fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / amp.cc
index b74a57dbce8badfeede821a8973b3ed995ddf121..d86362aa0d37d19198d8a8c840441c8145d133fe 100644 (file)
 #include "ardour/amp.h"
 #include "ardour/audio_buffer.h"
 #include "ardour/buffer_set.h"
-#include "ardour/configuration.h"
-#include "ardour/io.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)
+// used for low-pass filter denormal protection
+#define GAIN_COEFF_TINY (1e-10) // -200dB
+
+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(1.0)
-{
-       Evoral::Parameter p (GainAutomation);
-       /* gain range of -inf to +6dB, default 0dB */
-       p.set_range (0, 1.99526231f, 1, false);
-       boost::shared_ptr<AutomationList> gl (new AutomationList (p));
-       _gain_control = boost::shared_ptr<GainControl> (new GainControl (X_("gaincontrol"), s, this, p, gl));
-       add_control(_gain_control);
-}
-
-std::string
-Amp::display_name() const
+       , _current_gain(GAIN_COEFF_ZERO)
+       , _current_automation_frame (INT64_MAX)
+       , _gain_control (gc)
+       , _gain_automation_buffer(0)
+       , _midi_amp (control_midi_also)
 {
-       return _("Fader");
+       set_display_name (name);
+       add_control (_gain_control);
 }
 
 bool
-Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
+Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out)
 {
        out = in;
        return true;
@@ -74,7 +71,7 @@ Amp::configure_io (ChanCount in, ChanCount out)
 }
 
 void
-Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
+Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, double /*speed*/, pframes_t nframes, bool)
 {
        if (!_active && !_pending_active) {
                return;
@@ -84,39 +81,64 @@ Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
 
                if (_apply_gain_automation) {
 
-                       gain_t* gab = _session.gain_automation_buffer ();
+                       gain_t* gab = _gain_automation_buffer;
+                       assert (gab);
+
+                       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::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                                               if (ev.is_note_on()) {
+                                                       assert(ev.time() >= 0 && ev.time() < nframes);
+                                                       ev.scale_velocity (fabsf (gab[ev.time()]));
+                                               }
+                                       }
+                               }
+                       }
+
+
+                       const double a = 156.825 / _session.nominal_frame_rate(); // 25 Hz LPF; see Amp::apply_gain for details
+                       double 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] *= gab[nx];
+                                       sp[nx] *= lpf;
+                                       lpf += a * (gab[nx] - lpf);
                                }
                        }
 
-                       _current_gain = gab[nframes-1];
+                       if (fabs (lpf) < GAIN_COEFF_TINY) {
+                               _current_gain = GAIN_COEFF_ZERO;
+                       } else {
+                               _current_gain = lpf;
+                       }
 
                } else { /* manual (scalar) gain */
 
-                       gain_t const dg = _gain_control->user_double();
+                       gain_t const dg = _gain_control->get_value();
 
                        if (_current_gain != dg) {
 
-                               Amp::apply_gain (bufs, nframes, _current_gain, dg);
-                               _current_gain = dg;
+                               _current_gain = Amp::apply_gain (bufs, _session.nominal_frame_rate(), nframes, _current_gain, dg, _midi_amp);
 
-                       } else if (_current_gain != 1.0f) {
+                       } else if (_current_gain != GAIN_COEFF_UNITY) {
 
-                               /* gain has not changed, but its non-unity
-                               */
+                               /* gain has not changed, but its non-unity */
 
-                               for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
+                               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);
+                                               MidiBuffer& mb (*i);
 
-                                       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);
+                                               for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
+                                                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                                                       if (ev.is_note_on()) {
+                                                               ev.scale_velocity (fabsf (_current_gain));
+                                                       }
                                                }
                                        }
                                }
@@ -131,192 +153,161 @@ Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
        _active = _pending_active;
 }
 
-void
-Amp::apply_gain (BufferSet& bufs, framecnt_t nframes, gain_t initial, gain_t target)
+gain_t
+Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_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) {
-               return;
+               return initial;
        }
 
        // if we don't need to declick, defer to apply_simple_gain
        if (initial == target) {
                apply_simple_gain (bufs, nframes, target);
-               return;
-       }
-
-       const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
-       gain_t         delta;
-       double         fractional_shift = -1.0/declick;
-       double         fractional_pos;
-
-       if (target < initial) {
-               /* fade out: remove more and more of delta from initial */
-               delta = -(initial - target);
-       } else {
-               /* fade in: add more and more of delta from initial */
-               delta = target - initial;
+               return target;
        }
 
        /* MIDI 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) {
 
-       for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
+                       gain_t  delta;
+                       if (target < initial) {
+                               /* fade out: remove more and more of delta from initial */
+                               delta = -(initial - target);
+                       } else {
+                               /* fade in: add more and more of delta from initial */
+                               delta = target - initial;
+                       }
 
-               MidiBuffer& mb (*i);
+                       MidiBuffer& mb (*i);
 
-               for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
-                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                       for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
+                               Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
 
-                       if (ev.is_note_on()) {
-                               gain_t scale = delta * (ev.time()/(double) nframes);
-                               ev.scale_velocity (initial+scale);
+                               if (ev.is_note_on()) {
+                                       const gain_t scale = delta * (ev.time()/(double) nframes);
+                                       ev.scale_velocity (fabsf (initial+scale));
+                               }
                        }
                }
        }
 
        /* Audio Gain */
 
+       /* Low pass filter coefficient: 1.0 - e^(-2.0 * π * f / 48000) f in Hz.
+        * for f << SR,  approx a ~= 6.2 * f / SR;
+        */
+       const double a = 156.825 / sample_rate; // 25 Hz LPF
+
        for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
                Sample* const buffer = i->data();
+               double lpf = initial;
 
-               fractional_pos = 1.0;
-
-               for (pframes_t nx = 0; nx < declick; ++nx) {
-                       buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
-                       fractional_pos += fractional_shift;
+               for (pframes_t nx = 0; nx < nframes; ++nx) {
+                       buffer[nx] *= lpf;
+                       lpf += a * (target - lpf);
                }
-
-               /* now ensure the rest of the buffer has the target value applied, if necessary. */
-
-               if (declick != nframes) {
-
-                       if (target == 0.0) {
-                               memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
-                       } else if (target != 1.0) {
-                               apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
-                       }
+               if (i == bufs.audio_begin()) {
+                       rv = lpf;
                }
        }
+       if (fabsf (rv - target) < GAIN_COEFF_TINY) return target;
+       if (fabsf (rv) < GAIN_COEFF_TINY) return GAIN_COEFF_ZERO;
+       return rv;
 }
 
 void
 Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
 {
-        /* Almost exactly like ::apply_gain() but skips MIDI buffers and has fixed initial+target
-           values.
-         */
-
        if (nframes == 0 || bufs.count().n_total() == 0) {
                return;
        }
 
-       const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
-       gain_t         delta, initial, target;
-       double         fractional_shift = -1.0/(declick-1);
-       double         fractional_pos;
+       const framecnt_t declick = std::min ((framecnt_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 = 1.0;
-                target = 0.0;
+                initial = GAIN_COEFF_UNITY;
        } else {
                /* fade in: add more and more of delta from initial */
                delta = 1.0;
-                initial = 0.0;
-                target = 1.0;
+                initial = GAIN_COEFF_ZERO;
        }
 
        /* Audio Gain */
-
        for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
                Sample* const buffer = i->data();
 
-               fractional_pos = 1.0;
+               double fractional_pos = 0.0;
 
                for (pframes_t nx = 0; nx < declick; ++nx) {
-                       buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
+                       buffer[nx] *= initial + (delta * fractional_pos);
                        fractional_pos += fractional_shift;
                }
 
                /* now ensure the rest of the buffer has the target value applied, if necessary. */
-
                if (declick != nframes) {
-
-                       if (target == 0.0) {
+                       if (dir < 0) {
                                 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
-                       } else if (target != 1.0) {
-                               apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
                        }
                }
        }
 }
 
-void
-Amp::apply_gain (AudioBuffer& buf, framecnt_t nframes, gain_t initial, gain_t target)
+
+gain_t
+Amp::apply_gain (AudioBuffer& buf, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target)
 {
-        /** 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()
         */
 
        if (nframes == 0) {
-               return;
+               return initial;
        }
 
        // if we don't need to declick, defer to apply_simple_gain
        if (initial == target) {
                apply_simple_gain (buf, nframes, target);
-               return;
-       }
-
-       const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
-       gain_t         delta;
-       double         fractional_shift = -1.0/declick;
-       double         fractional_pos;
-
-       if (target < initial) {
-               /* fade out: remove more and more of delta from initial */
-               delta = -(initial - target);
-       } else {
-               /* fade in: add more and more of delta from initial */
-               delta = target - initial;
+               return target;
        }
 
-
         Sample* const buffer = buf.data();
+       const double a = 156.825 / sample_rate; // 25 Hz LPF, see [other] Amp::apply_gain() above for details
 
-        fractional_pos = 1.0;
-
-        for (pframes_t nx = 0; nx < declick; ++nx) {
-                buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
-                fractional_pos += fractional_shift;
+       double lpf = initial;
+        for (pframes_t nx = 0; nx < nframes; ++nx) {
+                buffer[nx] *= lpf;
+               lpf += a * (target - lpf);
         }
 
-        /* now ensure the rest of the buffer has the target value applied, if necessary. */
-
-        if (declick != nframes) {
-
-                if (target == 0.0) {
-                        memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
-                } else if (target != 1.0) {
-                        apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
-                }
-        }
+       if (fabs (lpf - target) < GAIN_COEFF_TINY) return target;
+       if (fabs (lpf) < GAIN_COEFF_TINY) return GAIN_COEFF_ZERO;
+       return lpf;
 }
 
 void
-Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target)
+Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool midi_amp)
 {
-       if (target == 0.0) {
+       if (fabsf (target) < GAIN_COEFF_SMALL) {
 
-               for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
-                       MidiBuffer& mb (*i);
+               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::MIDIEvent<MidiBuffer::TimeType> ev = *m;
-                               if (ev.is_note_on()) {
-                                       ev.set_velocity (0);
+                               for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
+                                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                                       if (ev.is_note_on()) {
+                                               ev.set_velocity (0);
+                                       }
                                }
                        }
                }
@@ -325,15 +316,18 @@ Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target)
                        memset (i->data(), 0, sizeof (Sample) * nframes);
                }
 
-       } else if (target != 1.0) {
+       } else if (target != GAIN_COEFF_UNITY) {
 
-               for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
-                       MidiBuffer& mb (*i);
+               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::MIDIEvent<MidiBuffer::TimeType> ev = *m;
-                               if (ev.is_note_on()) {
-                                       ev.scale_velocity (target);
+                               for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
+                                       Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
+                                       if (ev.is_note_on()) {
+                                               ev.scale_velocity (fabsf (target));
+                                       }
                                }
                        }
                }
@@ -347,50 +341,19 @@ Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target)
 void
 Amp::apply_simple_gain (AudioBuffer& buf, framecnt_t nframes, gain_t target)
 {
-       if (target == 0.0) {
+       if (fabsf (target) < GAIN_COEFF_SMALL) {
                 memset (buf.data(), 0, sizeof (Sample) * nframes);
-       } else if (target != 1.0) {
+       } 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 == 0.0f) {
-               set_gain (0.000001f + (0.000001f * factor), src);
-       } else {
-               set_gain (desired_gain + (desired_gain * factor), src);
-       }
-}
-
-void
-Amp::set_gain (gain_t val, void *src)
-{
-       // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
-       if (val > 1.99526231f) {
-               val = 1.99526231f;
-       }
-
-       if (src != _gain_control.get()) {
-               _gain_control->set_value (val);
-               // bit twisty, this will come back and call us again
-               // (this keeps control in sync with reality)
-               return;
-       }
-
-       _gain_control->set_double(val, false);
-       _session.set_dirty();
-}
-
 XMLNode&
 Amp::state (bool full_state)
 {
        XMLNode& node (Processor::state (full_state));
-       node.add_property("type", "amp");
-        node.add_child_nocopy (_gain_control->get_state());
+       node.add_property("type", _gain_control->parameter().type() == GainAutomation ? "amp" : "trim");
+       node.add_child_nocopy (_gain_control->get_state());
 
        return node;
 }
@@ -409,47 +372,29 @@ Amp::set_state (const XMLNode& node, int version)
        return 0;
 }
 
-void
-Amp::GainControl::set_value (double val)
-{
-       // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
-       if (val > 1.99526231) {
-               val = 1.99526231;
-       }
-
-       _amp->set_gain (val, this);
-
-       AutomationControl::set_value(val);
-}
-
-double
-Amp::GainControl::internal_to_interface (double v) const
-{
-       return gain_to_slider_position (v);
-}
-
-double
-Amp::GainControl::interface_to_internal (double v) const
-{
-       return slider_position_to_gain (v);
-}
-
-double
-Amp::GainControl::internal_to_user (double v) const
-{
-       return accurate_coefficient_to_dB (v);
-}
-
+/** 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).
+ */
 void
 Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes)
 {
-       Glib::Mutex::Lock am (control_lock(), Glib::TRY_LOCK);
+       Glib::Threads::Mutex::Lock am (control_lock(), Glib::Threads::TRY_LOCK);
 
-       if (am.locked() && _session.transport_rolling() && _gain_control->automation_playback()) {
+       if (am.locked()
+           && (_session.transport_rolling() || _session.bounce_processing())
+           && _gain_control->automation_playback())
+       {
+               assert (_gain_automation_buffer);
                _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
-                       start_frame, end_frame, _session.gain_automation_buffer(), nframes);
+                       start_frame, end_frame, _gain_automation_buffer, nframes);
+               if (start_frame != _current_automation_frame && _session.bounce_processing ()) {
+                       _current_gain = _gain_automation_buffer[0];
+               }
+               _current_automation_frame = end_frame;
        } else {
                _apply_gain_automation = false;
+               _current_automation_frame = INT64_MAX;
        }
 }
 
@@ -460,14 +405,24 @@ Amp::visible() const
 }
 
 std::string
-Amp::value_as_string (boost::shared_ptr<AutomationControl> ac) const
+Amp::value_as_string (boost::shared_ptr<const AutomationControl> ac) const
 {
        if (ac == _gain_control) {
                char buffer[32];
-               snprintf (buffer, sizeof (buffer), "%.2fdB", ac->internal_to_user (ac->get_value ()));
+               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)
+{
+       _gain_automation_buffer = g;
+}