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