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