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