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