libs/ardour/ardour/amp.h

   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 #ifndef __ardour_amp_h__
  20 #define __ardour_amp_h__
  21
  22 #include "ardour/dB.h"
  23 #include "ardour/libardour_visibility.h"
  24 #include "ardour/types.h"
  25 #include "ardour/chan_count.h"
  26 #include "ardour/processor.h"
  27 #include "ardour/automation_control.h"
  28
  29 namespace ARDOUR {
  30
  31 class BufferSet;
  32 class IO;
  33
  34 /** Applies a declick operation to all audio inputs, passing the same number of
  35  * audio outputs, and passing through any other types unchanged.
  36  */
  37 class LIBARDOUR_API Amp : public Processor {
  38 public:
  39         Amp(Session& s, std::string type = "amp");
  40
  41         std::string display_name() const;
  42         std::string type() const { return _type;}
  43
  44         bool visible () const;
  45
  46         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  47         bool configure_io (ChanCount in, ChanCount out);
  48
  49         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  50
  51         bool apply_gain () const  { return _apply_gain; }
  52         void apply_gain (bool yn) { _apply_gain = yn; }
  53
  54         void set_gain_automation_buffer (gain_t *);
  55
  56         void setup_gain_automation (framepos_t start_frame, framepos_t end_frame, framecnt_t nframes);
  57
  58         bool apply_gain_automation() const  { return _apply_gain_automation; }
  59         void apply_gain_automation(bool yn) { _apply_gain_automation = yn; }
  60
  61         XMLNode& state (bool full);
  62         int set_state (const XMLNode&, int version);
  63
  64         static gain_t apply_gain (BufferSet& bufs, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target, bool midi_amp = true);
  65         static void apply_simple_gain(BufferSet& bufs, framecnt_t nframes, gain_t target, bool midi_amp = true);
  66
  67         static gain_t apply_gain (AudioBuffer& buf, framecnt_t sample_rate, framecnt_t nframes, gain_t initial, gain_t target);
  68         static void apply_simple_gain(AudioBuffer& buf, framecnt_t nframes, gain_t target);
  69
  70         static void declick (BufferSet& bufs, framecnt_t nframes, int dir);
  71
  72         gain_t         gain () const { return _gain_control->get_value(); }
  73
  74         void           set_gain (gain_t g, void *src);
  75         void           inc_gain (gain_t delta, void *src);
  76
  77         static void update_meters();
  78
  79         /* automation */
  80
  81         struct GainControl : public AutomationControl {
  82                 GainControl (std::string name, Session& session, Amp* a, const Evoral::Parameter &param,
  83                                 boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>() )
  84                         : AutomationControl (session, param, ParameterDescriptor(param), al, name)
  85                         , _amp (a) {
  86                         set_flags (Controllable::Flag (flags() | Controllable::GainLike));
  87                         alist()->reset_default (1.0);
  88
  89                         lower_db = accurate_coefficient_to_dB (_desc.lower);
  90                         range_db = accurate_coefficient_to_dB (_desc.upper) - lower_db;
  91                 }
  92
  93                 void set_value (double val);
  94                 void set_value_unchecked (double);
  95
  96                 double internal_to_interface (double) const;
  97                 double interface_to_internal (double) const;
  98                 double internal_to_user (double) const;
  99                 double user_to_internal (double) const;
 100                 std::string get_user_string () const;
 101
 102                 Amp* _amp;
 103                 double lower_db;
 104                 double range_db;
 105         };
 106
 107         boost::shared_ptr<GainControl> gain_control() {
 108                 return _gain_control;
 109         }
 110
 111         boost::shared_ptr<const GainControl> gain_control() const {
 112                 return _gain_control;
 113         }
 114
 115         std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
 116
 117 private:
 118         bool   _denormal_protection;
 119         bool   _apply_gain;
 120         bool   _apply_gain_automation;
 121         float  _current_gain;
 122         framepos_t _current_automation_frame;
 123
 124         boost::shared_ptr<GainControl> _gain_control;
 125
 126         /** Buffer that we should use for gain automation */
 127         gain_t* _gain_automation_buffer;
 128         std::string _type;
 129         bool _midi_amp;
 130 };
 131
 132
 133 } // namespace ARDOUR
 134
 135 #endif // __ardour_amp_h__