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         if (_panshell && !_panshell->bypassed()) {
 113                 mixbufs.set_count (_send_to->n_outputs ());
 114                 _panshell->run (bufs, mixbufs, start_frame, end_frame, nframes);
 115         } else {
 116                 mixbufs.read_from (bufs, nframes);
 117         }
 118
 119         /* gain control */
 120
 121         gain_t tgain = target_gain ();
 122
 123         if (tgain != _current_gain) {
 124
 125                 /* target gain has changed */
 126
 127                 Amp::apply_gain (mixbufs, nframes, _current_gain, tgain);
 128                 _current_gain = tgain;
 129
 130         } else if (tgain == 0.0) {
 131
 132                 /* we were quiet last time, and we're still supposed to be quiet.
 133                 */
 134
 135                 _meter->reset ();
 136                 Amp::apply_simple_gain (mixbufs, nframes, 0.0);
 137                 goto out;
 138
 139         } else if (tgain != 1.0) {
 140
 141                 /* target gain has not changed, but is not zero or unity */
 142                 Amp::apply_simple_gain (mixbufs, nframes, tgain);
 143         }
 144
 145         // Can't automate gain for sends or returns yet because we need different buffers
 146         // so that we don't overwrite the main automation data for the route amp
 147         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 148
 149         _amp->run (mixbufs, start_frame, end_frame, nframes, true);
 150
 151         /* consider metering */
 152
 153         if (_metering) {
 154                 if (_amp->gain_control()->get_value() == 0) {
 155                         _meter->reset();
 156                 } else {
 157                         _meter->run (mixbufs, start_frame, end_frame, nframes, true);
 158                 }
 159         }
 160
 161 #if 0
 162         if (_session.transport_rolling()) {
 163                 for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {
 164                         Sample* p = b->data ();
 165                         for (pframes_t n = 0; n < nframes; ++n) {
 166                                 if (p[n] != 0.0) {
 167                                         cerr << "\tnon-zero data SENT to " << b->data() << endl;
 168                                         break;
 169                                 }
 170                         }
 171                 }
 172         }
 173 #endif
 174
 175         /* target will pick up our output when it is ready */
 176
 177   out:
 178         _active = _pending_active;
 179 }
 180
 181 int
 182 InternalSend::set_block_size (pframes_t nframes)
 183 {
 184         mixbufs.ensure_buffers (_configured_input, nframes);
 185         return 0;
 186 }
 187
 188 bool
 189 InternalSend::feeds (boost::shared_ptr<Route> other) const
 190 {
 191         return _send_to == other;
 192 }
 193
 194 XMLNode&
 195 InternalSend::state (bool full)
 196 {
 197         XMLNode& node (Send::state (full));
 198
 199         /* this replaces any existing "type" property */
 200
 201         node.add_property ("type", "intsend");
 202
 203         if (_send_to) {
 204                 node.add_property ("target", _send_to->id().to_s());
 205         }
 206
 207         return node;
 208 }
 209
 210 XMLNode&
 211 InternalSend::get_state()
 212 {
 213         return state (true);
 214 }
 215
 216 int
 217 InternalSend::set_state (const XMLNode& node, int version)
 218 {
 219         const XMLProperty* prop;
 220
 221         init_gain ();
 222
 223         Send::set_state (node, version);
 224
 225         if ((prop = node.property ("target")) != 0) {
 226
 227                 _send_to_id = prop->value();
 228
 229                 /* if we're loading a session, the target route may not have been
 230                    create yet. make sure we defer till we are sure that it should
 231                    exist.
 232                 */
 233
 234                 if (!IO::connecting_legal) {
 235                         IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
 236                 } else {
 237                         connect_when_legal ();
 238                 }
 239         }
 240
 241         return 0;
 242 }
 243
 244 int
 245 InternalSend::connect_when_legal ()
 246 {
 247         connect_c.disconnect ();
 248
 249         if (_send_to_id == "0") {
 250                 /* it vanished before we could connect */
 251                 return 0;
 252         }
 253
 254         boost::shared_ptr<Route> sendto;
 255
 256         if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
 257                 error << X_("cannot find route to connect to") << endmsg;
 258                 return -1;
 259         }
 260
 261         return use_target (sendto);
 262 }
 263
 264 bool
 265 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 266 {
 267         out = in;
 268         return true;
 269 }
 270
 271 bool
 272 InternalSend::configure_io (ChanCount in, ChanCount out)
 273 {
 274         bool ret = Send::configure_io (in, out);
 275         set_block_size (_session.engine().frames_per_cycle());
 276         return ret;
 277 }
 278
 279 bool
 280 InternalSend::set_name (const string& str)
 281 {
 282         /* rules for external sends don't apply to us */
 283         return IOProcessor::set_name (str);
 284 }
 285
 286 string
 287 InternalSend::display_name () const
 288 {
 289         if (_role == Aux) {
 290                 return string_compose (X_("aux-%1"), _name);
 291         } else {
 292                 return _name;
 293         }
 294 }
 295
 296 bool
 297 InternalSend::visible () const
 298 {
 299         if (_role == Aux) {
 300                 return true;
 301         }
 302
 303         return false;
 304 }
 305
 306 void
 307 InternalSend::send_to_property_changed (const PropertyChange& what_changed)
 308 {
 309         if (what_changed.contains (Properties::name)) {
 310                 set_name (_send_to->name ());
 311         }
 312 }
 313
 314 void
 315 InternalSend::set_can_pan (bool yn)
 316 {
 317         if (_panshell) {
 318                 _panshell->set_bypassed (!yn);
 319         }
 320 }
 321
 322 void
 323 InternalSend::cycle_start (pframes_t nframes)
 324 {
 325         Delivery::cycle_start (nframes);
 326
 327         for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {
 328                 (*b).prepare ();
 329         }
 330 }