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, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  56         void silence (framecnt_t nframes);
  57
  58         void activate ();
  59         void deactivate ();
  60         void flush ();
  61
  62         int set_block_size (pframes_t nframes);
  63
  64         ChanCount output_streams() const;
  65         ChanCount input_streams() const;
  66         ChanCount natural_output_streams() const;
  67         ChanCount natural_input_streams() const;
  68
  69         bool     set_count (uint32_t num);
  70         uint32_t get_count () const { return _plugins.size(); }
  71
  72         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  73         bool configure_io (ChanCount in, ChanCount out);
  74
  75         bool is_generator() const;
  76
  77         void realtime_handle_transport_stopped ();
  78
  79         struct PluginControl : public AutomationControl
  80         {
  81                 PluginControl (PluginInsert* p, const Evoral::Parameter &param,
  82                                 boost::shared_ptr<AutomationList> list = boost::shared_ptr<AutomationList>());
  83
  84                 void set_value (double val);
  85                 double get_value (void) const;
  86                 XMLNode& get_state();
  87
  88                 double user_to_ui (double) const;
  89                 double ui_to_user (double) const;
  90                 double plugin_to_ui (double) const;
  91                 double plugin_to_user (double) const;
  92
  93         private:
  94                 double user_to_plugin (double) const;
  95
  96                 PluginInsert* _plugin;
  97                 bool _logarithmic;
  98                 bool _sr_dependent;
  99                 bool _toggled;
 100         };
 101
 102         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 103                 if (num < _plugins.size()) {
 104                         return _plugins[num];
 105                 } else {
 106                         return _plugins[0]; // we always have one
 107                 }
 108         }
 109
 110         PluginType type ();
 111
 112         std::string describe_parameter (Evoral::Parameter param);
 113
 114         framecnt_t signal_latency () const;
 115
 116         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 117
 118         void collect_signal_for_analysis (framecnt_t nframes);
 119
 120         bool splitting () const {
 121                 return _splitting;
 122         }
 123
 124         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 125         /** Emitted when the return value of splitting () has changed */
 126         PBD::Signal0<void> SplittingChanged;
 127
 128   private:
 129         /* disallow copy construction */
 130         PluginInsert (const PluginInsert&);
 131
 132         void parameter_changed (Evoral::Parameter, float);
 133
 134         void  set_parameter (Evoral::Parameter param, float val);
 135         float get_parameter (Evoral::Parameter param);
 136
 137         float default_parameter_value (const Evoral::Parameter& param);
 138
 139         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 140         Plugins _plugins;
 141
 142         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 143
 144         framecnt_t _signal_analysis_collected_nframes;
 145         framecnt_t _signal_analysis_collect_nframes_max;
 146
 147         BufferSet _signal_analysis_inputs;
 148         BufferSet _signal_analysis_outputs;
 149
 150         /** true if we are splitting one processor input to >1 plugin inputs */
 151         bool _splitting;
 152
 153         void set_splitting (bool);
 154
 155         void automation_run (BufferSet& bufs, pframes_t nframes);
 156         void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 157
 158         void set_automatable ();
 159         void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 160         void set_parameter_state_2X (const XMLNode& node, int version);
 161         void set_control_ids (const XMLNode&, int version);
 162
 163         int32_t count_for_configuration (ChanCount in, ChanCount out) const;
 164
 165         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 166         void add_plugin_with_activation (boost::shared_ptr<Plugin>);
 167 };
 168
 169 } // namespace ARDOUR
 170
 171 #endif /* __ardour_plugin_insert_h__ */