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