Changed send/deliver role "Personal" to "Foldback" so bus type can match
[ardour.git] / libs / ardour / send.cc
index f537c9dfdfc7b21fb45d93103800c039f6950b2b..a9b8f2b135c2dfaadb1507ba16f7eb88ff5c7b07 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/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<Pannable> p, boost::shared_ptr<MuteMaster> mm, Role r)
-       : Delivery (s, p, mm, string_compose (_("send %1"), (_bitslot = s.next_send_id()) + 1), r)
+PBD::Signal0<void> Send::ChangedLatency;
+
+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);
+       case Delivery::Foldback:
+               return string_compose (_("foldback %1"), (bitslot = s.next_aux_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));
-       _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()));
+
+       _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 ()
 {
-        _session.unmark_send_id (_bitslot);
+       _session.unmark_send_id (_bitslot);
 }
 
 void
@@ -70,8 +135,84 @@ Send::deactivate ()
        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, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
+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 ();
@@ -95,14 +236,15 @@ Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframe
 
        /* 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_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, true);
+       Delivery::run (sendbufs, start_sample, end_sample, speed, nframes, true);
 
        /* consider metering */
 
@@ -110,30 +252,29 @@ Send::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframe
                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_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::get_state(void)
+Send::state ()
 {
-       return state (true);
-}
+       XMLNode& node = Delivery::state ();
 
-XMLNode&
-Send::state (bool full)
-{
-       XMLNode& node = Delivery::state(full);
-       char buf[32];
+       node.set_property ("type", "send");
 
-       node.add_property ("type", "send");
-       snprintf (buf, sizeof (buf), "%" PRIu32, _bitslot);
-       node.add_property ("bitslot", buf);
+       if (_role != Listen) {
+               node.set_property ("bitslot", _bitslot);
+       }
+
+       node.set_property ("selfdestruct", _remove_on_disconnect);
 
-       node.add_child_nocopy (_amp->state (full));
+       node.add_child_nocopy (_amp->get_state ());
 
        return node;
 }
@@ -145,21 +286,42 @@ Send::set_state (const XMLNode& node, int version)
                return set_state_2X (node, version);
        }
 
-       const XMLProperty* prop;
+       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 || _role == Delivery::Foldback) {
+                               _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 || _role == Delivery::Foldback) {
+                               _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;
+                       }
+               }
+       }
 
-        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);
-        }
+       node.get_property (X_("selfdestruct"), _remove_on_disconnect);
 
        XMLNodeList nlist = node.children();
        for (XMLNodeIterator i = nlist.begin(); i != nlist.end(); ++i) {
@@ -168,6 +330,9 @@ Send::set_state (const XMLNode& node, int version)
                }
        }
 
+       _send_delay->set_name ("Send-" + name());
+       _thru_delay->set_name ("Thru-" + name());
+
        return 0;
 }
 
@@ -207,7 +372,7 @@ Send::set_state_2X (const XMLNode& node, int /* version */)
 }
 
 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.
@@ -221,7 +386,7 @@ Send::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 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;
        }
 
@@ -229,33 +394,27 @@ 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 (!_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);
-
-       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
@@ -292,10 +451,21 @@ Send::display_to_user () const
 {
        /* we ignore Deliver::_display_to_user */
 
-       if (_role == Listen) {
-                /* don't make the monitor/control/listen send visible */
+       if (_role == Listen || _role == Foldback) {
+               /* 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 */
+               }
+       }
+}