2 Copyright (C) 2000 Paul Davis
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.
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.
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.
23 #include "pbd/xml++.h"
24 #include "pbd/boost_debug.h"
26 #include "ardour/amp.h"
27 #include "ardour/send.h"
28 #include "ardour/session.h"
29 #include "ardour/port.h"
30 #include "ardour/audio_port.h"
31 #include "ardour/buffer_set.h"
32 #include "ardour/meter.h"
33 #include "ardour/panner.h"
34 #include "ardour/io.h"
38 using namespace ARDOUR;
43 Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot)
46 /* this happens during initial construction of sends from XML,
47 before they get ::set_state() called. lets not worry about
56 return string_compose (_("aux %1"), (bitslot = s.next_aux_send_id ()) + 1);
57 case Delivery::Listen:
58 return _("listen"); // no ports, no need for numbering
60 return string_compose (_("send %1"), (bitslot = s.next_send_id ()) + 1);
62 fatal << string_compose (_("programming error: send created using role %1"), enum_2_string (r)) << endmsg;
69 Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r)
70 : Delivery (s, p, mm, name_and_id_new_send (s, r, _bitslot), r)
73 if (_role == Listen) {
74 /* we don't need to do this but it keeps things looking clean
75 in a debugger. _bitslot is not used by listen sends.
80 boost_debug_shared_ptr_mark_interesting (this, "send");
82 _amp.reset (new Amp (_session));
83 _meter.reset (new PeakMeter (_session));
85 add_control (_amp->gain_control ());
90 _session.unmark_send_id (_bitslot);
99 Processor::activate ();
106 _meter->deactivate ();
109 Processor::deactivate ();
113 Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
115 if (_output->n_ports() == ChanCount::ZERO) {
117 _active = _pending_active;
121 if (!_active && !_pending_active) {
123 _output->silence (nframes);
124 _active = _pending_active;
128 // we have to copy the input, because deliver_output() may alter the buffers
129 // in-place, which a send must never do.
131 BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
132 sendbufs.read_from (bufs, nframes);
133 assert(sendbufs.count() == bufs.count());
137 // Can't automate gain for sends or returns yet because we need different buffers
138 // so that we don't overwrite the main automation data for the route amp
139 // _amp->setup_gain_automation (start_frame, end_frame, nframes);
140 _amp->run (sendbufs, start_frame, end_frame, nframes, true);
142 /* deliver to outputs */
144 Delivery::run (sendbufs, start_frame, end_frame, nframes, true);
146 /* consider metering */
149 if (_amp->gain_control()->get_value() == 0) {
152 _meter->run (*_output_buffers, start_frame, end_frame, nframes, true);
156 /* _active was set to _pending_active by Delivery::run() */
160 Send::get_state(void)
166 Send::state (bool full)
168 XMLNode& node = Delivery::state(full);
171 node.add_property ("type", "send");
172 snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
174 if (_role != Listen) {
175 node.add_property ("bitslot", buf);
178 node.add_child_nocopy (_amp->state (full));
184 Send::set_state (const XMLNode& node, int version)
186 if (version < 3000) {
187 return set_state_2X (node, version);
190 const XMLProperty* prop;
192 Delivery::set_state (node, version);
194 /* don't try to reset bitslot if there is a node for it already: this can cause
195 issues with the session's accounting of send ID's
198 if ((prop = node.property ("bitslot")) == 0) {
199 if (_role == Delivery::Aux) {
200 _bitslot = _session.next_aux_send_id ();
201 } else if (_role == Delivery::Send) {
202 _bitslot = _session.next_send_id ();
204 // bitslot doesn't matter but make it zero anyway
208 if (_role == Delivery::Aux) {
209 _session.unmark_aux_send_id (_bitslot);
210 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
211 _session.mark_aux_send_id (_bitslot);
212 } else if (_role == Delivery::Send) {
213 _session.unmark_send_id (_bitslot);
214 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
215 _session.mark_send_id (_bitslot);
217 // bitslot doesn't matter but make it zero anyway
222 XMLNodeList nlist = node.children();
223 for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
224 if ((*i)->name() == X_("Processor")) {
225 _amp->set_state (**i, version);
233 Send::set_state_2X (const XMLNode& node, int /* version */)
235 /* use the IO's name for the name of the send */
236 XMLNodeList const & children = node.children ();
238 XMLNodeList::const_iterator i = children.begin();
239 while (i != children.end() && (*i)->name() != X_("Redirect")) {
243 if (i == children.end()) {
247 XMLNodeList const & grand_children = (*i)->children ();
248 XMLNodeList::const_iterator j = grand_children.begin ();
249 while (j != grand_children.end() && (*j)->name() != X_("IO")) {
253 if (j == grand_children.end()) {
257 XMLProperty const * prop = (*j)->property (X_("name"));
262 set_name (prop->value ());
268 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
270 /* sends have no impact at all on the channel configuration of the
271 streams passing through the route. so, out == in.
278 /** Caller must hold process lock */
280 Send::configure_io (ChanCount in, ChanCount out)
282 if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
286 if (!Processor::configure_io (in, out)) {
295 /** Set up the XML description of a send so that its name is unique.
296 * @param state XML send state.
297 * @param session Session.
300 Send::make_unique (XMLNode &state, Session &session)
302 uint32_t const bitslot = session.next_send_id() + 1;
305 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
306 state.property("bitslot")->set_value (buf);
308 string const name = string_compose (_("send %1"), bitslot);
310 state.property("name")->set_value (name);
312 XMLNode* io = state.child ("IO");
315 io->property("name")->set_value (name);
320 Send::set_name (const string& new_name)
324 if (_role == Delivery::Send) {
327 /* rip any existing numeric part of the name, and append the bitslot
330 string::size_type last_letter = new_name.find_last_not_of ("0123456789");
332 if (last_letter != string::npos) {
333 unique_name = new_name.substr (0, last_letter + 1);
335 unique_name = new_name;
338 snprintf (buf, sizeof (buf), "%u", (_bitslot + 1));
342 unique_name = new_name;
345 return Delivery::set_name (unique_name);
349 Send::display_to_user () const
351 /* we ignore Deliver::_display_to_user */
353 if (_role == Listen) {
354 /* don't make the monitor/control/listen send visible */