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/chan_mapping.h"
  31 #include "ardour/types.h"
  32 #include "ardour/parameter_descriptor.h"
  33 #include "ardour/processor.h"
  34 #include "ardour/automation_control.h"
  35
  36 class XMLNode;
  37
  38 namespace ARDOUR {
  39
  40 class Session;
  41 class Route;
  42 class Plugin;
  43
  44 /** Plugin inserts: send data through a plugin
  45  */
  46 class LIBARDOUR_API PluginInsert : public Processor
  47 {
  48   public:
  49         PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
  50         ~PluginInsert ();
  51
  52         static const std::string port_automation_node_name;
  53
  54         XMLNode& state(bool);
  55         XMLNode& get_state(void);
  56         int set_state(const XMLNode&, int version);
  57         void update_id (PBD::ID);
  58         void set_state_dir (const std::string& d = "");
  59
  60         void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  61         void silence (framecnt_t nframes);
  62
  63         void activate ();
  64         void deactivate ();
  65         void flush ();
  66
  67         bool reset_parameters_to_default ();
  68         bool can_reset_all_parameters ();
  69
  70         int set_block_size (pframes_t nframes);
  71
  72         ChanMapping input_map (uint32_t num=0) const {
  73                 if (num < _in_map.size()) {
  74                         return _in_map.find (num)->second;
  75                 } else {
  76                         return ChanMapping ();
  77                 }
  78         }
  79
  80         ChanMapping output_map (uint32_t num=0) const {
  81                 if (num < _out_map.size()) {
  82                         return _out_map.find (num)->second;
  83                 } else {
  84                         return ChanMapping ();
  85                 }
  86         }
  87
  88         void set_input_map (uint32_t, ChanMapping);
  89         void set_output_map (uint32_t, ChanMapping);
  90
  91         // these are ports visible on the outside
  92         ChanCount output_streams() const;
  93         ChanCount input_streams() const;
  94
  95         // actual ports of all plugins.
  96         // n * natural_i/o or result of reconfigurable i/o
  97         ChanCount internal_output_streams() const;
  98         ChanCount internal_input_streams() const;
  99
 100         // a single plugin's internal i/o
 101         ChanCount natural_output_streams() const;
 102         ChanCount natural_input_streams() const;
 103
 104         // allow to override output_streams(), implies "Custom Mode"
 105
 106         // only the owning route may call these (with process lock held)
 107         // route is not a friend class, it owns us
 108         bool set_count      (uint32_t num);
 109         void set_outputs    (const ChanCount&);
 110         void set_strict_io  (bool b) { _strict_io = b; }
 111         void set_custom_cfg (bool b) { _custom_cfg = b; }
 112         // end C++ class slavery!
 113
 114         uint32_t get_count  () const { return _plugins.size(); }
 115         bool     strict_io  () const { return _strict_io; }
 116         bool     custom_cfg () const { return _custom_cfg; }
 117
 118         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
 119         bool configure_io (ChanCount in, ChanCount out);
 120
 121         bool has_no_inputs() const;
 122         bool has_no_audio_inputs() const;
 123         bool is_midi_instrument() const;
 124
 125         void realtime_handle_transport_stopped ();
 126         void realtime_locate ();
 127         void monitoring_changed ();
 128
 129         /** A control that manipulates a plugin parameter (control port). */
 130         struct PluginControl : public AutomationControl
 131         {
 132                 PluginControl (PluginInsert*                     p,
 133                                const Evoral::Parameter&          param,
 134                                const ParameterDescriptor&        desc,
 135                                boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 136
 137                 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 138                 void set_value_unchecked (double);
 139                 double get_value (void) const;
 140                 void catch_up_with_external_value (double val);
 141                 XMLNode& get_state();
 142
 143         private:
 144                 PluginInsert* _plugin;
 145                 void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 146         };
 147
 148         /** A control that manipulates a plugin property (message). */
 149         struct PluginPropertyControl : public AutomationControl
 150         {
 151                 PluginPropertyControl (PluginInsert*                     p,
 152                                        const Evoral::Parameter&          param,
 153                                        const ParameterDescriptor&        desc,
 154                                        boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 155
 156                 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 157                 void set_value_unchecked (double);
 158                 double get_value (void) const;
 159                 XMLNode& get_state();
 160
 161         private:
 162                 PluginInsert* _plugin;
 163                 Variant       _value;
 164         };
 165
 166         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 167                 if (num < _plugins.size()) {
 168                         return _plugins[num];
 169                 } else {
 170                         return _plugins[0]; // we always have one
 171                 }
 172         }
 173
 174         PluginType type ();
 175
 176         std::string describe_parameter (Evoral::Parameter param);
 177
 178         framecnt_t signal_latency () const;
 179
 180         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 181
 182         void collect_signal_for_analysis (framecnt_t nframes);
 183
 184         bool no_inplace () const {
 185                 return _pending_no_inplace;
 186         }
 187
 188         void set_no_inplace (bool b) { // XXX tenative dev API
 189                 _pending_no_inplace = b; // TODO detect automatically
 190         }
 191
 192         bool strict_io_configured () const {
 193                 return _match.strict_io;
 194         }
 195
 196         bool splitting () const {
 197                 return _match.method == Split;
 198         }
 199
 200         void configured_io (ChanCount &in, ChanCount &out) const {
 201                 in = _configured_in;
 202                 out = _configured_out;
 203         }
 204
 205         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 206         PBD::Signal0<void> PluginIoReConfigure;
 207         PBD::Signal0<void> PluginMapChanged;
 208
 209         /** Enumeration of the ways in which we can match our insert's
 210          *  IO to that of the plugin(s).
 211          */
 212         enum MatchingMethod {
 213                 Impossible,  ///< we can't
 214                 Delegate,    ///< we are delegating to the plugin, and it can handle it
 215                 NoInputs,    ///< plugin has no inputs, so anything goes
 216                 ExactMatch,  ///< our insert's inputs are the same as the plugin's
 217                 Replicate,   ///< we have multiple instances of the plugin
 218                 Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
 219                 Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
 220         };
 221
 222   private:
 223         /* disallow copy construction */
 224         PluginInsert (const PluginInsert&);
 225
 226         void parameter_changed_externally (uint32_t, float);
 227
 228         void  set_parameter (Evoral::Parameter param, float val);
 229
 230         float default_parameter_value (const Evoral::Parameter& param);
 231
 232         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 233         Plugins _plugins;
 234
 235         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 236
 237         framecnt_t _signal_analysis_collected_nframes;
 238         framecnt_t _signal_analysis_collect_nframes_max;
 239
 240         BufferSet _signal_analysis_inputs;
 241         BufferSet _signal_analysis_outputs;
 242
 243         ChanCount _configured_in;
 244         ChanCount _configured_out;
 245         ChanCount _custom_out;
 246
 247         bool _configured;
 248         bool _no_inplace;
 249         bool _strict_io;
 250         bool _custom_cfg;
 251         bool _pending_no_inplace;
 252
 253         /** Description of how we can match our plugin's IO to our own insert IO */
 254         struct Match {
 255                 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
 256                 Match (MatchingMethod m, int32_t p,
 257                                 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
 258                         : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
 259
 260                 MatchingMethod method; ///< method to employ
 261                 int32_t plugins;       ///< number of copies of the plugin that we need
 262                 ChanCount hide;        ///< number of channels to hide
 263                 bool strict_io;        ///< force in == out
 264                 bool custom_cfg;       ///< custom config (if not strict)
 265         };
 266
 267         Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
 268         Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
 269
 270         /** details of the match currently being used */
 271         Match _match;
 272
 273         typedef std::map <uint32_t, ARDOUR::ChanMapping> PinMappings;
 274         PinMappings _in_map;
 275         PinMappings _out_map;
 276
 277         void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
 278         void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 279
 280         void create_automatable_parameters ();
 281         void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 282         void set_parameter_state_2X (const XMLNode& node, int version);
 283         void set_control_ids (const XMLNode&, int version);
 284
 285         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 286         void add_plugin (boost::shared_ptr<Plugin>);
 287
 288         void start_touch (uint32_t param_id);
 289         void end_touch (uint32_t param_id);
 290 };
 291
 292 } // namespace ARDOUR
 293
 294 #endif /* __ardour_plugin_insert_h__ */