libs/ardour/send.cc

   1 /*
   2     Copyright (C) 2000 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 <algorithm>
  21
  22 #include "pbd/xml++.h"
  23
  24 #include "ardour/amp.h"
  25 #include "ardour/send.h"
  26 #include "ardour/session.h"
  27 #include "ardour/port.h"
  28 #include "ardour/audio_port.h"
  29 #include "ardour/buffer_set.h"
  30 #include "ardour/meter.h"
  31 #include "ardour/panner.h"
  32 #include "ardour/io.h"
  33
  34 #include "i18n.h"
  35
  36 using namespace ARDOUR;
  37 using namespace PBD;
  38
  39 Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, Role r)
  40         : Delivery (s, mm, string_compose (_("send %1"), (_bitslot = s.next_send_id()) + 1), r)
  41         , _metering (false)
  42 {
  43         _amp.reset (new Amp (_session, _mute_master));
  44         _meter.reset (new PeakMeter (_session));
  45
  46         ProcessorCreated (this); /* EMIT SIGNAL */
  47 }
  48
  49 Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node, Role r)
  50         : Delivery (s, mm, "send", r)
  51         , _metering (false)
  52 {
  53         _amp.reset (new Amp (_session, _mute_master));
  54         _meter.reset (new PeakMeter (_session));
  55
  56         if (set_state (node)) {
  57                 throw failed_constructor();
  58         }
  59
  60         ProcessorCreated (this); /* EMIT SIGNAL */
  61 }
  62
  63 Send::~Send ()
  64 {
  65         GoingAway ();
  66 }
  67
  68 void
  69 Send::activate ()
  70 {
  71         _amp->activate ();
  72         _meter->activate ();
  73
  74         Processor::activate ();
  75 }
  76
  77 void
  78 Send::deactivate ()
  79 {
  80         _amp->deactivate ();
  81         _meter->deactivate ();
  82
  83         Processor::deactivate ();
  84 }
  85
  86 void
  87 Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
  88 {
  89         if (!_active || _output->n_ports() == ChanCount::ZERO) {
  90                 _meter->reset ();
  91                 return;
  92         }
  93
  94         // we have to copy the input, because deliver_output() may alter the buffers
  95         // in-place, which a send must never do.
  96
  97         BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
  98         sendbufs.read_from (bufs, nframes);
  99         assert(sendbufs.count() == bufs.count());
 100
 101         /* gain control */
 102
 103         // Can't automate gain for sends or returns yet because we need different buffers
 104         // so that we don't overwrite the main automation data for the route amp
 105         // _amp->setup_gain_automation (start_frame, end_frame, nframes);
 106         _amp->run (sendbufs, start_frame, end_frame, nframes);
 107
 108         /* deliver to outputs */
 109
 110         Delivery::run (sendbufs, start_frame, end_frame, nframes);
 111
 112         /* consider metering */
 113
 114         if (_metering) {
 115                 if (_amp->gain_control()->get_value() == 0) {
 116                         _meter->reset();
 117                 } else {
 118                         _meter->run (*_output_buffers, start_frame, end_frame, nframes);
 119                 }
 120         }
 121 }
 122
 123 XMLNode&
 124 Send::get_state(void)
 125 {
 126         return state (true);
 127 }
 128
 129 XMLNode&
 130 Send::state(bool full)
 131 {
 132         XMLNode& node = Delivery::state(full);
 133         char buf[32];
 134
 135         node.add_property ("type", "send");
 136         snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
 137         node.add_property ("bitslot", buf);
 138
 139         return node;
 140 }
 141
 142 int
 143 Send::set_state(const XMLNode& node)
 144 {
 145         XMLNodeList nlist = node.children();
 146         XMLNodeIterator niter;
 147         const XMLProperty* prop;
 148
 149         if ((prop = node.property ("bitslot")) == 0) {
 150                 _bitslot = _session.next_send_id();
 151         } else {
 152                 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
 153                 _session.mark_send_id (_bitslot);
 154         }
 155
 156         const XMLNode* insert_node = &node;
 157
 158         /* XXX need to load automation state & data for amp */
 159
 160         Delivery::set_state (*insert_node);
 161
 162         return 0;
 163 }
 164
 165 bool
 166 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 167 {
 168         /* sends have no impact at all on the channel configuration of the
 169            streams passing through the route. so, out == in.
 170         */
 171
 172         out = in;
 173         return true;
 174 }
 175
 176 bool
 177 Send::configure_io (ChanCount in, ChanCount out)
 178 {
 179         if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
 180                 return false;
 181         }
 182
 183         return Processor::configure_io (in, out);
 184 }
 185
 186 /** Set up the XML description of a send so that its name is unique.
 187  *  @param state XML send state.
 188  *  @param session Session.
 189  */
 190 void
 191 Send::make_unique (XMLNode &state, Session &session)
 192 {
 193         uint32_t const bitslot = session.next_send_id() + 1;
 194
 195         char buf[32];
 196         snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
 197         state.property("bitslot")->set_value (buf);
 198
 199         std::string const name = string_compose (_("send %1"), bitslot);
 200
 201         state.property("name")->set_value (name);
 202
 203         XMLNode* io = state.child ("IO");
 204
 205         if (io) {
 206                 io->property("name")->set_value (name);
 207         }
 208 }
 209
 210 bool
 211 Send::set_name (const std::string& new_name)
 212 {
 213         std::string unique_name;
 214
 215         if (_role == Delivery::Send) {
 216                 char buf[32];
 217                 snprintf (buf, sizeof (buf), "%u", _bitslot);
 218                 unique_name = new_name;
 219                 unique_name += buf;
 220         } else {
 221                 unique_name = new_name;
 222         }
 223
 224         return Delivery::set_name (unique_name);
 225 }
 226
 227 bool
 228 Send::visible () const
 229 {
 230         if (_role == Listen) {
 231                 return false;
 232         }
 233
 234         return true;
 235 }