*/
+#include <iostream>
#include <algorithm>
#include "pbd/xml++.h"
#include "ardour/amp.h"
-#include "ardour/send.h"
-#include "ardour/session.h"
-#include "ardour/port.h"
-#include "ardour/audio_port.h"
+#include "ardour/boost_debug.h"
#include "ardour/buffer_set.h"
-#include "ardour/meter.h"
-#include "ardour/panner.h"
+#include "ardour/debug.h"
+#include "ardour/delayline.h"
+#include "ardour/gain_control.h"
#include "ardour/io.h"
+#include "ardour/meter.h"
+#include "ardour/panner_shell.h"
+#include "ardour/send.h"
+#include "ardour/session.h"
-#include "i18n.h"
+#include "pbd/i18n.h"
+
+namespace ARDOUR {
+class AutomationControl;
+class MuteMaster;
+class Pannable;
+}
using namespace ARDOUR;
using namespace PBD;
+using namespace std;
-Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, Role r)
- : Delivery (s, mm, string_compose (_("send %1"), (_bitslot = s.next_send_id()) + 1), r)
- , _metering (false)
+PBD::Signal0<void> Send::ChangedLatency;
+
+string
+Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot, bool ignore_bitslot)
{
- _amp.reset (new Amp (_session, _mute_master));
- _meter.reset (new PeakMeter (_session));
+ if (ignore_bitslot) {
+ /* this happens during initial construction of sends from XML,
+ before they get ::set_state() called. lets not worry about
+ it.
+ */
+ bitslot = 0;
+ return string ();
+ }
+
+ switch (r) {
+ case Delivery::Aux:
+ return string_compose (_("aux %1"), (bitslot = s.next_aux_send_id ()) + 1);
+ case Delivery::Listen:
+ return _("listen"); // no ports, no need for numbering
+ case Delivery::Send:
+ return string_compose (_("send %1"), (bitslot = s.next_send_id ()) + 1);
+ default:
+ fatal << string_compose (_("programming error: send created using role %1"), enum_2_string (r)) << endmsg;
+ abort(); /*NOTREACHED*/
+ return string();
+ }
- ProcessorCreated (this); /* EMIT SIGNAL */
}
-Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node, int version, Role r)
- : Delivery (s, mm, "send", r)
+Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r, bool ignore_bitslot)
+ : Delivery (s, p, mm, name_and_id_new_send (s, r, _bitslot, ignore_bitslot), r)
, _metering (false)
+ , _delay_in (0)
+ , _delay_out (0)
+ , _remove_on_disconnect (false)
{
- _amp.reset (new Amp (_session, _mute_master));
- _meter.reset (new PeakMeter (_session));
-
- if (set_state (node, version)) {
- throw failed_constructor();
+ if (_role == Listen) {
+ /* we don't need to do this but it keeps things looking clean
+ in a debugger. _bitslot is not used by listen sends.
+ */
+ _bitslot = 0;
}
- ProcessorCreated (this); /* EMIT SIGNAL */
+ //boost_debug_shared_ptr_mark_interesting (this, "send");
+
+ boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
+ _gain_control = boost::shared_ptr<GainControl> (new GainControl (_session, Evoral::Parameter(GainAutomation), gl));
+ add_control (_gain_control);
+
+ _amp.reset (new Amp (_session, _("Fader"), _gain_control, true));
+ _meter.reset (new PeakMeter (_session, name()));
+
+ _send_delay.reset (new DelayLine (_session, "Send-" + name()));
+ _thru_delay.reset (new DelayLine (_session, "Thru-" + name()));
+
+ if (panner_shell()) {
+ panner_shell()->Changed.connect_same_thread (*this, boost::bind (&Send::panshell_changed, this));
+ }
+ if (_output) {
+ _output->changed.connect_same_thread (*this, boost::bind (&Send::snd_output_changed, this, _1, _2));
+ }
}
Send::~Send ()
{
- GoingAway ();
+ _session.unmark_send_id (_bitslot);
}
void
{
_amp->deactivate ();
_meter->deactivate ();
+ _meter->reset ();
Processor::deactivate ();
}
+samplecnt_t
+Send::signal_latency () const
+{
+ if (!_pending_active) {
+ return 0;
+ }
+ if (_user_latency) {
+ return _user_latency;
+ }
+ if (_delay_out > _delay_in) {
+ return _delay_out - _delay_in;
+ }
+ return 0;
+}
+
void
-Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+Send::update_delaylines ()
+{
+ if (_role == Listen) {
+ /* Don't align monitor-listen (just yet).
+ * They're present on each route, may change positions
+ * and could potentially signficiantly increase worst-case
+ * Latency: In PFL mode all tracks/busses would additionally be
+ * aligned at PFL position.
+ *
+ * We should only align active monitor-sends when at least one is active.
+ */
+ return;
+ }
+
+ bool changed;
+ if (_delay_out > _delay_in) {
+ changed = _thru_delay->set_delay(_delay_out - _delay_in);
+ _send_delay->set_delay(0);
+ } else {
+ changed = _thru_delay->set_delay(0);
+ _send_delay->set_delay(_delay_in - _delay_out);
+ }
+
+ if (changed) {
+ // TODO -- ideally postpone for effective no-op changes
+ // (in case both _delay_out and _delay_in are changed by the
+ // same amount in a single latency-update cycle).
+ ChangedLatency (); /* EMIT SIGNAL */
+ }
+}
+
+void
+Send::set_delay_in (samplecnt_t delay)
+{
+ if (_delay_in == delay) {
+ return;
+ }
+ _delay_in = delay;
+
+ DEBUG_TRACE (DEBUG::LatencyCompensation,
+ string_compose ("Send::set_delay_in %1: (%2) - %3 = %4\n",
+ name (), _delay_in, _delay_out, _delay_in - _delay_out));
+
+ update_delaylines ();
+}
+
+void
+Send::set_delay_out (samplecnt_t delay)
+{
+ if (_delay_out == delay) {
+ return;
+ }
+ _delay_out = delay;
+ DEBUG_TRACE (DEBUG::LatencyCompensation,
+ string_compose ("Send::set_delay_out %1: %2 - (%3) = %4\n",
+ name (), _delay_in, _delay_out, _delay_in - _delay_out));
+
+ update_delaylines ();
+}
+
+void
+Send::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool)
{
if (_output->n_ports() == ChanCount::ZERO) {
_meter->reset ();
/* gain control */
- // Can't automate gain for sends or returns yet because we need different buffers
- // so that we don't overwrite the main automation data for the route amp
- // _amp->setup_gain_automation (start_frame, end_frame, nframes);
- _amp->run (sendbufs, start_frame, end_frame, nframes);
+ _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
+ _amp->setup_gain_automation (start_sample, end_sample, nframes);
+ _amp->run (sendbufs, start_sample, end_sample, speed, nframes, true);
+
+ _send_delay->run (sendbufs, start_sample, end_sample, speed, nframes, true);
/* deliver to outputs */
- Delivery::run (sendbufs, start_frame, end_frame, nframes);
+ Delivery::run (sendbufs, start_sample, end_sample, speed, nframes, true);
/* consider metering */
if (_amp->gain_control()->get_value() == 0) {
_meter->reset();
} else {
- _meter->run (*_output_buffers, start_frame, end_frame, nframes);
+ _meter->run (*_output_buffers, start_sample, end_sample, speed, nframes, true);
}
}
+ _thru_delay->run (bufs, start_sample, end_sample, speed, nframes, true);
+
/* _active was set to _pending_active by Delivery::run() */
}
}
XMLNode&
-Send::state(bool full)
+Send::state (bool full)
{
XMLNode& node = Delivery::state(full);
- char buf[32];
- node.add_property ("type", "send");
- snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
- node.add_property ("bitslot", buf);
+ node.set_property ("type", "send");
+
+ if (_role != Listen) {
+ node.set_property ("bitslot", _bitslot);
+ }
+
+ node.set_property ("selfdestruct", _remove_on_disconnect);
+
+ node.add_child_nocopy (_amp->state (full));
return node;
}
int
Send::set_state (const XMLNode& node, int version)
{
+ if (version < 3000) {
+ return set_state_2X (node, version);
+ }
+
+ XMLProperty const * prop;
+
+ Delivery::set_state (node, version);
+
+ if (node.property ("ignore-bitslot") == 0) {
+
+ /* don't try to reset bitslot if there is a node for it already: this can cause
+ issues with the session's accounting of send ID's
+ */
+
+ if ((prop = node.property ("bitslot")) == 0) {
+ if (_role == Delivery::Aux) {
+ _bitslot = _session.next_aux_send_id ();
+ } else if (_role == Delivery::Send) {
+ _bitslot = _session.next_send_id ();
+ } else {
+ // bitslot doesn't matter but make it zero anyway
+ _bitslot = 0;
+ }
+ } else {
+ if (_role == Delivery::Aux) {
+ _session.unmark_aux_send_id (_bitslot);
+ _bitslot = string_to<uint32_t>(prop->value());
+ _session.mark_aux_send_id (_bitslot);
+ } else if (_role == Delivery::Send) {
+ _session.unmark_send_id (_bitslot);
+ _bitslot = string_to<uint32_t>(prop->value());
+ _session.mark_send_id (_bitslot);
+ } else {
+ // bitslot doesn't matter but make it zero anyway
+ _bitslot = 0;
+ }
+ }
+ }
+
+ node.get_property (X_("selfdestruct"), _remove_on_disconnect);
+
XMLNodeList nlist = node.children();
- XMLNodeIterator niter;
- const XMLProperty* prop;
+ for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
+ if ((*i)->name() == X_("Processor")) {
+ _amp->set_state (**i, version);
+ }
+ }
- if ((prop = node.property ("bitslot")) == 0) {
- _bitslot = _session.next_send_id();
- } else {
- sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
- _session.mark_send_id (_bitslot);
+ _send_delay->set_name ("Send-" + name());
+ _thru_delay->set_name ("Thru-" + name());
+
+ return 0;
+}
+
+int
+Send::set_state_2X (const XMLNode& node, int /* version */)
+{
+ /* use the IO's name for the name of the send */
+ XMLNodeList const & children = node.children ();
+
+ XMLNodeList::const_iterator i = children.begin();
+ while (i != children.end() && (*i)->name() != X_("Redirect")) {
+ ++i;
+ }
+
+ if (i == children.end()) {
+ return -1;
}
- const XMLNode* insert_node = &node;
+ XMLNodeList const & grand_children = (*i)->children ();
+ XMLNodeList::const_iterator j = grand_children.begin ();
+ while (j != grand_children.end() && (*j)->name() != X_("IO")) {
+ ++j;
+ }
- /* XXX need to load automation state & data for amp */
+ if (j == grand_children.end()) {
+ return -1;
+ }
+
+ XMLProperty const * prop = (*j)->property (X_("name"));
+ if (!prop) {
+ return -1;
+ }
- Delivery::set_state (*insert_node, version);
+ set_name (prop->value ());
return 0;
}
bool
-Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+Send::can_support_io_configuration (const ChanCount& in, ChanCount& out)
{
/* sends have no impact at all on the channel configuration of the
streams passing through the route. so, out == in.
return true;
}
+/** Caller must hold process lock */
bool
Send::configure_io (ChanCount in, ChanCount out)
{
- if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
+ if (!_amp->configure_io (in, out)) {
return false;
}
return false;
}
+ if (!_meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()))) {
+ return false;
+ }
+
+ if (!_thru_delay->configure_io (in, out)) {
+ return false;
+ }
+
+ if (!_send_delay->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()))) {
+ return false;
+ }
+
reset_panner ();
return true;
}
-/** Set up the XML description of a send so that its name is unique.
- * @param state XML send state.
- * @param session Session.
- */
void
-Send::make_unique (XMLNode &state, Session &session)
+Send::panshell_changed ()
{
- uint32_t const bitslot = session.next_send_id() + 1;
-
- char buf[32];
- snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
- state.property("bitslot")->set_value (buf);
-
- std::string const name = string_compose (_("send %1"), bitslot);
-
- state.property("name")->set_value (name);
-
- XMLNode* io = state.child ("IO");
-
- if (io) {
- io->property("name")->set_value (name);
- }
+ _meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()));
}
bool
-Send::set_name (const std::string& new_name)
+Send::set_name (const string& new_name)
{
- std::string unique_name;
+ string unique_name;
if (_role == Delivery::Send) {
char buf[32];
- snprintf (buf, sizeof (buf), "%u", _bitslot);
- unique_name = new_name;
+
+ /* rip any existing numeric part of the name, and append the bitslot
+ */
+
+ string::size_type last_letter = new_name.find_last_not_of ("0123456789");
+
+ if (last_letter != string::npos) {
+ unique_name = new_name.substr (0, last_letter + 1);
+ } else {
+ unique_name = new_name;
+ }
+
+ snprintf (buf, sizeof (buf), "%u", (_bitslot + 1));
unique_name += buf;
+
} else {
unique_name = new_name;
}
/* we ignore Deliver::_display_to_user */
if (_role == Listen) {
+ /* don't make the monitor/control/listen send visible */
return false;
}
return true;
}
+
+void
+Send::snd_output_changed (IOChange change, void* /*src*/)
+{
+ if (change.type & IOChange::ConnectionsChanged) {
+ if (!_output->connected() && _remove_on_disconnect) {
+ _remove_on_disconnect = false;
+ SelfDestruct (); /* EMIT SIGNAL */
+ }
+ }
+}