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