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