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