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         , _solo_level (0)
  59         , _solo_isolated (false)
  60         , _solo_ignored (false)
  61         , _mute_master (mm)
  62         , no_panner_reset (false)
  63 {
  64         _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
  65         _display_to_user = false;
  66
  67         if (_output) {
  68                 _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
  69         }
  70
  71         CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
  72 }
  73
  74 /* deliver to a new IO object */
  75
  76 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  77         : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
  78         , _role (r)
  79         , _output_buffers (new BufferSet())
  80         , _current_gain (1.0)
  81         , _output_offset (0)
  82         , _no_outs_cuz_we_no_monitor (false)
  83         , _solo_level (0)
  84         , _solo_isolated (false)
  85         , _solo_ignored (false)
  86         , _mute_master (mm)
  87         , no_panner_reset (false)
  88 {
  89         _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
  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         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 (nframes_t /*nframes*/)
 124 {
 125         _output_offset = 0;
 126         _no_outs_cuz_we_no_monitor = false;
 127 }
 128
 129 void
 130 Delivery::increment_output_offset (nframes_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                                 out = _output->n_ports();
 147                                 return true;
 148                         } else {
 149                                 /* not configured yet - we will passthru */
 150                                 out = in;
 151                                 return true;
 152                         }
 153                 } else {
 154                         fatal << "programming error: this should never be reached" << endmsg;
 155                         /*NOTREACHED*/
 156                 }
 157
 158
 159         } else if (_role == Insert) {
 160
 161                 /* the output buffers will be filled with data from the *input* ports
 162                    of this Insert.
 163                 */
 164
 165                 if (_input) {
 166                         if (_input->n_ports() != ChanCount::ZERO) {
 167                                 out = _input->n_ports();
 168                                 return true;
 169                         } else {
 170                                 /* not configured yet - we will passthru */
 171                                 out = in;
 172                                 return true;
 173                         }
 174                 } else {
 175                         fatal << "programming error: this should never be reached" << endmsg;
 176                         /*NOTREACHED*/
 177                 }
 178
 179         } else {
 180                 fatal << "programming error: this should never be reached" << endmsg;
 181         }
 182
 183         return false;
 184 }
 185
 186 bool
 187 Delivery::configure_io (ChanCount in, ChanCount out)
 188 {
 189         /* check configuration by comparison with our I/O port configuration, if appropriate.
 190            see ::can_support_io_configuration() for comments
 191         */
 192
 193         if (_role == Main) {
 194
 195                 if (_output) {
 196                         if (_output->n_ports() != out) {
 197                                 if (_output->n_ports() != ChanCount::ZERO) {
 198                                         fatal << _name << " programming error: configure_io with nports = " << _output->n_ports() << " called with " << in << " and " << out << " with " << _output->n_ports() << " output ports" << endmsg;
 199                                         /*NOTREACHED*/
 200                                 } else {
 201                                         /* I/O not yet configured */
 202                                 }
 203                         }
 204                 }
 205
 206         } else if (_role == Insert) {
 207
 208                 if (_input) {
 209                         if (_input->n_ports() != in) {
 210                                 if (_input->n_ports() != ChanCount::ZERO) {
 211                                         fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
 212                                         /*NOTREACHED*/
 213                                 } else {
 214                                         /* I/O not yet configured */
 215                                 }
 216                         }
 217                 }
 218         }
 219
 220         if (!Processor::configure_io (in, out)) {
 221                 return false;
 222         }
 223
 224         reset_panner ();
 225
 226         return true;
 227 }
 228
 229 void
 230 Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool result_required)
 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().attach_buffers (ports, nframes, _output_offset);
 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
 261                 /* target gain has changed */
 262
 263                 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
 264                 _current_gain = tgain;
 265
 266         } else if (tgain == 0.0) {
 267
 268                 /* we were quiet last time, and we're still supposed to be quiet.
 269                    Silence the outputs, and make sure the buffers are quiet too,
 270                 */
 271
 272                 _output->silence (nframes);
 273                 if (result_required) {
 274                         Amp::apply_simple_gain (bufs, nframes, 0.0);
 275                 }
 276                 goto out;
 277
 278         } else if (tgain != 1.0) {
 279
 280                 /* target gain has not changed, but is not unity */
 281                 Amp::apply_simple_gain (bufs, nframes, tgain);
 282         }
 283
 284         if (_panner && _panner->npanners() && !_panner->bypassed()) {
 285
 286                 // Use the panner to distribute audio to output port buffers
 287
 288                 _panner->run (bufs, output_buffers(), start_frame, end_frame, nframes);
 289
 290                 if (result_required) {
 291                         bufs.read_from (output_buffers (), nframes);
 292                 }
 293
 294         } else {
 295
 296                 // Do a 1:1 copy of data to output ports
 297
 298                 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
 299                         _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
 300                 }
 301
 302                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 303                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
 304                 }
 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 (_panner->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                 _panner->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 (panners_legal) {
 361                 if (!no_panner_reset) {
 362
 363                         uint32_t ntargets;
 364
 365                         if (_output) {
 366                                 ntargets = _output->n_ports().n_audio();
 367                         } else {
 368                                 ntargets = _configured_output.n_audio();
 369                         }
 370
 371                         _panner->reset (ntargets, pans_required());
 372                 }
 373         } else {
 374                 panner_legal_c.disconnect ();
 375                 PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
 376         }
 377 }
 378
 379 int
 380 Delivery::panners_became_legal ()
 381 {
 382         uint32_t ntargets;
 383
 384         if (_output) {
 385                 ntargets = _output->n_ports().n_audio();
 386         } else {
 387                 ntargets = _configured_output.n_audio();
 388         }
 389
 390         _panner->reset (ntargets, pans_required());
 391         _panner->load (); // automation
 392         panner_legal_c.disconnect ();
 393         return 0;
 394 }
 395
 396 void
 397 Delivery::defer_pan_reset ()
 398 {
 399         no_panner_reset = true;
 400 }
 401
 402 void
 403 Delivery::allow_pan_reset ()
 404 {
 405         no_panner_reset = false;
 406         reset_panner ();
 407 }
 408
 409
 410 int
 411 Delivery::disable_panners (void)
 412 {
 413         panners_legal = false;
 414         return 0;
 415 }
 416
 417 int
 418 Delivery::reset_panners ()
 419 {
 420         panners_legal = true;
 421         return *PannersLegal ();
 422 }
 423
 424
 425 void
 426 Delivery::start_pan_touch (uint32_t which)
 427 {
 428         if (which < _panner->npanners()) {
 429                 _panner->pan_control(which)->start_touch();
 430         }
 431 }
 432
 433 void
 434 Delivery::end_pan_touch (uint32_t which)
 435 {
 436         if (which < _panner->npanners()) {
 437                 _panner->pan_control(which)->stop_touch();
 438         }
 439
 440 }
 441
 442 void
 443 Delivery::transport_stopped (sframes_t frame)
 444 {
 445         _panner->transport_stopped (frame);
 446 }
 447
 448 void
 449 Delivery::flush (nframes_t nframes, nframes64_t time)
 450 {
 451         /* io_lock, not taken: function must be called from Session::process() calltree */
 452
 453         PortSet& ports (_output->ports());
 454
 455         for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 456                 (*i).flush_buffers (nframes, time, _output_offset);
 457         }
 458 }
 459
 460 void
 461 Delivery::transport_stopped ()
 462 {
 463         /* turn off any notes that are on */
 464
 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 gain_t
 473 Delivery::target_gain ()
 474 {
 475         /* if we've been requested to deactivate, our target gain is zero */
 476
 477         if (!_pending_active) {
 478                 return 0.0;
 479         }
 480
 481         /* if we've been told not to output because its a monitoring situation and
 482            we're not monitoring, then be quiet.
 483         */
 484
 485         if (_no_outs_cuz_we_no_monitor) {
 486                 return 0.0;
 487         }
 488
 489         gain_t desired_gain = -1.0f;
 490
 491         if (_solo_level || _solo_ignored) {
 492
 493                 desired_gain = 1.0;
 494
 495         } else {
 496
 497                 if (_role == Listen && _session.monitor_out() && !_session.soloing()) {
 498
 499                         /* nobody is soloed, so control/monitor/listen bus gets its
 500                            signal from master out, we should be silent
 501                         */
 502                         desired_gain = 0.0;
 503
 504                 } else {
 505
 506                         MuteMaster::MutePoint mp;
 507
 508                         switch (_role) {
 509                         case Main:
 510                                 mp = MuteMaster::Main;
 511                                 break;
 512                         case Listen:
 513                                 mp = MuteMaster::Listen;
 514                                 break;
 515                         case Send:
 516                         case Insert:
 517                         case Aux:
 518                                 /* XXX FIX ME this is wrong, we need per-delivery muting */
 519                                 mp = MuteMaster::PreFader;
 520                                 break;
 521                         }
 522
 523                         if (!_solo_isolated && _session.soloing()) {
 524                                 desired_gain = min (Config->get_solo_mute_gain(), _mute_master->mute_gain_at (mp));
 525
 526                         } else {
 527
 528                                 desired_gain = _mute_master->mute_gain_at (mp);
 529                         }
 530                 }
 531         }
 532
 533         return desired_gain;
 534 }
 535
 536 void
 537 Delivery::no_outs_cuz_we_no_monitor (bool yn)
 538 {
 539         _no_outs_cuz_we_no_monitor = yn;
 540 }
 541
 542 bool
 543 Delivery::set_name (const std::string& name)
 544 {
 545         bool ret = IOProcessor::set_name (name);
 546
 547         if (ret) {
 548                 ret = _panner->set_name (name);
 549         }
 550
 551         return ret;
 552 }
 553
 554 void
 555 Delivery::output_changed (IOChange change, void* /*src*/)
 556 {
 557         if (change & ARDOUR::ConfigurationChanged) {
 558                 reset_panner ();
 559         }
 560 }
 561