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