2 Copyright (C) 2000,2007 Paul Davis
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.
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.
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.
20 #ifndef __ardour_plugin_insert_h__
21 #define __ardour_plugin_insert_h__
26 #include <boost/weak_ptr.hpp>
28 #include "ardour/ardour.h"
29 #include "ardour/libardour_visibility.h"
30 #include "ardour/types.h"
31 #include "ardour/parameter_descriptor.h"
32 #include "ardour/processor.h"
33 #include "ardour/automation_control.h"
43 /** Plugin inserts: send data through a plugin
45 class LIBARDOUR_API PluginInsert : public Processor
48 PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
51 static const std::string port_automation_node_name;
54 XMLNode& get_state(void);
55 int set_state(const XMLNode&, int version);
56 void update_id (PBD::ID);
58 void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
59 void silence (framecnt_t nframes);
65 bool reset_parameters_to_default ();
66 bool can_reset_all_parameters ();
68 int set_block_size (pframes_t nframes);
70 ChanCount output_streams() const;
71 ChanCount input_streams() const;
72 ChanCount natural_output_streams() const;
73 ChanCount natural_input_streams() const;
75 bool set_count (uint32_t num);
76 uint32_t get_count () const { return _plugins.size(); }
78 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
79 bool configure_io (ChanCount in, ChanCount out);
81 bool has_no_inputs() const;
82 bool has_no_audio_inputs() const;
83 bool is_midi_instrument() const;
85 void realtime_handle_transport_stopped ();
86 void realtime_locate ();
87 void monitoring_changed ();
89 /** A control that manipulates a plugin parameter (control port). */
90 struct PluginControl : public AutomationControl
92 PluginControl (PluginInsert* p,
93 const Evoral::Parameter& param,
94 const ParameterDescriptor& desc,
95 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
97 void set_value (double val);
98 double get_value (void) const;
102 PluginInsert* _plugin;
105 /** A control that manipulates a plugin property (message). */
106 struct PluginPropertyControl : public AutomationControl
108 PluginPropertyControl (PluginInsert* p,
109 const Evoral::Parameter& param,
110 const ParameterDescriptor& desc,
111 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
113 void set_value (const Variant& val);
114 void set_value (double val);
115 double get_value (void) const;
116 XMLNode& get_state();
119 PluginInsert* _plugin;
123 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
124 if (num < _plugins.size()) {
125 return _plugins[num];
127 return _plugins[0]; // we always have one
133 std::string describe_parameter (Evoral::Parameter param);
135 framecnt_t signal_latency () const;
137 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
139 void collect_signal_for_analysis (framecnt_t nframes);
141 bool splitting () const {
142 return _match.method == Split;
145 void configured_io (ChanCount &in, ChanCount &out) { in = _configured_in; out = _configured_out; }
147 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
148 PBD::Signal0<void> PluginIoReConfigure;
150 /** Enumeration of the ways in which we can match our insert's
151 * IO to that of the plugin(s).
153 enum MatchingMethod {
154 Impossible, ///< we can't
155 Delegate, ///< we are delegating to the plugin, and it can handle it
156 NoInputs, ///< plugin has no inputs, so anything goes
157 ExactMatch, ///< our insert's inputs are the same as the plugin's
158 Replicate, ///< we have multiple instances of the plugin
159 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
160 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
164 /* disallow copy construction */
165 PluginInsert (const PluginInsert&);
167 void parameter_changed (uint32_t, float);
169 void set_parameter (Evoral::Parameter param, float val);
170 float get_parameter (Evoral::Parameter param);
172 float default_parameter_value (const Evoral::Parameter& param);
174 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
177 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
179 framecnt_t _signal_analysis_collected_nframes;
180 framecnt_t _signal_analysis_collect_nframes_max;
182 BufferSet _signal_analysis_inputs;
183 BufferSet _signal_analysis_outputs;
185 ChanCount midi_bypass;
187 ChanCount _configured_in;
188 ChanCount _configured_out;
190 /** Description of how we can match our plugin's IO to our own insert IO */
192 Match () : method (Impossible), plugins (0) {}
193 Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
195 MatchingMethod method; ///< method to employ
196 int32_t plugins; ///< number of copies of the plugin that we need
197 ChanCount hide; ///< number of channels to hide
200 Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
202 /** details of the match currently being used */
205 void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
206 void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
208 void create_automatable_parameters ();
209 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
210 void set_parameter_state_2X (const XMLNode& node, int version);
211 void set_control_ids (const XMLNode&, int version);
213 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
214 void add_plugin (boost::shared_ptr<Plugin>);
216 void start_touch (uint32_t param_id);
217 void end_touch (uint32_t param_id);
220 } // namespace ARDOUR
222 #endif /* __ardour_plugin_insert_h__ */