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 || !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         BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
  84         sendbufs.read_from (bufs, nframes);
  85         assert(sendbufs.count() == bufs.count());
  86
  87         /* gain control */
  88
  89         gain_t tgain = target_gain ();
  90
  91         if (tgain != _current_gain) {
  92
  93                 /* target gain has changed */
  94
  95                 Amp::apply_gain (sendbufs, nframes, _current_gain, tgain);
  96                 _current_gain = tgain;
  97
  98         } else if (tgain == 0.0) {
  99
 100                 /* we were quiet last time, and we're still supposed to be quiet.
 101                 */
 102
 103                 _meter->reset ();
 104                 Amp::apply_simple_gain (sendbufs, nframes, 0.0);
 105                 return;
 106
 107         } else if (tgain != 1.0) {
 108
 109                 /* target gain has not changed, but is not zero or unity */
 110                 Amp::apply_simple_gain (sendbufs, nframes, tgain);
 111         }
 112
 113
 114         // Can't automate gain for sends or returns yet because we need different buffers
 115         // so that we don't overwrite the main automation data for the route amp
 116         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 117
 118         _amp->run (sendbufs, start_frame, end_frame, nframes);
 119
 120         /* consider metering */
 121
 122         if (_metering) {
 123                 if (_amp->gain_control()->get_value() == 0) {
 124                         _meter->reset();
 125                 } else {
 126                         _meter->run (sendbufs, start_frame, end_frame, nframes);
 127                 }
 128         }
 129
 130         /* deliver to target */
 131
 132         target->merge_from (sendbufs, nframes);
 133 }
 134
 135 bool
 136 InternalSend::feeds (boost::shared_ptr<Route> other) const
 137 {
 138         return _send_to == other;
 139 }
 140
 141 XMLNode&
 142 InternalSend::state (bool full)
 143 {
 144         XMLNode& node (Send::state (full));
 145
 146         /* this replaces any existing property */
 147
 148         node.add_property ("type", "intsend");
 149
 150         if (_send_to) {
 151                 node.add_property ("target", _send_to->id().to_s());
 152         }
 153
 154         return node;
 155 }
 156
 157 XMLNode&
 158 InternalSend::get_state()
 159 {
 160         return state (true);
 161 }
 162
 163 int
 164 InternalSend::set_state (const XMLNode& node)
 165 {
 166         const XMLProperty* prop;
 167
 168         Send::set_state (node);
 169
 170         if ((prop = node.property ("target")) != 0) {
 171
 172                 _send_to_id = prop->value();
 173
 174                 /* if we're loading a session, the target route may not have been
 175                    create yet. make sure we defer till we are sure that it should
 176                    exist.
 177                 */
 178
 179                 if (!IO::connecting_legal) {
 180                         connect_c = IO::ConnectingLegal.connect (mem_fun (*this, &InternalSend::connect_when_legal));
 181                 } else {
 182                         connect_when_legal ();
 183                 }
 184         }
 185
 186         return 0;
 187 }
 188
 189 int
 190 InternalSend::connect_when_legal ()
 191 {
 192         connect_c.disconnect ();
 193
 194         if (_send_to_id == "0") {
 195                 /* it vanished before we could connect */
 196                 return 0;
 197         }
 198
 199         if ((_send_to = _session.route_by_id (_send_to_id)) == 0) {
 200                 error << X_("cannot find route to connect to") << endmsg;
 201                 return -1;
 202         }
 203
 204         if ((target = _send_to->get_return_buffer ()) == 0) {
 205                 error << X_("target for internal send has no return buffer") << endmsg;
 206                 return -1;
 207         }
 208
 209         return 0;
 210 }
 211
 212 bool
 213 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 214 {
 215         out = in;
 216         return true;
 217 }
 218
 219 bool
 220 InternalSend::set_name (const std::string& str)
 221 {
 222         /* rules for external sends don't apply to us */
 223         return IOProcessor::set_name (str);
 224 }
 225
 226 std::string
 227 InternalSend::display_name () const
 228 {
 229         if (_role == Aux) {
 230                 return string_compose (X_("aux-%1"), _name);
 231         } else {
 232                 return _name;
 233         }
 234 }
 235
 236 bool
 237 InternalSend::visible () const
 238 {
 239         if (_role == Aux) {
 240                 return true;
 241         }
 242
 243         return false;
 244 }