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, Stateful::loading_state_version);
  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         // Can't automate gain for sends or returns yet because we need different buffers
 113         // so that we don't overwrite the main automation data for the route amp
 114         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 115
 116         _amp->run (mixbufs, start_frame, end_frame, nframes);
 117
 118         /* XXX NEED TO PAN */
 119
 120         /* consider metering */
 121
 122         if (_metering) {
 123                 if (_amp->gain_control()->get_value() == 0) {
 124                         _meter->reset();
 125                 } else {
 126                         _meter->run (mixbufs, start_frame, end_frame, nframes);
 127                 }
 128         }
 129
 130         /* deliver to target */
 131
 132         target->merge_from (mixbufs, nframes);
 133
 134   out:
 135         _active = _pending_active;
 136 }
 137
 138 void
 139 InternalSend::set_block_size (nframes_t nframes)
 140 {
 141         mixbufs.ensure_buffers (_configured_input, nframes);
 142 }
 143
 144 bool
 145 InternalSend::feeds (boost::shared_ptr<Route> other) const
 146 {
 147         return _send_to == other;
 148 }
 149
 150 XMLNode&
 151 InternalSend::state (bool full)
 152 {
 153         XMLNode& node (Send::state (full));
 154
 155         /* this replaces any existing "type" property */
 156
 157         node.add_property ("type", "intsend");
 158
 159         if (_send_to) {
 160                 node.add_property ("target", _send_to->id().to_s());
 161         }
 162
 163         return node;
 164 }
 165
 166 XMLNode&
 167 InternalSend::get_state()
 168 {
 169         return state (true);
 170 }
 171
 172 int
 173 InternalSend::set_state (const XMLNode& node, int version)
 174 {
 175         const XMLProperty* prop;
 176
 177         Send::set_state (node, version);
 178
 179         if ((prop = node.property ("target")) != 0) {
 180
 181                 _send_to_id = prop->value();
 182
 183                 /* if we're loading a session, the target route may not have been
 184                    create yet. make sure we defer till we are sure that it should
 185                    exist.
 186                 */
 187
 188                 if (!IO::connecting_legal) {
 189                         connect_c = IO::ConnectingLegal.connect (mem_fun (*this, &InternalSend::connect_when_legal));
 190                 } else {
 191                         connect_when_legal ();
 192                 }
 193         }
 194
 195         return 0;
 196 }
 197
 198 int
 199 InternalSend::connect_when_legal ()
 200 {
 201         connect_c.disconnect ();
 202
 203         if (_send_to_id == "0") {
 204                 /* it vanished before we could connect */
 205                 return 0;
 206         }
 207
 208         if ((_send_to = _session.route_by_id (_send_to_id)) == 0) {
 209                 error << X_("cannot find route to connect to") << endmsg;
 210                 return -1;
 211         }
 212
 213         if ((target = _send_to->get_return_buffer ()) == 0) {
 214                 error << X_("target for internal send has no return buffer") << endmsg;
 215                 return -1;
 216         }
 217
 218         return 0;
 219 }
 220
 221 bool
 222 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 223 {
 224         out = in;
 225         return true;
 226 }
 227
 228 bool
 229 InternalSend::configure_io (ChanCount in, ChanCount out)
 230 {
 231         bool ret = Send::configure_io (in, out);
 232         set_block_size (_session.engine().frames_per_cycle());
 233         return ret;
 234 }
 235
 236 bool
 237 InternalSend::set_name (const std::string& str)
 238 {
 239         /* rules for external sends don't apply to us */
 240         return IOProcessor::set_name (str);
 241 }
 242
 243 std::string
 244 InternalSend::display_name () const
 245 {
 246         if (_role == Aux) {
 247                 return string_compose (X_("aux-%1"), _name);
 248         } else {
 249                 return _name;
 250         }
 251 }
 252
 253 bool
 254 InternalSend::visible () const
 255 {
 256         if (_role == Aux) {
 257                 return true;
 258         }
 259
 260         return false;
 261 }