fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / send.cc
index 41dd3e8f860212e5c0b570d4f6a844b2b93a0ceb..d0049ff7b243f700d4eba516b118841092d6461f 100644 (file)
 #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/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)
+string
+Send::name_and_id_new_send (Session& s, Role r, uint32_t& bitslot, bool ignore_bitslot)
+{
+       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();
+       }
+
+}
+
+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 (_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;
+       }
+
+       //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()));
+
+       _delayline.reset (new DelayLine (_session, 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 ()
@@ -66,12 +125,41 @@ Send::deactivate ()
        _amp->deactivate ();
        _meter->deactivate ();
        _meter->reset ();
-       
+
        Processor::deactivate ();
 }
 
 void
-Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool)
+Send::set_delay_in(framecnt_t delay)
+{
+       if (!_delayline) return;
+       if (_delay_in == delay) {
+               return;
+       }
+       _delay_in = delay;
+
+       DEBUG_TRACE (DEBUG::LatencyCompensation,
+                       string_compose ("Send::set_delay_in(%1) + %2 = %3\n",
+                               delay, _delay_out, _delay_out + _delay_in));
+       _delayline.get()->set_delay(_delay_out + _delay_in);
+}
+
+void
+Send::set_delay_out(framecnt_t delay)
+{
+       if (!_delayline) return;
+       if (_delay_out == delay) {
+               return;
+       }
+       _delay_out = delay;
+       DEBUG_TRACE (DEBUG::LatencyCompensation,
+                       string_compose ("Send::set_delay_out(%1) + %2 = %3\n",
+                               delay, _delay_in, _delay_out + _delay_in));
+       _delayline.get()->set_delay(_delay_out + _delay_in);
+}
+
+void
+Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool)
 {
        if (_output->n_ports() == ChanCount::ZERO) {
                _meter->reset ();
@@ -95,14 +183,15 @@ Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_
 
        /* 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, true);
+       _amp->set_gain_automation_buffer (_session.send_gain_automation_buffer ());
+       _amp->setup_gain_automation (start_frame, end_frame, nframes);
+       _amp->run (sendbufs, start_frame, end_frame, speed, nframes, true);
+
+       _delayline->run (sendbufs, start_frame, end_frame, speed, nframes, true);
 
        /* deliver to outputs */
 
-       Delivery::run (sendbufs, start_frame, end_frame, nframes, true);
+       Delivery::run (sendbufs, start_frame, end_frame, speed, nframes, true);
 
        /* consider metering */
 
@@ -110,7 +199,7 @@ Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_
                if (_amp->gain_control()->get_value() == 0) {
                        _meter->reset();
                } else {
-                       _meter->run (*_output_buffers, start_frame, end_frame, nframes, true);
+                       _meter->run (*_output_buffers, start_frame, end_frame, speed, nframes, true);
                }
        }
 
@@ -131,7 +220,14 @@ Send::state (bool full)
 
        node.add_property ("type", "send");
        snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
-       node.add_property ("bitslot", buf);
+
+       if (_role != Listen) {
+               node.add_property ("bitslot", buf);
+       }
+
+       node.add_property("selfdestruct", _remove_on_disconnect ? "yes" : "no");
+
+       node.add_child_nocopy (_amp->state (full));
 
        return node;
 }
@@ -139,31 +235,96 @@ Send::state (bool full)
 int
 Send::set_state (const XMLNode& node, int version)
 {
-       XMLNodeList nlist = node.children();
-       XMLNodeIterator niter;
-       const XMLProperty* prop;
+       if (version < 3000) {
+               return set_state_2X (node, version);
+       }
+
+       XMLProperty const * prop;
 
        Delivery::set_state (node, version);
 
-        /* don't try to reset bitslot if its already set: this can cause
-           issues with the session's accounting of send ID's
-        */
+       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);
+                               sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+                               _session.mark_aux_send_id (_bitslot);
+                       } else if (_role == Delivery::Send) {
+                               _session.unmark_send_id (_bitslot);
+                               sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
+                               _session.mark_send_id (_bitslot);
+                       } else {
+                               // bitslot doesn't matter but make it zero anyway
+                               _bitslot = 0;
+                       }
+               }
+       }
+
+       if ((prop = node.property (X_("selfdestruct"))) != 0) {
+               _remove_on_disconnect = string_is_affirmative (prop->value());
+       }
+
+       XMLNodeList nlist = node.children();
+       for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
+               if ((*i)->name() == X_("Processor")) {
+                       _amp->set_state (**i, version);
+               }
+       }
+
+       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;
+       }
+
+       XMLNodeList const & grand_children = (*i)->children ();
+       XMLNodeList::const_iterator j = grand_children.begin ();
+       while (j != grand_children.end() && (*j)->name() != X_("IO")) {
+               ++j;
+       }
+
+       if (j == grand_children.end()) {
+               return -1;
+       }
 
-        if ((prop = node.property ("bitslot")) == 0) {
-                _bitslot = _session.next_send_id();
-        } else {
-                _session.unmark_send_id (_bitslot);
-                sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
-                _session.mark_send_id (_bitslot);
-        }
+       XMLProperty const * prop = (*j)->property (X_("name"));
+       if (!prop) {
+               return -1;
+       }
 
-       /* XXX need to load automation state & data for amp */
+       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.
@@ -173,10 +334,11 @@ Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
        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;
        }
 
@@ -184,33 +346,24 @@ Send::configure_io (ChanCount in, ChanCount out)
                return false;
        }
 
+       if (!_meter->configure_io (ChanCount (DataType::AUDIO, pan_outs()), ChanCount (DataType::AUDIO, pan_outs()))) {
+               return false;
+       }
+
+       if (_delayline && !_delayline->configure_io(in, out)) {
+               cerr << "send delayline config failed\n";
+               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);
-
-       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
@@ -254,3 +407,20 @@ Send::display_to_user () const
 
        return true;
 }
+
+string
+Send::value_as_string (boost::shared_ptr<const AutomationControl> ac) const
+{
+       return _amp->value_as_string (ac);
+}
+
+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 */
+               }
+       }
+}