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