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/configuration.h"
30 #include "ardour/io.h"
31 #include "ardour/midi_buffer.h"
32 #include "ardour/session.h"
36 using namespace ARDOUR;
42 , _apply_gain_automation(false)
45 Evoral::Parameter p (GainAutomation);
46 /* gain range of -inf to +6dB, default 0dB */
47 p.set_range (0, 1.99526231f, 1, false);
48 boost::shared_ptr<AutomationList> gl (new AutomationList (p));
49 _gain_control = boost::shared_ptr<GainControl> (new GainControl (X_("gaincontrol"), s, this, p, gl));
50 add_control(_gain_control);
54 Amp::display_name() const
60 Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
67 Amp::configure_io (ChanCount in, ChanCount out)
69 if (out != in) { // always 1:1
73 return Processor::configure_io (in, out);
77 Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
79 if (!_active && !_pending_active) {
85 if (_apply_gain_automation) {
87 gain_t* gab = _session.gain_automation_buffer ();
89 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
90 Sample* const sp = i->data();
91 for (pframes_t nx = 0; nx < nframes; ++nx) {
96 _current_gain = gab[nframes-1];
98 } else { /* manual (scalar) gain */
100 gain_t const dg = _gain_control->user_double();
102 if (_current_gain != dg) {
104 Amp::apply_gain (bufs, nframes, _current_gain, dg);
107 } else if (_current_gain != 1.0f) {
109 /* gain has not changed, but its non-unity
112 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
116 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
117 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
118 if (ev.is_note_on()) {
119 ev.scale_velocity (_current_gain);
124 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
125 apply_gain_to_buffer (i->data(), nframes, _current_gain);
131 _active = _pending_active;
135 Amp::apply_gain (BufferSet& bufs, framecnt_t nframes, gain_t initial, gain_t target)
137 /** Apply a (potentially) declicked gain to the buffers of @a bufs
140 if (nframes == 0 || bufs.count().n_total() == 0) {
144 // if we don't need to declick, defer to apply_simple_gain
145 if (initial == target) {
146 apply_simple_gain (bufs, nframes, target);
150 const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
152 double fractional_shift = -1.0/declick;
153 double fractional_pos;
155 if (target < initial) {
156 /* fade out: remove more and more of delta from initial */
157 delta = -(initial - target);
159 /* fade in: add more and more of delta from initial */
160 delta = target - initial;
165 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
169 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
170 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
172 if (ev.is_note_on()) {
173 gain_t scale = delta * (ev.time()/(double) nframes);
174 ev.scale_velocity (initial+scale);
181 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
182 Sample* const buffer = i->data();
184 fractional_pos = 1.0;
186 for (pframes_t nx = 0; nx < declick; ++nx) {
187 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
188 fractional_pos += fractional_shift;
191 /* now ensure the rest of the buffer has the target value applied, if necessary. */
193 if (declick != nframes) {
196 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
197 } else if (target != 1.0) {
198 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
205 Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
207 /* Almost exactly like ::apply_gain() but skips MIDI buffers and has fixed initial+target
211 if (nframes == 0 || bufs.count().n_total() == 0) {
215 const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
216 gain_t delta, initial, target;
217 double fractional_shift = -1.0/(declick-1);
218 double fractional_pos;
221 /* fade out: remove more and more of delta from initial */
226 /* fade in: add more and more of delta from initial */
234 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
235 Sample* const buffer = i->data();
237 fractional_pos = 1.0;
239 for (pframes_t nx = 0; nx < declick; ++nx) {
240 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
241 fractional_pos += fractional_shift;
244 /* now ensure the rest of the buffer has the target value applied, if necessary. */
246 if (declick != nframes) {
249 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
250 } else if (target != 1.0) {
251 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
258 Amp::apply_gain (AudioBuffer& buf, framecnt_t nframes, gain_t initial, gain_t target)
260 /** Apply a (potentially) declicked gain to the contents of @a buf
267 // if we don't need to declick, defer to apply_simple_gain
268 if (initial == target) {
269 apply_simple_gain (buf, nframes, target);
273 const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
275 double fractional_shift = -1.0/declick;
276 double fractional_pos;
278 if (target < initial) {
279 /* fade out: remove more and more of delta from initial */
280 delta = -(initial - target);
282 /* fade in: add more and more of delta from initial */
283 delta = target - initial;
287 Sample* const buffer = buf.data();
289 fractional_pos = 1.0;
291 for (pframes_t nx = 0; nx < declick; ++nx) {
292 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
293 fractional_pos += fractional_shift;
296 /* now ensure the rest of the buffer has the target value applied, if necessary. */
298 if (declick != nframes) {
301 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
302 } else if (target != 1.0) {
303 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
309 Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target)
313 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
316 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
317 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
318 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 != 1.0) {
330 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
333 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
334 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
335 if (ev.is_note_on()) {
336 ev.scale_velocity (target);
341 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
342 apply_gain_to_buffer (i->data(), nframes, target);
348 Amp::apply_simple_gain (AudioBuffer& buf, framecnt_t nframes, gain_t target)
351 memset (buf.data(), 0, sizeof (Sample) * nframes);
352 } else if (target != 1.0) {
353 apply_gain_to_buffer (buf.data(), nframes, target);
358 Amp::inc_gain (gain_t factor, void *src)
360 float desired_gain = _gain_control->user_double();
362 if (desired_gain == 0.0f) {
363 set_gain (0.000001f + (0.000001f * factor), src);
365 set_gain (desired_gain + (desired_gain * factor), src);
370 Amp::set_gain (gain_t val, void *src)
372 // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
373 if (val > 1.99526231f) {
377 if (src != _gain_control.get()) {
378 _gain_control->set_value (val);
379 // bit twisty, this will come back and call us again
380 // (this keeps control in sync with reality)
384 _gain_control->set_double(val, false);
385 _session.set_dirty();
389 Amp::state (bool full_state)
391 XMLNode& node (Processor::state (full_state));
392 node.add_property("type", "amp");
393 node.add_child_nocopy (_gain_control->get_state());
399 Amp::set_state (const XMLNode& node, int version)
403 Processor::set_state (node, version);
405 if ((gain_node = node.child (Controllable::xml_node_name.c_str())) != 0) {
406 _gain_control->set_state (*gain_node, version);
413 Amp::GainControl::set_value (double val)
415 // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
416 if (val > 1.99526231) {
420 _amp->set_gain (val, this);
422 AutomationControl::set_value(val);
426 Amp::GainControl::internal_to_interface (double v) const
428 return gain_to_slider_position (v);
432 Amp::GainControl::interface_to_internal (double v) const
434 return slider_position_to_gain (v);
438 Amp::GainControl::internal_to_user (double v) const
440 return accurate_coefficient_to_dB (v);
444 Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes)
446 Glib::Mutex::Lock am (control_lock(), Glib::TRY_LOCK);
448 if (am.locked() && _session.transport_rolling() && _gain_control->automation_playback()) {
449 _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
450 start_frame, end_frame, _session.gain_automation_buffer(), nframes);
452 _apply_gain_automation = false;
463 Amp::value_as_string (boost::shared_ptr<AutomationControl> ac) const
465 if (ac == _gain_control) {
467 snprintf (buffer, sizeof (buffer), "%.2fdB", ac->internal_to_user (ac->get_value ()));
471 return Automatable::value_as_string (ac);