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/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"
44 /** Plugin inserts: send data through a plugin
46 class LIBARDOUR_API PluginInsert : public Processor
49 PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
52 static const std::string port_automation_node_name;
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 = "");
60 void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
61 void silence (framecnt_t nframes);
67 bool reset_parameters_to_default ();
68 bool can_reset_all_parameters ();
70 int set_block_size (pframes_t nframes);
72 ChanCount output_streams() const;
73 ChanCount input_streams() const;
74 ChanCount natural_output_streams() const;
75 ChanCount natural_input_streams() const;
77 bool set_count (uint32_t num);
78 uint32_t get_count () const { return _plugins.size(); }
80 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
81 bool configure_io (ChanCount in, ChanCount out);
83 bool has_no_inputs() const;
84 bool has_no_audio_inputs() const;
85 bool is_midi_instrument() const;
87 void realtime_handle_transport_stopped ();
88 void realtime_locate ();
89 void monitoring_changed ();
91 /** A control that manipulates a plugin parameter (control port). */
92 struct PluginControl : public AutomationControl
94 PluginControl (PluginInsert* p,
95 const Evoral::Parameter& param,
96 const ParameterDescriptor& desc,
97 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
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();
106 PluginInsert* _plugin;
107 void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
110 /** A control that manipulates a plugin property (message). */
111 struct PluginPropertyControl : public AutomationControl
113 PluginPropertyControl (PluginInsert* p,
114 const Evoral::Parameter& param,
115 const ParameterDescriptor& desc,
116 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
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();
124 PluginInsert* _plugin;
128 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
129 if (num < _plugins.size()) {
130 return _plugins[num];
132 return _plugins[0]; // we always have one
138 std::string describe_parameter (Evoral::Parameter param);
140 framecnt_t signal_latency () const;
142 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
144 void collect_signal_for_analysis (framecnt_t nframes);
146 void set_strict_io (bool b) {
150 bool strict_io_configured () const {
151 return _strict_io_configured;
154 bool splitting () const {
155 return _match.method == Split;
158 void configured_io (ChanCount &in, ChanCount &out) { in = _configured_in; out = _configured_out; }
160 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
161 PBD::Signal0<void> PluginIoReConfigure;
163 /** Enumeration of the ways in which we can match our insert's
164 * IO to that of the plugin(s).
166 enum MatchingMethod {
167 Impossible, ///< we can't
168 Delegate, ///< we are delegating to the plugin, and it can handle it
169 NoInputs, ///< plugin has no inputs, so anything goes
170 ExactMatch, ///< our insert's inputs are the same as the plugin's
171 Replicate, ///< we have multiple instances of the plugin
172 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
173 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
177 /* disallow copy construction */
178 PluginInsert (const PluginInsert&);
180 void parameter_changed_externally (uint32_t, float);
182 void set_parameter (Evoral::Parameter param, float val);
184 float default_parameter_value (const Evoral::Parameter& param);
186 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
189 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
191 framecnt_t _signal_analysis_collected_nframes;
192 framecnt_t _signal_analysis_collect_nframes_max;
194 BufferSet _signal_analysis_inputs;
195 BufferSet _signal_analysis_outputs;
197 ChanCount midi_bypass;
199 ChanCount _configured_in;
200 ChanCount _configured_out;
203 bool _strict_io_configured;
205 /** Description of how we can match our plugin's IO to our own insert IO */
207 Match () : method (Impossible), plugins (0) {}
208 Match (MatchingMethod m, int32_t p, ChanCount h = ChanCount ()) : method (m), plugins (p), hide (h) {}
210 MatchingMethod method; ///< method to employ
211 int32_t plugins; ///< number of copies of the plugin that we need
212 ChanCount hide; ///< number of channels to hide
215 Match private_can_support_io_configuration (ChanCount const &, ChanCount &);
217 /** details of the match currently being used */
219 std::map <uint32_t, ARDOUR::ChanMapping> _in_map;
220 std::map <uint32_t, ARDOUR::ChanMapping> _out_map;
222 void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
223 void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
225 void create_automatable_parameters ();
226 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
227 void set_parameter_state_2X (const XMLNode& node, int version);
228 void set_control_ids (const XMLNode&, int version);
230 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
231 void add_plugin (boost::shared_ptr<Plugin>);
233 void start_touch (uint32_t param_id);
234 void end_touch (uint32_t param_id);
237 } // namespace ARDOUR
239 #endif /* __ardour_plugin_insert_h__ */