libs/ardour/internal_send.cc

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include "pbd/error.h"
  21 #include "pbd/failed_constructor.h"
  22 #include "pbd/types_convert.h"
  23
  24 #include "ardour/amp.h"
  25 #include "ardour/audio_buffer.h"
  26 #include "ardour/delayline.h"
  27 #include "ardour/internal_return.h"
  28 #include "ardour/internal_send.h"
  29 #include "ardour/meter.h"
  30 #include "ardour/panner_shell.h"
  31 #include "ardour/route.h"
  32 #include "ardour/session.h"
  33 #include "ardour/audioengine.h"
  34
  35 #include "pbd/i18n.h"
  36
  37 namespace ARDOUR { class MuteMaster; class Pannable; }
  38
  39 using namespace PBD;
  40 using namespace ARDOUR;
  41 using namespace std;
  42
  43 PBD::Signal1<void, pframes_t> InternalSend::CycleStart;
  44
  45 InternalSend::InternalSend (Session& s,
  46                 boost::shared_ptr<Pannable> p,
  47                 boost::shared_ptr<MuteMaster> mm,
  48                 boost::shared_ptr<Route> sendfrom,
  49                 boost::shared_ptr<Route> sendto,
  50                 Delivery::Role role,
  51                 bool ignore_bitslot)
  52         : Send (s, p, mm, role, ignore_bitslot)
  53         , _send_from (sendfrom)
  54         , _allow_feedback (false)
  55 {
  56         if (sendto) {
  57                 if (use_target (sendto)) {
  58                         throw failed_constructor();
  59                 }
  60         }
  61
  62         init_gain ();
  63
  64         _send_from->DropReferences.connect_same_thread (source_connection, boost::bind (&InternalSend::send_from_going_away, this));
  65         CycleStart.connect_same_thread (*this, boost::bind (&InternalSend::cycle_start, this, _1));
  66 }
  67
  68 InternalSend::~InternalSend ()
  69 {
  70         if (_send_to) {
  71                 _send_to->remove_send_from_internal_return (this);
  72         }
  73 }
  74
  75 void
  76 InternalSend::init_gain ()
  77 {
  78         if (_role == Listen) {
  79                 /* send to monitor bus is always at unity */
  80                 _gain_control->set_value (GAIN_COEFF_UNITY, PBD::Controllable::NoGroup);
  81         } else {
  82                 /* aux sends start at -inf dB */
  83                 _gain_control->set_value (GAIN_COEFF_ZERO, PBD::Controllable::NoGroup);
  84         }
  85 }
  86
  87 int
  88 InternalSend::use_target (boost::shared_ptr<Route> sendto)
  89 {
  90         if (_send_to) {
  91                 _send_to->remove_send_from_internal_return (this);
  92         }
  93
  94         _send_to = sendto;
  95
  96         _send_to->add_send_to_internal_return (this);
  97
  98         mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
  99         mixbufs.set_count (_send_to->internal_return()->input_streams());
 100
 101         _meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
 102
 103         _send_delay->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
 104
 105         reset_panner ();
 106
 107         set_name (sendto->name());
 108         _send_to_id = _send_to->id();
 109
 110         target_connections.drop_connections ();
 111
 112         _send_to->DropReferences.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_going_away, this));
 113         _send_to->PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_property_changed, this, _1));
 114         _send_to->io_changed.connect_same_thread (target_connections, boost::bind (&InternalSend::target_io_changed, this));
 115         boost::shared_ptr<Stripable> st_to = boost::dynamic_pointer_cast<Stripable> (_send_to);
 116         st_to->presentation_info().PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_pi_change, this, _1));
 117         send_to_pi_change (Properties::hidden);
 118
 119         return 0;
 120 }
 121
 122 void
 123 InternalSend::target_io_changed ()
 124 {
 125         assert (_send_to);
 126         mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), _session.get_block_size());
 127         mixbufs.set_count (_send_to->internal_return()->input_streams());
 128         reset_panner();
 129 }
 130
 131 void
 132 InternalSend::send_from_going_away ()
 133 {
 134         _send_from.reset();
 135 }
 136
 137 void
 138 InternalSend::send_to_going_away ()
 139 {
 140         target_connections.drop_connections ();
 141         _send_to.reset ();
 142         _send_to_id = "0";
 143 }
 144
 145 void
 146 InternalSend::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)
 147 {
 148         if ((!_active && !_pending_active) || !_send_to) {
 149                 _meter->reset ();
 150                 return;
 151         }
 152
 153         // we have to copy the input, because we may alter the buffers with the amp
 154         // in-place, which a send must never do.
 155
 156         if (_panshell && !_panshell->bypassed() && role() != Listen) {
 157                 if (mixbufs.count ().n_audio () > 0) {
 158                         _panshell->run (bufs, mixbufs, start_sample, end_sample, nframes);
 159                 }
 160
 161                 /* non-audio data will not have been copied by the panner, do it now
 162                  * if there are more buffers available than send buffers, ignore them,
 163                  * if there are less, copy the last as IO::copy_to_output does. */
 164
 165                 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
 166                         if (*t != DataType::AUDIO) {
 167                                 BufferSet::iterator o = mixbufs.begin(*t);
 168                                 BufferSet::iterator i = bufs.begin(*t);
 169
 170                                 while (i != bufs.end(*t) && o != mixbufs.end(*t)) {
 171                                         o->read_from (*i, nframes);
 172                                         ++i;
 173                                         ++o;
 174                                 }
 175                                 while (o != mixbufs.end(*t)) {
 176                                         o->silence(nframes, 0);
 177                                         ++o;
 178                                 }
 179                         }
 180                 }
 181         } else {
 182                 if (role() == Listen) {
 183                         /* We're going to the monitor bus, so discard MIDI data */
 184
 185                         uint32_t const bufs_audio = bufs.count().get (DataType::AUDIO);
 186                         uint32_t const mixbufs_audio = mixbufs.count().get (DataType::AUDIO);
 187
 188                         /* monitor-section has same number of channels as master-bus (on creation).
 189                          *
 190                          * There is no clear answer what should happen when trying to PFL or AFL
 191                          * a track that has more channels (bufs_audio from source-track is
 192                          * larger than mixbufs).
 193                          *
 194                          * There are two options:
 195                          *  1: discard additional channels    (current)
 196                          * OR
 197                          *  2: require the monitor-section to have at least as many channels
 198                          * as the largest count of any route
 199                          */
 200                         //assert (mixbufs.available().get (DataType::AUDIO) >= bufs_audio);
 201
 202                         /* Copy bufs into mixbufs, going round bufs more than once if necessary
 203                            to ensure that every mixbuf gets some data.
 204                         */
 205
 206                         uint32_t j = 0;
 207                         uint32_t i = 0;
 208                         for (i = 0; i < mixbufs_audio && j < bufs_audio; ++i) {
 209                                 mixbufs.get_audio(i).read_from (bufs.get_audio(j), nframes);
 210                                 ++j;
 211
 212                                 if (j == bufs_audio) {
 213                                         j = 0;
 214                                 }
 215                         }
 216                         /* in case or MIDI track with 0 audio channels */
 217                         for (; i < mixbufs_audio; ++i) {
 218                                 mixbufs.get_audio(i).silence (nframes);
 219                         }
 220
 221                 } else {
 222                         assert (mixbufs.available() >= bufs.count());
 223                         mixbufs.read_from (bufs, nframes);
 224                 }
 225         }
 226
 227         /* gain control */
 228
 229         gain_t tgain = target_gain ();
 230
 231         if (tgain != _current_gain) {
 232
 233                 /* target gain has changed */
 234
 235                 _current_gain = Amp::apply_gain (mixbufs, _session.nominal_sample_rate(), nframes, _current_gain, tgain);
 236
 237         } else if (tgain == GAIN_COEFF_ZERO) {
 238
 239                 /* we were quiet last time, and we're still supposed to be quiet.
 240                 */
 241
 242                 _meter->reset ();
 243                 Amp::apply_simple_gain (mixbufs, nframes, GAIN_COEFF_ZERO);
 244                 goto out;
 245
 246         } else if (tgain != GAIN_COEFF_UNITY) {
 247
 248                 /* target gain has not changed, but is not zero or unity */
 249                 Amp::apply_simple_gain (mixbufs, nframes, tgain);
 250         }
 251
 252         _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
 253         _amp->setup_gain_automation (start_sample, end_sample, nframes);
 254         _amp->run (mixbufs, start_sample, end_sample, speed, nframes, true);
 255
 256         _send_delay->run (mixbufs, start_sample, end_sample, speed, nframes, true);
 257
 258         /* consider metering */
 259
 260         if (_metering) {
 261                 if (_amp->gain_control()->get_value() == GAIN_COEFF_ZERO) {
 262                         _meter->reset();
 263                 } else {
 264                         _meter->run (mixbufs, start_sample, end_sample, speed, nframes, true);
 265                 }
 266         }
 267
 268         _thru_delay->run (bufs, start_sample, end_sample, speed, nframes, true);
 269
 270         /* target will pick up our output when it is ready */
 271
 272   out:
 273         _active = _pending_active;
 274 }
 275
 276 int
 277 InternalSend::set_block_size (pframes_t nframes)
 278 {
 279         if (_send_to) {
 280                 mixbufs.ensure_buffers (_send_to->internal_return()->input_streams(), nframes);
 281         }
 282
 283         return 0;
 284 }
 285
 286 void
 287 InternalSend::set_allow_feedback (bool yn)
 288 {
 289         _allow_feedback = yn;
 290         _send_from->processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
 291 }
 292
 293 bool
 294 InternalSend::feeds (boost::shared_ptr<Route> other) const
 295 {
 296         if (_role == Listen || !_allow_feedback) {
 297                 return _send_to == other;
 298         }
 299         return false;
 300 }
 301
 302 XMLNode&
 303 InternalSend::state ()
 304 {
 305         XMLNode& node (Send::state ());
 306
 307         /* this replaces any existing "type" property */
 308
 309         node.set_property ("type", "intsend");
 310
 311         if (_send_to) {
 312                 node.set_property ("target", _send_to->id());
 313         }
 314         node.set_property ("allow-feedback", _allow_feedback);
 315
 316         return node;
 317 }
 318
 319 int
 320 InternalSend::set_state (const XMLNode& node, int version)
 321 {
 322         init_gain ();
 323
 324         Send::set_state (node, version);
 325
 326         if (node.get_property ("target", _send_to_id)) {
 327
 328                 /* if we're loading a session, the target route may not have been
 329                    create yet. make sure we defer till we are sure that it should
 330                    exist.
 331                 */
 332
 333                 if (!IO::connecting_legal) {
 334                         IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
 335                 } else {
 336                         connect_when_legal ();
 337                 }
 338         }
 339
 340         node.get_property (X_("allow-feedback"), _allow_feedback);
 341
 342         return 0;
 343 }
 344
 345 int
 346 InternalSend::connect_when_legal ()
 347 {
 348         connect_c.disconnect ();
 349
 350         if (_send_to_id == "0") {
 351                 /* it vanished before we could connect */
 352                 return 0;
 353         }
 354
 355         boost::shared_ptr<Route> sendto;
 356
 357         if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
 358                 error << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endmsg;
 359                 cerr << string_compose (_("%1 - cannot find any track/bus with the ID %2 to connect to"), display_name(), _send_to_id) << endl;
 360                 return -1;
 361         }
 362
 363         return use_target (sendto);
 364 }
 365
 366 bool
 367 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 368 {
 369         out = in;
 370         return true;
 371 }
 372
 373 uint32_t
 374 InternalSend::pan_outs () const
 375 {
 376         /* the number of targets for our panner is determined by what we are
 377            sending to, if anything.
 378         */
 379
 380         if (_send_to) {
 381                 return _send_to->internal_return()->input_streams().n_audio();
 382         }
 383
 384         return 1; /* zero is more accurate, but 1 is probably safer as a way to
 385                    * say "don't pan"
 386                    */
 387 }
 388
 389 bool
 390 InternalSend::configure_io (ChanCount in, ChanCount out)
 391 {
 392         bool ret = Send::configure_io (in, out);
 393         set_block_size (_session.engine().samples_per_cycle());
 394         return ret;
 395 }
 396
 397 bool
 398 InternalSend::set_name (const string& str)
 399 {
 400         /* rules for external sends don't apply to us */
 401         return IOProcessor::set_name (str);
 402 }
 403
 404 string
 405 InternalSend::display_name () const
 406 {
 407         if (_role == Aux) {
 408                 return string_compose (X_("%1"), _name);
 409         } else {
 410                 return _name;
 411         }
 412 }
 413
 414 bool
 415 InternalSend::visible () const
 416 {
 417         if (_role == Aux) {
 418                 return true;
 419         }
 420
 421         return false;
 422 }
 423
 424 void
 425 InternalSend::send_to_property_changed (const PropertyChange& what_changed)
 426 {
 427         if (what_changed.contains (Properties::name)) {
 428                 set_name (_send_to->name ());
 429         }
 430 }
 431
 432 void
 433 InternalSend::send_to_pi_change (const PBD::PropertyChange& what_changed)
 434 {
 435         if (what_changed.contains (Properties::hidden)) {
 436                 boost::shared_ptr<Stripable> st_to = boost::dynamic_pointer_cast<Stripable> (_send_to);
 437                 if (Config->get_hiding_aux_hides_connected_sends()) {
 438                         set_display_to_user (!st_to->is_hidden ());
 439                 } else {
 440                         set_display_to_user (true);
 441                 }
 442                 _send_from->processors_changed (RouteProcessorChange ()); /* EMIT SIGNAL */
 443         }
 444 }
 445
 446 void
 447 InternalSend::set_can_pan (bool yn)
 448 {
 449         if (_panshell) {
 450                 _panshell->set_bypassed (!yn);
 451         }
 452 }
 453
 454 void
 455 InternalSend::cycle_start (pframes_t /*nframes*/)
 456 {
 457         for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {
 458                 b->prepare ();
 459         }
 460 }