independent panning for external sends
[ardour.git] / libs / ardour / delivery.cc
index eaf58c0a9bca120ba15eef119a4cdd4417090d9e..e4c39271f578b0c3f3055636b74335e7862ae926 100644 (file)
 #include "pbd/enumwriter.h"
 #include "pbd/convert.h"
 
-#include "ardour/midi_buffer.h"
-
-#include "ardour/delivery.h"
-#include "ardour/audio_buffer.h"
 #include "ardour/amp.h"
+#include "ardour/audioengine.h"
 #include "ardour/buffer_set.h"
-#include "ardour/configuration.h"
+#include "ardour/debug.h"
+#include "ardour/delivery.h"
 #include "ardour/io.h"
-#include "ardour/meter.h"
 #include "ardour/mute_master.h"
-#include "ardour/panner.h"
+#include "ardour/pannable.h"
+#include "ardour/panner_shell.h"
 #include "ardour/port.h"
 #include "ardour/session.h"
 
 #include "i18n.h"
 
+namespace ARDOUR { class Panner; }
+
 using namespace std;
 using namespace PBD;
 using namespace ARDOUR;
 
-PBD::Signal1<void,nframes_t> Delivery::CycleStart;
-PBD::Signal0<int>           Delivery::PannersLegal;
-bool                                     Delivery::panners_legal = false;
+PBD::Signal0<void>            Delivery::PannersLegal;
+bool                          Delivery::panners_legal = false;
 
 /* deliver to an existing IO object */
 
-Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
+Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable> pannable,
+                    boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
        : IOProcessor(s, boost::shared_ptr<IO>(), (role_requires_output_ports (r) ? io : boost::shared_ptr<IO>()), name)
        , _role (r)
        , _output_buffers (new BufferSet())
        , _current_gain (1.0)
-       , _output_offset (0)
        , _no_outs_cuz_we_no_monitor (false)
-       , _solo_level (0)
-       , _solo_isolated (false)
        , _mute_master (mm)
-       , no_panner_reset (false)
+       , _no_panner_reset (false)
 {
-       _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
+       if (pannable) {
+               _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
+       }
+
        _display_to_user = false;
 
        if (_output) {
                _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
        }
-
-       CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
 }
 
 /* deliver to a new IO object */
 
-Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
-       : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name)
+Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
+       : IOProcessor(s, false, (role_requires_output_ports (r) ? true : false), name, "", DataType::AUDIO, (r == Send))
        , _role (r)
        , _output_buffers (new BufferSet())
        , _current_gain (1.0)
-       , _output_offset (0)
        , _no_outs_cuz_we_no_monitor (false)
-       , _solo_level (0)
-       , _solo_isolated (false)
        , _mute_master (mm)
-       , no_panner_reset (false)
+       , _no_panner_reset (false)
 {
-       _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
+       if (pannable) {
+               _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable));
+       }
+
        _display_to_user = false;
 
        if (_output) {
                _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
        }
-
-       CycleStart.connect_same_thread (*this, boost::bind (&Delivery::cycle_start, this, _1));
 }
 
 
 Delivery::~Delivery()
 {
+       DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));   
+
+       /* this object should vanish from any signal callback lists
+          that it is on before we get any further. The full qualification
+          of the method name is not necessary, but is here to make it 
+          clear that this call is about signals, not data flow connections.
+       */
+
+       ScopedConnectionList::drop_connections ();
+
        delete _output_buffers;
 }
 
@@ -117,21 +123,8 @@ Delivery::display_name () const
        }
 }
 
-void
-Delivery::cycle_start (nframes_t /*nframes*/)
-{
-       _output_offset = 0;
-       _no_outs_cuz_we_no_monitor = false;
-}
-
-void
-Delivery::increment_output_offset (nframes_t n)
-{
-       _output_offset += n;
-}
-
 bool
-Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 {
        if (_role == Main) {
 
@@ -141,7 +134,8 @@ Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) con
 
                if (_output) {
                        if (_output->n_ports() != ChanCount::ZERO) {
-                               out = _output->n_ports();
+                               /* increase number of output ports if the processor chain requires it */
+                               out = ChanCount::max (_output->n_ports(), in);
                                return true;
                        } else {
                                /* not configured yet - we will passthru */
@@ -181,9 +175,15 @@ Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) con
        return false;
 }
 
+/** Caller must hold process lock */
 bool
 Delivery::configure_io (ChanCount in, ChanCount out)
 {
+#ifndef NDEBUG
+       bool r = AudioEngine::instance()->process_lock().trylock();
+       assert (!r && "trylock inside Delivery::configure_io");
+#endif
+
        /* check configuration by comparison with our I/O port configuration, if appropriate.
           see ::can_support_io_configuration() for comments
        */
@@ -193,8 +193,7 @@ Delivery::configure_io (ChanCount in, ChanCount out)
                if (_output) {
                        if (_output->n_ports() != out) {
                                if (_output->n_ports() != ChanCount::ZERO) {
-                                       fatal << _name << " programming error: configure_io with nports = " << _output->n_ports() << " called with " << in << " and " << out << " with " << _output->n_ports() << " output ports" << endmsg;
-                                       /*NOTREACHED*/
+                                       _output->ensure_io (out, false, this);
                                } else {
                                        /* I/O not yet configured */
                                }
@@ -213,6 +212,7 @@ Delivery::configure_io (ChanCount in, ChanCount out)
                                }
                        }
                }
+
        }
 
        if (!Processor::configure_io (in, out)) {
@@ -225,7 +225,7 @@ Delivery::configure_io (ChanCount in, ChanCount out)
 }
 
 void
-Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool result_required)
+Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool result_required)
 {
        assert (_output);
 
@@ -245,7 +245,7 @@ Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nfra
           processing pathway that wants to use this->output_buffers() for some reason.
        */
 
-       output_buffers().attach_buffers (ports, nframes, _output_offset);
+       output_buffers().get_backend_port_addresses (ports, nframes);
 
        // this Delivery processor is not a derived type, and thus we assume
        // we really can modify the buffers passed in (it is almost certainly
@@ -255,7 +255,6 @@ Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nfra
        tgain = target_gain ();
 
        if (tgain != _current_gain) {
-
                /* target gain has changed */
 
                Amp::apply_gain (bufs, nframes, _current_gain, tgain);
@@ -269,6 +268,7 @@ Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nfra
 
                _output->silence (nframes);
                if (result_required) {
+                       bufs.set_count (output_buffers().count ());
                        Amp::apply_simple_gain (bufs, nframes, 0.0);
                }
                goto out;
@@ -279,28 +279,35 @@ Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nfra
                Amp::apply_simple_gain (bufs, nframes, tgain);
        }
 
-       if (_panner && _panner->npanners() && !_panner->bypassed()) {
+       if (_panshell && !_panshell->bypassed() && _panshell->panner()) {
 
                // Use the panner to distribute audio to output port buffers
 
-               _panner->run (bufs, output_buffers(), start_frame, end_frame, nframes);
+               _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
 
-               if (result_required) {
-                       bufs.read_from (output_buffers (), nframes);
+               // MIDI data will not have been delivered by the panner
+
+               if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
+                       _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
                }
 
        } else {
+
                // Do a 1:1 copy of data to output ports
 
                if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
-                       _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
-               }
+                       _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
+                }
 
                if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
-                       _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
+                       _output->copy_to_outputs (bufs, DataType::MIDI, nframes, 0);
                }
        }
 
+        if (result_required) {
+                bufs.read_from (output_buffers (), nframes);
+        }
+
   out:
        _active = _pending_active;
 }
@@ -319,7 +326,13 @@ Delivery::state (bool full_state)
        }
 
        node.add_property("role", enum_2_string(_role));
-       node.add_child_nocopy (_panner->state (full_state));
+
+       if (_panshell) {
+               node.add_child_nocopy (_panshell->get_state ());
+               if (_panshell->pannable()) {
+                       node.add_child_nocopy (_panshell->pannable()->get_state ());
+               }
+       }
 
        return node;
 }
@@ -340,130 +353,147 @@ Delivery::set_state (const XMLNode& node, int version)
                // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
        }
 
-       XMLNode* pan_node = node.child (X_("Panner"));
+       XMLNode* pan_node = node.child (X_("PannerShell"));
 
-       if (pan_node) {
-               _panner->set_state (*pan_node, version);
+       if (pan_node && _panshell) {
+               _panshell->set_state (*pan_node, version);
        }
 
        reset_panner ();
 
+       XMLNode* pannnode = node.child (X_("Pannable"));
+       if (_panshell->panner() && pannnode) {
+               _panshell->pannable()->set_state (*pannnode, version);
+       }
+
        return 0;
 }
 
+void
+Delivery::unpan ()
+{
+       /* caller must hold process lock */
+
+       _panshell.reset ();
+}
+
+uint32_t
+Delivery::pan_outs () const
+{
+       if (_output) {
+               return _output->n_ports().n_audio();
+       } 
+
+       return _configured_output.n_audio();
+}
+
 void
 Delivery::reset_panner ()
 {
        if (panners_legal) {
-               if (!no_panner_reset) {
+               if (!_no_panner_reset) {
 
-                       uint32_t ntargets;
-
-                       if (_output) {
-                               ntargets = _output->n_ports().n_audio();
-                       } else {
-                               ntargets = _configured_output.n_audio();
+                       if (_panshell) {
+                               _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
+                               
+                               if (_role == Main || _role == Aux || _role == Send) {
+                                       _panshell->pannable()->set_panner (_panshell->panner());
+                               }
                        }
-
-                       _panner->reset (ntargets, pans_required());
                }
+
        } else {
                panner_legal_c.disconnect ();
                PannersLegal.connect_same_thread (panner_legal_c, boost::bind (&Delivery::panners_became_legal, this));
        }
 }
 
-int
+void
 Delivery::panners_became_legal ()
 {
-       uint32_t ntargets;
-
-       if (_output) {
-               ntargets = _output->n_ports().n_audio();
-       } else {
-               ntargets = _configured_output.n_audio();
+       if (_panshell) {
+               _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
+               
+               if (_role == Main) {
+                       _panshell->pannable()->set_panner (_panshell->panner());
+               }
        }
 
-       _panner->reset (ntargets, pans_required());
-       _panner->load (); // automation
        panner_legal_c.disconnect ();
-       return 0;
 }
 
 void
 Delivery::defer_pan_reset ()
 {
-       no_panner_reset = true;
+       _no_panner_reset = true;
 }
 
 void
 Delivery::allow_pan_reset ()
 {
-       no_panner_reset = false;
+       _no_panner_reset = false;
        reset_panner ();
 }
 
 
 int
-Delivery::disable_panners (void)
+Delivery::disable_panners ()
 {
        panners_legal = false;
        return 0;
 }
 
-int
+void
 Delivery::reset_panners ()
 {
        panners_legal = true;
-       return *PannersLegal ();
+       PannersLegal ();
 }
 
-
 void
-Delivery::start_pan_touch (uint32_t which)
+Delivery::flush_buffers (framecnt_t nframes)
 {
-       if (which < _panner->npanners()) {
-               _panner->pan_control(which)->start_touch();
-       }
-}
+       /* io_lock, not taken: function must be called from Session::process() calltree */
 
-void
-Delivery::end_pan_touch (uint32_t which)
-{
-       if (which < _panner->npanners()) {
-               _panner->pan_control(which)->stop_touch();
+       if (!_output) {
+               return;
        }
+       
+       PortSet& ports (_output->ports());
 
+       for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
+               i->flush_buffers (nframes);
+       }
 }
 
 void
-Delivery::transport_stopped (sframes_t frame)
+Delivery::transport_stopped (framepos_t now)
 {
-       _panner->transport_stopped (frame);
-}
+        Processor::transport_stopped (now);
 
-void
-Delivery::flush (nframes_t nframes, nframes64_t time)
-{
-       /* io_lock, not taken: function must be called from Session::process() calltree */
+       if (_panshell) {
+               _panshell->pannable()->transport_stopped (now);
+       }
 
-       PortSet& ports (_output->ports());
+        if (_output) {
+                PortSet& ports (_output->ports());
 
-       for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
-               (*i).flush_buffers (nframes, time, _output_offset);
-       }
+                for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
+                        i->transport_stopped ();
+                }
+        }
 }
 
 void
-Delivery::transport_stopped ()
+Delivery::realtime_locate ()
 {
-       /* turn off any notes that are on */
+        if (_output) {
+                PortSet& ports (_output->ports());
 
-       PortSet& ports (_output->ports());
-
-       for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
-               (*i).transport_stopped ();
-       }
+                for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
+                        i->realtime_locate ();
+                }
+        }
 }
 
 gain_t
@@ -483,48 +513,37 @@ Delivery::target_gain ()
                return 0.0;
        }
 
-       gain_t desired_gain = -1.0f;
-
-        if (_solo_level) {
-
-               desired_gain = 1.0;
-
-        } else {
-
-                if (_role == Listen && _session.monitor_out() && !_session.soloing()) {
-
-                        /* nobody is soloed, so control/monitor/listen bus gets its
-                           signal from master out, we should be silent
-                        */
-                        desired_gain = 0.0;
-
-                } else {
-                
-                        MuteMaster::MutePoint mp;
-                
-                        switch (_role) {
-                        case Main:
-                                mp = MuteMaster::Main;
-                                break;
-                        case Listen:
-                                mp = MuteMaster::Listen;
-                                break;
-                        case Send:
-                        case Insert:
-                        case Aux:
-                                /* XXX FIX ME this is wrong, we need per-delivery muting */
-                                mp = MuteMaster::PreFader;
-                                break;
-                        }
-                        
-                        if (!_solo_isolated && _session.soloing()) {
-                                desired_gain = min (Config->get_solo_mute_gain(), _mute_master->mute_gain_at (mp));
-                                
-                        } else {
-                                
-                                desired_gain = _mute_master->mute_gain_at (mp);
-                        }
-                }
+        MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
+
+        switch (_role) {
+        case Main:
+                mp = MuteMaster::Main;
+                break;
+        case Listen:
+                mp = MuteMaster::Listen;
+                break;
+        case Send:
+        case Insert:
+        case Aux:
+               if (_pre_fader) {
+                       mp = MuteMaster::PreFader;
+               } else {
+                       mp = MuteMaster::PostFader;
+               }
+                break;
+        }
+
+        gain_t desired_gain = _mute_master->mute_gain_at (mp);
+
+        if (_role == Listen && _session.monitor_out() && !_session.listening()) {
+
+                /* nobody is soloed, and this delivery is a listen-send to the
+                   control/monitor/listen bus, we should be silent since
+                   it gets its signal from the master out.
+                */
+
+                desired_gain = 0.0;
+
         }
 
        return desired_gain;
@@ -542,17 +561,30 @@ Delivery::set_name (const std::string& name)
        bool ret = IOProcessor::set_name (name);
 
        if (ret) {
-               ret = _panner->set_name (name);
+               ret = _panshell->set_name (name);
        }
 
        return ret;
 }
 
+bool ignore_output_change = false;
+
 void
 Delivery::output_changed (IOChange change, void* /*src*/)
 {
-       if (change & ARDOUR::ConfigurationChanged) {
+       if (change.type & IOChange::ConfigurationChanged) {
                reset_panner ();
+               _output_buffers->attach_buffers (_output->ports ());
+       }
+}
+
+boost::shared_ptr<Panner>
+Delivery::panner () const
+{
+       if (_panshell) {
+               return _panshell->panner();
+       } else {
+               return boost::shared_ptr<Panner>();
        }
 }