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