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