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);
57 void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
58 void silence (framecnt_t nframes);
64 int set_block_size (pframes_t nframes);
66 ChanCount output_streams() const;
67 ChanCount input_streams() const;
68 ChanCount natural_output_streams() const;
69 ChanCount natural_input_streams() const;
71 bool set_count (uint32_t num);
72 uint32_t get_count () const { return _plugins.size(); }
74 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
75 bool configure_io (ChanCount in, ChanCount out);
77 bool has_no_inputs() const;
78 bool has_no_audio_inputs() const;
79 bool is_midi_instrument() const;
81 void realtime_handle_transport_stopped ();
82 void realtime_locate ();
83 void monitoring_changed ();
85 /** A control that manipulates a plugin parameter (control port). */
86 struct PluginControl : public AutomationControl
88 PluginControl (PluginInsert* p,
89 const Evoral::Parameter& param,
90 const ParameterDescriptor& desc,
91 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
93 void set_value (double val);
94 double get_value (void) const;
97 double internal_to_interface (double) const;
98 double interface_to_internal (double) const;
101 PluginInsert* _plugin;
104 /** A control that manipulates a plugin property (message). */
105 struct PluginPropertyControl : public AutomationControl
107 PluginPropertyControl (PluginInsert* p,
108 const Evoral::Parameter& param,
109 const ParameterDescriptor& desc,
110 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
112 void set_value (const Variant& val);
113 void set_value (double val);
114 double get_value (void) const;
115 XMLNode& get_state();
118 PluginInsert* _plugin;
122 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
123 if (num < _plugins.size()) {
124 return _plugins[num];
126 return _plugins[0]; // we always have one
132 std::string describe_parameter (Evoral::Parameter param);
134 framecnt_t signal_latency () const;
136 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
138 void collect_signal_for_analysis (framecnt_t nframes);
140 bool splitting () const {
141 return _match.method == Split;
144 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
145 PBD::Signal0<void> PluginIoReConfigure;
147 /** Enumeration of the ways in which we can match our insert's
148 * IO to that of the plugin(s).
150 enum MatchingMethod {
151 Impossible, ///< we can't
152 Delegate, ///< we are delegating to the plugin, and it can handle it
153 NoInputs, ///< plugin has no inputs, so anything goes
154 ExactMatch, ///< our insert's inputs are the same as the plugin's
155 Replicate, ///< we have multiple instances of the plugin
156 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
157 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
161 /* disallow copy construction */
162 PluginInsert (const PluginInsert&);
164 void parameter_changed (uint32_t, float);
166 void set_parameter (Evoral::Parameter param, float val);
167 float get_parameter (Evoral::Parameter param);
169 float default_parameter_value (const Evoral::Parameter& param);
171 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
174 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
176 framecnt_t _signal_analysis_collected_nframes;
177 framecnt_t _signal_analysis_collect_nframes_max;
179 BufferSet _signal_analysis_inputs;
180 BufferSet _signal_analysis_outputs;
182 ChanCount midi_bypass;
184 /** Description of how we can match our plugin's IO to our own insert IO */
186 Match () : method (Impossible), plugins (0) {}
187 Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
189 MatchingMethod method; ///< method to employ
190 int32_t plugins; ///< number of copies of the plugin that we need
191 ChanCount hide; ///< number of channels to hide
194 Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
196 /** details of the match currently being used */
199 void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
200 void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
202 void create_automatable_parameters ();
203 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
204 void set_parameter_state_2X (const XMLNode& node, int version);
205 void set_control_ids (const XMLNode&, int version);
207 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
208 void add_plugin (boost::shared_ptr<Plugin>);
210 void start_touch (uint32_t param_id);
211 void end_touch (uint32_t param_id);
214 } // namespace ARDOUR
216 #endif /* __ardour_plugin_insert_h__ */