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;
41 , _apply_gain_automation(false)
44 boost::shared_ptr<AutomationList> gl(new AutomationList(Evoral::Parameter(GainAutomation)));
45 _gain_control = boost::shared_ptr<GainControl>( new GainControl(X_("gaincontrol"), s, this, Evoral::Parameter(GainAutomation), gl ));
46 add_control(_gain_control);
50 Amp::display_name() const
56 Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
63 Amp::configure_io (ChanCount in, ChanCount out)
65 if (out != in) { // always 1:1
69 return Processor::configure_io (in, out);
73 Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, nframes_t nframes, bool)
75 if (!_active && !_pending_active) {
81 if (_apply_gain_automation) {
83 gain_t* gab = _session.gain_automation_buffer ();
85 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
86 Sample* const sp = i->data();
87 for (nframes_t nx = 0; nx < nframes; ++nx) {
92 _current_gain = gab[nframes-1];
94 } else { /* manual (scalar) gain */
96 gain_t const dg = _gain_control->user_double();
98 if (_current_gain != dg) {
100 Amp::apply_gain (bufs, nframes, _current_gain, dg);
103 } else if (_current_gain != 1.0f) {
105 /* gain has not changed, but its non-unity
108 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
112 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
113 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
114 if (ev.is_note_on()) {
115 ev.scale_velocity (_current_gain);
120 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
121 apply_gain_to_buffer (i->data(), nframes, _current_gain);
127 _active = _pending_active;
131 Amp::apply_gain (BufferSet& bufs, nframes_t nframes, gain_t initial, gain_t target)
133 /** Apply a (potentially) declicked gain to the buffers of @a bufs
136 if (nframes == 0 || bufs.count().n_total() == 0) {
140 // if we don't need to declick, defer to apply_simple_gain
141 if (initial == target) {
142 apply_simple_gain (bufs, nframes, target);
146 const nframes_t declick = std::min ((nframes_t)128, nframes);
148 double fractional_shift = -1.0/declick;
149 double fractional_pos;
151 if (target < initial) {
152 /* fade out: remove more and more of delta from initial */
153 delta = -(initial - target);
155 /* fade in: add more and more of delta from initial */
156 delta = target - initial;
161 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
165 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
166 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
168 if (ev.is_note_on()) {
169 gain_t scale = delta * (ev.time()/(double) nframes);
170 ev.scale_velocity (initial+scale);
177 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
178 Sample* const buffer = i->data();
180 fractional_pos = 1.0;
182 for (nframes_t nx = 0; nx < declick; ++nx) {
183 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
184 fractional_pos += fractional_shift;
187 /* now ensure the rest of the buffer has the target value applied, if necessary. */
189 if (declick != nframes) {
192 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
193 } else if (target != 1.0) {
194 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
201 Amp::declick (BufferSet& bufs, nframes_t nframes, int dir)
203 /* Almost exactly like ::apply_gain() but skips MIDI buffers and has fixed initial+target
207 if (nframes == 0 || bufs.count().n_total() == 0) {
211 const nframes_t declick = std::min ((nframes_t)128, nframes);
212 gain_t delta, initial, target;
213 double fractional_shift = -1.0/declick;
214 double fractional_pos;
217 /* fade out: remove more and more of delta from initial */
222 /* fade in: add more and more of delta from initial */
230 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
231 Sample* const buffer = i->data();
233 fractional_pos = 1.0;
235 for (nframes_t nx = 0; nx < declick; ++nx) {
236 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
237 fractional_pos += fractional_shift;
240 /* now ensure the rest of the buffer has the target value applied, if necessary. */
242 if (declick != nframes) {
245 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
246 } else if (target != 1.0) {
247 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
254 Amp::apply_gain (AudioBuffer& buf, nframes_t nframes, gain_t initial, gain_t target)
256 /** Apply a (potentially) declicked gain to the contents of @a buf
263 // if we don't need to declick, defer to apply_simple_gain
264 if (initial == target) {
265 apply_simple_gain (buf, nframes, target);
269 const nframes_t declick = std::min ((nframes_t)128, nframes);
271 double fractional_shift = -1.0/declick;
272 double fractional_pos;
274 if (target < initial) {
275 /* fade out: remove more and more of delta from initial */
276 delta = -(initial - target);
278 /* fade in: add more and more of delta from initial */
279 delta = target - initial;
283 Sample* const buffer = buf.data();
285 fractional_pos = 1.0;
287 for (nframes_t nx = 0; nx < declick; ++nx) {
288 buffer[nx] *= (initial + (delta * (0.5 + 0.5 * cos (M_PI * fractional_pos))));
289 fractional_pos += fractional_shift;
292 /* now ensure the rest of the buffer has the target value applied, if necessary. */
294 if (declick != nframes) {
297 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
298 } else if (target != 1.0) {
299 apply_gain_to_buffer (&buffer[declick], nframes - declick, target);
305 Amp::apply_simple_gain (BufferSet& bufs, nframes_t nframes, gain_t target)
309 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
312 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
313 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
314 if (ev.is_note_on()) {
320 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
321 memset (i->data(), 0, sizeof (Sample) * nframes);
324 } else if (target != 1.0) {
326 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
329 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
330 Evoral::MIDIEvent<MidiBuffer::TimeType> ev = *m;
331 if (ev.is_note_on()) {
332 ev.scale_velocity (target);
337 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
338 apply_gain_to_buffer (i->data(), nframes, target);
344 Amp::apply_simple_gain (AudioBuffer& buf, nframes_t nframes, gain_t target)
347 memset (buf.data(), 0, sizeof (Sample) * nframes);
348 } else if (target != 1.0) {
349 apply_gain_to_buffer (buf.data(), nframes, target);
354 Amp::inc_gain (gain_t factor, void *src)
356 float desired_gain = _gain_control->user_double();
358 if (desired_gain == 0.0f) {
359 set_gain (0.000001f + (0.000001f * factor), src);
361 set_gain (desired_gain + (desired_gain * factor), src);
366 Amp::set_gain (gain_t val, void *src)
368 // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
369 if (val > 1.99526231f) {
373 //cerr << "set desired gain to " << val << " when curgain = " << _gain_control->get_value () << endl;
375 if (src != _gain_control.get()) {
376 _gain_control->set_value (val);
377 // bit twisty, this will come back and call us again
378 // (this keeps control in sync with reality)
382 _gain_control->set_double(val, false);
383 _session.set_dirty();
387 Amp::state (bool full_state)
389 XMLNode& node (Processor::state (full_state));
390 node.add_property("type", "amp");
393 snprintf (buf, sizeof (buf), "%2.12f", _gain_control->get_value());
394 node.add_property("gain", buf);
400 Amp::set_state (const XMLNode& node, int version)
402 const XMLProperty* prop;
404 Processor::set_state (node, version);
405 prop = node.property ("gain");
410 if (sscanf (prop->value().c_str(), "%f", &val) == 1) {
411 _gain_control->set_value (val);
419 Amp::GainControl::set_value (double val)
421 // max gain at about +6dB (10.0 ^ ( 6 dB * 0.05))
422 if (val > 1.99526231f)
425 _amp->set_gain (val, this);
427 AutomationControl::set_value(val);
431 Amp::GainControl::get_value (void) const
433 return AutomationControl::get_value();
437 Amp::setup_gain_automation (sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
439 Glib::Mutex::Lock am (control_lock(), Glib::TRY_LOCK);
441 if (am.locked() && _session.transport_rolling() && _gain_control->automation_playback()) {
442 _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
443 start_frame, end_frame, _session.gain_automation_buffer(), nframes);
445 _apply_gain_automation = false;