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 <iostream>
  21
  22 #include "pbd/error.h"
  23 #include "pbd/failed_constructor.h"
  24
  25 #include "ardour/amp.h"
  26 #include "ardour/internal_send.h"
  27 #include "ardour/meter.h"
  28 #include "ardour/route.h"
  29 #include "ardour/session.h"
  30
  31 #include "i18n.h"
  32
  33 using namespace PBD;
  34 using namespace ARDOUR;
  35
  36 InternalSend::InternalSend (Session& s, boost::shared_ptr<MuteMaster> mm, boost::shared_ptr<Route> sendto, Delivery::Role role)
  37         : Send (s, mm, role)
  38         , _send_to (sendto)
  39 {
  40         if ((target = _send_to->get_return_buffer ()) == 0) {
  41                 throw failed_constructor();
  42         }
  43
  44         set_name (sendto->name());
  45
  46         _send_to->GoingAway.connect (mem_fun (*this, &InternalSend::send_to_going_away));
  47 }
  48
  49 InternalSend::InternalSend (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
  50         : Send (s, mm, node, Delivery::Aux /* will be reset in set_state() */)
  51 {
  52         set_state (node);
  53 }
  54
  55 InternalSend::~InternalSend ()
  56 {
  57         if (_send_to) {
  58                 _send_to->release_return_buffer ();
  59         }
  60
  61         connect_c.disconnect ();
  62 }
  63
  64 void
  65 InternalSend::send_to_going_away ()
  66 {
  67         target = 0;
  68         _send_to.reset ();
  69         _send_to_id = "0";
  70 }
  71
  72 void
  73 InternalSend::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
  74 {
  75         if ((!_active && !_pending_active) || !target || !_send_to) {
  76                 _meter->reset ();
  77                 return;
  78         }
  79
  80         // we have to copy the input, because we may alter the buffers with the amp
  81         // in-place, which a send must never do.
  82
  83         assert(mixbufs.available() >= bufs.count());
  84         mixbufs.read_from (bufs, nframes);
  85
  86         /* gain control */
  87
  88         gain_t tgain = target_gain ();
  89
  90         if (tgain != _current_gain) {
  91
  92                 /* target gain has changed */
  93
  94                 Amp::apply_gain (mixbufs, nframes, _current_gain, tgain);
  95                 _current_gain = tgain;
  96
  97         } else if (tgain == 0.0) {
  98
  99                 /* we were quiet last time, and we're still supposed to be quiet.
 100                 */
 101
 102                 _meter->reset ();
 103                 Amp::apply_simple_gain (mixbufs, nframes, 0.0);
 104                 goto out;
 105
 106         } else if (tgain != 1.0) {
 107
 108                 /* target gain has not changed, but is not zero or unity */
 109                 Amp::apply_simple_gain (mixbufs, nframes, tgain);
 110         }
 111
 112
 113         // Can't automate gain for sends or returns yet because we need different buffers
 114         // so that we don't overwrite the main automation data for the route amp
 115         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 116
 117         _amp->run (mixbufs, start_frame, end_frame, nframes);
 118
 119         /* XXX NEED TO PAN */
 120
 121         /* consider metering */
 122
 123         if (_metering) {
 124                 if (_amp->gain_control()->get_value() == 0) {
 125                         _meter->reset();
 126                 } else {
 127                         _meter->run (mixbufs, start_frame, end_frame, nframes);
 128                 }
 129         }
 130
 131         /* deliver to target */
 132
 133         target->merge_from (mixbufs, nframes);
 134
 135   out:
 136         _active = _pending_active;
 137 }
 138
 139 void
 140 InternalSend::set_block_size (nframes_t nframes)
 141 {
 142         mixbufs.ensure_buffers (_configured_input, nframes);
 143 }
 144
 145 bool
 146 InternalSend::feeds (boost::shared_ptr<Route> other) const
 147 {
 148         return _send_to == other;
 149 }
 150
 151 XMLNode&
 152 InternalSend::state (bool full)
 153 {
 154         XMLNode& node (Send::state (full));
 155
 156         /* this replaces any existing property */
 157
 158         node.add_property ("type", "intsend");
 159
 160         if (_send_to) {
 161                 node.add_property ("target", _send_to->id().to_s());
 162         }
 163
 164         return node;
 165 }
 166
 167 XMLNode&
 168 InternalSend::get_state()
 169 {
 170         return state (true);
 171 }
 172
 173 int
 174 InternalSend::set_state (const XMLNode& node)
 175 {
 176         const XMLProperty* prop;
 177
 178         Send::set_state (node);
 179
 180         if ((prop = node.property ("target")) != 0) {
 181
 182                 _send_to_id = prop->value();
 183
 184                 /* if we're loading a session, the target route may not have been
 185                    create yet. make sure we defer till we are sure that it should
 186                    exist.
 187                 */
 188
 189                 if (!IO::connecting_legal) {
 190                         connect_c = IO::ConnectingLegal.connect (mem_fun (*this, &InternalSend::connect_when_legal));
 191                 } else {
 192                         connect_when_legal ();
 193                 }
 194         }
 195
 196         return 0;
 197 }
 198
 199 int
 200 InternalSend::connect_when_legal ()
 201 {
 202         connect_c.disconnect ();
 203
 204         if (_send_to_id == "0") {
 205                 /* it vanished before we could connect */
 206                 return 0;
 207         }
 208
 209         if ((_send_to = _session.route_by_id (_send_to_id)) == 0) {
 210                 error << X_("cannot find route to connect to") << endmsg;
 211                 return -1;
 212         }
 213
 214         if ((target = _send_to->get_return_buffer ()) == 0) {
 215                 error << X_("target for internal send has no return buffer") << endmsg;
 216                 return -1;
 217         }
 218
 219         return 0;
 220 }
 221
 222 bool
 223 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 224 {
 225         out = in;
 226         return true;
 227 }
 228
 229 bool
 230 InternalSend::configure_io (ChanCount in, ChanCount out)
 231 {
 232         bool ret = Send::configure_io (in, out);
 233         set_block_size (_session.engine().frames_per_cycle());
 234         return ret;
 235 }
 236
 237 bool
 238 InternalSend::set_name (const std::string& str)
 239 {
 240         /* rules for external sends don't apply to us */
 241         return IOProcessor::set_name (str);
 242 }
 243
 244 std::string
 245 InternalSend::display_name () const
 246 {
 247         if (_role == Aux) {
 248                 return string_compose (X_("aux-%1"), _name);
 249         } else {
 250                 return _name;
 251         }
 252 }
 253
 254 bool
 255 InternalSend::visible () const
 256 {
 257         if (_role == Aux) {
 258                 return true;
 259         }
 260
 261         return false;
 262 }