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