use const static member instead of a magic number
[ardour.git] / libs / ardour / amp.cc
index 230b9f0d6b13ab7daa2ed893cb0aa17d21da101f..f60240fd57c128dc6ca97a74364eecbb90b56912 100644 (file)
@@ -26,8 +26,6 @@
 #include "ardour/amp.h"
 #include "ardour/audio_buffer.h"
 #include "ardour/buffer_set.h"
-#include "ardour/configuration.h"
-#include "ardour/io.h"
 #include "ardour/midi_buffer.h"
 #include "ardour/session.h"
 
 
 using namespace ARDOUR;
 using namespace PBD;
+using std::min;
+
+/* gain range of -inf to +6dB, default 0dB */
+const float Amp::max_gain_coefficient = 1.99526231f;
 
 Amp::Amp (Session& s)
        : Processor(s, "Amp")
        , _apply_gain(true)
        , _apply_gain_automation(false)
        , _current_gain(1.0)
+       , _gain_automation_buffer(0)
 {
-       boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(GainAutomation)));
-       _gain_control = boost::shared_ptr<GainControl>( new GainControl(X_("gaincontrol"), s, this, Evoral::Parameter(GainAutomation), gl ));
+       Evoral::Parameter p (GainAutomation);
+       p.set_range (0, max_gain_coefficient, 1, false);
+       boost::shared_ptr<AutomationList> gl (new AutomationList (p));
+       _gain_control = boost::shared_ptr<GainControl> (new GainControl (X_("gaincontrol"), s, this, p, gl));
+       _gain_control->set_flags (Controllable::GainLike);
+
        add_control(_gain_control);
 }
 
@@ -81,7 +88,8 @@ 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);
 
                        for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
                                Sample* const sp = i->data();
@@ -89,7 +97,7 @@ Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
                                        sp[nx] *= gab[nx];
                                }
                        }
-                       
+
                        _current_gain = gab[nframes-1];
 
                } else { /* manual (scalar) gain */
@@ -109,7 +117,7 @@ Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/,
                                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()) {
@@ -167,7 +175,7 @@ Amp::apply_gain (BufferSet& bufs, framecnt_t nframes, gain_t initial, gain_t tar
                        Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
 
                        if (ev.is_note_on()) {
-                               gain_t scale = delta * (ev.time()/(double) nframes);
+                               const gain_t scale = delta * (ev.time()/(double) nframes);
                                ev.scale_velocity (initial+scale);
                        }
                }
@@ -211,7 +219,7 @@ Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
 
        const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
        gain_t         delta, initial, target;
-       double         fractional_shift = -1.0/declick;
+       double         fractional_shift = -1.0/(declick-1);
        double         fractional_pos;
 
        if (dir < 0) {
@@ -243,7 +251,7 @@ Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
                if (declick != nframes) {
 
                        if (target == 0.0) {
-                               memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
+                                memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
                        } else if (target != 1.0) {
                                apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
                        }
@@ -282,18 +290,18 @@ Amp::apply_gain (AudioBuffer& buf, framecnt_t nframes, gain_t initial, gain_t ta
 
 
         Sample* const buffer = buf.data();
-        
+
         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;
         }
-        
+
         /* 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) {
@@ -366,12 +374,7 @@ Amp::inc_gain (gain_t factor, void *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;
-       }
-
-       //cerr << "set desired gain to " << val << " when curgain = " << _gain_control->get_value () << endl;
+       val = min (val, max_gain_coefficient);
 
        if (src != _gain_control.get()) {
                _gain_control->set_value (val);
@@ -380,7 +383,7 @@ Amp::set_gain (gain_t val, void *src)
                return;
        }
 
-       _gain_control->set_double(val, false);
+       _gain_control->set_double (val);
        _session.set_dirty();
 }
 
@@ -404,16 +407,15 @@ Amp::set_state (const XMLNode& node, int 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)
 {
-       // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
-       if (val > 1.99526231f) {
-               val = 1.99526231f;
+       if (val > max_gain_coefficient) {
+               val = max_gain_coefficient;
        }
 
        _amp->set_gain (val, this);
@@ -422,19 +424,36 @@ Amp::GainControl::set_value (double val)
 }
 
 double
-Amp::GainControl::get_value (void) const
+Amp::GainControl::internal_to_interface (double v) const
 {
-       return AutomationControl::get_value();
+       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()) {
+               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);
        } else {
                _apply_gain_automation = false;
        }
@@ -445,3 +464,26 @@ 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)
+{
+       _gain_automation_buffer = g;
+}