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         bool is_instrument () const;
 180         bool has_output_presets (
 181                         ChanCount in = ChanCount (DataType::MIDI, 1),
 182                         ChanCount out = ChanCount (DataType::AUDIO, 2)
 183                         );
 184
 185         void realtime_handle_transport_stopped ();
 186         void realtime_locate ();
 187         void monitoring_changed ();
 188
 189         bool load_preset (Plugin::PresetRecord);
 190
 191         /** A control that manipulates a plugin parameter (control port). */
 192         struct PluginControl : public AutomationControl
 193         {
 194                 PluginControl (PluginInsert*                     p,
 195                                const Evoral::Parameter&          param,
 196                                const ParameterDescriptor&        desc,
 197                                boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 198
 199                 double get_value (void) const;
 200                 void catch_up_with_external_value (double val);
 201                 XMLNode& get_state();
 202
 203         private:
 204                 PluginInsert* _plugin;
 205                 void actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 206         };
 207
 208         /** A control that manipulates a plugin property (message). */
 209         struct PluginPropertyControl : public AutomationControl
 210         {
 211                 PluginPropertyControl (PluginInsert*                     p,
 212                                        const Evoral::Parameter&          param,
 213                                        const ParameterDescriptor&        desc,
 214                                        boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 215
 216                 double get_value (void) const;
 217                 XMLNode& get_state();
 218         protected:
 219                 void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
 220
 221         private:
 222                 PluginInsert* _plugin;
 223                 Variant       _value;
 224         };
 225
 226         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 227                 if (num < _plugins.size()) {
 228                         return _plugins[num];
 229                 } else {
 230                         return _plugins[0]; // we always have one
 231                 }
 232         }
 233
 234         samplecnt_t plugin_latency () const;
 235
 236         bool has_sidechain () const {
 237                 return _sidechain ? true : false;
 238         }
 239
 240         boost::shared_ptr<IO> sidechain_input () const {
 241                 if (_sidechain) {
 242                         return _sidechain->input ();
 243                 }
 244                 return boost::shared_ptr<IO> ();
 245         }
 246
 247         PluginType type ();
 248
 249         boost::shared_ptr<ReadOnlyControl> control_output (uint32_t) const;
 250
 251         std::string describe_parameter (Evoral::Parameter param);
 252
 253         samplecnt_t signal_latency () const;
 254
 255         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 256
 257         void collect_signal_for_analysis (samplecnt_t nframes);
 258
 259         bool strict_io_configured () const {
 260                 return _match.strict_io;
 261         }
 262
 263         bool splitting () const {
 264                 return _match.method == Split;
 265         }
 266
 267         void configured_io (ChanCount &in, ChanCount &out) const {
 268                 in = _configured_in;
 269                 out = _configured_out;
 270         }
 271
 272         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 273         PBD::Signal0<void> PluginIoReConfigure;
 274         PBD::Signal0<void> PluginMapChanged;
 275         PBD::Signal0<void> PluginConfigChanged;
 276
 277         /** Enumeration of the ways in which we can match our insert's
 278          *  IO to that of the plugin(s).
 279          */
 280         enum MatchingMethod {
 281                 Impossible,  ///< we can't
 282                 Delegate,    ///< we are delegating to the plugin, and it can handle it
 283                 NoInputs,    ///< plugin has no inputs, so anything goes
 284                 ExactMatch,  ///< our insert's inputs are the same as the plugin's
 285                 Replicate,   ///< we have multiple instances of the plugin
 286                 Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
 287                 Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
 288         };
 289
 290         /** Description of how we can match our plugin's IO to our own insert IO */
 291         struct Match {
 292                 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
 293                 Match (MatchingMethod m, int32_t p,
 294                                 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
 295                         : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
 296
 297                 MatchingMethod method; ///< method to employ
 298                 int32_t plugins;       ///< number of copies of the plugin that we need
 299                 ChanCount hide;        ///< number of channels to hide
 300                 bool strict_io;        ///< force in == out
 301                 bool custom_cfg;       ///< custom config (if not strict)
 302         };
 303
 304 protected:
 305         XMLNode& state ();
 306
 307 private:
 308         /* disallow copy construction */
 309         PluginInsert (const PluginInsert&);
 310
 311         void parameter_changed_externally (uint32_t, float);
 312
 313         void set_parameter (Evoral::Parameter param, float val);
 314
 315         float default_parameter_value (const Evoral::Parameter& param);
 316
 317         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 318         Plugins _plugins;
 319
 320         boost::shared_ptr<SideChain> _sidechain;
 321         uint32_t _sc_playback_latency;
 322         uint32_t _sc_capture_latency;
 323         uint32_t _plugin_signal_latency;
 324
 325         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 326
 327         samplecnt_t _signal_analysis_collected_nframes;
 328         samplecnt_t _signal_analysis_collect_nframes_max;
 329
 330         BufferSet _signal_analysis_inputs;
 331         BufferSet _signal_analysis_outputs;
 332
 333         FixedDelay _delaybuffers;
 334
 335         ChanCount _configured_in;
 336         ChanCount _configured_internal; // with side-chain
 337         ChanCount _configured_out;
 338         ChanCount _custom_out;
 339         ChanCount _custom_sinks;
 340         ChanCount _preset_out;
 341         ChanCount _cached_sidechain_pins;
 342         ChanCount _required_buffers;
 343
 344         bool _configured;
 345         bool _no_inplace;
 346         bool _strict_io;
 347         bool _custom_cfg;
 348         bool _maps_from_state;
 349         bool _mapping_changed;
 350
 351         Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
 352         Match internal_can_support_io_configuration (ChanCount const &, ChanCount &) const;
 353         Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
 354
 355         /** details of the match currently being used */
 356         Match _match;
 357
 358         typedef std::map <uint32_t, ARDOUR::ChanMapping> PinMappings;
 359         PinMappings _in_map;
 360         PinMappings _out_map;
 361         ChanMapping _thru_map; // out-idx <=  in-idx
 362
 363         void automate_and_run (BufferSet& bufs, samplepos_t start, samplepos_t end, double speed, pframes_t nframes);
 364         void connect_and_run (BufferSet& bufs, samplepos_t start, samplecnt_t end, double speed, pframes_t nframes, samplecnt_t offset, bool with_auto);
 365         void bypass (BufferSet& bufs, pframes_t nframes);
 366         void inplace_silence_unconnected (BufferSet&, const PinMappings&, samplecnt_t nframes, samplecnt_t offset) const;
 367
 368         void create_automatable_parameters ();
 369         void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 370         void set_parameter_state_2X (const XMLNode& node, int version);
 371         void set_control_ids (const XMLNode&, int version);
 372
 373         void enable_changed ();
 374         void bypassable_changed ();
 375
 376         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 377         void add_plugin (boost::shared_ptr<Plugin>);
 378
 379         void start_touch (uint32_t param_id);
 380         void end_touch (uint32_t param_id);
 381
 382         void latency_changed ();
 383         bool _latency_changed;
 384         uint32_t _bypass_port;
 385
 386         typedef std::map<uint32_t, boost::shared_ptr<ReadOnlyControl> >CtrlOutMap;
 387         CtrlOutMap _control_outputs;
 388
 389         void preset_load_set_value (uint32_t, float);
 390 };
 391
 392 } // namespace ARDOUR
 393
 394 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m);
 395
 396 #endif /* __ardour_plugin_insert_h__ */