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/amp.h"
  31 #include "ardour/buffer_set.h"
  32 #include "ardour/configuration.h"
  33 #include "ardour/io.h"
  34 #include "ardour/meter.h"
  35 #include "ardour/mute_master.h"
  36 #include "ardour/panner.h"
  37 #include "ardour/panner_shell.h"
  38 #include "ardour/pannable.h"
  39 #include "ardour/port.h"
  40 #include "ardour/session.h"
  41 #include "ardour/audioengine.h"
  42
  43 #include "i18n.h"
  44
  45 using namespace std;
  46 using namespace PBD;
  47 using namespace ARDOUR;
  48
  49 PBD::Signal1<void, pframes_t> Delivery::CycleStart;
  50 PBD::Signal0<int>             Delivery::PannersLegal;
  51 bool                          Delivery::panners_legal = false;
  52
  53 /* deliver to an existing IO object */
  54
  55 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable> pannable,
  56                     boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  57         : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
  58         , _role (r)
  59         , _output_buffers (new BufferSet())
  60         , _current_gain (1.0)
  61         , _output_offset (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         , _output_offset (0)
  84         , _no_outs_cuz_we_no_monitor (false)
  85         , _mute_master (mm)
  86         , no_panner_reset (false)
  87 {
  88         _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
  89         _display_to_user = false;
  90
  91         if (_output) {
  92                 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
  93         }
  94
  95         CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
  96 }
  97
  98
  99 Delivery::~Delivery()
 100 {
 101         DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));
 102         delete _output_buffers;
 103 }
 104
 105 std::string
 106 Delivery::display_name () const
 107 {
 108         switch (_role) {
 109         case Main:
 110                 return _("main outs");
 111                 break;
 112         case Listen:
 113                 return _("listen");
 114                 break;
 115         case Send:
 116         case Insert:
 117         default:
 118                 return name();
 119         }
 120 }
 121
 122 void
 123 Delivery::cycle_start (pframes_t /*nframes*/)
 124 {
 125         _output_offset = 0;
 126         _no_outs_cuz_we_no_monitor = false;
 127 }
 128
 129 void
 130 Delivery::increment_output_offset (framecnt_t n)
 131 {
 132         _output_offset += n;
 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, _output_offset);
 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                         Amp::apply_simple_gain (bufs, nframes, 0.0);
 280                 }
 281                 goto out;
 282
 283         } else if (tgain != 1.0) {
 284
 285                 /* target gain has not changed, but is not unity */
 286                 Amp::apply_simple_gain (bufs, nframes, tgain);
 287         }
 288
 289         panner = _panshell->panner();
 290
 291         if (panner && !panner->bypassed()) {
 292
 293                 // Use the panner to distribute audio to output port buffers
 294
 295                 _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
 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, _output_offset);
 304                 }
 305
 306                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 307                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
 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         node.add_child_nocopy (_panshell->state (full_state));
 334
 335         return node;
 336 }
 337
 338 int
 339 Delivery::set_state (const XMLNode& node, int version)
 340 {
 341         const XMLProperty* prop;
 342
 343         if (IOProcessor::set_state (node, version)) {
 344                 return -1;
 345         }
 346
 347         if ((prop = node.property ("role")) != 0) {
 348                 _role = Role (string_2_enum (prop->value(), _role));
 349                 // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
 350         } else {
 351                 // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
 352         }
 353
 354         XMLNode* pan_node = node.child (X_("Panner"));
 355
 356         if (pan_node) {
 357                 _panshell->set_state (*pan_node, version);
 358         }
 359
 360         reset_panner ();
 361
 362         return 0;
 363 }
 364
 365 void
 366 Delivery::reset_panner ()
 367 {
 368         if (_role == Listen) {
 369                 /* monitor out gets no panner */
 370                 return;
 371         }
 372
 373         if (panners_legal) {
 374                 if (!no_panner_reset) {
 375
 376                         uint32_t ntargets;
 377
 378                         if (_output) {
 379                                 ntargets = _output->n_ports().n_audio();
 380                         } else {
 381                                 ntargets = _configured_output.n_audio();
 382                         }
 383
 384                         _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
 385
 386                         if (_role == Main) {
 387                                 _panshell->pannable()->set_panner (_panshell->panner());
 388                         }
 389                 }
 390
 391         } else {
 392                 panner_legal_c.disconnect ();
 393                 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
 394         }
 395 }
 396
 397 int
 398 Delivery::panners_became_legal ()
 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         _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, ntargets));
 409
 410         if (_role == Main) {
 411                 _panshell->pannable()->set_panner (_panshell->panner());
 412         }
 413
 414         panner_legal_c.disconnect ();
 415         return 0;
 416 }
 417
 418 void
 419 Delivery::defer_pan_reset ()
 420 {
 421         no_panner_reset = true;
 422 }
 423
 424 void
 425 Delivery::allow_pan_reset ()
 426 {
 427         no_panner_reset = false;
 428         reset_panner ();
 429 }
 430
 431
 432 int
 433 Delivery::disable_panners (void)
 434 {
 435         panners_legal = false;
 436         return 0;
 437 }
 438
 439 int
 440 Delivery::reset_panners ()
 441 {
 442         panners_legal = true;
 443         return *PannersLegal ();
 444 }
 445
 446 void
 447 Delivery::flush_buffers (framecnt_t nframes, framepos_t time)
 448 {
 449         /* io_lock, not taken: function must be called from Session::process() calltree */
 450
 451         PortSet& ports (_output->ports());
 452
 453         for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 454                 (*i).flush_buffers (nframes, time, _output_offset);
 455         }
 456 }
 457
 458 void
 459 Delivery::transport_stopped (framepos_t now)
 460 {
 461         Processor::transport_stopped (now);
 462         _panshell->pannable()->transport_stopped (now);
 463
 464         if (_output) {
 465                 PortSet& ports (_output->ports());
 466
 467                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 468                         (*i).transport_stopped ();
 469                 }
 470         }
 471 }
 472
 473 gain_t
 474 Delivery::target_gain ()
 475 {
 476         /* if we've been requested to deactivate, our target gain is zero */
 477
 478         if (!_pending_active) {
 479                 return 0.0;
 480         }
 481
 482         /* if we've been told not to output because its a monitoring situation and
 483            we're not monitoring, then be quiet.
 484         */
 485
 486         if (_no_outs_cuz_we_no_monitor) {
 487                 return 0.0;
 488         }
 489
 490         MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
 491
 492         switch (_role) {
 493         case Main:
 494                 mp = MuteMaster::Main;
 495                 break;
 496         case Listen:
 497                 mp = MuteMaster::Listen;
 498                 break;
 499         case Send:
 500         case Insert:
 501         case Aux:
 502                 if (_pre_fader) {
 503                         mp = MuteMaster::PreFader;
 504                 } else {
 505                         mp = MuteMaster::PostFader;
 506                 }
 507                 break;
 508         }
 509
 510         gain_t desired_gain = _mute_master->mute_gain_at (mp);
 511
 512         if (_role == Listen && _session.monitor_out() && !_session.listening()) {
 513
 514                 /* nobody is soloed, and this delivery is a listen-send to the
 515                    control/monitor/listen bus, we should be silent since
 516                    it gets its signal from the master out.
 517                 */
 518
 519                 desired_gain = 0.0;
 520
 521         }
 522
 523         return desired_gain;
 524 }
 525
 526 void
 527 Delivery::no_outs_cuz_we_no_monitor (bool yn)
 528 {
 529         _no_outs_cuz_we_no_monitor = yn;
 530 }
 531
 532 bool
 533 Delivery::set_name (const std::string& name)
 534 {
 535         bool ret = IOProcessor::set_name (name);
 536
 537         if (ret) {
 538                 ret = _panshell->set_name (name);
 539         }
 540
 541         return ret;
 542 }
 543
 544 void
 545 Delivery::output_changed (IOChange change, void* /*src*/)
 546 {
 547         if (change.type & IOChange::ConfigurationChanged) {
 548                 reset_panner ();
 549                 _output_buffers->attach_buffers (_output->ports ());
 550         }
 551 }
 552
 553 boost::shared_ptr<Panner>
 554 Delivery::panner () const
 555 {
 556         return _panshell->panner();
 557 }