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 GainControl;
  33 class IO;
  34
  35 /** Applies a declick operation to all audio inputs, passing the same number of
  36  * audio outputs, and passing through any other types unchanged.
  37  */
  38 class LIBARDOUR_API Amp : public Processor {
  39 public:
  40         Amp(Session& s, const std::string& display_name, boost::shared_ptr<GainControl> control, bool control_midi_also);
  41
  42         std::string display_name () const { return _display_name; }
  43         void set_display_name (const std::string& name) { _display_name = name; }
  44
  45         bool visible () const;
  46
  47         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  48         bool configure_io (ChanCount in, ChanCount out);
  49
  50         void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
  51
  52         void set_gain_automation_buffer (gain_t *);
  53
  54         void setup_gain_automation (samplepos_t start_sample, samplepos_t end_sample, samplecnt_t nframes);
  55
  56         XMLNode& state ();
  57         int set_state (const XMLNode&, int version);
  58
  59         static gain_t apply_gain (BufferSet& bufs, samplecnt_t sample_rate, samplecnt_t nframes, gain_t initial, gain_t target, bool midi_amp = true);
  60         static void apply_simple_gain(BufferSet& bufs, samplecnt_t nframes, gain_t target, bool midi_amp = true);
  61
  62         static gain_t apply_gain (AudioBuffer& buf, samplecnt_t sample_rate, samplecnt_t nframes, gain_t initial, gain_t target, sampleoffset_t offset = 0);
  63         static void apply_simple_gain (AudioBuffer& buf, samplecnt_t nframes, gain_t target, sampleoffset_t offset = 0);
  64
  65         static void declick (BufferSet& bufs, samplecnt_t nframes, int dir);
  66         static void update_meters();
  67
  68         boost::shared_ptr<GainControl> gain_control() {
  69                 return _gain_control;
  70         }
  71
  72         boost::shared_ptr<const GainControl> gain_control() const {
  73                 return _gain_control;
  74         }
  75
  76 private:
  77         bool   _denormal_protection;
  78         bool   _apply_gain_automation;
  79         float  _current_gain;
  80         samplepos_t _current_automation_sample;
  81
  82         std::string _display_name;
  83
  84         boost::shared_ptr<GainControl> _gain_control;
  85
  86         /** Buffer that we should use for gain automation */
  87         gain_t* _gain_automation_buffer;
  88         bool _midi_amp;
  89 };
  90
  91
  92 } // namespace ARDOUR
  93
  94 #endif // __ardour_amp_h__