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