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/types.h"
  30 #include "ardour/processor.h"
  31 #include "ardour/automation_control.h"
  32
  33 class XMLNode;
  34
  35 namespace ARDOUR {
  36
  37 class Session;
  38 class Route;
  39 class Plugin;
  40
  41 /** Plugin inserts: send data through a plugin
  42  */
  43 class PluginInsert : public Processor
  44 {
  45   public:
  46         PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
  47         ~PluginInsert ();
  48
  49         static const std::string port_automation_node_name;
  50
  51         XMLNode& state(bool);
  52         XMLNode& get_state(void);
  53         int set_state(const XMLNode&, int version);
  54
  55         void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  56         void silence (framecnt_t nframes);
  57
  58         void activate ();
  59         void deactivate ();
  60         void flush ();
  61
  62         int set_block_size (pframes_t nframes);
  63
  64         ChanCount output_streams() const;
  65         ChanCount input_streams() const;
  66         ChanCount natural_output_streams() const;
  67         ChanCount natural_input_streams() const;
  68
  69         bool     set_count (uint32_t num);
  70         uint32_t get_count () const { return _plugins.size(); }
  71
  72         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  73         bool configure_io (ChanCount in, ChanCount out);
  74
  75         bool has_no_inputs() const;
  76         bool has_no_audio_inputs() const;
  77         bool is_midi_instrument() const;
  78
  79         void realtime_handle_transport_stopped ();
  80         void realtime_locate ();
  81         void monitoring_changed ();
  82
  83         struct PluginControl : public AutomationControl
  84         {
  85                 PluginControl (PluginInsert* p, const Evoral::Parameter &param,
  86                                 boost::shared_ptr<AutomationList> list = boost::shared_ptr<AutomationList>());
  87
  88                 void set_value (double val);
  89                 double get_value (void) const;
  90                 XMLNode& get_state();
  91
  92                 double user_to_ui (double) const;
  93                 double ui_to_user (double) const;
  94                 double plugin_to_ui (double) const;
  95                 double plugin_to_user (double) const;
  96
  97         private:
  98                 double user_to_plugin (double) const;
  99
 100                 PluginInsert* _plugin;
 101                 bool _logarithmic;
 102                 bool _sr_dependent;
 103                 bool _toggled;
 104         };
 105
 106         boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
 107                 if (num < _plugins.size()) {
 108                         return _plugins[num];
 109                 } else {
 110                         return _plugins[0]; // we always have one
 111                 }
 112         }
 113
 114         PluginType type ();
 115
 116         std::string describe_parameter (Evoral::Parameter param);
 117
 118         framecnt_t signal_latency () const;
 119
 120         boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
 121
 122         void collect_signal_for_analysis (framecnt_t nframes);
 123
 124         bool splitting () const {
 125                 return _match.method == Split;
 126         }
 127
 128         PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
 129         /** Emitted when the return value of splitting () has changed */
 130         PBD::Signal0<void> SplittingChanged;
 131
 132         /** Enumeration of the ways in which we can match our insert's
 133          *  IO to that of the plugin(s).
 134          */
 135         enum MatchingMethod {
 136                 Impossible,  ///< we can't
 137                 Delegate,    ///< we are delegating to the plugin, and it can handle it
 138                 NoInputs,    ///< plugin has no inputs, so anything goes
 139                 ExactMatch,  ///< our insert's inputs are the same as the plugin's
 140                 Replicate,   ///< we have multiple instances of the plugin
 141                 Split,       ///< we copy one of our insert's inputs to multiple plugin inputs
 142                 Hide,        ///< we `hide' some of the plugin's inputs by feeding them silence
 143         };
 144
 145   private:
 146         /* disallow copy construction */
 147         PluginInsert (const PluginInsert&);
 148
 149         void parameter_changed (Evoral::Parameter, float);
 150
 151         void  set_parameter (Evoral::Parameter param, float val);
 152         float get_parameter (Evoral::Parameter param);
 153
 154         float default_parameter_value (const Evoral::Parameter& param);
 155
 156         typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
 157         Plugins _plugins;
 158
 159         boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
 160
 161         framecnt_t _signal_analysis_collected_nframes;
 162         framecnt_t _signal_analysis_collect_nframes_max;
 163
 164         BufferSet _signal_analysis_inputs;
 165         BufferSet _signal_analysis_outputs;
 166
 167         /** Description of how we can match our plugin's IO to our own insert IO */
 168         struct Match {
 169                 Match () : method (Impossible), plugins (0) {}
 170                 Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
 171
 172                 MatchingMethod method; ///< method to employ
 173                 int32_t plugins;       ///< number of copies of the plugin that we need
 174                 ChanCount hide;        ///< number of channels to hide
 175         };
 176
 177         Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
 178
 179         /** details of the match currently being used */
 180         Match _match;
 181
 182         void automation_run (BufferSet& bufs, pframes_t nframes);
 183         void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
 184
 185         void create_automatable_parameters ();
 186         void control_list_automation_state_changed (Evoral::Parameter, AutoState);
 187         void set_parameter_state_2X (const XMLNode& node, int version);
 188         void set_control_ids (const XMLNode&, int version);
 189
 190         boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
 191         void add_plugin (boost::shared_ptr<Plugin>);
 192 };
 193
 194 } // namespace ARDOUR
 195
 196 #endif /* __ardour_plugin_insert_h__ */