Move panner bypass state up to the PannerShell so that it is preserved even when...
[ardour.git] / libs / ardour / internal_send.cc
index 540a6869e1e24357529ef4aa08ddd23b88e35c96..171a5bb210ba15797aa25a329831b74203508765 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2009 Paul Davis 
+    Copyright (C) 2009 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
 
 */
 
-#include <iostream>
-
 #include "pbd/error.h"
 #include "pbd/failed_constructor.h"
 
 #include "ardour/amp.h"
+#include "ardour/audio_buffer.h"
 #include "ardour/internal_send.h"
 #include "ardour/meter.h"
+#include "ardour/panner.h"
+#include "ardour/panner_shell.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
 
 
 using namespace PBD;
 using namespace ARDOUR;
+using namespace std;
 
-InternalSend::InternalSend (Session& s, boost::shared_ptr<MuteMaster> mm, boost::shared_ptr<Route> sendto, Delivery::Role role)
-       : Send (s, mm, role)
-       , _send_to (sendto)
+InternalSend::InternalSend (Session& s, boost::shared_ptr<Pannable> p, boost::shared_ptr<MuteMaster> mm, boost::shared_ptr<Route> sendto, Delivery::Role role)
+       : Send (s, p, mm, role)
 {
-       if ((target = _send_to->get_return_buffer ()) == 0) {
-               throw failed_constructor();
-       }
+        if (sendto) {
+                if (use_target (sendto)) {
+                        throw failed_constructor();
+                }
+        }
 
-       set_name (sendto->name());
-       
-       _send_to->GoingAway.connect (mem_fun (*this, &InternalSend::send_to_going_away));
+       init_gain ();
 }
 
-InternalSend::InternalSend (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
-       : Send (s, mm, node, Delivery::Aux /* will be reset in set_state() */)
+InternalSend::~InternalSend ()
 {
-       set_state (node);
+       if (_send_to) {
+               _send_to->remove_send_from_internal_return (this);
+       }
 }
 
-InternalSend::~InternalSend ()
+void
+InternalSend::init_gain ()
+{
+       if (_role == Listen) {
+               /* send to monitor bus is always at unity */
+               _amp->set_gain (1.0, this);
+       } else {
+               /* aux sends start at -inf dB */
+               _amp->set_gain (0, this);
+       }
+}
+
+int
+InternalSend::use_target (boost::shared_ptr<Route> sendto)
 {
        if (_send_to) {
-               _send_to->release_return_buffer ();
+               _send_to->remove_send_from_internal_return (this);
        }
 
-       connect_c.disconnect ();
+        _send_to = sendto;
+
+        _send_to->add_send_to_internal_return (this);
+
+        set_name (sendto->name());
+        _send_to_id = _send_to->id();
+
+        target_connections.drop_connections ();
+
+        _send_to->DropReferences.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_going_away, this));
+        _send_to->PropertyChanged.connect_same_thread (target_connections, boost::bind (&InternalSend::send_to_property_changed, this, _1));;
+
+        return 0;
 }
 
 void
 InternalSend::send_to_going_away ()
 {
-       target = 0;
+        target_connections.drop_connections ();
        _send_to.reset ();
        _send_to_id = "0";
 }
 
 void
-InternalSend::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
+InternalSend::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool)
 {
-       if (!_active || !target || !_send_to) {
+       if ((!_active && !_pending_active) || !_send_to) {
                _meter->reset ();
                return;
        }
 
        // we have to copy the input, because we may alter the buffers with the amp
        // 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());
-       
+
+       assert(mixbufs.available() >= bufs.count());
+
+       if (_panshell && !_panshell->bypassed()) {
+               mixbufs.set_count (_send_to->n_outputs ());
+               _panshell->run (bufs, mixbufs, start_frame, end_frame, nframes);
+       } else {
+               mixbufs.read_from (bufs, nframes);
+       }
+
        /* gain control */
 
        gain_t tgain = target_gain ();
-       
+
        if (tgain != _current_gain) {
-               
+
                /* target gain has changed */
 
-               Amp::apply_gain (sendbufs, nframes, _current_gain, tgain);
+               Amp::apply_gain (mixbufs, nframes, _current_gain, tgain);
                _current_gain = tgain;
 
        } else if (tgain == 0.0) {
@@ -101,35 +133,56 @@ InternalSend::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame,
                */
 
                _meter->reset ();
-               Amp::apply_simple_gain (sendbufs, nframes, 0.0);
-               return;
+               Amp::apply_simple_gain (mixbufs, nframes, 0.0);
+               goto out;
 
        } else if (tgain != 1.0) {
 
-               /* target gain has not changed, but is not unity */
-               Amp::apply_simple_gain (sendbufs, nframes, tgain);
+               /* target gain has not changed, but is not zero or unity */
+               Amp::apply_simple_gain (mixbufs, nframes, tgain);
        }
 
-       
        // 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 (mixbufs, start_frame, end_frame, nframes, true);
 
        /* consider metering */
-       
+
        if (_metering) {
                if (_amp->gain_control()->get_value() == 0) {
                        _meter->reset();
                } else {
-                       _meter->run (sendbufs, start_frame, end_frame, nframes);
+                       _meter->run (mixbufs, start_frame, end_frame, nframes, true);
                }
        }
 
-       /* deliver to target */
+#if 0
+        if (_session.transport_rolling()) {
+                for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {
+                        Sample* p = b->data ();
+                        for (pframes_t n = 0; n < nframes; ++n) {
+                               if (p[n] != 0.0) {
+                                       cerr << "\tnon-zero data SENT to " << b->data() << endl;
+                                       break;
+                               }
+                        }
+                }
+        }
+#endif
+
+       /* target will pick up our output when it is ready */
+
+  out:
+       _active = _pending_active;
+}
 
-       target->merge_from (sendbufs, nframes);
+int
+InternalSend::set_block_size (pframes_t nframes)
+{
+       mixbufs.ensure_buffers (_configured_input, nframes);
+        return 0;
 }
 
 bool
@@ -143,14 +196,14 @@ InternalSend::state (bool full)
 {
        XMLNode& node (Send::state (full));
 
-       /* this replaces any existing property */
+       /* this replaces any existing "type" property */
 
        node.add_property ("type", "intsend");
 
        if (_send_to) {
                node.add_property ("target", _send_to->id().to_s());
        }
-       
+
        return node;
 }
 
@@ -161,11 +214,13 @@ InternalSend::get_state()
 }
 
 int
-InternalSend::set_state (const XMLNode& node)
+InternalSend::set_state (const XMLNode& node, int version)
 {
        const XMLProperty* prop;
 
-       Send::set_state (node);
+       init_gain ();
+
+       Send::set_state (node, version);
 
        if ((prop = node.property ("target")) != 0) {
 
@@ -177,12 +232,12 @@ InternalSend::set_state (const XMLNode& node)
                */
 
                if (!IO::connecting_legal) {
-                       connect_c = IO::ConnectingLegal.connect (mem_fun (*this, &InternalSend::connect_when_legal));
+                       IO::ConnectingLegal.connect_same_thread (connect_c, boost::bind (&InternalSend::connect_when_legal, this));
                } else {
                        connect_when_legal ();
                }
        }
-       
+
        return 0;
 }
 
@@ -196,20 +251,17 @@ InternalSend::connect_when_legal ()
                return 0;
        }
 
-       if ((_send_to = _session.route_by_id (_send_to_id)) == 0) {
+        boost::shared_ptr<Route> sendto;
+
+       if ((sendto = _session.route_by_id (_send_to_id)) == 0) {
                error << X_("cannot find route to connect to") << endmsg;
                return -1;
-       } 
-       
-       if ((target = _send_to->get_return_buffer ()) == 0) {
-               error << X_("target for internal send has no return buffer") << endmsg;
-               return -1;
        }
 
-       return 0;
+        return use_target (sendto);
 }
 
-bool 
+bool
 InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 {
        out = in;
@@ -217,13 +269,21 @@ InternalSend::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 }
 
 bool
-InternalSend::set_name (const std::string& str)
+InternalSend::configure_io (ChanCount in, ChanCount out)
+{
+       bool ret = Send::configure_io (in, out);
+       set_block_size (_session.engine().frames_per_cycle());
+       return ret;
+}
+
+bool
+InternalSend::set_name (const string& str)
 {
        /* rules for external sends don't apply to us */
        return IOProcessor::set_name (str);
 }
 
-std::string
+string
 InternalSend::display_name () const
 {
        if (_role == Aux) {
@@ -240,5 +300,31 @@ InternalSend::visible () const
                return true;
        }
 
-       return false; 
+       return false;
+}
+
+void
+InternalSend::send_to_property_changed (const PropertyChange& what_changed)
+{
+       if (what_changed.contains (Properties::name)) {
+               set_name (_send_to->name ());
+       }
+}
+
+void
+InternalSend::set_can_pan (bool yn)
+{
+       if (_panshell) {
+               _panshell->set_bypassed (!yn);
+       }
 }
+
+void
+InternalSend::cycle_start (pframes_t nframes)
+{
+       Delivery::cycle_start (nframes);
+
+       for (BufferSet::audio_iterator b = mixbufs.audio_begin(); b != mixbufs.audio_end(); ++b) {
+               (*b).prepare ();
+       }
+}