libs/ardour/amp.cc

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3
   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)
   7     any later version.
   8
   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
  12     for more details.
  13
  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.
  17 */
  18
  19 #include <cstring>
  20 #include <cmath>
  21 #include <algorithm>
  22
  23 #include "evoral/Curve.hpp"
  24
  25 #include "ardour/amp.h"
  26 #include "ardour/audio_buffer.h"
  27 #include "ardour/buffer_set.h"
  28 #include "ardour/gain_control.h"
  29 #include "ardour/midi_buffer.h"
  30 #include "ardour/rc_configuration.h"
  31 #include "ardour/session.h"
  32
  33 #include "pbd/i18n.h"
  34
  35 using namespace ARDOUR;
  36 using namespace PBD;
  37
  38 // used for low-pass filter denormal protection
  39 #define GAIN_COEFF_TINY (1e-10) // -200dB
  40
  41 Amp::Amp (Session& s, const std::string& name, boost::shared_ptr<GainControl> gc, bool control_midi_also)
  42         : Processor(s, "Amp")
  43         , _apply_gain(true)
  44         , _apply_gain_automation(false)
  45         , _current_gain(GAIN_COEFF_ZERO)
  46         , _current_automation_frame (INT64_MAX)
  47         , _gain_control (gc)
  48         , _gain_automation_buffer(0)
  49         , _midi_amp (control_midi_also)
  50 {
  51         set_display_name (name);
  52         add_control (_gain_control);
  53 }
  54
  55 bool
  56 Amp::can_support_io_configuration (const ChanCount& in, ChanCount& out)
  57 {
  58         out = in;
  59         return true;
  60 }
  61
  62 bool
  63 Amp::configure_io (ChanCount in, ChanCount out)
  64 {
  65         if (out != in) { // always 1:1
  66                 return false;
  67         }
  68
  69         return Processor::configure_io (in, out);
  70 }
  71
  72 static void
  73 scale_midi_velocity(Evoral::Event<MidiBuffer::TimeType>& ev, float factor)
  74 {
  75         factor = std::max(factor, 0.0f);
  76         ev.set_velocity(std::min(127L, lrintf(ev.velocity() * factor)));
  77 }
  78
  79 void
  80 Amp::run (BufferSet& bufs, framepos_t /*start_frame*/, framepos_t /*end_frame*/, double /*speed*/, pframes_t nframes, bool)
  81 {
  82         if (!_active && !_pending_active) {
  83                 return;
  84         }
  85
  86         if (_apply_gain) {
  87
  88                 if (_apply_gain_automation) {
  89
  90                         gain_t* gab = _gain_automation_buffer;
  91                         assert (gab);
  92
  93                         if (_midi_amp) {
  94                                 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
  95                                         MidiBuffer& mb (*i);
  96                                         for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
  97                                                 Evoral::Event<MidiBuffer::TimeType> ev = *m;
  98                                                 if (ev.is_note_on()) {
  99                                                         assert(ev.time() >= 0 && ev.time() < nframes);
 100                                                         scale_midi_velocity (ev, fabsf (gab[ev.time()]));
 101                                                 }
 102                                         }
 103                                 }
 104                         }
 105
 106
 107                         const double a = 156.825 / _session.nominal_frame_rate(); // 25 Hz LPF; see Amp::apply_gain for details
 108                         double lpf = _current_gain;
 109
 110                         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 111                                 Sample* const sp = i->data();
 112                                 lpf = _current_gain;
 113                                 for (pframes_t nx = 0; nx < nframes; ++nx) {
 114                                         sp[nx] *= lpf;
 115                                         lpf += a * (gab[nx] - lpf);
 116                                 }
 117                         }
 118
 119                         if (fabs (lpf) < GAIN_COEFF_TINY) {
 120                                 _current_gain = GAIN_COEFF_ZERO;
 121                         } else {
 122                                 _current_gain = lpf;
 123                         }
 124
 125                 } else { /* manual (scalar) gain */
 126
 127                         gain_t const dg = _gain_control->get_value();
 128
 129                         if (_current_gain != dg) {
 130
 131                                 _current_gain = Amp::apply_gain (bufs, _session.nominal_frame_rate(), nframes, _current_gain, dg, _midi_amp);
 132
 133                         } else if (_current_gain != GAIN_COEFF_UNITY) {
 134
 135                                 /* gain has not changed, but its non-unity */
 136
 137                                 if (_midi_amp) {
 138                                         /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
 139                                         for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
 140
 141                                                 MidiBuffer& mb (*i);
 142
 143                                                 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
 144                                                         Evoral::Event<MidiBuffer::TimeType> ev = *m;
 145                                                         if (ev.is_note_on()) {
 146                                                                 scale_midi_velocity (ev, fabsf (_current_gain));
 147                                                         }
 148                                                 }
 149                                         }
 150                                 }
 151
 152                                 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 153                                         apply_gain_to_buffer (i->data(), nframes, _current_gain);
 154                                 }
 155                         }
 156                 }
 157         }
 158
 159         _active = _pending_active;
 160 }
 161
 162 gain_t
 163 Amp::apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target, bool midi_amp)
 164 {
 165         /** Apply a (potentially) declicked gain to the buffers of @a bufs */
 166         gain_t rv = target;
 167
 168         if (nframes == 0 || bufs.count().n_total() == 0) {
 169                 return initial;
 170         }
 171
 172         // if we don't need to declick, defer to apply_simple_gain
 173         if (initial == target) {
 174                 apply_simple_gain (bufs, nframes, target);
 175                 return target;
 176         }
 177
 178         /* MIDI Gain */
 179         if (midi_amp) {
 180                 /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
 181                 for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
 182
 183                         gain_t  delta;
 184                         if (target < initial) {
 185                                 /* fade out: remove more and more of delta from initial */
 186                                 delta = -(initial - target);
 187                         } else {
 188                                 /* fade in: add more and more of delta from initial */
 189                                 delta = target - initial;
 190                         }
 191
 192                         MidiBuffer& mb (*i);
 193
 194                         for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
 195                                 Evoral::Event<MidiBuffer::TimeType> ev = *m;
 196
 197                                 if (ev.is_note_on()) {
 198                                         const gain_t scale = delta * (ev.time()/(double) nframes);
 199                                         scale_midi_velocity (ev, fabsf (initial + scale));
 200                                 }
 201                         }
 202                 }
 203         }
 204
 205         /* Audio Gain */
 206
 207         /* Low pass filter coefficient: 1.0 - e^(-2.0 * π * f / 48000) f in Hz.
 208          * for f << SR,  approx a ~= 6.2 * f / SR;
 209          */
 210         const double a = 156.825 / sample_rate; // 25 Hz LPF
 211
 212         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 213                 Sample* const buffer = i->data();
 214                 double lpf = initial;
 215
 216                 for (pframes_t nx = 0; nx < nframes; ++nx) {
 217                         buffer[nx] *= lpf;
 218                         lpf += a * (target - lpf);
 219                 }
 220                 if (i == bufs.audio_begin()) {
 221                         rv = lpf;
 222                 }
 223         }
 224         if (fabsf (rv - target) < GAIN_COEFF_TINY) return target;
 225         if (fabsf (rv) < GAIN_COEFF_TINY) return GAIN_COEFF_ZERO;
 226         return rv;
 227 }
 228
 229 void
 230 Amp::declick (BufferSet& bufs, framecnt_t nframes, int dir)
 231 {
 232         if (nframes == 0 || bufs.count().n_total() == 0) {
 233                 return;
 234         }
 235
 236         const framecnt_t declick = std::min ((framecnt_t) 512, nframes);
 237         const double     fractional_shift = 1.0 / declick ;
 238         gain_t           delta, initial;
 239
 240         if (dir < 0) {
 241                 /* fade out: remove more and more of delta from initial */
 242                 delta = -1.0;
 243                 initial = GAIN_COEFF_UNITY;
 244         } else {
 245                 /* fade in: add more and more of delta from initial */
 246                 delta = 1.0;
 247                 initial = GAIN_COEFF_ZERO;
 248         }
 249
 250         /* Audio Gain */
 251         for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 252                 Sample* const buffer = i->data();
 253
 254                 double fractional_pos = 0.0;
 255
 256                 for (pframes_t nx = 0; nx < declick; ++nx) {
 257                         buffer[nx] *= initial + (delta * fractional_pos);
 258                         fractional_pos += fractional_shift;
 259                 }
 260
 261                 /* now ensure the rest of the buffer has the target value applied, if necessary. */
 262                 if (declick != nframes) {
 263                         if (dir < 0) {
 264                                 memset (&buffer[declick], 0, sizeof (Sample) * (nframes - declick));
 265                         }
 266                 }
 267         }
 268 }
 269
 270
 271 gain_t
 272 Amp::apply_gain (AudioBuffer& buf, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target)
 273 {
 274         /* Apply a (potentially) declicked gain to the contents of @a buf
 275          * -- used by MonitorProcessor::run()
 276          */
 277
 278         if (nframes == 0) {
 279                 return initial;
 280         }
 281
 282         // if we don't need to declick, defer to apply_simple_gain
 283         if (initial == target) {
 284                 apply_simple_gain (buf, nframes, target);
 285                 return target;
 286         }
 287
 288         Sample* const buffer = buf.data();
 289         const double a = 156.825 / sample_rate; // 25 Hz LPF, see [other] Amp::apply_gain() above for details
 290
 291         double lpf = initial;
 292         for (pframes_t nx = 0; nx < nframes; ++nx) {
 293                 buffer[nx] *= lpf;
 294                 lpf += a * (target - lpf);
 295         }
 296
 297         if (fabs (lpf - target) < GAIN_COEFF_TINY) return target;
 298         if (fabs (lpf) < GAIN_COEFF_TINY) return GAIN_COEFF_ZERO;
 299         return lpf;
 300 }
 301
 302 void
 303 Amp::apply_simple_gain (BufferSet& bufs, framecnt_t nframes, gain_t target, bool midi_amp)
 304 {
 305         if (fabsf (target) < GAIN_COEFF_SMALL) {
 306
 307                 if (midi_amp) {
 308                         /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
 309                         for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
 310                                 MidiBuffer& mb (*i);
 311
 312                                 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
 313                                         Evoral::Event<MidiBuffer::TimeType> ev = *m;
 314                                         if (ev.is_note_on()) {
 315                                                 ev.set_velocity (0);
 316                                         }
 317                                 }
 318                         }
 319                 }
 320
 321                 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 322                         memset (i->data(), 0, sizeof (Sample) * nframes);
 323                 }
 324
 325         } else if (target != GAIN_COEFF_UNITY) {
 326
 327                 if (midi_amp) {
 328                         /* don't Trim midi velocity -- only relevant for Midi on Audio tracks */
 329                         for (BufferSet::midi_iterator i = bufs.midi_begin(); i != bufs.midi_end(); ++i) {
 330                                 MidiBuffer& mb (*i);
 331
 332                                 for (MidiBuffer::iterator m = mb.begin(); m != mb.end(); ++m) {
 333                                         Evoral::Event<MidiBuffer::TimeType> ev = *m;
 334                                         if (ev.is_note_on()) {
 335                                                 scale_midi_velocity(ev, fabsf (target));
 336                                         }
 337                                 }
 338                         }
 339                 }
 340
 341                 for (BufferSet::audio_iterator i = bufs.audio_begin(); i != bufs.audio_end(); ++i) {
 342                         apply_gain_to_buffer (i->data(), nframes, target);
 343                 }
 344         }
 345 }
 346
 347 void
 348 Amp::apply_simple_gain (AudioBuffer& buf, framecnt_t nframes, gain_t target)
 349 {
 350         if (fabsf (target) < GAIN_COEFF_SMALL) {
 351                 memset (buf.data(), 0, sizeof (Sample) * nframes);
 352         } else if (target != GAIN_COEFF_UNITY) {
 353                 apply_gain_to_buffer (buf.data(), nframes, target);
 354         }
 355 }
 356
 357 XMLNode&
 358 Amp::state (bool full_state)
 359 {
 360         XMLNode& node (Processor::state (full_state));
 361         node.set_property("type", _gain_control->parameter().type() == GainAutomation ? "amp" : "trim");
 362         node.add_child_nocopy (_gain_control->get_state());
 363
 364         return node;
 365 }
 366
 367 int
 368 Amp::set_state (const XMLNode& node, int version)
 369 {
 370         XMLNode* gain_node;
 371
 372         Processor::set_state (node, version);
 373
 374         if ((gain_node = node.child (Controllable::xml_node_name.c_str ())) != 0) {
 375                 _gain_control->set_state (*gain_node, version);
 376         }
 377
 378         return 0;
 379 }
 380
 381 /** Write gain automation for this cycle into the buffer previously passed in to
 382  *  set_gain_automation_buffer (if we are in automation playback mode and the
 383  *  transport is rolling).
 384  */
 385 void
 386 Amp::setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes)
 387 {
 388         Glib::Threads::Mutex::Lock am (control_lock(), Glib::Threads::TRY_LOCK);
 389
 390         if (am.locked()
 391             && (_session.transport_rolling() || _session.bounce_processing())
 392             && _gain_control->automation_playback())
 393         {
 394                 assert (_gain_automation_buffer);
 395                 _apply_gain_automation = _gain_control->list()->curve().rt_safe_get_vector (
 396                         start_frame, end_frame, _gain_automation_buffer, nframes);
 397
 398                 /* XXX the future requires a way to automate the control master
 399                  * and merge its own automation vector/curve with this one. We
 400                  * don't have a way to do that just yet, so for now, just get
 401                  * the master's current gain and scale our own automation
 402                  * vector/curve by this value.
 403                  */
 404
 405                 if (_gain_control->slaved()) {
 406                         const double master_gain = _gain_control->get_masters_value ();
 407                         if (master_gain != 1.0) {
 408                                 apply_gain_to_buffer (_gain_automation_buffer, nframes, master_gain);
 409                         }
 410                 }
 411
 412                 if (start_frame != _current_automation_frame && _session.bounce_processing ()) {
 413                         _current_gain = _gain_automation_buffer[0];
 414                 }
 415                 _current_automation_frame = end_frame;
 416         } else {
 417                 _apply_gain_automation = false;
 418                 _current_automation_frame = INT64_MAX;
 419         }
 420 }
 421
 422 bool
 423 Amp::visible() const
 424 {
 425         return true;
 426 }
 427
 428 std::string
 429 Amp::value_as_string (boost::shared_ptr<const AutomationControl> ac) const
 430 {
 431         if (ac == _gain_control) {
 432                 char buffer[32];
 433                 snprintf (buffer, sizeof (buffer), _("%.2fdB"), ac->internal_to_user (ac->get_value ()));
 434                 return buffer;
 435         }
 436
 437         return Automatable::value_as_string (ac);
 438 }
 439
 440 /** Sets up the buffer that setup_gain_automation and ::run will use for
 441  *  gain automationc curves.  Must be called before setup_gain_automation,
 442  *  and must be called with process lock held.
 443  */
 444
 445 void
 446 Amp::set_gain_automation_buffer (gain_t* g)
 447 {
 448         _gain_automation_buffer = g;
 449 }