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 {
  66         if (pannable) {
  67                 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
  68         }
  69
  70         _display_to_user = false;
  71
  72         if (_output) {
  73                 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
  74         }
  75
  76         CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
  77 }
  78
  79 /* deliver to a new IO object */
  80
  81 Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  82         : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
  83         , _role (r)
  84         , _output_buffers (new BufferSet())
  85         , _current_gain (1.0)
  86         , _no_outs_cuz_we_no_monitor (false)
  87         , _mute_master (mm)
  88         , no_panner_reset (false)
  89 {
  90         if (pannable) {
  91                 _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
  92         }
  93
  94         _display_to_user = false;
  95
  96         if (_output) {
  97                 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
  98         }
  99
 100         CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
 101 }
 102
 103
 104 Delivery::~Delivery()
 105 {
 106         DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
 107         delete _output_buffers;
 108 }
 109
 110 std::string
 111 Delivery::display_name () const
 112 {
 113         switch (_role) {
 114         case Main:
 115                 return _("main outs");
 116                 break;
 117         case Listen:
 118                 return _("listen");
 119                 break;
 120         case Send:
 121         case Insert:
 122         default:
 123                 return name();
 124         }
 125 }
 126
 127 void
 128 Delivery::cycle_start (pframes_t /*nframes*/)
 129 {
 130         _no_outs_cuz_we_no_monitor = false;
 131 }
 132
 133 bool
 134 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 135 {
 136         if (_role == Main) {
 137
 138                 /* the out buffers will be set to point to the port output buffers
 139                    of our output object.
 140                 */
 141
 142                 if (_output) {
 143                         if (_output->n_ports() != ChanCount::ZERO) {
 144                                 /* increase number of output ports if the processor chain requires it */
 145                                 out = ChanCount::max (_output->n_ports(), in);
 146                                 return true;
 147                         } else {
 148                                 /* not configured yet - we will passthru */
 149                                 out = in;
 150                                 return true;
 151                         }
 152                 } else {
 153                         fatal << "programming error: this should never be reached" << endmsg;
 154                         /*NOTREACHED*/
 155                 }
 156
 157
 158         } else if (_role == Insert) {
 159
 160                 /* the output buffers will be filled with data from the *input* ports
 161                    of this Insert.
 162                 */
 163
 164                 if (_input) {
 165                         if (_input->n_ports() != ChanCount::ZERO) {
 166                                 out = _input->n_ports();
 167                                 return true;
 168                         } else {
 169                                 /* not configured yet - we will passthru */
 170                                 out = in;
 171                                 return true;
 172                         }
 173                 } else {
 174                         fatal << "programming error: this should never be reached" << endmsg;
 175                         /*NOTREACHED*/
 176                 }
 177
 178         } else {
 179                 fatal << "programming error: this should never be reached" << endmsg;
 180         }
 181
 182         return false;
 183 }
 184
 185 /** Caller must hold process lock */
 186 bool
 187 Delivery::configure_io (ChanCount in, ChanCount out)
 188 {
 189         assert (!AudioEngine::instance()->process_lock().trylock());
 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                                         /*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         output_buffers().get_jack_port_addresses (ports, nframes);
 253
 254         // this Delivery processor is not a derived type, and thus we assume
 255         // we really can modify the buffers passed in (it is almost certainly
 256         // the main output stage of a Route). Contrast with Send::run()
 257         // which cannot do this.
 258
 259         tgain = target_gain ();
 260
 261         if (tgain != _current_gain) {
 262                 /* target gain has changed */
 263
 264                 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
 265                 _current_gain = tgain;
 266
 267         } else if (tgain == 0.0) {
 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, 0.0);
 277                 }
 278                 goto out;
 279
 280         } else if (tgain != 1.0) {
 281
 282                 /* target gain has not changed, but is not unity */
 283                 Amp::apply_simple_gain (bufs, nframes, tgain);
 284         }
 285
 286         if (_panshell && !_panshell->bypassed() && _panshell->panner()) {
 287
 288                 // Use the panner to distribute audio to output port buffers
 289
 290                 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
 291
 292                 // MIDI data will not have been delivered by the panner
 293
 294                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 295                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
 296                 }
 297
 298         } else {
 299
 300                 // Do a 1:1 copy of data to output ports
 301
 302                 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
 303                         _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
 304                 }
 305
 306                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 307                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
 308                 }
 309         }
 310
 311         if (result_required) {
 312                 bufs.read_from (output_buffers (), nframes);
 313         }
 314
 315   out:
 316         _active = _pending_active;
 317 }
 318
 319 XMLNode&
 320 Delivery::state (bool full_state)
 321 {
 322         XMLNode& node (IOProcessor::state (full_state));
 323
 324         if (_role & Main) {
 325                 node.add_property("type", "main-outs");
 326         } else if (_role & Listen) {
 327                 node.add_property("type", "listen");
 328         } else {
 329                 node.add_property("type", "delivery");
 330         }
 331
 332         node.add_property("role", enum_2_string(_role));
 333
 334         if (_panshell) {
 335                 node.add_child_nocopy (_panshell->get_state ());
 336         }
 337
 338         return node;
 339 }
 340
 341 int
 342 Delivery::set_state (const XMLNode& node, int version)
 343 {
 344         const XMLProperty* prop;
 345
 346         if (IOProcessor::set_state (node, version)) {
 347                 return -1;
 348         }
 349
 350         if ((prop = node.property ("role")) != 0) {
 351                 _role = Role (string_2_enum (prop->value(), _role));
 352                 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
 353         } else {
 354                 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
 355         }
 356
 357         XMLNode* pan_node = node.child (X_("PannerShell"));
 358
 359         if (pan_node && _panshell) {
 360                 _panshell->set_state (*pan_node, version);
 361         }
 362
 363         reset_panner ();
 364
 365         return 0;
 366 }
 367
 368 void
 369 Delivery::unpan ()
 370 {
 371         /* caller must hold process lock */
 372
 373         _panshell.reset ();
 374 }
 375
 376 uint32_t
 377 Delivery::pan_outs () const
 378 {
 379         if (_output) {
 380                 return _output->n_ports().n_audio();
 381         }
 382
 383         return _configured_output.n_audio();
 384 }
 385
 386 void
 387 Delivery::reset_panner ()
 388 {
 389         if (panners_legal) {
 390                 if (!no_panner_reset) {
 391
 392                         if (_panshell) {
 393                                 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
 394
 395                                 if (_role == Main) {
 396                                         _panshell->pannable()->set_panner (_panshell->panner());
 397                                 }
 398                         }
 399                 }
 400
 401         } else {
 402                 panner_legal_c.disconnect ();
 403                 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
 404         }
 405 }
 406
 407 int
 408 Delivery::panners_became_legal ()
 409 {
 410         if (_panshell) {
 411                 _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
 412
 413                 if (_role == Main) {
 414                         _panshell->pannable()->set_panner (_panshell->panner());
 415                 }
 416         }
 417
 418         panner_legal_c.disconnect ();
 419         return 0;
 420 }
 421
 422 void
 423 Delivery::defer_pan_reset ()
 424 {
 425         no_panner_reset = true;
 426 }
 427
 428 void
 429 Delivery::allow_pan_reset ()
 430 {
 431         no_panner_reset = false;
 432         reset_panner ();
 433 }
 434
 435
 436 int
 437 Delivery::disable_panners (void)
 438 {
 439         panners_legal = false;
 440         return 0;
 441 }
 442
 443 int
 444 Delivery::reset_panners ()
 445 {
 446         panners_legal = true;
 447         return *PannersLegal ();
 448 }
 449
 450 void
 451 Delivery::flush_buffers (framecnt_t nframes, framepos_t time)
 452 {
 453         /* io_lock, not taken: function must be called from Session::process() calltree */
 454
 455         if (!_output) {
 456                 return;
 457         }
 458
 459         PortSet& ports (_output->ports());
 460
 461         for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 462                 i->flush_buffers (nframes, time);
 463         }
 464 }
 465
 466 void
 467 Delivery::transport_stopped (framepos_t now)
 468 {
 469         Processor::transport_stopped (now);
 470
 471         if (_panshell) {
 472                 _panshell->pannable()->transport_stopped (now);
 473         }
 474
 475         if (_output) {
 476                 PortSet& ports (_output->ports());
 477
 478                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 479                         i->transport_stopped ();
 480                 }
 481         }
 482 }
 483
 484 void
 485 Delivery::realtime_locate ()
 486 {
 487         if (_output) {
 488                 PortSet& ports (_output->ports());
 489
 490                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 491                         i->realtime_locate ();
 492                 }
 493         }
 494 }
 495
 496 gain_t
 497 Delivery::target_gain ()
 498 {
 499         /* if we've been requested to deactivate, our target gain is zero */
 500
 501         if (!_pending_active) {
 502                 return 0.0;
 503         }
 504
 505         /* if we've been told not to output because its a monitoring situation and
 506            we're not monitoring, then be quiet.
 507         */
 508
 509         if (_no_outs_cuz_we_no_monitor) {
 510                 return 0.0;
 511         }
 512
 513         MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
 514
 515         switch (_role) {
 516         case Main:
 517                 mp = MuteMaster::Main;
 518                 break;
 519         case Listen:
 520                 mp = MuteMaster::Listen;
 521                 break;
 522         case Send:
 523         case Insert:
 524         case Aux:
 525                 if (_pre_fader) {
 526                         mp = MuteMaster::PreFader;
 527                 } else {
 528                         mp = MuteMaster::PostFader;
 529                 }
 530                 break;
 531         }
 532
 533         gain_t desired_gain = _mute_master->mute_gain_at (mp);
 534
 535         if (_role == Listen && _session.monitor_out() && !_session.listening()) {
 536
 537                 /* nobody is soloed, and this delivery is a listen-send to the
 538                    control/monitor/listen bus, we should be silent since
 539                    it gets its signal from the master out.
 540                 */
 541
 542                 desired_gain = 0.0;
 543
 544         }
 545
 546         return desired_gain;
 547 }
 548
 549 void
 550 Delivery::no_outs_cuz_we_no_monitor (bool yn)
 551 {
 552         _no_outs_cuz_we_no_monitor = yn;
 553 }
 554
 555 bool
 556 Delivery::set_name (const std::string& name)
 557 {
 558         bool ret = IOProcessor::set_name (name);
 559
 560         if (ret) {
 561                 ret = _panshell->set_name (name);
 562         }
 563
 564         return ret;
 565 }
 566
 567 bool ignore_output_change = false;
 568
 569 void
 570 Delivery::output_changed (IOChange change, void* /*src*/)
 571 {
 572         if (change.type & IOChange::ConfigurationChanged) {
 573                 reset_panner ();
 574                 _output_buffers->attach_buffers (_output->ports ());
 575         }
 576 }
 577
 578 boost::shared_ptr<Panner>
 579 Delivery::panner () const
 580 {
 581         if (_panshell) {
 582                 return _panshell->panner();
 583         } else {
 584                 return boost::shared_ptr<Panner>();
 585         }
 586 }
 587