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"
25 #include "ardour/amp.h"
26 #include "ardour/boost_debug.h"
27 #include "ardour/buffer_set.h"
28 #include "ardour/debug.h"
29 #include "ardour/delayline.h"
30 #include "ardour/gain_control.h"
31 #include "ardour/io.h"
32 #include "ardour/meter.h"
33 #include "ardour/panner_shell.h"
34 #include "ardour/send.h"
35 #include "ardour/session.h"
40 class AutomationControl;
45 using namespace ARDOUR;
49 PBD::Signal0<void> Send::ChangedLatency;
52 Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot, bool ignore_bitslot)
55 /* this happens during initial construction of sends from XML,
56 before they get ::set_state() called. lets not worry about
65 return string_compose (_("aux %1"), (bitslot = s.next_aux_send_id ()) + 1);
66 case Delivery::Listen:
67 return _("listen"); // no ports, no need for numbering
69 return string_compose (_("send %1"), (bitslot = s.next_send_id ()) + 1);
71 fatal << string_compose (_("programming error: send created using role %1"), enum_2_string (r)) << endmsg;
72 abort(); /*NOTREACHED*/
78 Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r, bool ignore_bitslot)
79 : Delivery (s, p, mm, name_and_id_new_send (s, r, _bitslot, ignore_bitslot), r)
83 , _remove_on_disconnect (false)
85 if (_role == Listen) {
86 /* we don't need to do this but it keeps things looking clean
87 in a debugger. _bitslot is not used by listen sends.
92 //boost_debug_shared_ptr_mark_interesting (this, "send");
94 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
95 _gain_control = boost::shared_ptr<GainControl> (new GainControl (_session, Evoral::Parameter(GainAutomation), gl));
96 add_control (_gain_control);
98 _amp.reset (new Amp (_session, _("Fader"), _gain_control, true));
99 _meter.reset (new PeakMeter (_session, name()));
101 _send_delay.reset (new DelayLine (_session, "Send-" + name()));
102 _thru_delay.reset (new DelayLine (_session, "Thru-" + name()));
104 if (panner_shell()) {
105 panner_shell()->Changed.connect_same_thread (*this, boost::bind (&Send::panshell_changed, this));
108 _output->changed.connect_same_thread (*this, boost::bind (&Send::snd_output_changed, this, _1, _2));
114 _session.unmark_send_id (_bitslot);
123 Processor::activate ();
130 _meter->deactivate ();
133 Processor::deactivate ();
137 Send::signal_latency () const
139 if (!_pending_active) {
143 return _user_latency;
145 if (_delay_out > _delay_in) {
146 return _delay_out - _delay_in;
152 Send::update_delaylines ()
154 if (_role == Listen) {
155 /* Don't align monitor-listen (just yet).
156 * They're present on each route, may change positions
157 * and could potentially signficiantly increase worst-case
158 * Latency: In PFL mode all tracks/busses would additionally be
159 * aligned at PFL position.
161 * We should only align active monitor-sends when at least one is active.
167 if (_delay_out > _delay_in) {
168 changed = _thru_delay->set_delay(_delay_out - _delay_in);
169 _send_delay->set_delay(0);
171 changed = _thru_delay->set_delay(0);
172 _send_delay->set_delay(_delay_in - _delay_out);
176 // TODO -- ideally postpone for effective no-op changes
177 // (in case both _delay_out and _delay_in are changed by the
178 // same amount in a single latency-update cycle).
179 ChangedLatency (); /* EMIT SIGNAL */
184 Send::set_delay_in (samplecnt_t delay)
186 if (_delay_in == delay) {
191 DEBUG_TRACE (DEBUG::LatencyCompensation,
192 string_compose ("Send::set_delay_in %1: (%2) - %3 = %4\n",
193 name (), _delay_in, _delay_out, _delay_in - _delay_out));
195 update_delaylines ();
199 Send::set_delay_out (samplecnt_t delay)
201 if (_delay_out == delay) {
205 DEBUG_TRACE (DEBUG::LatencyCompensation,
206 string_compose ("Send::set_delay_out %1: %2 - (%3) = %4\n",
207 name (), _delay_in, _delay_out, _delay_in - _delay_out));
209 update_delaylines ();
213 Send::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)
215 if (_output->n_ports() == ChanCount::ZERO) {
217 _active = _pending_active;
221 if (!_active && !_pending_active) {
223 _output->silence (nframes);
224 _active = _pending_active;
228 // we have to copy the input, because deliver_output() may alter the buffers
229 // in-place, which a send must never do.
231 BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
232 sendbufs.read_from (bufs, nframes);
233 assert(sendbufs.count() == bufs.count());
237 _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
238 _amp->setup_gain_automation (start_sample, end_sample, nframes);
239 _amp->run (sendbufs, start_sample, end_sample, speed, nframes, true);
241 _send_delay->run (sendbufs, start_sample, end_sample, speed, nframes, true);
243 /* deliver to outputs */
245 Delivery::run (sendbufs, start_sample, end_sample, speed, nframes, true);
247 /* consider metering */
250 if (_amp->gain_control()->get_value() == 0) {
253 _meter->run (*_output_buffers, start_sample, end_sample, speed, nframes, true);
257 _thru_delay->run (bufs, start_sample, end_sample, speed, nframes, true);
259 /* _active was set to _pending_active by Delivery::run() */
265 XMLNode& node = Delivery::state ();
267 node.set_property ("type", "send");
269 if (_role != Listen) {
270 node.set_property ("bitslot", _bitslot);
273 node.set_property ("selfdestruct", _remove_on_disconnect);
275 node.add_child_nocopy (_amp->get_state ());
281 Send::set_state (const XMLNode& node, int version)
283 if (version < 3000) {
284 return set_state_2X (node, version);
287 XMLProperty const * prop;
289 Delivery::set_state (node, version);
291 if (node.property ("ignore-bitslot") == 0) {
293 /* don't try to reset bitslot if there is a node for it already: this can cause
294 issues with the session's accounting of send ID's
297 if ((prop = node.property ("bitslot")) == 0) {
298 if (_role == Delivery::Aux) {
299 _bitslot = _session.next_aux_send_id ();
300 } else if (_role == Delivery::Send) {
301 _bitslot = _session.next_send_id ();
303 // bitslot doesn't matter but make it zero anyway
307 if (_role == Delivery::Aux) {
308 _session.unmark_aux_send_id (_bitslot);
309 _bitslot = string_to<uint32_t>(prop->value());
310 _session.mark_aux_send_id (_bitslot);
311 } else if (_role == Delivery::Send) {
312 _session.unmark_send_id (_bitslot);
313 _bitslot = string_to<uint32_t>(prop->value());
314 _session.mark_send_id (_bitslot);
316 // bitslot doesn't matter but make it zero anyway
322 node.get_property (X_("selfdestruct"), _remove_on_disconnect);
324 XMLNodeList nlist = node.children();
325 for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
326 if ((*i)->name() == X_("Processor")) {
327 _amp->set_state (**i, version);
331 _send_delay->set_name ("Send-" + name());
332 _thru_delay->set_name ("Thru-" + name());
338 Send::set_state_2X (const XMLNode& node, int /* version */)
340 /* use the IO's name for the name of the send */
341 XMLNodeList const & children = node.children ();
343 XMLNodeList::const_iterator i = children.begin();
344 while (i != children.end() && (*i)->name() != X_("Redirect")) {
348 if (i == children.end()) {
352 XMLNodeList const & grand_children = (*i)->children ();
353 XMLNodeList::const_iterator j = grand_children.begin ();
354 while (j != grand_children.end() && (*j)->name() != X_("IO")) {
358 if (j == grand_children.end()) {
362 XMLProperty const * prop = (*j)->property (X_("name"));
367 set_name (prop->value ());
373 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out)
375 /* sends have no impact at all on the channel configuration of the
376 streams passing through the route. so, out == in.
383 /** Caller must hold process lock */
385 Send::configure_io (ChanCount in, ChanCount out)
387 if (!_amp->configure_io (in, out)) {
391 if (!Processor::configure_io (in, out)) {
395 if (!_meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()))) {
399 if (!_thru_delay->configure_io (in, out)) {
403 if (!_send_delay->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()))) {
413 Send::panshell_changed ()
415 _meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
419 Send::set_name (const string& new_name)
423 if (_role == Delivery::Send) {
426 /* rip any existing numeric part of the name, and append the bitslot
429 string::size_type last_letter = new_name.find_last_not_of ("0123456789");
431 if (last_letter != string::npos) {
432 unique_name = new_name.substr (0, last_letter + 1);
434 unique_name = new_name;
437 snprintf (buf, sizeof (buf), "%u", (_bitslot + 1));
441 unique_name = new_name;
444 return Delivery::set_name (unique_name);
448 Send::display_to_user () const
450 /* we ignore Deliver::_display_to_user */
452 if (_role == Listen) {
453 /* don't make the monitor/control/listen send visible */
461 Send::snd_output_changed (IOChange change, void* /*src*/)
463 if (change.type & IOChange::ConnectionsChanged) {
464 if (!_output->connected() && _remove_on_disconnect) {
465 _remove_on_disconnect = false;
466 SelfDestruct (); /* EMIT SIGNAL */