Fix restoration of connections to control surface ports.
[ardour.git] / libs / ardour / send.cc
index 307f83fa62ec0a51317b03e6512422a72f2f2d00..2ec9a10bda6df85e3796dfc050433feb2ec8a57f 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -17,6 +17,7 @@
 
 */
 
+#include <iostream>
 #include <algorithm>
 
 #include "pbd/xml++.h"
 
 using namespace ARDOUR;
 using namespace PBD;
+using namespace std;
 
-Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, bool internal)
-       : Delivery (s, mm, string_compose (_("send %1"), (_bitslot = s.next_send_id()) + 1), 
-                   (internal ? Delivery::Listen : Delivery::Send))
+Send::Send (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r)
+       : Delivery (s, p, mm, string_compose (_("send %1"), (_bitslot = s.next_send_id()) + 1), r)
        , _metering (false)
 {
-       _amp.reset (new Amp (_session, _mute_master));
+       _amp.reset (new Amp (_session));
        _meter.reset (new PeakMeter (_session));
-
-       ProcessorCreated (this); /* EMIT SIGNAL */
 }
 
-Send::Send (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node, bool internal)
-        : Delivery (s, mm, "send", (internal ? Delivery::Listen : Delivery::Send))
-       , _metering (false)
+Send::~Send ()
 {
-       _amp.reset (new Amp (_session, _mute_master));
-       _meter.reset (new PeakMeter (_session));
+        _session.unmark_send_id (_bitslot);
+}
 
-       if (set_state (node)) {
-               throw failed_constructor();
-       }
+void
+Send::activate ()
+{
+       _amp->activate ();
+       _meter->activate ();
 
-       ProcessorCreated (this); /* EMIT SIGNAL */
+       Processor::activate ();
 }
 
-Send::~Send ()
+void
+Send::deactivate ()
 {
-       GoingAway ();
+       _amp->deactivate ();
+       _meter->deactivate ();
+       _meter->reset ();
+       
+       Processor::deactivate ();
 }
 
 void
-Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
 {
-       if (!_active || _output->n_ports() == ChanCount::ZERO) {
+       if (_output->n_ports() == ChanCount::ZERO) {
                _meter->reset ();
+               _active = _pending_active;
+               return;
+       }
+
+       if (!_active && !_pending_active) {
+               _meter->reset ();
+               _output->silence (nframes);
+               _active = _pending_active;
                return;
        }
 
        // we have to copy the input, because deliver_output() may alter the buffers
        // in-place, which a send must never do.
-       
+
        BufferSet& sendbufs = _session.get_mix_buffers (bufs.count());
        sendbufs.read_from (bufs, nframes);
        assert(sendbufs.count() == bufs.count());
@@ -86,21 +98,23 @@ Send::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_
        // 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->run (sendbufs, start_frame, end_frame, nframes, true);
 
        /* deliver to outputs */
 
-       Delivery::run (sendbufs, start_frame, end_frame, nframes);
+       Delivery::run (sendbufs, start_frame, end_frame, nframes, true);
 
        /* consider metering */
-       
+
        if (_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_frame, end_frame, nframes, true);
                }
        }
+
+       /* _active was set to _pending_active by Delivery::run() */
 }
 
 XMLNode&
@@ -110,7 +124,7 @@ Send::get_state(void)
 }
 
 XMLNode&
-Send::state(bool full)
+Send::state (bool full)
 {
        XMLNode& node = Delivery::state(full);
        char buf[32];
@@ -119,28 +133,75 @@ Send::state(bool full)
        snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
        node.add_property ("bitslot", buf);
 
+       node.add_child_nocopy (_amp->state (full));
+
        return node;
 }
 
 int
-Send::set_state(const XMLNode& node)
+Send::set_state (const XMLNode& node, int version)
 {
-       XMLNodeList nlist = node.children();
-       XMLNodeIterator niter;
+       if (version < 3000) {
+               return set_state_2X (node, version);
+       }
+       
        const XMLProperty* prop;
 
-       if ((prop = node.property ("bitslot")) == 0) {
-               _bitslot = _session.next_send_id();
-       } else {
-               sscanf (prop->value().c_str(), "%" PRIu32, &_bitslot);
-               _session.mark_send_id (_bitslot);
+       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 ((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);
+        }
+
+       XMLNodeList nlist = node.children();
+       for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
+               if ((*i)->name() == X_("Processor")) {
+                       _amp->set_state (**i, version);
+               }
        }
 
-       const XMLNode* insert_node = &node;
+       return 0;
+}
 
-       /* XXX need to load automation state & data for amp */
-       
-       Delivery::set_state (*insert_node);
+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;
+       }
+
+       XMLProperty const * prop = (*j)->property (X_("name"));
+       if (!prop) {
+               return -1;
+       }
+
+       set_name (prop->value ());
 
        return 0;
 }
@@ -148,22 +209,29 @@ Send::set_state(const XMLNode& node)
 bool
 Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 {
-       if (_output->n_ports() == ChanCount::ZERO) {
+       /* sends have no impact at all on the channel configuration of the
+          streams passing through the route. so, out == in.
+       */
 
-               /* not configured yet, we can support anything */
-
-               out = in;
-               return true; /* we can support anything the first time we're asked */
-
-       } else {
+       out = in;
+       return true;
+}
 
-               /* for a send, processor input corresponds to IO output */
+/** Caller must hold process lock */
+bool
+Send::configure_io (ChanCount in, ChanCount out)
+{
+       if (!_amp->configure_io (in, out) || !_meter->configure_io (in, out)) {
+               return false;
+       }
 
-               out = in;
-               return true;
+       if (!Processor::configure_io (in, out)) {
+               return false;
        }
 
-       return false;
+       reset_panner ();
+
+       return true;
 }
 
 /** Set up the XML description of a send so that its name is unique.
@@ -179,25 +247,55 @@ Send::make_unique (XMLNode &state, Session &session)
        snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
        state.property("bitslot")->set_value (buf);
 
-       std::string const name = string_compose (_("send %1"), bitslot);
-       
+       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);
        }
 }
 
 bool
-Send::set_name (const std::string& new_name)
+Send::set_name (const string& new_name)
 {
-       char buf[32];
-       std::string unique_name;
+       string unique_name;
+
+       if (_role == Delivery::Send) {
+               char buf[32];
+
+               /* rip any existing numeric part of the name, and append the bitslot
+                */
 
-       snprintf (buf, sizeof (buf), "%u", _bitslot);
-       unique_name = new_name;
-       unique_name += buf;
+               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;
+       }
 
        return Delivery::set_name (unique_name);
 }
+
+bool
+Send::display_to_user () const
+{
+       /* we ignore Deliver::_display_to_user */
+
+       if (_role == Listen) {
+                /* don't make the monitor/control/listen send visible */
+               return false;
+       }
+
+       return true;
+}