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/libardour_visibility.h"
  30 #include "ardour/types.h"
  31 #include "ardour/parameter_descriptor.h"
  32 #include "ardour/processor.h"
  33 #include "ardour/automation_control.h"
  34
  35 class XMLNode;
  36
  37 namespace ARDOUR {
  38
  39 class Session;
  40 class Route;
  41 class Plugin;
  42
  43 /** Plugin inserts: send data through a plugin
  44  */
  45 class LIBARDOUR_API PluginInsert : public Processor
  46 {
  47   public:
  48         PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
  49         ~PluginInsert ();
  50
  51         static const std::string port_automation_node_name;
  52
  53         XMLNode& state(bool);
  54         XMLNode& get_state(void);
  55         int set_state(const XMLNode&, int version);
  56         void update_id (PBD::ID);
  57         void set_state_dir (const std::string& d = "");
  58
  59         void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  60         void silence (framecnt_t nframes);
  61
  62         void activate ();
  63         void deactivate ();
  64         void flush ();
  65
  66         bool reset_parameters_to_default ();
  67         bool can_reset_all_parameters ();
  68
  69         int set_block_size (pframes_t nframes);
  70
  71         ChanCount output_streams() const;
  72         ChanCount input_streams() const;
  73         ChanCount natural_output_streams() const;
  74         ChanCount natural_input_streams() const;
  75
  76         bool     set_count (uint32_t num);
  77         uint32_t get_count () const { return _plugins.size(); }
  78
  79         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  80         bool configure_io (ChanCount in, ChanCount out);
  81
  82         bool has_no_inputs() const;
  83         bool has_no_audio_inputs() const;
  84         bool is_midi_instrument() const;
  85
  86         void realtime_handle_transport_stopped ();
  87         void realtime_locate ();
  88         void monitoring_changed ();
  89
  90         /** A control that manipulates a plugin parameter (control port). */
  91         struct PluginControl : public AutomationControl
  92         {
  93                 PluginControl (PluginInsert*                     p,
  94                                const Evoral::Parameter&          param,
  95                                const ParameterDescriptor&        desc,
  96                                boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
  97
  98                 void set_value (double val);
  99                 void set_value_unchecked (double);
 100                 double get_value (void) const;
 101                 void catch_up_with_external_value (double val);
 102                 XMLNode& get_state();
 103
 104         private:
 105                 PluginInsert* _plugin;
 106         };
 107
 108         /** A control that manipulates a plugin property (message). */
 109         struct PluginPropertyControl : public AutomationControl
 110         {
 111                 PluginPropertyControl (PluginInsert*                     p,
 112                                        const Evoral::Parameter&          param,
 113                                        const ParameterDescriptor&        desc,
 114                                        boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 115
 116                 void set_value (const Variant& val);
 117                 void set_value (double val);
 118                 void set_value_unchecked (double);
 119                 double get_value (void) const;
 120                 XMLNode& get_state();
 121
 122         private:
 123                 PluginInsert* _plugin;
 124                 Variant       _value;
 125         };
 126
 127         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 128                 if (num < _plugins.size()) {
 129                         return _plugins[num];
 130                 } else {
 131                         return _plugins[0]; // we always have one
 132                 }
 133         }
 134
 135         PluginType type ();
 136
 137         std::string describe_parameter (Evoral::Parameter param);
 138
 139         framecnt_t signal_latency () const;
 140
 141         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 142
 143         void collect_signal_for_analysis (framecnt_t nframes);
 144
 145         bool splitting () const {
 146                 return _match.method == Split;
 147         }
 148
 149         void configured_io (ChanCount &in, ChanCount &out) { in = _configured_in; out = _configured_out; }
 150
 151         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 152         PBD::Signal0<void> PluginIoReConfigure;
 153
 154         /** Enumeration of the ways in which we can match our insert's
 155          *  IO to that of the plugin(s).
 156          */
 157         enum MatchingMethod {
 158                 Impossible,  ///< we can't
 159                 Delegate,    ///< we are delegating to the plugin, and it can handle it
 160                 NoInputs,    ///< plugin has no inputs, so anything goes
 161                 ExactMatch,  ///< our insert's inputs are the same as the plugin's
 162                 Replicate,   ///< we have multiple instances of the plugin
 163                 Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
 164                 Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
 165         };
 166
 167   private:
 168         /* disallow copy construction */
 169         PluginInsert (const PluginInsert&);
 170
 171         void parameter_changed_externally (uint32_t, float);
 172
 173         void  set_parameter (Evoral::Parameter param, float val);
 174
 175         float default_parameter_value (const Evoral::Parameter& param);
 176
 177         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 178         Plugins _plugins;
 179
 180         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 181
 182         framecnt_t _signal_analysis_collected_nframes;
 183         framecnt_t _signal_analysis_collect_nframes_max;
 184
 185         BufferSet _signal_analysis_inputs;
 186         BufferSet _signal_analysis_outputs;
 187
 188         ChanCount midi_bypass;
 189
 190         ChanCount _configured_in;
 191         ChanCount _configured_out;
 192
 193         /** Description of how we can match our plugin's IO to our own insert IO */
 194         struct Match {
 195                 Match () : method (Impossible), plugins (0) {}
 196                 Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
 197
 198                 MatchingMethod method; ///< method to employ
 199                 int32_t plugins;       ///< number of copies of the plugin that we need
 200                 ChanCount hide;        ///< number of channels to hide
 201         };
 202
 203         Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
 204
 205         /** details of the match currently being used */
 206         Match _match;
 207
 208         void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
 209         void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 210
 211         void create_automatable_parameters ();
 212         void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 213         void set_parameter_state_2X (const XMLNode& node, int version);
 214         void set_control_ids (const XMLNode&, int version);
 215
 216         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 217         void add_plugin (boost::shared_ptr<Plugin>);
 218
 219         void start_touch (uint32_t param_id);
 220         void end_touch (uint32_t param_id);
 221 };
 222
 223 } // namespace ARDOUR
 224
 225 #endif /* __ardour_plugin_insert_h__ */