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/buffer_set.h"
30 #include "ardour/meter.h"
31 #include "ardour/io.h"
32 #include "ardour/panner_shell.h"
37 class AutomationControl;
42 using namespace ARDOUR;
47 Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot, bool ignore_bitslot)
50 /* this happens during initial construction of sends from XML,
51 before they get ::set_state() called. lets not worry about
60 return string_compose (_("aux %1"), (bitslot = s.next_aux_send_id ()) + 1);
61 case Delivery::Listen:
62 return _("listen"); // no ports, no need for numbering
64 return string_compose (_("send %1"), (bitslot = s.next_send_id ()) + 1);
66 fatal << string_compose (_("programming error: send created using role %1"), enum_2_string (r)) << endmsg;
73 Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r, bool ignore_bitslot)
74 : Delivery (s, p, mm, name_and_id_new_send (s, r, _bitslot, ignore_bitslot), r)
77 if (_role == Listen) {
78 /* we don't need to do this but it keeps things looking clean
79 in a debugger. _bitslot is not used by listen sends.
84 //boost_debug_shared_ptr_mark_interesting (this, "send");
86 _amp.reset (new Amp (_session));
87 _meter.reset (new PeakMeter (_session, name()));
89 add_control (_amp->gain_control ());
92 panner_shell()->Changed.connect_same_thread (*this, boost::bind (&Send::panshell_changed, this));
98 _session.unmark_send_id (_bitslot);
107 Processor::activate ();
114 _meter->deactivate ();
117 Processor::deactivate ();
121 Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
123 if (_output->n_ports() == ChanCount::ZERO) {
125 _active = _pending_active;
129 if (!_active && !_pending_active) {
131 _output->silence (nframes);
132 _active = _pending_active;
136 // we have to copy the input, because deliver_output() may alter the buffers
137 // in-place, which a send must never do.
139 BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
140 sendbufs.read_from (bufs, nframes);
141 assert(sendbufs.count() == bufs.count());
145 _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
146 _amp->setup_gain_automation (start_frame, end_frame, nframes);
147 _amp->run (sendbufs, start_frame, end_frame, nframes, true);
149 /* deliver to outputs */
151 Delivery::run (sendbufs, start_frame, end_frame, nframes, true);
153 /* consider metering */
156 if (_amp->gain_control()->get_value() == 0) {
159 _meter->run (*_output_buffers, start_frame, end_frame, nframes, true);
163 /* _active was set to _pending_active by Delivery::run() */
167 Send::get_state(void)
173 Send::state (bool full)
175 XMLNode& node = Delivery::state(full);
178 node.add_property ("type", "send");
179 snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
181 if (_role != Listen) {
182 node.add_property ("bitslot", buf);
185 node.add_child_nocopy (_amp->state (full));
191 Send::set_state (const XMLNode& node, int version)
193 if (version < 3000) {
194 return set_state_2X (node, version);
197 const XMLProperty* prop;
199 Delivery::set_state (node, version);
201 if (node.property ("ignore-bitslot") == 0) {
203 /* don't try to reset bitslot if there is a node for it already: this can cause
204 issues with the session's accounting of send ID's
207 if ((prop = node.property ("bitslot")) == 0) {
208 if (_role == Delivery::Aux) {
209 _bitslot = _session.next_aux_send_id ();
210 } else if (_role == Delivery::Send) {
211 _bitslot = _session.next_send_id ();
213 // bitslot doesn't matter but make it zero anyway
217 if (_role == Delivery::Aux) {
218 _session.unmark_aux_send_id (_bitslot);
219 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
220 _session.mark_aux_send_id (_bitslot);
221 } else if (_role == Delivery::Send) {
222 _session.unmark_send_id (_bitslot);
223 sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
224 _session.mark_send_id (_bitslot);
226 // bitslot doesn't matter but make it zero anyway
232 XMLNodeList nlist = node.children();
233 for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
234 if ((*i)->name() == X_("Processor")) {
235 _amp->set_state (**i, version);
243 Send::set_state_2X (const XMLNode& node, int /* version */)
245 /* use the IO's name for the name of the send */
246 XMLNodeList const & children = node.children ();
248 XMLNodeList::const_iterator i = children.begin();
249 while (i != children.end() && (*i)->name() != X_("Redirect")) {
253 if (i == children.end()) {
257 XMLNodeList const & grand_children = (*i)->children ();
258 XMLNodeList::const_iterator j = grand_children.begin ();
259 while (j != grand_children.end() && (*j)->name() != X_("IO")) {
263 if (j == grand_children.end()) {
267 XMLProperty const * prop = (*j)->property (X_("name"));
272 set_name (prop->value ());
278 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out)
280 /* sends have no impact at all on the channel configuration of the
281 streams passing through the route. so, out == in.
288 /** Caller must hold process lock */
290 Send::configure_io (ChanCount in, ChanCount out)
292 if (!_amp->configure_io (in, out)) {
296 if (!Processor::configure_io (in, out)) {
300 if (!_meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()))) {
310 Send::panshell_changed ()
312 _meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
316 Send::set_name (const string& new_name)
320 if (_role == Delivery::Send) {
323 /* rip any existing numeric part of the name, and append the bitslot
326 string::size_type last_letter = new_name.find_last_not_of ("0123456789");
328 if (last_letter != string::npos) {
329 unique_name = new_name.substr (0, last_letter + 1);
331 unique_name = new_name;
334 snprintf (buf, sizeof (buf), "%u", (_bitslot + 1));
338 unique_name = new_name;
341 return Delivery::set_name (unique_name);
345 Send::display_to_user () const
347 /* we ignore Deliver::_display_to_user */
349 if (_role == Listen) {
350 /* don't make the monitor/control/listen send visible */
358 Send::value_as_string (boost::shared_ptr<AutomationControl> ac) const
360 return _amp->value_as_string (ac);