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