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 _gain_control->set_flags (Controllable::GainLike);
52 add_control(_gain_control);
56 Amp::display_name() const
62 Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
69 Amp::configure_io (ChanCount in, ChanCount out)
71 if (out != in) { // always 1:1
75 return Processor::configure_io (in, out);
79 Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, pframes_t nframes, bool)
81 if (!_active && !_pending_active) {
87 if (_apply_gain_automation) {
89 gain_t* gab = _session.gain_automation_buffer ();
91 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
92 Sample* const sp = i->data();
93 for (pframes_t nx = 0; nx < nframes; ++nx) {
98 _current_gain = gab[nframes-1];
100 } else { /* manual (scalar) gain */
102 gain_t const dg = _gain_control->user_double();
104 if (_current_gain != dg) {
106 Amp::apply_gain (bufs, nframes, _current_gain, dg);
109 } else if (_current_gain != 1.0f) {
111 /* gain has not changed, but its non-unity
114 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
118 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
119 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
120 if (ev.is_note_on()) {
121 ev.scale_velocity (_current_gain);
126 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
127 apply_gain_to_buffer (i->data(), nframes, _current_gain);
133 _active = _pending_active;
137 Amp::apply_gain (BufferSet& bufs, framecnt_t nframes, gain_t initial, gain_t target)
139 /** Apply a (potentially) declicked gain to the buffers of @a bufs
142 if (nframes == 0 || bufs.count().n_total() == 0) {
146 // if we don't need to declick, defer to apply_simple_gain
147 if (initial == target) {
148 apply_simple_gain (bufs, nframes, target);
152 const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
154 double fractional_shift = -1.0/declick;
155 double fractional_pos;
157 if (target < initial) {
158 /* fade out: remove more and more of delta from initial */
159 delta = -(initial - target);
161 /* fade in: add more and more of delta from initial */
162 delta = target - initial;
167 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
171 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
172 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
174 if (ev.is_note_on()) {
175 gain_t scale = delta * (ev.time()/(double) nframes);
176 ev.scale_velocity (initial+scale);
183 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
184 Sample* const buffer = i->data();
186 fractional_pos = 1.0;
188 for (pframes_t nx = 0; nx < declick; ++nx) {
189 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
190 fractional_pos += fractional_shift;
193 /* now ensure the rest of the buffer has the target value applied, if necessary. */
195 if (declick != nframes) {
198 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
199 } else if (target != 1.0) {
200 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
207 Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
209 /* Almost exactly like ::apply_gain() but skips MIDI buffers and has fixed initial+target
213 if (nframes == 0 || bufs.count().n_total() == 0) {
217 const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
218 gain_t delta, initial, target;
219 double fractional_shift = -1.0/(declick-1);
220 double fractional_pos;
223 /* fade out: remove more and more of delta from initial */
228 /* fade in: add more and more of delta from initial */
236 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
237 Sample* const buffer = i->data();
239 fractional_pos = 1.0;
241 for (pframes_t nx = 0; nx < declick; ++nx) {
242 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
243 fractional_pos += fractional_shift;
246 /* now ensure the rest of the buffer has the target value applied, if necessary. */
248 if (declick != nframes) {
251 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
252 } else if (target != 1.0) {
253 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
260 Amp::apply_gain (AudioBuffer& buf, framecnt_t nframes, gain_t initial, gain_t target)
262 /** Apply a (potentially) declicked gain to the contents of @a buf
269 // if we don't need to declick, defer to apply_simple_gain
270 if (initial == target) {
271 apply_simple_gain (buf, nframes, target);
275 const framecnt_t declick = std::min ((framecnt_t) 128, nframes);
277 double fractional_shift = -1.0/declick;
278 double fractional_pos;
280 if (target < initial) {
281 /* fade out: remove more and more of delta from initial */
282 delta = -(initial - target);
284 /* fade in: add more and more of delta from initial */
285 delta = target - initial;
289 Sample* const buffer = buf.data();
291 fractional_pos = 1.0;
293 for (pframes_t nx = 0; nx < declick; ++nx) {
294 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
295 fractional_pos += fractional_shift;
298 /* now ensure the rest of the buffer has the target value applied, if necessary. */
300 if (declick != nframes) {
303 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
304 } else if (target != 1.0) {
305 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
311 Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target)
315 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
318 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
319 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
320 if (ev.is_note_on()) {
326 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
327 memset (i->data(), 0, sizeof (Sample) * nframes);
330 } else if (target != 1.0) {
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 (target);
343 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
344 apply_gain_to_buffer (i->data(), nframes, target);
350 Amp::apply_simple_gain (AudioBuffer& buf, framecnt_t nframes, gain_t target)
353 memset (buf.data(), 0, sizeof (Sample) * nframes);
354 } else if (target != 1.0) {
355 apply_gain_to_buffer (buf.data(), nframes, target);
360 Amp::inc_gain (gain_t factor, void *src)
362 float desired_gain = _gain_control->user_double();
364 if (desired_gain == 0.0f) {
365 set_gain (0.000001f + (0.000001f * factor), src);
367 set_gain (desired_gain + (desired_gain * factor), src);
372 Amp::set_gain (gain_t val, void *src)
374 // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
375 if (val > 1.99526231f) {
379 if (src != _gain_control.get()) {
380 _gain_control->set_value (val);
381 // bit twisty, this will come back and call us again
382 // (this keeps control in sync with reality)
386 _gain_control->set_double(val, false);
387 _session.set_dirty();
391 Amp::state (bool full_state)
393 XMLNode& node (Processor::state (full_state));
394 node.add_property("type", "amp");
395 node.add_child_nocopy (_gain_control->get_state());
401 Amp::set_state (const XMLNode& node, int version)
405 Processor::set_state (node, version);
407 if ((gain_node = node.child (Controllable::xml_node_name.c_str())) != 0) {
408 _gain_control->set_state (*gain_node, version);
415 Amp::GainControl::set_value (double val)
417 // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
418 if (val > 1.99526231) {
422 _amp->set_gain (val, this);
424 AutomationControl::set_value(val);
428 Amp::GainControl::internal_to_interface (double v) const
430 return gain_to_slider_position (v);
434 Amp::GainControl::interface_to_internal (double v) const
436 return slider_position_to_gain (v);
440 Amp::GainControl::internal_to_user (double v) const
442 return accurate_coefficient_to_dB (v);
446 Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes)
448 Glib::Mutex::Lock am (control_lock(), Glib::TRY_LOCK);
450 if (am.locked() && _session.transport_rolling() && _gain_control->automation_playback()) {
451 _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
452 start_frame, end_frame, _session.gain_automation_buffer(), nframes);
454 _apply_gain_automation = false;
465 Amp::value_as_string (boost::shared_ptr<AutomationControl> ac) const
467 if (ac == _gain_control) {
469 snprintf (buffer, sizeof (buffer), "%.2fdB", ac->internal_to_user (ac->get_value ()));
473 return Automatable::value_as_string (ac);