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