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