fix DSP load bounds 0..1 and add unbound API
[ardour.git] / libs / ardour / delivery.cc
index 126b599299691855457e23283b4b818404d6c766..5a4fbd3e1defe3c1f5bf5cc481f36fefd29ebd60 100644 (file)
@@ -52,13 +52,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)
+       , _amp (new Amp (s))
        , _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;
@@ -66,6 +68,8 @@ Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pann
        if (_output) {
                _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
        }
+
+       _amp->activate ();
 }
 
 /* deliver to a new IO object */
@@ -74,13 +78,15 @@ Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::sha
        : 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)
+       , _amp (new Amp (s))
        , _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;
@@ -88,16 +94,17 @@ Delivery::Delivery (Session& s, boost::shared_ptr<Pannable> pannable, boost::sha
        if (_output) {
                _output->changed.connect_same_thread (*this, boost::bind (&Delivery::output_changed, this, _1, _2));
        }
-}
 
+       _amp->activate ();
+}
 
 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.
        */
 
@@ -124,7 +131,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) {
 
@@ -144,7 +151,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*/
                }
 
 
@@ -165,7 +172,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 {
@@ -179,7 +186,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
@@ -203,7 +213,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 */
                                }
@@ -228,6 +238,7 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pf
 
        PortSet& ports (_output->ports());
        gain_t tgain;
+       bool need_amp = true;
 
        if (_output->n_ports ().get (_output->default_type()) == 0) {
                goto out;
@@ -242,7 +253,8 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pf
           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
@@ -251,31 +263,69 @@ Delivery::run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pf
 
        tgain = target_gain ();
 
-       if (tgain != _current_gain) {
-               /* target gain has changed */
+       if (tgain < GAIN_COEFF_SMALL && _amp->gain() < GAIN_COEFF_SMALL) {
 
-               Amp::apply_gain (bufs, nframes, _current_gain, tgain);
-               _current_gain = tgain;
+               /* special case (but very common) fast path:
+                *
+                * if we are supposed to be silent, and we were already silent,
+                * then short-circuit the computation in Amp and just put silence into
+                * our output(s)
+                */
 
-       } else if (tgain == 0.0) {
+               _output->silence (nframes);
 
-               /* we were quiet last time, and we're still supposed to be quiet.
-                  Silence the outputs, and make sure the buffers are quiet too,
-               */
+               if (!result_required) {
+                       /* if !result_required, then the buffers won't actually
+                        * be used. This means we don't actually need to silence
+                        * them, because we've already filled the output ports
+                        * with silence.
+                        *
+                        * but we just noted that result_required is true,
+                        * and so we do need to run the amp to ensure
+                        * that the buffers are silenced.
+                        */
+                       need_amp = false;
+               }
+       }
+
+       if (need_amp) {
+
+               bufs.set_count (output_buffers().count ());
+
+               if (_role != Main) {
+
+                       /* inserts, external and internal sends have
+                        * automatable gain and the Amp::run() method has
+                        * already been executed by the time we get here.
+                        *
+                        * XXX we do not expose the automatable gain for
+                        * Inserts as of September 2015.
+                        */
+
+               } else {
+
+                       /* main outs have no automatable gain, the amp is just
+                        * used for ramping gain changes caused by monitoring
+                        * state changes.
+                        */
+
+                       _amp->set_gain (tgain, this);
+                       _amp->run (bufs, 0, 0, nframes, false);
 
-               _output->silence (nframes);
-               if (result_required) {
-                       bufs.set_count (output_buffers().count ());
-                       Amp::apply_simple_gain (bufs, nframes, 0.0);
                }
+
+       } else {
                goto out;
+       }
 
-       } else if (tgain != 1.0) {
+        // Speed quietning
 
-               /* target gain has not changed, but is not unity */
-               Amp::apply_simple_gain (bufs, nframes, tgain);
+       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
@@ -326,6 +376,9 @@ Delivery::state (bool full_state)
 
        if (_panshell) {
                node.add_child_nocopy (_panshell->get_state ());
+               if (_panshell->pannable()) {
+                       node.add_child_nocopy (_panshell->pannable()->get_state ());
+               }
        }
 
        return node;
@@ -355,6 +408,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;
 }
 
@@ -371,7 +429,7 @@ Delivery::pan_outs () const
 {
        if (_output) {
                return _output->n_ports().n_audio();
-       } 
+       }
 
        return _configured_output.n_audio();
 }
@@ -382,12 +440,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());
-                               }
                        }
                }
 
@@ -400,12 +454,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 ();
@@ -447,7 +497,7 @@ Delivery::flush_buffers (framecnt_t nframes)
        if (!_output) {
                return;
        }
-       
+
        PortSet& ports (_output->ports());
 
        for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
@@ -491,15 +541,15 @@ 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
           we're not monitoring, then be quiet.
        */
 
-       if (_no_outs_cuz_we_no_monitor) {
-               return 0.0;
+       if (_role == Main && _session.config.get_use_monitor_fades() && _no_outs_cuz_we_no_monitor) {
+               return GAIN_COEFF_ZERO;
        }
 
         MuteMaster::MutePoint mp = MuteMaster::Main; // stupid gcc uninit warning
@@ -531,7 +581,7 @@ Delivery::target_gain ()
                    it gets its signal from the master out.
                 */
 
-                desired_gain = 0.0;
+                desired_gain = GAIN_COEFF_ZERO;
 
         }
 
@@ -549,7 +599,7 @@ Delivery::set_name (const std::string& name)
 {
        bool ret = IOProcessor::set_name (name);
 
-       if (ret) {
+       if (ret && _panshell) {
                ret = _panshell->set_name (name);
        }