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=0) 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=0) const {
  81                 if (num < _out_map.size()) {
  82                         return _out_map.find (num)->second;
  83                 } else {
  84                         return ChanMapping ();
  85                 }
  86         }
  87
  88 #ifndef NDEBUG // prototyping -- this should be done synchroneously in configure_io()
  89         void set_input_map (uint32_t num, ChanMapping m) {
  90                 if (num < _in_map.size()) {
  91                         _in_map[num] = m;
  92                 }
  93         }
  94         void set_output_map (uint32_t num, ChanMapping m) {
  95                 if (num < _in_map.size()) {
  96                         _out_map[num] = m;
  97                 }
  98         }
  99 #endif
 100
 101         ChanCount output_streams() const;
 102         ChanCount input_streams() const;
 103         ChanCount natural_output_streams() const;
 104         ChanCount natural_input_streams() const;
 105
 106         bool     set_count (uint32_t num);
 107         uint32_t get_count () const { return _plugins.size(); }
 108
 109         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
 110         bool configure_io (ChanCount in, ChanCount out);
 111
 112         bool has_no_inputs() const;
 113         bool has_no_audio_inputs() const;
 114         bool is_midi_instrument() const;
 115
 116         void realtime_handle_transport_stopped ();
 117         void realtime_locate ();
 118         void monitoring_changed ();
 119
 120         /** A control that manipulates a plugin parameter (control port). */
 121         struct PluginControl : public AutomationControl
 122         {
 123                 PluginControl (PluginInsert*                     p,
 124                                const Evoral::Parameter&          param,
 125                                const ParameterDescriptor&        desc,
 126                                boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 127
 128                 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 129                 void set_value_unchecked (double);
 130                 double get_value (void) const;
 131                 void catch_up_with_external_value (double val);
 132                 XMLNode& get_state();
 133
 134         private:
 135                 PluginInsert* _plugin;
 136                 void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 137         };
 138
 139         /** A control that manipulates a plugin property (message). */
 140         struct PluginPropertyControl : public AutomationControl
 141         {
 142                 PluginPropertyControl (PluginInsert*                     p,
 143                                        const Evoral::Parameter&          param,
 144                                        const ParameterDescriptor&        desc,
 145                                        boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
 146
 147                 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
 148                 void set_value_unchecked (double);
 149                 double get_value (void) const;
 150                 XMLNode& get_state();
 151
 152         private:
 153                 PluginInsert* _plugin;
 154                 Variant       _value;
 155         };
 156
 157         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 158                 if (num < _plugins.size()) {
 159                         return _plugins[num];
 160                 } else {
 161                         return _plugins[0]; // we always have one
 162                 }
 163         }
 164
 165         PluginType type ();
 166
 167         std::string describe_parameter (Evoral::Parameter param);
 168
 169         framecnt_t signal_latency () const;
 170
 171         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 172
 173         void collect_signal_for_analysis (framecnt_t nframes);
 174
 175         bool no_inplace () const {
 176                 return _pending_no_inplace;
 177         }
 178
 179         void set_no_inplace (bool b) {
 180                 _pending_no_inplace = b;
 181         }
 182
 183         void set_strict_io (bool b) {
 184                 _strict_io = b;
 185         }
 186
 187         bool strict_io_configured () const {
 188                 return _strict_io_configured;
 189         }
 190
 191         bool splitting () const {
 192                 return _match.method == Split;
 193         }
 194
 195         void configured_io (ChanCount &in, ChanCount &out) { in = _configured_in; out = _configured_out; }
 196
 197         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 198         PBD::Signal0<void> PluginIoReConfigure;
 199
 200         /** Enumeration of the ways in which we can match our insert's
 201          *  IO to that of the plugin(s).
 202          */
 203         enum MatchingMethod {
 204                 Impossible,  ///< we can't
 205                 Delegate,    ///< we are delegating to the plugin, and it can handle it
 206                 NoInputs,    ///< plugin has no inputs, so anything goes
 207                 ExactMatch,  ///< our insert's inputs are the same as the plugin's
 208                 Replicate,   ///< we have multiple instances of the plugin
 209                 Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
 210                 Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
 211         };
 212
 213   private:
 214         /* disallow copy construction */
 215         PluginInsert (const PluginInsert&);
 216
 217         void parameter_changed_externally (uint32_t, float);
 218
 219         void  set_parameter (Evoral::Parameter param, float val);
 220
 221         float default_parameter_value (const Evoral::Parameter& param);
 222
 223         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 224         Plugins _plugins;
 225
 226         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 227
 228         framecnt_t _signal_analysis_collected_nframes;
 229         framecnt_t _signal_analysis_collect_nframes_max;
 230
 231         BufferSet _signal_analysis_inputs;
 232         BufferSet _signal_analysis_outputs;
 233
 234         ChanCount midi_bypass;
 235
 236         ChanCount _configured_in;
 237         ChanCount _configured_out;
 238
 239         bool _no_inplace;
 240         bool _pending_no_inplace;
 241         bool _strict_io;
 242         bool _strict_io_configured;
 243
 244         /** Description of how we can match our plugin's IO to our own insert IO */
 245         struct Match {
 246                 Match () : method (Impossible), plugins (0) {}
 247                 Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
 248
 249                 MatchingMethod method; ///< method to employ
 250                 int32_t plugins;       ///< number of copies of the plugin that we need
 251                 ChanCount hide;        ///< number of channels to hide
 252         };
 253
 254         Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
 255
 256         /** details of the match currently being used */
 257         Match _match;
 258         std::map <uint32_t, ARDOUR::ChanMapping> _in_map;
 259         std::map <uint32_t, ARDOUR::ChanMapping> _out_map;
 260
 261         void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
 262         void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 263
 264         void create_automatable_parameters ();
 265         void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 266         void set_parameter_state_2X (const XMLNode& node, int version);
 267         void set_control_ids (const XMLNode&, int version);
 268
 269         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 270         void add_plugin (boost::shared_ptr<Plugin>);
 271
 272         void start_touch (uint32_t param_id);
 273         void end_touch (uint32_t param_id);
 274 };
 275
 276 } // namespace ARDOUR
 277
 278 #endif /* __ardour_plugin_insert_h__ */