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 "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, pframes_t nframes, bool result_required)
 233 {
 234         assert (_output);
 235
 236         PortSet& ports (_output->ports());
 237         gain_t tgain;
 238
 239         if (_output->n_ports ().get (_output->default_type()) == 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                 // MIDI data will not have been delivered by the panner
 301
 302                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 303                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
 304                 }
 305
 306         } else {
 307
 308                 // Do a 1:1 copy of data to output ports
 309
 310                 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
 311                         _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
 312                 }
 313
 314                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 315                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
 316                 }
 317         }
 318
 319         if (result_required) {
 320                 bufs.read_from (output_buffers (), nframes);
 321         }
 322
 323   out:
 324         _active = _pending_active;
 325 }
 326
 327 XMLNode&
 328 Delivery::state (bool full_state)
 329 {
 330         XMLNode& node (IOProcessor::state (full_state));
 331
 332         if (_role & Main) {
 333                 node.add_property("type", "main-outs");
 334         } else if (_role & Listen) {
 335                 node.add_property("type", "listen");
 336         } else {
 337                 node.add_property("type", "delivery");
 338         }
 339
 340         node.add_property("role", enum_2_string(_role));
 341
 342         if (_panshell) {
 343                 node.add_child_nocopy (_panshell->get_state ());
 344                 if (_panshell->pannable()) {
 345                         node.add_child_nocopy (_panshell->pannable()->get_state ());
 346                 }
 347         }
 348
 349         return node;
 350 }
 351
 352 int
 353 Delivery::set_state (const XMLNode& node, int version)
 354 {
 355         const XMLProperty* prop;
 356
 357         if (IOProcessor::set_state (node, version)) {
 358                 return -1;
 359         }
 360
 361         if ((prop = node.property ("role")) != 0) {
 362                 _role = Role (string_2_enum (prop->value(), _role));
 363                 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
 364         } else {
 365                 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
 366         }
 367
 368         XMLNode* pan_node = node.child (X_("PannerShell"));
 369
 370         if (pan_node && _panshell) {
 371                 _panshell->set_state (*pan_node, version);
 372         }
 373
 374         reset_panner ();
 375
 376         XMLNode* pannnode = node.child (X_("Pannable"));
 377         if (_panshell && _panshell->panner() && pannnode) {
 378                 _panshell->pannable()->set_state (*pannnode, version);
 379         }
 380
 381         return 0;
 382 }
 383
 384 void
 385 Delivery::unpan ()
 386 {
 387         /* caller must hold process lock */
 388
 389         _panshell.reset ();
 390 }
 391
 392 uint32_t
 393 Delivery::pan_outs () const
 394 {
 395         if (_output) {
 396                 return _output->n_ports().n_audio();
 397         }
 398
 399         return _configured_output.n_audio();
 400 }
 401
 402 void
 403 Delivery::reset_panner ()
 404 {
 405         if (panners_legal) {
 406                 if (!_no_panner_reset) {
 407
 408                         if (_panshell && _role != Insert && _role != Listen) {
 409                                 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
 410                         }
 411                 }
 412
 413         } else {
 414                 panner_legal_c.disconnect ();
 415                 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
 416         }
 417 }
 418
 419 void
 420 Delivery::panners_became_legal ()
 421 {
 422         if (_panshell && _role != Insert) {
 423                 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
 424         }
 425
 426         panner_legal_c.disconnect ();
 427 }
 428
 429 void
 430 Delivery::defer_pan_reset ()
 431 {
 432         _no_panner_reset = true;
 433 }
 434
 435 void
 436 Delivery::allow_pan_reset ()
 437 {
 438         _no_panner_reset = false;
 439         reset_panner ();
 440 }
 441
 442
 443 int
 444 Delivery::disable_panners ()
 445 {
 446         panners_legal = false;
 447         return 0;
 448 }
 449
 450 void
 451 Delivery::reset_panners ()
 452 {
 453         panners_legal = true;
 454         PannersLegal ();
 455 }
 456
 457 void
 458 Delivery::flush_buffers (framecnt_t nframes)
 459 {
 460         /* io_lock, not taken: function must be called from Session::process() calltree */
 461
 462         if (!_output) {
 463                 return;
 464         }
 465
 466         PortSet& ports (_output->ports());
 467
 468         for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 469                 i->flush_buffers (nframes);
 470         }
 471 }
 472
 473 void
 474 Delivery::transport_stopped (framepos_t now)
 475 {
 476         Processor::transport_stopped (now);
 477
 478         if (_panshell) {
 479                 _panshell->pannable()->transport_stopped (now);
 480         }
 481
 482         if (_output) {
 483                 PortSet& ports (_output->ports());
 484
 485                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 486                         i->transport_stopped ();
 487                 }
 488         }
 489 }
 490
 491 void
 492 Delivery::realtime_locate ()
 493 {
 494         if (_output) {
 495                 PortSet& ports (_output->ports());
 496
 497                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 498                         i->realtime_locate ();
 499                 }
 500         }
 501 }
 502
 503 gain_t
 504 Delivery::target_gain ()
 505 {
 506         /* if we've been requested to deactivate, our target gain is zero */
 507
 508         if (!_pending_active) {
 509                 return GAIN_COEFF_ZERO;
 510         }
 511
 512         /* if we've been told not to output because its a monitoring situation and
 513            we're not monitoring, then be quiet.
 514         */
 515
 516         if (_no_outs_cuz_we_no_monitor) {
 517                 return GAIN_COEFF_ZERO;
 518         }
 519
 520         MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
 521
 522         switch (_role) {
 523         case Main:
 524                 mp = MuteMaster::Main;
 525                 break;
 526         case Listen:
 527                 mp = MuteMaster::Listen;
 528                 break;
 529         case Send:
 530         case Insert:
 531         case Aux:
 532                 if (_pre_fader) {
 533                         mp = MuteMaster::PreFader;
 534                 } else {
 535                         mp = MuteMaster::PostFader;
 536                 }
 537                 break;
 538         }
 539
 540         gain_t desired_gain = _mute_master->mute_gain_at (mp);
 541
 542         if (_role == Listen && _session.monitor_out() && !_session.listening()) {
 543
 544                 /* nobody is soloed, and this delivery is a listen-send to the
 545                    control/monitor/listen bus, we should be silent since
 546                    it gets its signal from the master out.
 547                 */
 548
 549                 desired_gain = GAIN_COEFF_ZERO;
 550
 551         }
 552
 553         return desired_gain;
 554 }
 555
 556 void
 557 Delivery::no_outs_cuz_we_no_monitor (bool yn)
 558 {
 559         _no_outs_cuz_we_no_monitor = yn;
 560 }
 561
 562 bool
 563 Delivery::set_name (const std::string& name)
 564 {
 565         bool ret = IOProcessor::set_name (name);
 566
 567         if (ret && _panshell) {
 568                 ret = _panshell->set_name (name);
 569         }
 570
 571         return ret;
 572 }
 573
 574 bool ignore_output_change = false;
 575
 576 void
 577 Delivery::output_changed (IOChange change, void* /*src*/)
 578 {
 579         if (change.type & IOChange::ConfigurationChanged) {
 580                 reset_panner ();
 581                 _output_buffers->attach_buffers (_output->ports ());
 582         }
 583 }
 584
 585 boost::shared_ptr<Panner>
 586 Delivery::panner () const
 587 {
 588         if (_panshell) {
 589                 return _panshell->panner();
 590         } else {
 591                 return boost::shared_ptr<Panner>();
 592         }
 593 }
 594