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;
59 int set_state(const XMLNode&, int version);
60 void update_id (PBD::ID);
61 void set_owner (SessionObject*);
62 void set_state_dir (const std::string& d = "");
64 void run (BufferSet& in, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
65 void silence (samplecnt_t nframes, samplepos_t start_sample);
71 void enable (bool yn);
72 bool enabled () const;
73 bool bypassable () const;
75 bool reset_parameters_to_default ();
76 bool can_reset_all_parameters ();
78 bool write_immediate_event (size_t size, const uint8_t* buf);
80 void automation_run (samplepos_t, pframes_t);
81 bool find_next_event (double, double, Evoral::ControlEvent&, bool only_active = true) const;
83 int set_block_size (pframes_t nframes);
85 ChanMapping input_map (uint32_t num) const {
86 if (num < _in_map.size()) {
87 return _in_map.find (num)->second;
89 return ChanMapping ();
93 ChanMapping output_map (uint32_t num) const {
94 if (num < _out_map.size()) {
95 return _out_map.find (num)->second;
97 return ChanMapping ();
101 ChanMapping thru_map () const {
105 bool pre_seed (const ChanCount&, const ChanCount&, const ChanMapping&, const ChanMapping&, const ChanMapping&);
107 ChanMapping input_map () const; ///< combined (all instances) input map
108 ChanMapping no_sc_input_map () const; ///< combined (all instances) input map w/o sidechain sinks
109 ChanMapping output_map () const; ///< combined (all instances) output map
110 bool has_midi_bypass () const;
111 bool has_midi_thru () const;
112 bool inplace () const { return ! _no_inplace; }
115 bool is_channelstrip () const;
118 void set_input_map (uint32_t, ChanMapping);
119 void set_output_map (uint32_t, ChanMapping);
120 void set_thru_map (ChanMapping);
121 bool reset_map (bool emit = true);
122 bool sanitize_maps ();
123 bool check_inplace ();
124 bool configured () const { return _configured; }
126 // these are ports visible on the outside
127 ChanCount output_streams() const;
128 ChanCount input_streams() const;
129 ChanCount internal_streams() const; // with side-chain
131 // actual ports of all plugins.
132 // n * natural_i/o or result of reconfigurable i/o
133 ChanCount internal_output_streams() const;
134 ChanCount internal_input_streams() const;
136 // a single plugin's internal i/o
137 ChanCount natural_output_streams() const;
138 ChanCount natural_input_streams() const;
140 /** plugin ports marked as sidechain */
141 ChanCount sidechain_input_pins() const;
143 /** Plugin-Insert IO sidechain ports */
144 ChanCount sidechain_input_ports() const {
146 return _sidechain->input ()->n_ports ();
152 const ChanCount& required_buffers () const { return _required_buffers; }
153 const ChanCount& preset_out () const { return _preset_out; }
155 // allow to override output_streams(), implies "Custom Mode"
157 // only the owning route may call these (with process lock held)
158 // route is not a friend class, it owns us
159 bool set_count (uint32_t num);
160 void set_sinks (const ChanCount&); // reconfigurable I/O ONLY
161 void set_outputs (const ChanCount&);
162 void set_strict_io (bool b);
163 void set_custom_cfg (bool b);
164 bool set_preset_out (const ChanCount&);
165 bool add_sidechain (uint32_t n_audio = 1, uint32_t n_midi = 0);
166 bool del_sidechain ();
167 void set_sidechain_latency (uint32_t, uint32_t);
168 boost::shared_ptr<SideChain> sidechain () const { return _sidechain; }
169 // end C++ class slavery!
171 uint32_t get_count () const { return _plugins.size(); }
172 bool strict_io () const { return _strict_io; }
173 bool custom_cfg () const { return _custom_cfg; }
175 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
176 bool configure_io (ChanCount in, ChanCount out);
178 bool has_no_inputs() const;
179 bool has_no_audio_inputs() const;
180 bool is_instrument () const;
181 bool has_output_presets (
182 ChanCount in = ChanCount (DataType::MIDI, 1),
183 ChanCount out = ChanCount (DataType::AUDIO, 2)
186 void realtime_handle_transport_stopped ();
187 void realtime_locate ();
188 void monitoring_changed ();
190 bool load_preset (Plugin::PresetRecord);
192 /** A control that manipulates a plugin parameter (control port). */
193 struct PluginControl : public AutomationControl
195 PluginControl (PluginInsert* p,
196 const Evoral::Parameter& param,
197 const ParameterDescriptor& desc,
198 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
200 double get_value (void) const;
201 void catch_up_with_external_value (double val);
202 XMLNode& get_state();
205 PluginInsert* _plugin;
206 void actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
209 /** A control that manipulates a plugin property (message). */
210 struct PluginPropertyControl : public AutomationControl
212 PluginPropertyControl (PluginInsert* p,
213 const Evoral::Parameter& param,
214 const ParameterDescriptor& desc,
215 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
217 double get_value (void) const;
218 XMLNode& get_state();
220 void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
223 PluginInsert* _plugin;
227 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
228 if (num < _plugins.size()) {
229 return _plugins[num];
231 return _plugins[0]; // we always have one
235 samplecnt_t plugin_latency () const;
237 bool has_sidechain () const {
238 return _sidechain ? true : false;
241 boost::shared_ptr<IO> sidechain_input () const {
243 return _sidechain->input ();
245 return boost::shared_ptr<IO> ();
250 boost::shared_ptr<ReadOnlyControl> control_output (uint32_t) const;
252 std::string describe_parameter (Evoral::Parameter param);
254 samplecnt_t signal_latency () const;
256 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
258 void collect_signal_for_analysis (samplecnt_t nframes);
260 bool strict_io_configured () const {
261 return _match.strict_io;
264 bool splitting () const {
265 return _match.method == Split;
268 void configured_io (ChanCount &in, ChanCount &out) const {
270 out = _configured_out;
273 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
274 PBD::Signal0<void> PluginIoReConfigure;
275 PBD::Signal0<void> PluginMapChanged;
276 PBD::Signal0<void> PluginConfigChanged;
278 /** Enumeration of the ways in which we can match our insert's
279 * IO to that of the plugin(s).
281 enum MatchingMethod {
282 Impossible, ///< we can't
283 Delegate, ///< we are delegating to the plugin, and it can handle it
284 NoInputs, ///< plugin has no inputs, so anything goes
285 ExactMatch, ///< our insert's inputs are the same as the plugin's
286 Replicate, ///< we have multiple instances of the plugin
287 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
288 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
291 /** Description of how we can match our plugin's IO to our own insert IO */
293 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
294 Match (MatchingMethod m, int32_t p,
295 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
296 : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
298 MatchingMethod method; ///< method to employ
299 int32_t plugins; ///< number of copies of the plugin that we need
300 ChanCount hide; ///< number of channels to hide
301 bool strict_io; ///< force in == out
302 bool custom_cfg; ///< custom config (if not strict)
309 /* disallow copy construction */
310 PluginInsert (const PluginInsert&);
312 void parameter_changed_externally (uint32_t, float);
314 void set_parameter (Evoral::Parameter param, float val);
316 float default_parameter_value (const Evoral::Parameter& param);
318 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
321 boost::shared_ptr<SideChain> _sidechain;
322 uint32_t _sc_playback_latency;
323 uint32_t _sc_capture_latency;
324 uint32_t _plugin_signal_latency;
326 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
328 samplecnt_t _signal_analysis_collected_nframes;
329 samplecnt_t _signal_analysis_collect_nframes_max;
331 BufferSet _signal_analysis_inputs;
332 BufferSet _signal_analysis_outputs;
334 FixedDelay _delaybuffers;
336 ChanCount _configured_in;
337 ChanCount _configured_internal; // with side-chain
338 ChanCount _configured_out;
339 ChanCount _custom_out;
340 ChanCount _custom_sinks;
341 ChanCount _preset_out;
342 ChanCount _cached_sidechain_pins;
343 ChanCount _required_buffers;
349 bool _maps_from_state;
350 bool _mapping_changed;
352 Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
353 Match internal_can_support_io_configuration (ChanCount const &, ChanCount &) const;
354 Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
356 /** details of the match currently being used */
359 typedef std::map <uint32_t, ARDOUR::ChanMapping> PinMappings;
361 PinMappings _out_map;
362 ChanMapping _thru_map; // out-idx <= in-idx
364 void automate_and_run (BufferSet& bufs, samplepos_t start, samplepos_t end, double speed, pframes_t nframes);
365 void connect_and_run (BufferSet& bufs, samplepos_t start, samplecnt_t end, double speed, pframes_t nframes, samplecnt_t offset, bool with_auto);
366 void bypass (BufferSet& bufs, pframes_t nframes);
367 void inplace_silence_unconnected (BufferSet&, const PinMappings&, samplecnt_t nframes, samplecnt_t offset) const;
369 void create_automatable_parameters ();
370 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
371 void set_parameter_state_2X (const XMLNode& node, int version);
372 void set_control_ids (const XMLNode&, int version);
374 void enable_changed ();
375 void bypassable_changed ();
377 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
378 void add_plugin (boost::shared_ptr<Plugin>);
380 void start_touch (uint32_t param_id);
381 void end_touch (uint32_t param_id);
383 void latency_changed ();
384 bool _latency_changed;
385 uint32_t _bypass_port;
387 typedef std::map<uint32_t, boost::shared_ptr<ReadOnlyControl> >CtrlOutMap;
388 CtrlOutMap _control_outputs;
390 void preset_load_set_value (uint32_t, float);
393 } // namespace ARDOUR
395 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m);
397 #endif /* __ardour_plugin_insert_h__ */