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