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