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