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