when calling Session::engine_halted() after a user-driven engine stop, make sure...
[ardour.git] / libs / ardour / delivery.cc
index 86ce419340acfa781d01691e09378336d779f5b9..27a12dbc29cdb77ad13dc20e91c69d7759c8d985 100644 (file)
 #include <algorithm>
 
 #include "pbd/enumwriter.h"
-#include "pbd/convert.h"
+#include "pbd/enum_convert.h"
 
-#include "ardour/midi_buffer.h"
-
-#include "ardour/debug.h"
-#include "ardour/delivery.h"
-#include "ardour/audio_buffer.h"
-#include "ardour/audio_port.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/panner_shell.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 PBD {
+       DEFINE_ENUM_CONVERT(ARDOUR::Delivery::Role);
+}
+
+namespace ARDOUR { class Panner; }
 
 using namespace std;
 using namespace PBD;
@@ -57,13 +56,15 @@ Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pann
        : 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)
+       , _current_gain (GAIN_COEFF_UNITY)
        , _no_outs_cuz_we_no_monitor (false)
        , _mute_master (mm)
        , _no_panner_reset (false)
 {
        if (pannable) {
-               _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, 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;
@@ -76,16 +77,18 @@ Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pann
 /* deliver to a new IO object */
 
 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)
+       : 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)
+       , _current_gain (GAIN_COEFF_UNITY)
        , _no_outs_cuz_we_no_monitor (false)
        , _mute_master (mm)
        , _no_panner_reset (false)
 {
        if (pannable) {
-               _panshell = boost::shared_ptr<PannerShell>(new PannerShell (_name, _session, 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;
@@ -98,11 +101,11 @@ Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::sha
 
 Delivery::~Delivery()
 {
-       DEBUG_TRACE (DEBUG::Destruction, string_compose ("delivery %1 destructor\n", _name));   
+       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 
+          of the method name is not necessary, but is here to make it
           clear that this call is about signals, not data flow connections.
        */
 
@@ -129,7 +132,7 @@ Delivery::display_name () const
 }
 
 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) {
 
@@ -149,7 +152,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*/
                }
 
 
@@ -170,7 +173,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 {
@@ -184,7 +187,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
@@ -208,7 +214,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 */
                                }
@@ -227,14 +233,14 @@ Delivery::configure_io (ChanCount in, ChanCount out)
 }
 
 void
-Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool result_required)
+Delivery::run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, 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;
        }
 
@@ -244,10 +250,11 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pf
        }
 
        /* 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().get_jack_port_addresses (ports, nframes);
+       // 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
@@ -259,78 +266,114 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pf
        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_sample_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) {
                        bufs.set_count (output_buffers().count ());
-                       Amp::apply_simple_gain (bufs, nframes, 0.0);
+                       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);
        }
 
+       // 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
 
-               _panshell->run (bufs, output_buffers(), start_frame, end_frame, nframes);
+               _panshell->run (bufs, output_buffers(), start_sample, end_sample, nframes);
 
-               // MIDI data will not have been delivered by the panner
+               // non-audio 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);
+               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, Port::port_offset());
+                       }
                }
 
        } else {
 
-               // Do a 1:1 copy of data to output ports
+               /* Do a 1:1 copy of data to output ports
+
+                  Audio is handled separately because we use 0 for the offset,
+                  since the port offset is only used for timestamped events
+                  (i.e. MIDI).
+               */
 
-               if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
+               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, 0);
+               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, Port::port_offset());
+                       }
                }
        }
 
-        if (result_required) {
-                bufs.read_from (output_buffers (), nframes);
-        }
+       if (result_required) {
+               /* "bufs" are internal, meaning they should never reflect
+                  split-cycle offsets. So shift events back in time from where
+                  they were for the external buffers associated with Ports.
+               */
+
+               const BufferSet& outs (output_buffers());
+               bufs.set_count (output_buffers().count ());
 
-  out:
+               for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
+
+                       uint32_t n = 0;
+                       for (BufferSet::iterator b = bufs.begin (*t); b != bufs.end (*t); ++b) {
+                               if (outs.count ().get (*t) <= n) {
+                                       continue;
+                               }
+                               b->read_from (outs.get (*t, n++), nframes, (*t == DataType::AUDIO ? 0 : -Port::port_offset()));
+                       }
+               }
+       }
+
+out:
        _active = _pending_active;
 }
 
 XMLNode&
-Delivery::state (bool full_state)
+Delivery::state ()
 {
-       XMLNode& node (IOProcessor::state (full_state));
+       XMLNode& node (IOProcessor::state ());
 
        if (_role & Main) {
-               node.add_property("type", "main-outs");
+               node.set_property("type", "main-outs");
        } else if (_role & Listen) {
-               node.add_property("type", "listen");
+               node.set_property("type", "listen");
        } else {
-               node.add_property("type", "delivery");
+               node.set_property("type", "delivery");
        }
 
-       node.add_property("role", enum_2_string(_role));
+       node.set_property("role", _role);
 
        if (_panshell) {
                node.add_child_nocopy (_panshell->get_state ());
+               if (_panshell->pannable()) {
+                       node.add_child_nocopy (_panshell->pannable()->get_state ());
+               }
        }
 
        return node;
@@ -339,14 +382,11 @@ Delivery::state (bool full_state)
 int
 Delivery::set_state (const XMLNode& node, int version)
 {
-       const XMLProperty* prop;
-
        if (IOProcessor::set_state (node, version)) {
                return -1;
        }
 
-       if ((prop = node.property ("role")) != 0) {
-               _role = Role (string_2_enum (prop->value(), _role));
+       if (node.get_property ("role", _role)) {
                // std::cerr << this << ' ' << _name << " set role to " << enum_2_string (_role) << std::endl;
        } else {
                // std::cerr << this << ' ' << _name << " NO ROLE INFO\n";
@@ -360,6 +400,11 @@ Delivery::set_state (const XMLNode& node, int version)
 
        reset_panner ();
 
+       XMLNode* pannnode = node.child (X_("Pannable"));
+       if (_panshell && _panshell->panner() && pannnode) {
+               _panshell->pannable()->set_state (*pannnode, version);
+       }
+
        return 0;
 }
 
@@ -376,7 +421,7 @@ Delivery::pan_outs () const
 {
        if (_output) {
                return _output->n_ports().n_audio();
-       } 
+       }
 
        return _configured_output.n_audio();
 }
@@ -387,12 +432,8 @@ Delivery::reset_panner ()
        if (panners_legal) {
                if (!_no_panner_reset) {
 
-                       if (_panshell) {
+                       if (_panshell && _role != Insert && _role != Listen) {
                                _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
-                               
-                               if (_role == Main) {
-                                       _panshell->pannable()->set_panner (_panshell->panner());
-                               }
                        }
                }
 
@@ -405,12 +446,8 @@ Delivery::reset_panner ()
 void
 Delivery::panners_became_legal ()
 {
-       if (_panshell) {
+       if (_panshell && _role != Insert) {
                _panshell->configure_io (ChanCount (DataType::AUDIO, pans_required()), ChanCount (DataType::AUDIO, pan_outs()));
-               
-               if (_role == Main) {
-                       _panshell->pannable()->set_panner (_panshell->panner());
-               }
        }
 
        panner_legal_c.disconnect ();
@@ -445,14 +482,14 @@ Delivery::reset_panners ()
 }
 
 void
-Delivery::flush_buffers (framecnt_t nframes)
+Delivery::flush_buffers (samplecnt_t nframes)
 {
        /* io_lock, not taken: function must be called from Session::process() calltree */
 
        if (!_output) {
                return;
        }
-       
+
        PortSet& ports (_output->ports());
 
        for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
@@ -461,33 +498,33 @@ Delivery::flush_buffers (framecnt_t nframes)
 }
 
 void
-Delivery::transport_stopped (framepos_t now)
+Delivery::non_realtime_transport_stop (samplepos_t now, bool flush)
 {
-        Processor::transport_stopped (now);
+       Processor::non_realtime_transport_stop (now, flush);
 
        if (_panshell) {
-               _panshell->pannable()->transport_stopped (now);
+               _panshell->pannable()->non_realtime_transport_stop (now, flush);
        }
 
-        if (_output) {
-                PortSet& ports (_output->ports());
+       if (_output) {
+               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->transport_stopped ();
+               }
+       }
 }
 
 void
 Delivery::realtime_locate ()
 {
-        if (_output) {
-                PortSet& ports (_output->ports());
+       if (_output) {
+               PortSet& ports (_output->ports());
 
-                for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
-                        i->realtime_locate ();
-                }
-        }
+               for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
+                       i->realtime_locate ();
+               }
+       }
 }
 
 gain_t
@@ -496,7 +533,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
@@ -504,41 +541,40 @@ Delivery::target_gain ()
        */
 
        if (_no_outs_cuz_we_no_monitor) {
-               return 0.0;
-       }
-
-        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;
-        }
+               return GAIN_COEFF_ZERO;
+       }
 
-        gain_t desired_gain = _mute_master->mute_gain_at (mp);
+       MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
 
-        if (_role == Listen && _session.monitor_out() && !_session.listening()) {
+       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);
 
-                /* 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.
-                */
+       if (_role == Listen && _session.monitor_out() && !_session.listening()) {
 
-                desired_gain = 0.0;
+               /* 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 = GAIN_COEFF_ZERO;
+       }
 
        return desired_gain;
 }
@@ -554,7 +590,7 @@ Delivery::set_name (const std::string& name)
 {
        bool ret = IOProcessor::set_name (name);
 
-       if (ret) {
+       if (ret && _panshell) {
                ret = _panshell->set_name (name);
        }