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/readonly_control.h"
38 #include "ardour/sidechain.h"
39 #include "ardour/automation_control.h"
49 /** Plugin inserts: send data through a plugin
51 class LIBARDOUR_API PluginInsert : public Processor
54 PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
57 static const std::string port_automation_node_name;
60 XMLNode& get_state(void);
61 int set_state(const XMLNode&, int version);
62 void update_id (PBD::ID);
63 void set_owner (SessionObject*);
64 void set_state_dir (const std::string& d = "");
66 void run (BufferSet& in, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
67 void silence (samplecnt_t nframes, samplepos_t start_sample);
73 void enable (bool yn);
74 bool enabled () const;
75 bool bypassable () const;
77 bool reset_parameters_to_default ();
78 bool can_reset_all_parameters ();
80 bool write_immediate_event (size_t size, const uint8_t* buf);
82 int set_block_size (pframes_t nframes);
84 ChanMapping input_map (uint32_t num) const {
85 if (num < _in_map.size()) {
86 return _in_map.find (num)->second;
88 return ChanMapping ();
92 ChanMapping output_map (uint32_t num) const {
93 if (num < _out_map.size()) {
94 return _out_map.find (num)->second;
96 return ChanMapping ();
100 ChanMapping thru_map () const {
104 bool pre_seed (const ChanCount&, const ChanCount&, const ChanMapping&, const ChanMapping&, const ChanMapping&);
106 ChanMapping input_map () const; ///< combined (all instances) input map
107 ChanMapping no_sc_input_map () const; ///< combined (all instances) input map w/o sidechain sinks
108 ChanMapping output_map () const; ///< combined (all instances) output map
109 bool has_midi_bypass () const;
110 bool has_midi_thru () const;
111 bool inplace () const { return ! _no_inplace; }
114 bool is_channelstrip () const;
117 void set_input_map (uint32_t, ChanMapping);
118 void set_output_map (uint32_t, ChanMapping);
119 void set_thru_map (ChanMapping);
120 bool reset_map (bool emit = true);
121 bool sanitize_maps ();
122 bool check_inplace ();
123 bool configured () const { return _configured; }
125 // these are ports visible on the outside
126 ChanCount output_streams() const;
127 ChanCount input_streams() const;
128 ChanCount internal_streams() const; // with side-chain
130 // actual ports of all plugins.
131 // n * natural_i/o or result of reconfigurable i/o
132 ChanCount internal_output_streams() const;
133 ChanCount internal_input_streams() const;
135 // a single plugin's internal i/o
136 ChanCount natural_output_streams() const;
137 ChanCount natural_input_streams() const;
139 /** plugin ports marked as sidechain */
140 ChanCount sidechain_input_pins() const;
142 /** Plugin-Insert IO sidechain ports */
143 ChanCount sidechain_input_ports() const {
145 return _sidechain->input ()->n_ports ();
151 const ChanCount& required_buffers () const { return _required_buffers; }
152 const ChanCount& preset_out () const { return _preset_out; }
154 // allow to override output_streams(), implies "Custom Mode"
156 // only the owning route may call these (with process lock held)
157 // route is not a friend class, it owns us
158 bool set_count (uint32_t num);
159 void set_sinks (const ChanCount&); // reconfigurable I/O ONLY
160 void set_outputs (const ChanCount&);
161 void set_strict_io (bool b);
162 void set_custom_cfg (bool b);
163 bool set_preset_out (const ChanCount&);
164 bool add_sidechain (uint32_t n_audio = 1, uint32_t n_midi = 0);
165 bool del_sidechain ();
166 void set_sidechain_latency (uint32_t, uint32_t);
167 boost::shared_ptr<SideChain> sidechain () const { return _sidechain; }
168 // end C++ class slavery!
170 uint32_t get_count () const { return _plugins.size(); }
171 bool strict_io () const { return _strict_io; }
172 bool custom_cfg () const { return _custom_cfg; }
174 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
175 bool configure_io (ChanCount in, ChanCount out);
177 bool has_no_inputs() const;
178 bool has_no_audio_inputs() const;
179 bool is_instrument () const;
180 bool has_output_presets (
181 ChanCount in = ChanCount (DataType::MIDI, 1),
182 ChanCount out = ChanCount (DataType::AUDIO, 2)
185 void realtime_handle_transport_stopped ();
186 void realtime_locate ();
187 void monitoring_changed ();
189 bool load_preset (Plugin::PresetRecord);
191 /** A control that manipulates a plugin parameter (control port). */
192 struct PluginControl : public AutomationControl
194 PluginControl (PluginInsert* p,
195 const Evoral::Parameter& param,
196 const ParameterDescriptor& desc,
197 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
199 double get_value (void) const;
200 void catch_up_with_external_value (double val);
201 XMLNode& get_state();
204 PluginInsert* _plugin;
205 void actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
208 /** A control that manipulates a plugin property (message). */
209 struct PluginPropertyControl : public AutomationControl
211 PluginPropertyControl (PluginInsert* p,
212 const Evoral::Parameter& param,
213 const ParameterDescriptor& desc,
214 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
216 double get_value (void) const;
217 XMLNode& get_state();
219 void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
222 PluginInsert* _plugin;
226 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
227 if (num < _plugins.size()) {
228 return _plugins[num];
230 return _plugins[0]; // we always have one
234 samplecnt_t plugin_latency () const;
236 bool has_sidechain () const {
237 return _sidechain ? true : false;
240 boost::shared_ptr<IO> sidechain_input () const {
242 return _sidechain->input ();
244 return boost::shared_ptr<IO> ();
249 boost::shared_ptr<ReadOnlyControl> control_output (uint32_t) const;
251 std::string describe_parameter (Evoral::Parameter param);
253 samplecnt_t signal_latency () const;
255 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
257 void collect_signal_for_analysis (samplecnt_t nframes);
259 bool strict_io_configured () const {
260 return _match.strict_io;
263 bool splitting () const {
264 return _match.method == Split;
267 void configured_io (ChanCount &in, ChanCount &out) const {
269 out = _configured_out;
272 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
273 PBD::Signal0<void> PluginIoReConfigure;
274 PBD::Signal0<void> PluginMapChanged;
275 PBD::Signal0<void> PluginConfigChanged;
277 /** Enumeration of the ways in which we can match our insert's
278 * IO to that of the plugin(s).
280 enum MatchingMethod {
281 Impossible, ///< we can't
282 Delegate, ///< we are delegating to the plugin, and it can handle it
283 NoInputs, ///< plugin has no inputs, so anything goes
284 ExactMatch, ///< our insert's inputs are the same as the plugin's
285 Replicate, ///< we have multiple instances of the plugin
286 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
287 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
290 /** Description of how we can match our plugin's IO to our own insert IO */
292 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
293 Match (MatchingMethod m, int32_t p,
294 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
295 : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
297 MatchingMethod method; ///< method to employ
298 int32_t plugins; ///< number of copies of the plugin that we need
299 ChanCount hide; ///< number of channels to hide
300 bool strict_io; ///< force in == out
301 bool custom_cfg; ///< custom config (if not strict)
305 /* disallow copy construction */
306 PluginInsert (const PluginInsert&);
308 void parameter_changed_externally (uint32_t, float);
310 void set_parameter (Evoral::Parameter param, float val);
312 float default_parameter_value (const Evoral::Parameter& param);
314 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
317 boost::shared_ptr<SideChain> _sidechain;
318 uint32_t _sc_playback_latency;
319 uint32_t _sc_capture_latency;
320 uint32_t _plugin_signal_latency;
322 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
324 samplecnt_t _signal_analysis_collected_nframes;
325 samplecnt_t _signal_analysis_collect_nframes_max;
327 BufferSet _signal_analysis_inputs;
328 BufferSet _signal_analysis_outputs;
330 FixedDelay _delaybuffers;
332 ChanCount _configured_in;
333 ChanCount _configured_internal; // with side-chain
334 ChanCount _configured_out;
335 ChanCount _custom_out;
336 ChanCount _custom_sinks;
337 ChanCount _preset_out;
338 ChanCount _cached_sidechain_pins;
339 ChanCount _required_buffers;
345 bool _maps_from_state;
346 bool _mapping_changed;
348 Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
349 Match internal_can_support_io_configuration (ChanCount const &, ChanCount &) const;
350 Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
352 /** details of the match currently being used */
355 typedef std::map <uint32_t, ARDOUR::ChanMapping> PinMappings;
357 PinMappings _out_map;
358 ChanMapping _thru_map; // out-idx <= in-idx
360 void automate_and_run (BufferSet& bufs, samplepos_t start, samplepos_t end, double speed, pframes_t nframes);
361 void connect_and_run (BufferSet& bufs, samplepos_t start, samplecnt_t end, double speed, pframes_t nframes, samplecnt_t offset, bool with_auto);
362 void bypass (BufferSet& bufs, pframes_t nframes);
363 void inplace_silence_unconnected (BufferSet&, const PinMappings&, samplecnt_t nframes, samplecnt_t offset) const;
365 void create_automatable_parameters ();
366 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
367 void set_parameter_state_2X (const XMLNode& node, int version);
368 void set_control_ids (const XMLNode&, int version);
370 void enable_changed ();
371 void bypassable_changed ();
373 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
374 void add_plugin (boost::shared_ptr<Plugin>);
376 void start_touch (uint32_t param_id);
377 void end_touch (uint32_t param_id);
379 void latency_changed ();
380 bool _latency_changed;
381 uint32_t _bypass_port;
383 typedef std::map<uint32_t, boost::shared_ptr<ReadOnlyControl> >CtrlOutMap;
384 CtrlOutMap _control_outputs;
386 void preset_load_set_value (uint32_t, float);
389 } // namespace ARDOUR
391 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m);
393 #endif /* __ardour_plugin_insert_h__ */