fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / delivery.cc
index 700efd8ac1eae88e52036f5e456c2e4b62431e04..e051ce6fb14a88fb92567026ad91ea3bbc768e53 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 "ardour/audioengine.h"
 
-#include "i18n.h"
+#include "pbd/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)
+       , _current_gain (GAIN_COEFF_UNITY)
        , _no_outs_cuz_we_no_monitor (false)
        , _mute_master (mm)
-       , no_panner_reset (false)
+       , _no_panner_reset (false)
 {
-       _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
+       if (pannable) {
+               bool is_send = false;
+               if (r & (Delivery::Send|Delivery::Aux)) is_send = true;
+               _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable, is_send));
+       }
+
        _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)
+       , _current_gain (GAIN_COEFF_UNITY)
        , _no_outs_cuz_we_no_monitor (false)
        , _mute_master (mm)
-       , no_panner_reset (false)
+       , _no_panner_reset (false)
 {
-       _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
+       if (pannable) {
+               bool is_send = false;
+               if (r & (Delivery::Send|Delivery::Aux)) is_send = true;
+               _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, pannable, is_send));
+       }
+
        _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;
 }
 
@@ -114,21 +127,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) {
 
@@ -148,7 +148,7 @@ Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) con
                        }
                } else {
                        fatal << "programming error: this should never be reached" << endmsg;
-                       /*NOTREACHED*/
+                       abort(); /*NOTREACHED*/
                }
 
 
@@ -169,7 +169,7 @@ Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) con
                        }
                } else {
                        fatal << "programming error: this should never be reached" << endmsg;
-                       /*NOTREACHED*/
+                       abort(); /*NOTREACHED*/
                }
 
        } else {
@@ -183,7 +183,10 @@ Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) con
 bool
 Delivery::configure_io (ChanCount in, ChanCount out)
 {
-       assert (!AudioEngine::instance()->process_lock().trylock());
+#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
@@ -207,7 +210,7 @@ Delivery::configure_io (ChanCount in, ChanCount out)
                        if (_input->n_ports() != in) {
                                if (_input->n_ports() != ChanCount::ZERO) {
                                        fatal << _name << " programming error: configure_io called with " << in << " and " << out << " with " << _input->n_ports() << " input ports" << endmsg;
-                                       /*NOTREACHED*/
+                                       abort(); /*NOTREACHED*/
                                } else {
                                        /* I/O not yet configured */
                                }
@@ -215,7 +218,7 @@ Delivery::configure_io (ChanCount in, ChanCount out)
                }
 
        }
-       
+
        if (!Processor::configure_io (in, out)) {
                return false;
        }
@@ -226,14 +229,14 @@ Delivery::configure_io (ChanCount in, ChanCount out)
 }
 
 void
-Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, nframes_t nframes, bool result_required)
+Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double /*speed*/, pframes_t nframes, bool result_required)
 {
        assert (_output);
 
        PortSet& ports (_output->ports());
        gain_t tgain;
 
-       if (_output->n_ports ().get (_output->default_type()) == 0) {
+       if (ports.num_ports () == 0) {
                goto out;
        }
 
@@ -243,10 +246,11 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, nf
        }
 
        /* this setup is not just for our purposes, but for anything that comes after us in the
-          processing pathway that wants to use this->output_buffers() for some reason.
-       */
+        * processing pathway that wants to use this->output_buffers() for some reason.
+        */
 
-       output_buffers().attach_buffers (ports, nframes, _output_offset);
+       // TODO delayline -- latency-compensation
+       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
@@ -258,53 +262,71 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, nf
        if (tgain != _current_gain) {
                /* target gain has changed */
 
-               Amp::apply_gain (bufs, nframes, _current_gain, tgain);
-               _current_gain = tgain;
+               _current_gain = Amp::apply_gain (bufs, _session.nominal_frame_rate(), nframes, _current_gain, tgain);
 
-       } else if (tgain == 0.0) {
+       } else if (tgain < GAIN_COEFF_SMALL) {
 
                /* we were quiet last time, and we're still supposed to be quiet.
-                  Silence the outputs, and make sure the buffers are quiet too,
-               */
+                        Silence the outputs, and make sure the buffers are quiet too,
+                        */
 
                _output->silence (nframes);
                if (result_required) {
-                       Amp::apply_simple_gain (bufs, nframes, 0.0);
+                       bufs.set_count (output_buffers().count ());
+                       Amp::apply_simple_gain (bufs, nframes, GAIN_COEFF_ZERO);
                }
                goto out;
 
-       } else if (tgain != 1.0) {
+       } else if (tgain != GAIN_COEFF_UNITY) {
 
                /* target gain has not changed, but is not unity */
                Amp::apply_simple_gain (bufs, nframes, tgain);
        }
 
-       if (_panner && _panner->npanners() && !_panner->bypassed()) {
+       // Speed quietning
+
+       if (fabs (_session.transport_speed()) > 1.5 && Config->get_quieten_at_speed ()) {
+               Amp::apply_simple_gain (bufs, nframes, speed_quietning, false);
+       }
+
+       // Panning
+
+       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);
+               // non-audio data will not have been delivered by the panner
+
+               for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
+                       if (*t != DataType::AUDIO && bufs.count().get(*t) > 0) {
+                               _output->copy_to_outputs (bufs, *t, nframes, ports.port(0)->port_offset());
+                       }
                }
 
        } 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);
-                }
+               // audio is handled separately because we use 0 for the offset
+               // XXX how does this interact with Port::increment_global_port_buffer_offset ?
+               if (bufs.count().n_audio() > 0) {
+                       _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);
+               for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
+                       if (*t != DataType::AUDIO && bufs.count().get(*t) > 0) {
+                               _output->copy_to_outputs (bufs, *t, nframes, ports.port(0)->port_offset());
+                       }
                }
-                
-                        
        }
 
-  out:
+       if (result_required) {
+               bufs.read_from (output_buffers (), nframes);
+       }
+
+out:
        _active = _pending_active;
 }
 
@@ -322,7 +344,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;
 }
@@ -330,7 +358,7 @@ Delivery::state (bool full_state)
 int
 Delivery::set_state (const XMLNode& node, int version)
 {
-       const XMLProperty* prop;
+       XMLProperty const * prop;
 
        if (IOProcessor::set_state (node, version)) {
                return -1;
@@ -343,112 +371,108 @@ 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 && _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 && _role != Insert && _role != Listen) {
+                               _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
                        }
-
-                       _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 && _role != Insert) {
+               _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
        }
 
-       _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, double when)
+Delivery::flush_buffers (framecnt_t nframes)
 {
-       if (which < _panner->npanners()) {
-               _panner->pan_control(which)->start_touch(when);
-       }
-}
+       /* io_lock, not taken: function must be called from Session::process() calltree */
 
-void
-Delivery::end_pan_touch (uint32_t which, bool mark, double when)
-{
-       if (which < _panner->npanners()) {
-               _panner->pan_control(which)->stop_touch(mark, when);
+       if (!_output) {
+               return;
        }
 
-}
-
-
-void
-Delivery::flush_buffers (nframes_t nframes, framepos_t time)
-{
-       /* io_lock, not taken: function must be called from Session::process() calltree */
-
        PortSet& ports (_output->ports());
-        
+
        for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
-               (*i).flush_buffers (nframes, time, _output_offset);
+               i->flush_buffers (nframes);
        }
 }
 
@@ -457,13 +481,27 @@ Delivery::transport_stopped (framepos_t now)
 {
         Processor::transport_stopped (now);
 
-       _panner->transport_stopped (now);
+       if (_panshell) {
+               _panshell->pannable()->transport_stopped (now);
+       }
 
         if (_output) {
                 PortSet& ports (_output->ports());
-                
+
+                for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
+                        i->transport_stopped ();
+                }
+        }
+}
+
+void
+Delivery::realtime_locate ()
+{
+        if (_output) {
+                PortSet& ports (_output->ports());
+
                 for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
-                        (*i).transport_stopped ();
+                        i->realtime_locate ();
                 }
         }
 }
@@ -474,7 +512,7 @@ Delivery::target_gain ()
        /* if we've been requested to deactivate, our target gain is zero */
 
        if (!_pending_active) {
-               return 0.0;
+               return GAIN_COEFF_ZERO;
        }
 
        /* if we've been told not to output because its a monitoring situation and
@@ -482,11 +520,11 @@ Delivery::target_gain ()
        */
 
        if (_no_outs_cuz_we_no_monitor) {
-               return 0.0;
+               return GAIN_COEFF_ZERO;
        }
 
         MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
-        
+
         switch (_role) {
         case Main:
                 mp = MuteMaster::Main;
@@ -506,17 +544,17 @@ Delivery::target_gain ()
         }
 
         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;
-                
-        } 
+
+                desired_gain = GAIN_COEFF_ZERO;
+
+        }
 
        return desired_gain;
 }
@@ -532,18 +570,31 @@ Delivery::set_name (const std::string& name)
 {
        bool ret = IOProcessor::set_name (name);
 
-       if (ret) {
-               ret = _panner->set_name (name);
+       if (ret && _panshell) {
+               ret = _panshell->set_name (name);
        }
 
        return ret;
 }
 
+bool ignore_output_change = false;
+
 void
 Delivery::output_changed (IOChange change, void* /*src*/)
 {
        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>();
        }
 }