Collect plugin runtime profile statistics.
[ardour.git] / libs / ardour / amp.cc
index c94b09536f08fe0c30ef7c443830301963b0bb2d..7a8232d90cf1320286d9e5aacdc4d4525b381586 100644 (file)
@@ -16,7 +16,6 @@
     675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
-#include <iostream>
 #include <cstring>
 #include <cmath>
 #include <algorithm>
 #include "ardour/amp.h"
 #include "ardour/audio_buffer.h"
 #include "ardour/buffer_set.h"
+#include "ardour/gain_control.h"
 #include "ardour/midi_buffer.h"
 #include "ardour/rc_configuration.h"
 #include "ardour/session.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace ARDOUR;
 using namespace PBD;
 
-Amp::Amp (Session& s, std::string type)
+#define GAIN_COEFF_DELTA (1e-5)
+
+Amp::Amp (Session& s, const std::string& name, boost::shared_ptr<GainControl> gc, bool control_midi_also)
        : Processor(s, "Amp")
-       , _apply_gain(true)
        , _apply_gain_automation(false)
-       , _current_gain(GAIN_COEFF_UNITY)
-       , _current_automation_frame (INT64_MAX)
+       , _current_gain(GAIN_COEFF_ZERO)
+       , _current_automation_sample (INT64_MAX)
+       , _gain_control (gc)
        , _gain_automation_buffer(0)
-       , _type (type)
-       , _midi_amp (type != "trim")
-{
-       Evoral::Parameter p (_type == "trim" ? TrimAutomation : GainAutomation);
-       boost::shared_ptr<AutomationList> gl (new AutomationList (p));
-       _gain_control = boost::shared_ptr<GainControl> (new GainControl ((_type == "trim") ? X_("trimcontrol") : X_("gaincontrol"), s, this, p, gl));
-       _gain_control->set_flags (Controllable::GainLike);
-
-       add_control(_gain_control);
-}
-
-std::string
-Amp::display_name() const
+       , _midi_amp (control_midi_also)
 {
-       return _("Fader");
+       set_display_name (name);
+       add_control (_gain_control);
 }
 
 bool
@@ -76,71 +67,104 @@ Amp::configure_io (ChanCount in, ChanCount out)
        return Processor::configure_io (in, out);
 }
 
+static void
+scale_midi_velocity(Evoral::Event<MidiBuffer::TimeType>& ev, float factor)
+{
+       factor = std::max(factor, 0.0f);
+       ev.set_velocity(std::min(127L, lrintf(ev.velocity() * factor)));
+}
+
 void
-Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
+Amp::run (BufferSet& bufs, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double /*speed*/, pframes_t nframes, bool)
 {
        if (!_active && !_pending_active) {
+               /* disregard potentially prepared gain-automation. */
+               _apply_gain_automation = false;
                return;
        }
 
-       if (_apply_gain) {
-
-               if (_apply_gain_automation) {
+       if (_apply_gain_automation) {
 
-                       gain_t* gab = _gain_automation_buffer;
-                       assert (gab);
+               gain_t* gab = _gain_automation_buffer;
+               assert (gab);
 
-                       // TODO automated midi gain
+               /* see note in PluginInsert::connect_and_run -- effectively emit Changed signal */
+               _gain_control->set_value_unchecked (gab[0]);
 
-                       const float a = 62.78 / _session.nominal_frame_rate(); // 10 Hz LPF
-                       float lpf = _current_gain;
-
-                       for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
-                               Sample* const sp = i->data();
-                               lpf = _current_gain;
-                               for (pframes_t nx = 0; nx < nframes; ++nx) {
-                                       sp[nx] *= lpf;
-                                       lpf += a * (gab[nx] - lpf);
+               if (_midi_amp) {
+                       for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
+                               MidiBuffer& mb (*i);
+                               for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
+                                       Evoral::Event<MidiBuffer::TimeType> ev = *m;
+                                       if (ev.is_note_on()) {
+                                               assert(ev.time() >= 0 && ev.time() < nframes);
+                                               scale_midi_velocity (ev, fabsf (gab[ev.time()]));
+                                       }
                                }
                        }
+               }
 
-                       if (lpf < 1e-10) {
-                               _current_gain = 0;
-                       } else {
-                               _current_gain = lpf;
+               const gain_t a = 156.825f / (gain_t)_session.nominal_sample_rate(); // 25 Hz LPF; see Amp::apply_gain for details
+               gain_t lpf = _current_gain;
+
+               for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
+                       Sample* const sp = i->data();
+                       lpf = _current_gain;
+                       for (pframes_t nx = 0; nx < nframes; ++nx) {
+                               sp[nx] *= lpf;
+                               lpf += a * (gab[nx] - lpf);
                        }
+               }
 
-               } else { /* manual (scalar) gain */
+               if (fabsf (lpf) < GAIN_COEFF_SMALL) {
+                       _current_gain = GAIN_COEFF_ZERO;
+               } else {
+                       _current_gain = lpf;
+               }
 
-                       gain_t const dg = _gain_control->user_double();
+               /* used it, don't do it again until setup_gain_automation() is
+                * called successfully.
+               */
+               _apply_gain_automation = false;
 
-                       if (_current_gain != dg) {
+       } else { /* manual (scalar) gain */
 
-                               _current_gain = Amp::apply_gain (bufs, _session.nominal_frame_rate(), nframes, _current_gain, dg, _midi_amp);
+               gain_t const target_gain = _gain_control->get_value();
 
-                       } else if (_current_gain != GAIN_COEFF_UNITY) {
+               if (fabsf (_current_gain - target_gain) >= GAIN_COEFF_DELTA) {
 
-                               /* gain has not changed, but its non-unity */
+                       _current_gain = Amp::apply_gain (bufs, _session.nominal_sample_rate(), nframes, _current_gain, target_gain, _midi_amp);
 
-                               if (_midi_amp) {
-                                       /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
-                                       for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
+                       /* see note in PluginInsert::connect_and_run ()
+                        * set_value_unchecked() won't emit a signal since the value is effectively unchanged
+                        */
+                       _gain_control->Changed (false, PBD::Controllable::NoGroup);
 
-                                               MidiBuffer& mb (*i);
+               } else if (target_gain != GAIN_COEFF_UNITY) {
 
-                                               for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
-                                                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
-                                                       if (ev.is_note_on()) {
-                                                               ev.scale_velocity (_current_gain);
-                                                       }
+                       _current_gain = target_gain;
+
+                       if (_midi_amp) {
+                               /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
+                               for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
+
+                                       MidiBuffer& mb (*i);
+
+                                       for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
+                                               Evoral::Event<MidiBuffer::TimeType> ev = *m;
+                                               if (ev.is_note_on()) {
+                                                       scale_midi_velocity (ev, fabsf (_current_gain));
                                                }
                                        }
                                }
+                       }
 
-                               for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
-                                       apply_gain_to_buffer (i->data(), nframes, _current_gain);
-                               }
+                       for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
+                               apply_gain_to_buffer (i->data(), nframes, _current_gain);
                        }
+               } else {
+                       /* unity target gain */
+                       _current_gain = target_gain;
                }
        }
 
@@ -148,9 +172,9 @@ Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
 }
 
 gain_t
-Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target, bool midi_amp)
+Amp::apply_gain (BufferSet& bufs, samplecnt_t sample_rate, samplecnt_t nframes, gain_t initial, gain_t target, bool midi_amp)
 {
-        /** Apply a (potentially) declicked gain to the buffers of @a bufs */
+       /** Apply a (potentially) declicked gain to the buffers of @a bufs */
        gain_t rv = target;
 
        if (nframes == 0 || bufs.count().n_total() == 0) {
@@ -180,11 +204,11 @@ Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, ga
                        MidiBuffer& mb (*i);
 
                        for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
-                               Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                               Evoral::Event<MidiBuffer::TimeType> ev = *m;
 
                                if (ev.is_note_on()) {
                                        const gain_t scale = delta * (ev.time()/(double) nframes);
-                                       ev.scale_velocity (initial+scale);
+                                       scale_midi_velocity (ev, fabsf (initial + scale));
                                }
                        }
                }
@@ -195,11 +219,11 @@ Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, ga
        /* Low pass filter coefficient: 1.0 - e^(-2.0 * π * f / 48000) f in Hz.
         * for f << SR,  approx a ~= 6.2 * f / SR;
         */
-       const float a = 62.78 / sample_rate; // 10 Hz LPF
+       const gain_t a = 156.825f / (gain_t)sample_rate; // 25 Hz LPF
 
        for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
                Sample* const buffer = i->data();
-               float lpf = initial;
+               double lpf = initial;
 
                for (pframes_t nx = 0; nx < nframes; ++nx) {
                        buffer[nx] *= lpf;
@@ -209,31 +233,29 @@ Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, ga
                        rv = lpf;
                }
        }
-       // 1e-10 ~ 200dB, prevent denormals.
-       if (rv < 1e-10) return 0;
-       if (fabsf(rv - 1.0) < 1e-10) return 1.0;
+       if (fabsf (rv - target) < GAIN_COEFF_DELTA) return target;
        return rv;
 }
 
 void
-Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
+Amp::declick (BufferSet& bufs, samplecnt_t nframes, int dir)
 {
        if (nframes == 0 || bufs.count().n_total() == 0) {
                return;
        }
 
-       const framecnt_t declick = std::min ((framecnt_t) 512, nframes);
+       const samplecnt_t declick = std::min ((samplecnt_t) 512, nframes);
        const double     fractional_shift = 1.0 / declick ;
        gain_t           delta, initial;
 
        if (dir < 0) {
                /* fade out: remove more and more of delta from initial */
                delta = -1.0;
-                initial = GAIN_COEFF_UNITY;
+               initial = GAIN_COEFF_UNITY;
        } else {
                /* fade in: add more and more of delta from initial */
                delta = 1.0;
-                initial = GAIN_COEFF_ZERO;
+               initial = GAIN_COEFF_ZERO;
        }
 
        /* Audio Gain */
@@ -250,7 +272,7 @@ Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
                /* now ensure the rest of the buffer has the target value applied, if necessary. */
                if (declick != nframes) {
                        if (dir < 0) {
-                                memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
+                               memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
                        }
                }
        }
@@ -258,9 +280,9 @@ Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
 
 
 gain_t
-Amp::apply_gain (AudioBuffer& buf, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target)
+Amp::apply_gain (AudioBuffer& buf, samplecnt_t sample_rate, samplecnt_t nframes, gain_t initial, gain_t target, sampleoffset_t offset)
 {
-        /* Apply a (potentially) declicked gain to the contents of @a buf
+       /* Apply a (potentially) declicked gain to the contents of @a buf
         * -- used by MonitorProcessor::run()
         */
 
@@ -270,28 +292,27 @@ Amp::apply_gain (AudioBuffer& buf, framecnt_t sample_rate, framecnt_t nframes, g
 
        // if we don't need to declick, defer to apply_simple_gain
        if (initial == target) {
-               apply_simple_gain (buf, nframes, target);
+               apply_simple_gain (buf, nframes, target, offset);
                return target;
        }
 
-        Sample* const buffer = buf.data();
-       const float a = 62.78 / sample_rate; // 10 Hz LPF, see [other] Amp::apply_gain() above,
+       Sample* const buffer = buf.data (offset);
+       const gain_t a = 156.825f / (gain_t)sample_rate; // 25 Hz LPF, see [other] Amp::apply_gain() above for details
 
-       float lpf = initial;
-        for (pframes_t nx = 0; nx < nframes; ++nx) {
-                buffer[nx] *= lpf;
+       gain_t lpf = initial;
+       for (pframes_t nx = 0; nx < nframes; ++nx) {
+               buffer[nx] *= lpf;
                lpf += a * (target - lpf);
-        }
+       }
 
-       if (lpf < 1e-10) return 0; // TODO use GAIN_COEFF_TINY or _DENORMAL
-       if (fabsf(lpf - GAIN_COEFF_UNITY) < 1e-10) return GAIN_COEFF_UNITY;
+       if (fabsf (lpf - target) < GAIN_COEFF_DELTA) return target;
        return lpf;
 }
 
 void
-Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool midi_amp)
+Amp::apply_simple_gain (BufferSet& bufs, samplecnt_t nframes, gain_t target, bool midi_amp)
 {
-       if (target < GAIN_COEFF_SMALL) {
+       if (fabsf (target) < GAIN_COEFF_SMALL) {
 
                if (midi_amp) {
                        /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
@@ -299,7 +320,7 @@ Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool
                                MidiBuffer& mb (*i);
 
                                for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
-                                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                                       Evoral::Event<MidiBuffer::TimeType> ev = *m;
                                        if (ev.is_note_on()) {
                                                ev.set_velocity (0);
                                        }
@@ -319,9 +340,9 @@ Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool
                                MidiBuffer& mb (*i);
 
                                for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
-                                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                                       Evoral::Event<MidiBuffer::TimeType> ev = *m;
                                        if (ev.is_note_on()) {
-                                               ev.scale_velocity (target);
+                                               scale_midi_velocity(ev, fabsf (target));
                                        }
                                }
                        }
@@ -334,39 +355,21 @@ Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool
 }
 
 void
-Amp::apply_simple_gain (AudioBuffer& buf, framecnt_t nframes, gain_t target)
+Amp::apply_simple_gain (AudioBuffer& buf, samplecnt_t nframes, gain_t target, sampleoffset_t offset)
 {
-       if (target < GAIN_COEFF_SMALL) {
-                memset (buf.data(), 0, sizeof (Sample) * nframes);
+       if (fabsf (target) < GAIN_COEFF_SMALL) {
+               memset (buf.data (offset), 0, sizeof (Sample) * nframes);
        } else if (target != GAIN_COEFF_UNITY) {
-                apply_gain_to_buffer (buf.data(), nframes, target);
-       }
-}
-
-void
-Amp::inc_gain (gain_t factor, void *src)
-{
-       float desired_gain = _gain_control->user_double();
-
-       if (desired_gain < GAIN_COEFF_SMALL) {
-               set_gain (0.000001f + (0.000001f * factor), src);
-       } else {
-               set_gain (desired_gain + (desired_gain * factor), src);
+               apply_gain_to_buffer (buf.data(offset), nframes, target);
        }
 }
 
-void
-Amp::set_gain (gain_t val, void *)
-{
-       _gain_control->set_value (val);
-}
-
 XMLNode&
-Amp::state (bool full_state)
+Amp::state ()
 {
-       XMLNode& node (Processor::state (full_state));
-       node.add_property("type", _type);
-        node.add_child_nocopy (_gain_control->get_state());
+       XMLNode& node (Processor::state ());
+       node.set_property("type", _gain_control->parameter().type() == GainAutomation ? "amp" : "trim");
+       node.add_child_nocopy (_gain_control->get_state());
 
        return node;
 }
@@ -374,69 +377,26 @@ Amp::state (bool full_state)
 int
 Amp::set_state (const XMLNode& node, int version)
 {
-        XMLNode* gain_node;
+       XMLNode* gain_node;
 
        Processor::set_state (node, version);
 
-        if ((gain_node = node.child (Controllable::xml_node_name.c_str())) != 0) {
-                _gain_control->set_state (*gain_node, version);
-        }
-
-       return 0;
-}
-
-void
-Amp::GainControl::set_value (double val)
-{
-       AutomationControl::set_value (std::max (std::min (val, (double)_desc.upper), (double)_desc.lower));
-       _amp->session().set_dirty ();
-}
-
-double
-Amp::GainControl::internal_to_interface (double v) const
-{
-       if (_desc.type == GainAutomation) {
-               return gain_to_slider_position (v);
-       } else {
-               return (accurate_coefficient_to_dB (v) - lower_db) / range_db;
+       if ((gain_node = node.child (Controllable::xml_node_name.c_str ())) != 0) {
+               _gain_control->set_state (*gain_node, version);
        }
-}
 
-double
-Amp::GainControl::interface_to_internal (double v) const
-{
-       if (_desc.type == GainAutomation) {
-               return slider_position_to_gain (v);
-       } else {
-               return dB_to_coefficient (lower_db + v * range_db);
-       }
-}
-
-double
-Amp::GainControl::internal_to_user (double v) const
-{
-       return accurate_coefficient_to_dB (v);
-}
-
-double
-Amp::GainControl::user_to_internal (double u) const
-{
-       return dB_to_coefficient (u);
-}
-
-std::string
-Amp::GainControl::get_user_string () const
-{
-       char theBuf[32]; sprintf( theBuf, _("%3.1f dB"), accurate_coefficient_to_dB (get_value()));
-       return std::string(theBuf);
+       return 0;
 }
 
 /** Write gain automation for this cycle into the buffer previously passed in to
  *  set_gain_automation_buffer (if we are in automation playback mode and the
  *  transport is rolling).
+ *
+ *  After calling this, the gain-automation buffer is valid for the next run.
+ *  so make sure to call ::run() which invalidates the buffer again.
  */
 void
-Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes)
+Amp::setup_gain_automation (samplepos_t start_sample, samplepos_t end_sample, samplecnt_t nframes)
 {
        Glib::Threads::Mutex::Lock am (control_lock(), Glib::Threads::TRY_LOCK);
 
@@ -445,15 +405,16 @@ Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framec
            && _gain_control->automation_playback())
        {
                assert (_gain_automation_buffer);
-               _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
-                       start_frame, end_frame, _gain_automation_buffer, nframes);
-               if (start_frame != _current_automation_frame) {
+
+               _apply_gain_automation = _gain_control->get_masters_curve ( start_sample, end_sample, _gain_automation_buffer, nframes);
+
+               if (start_sample != _current_automation_sample && _session.bounce_processing ()) {
                        _current_gain = _gain_automation_buffer[0];
                }
-               _current_automation_frame = end_frame;
+               _current_automation_sample = end_sample;
        } else {
                _apply_gain_automation = false;
-               _current_automation_frame = INT64_MAX;
+               _current_automation_sample = INT64_MAX;
        }
 }
 
@@ -463,23 +424,10 @@ Amp::visible() const
        return true;
 }
 
-std::string
-Amp::value_as_string (boost::shared_ptr<AutomationControl> ac) const
-{
-       if (ac == _gain_control) {
-               char buffer[32];
-               snprintf (buffer, sizeof (buffer), _("%.2fdB"), ac->internal_to_user (ac->get_value ()));
-               return buffer;
-       }
-
-       return Automatable::value_as_string (ac);
-}
-
 /** Sets up the buffer that setup_gain_automation and ::run will use for
  *  gain automationc curves.  Must be called before setup_gain_automation,
  *  and must be called with process lock held.
  */
-
 void
 Amp::set_gain_automation_buffer (gain_t* g)
 {