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