2 Copyright (C) 2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify it
5 under the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2 of the License, or (at your option)
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License along
15 with this program; if not, write to the Free Software Foundation, Inc.,
16 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include "evoral/Curve.hpp"
26 #include "ardour/amp.h"
27 #include "ardour/audio_buffer.h"
28 #include "ardour/buffer_set.h"
29 #include "ardour/midi_buffer.h"
30 #include "ardour/rc_configuration.h"
31 #include "ardour/session.h"
35 using namespace ARDOUR;
38 // used for low-pass filter denormal protection
39 #define GAIN_COEFF_TINY (1e-10) // -200dB
41 Amp::Amp (Session& s, std::string type)
44 , _apply_gain_automation(false)
45 , _current_gain(GAIN_COEFF_ZERO)
46 , _current_automation_frame (INT64_MAX)
47 , _gain_automation_buffer(0)
49 , _midi_amp (type != "trim")
51 Evoral::Parameter p (_type == "trim" ? TrimAutomation : GainAutomation);
52 boost::shared_ptr<AutomationList> gl (new AutomationList (p));
53 _gain_control = boost::shared_ptr<GainControl> (new GainControl ((_type == "trim") ? X_("trimcontrol") : X_("gaincontrol"), s, this, p, gl));
54 _gain_control->set_flags (Controllable::GainLike);
56 add_control(_gain_control);
60 Amp::display_name() const
66 Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out)
73 Amp::configure_io (ChanCount in, ChanCount out)
75 if (out != in) { // always 1:1
79 return Processor::configure_io (in, out);
83 Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
85 if (!_active && !_pending_active) {
91 if (_apply_gain_automation) {
93 gain_t* gab = _gain_automation_buffer;
97 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
99 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
100 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
101 if (ev.is_note_on()) {
102 assert(ev.time() >= 0 && ev.time() < nframes);
103 ev.scale_velocity (fabsf (gab[ev.time()]));
110 const double a = 156.825 / _session.nominal_frame_rate(); // 25 Hz LPF; see Amp::apply_gain for details
111 double lpf = _current_gain;
113 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
114 Sample* const sp = i->data();
116 for (pframes_t nx = 0; nx < nframes; ++nx) {
118 lpf += a * (gab[nx] - lpf);
122 if (fabs (lpf) < GAIN_COEFF_TINY) {
123 _current_gain = GAIN_COEFF_ZERO;
128 } else { /* manual (scalar) gain */
130 gain_t const dg = _gain_control->user_double();
132 if (_current_gain != dg) {
134 _current_gain = Amp::apply_gain (bufs, _session.nominal_frame_rate(), nframes, _current_gain, dg, _midi_amp);
136 } else if (_current_gain != GAIN_COEFF_UNITY) {
138 /* gain has not changed, but its non-unity */
141 /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
142 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
146 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
147 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
148 if (ev.is_note_on()) {
149 ev.scale_velocity (fabsf (_current_gain));
155 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
156 apply_gain_to_buffer (i->data(), nframes, _current_gain);
162 _active = _pending_active;
166 Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target, bool midi_amp)
168 /** Apply a (potentially) declicked gain to the buffers of @a bufs */
171 if (nframes == 0 || bufs.count().n_total() == 0) {
175 // if we don't need to declick, defer to apply_simple_gain
176 if (initial == target) {
177 apply_simple_gain (bufs, nframes, target);
183 /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
184 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
187 if (target < initial) {
188 /* fade out: remove more and more of delta from initial */
189 delta = -(initial - target);
191 /* fade in: add more and more of delta from initial */
192 delta = target - initial;
197 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
198 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
200 if (ev.is_note_on()) {
201 const gain_t scale = delta * (ev.time()/(double) nframes);
202 ev.scale_velocity (fabsf (initial+scale));
210 /* Low pass filter coefficient: 1.0 - e^(-2.0 * π * f / 48000) f in Hz.
211 * for f << SR, approx a ~= 6.2 * f / SR;
213 const double a = 156.825 / sample_rate; // 25 Hz LPF
215 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
216 Sample* const buffer = i->data();
217 double lpf = initial;
219 for (pframes_t nx = 0; nx < nframes; ++nx) {
221 lpf += a * (target - lpf);
223 if (i == bufs.audio_begin()) {
227 if (fabsf (rv - target) < GAIN_COEFF_TINY) return target;
228 if (fabsf (rv) < GAIN_COEFF_TINY) return GAIN_COEFF_ZERO;
233 Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
235 if (nframes == 0 || bufs.count().n_total() == 0) {
239 const framecnt_t declick = std::min ((framecnt_t) 512, nframes);
240 const double fractional_shift = 1.0 / declick ;
241 gain_t delta, initial;
244 /* fade out: remove more and more of delta from initial */
246 initial = GAIN_COEFF_UNITY;
248 /* fade in: add more and more of delta from initial */
250 initial = GAIN_COEFF_ZERO;
254 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
255 Sample* const buffer = i->data();
257 double fractional_pos = 0.0;
259 for (pframes_t nx = 0; nx < declick; ++nx) {
260 buffer[nx] *= initial + (delta * fractional_pos);
261 fractional_pos += fractional_shift;
264 /* now ensure the rest of the buffer has the target value applied, if necessary. */
265 if (declick != nframes) {
267 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
275 Amp::apply_gain (AudioBuffer& buf, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target)
277 /* Apply a (potentially) declicked gain to the contents of @a buf
278 * -- used by MonitorProcessor::run()
285 // if we don't need to declick, defer to apply_simple_gain
286 if (initial == target) {
287 apply_simple_gain (buf, nframes, target);
291 Sample* const buffer = buf.data();
292 const double a = 156.825 / sample_rate; // 25 Hz LPF, see [other] Amp::apply_gain() above for details
294 double lpf = initial;
295 for (pframes_t nx = 0; nx < nframes; ++nx) {
297 lpf += a * (target - lpf);
300 if (fabs (lpf - target) < GAIN_COEFF_TINY) return target;
301 if (fabs (lpf) < GAIN_COEFF_TINY) return GAIN_COEFF_ZERO;
306 Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool midi_amp)
308 if (fabsf (target) < GAIN_COEFF_SMALL) {
311 /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
312 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
315 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
316 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
317 if (ev.is_note_on()) {
324 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
325 memset (i->data(), 0, sizeof (Sample) * nframes);
328 } else if (target != GAIN_COEFF_UNITY) {
331 /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
332 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
335 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
336 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
337 if (ev.is_note_on()) {
338 ev.scale_velocity (fabsf (target));
344 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
345 apply_gain_to_buffer (i->data(), nframes, target);
351 Amp::apply_simple_gain (AudioBuffer& buf, framecnt_t nframes, gain_t target)
353 if (fabsf (target) < GAIN_COEFF_SMALL) {
354 memset (buf.data(), 0, sizeof (Sample) * nframes);
355 } else if (target != GAIN_COEFF_UNITY) {
356 apply_gain_to_buffer (buf.data(), nframes, target);
361 Amp::inc_gain (gain_t factor, void *src)
363 float desired_gain = _gain_control->user_double();
365 if (fabsf (desired_gain) < GAIN_COEFF_SMALL) {
366 // really?! what's the idea here?
367 set_gain (0.000001f + (0.000001f * factor), src);
369 set_gain (desired_gain + (desired_gain * factor), src);
374 Amp::set_gain (gain_t val, void *)
376 _gain_control->set_value (val);
380 Amp::state (bool full_state)
382 XMLNode& node (Processor::state (full_state));
383 node.add_property("type", _type);
384 node.add_child_nocopy (_gain_control->get_state());
390 Amp::set_state (const XMLNode& node, int version)
394 Processor::set_state (node, version);
396 if ((gain_node = node.child (Controllable::xml_node_name.c_str())) != 0) {
397 _gain_control->set_state (*gain_node, version);
404 Amp::GainControl::set_value (double val)
406 AutomationControl::set_value (std::max (std::min (val, (double)_desc.upper), (double)_desc.lower));
407 _amp->session().set_dirty ();
411 Amp::GainControl::internal_to_interface (double v) const
413 if (_desc.type == GainAutomation) {
414 return gain_to_slider_position (v);
416 return (accurate_coefficient_to_dB (v) - lower_db) / range_db;
421 Amp::GainControl::interface_to_internal (double v) const
423 if (_desc.type == GainAutomation) {
424 return slider_position_to_gain (v);
426 return dB_to_coefficient (lower_db + v * range_db);
431 Amp::GainControl::internal_to_user (double v) const
433 return accurate_coefficient_to_dB (v);
437 Amp::GainControl::user_to_internal (double u) const
439 return dB_to_coefficient (u);
443 Amp::GainControl::get_user_string () const
445 char theBuf[32]; sprintf( theBuf, _("%3.1f dB"), accurate_coefficient_to_dB (get_value()));
446 return std::string(theBuf);
449 /** Write gain automation for this cycle into the buffer previously passed in to
450 * set_gain_automation_buffer (if we are in automation playback mode and the
451 * transport is rolling).
454 Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes)
456 Glib::Threads::Mutex::Lock am (control_lock(), Glib::Threads::TRY_LOCK);
459 && (_session.transport_rolling() || _session.bounce_processing())
460 && _gain_control->automation_playback())
462 assert (_gain_automation_buffer);
463 _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
464 start_frame, end_frame, _gain_automation_buffer, nframes);
465 if (start_frame != _current_automation_frame) {
466 _current_gain = _gain_automation_buffer[0];
468 _current_automation_frame = end_frame;
470 _apply_gain_automation = false;
471 _current_automation_frame = INT64_MAX;
482 Amp::value_as_string (boost::shared_ptr<AutomationControl> ac) const
484 if (ac == _gain_control) {
486 snprintf (buffer, sizeof (buffer), _("%.2fdB"), ac->internal_to_user (ac->get_value ()));
490 return Automatable::value_as_string (ac);
493 /** Sets up the buffer that setup_gain_automation and ::run will use for
494 * gain automationc curves. Must be called before setup_gain_automation,
495 * and must be called with process lock held.
499 Amp::set_gain_automation_buffer (gain_t* g)
501 _gain_automation_buffer = g;