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