libs/ardour/ardour/plugin_insert.h

   1 /*
   2     Copyright (C) 2000,2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_plugin_insert_h__
  21 #define __ardour_plugin_insert_h__
  22
  23 #include <vector>
  24 #include <string>
  25
  26 #include <boost/weak_ptr.hpp>
  27
  28 #include "ardour/ardour.h"
  29 #include "ardour/types.h"
  30 #include "ardour/processor.h"
  31 #include "ardour/automation_control.h"
  32
  33 class XMLNode;
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class Route;
  39 class Plugin;
  40
  41 /** Plugin inserts: send data through a plugin
  42  */
  43 class PluginInsert : public Processor
  44 {
  45   public:
  46         PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
  47         ~PluginInsert ();
  48
  49         static const std::string port_automation_node_name;
  50
  51         XMLNode& state(bool);
  52         XMLNode& get_state(void);
  53         int set_state(const XMLNode&, int version);
  54
  55         void run (BufferSet& in, sframes_t start_frame, sframes_t end_frame, nframes_t nframes, bool);
  56         void silence (nframes_t nframes);
  57
  58         void activate ();
  59         void deactivate ();
  60
  61         void set_block_size (nframes_t nframes);
  62
  63         ChanCount output_streams() const;
  64         ChanCount input_streams() const;
  65         ChanCount natural_output_streams() const;
  66         ChanCount natural_input_streams() const;
  67
  68         bool     set_count (uint32_t num);
  69         uint32_t get_count () const { return _plugins.size(); }
  70
  71         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  72         bool configure_io (ChanCount in, ChanCount out);
  73
  74         bool is_generator() const;
  75
  76         struct PluginControl : public AutomationControl
  77         {
  78                 PluginControl (PluginInsert* p, const Evoral::Parameter &param,
  79                                 boost::shared_ptr<AutomationList> list = boost::shared_ptr<AutomationList>());
  80
  81                 void set_value (float val);
  82                 float get_value (void) const;
  83
  84         private:
  85                 PluginInsert* _plugin;
  86                 bool _logarithmic;
  87                 bool _toggled;
  88         };
  89
  90         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
  91                 if (num < _plugins.size()) {
  92                         return _plugins[num];
  93                 } else {
  94                         return _plugins[0]; // we always have one
  95                 }
  96         }
  97
  98         PluginType type ();
  99
 100         std::string describe_parameter (Evoral::Parameter param);
 101
 102         nframes_t signal_latency() const;
 103
 104         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 105
 106         void collect_signal_for_analysis(nframes_t nframes);
 107
 108         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 109
 110   private:
 111         /* disallow copy construction */
 112         PluginInsert (const PluginInsert&);
 113
 114         void parameter_changed (Evoral::Parameter, float);
 115
 116         void  set_parameter (Evoral::Parameter param, float val);
 117         float get_parameter (Evoral::Parameter param);
 118
 119         float default_parameter_value (const Evoral::Parameter& param);
 120
 121         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 122         Plugins _plugins;
 123
 124         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 125
 126         nframes_t _signal_analysis_collected_nframes;
 127         nframes_t _signal_analysis_collect_nframes_max;
 128
 129         BufferSet _signal_analysis_inputs;
 130         BufferSet _signal_analysis_outputs;
 131
 132         void automation_run (BufferSet& bufs, nframes_t nframes);
 133         void connect_and_run (BufferSet& bufs, nframes_t nframes, nframes_t offset, bool with_auto, nframes_t now = 0);
 134
 135         void set_automatable ();
 136         void auto_state_changed (Evoral::Parameter which);
 137         void set_parameter_state (const XMLNode& node, int version);
 138         void set_parameter_state_2X (const XMLNode& node, int version);
 139
 140         int32_t count_for_configuration (ChanCount in, ChanCount out) const;
 141
 142         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 143 };
 144
 145 } // namespace ARDOUR
 146
 147 #endif /* __ardour_plugin_insert_h__ */