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