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