libs/ardour/delivery.cc

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU General Public License as published by the Free
   6     Software Foundation; either version 2 of the License, or (at your option)
   7     any later version.
   8
   9     This program is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12     for more details.
  13
  14     You should have received a copy of the GNU General Public License along
  15     with this program; if not, write to the Free Software Foundation, Inc.,
  16     675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <cmath>
  20 #include <algorithm>
  21
  22 #include "pbd/enumwriter.h"
  23 #include "pbd/convert.h"
  24
  25 #include "ardour/midi_buffer.h"
  26
  27 #include "ardour/debug.h"
  28 #include "ardour/delivery.h"
  29 #include "ardour/audio_buffer.h"
  30 #include "ardour/audio_port.h"
  31 #include "ardour/amp.h"
  32 #include "ardour/buffer_set.h"
  33 #include "ardour/configuration.h"
  34 #include "ardour/io.h"
  35 #include "ardour/meter.h"
  36 #include "ardour/mute_master.h"
  37 #include "ardour/panner.h"
  38 #include "ardour/panner_shell.h"
  39 #include "ardour/pannable.h"
  40 #include "ardour/port.h"
  41 #include "ardour/session.h"
  42 #include "ardour/audioengine.h"
  43
  44 #include "i18n.h"
  45
  46 using namespace std;
  47 using namespace PBD;
  48 using namespace ARDOUR;
  49
  50 PBD::Signal1<void, pframes_t> Delivery::CycleStart;
  51 PBD::Signal0<int>             Delivery::PannersLegal;
  52 bool                          Delivery::panners_legal = false;
  53
  54 /* deliver to an existing IO object */
  55
  56 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable> pannable,
  57                     boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  58         : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
  59         , _role (r)
  60         , _output_buffers (new BufferSet())
  61         , _current_gain (1.0)
  62         , _no_outs_cuz_we_no_monitor (false)
  63         , _mute_master (mm)
  64         , no_panner_reset (false)
  65         , scnt (0)
  66 {
  67         if (pannable) {
  68                 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
  69         }
  70
  71         _display_to_user = false;
  72
  73         if (_output) {
  74                 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
  75         }
  76
  77         CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
  78 }
  79
  80 /* deliver to a new IO object */
  81
  82 Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  83         : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
  84         , _role (r)
  85         , _output_buffers (new BufferSet())
  86         , _current_gain (1.0)
  87         , _no_outs_cuz_we_no_monitor (false)
  88         , _mute_master (mm)
  89         , no_panner_reset (false)
  90         , scnt (0)
  91 {
  92         if (pannable) {
  93                 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
  94         }
  95
  96         _display_to_user = false;
  97
  98         if (_output) {
  99                 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
 100         }
 101
 102         CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
 103 }
 104
 105
 106 Delivery::~Delivery()
 107 {
 108         DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
 109         delete _output_buffers;
 110 }
 111
 112 std::string
 113 Delivery::display_name () const
 114 {
 115         switch (_role) {
 116         case Main:
 117                 return _("main outs");
 118                 break;
 119         case Listen:
 120                 return _("listen");
 121                 break;
 122         case Send:
 123         case Insert:
 124         default:
 125                 return name();
 126         }
 127 }
 128
 129 void
 130 Delivery::cycle_start (pframes_t /*nframes*/)
 131 {
 132         _no_outs_cuz_we_no_monitor = false;
 133 }
 134
 135 bool
 136 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 137 {
 138         if (_role == Main) {
 139
 140                 /* the out buffers will be set to point to the port output buffers
 141                    of our output object.
 142                 */
 143
 144                 if (_output) {
 145                         if (_output->n_ports() != ChanCount::ZERO) {
 146                                 /* increase number of output ports if the processor chain requires it */
 147                                 out = ChanCount::max (_output->n_ports(), in);
 148                                 return true;
 149                         } else {
 150                                 /* not configured yet - we will passthru */
 151                                 out = in;
 152                                 return true;
 153                         }
 154                 } else {
 155                         fatal << "programming error: this should never be reached" << endmsg;
 156                         /*NOTREACHED*/
 157                 }
 158
 159
 160         } else if (_role == Insert) {
 161
 162                 /* the output buffers will be filled with data from the *input* ports
 163                    of this Insert.
 164                 */
 165
 166                 if (_input) {
 167                         if (_input->n_ports() != ChanCount::ZERO) {
 168                                 out = _input->n_ports();
 169                                 return true;
 170                         } else {
 171                                 /* not configured yet - we will passthru */
 172                                 out = in;
 173                                 return true;
 174                         }
 175                 } else {
 176                         fatal << "programming error: this should never be reached" << endmsg;
 177                         /*NOTREACHED*/
 178                 }
 179
 180         } else {
 181                 fatal << "programming error: this should never be reached" << endmsg;
 182         }
 183
 184         return false;
 185 }
 186
 187 /** Caller must hold process lock */
 188 bool
 189 Delivery::configure_io (ChanCount in, ChanCount out)
 190 {
 191         assert (!AudioEngine::instance()->process_lock().trylock());
 192
 193         /* check configuration by comparison with our I/O port configuration, if appropriate.
 194            see ::can_support_io_configuration() for comments
 195         */
 196
 197         if (_role == Main) {
 198
 199                 if (_output) {
 200                         if (_output->n_ports() != out) {
 201                                 if (_output->n_ports() != ChanCount::ZERO) {
 202                                         _output->ensure_io (out, false, this);
 203                                 } else {
 204                                         /* I/O not yet configured */
 205                                 }
 206                         }
 207                 }
 208
 209         } else if (_role == Insert) {
 210
 211                 if (_input) {
 212                         if (_input->n_ports() != in) {
 213                                 if (_input->n_ports() != ChanCount::ZERO) {
 214                                         fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
 215                                         /*NOTREACHED*/
 216                                 } else {
 217                                         /* I/O not yet configured */
 218                                 }
 219                         }
 220                 }
 221
 222         }
 223
 224         if (!Processor::configure_io (in, out)) {
 225                 return false;
 226         }
 227
 228         reset_panner ();
 229
 230         return true;
 231 }
 232
 233 void
 234 Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool result_required)
 235 {
 236         boost::shared_ptr<Panner> panner;
 237
 238         assert (_output);
 239
 240         PortSet& ports (_output->ports());
 241         gain_t tgain;
 242
 243         if (_output->n_ports ().get (_output->default_type()) == 0) {
 244                 goto out;
 245         }
 246
 247         if (!_active && !_pending_active) {
 248                 _output->silence (nframes);
 249                 goto out;
 250         }
 251
 252         /* this setup is not just for our purposes, but for anything that comes after us in the
 253            processing pathway that wants to use this->output_buffers() for some reason.
 254         */
 255
 256         output_buffers().get_jack_port_addresses (ports, nframes);
 257
 258         // this Delivery processor is not a derived type, and thus we assume
 259         // we really can modify the buffers passed in (it is almost certainly
 260         // the main output stage of a Route). Contrast with Send::run()
 261         // which cannot do this.
 262
 263         tgain = target_gain ();
 264
 265         if (tgain != _current_gain) {
 266                 /* target gain has changed */
 267
 268                 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
 269                 _current_gain = tgain;
 270
 271         } else if (tgain == 0.0) {
 272
 273                 /* we were quiet last time, and we're still supposed to be quiet.
 274                    Silence the outputs, and make sure the buffers are quiet too,
 275                 */
 276
 277                 _output->silence (nframes);
 278                 if (result_required) {
 279                         bufs.set_count (output_buffers().count ());
 280                         Amp::apply_simple_gain (bufs, nframes, 0.0);
 281                 }
 282                 goto out;
 283
 284         } else if (tgain != 1.0) {
 285
 286                 /* target gain has not changed, but is not unity */
 287                 Amp::apply_simple_gain (bufs, nframes, tgain);
 288         }
 289
 290         if (_panshell) {
 291                 panner = _panshell->panner();
 292         }
 293
 294 #if 0
 295         if (_session.transport_rolling()) {
 296                 cerr << name() << " first value written : " << scnt << endl;
 297                 for (BufferSet::audio_iterator b = bufs.audio_begin(); b != bufs.audio_end(); ++b) {
 298                         Sample* p = b->data ();
 299                         float s = (float) scnt;
 300                         for (pframes_t n = 0; n < nframes; ++n) {
 301                                 p[n] =  s * 0.001;
 302                                 s += 1.0;
 303                         }
 304                 }
 305                 scnt += nframes;
 306         }
 307 #endif
 308
 309         if (panner && !panner->bypassed()) {
 310
 311                 // Use the panner to distribute audio to output port buffers
 312
 313                 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
 314
 315
 316         } else {
 317
 318                 // Do a 1:1 copy of data to output ports
 319
 320                 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
 321                         _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
 322                 }
 323
 324                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 325                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
 326                 }
 327         }
 328
 329         if (result_required) {
 330                 bufs.read_from (output_buffers (), nframes);
 331         }
 332
 333   out:
 334         _active = _pending_active;
 335 }
 336
 337 XMLNode&
 338 Delivery::state (bool full_state)
 339 {
 340         XMLNode& node (IOProcessor::state (full_state));
 341
 342         if (_role & Main) {
 343                 node.add_property("type", "main-outs");
 344         } else if (_role & Listen) {
 345                 node.add_property("type", "listen");
 346         } else {
 347                 node.add_property("type", "delivery");
 348         }
 349
 350         node.add_property("role", enum_2_string(_role));
 351
 352         if (_panshell) {
 353                 node.add_child_nocopy (_panshell->state (full_state));
 354         }
 355
 356         return node;
 357 }
 358
 359 int
 360 Delivery::set_state (const XMLNode& node, int version)
 361 {
 362         const XMLProperty* prop;
 363
 364         if (IOProcessor::set_state (node, version)) {
 365                 return -1;
 366         }
 367
 368         if ((prop = node.property ("role")) != 0) {
 369                 _role = Role (string_2_enum (prop->value(), _role));
 370                 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
 371         } else {
 372                 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
 373         }
 374
 375         XMLNode* pan_node = node.child (X_("PannerShell"));
 376
 377         if (pan_node && _panshell) {
 378                 _panshell->set_state (*pan_node, version);
 379         }
 380
 381         reset_panner ();
 382
 383         return 0;
 384 }
 385
 386 void
 387 Delivery::unpan ()
 388 {
 389         /* caller must hold process lock */
 390
 391         _panshell.reset ();
 392 }
 393
 394 void
 395 Delivery::reset_panner ()
 396 {
 397         if (panners_legal) {
 398                 if (!no_panner_reset) {
 399
 400                         uint32_t ntargets;
 401
 402                         if (_output) {
 403                                 ntargets = _output->n_ports().n_audio();
 404                         } else {
 405                                 ntargets = _configured_output.n_audio();
 406                         }
 407
 408                         if (_panshell) {
 409                                 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
 410
 411                                 if (_role == Main) {
 412                                         _panshell->pannable()->set_panner (_panshell->panner());
 413                                 }
 414                         }
 415                 }
 416
 417         } else {
 418                 panner_legal_c.disconnect ();
 419                 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
 420         }
 421 }
 422
 423 int
 424 Delivery::panners_became_legal ()
 425 {
 426         uint32_t ntargets;
 427
 428         if (_output) {
 429                 ntargets = _output->n_ports().n_audio();
 430         } else {
 431                 ntargets = _configured_output.n_audio();
 432         }
 433
 434         if (_panshell) {
 435                 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
 436
 437                 if (_role == Main) {
 438                         _panshell->pannable()->set_panner (_panshell->panner());
 439                 }
 440         }
 441
 442         panner_legal_c.disconnect ();
 443         return 0;
 444 }
 445
 446 void
 447 Delivery::defer_pan_reset ()
 448 {
 449         no_panner_reset = true;
 450 }
 451
 452 void
 453 Delivery::allow_pan_reset ()
 454 {
 455         no_panner_reset = false;
 456         reset_panner ();
 457 }
 458
 459
 460 int
 461 Delivery::disable_panners (void)
 462 {
 463         panners_legal = false;
 464         return 0;
 465 }
 466
 467 int
 468 Delivery::reset_panners ()
 469 {
 470         panners_legal = true;
 471         return *PannersLegal ();
 472 }
 473
 474 void
 475 Delivery::flush_buffers (framecnt_t nframes, framepos_t time)
 476 {
 477         /* io_lock, not taken: function must be called from Session::process() calltree */
 478
 479         PortSet& ports (_output->ports());
 480
 481         for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 482                 (*i).flush_buffers (nframes, time);
 483         }
 484 }
 485
 486 void
 487 Delivery::transport_stopped (framepos_t now)
 488 {
 489         Processor::transport_stopped (now);
 490
 491         if (_panshell) {
 492                 _panshell->pannable()->transport_stopped (now);
 493         }
 494
 495         if (_output) {
 496                 PortSet& ports (_output->ports());
 497
 498                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 499                         (*i).transport_stopped ();
 500                 }
 501         }
 502 }
 503
 504 void
 505 Delivery::realtime_locate ()
 506 {
 507         if (_output) {
 508                 PortSet& ports (_output->ports());
 509
 510                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 511                         (*i).realtime_locate ();
 512                 }
 513         }
 514 }
 515
 516 gain_t
 517 Delivery::target_gain ()
 518 {
 519         /* if we've been requested to deactivate, our target gain is zero */
 520
 521         if (!_pending_active) {
 522                 return 0.0;
 523         }
 524
 525         /* if we've been told not to output because its a monitoring situation and
 526            we're not monitoring, then be quiet.
 527         */
 528
 529         if (_no_outs_cuz_we_no_monitor) {
 530                 return 0.0;
 531         }
 532
 533         MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
 534
 535         switch (_role) {
 536         case Main:
 537                 mp = MuteMaster::Main;
 538                 break;
 539         case Listen:
 540                 mp = MuteMaster::Listen;
 541                 break;
 542         case Send:
 543         case Insert:
 544         case Aux:
 545                 if (_pre_fader) {
 546                         mp = MuteMaster::PreFader;
 547                 } else {
 548                         mp = MuteMaster::PostFader;
 549                 }
 550                 break;
 551         }
 552
 553         gain_t desired_gain = _mute_master->mute_gain_at (mp);
 554
 555         if (_role == Listen && _session.monitor_out() && !_session.listening()) {
 556
 557                 /* nobody is soloed, and this delivery is a listen-send to the
 558                    control/monitor/listen bus, we should be silent since
 559                    it gets its signal from the master out.
 560                 */
 561
 562                 desired_gain = 0.0;
 563
 564         }
 565
 566         return desired_gain;
 567 }
 568
 569 void
 570 Delivery::no_outs_cuz_we_no_monitor (bool yn)
 571 {
 572         _no_outs_cuz_we_no_monitor = yn;
 573 }
 574
 575 bool
 576 Delivery::set_name (const std::string& name)
 577 {
 578         bool ret = IOProcessor::set_name (name);
 579
 580         if (ret) {
 581                 ret = _panshell->set_name (name);
 582         }
 583
 584         return ret;
 585 }
 586
 587 void
 588 Delivery::output_changed (IOChange change, void* /*src*/)
 589 {
 590         if (change.type & IOChange::ConfigurationChanged) {
 591                 reset_panner ();
 592                 _output_buffers->attach_buffers (_output->ports ());
 593         }
 594 }
 595
 596 boost::shared_ptr<Panner>
 597 Delivery::panner () const
 598 {
 599         if (_panshell) {
 600                 return _panshell->panner();
 601         } else {
 602                 return boost::shared_ptr<Panner>();
 603         }
 604 }
 605