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/fixed_delay.h"
32 #include "ardour/io.h"
33 #include "ardour/types.h"
34 #include "ardour/parameter_descriptor.h"
35 #include "ardour/plugin.h"
36 #include "ardour/processor.h"
37 #include "ardour/sidechain.h"
38 #include "ardour/automation_control.h"
48 /** Plugin inserts: send data through a plugin
50 class LIBARDOUR_API PluginInsert : public Processor
53 PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
56 static const std::string port_automation_node_name;
59 XMLNode& get_state(void);
60 int set_state(const XMLNode&, int version);
61 void update_id (PBD::ID);
62 void set_state_dir (const std::string& d = "");
64 void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
65 void silence (framecnt_t nframes);
71 bool reset_parameters_to_default ();
72 bool can_reset_all_parameters ();
74 int set_block_size (pframes_t nframes);
76 ChanMapping input_map (uint32_t num) const {
77 if (num < _in_map.size()) {
78 return _in_map.find (num)->second;
80 return ChanMapping ();
84 ChanMapping output_map (uint32_t num) const {
85 if (num < _out_map.size()) {
86 return _out_map.find (num)->second;
88 return ChanMapping ();
92 ChanMapping thru_map () const {
96 ChanMapping input_map () const; ///< combined (all instances) input map
97 ChanMapping output_map () const; ///< combined (all instances) output map
98 bool has_midi_bypass () const;
99 bool has_midi_thru () const;
100 bool inplace () const { return ! _no_inplace; }
103 bool is_channelstrip () const;
106 void set_input_map (uint32_t, ChanMapping);
107 void set_output_map (uint32_t, ChanMapping);
108 void set_thru_map (ChanMapping);
109 bool reset_map (bool emit = true);
110 bool sanitize_maps ();
111 bool check_inplace ();
113 // these are ports visible on the outside
114 ChanCount output_streams() const;
115 ChanCount input_streams() const;
116 ChanCount internal_streams() const; // with side-chain
118 // actual ports of all plugins.
119 // n * natural_i/o or result of reconfigurable i/o
120 ChanCount internal_output_streams() const;
121 ChanCount internal_input_streams() const;
123 // a single plugin's internal i/o
124 ChanCount natural_output_streams() const;
125 ChanCount natural_input_streams() const;
127 /** plugin ports marked as sidechain */
128 ChanCount sidechain_input_pins() const;
130 /** Plugin-Insert IO sidechain ports */
131 ChanCount sidechain_input_ports() const {
133 return _sidechain->input ()->n_ports ();
139 const ChanCount& required_buffers () const { return _required_buffers; }
140 const ChanCount& preset_out () const { return _preset_out; }
142 // allow to override output_streams(), implies "Custom Mode"
144 // only the owning route may call these (with process lock held)
145 // route is not a friend class, it owns us
146 bool set_count (uint32_t num);
147 void set_outputs (const ChanCount&);
148 void set_strict_io (bool b);
149 void set_custom_cfg (bool b);
150 bool set_preset_out (const ChanCount&);
151 bool add_sidechain (uint32_t n_audio = 1);
152 bool del_sidechain ();
153 boost::shared_ptr<SideChain> sidechain () const { return _sidechain; }
154 // end C++ class slavery!
156 uint32_t get_count () const { return _plugins.size(); }
157 bool strict_io () const { return _strict_io; }
158 bool custom_cfg () const { return _custom_cfg; }
160 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
161 bool configure_io (ChanCount in, ChanCount out);
163 bool has_no_inputs() const;
164 bool has_no_audio_inputs() const;
165 bool needs_midi_input() const;
167 void realtime_handle_transport_stopped ();
168 void realtime_locate ();
169 void monitoring_changed ();
171 bool load_preset (Plugin::PresetRecord);
173 /** A control that manipulates a plugin parameter (control port). */
174 struct PluginControl : public AutomationControl
176 PluginControl (PluginInsert* p,
177 const Evoral::Parameter& param,
178 const ParameterDescriptor& desc,
179 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
181 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
182 void set_value_unchecked (double);
183 double get_value (void) const;
184 void catch_up_with_external_value (double val);
185 XMLNode& get_state();
188 PluginInsert* _plugin;
189 void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
192 /** A control that manipulates a plugin property (message). */
193 struct PluginPropertyControl : public AutomationControl
195 PluginPropertyControl (PluginInsert* p,
196 const Evoral::Parameter& param,
197 const ParameterDescriptor& desc,
198 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
200 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
201 void set_value_unchecked (double);
202 double get_value (void) const;
203 XMLNode& get_state();
206 PluginInsert* _plugin;
210 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
211 if (num < _plugins.size()) {
212 return _plugins[num];
214 return _plugins[0]; // we always have one
218 framecnt_t plugin_latency () const;
220 bool has_sidechain () const {
221 return _sidechain ? true : false;
224 boost::shared_ptr<IO> sidechain_input () const {
226 return _sidechain->input ();
228 return boost::shared_ptr<IO> ();
233 std::string describe_parameter (Evoral::Parameter param);
235 framecnt_t signal_latency () const;
237 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
239 void collect_signal_for_analysis (framecnt_t nframes);
241 bool strict_io_configured () const {
242 return _match.strict_io;
245 bool splitting () const {
246 return _match.method == Split;
249 void configured_io (ChanCount &in, ChanCount &out) const {
251 out = _configured_out;
254 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
255 PBD::Signal0<void> PluginIoReConfigure;
256 PBD::Signal0<void> PluginMapChanged;
257 PBD::Signal0<void> PluginConfigChanged;
259 /** Enumeration of the ways in which we can match our insert's
260 * IO to that of the plugin(s).
262 enum MatchingMethod {
263 Impossible, ///< we can't
264 Delegate, ///< we are delegating to the plugin, and it can handle it
265 NoInputs, ///< plugin has no inputs, so anything goes
266 ExactMatch, ///< our insert's inputs are the same as the plugin's
267 Replicate, ///< we have multiple instances of the plugin
268 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
269 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
272 /** Description of how we can match our plugin's IO to our own insert IO */
274 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
275 Match (MatchingMethod m, int32_t p,
276 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
277 : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
279 MatchingMethod method; ///< method to employ
280 int32_t plugins; ///< number of copies of the plugin that we need
281 ChanCount hide; ///< number of channels to hide
282 bool strict_io; ///< force in == out
283 bool custom_cfg; ///< custom config (if not strict)
287 /* disallow copy construction */
288 PluginInsert (const PluginInsert&);
290 void parameter_changed_externally (uint32_t, float);
292 void set_parameter (Evoral::Parameter param, float val);
294 float default_parameter_value (const Evoral::Parameter& param);
296 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
299 boost::shared_ptr<SideChain> _sidechain;
301 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
303 framecnt_t _signal_analysis_collected_nframes;
304 framecnt_t _signal_analysis_collect_nframes_max;
306 BufferSet _signal_analysis_inputs;
307 BufferSet _signal_analysis_outputs;
309 FixedDelay _delaybuffers;
311 ChanCount _configured_in;
312 ChanCount _configured_internal; // with side-chain
313 ChanCount _configured_out;
314 ChanCount _custom_out;
315 ChanCount _preset_out;
316 ChanCount _cached_sidechain_pins;
317 ChanCount _required_buffers;
323 bool _maps_from_state;
324 bool _mapping_changed;
326 Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
327 Match internal_can_support_io_configuration (ChanCount const &, ChanCount &) const;
328 Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
330 /** details of the match currently being used */
333 typedef std::map <uint32_t, ARDOUR::ChanMapping> PinMappings;
335 PinMappings _out_map;
336 ChanMapping _thru_map; // out-idx <= in-idx
338 void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
339 void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
341 void create_automatable_parameters ();
342 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
343 void set_parameter_state_2X (const XMLNode& node, int version);
344 void set_control_ids (const XMLNode&, int version);
346 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
347 void add_plugin (boost::shared_ptr<Plugin>);
349 void start_touch (uint32_t param_id);
350 void end_touch (uint32_t param_id);
352 void latency_changed (framecnt_t, framecnt_t);
353 bool _latency_changed;
356 } // namespace ARDOUR
358 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m);
360 #endif /* __ardour_plugin_insert_h__ */