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