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 "pbd/timing.h"
30 #include "ardour/ardour.h"
31 #include "ardour/libardour_visibility.h"
32 #include "ardour/chan_mapping.h"
33 #include "ardour/fixed_delay.h"
34 #include "ardour/io.h"
35 #include "ardour/types.h"
36 #include "ardour/parameter_descriptor.h"
37 #include "ardour/plugin.h"
38 #include "ardour/processor.h"
39 #include "ardour/readonly_control.h"
40 #include "ardour/sidechain.h"
41 #include "ardour/automation_control.h"
51 /** Plugin inserts: send data through a plugin
53 class LIBARDOUR_API PluginInsert : public Processor
56 PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
59 static const std::string port_automation_node_name;
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 void automation_run (samplepos_t, pframes_t);
83 bool find_next_event (double, double, Evoral::ControlEvent&, bool only_active = true) const;
85 int set_block_size (pframes_t nframes);
87 ChanMapping input_map (uint32_t num) const {
88 if (num < _in_map.size()) {
89 return _in_map.find (num)->second;
91 return ChanMapping ();
95 ChanMapping output_map (uint32_t num) const {
96 if (num < _out_map.size()) {
97 return _out_map.find (num)->second;
99 return ChanMapping ();
103 ChanMapping thru_map () const {
107 bool pre_seed (const ChanCount&, const ChanCount&, const ChanMapping&, const ChanMapping&, const ChanMapping&);
109 ChanMapping input_map () const; ///< combined (all instances) input map
110 ChanMapping no_sc_input_map () const; ///< combined (all instances) input map w/o sidechain sinks
111 ChanMapping output_map () const; ///< combined (all instances) output map
112 bool has_midi_bypass () const;
113 bool has_midi_thru () const;
114 bool inplace () const { return ! _no_inplace; }
117 bool is_channelstrip () const;
118 bool is_nonbypassable () const;
120 bool is_channelstrip () const { return false; }
121 bool is_nonbypassable () const { return false; }
124 void set_input_map (uint32_t, ChanMapping);
125 void set_output_map (uint32_t, ChanMapping);
126 void set_thru_map (ChanMapping);
127 bool reset_map (bool emit = true);
128 bool sanitize_maps ();
129 bool check_inplace ();
130 bool configured () const { return _configured; }
132 // these are ports visible on the outside
133 ChanCount output_streams() const;
134 ChanCount input_streams() const;
135 ChanCount internal_streams() const; // with side-chain
137 // actual ports of all plugins.
138 // n * natural_i/o or result of reconfigurable i/o
139 ChanCount internal_output_streams() const;
140 ChanCount internal_input_streams() const;
142 // a single plugin's internal i/o
143 ChanCount natural_output_streams() const;
144 ChanCount natural_input_streams() const;
146 /** plugin ports marked as sidechain */
147 ChanCount sidechain_input_pins() const;
149 /** Plugin-Insert IO sidechain ports */
150 ChanCount sidechain_input_ports() const {
152 return _sidechain->input ()->n_ports ();
158 const ChanCount& required_buffers () const { return _required_buffers; }
159 const ChanCount& preset_out () const { return _preset_out; }
161 // allow to override output_streams(), implies "Custom Mode"
163 // only the owning route may call these (with process lock held)
164 // route is not a friend class, it owns us
165 bool set_count (uint32_t num);
166 void set_sinks (const ChanCount&); // reconfigurable I/O ONLY
167 void set_outputs (const ChanCount&);
168 void set_strict_io (bool b);
169 void set_custom_cfg (bool b);
170 bool set_preset_out (const ChanCount&);
171 bool add_sidechain (uint32_t n_audio = 1, uint32_t n_midi = 0);
172 bool del_sidechain ();
173 void update_sidechain_name ();
174 boost::shared_ptr<SideChain> sidechain () const { return _sidechain; }
175 // end C++ class slavery!
177 uint32_t get_count () const { return _plugins.size(); }
178 bool strict_io () const { return _strict_io; }
179 bool custom_cfg () const { return _custom_cfg; }
181 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
182 bool configure_io (ChanCount in, ChanCount out);
184 bool has_no_inputs() const;
185 bool has_no_audio_inputs() const;
187 bool is_instrument () const;
189 bool has_output_presets (
190 ChanCount in = ChanCount (DataType::MIDI, 1),
191 ChanCount out = ChanCount (DataType::AUDIO, 2)
194 void realtime_handle_transport_stopped ();
195 void realtime_locate ();
196 void monitoring_changed ();
198 bool load_preset (Plugin::PresetRecord);
200 bool get_stats (uint64_t& min, uint64_t& max, double& avg, double& dev) const;
203 /** A control that manipulates a plugin parameter (control port). */
204 struct PluginControl : public AutomationControl
206 PluginControl (PluginInsert* p,
207 const Evoral::Parameter& param,
208 const ParameterDescriptor& desc,
209 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
211 double get_value (void) const;
212 void catch_up_with_external_value (double val);
213 XMLNode& get_state();
216 PluginInsert* _plugin;
217 void actually_set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
220 /** A control that manipulates a plugin property (message). */
221 struct PluginPropertyControl : public AutomationControl
223 PluginPropertyControl (PluginInsert* p,
224 const Evoral::Parameter& param,
225 const ParameterDescriptor& desc,
226 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
228 double get_value (void) const;
229 XMLNode& get_state();
231 void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
234 PluginInsert* _plugin;
238 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
239 if (num < _plugins.size()) {
240 return _plugins[num];
242 return _plugins[0]; // we always have one
246 samplecnt_t plugin_latency () const;
248 bool has_sidechain () const {
249 return _sidechain ? true : false;
252 boost::shared_ptr<IO> sidechain_input () const {
254 return _sidechain->input ();
256 return boost::shared_ptr<IO> ();
261 boost::shared_ptr<ReadOnlyControl> control_output (uint32_t) const;
263 std::string describe_parameter (Evoral::Parameter param);
265 samplecnt_t signal_latency () const;
267 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
269 void collect_signal_for_analysis (samplecnt_t nframes);
271 bool strict_io_configured () const {
272 return _match.strict_io;
275 bool splitting () const {
276 return _match.method == Split;
279 void configured_io (ChanCount &in, ChanCount &out) const {
281 out = _configured_out;
284 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
285 PBD::Signal0<void> PluginIoReConfigure;
286 PBD::Signal0<void> PluginMapChanged;
287 PBD::Signal0<void> PluginConfigChanged;
289 /** Enumeration of the ways in which we can match our insert's
290 * IO to that of the plugin(s).
292 enum MatchingMethod {
293 Impossible, ///< we can't
294 Delegate, ///< we are delegating to the plugin, and it can handle it
295 NoInputs, ///< plugin has no inputs, so anything goes
296 ExactMatch, ///< our insert's inputs are the same as the plugin's
297 Replicate, ///< we have multiple instances of the plugin
298 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
299 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
302 /** Description of how we can match our plugin's IO to our own insert IO */
304 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
305 Match (MatchingMethod m, int32_t p,
306 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
307 : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
309 MatchingMethod method; ///< method to employ
310 int32_t plugins; ///< number of copies of the plugin that we need
311 ChanCount hide; ///< number of channels to hide
312 bool strict_io; ///< force in == out
313 bool custom_cfg; ///< custom config (if not strict)
320 /* disallow copy construction */
321 PluginInsert (const PluginInsert&);
323 void parameter_changed_externally (uint32_t, float);
325 void set_parameter (Evoral::Parameter param, float val);
327 float default_parameter_value (const Evoral::Parameter& param);
329 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
332 boost::shared_ptr<SideChain> _sidechain;
333 uint32_t _sc_playback_latency;
334 uint32_t _sc_capture_latency;
335 uint32_t _plugin_signal_latency;
337 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
339 samplecnt_t _signal_analysis_collected_nframes;
340 samplecnt_t _signal_analysis_collect_nframes_max;
342 BufferSet _signal_analysis_inputs;
343 BufferSet _signal_analysis_outputs;
345 FixedDelay _delaybuffers;
347 ChanCount _configured_in;
348 ChanCount _configured_internal; // with side-chain
349 ChanCount _configured_out;
350 ChanCount _custom_out;
351 ChanCount _custom_sinks;
352 ChanCount _preset_out;
353 ChanCount _cached_sidechain_pins;
354 ChanCount _required_buffers;
360 bool _maps_from_state;
361 bool _mapping_changed;
363 Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
364 Match internal_can_support_io_configuration (ChanCount const &, ChanCount &) const;
365 Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
367 /** details of the match currently being used */
370 /* ordered map [plugin instance ID] => ARDOUR::ChanMapping
371 * TODO: consider replacing with boost::flat_map<> or std::vector<>.
373 class PinMappings : public std::map <uint32_t, ARDOUR::ChanMapping> {
375 /* this emulates C++11's std::map::at()
376 * return mapping for given plugin instance */
377 inline ARDOUR::ChanMapping const& p (const uint32_t i) const {
379 const_iterator x = find (i);
380 assert (x != end ());
383 return find(i)->second;
389 PinMappings _out_map;
390 ChanMapping _thru_map; // out-idx <= in-idx
392 void automate_and_run (BufferSet& bufs, samplepos_t start, samplepos_t end, double speed, pframes_t nframes);
393 void connect_and_run (BufferSet& bufs, samplepos_t start, samplecnt_t end, double speed, pframes_t nframes, samplecnt_t offset, bool with_auto);
394 void bypass (BufferSet& bufs, pframes_t nframes);
395 void inplace_silence_unconnected (BufferSet&, const PinMappings&, samplecnt_t nframes, samplecnt_t offset) const;
397 void create_automatable_parameters ();
398 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
399 void set_parameter_state_2X (const XMLNode& node, int version);
400 void set_control_ids (const XMLNode&, int version);
402 void enable_changed ();
403 void bypassable_changed ();
405 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
406 void add_plugin (boost::shared_ptr<Plugin>);
408 void add_sidechain_from_xml (const XMLNode& node, int version);
410 void start_touch (uint32_t param_id);
411 void end_touch (uint32_t param_id);
413 void latency_changed ();
414 bool _latency_changed;
415 uint32_t _bypass_port;
417 typedef std::map<uint32_t, boost::shared_ptr<ReadOnlyControl> >CtrlOutMap;
418 CtrlOutMap _control_outputs;
420 void preset_load_set_value (uint32_t, float);
422 PBD::TimingStats _timing_stats;
423 volatile gint _stat_reset;
426 } // namespace ARDOUR
428 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m);
430 #endif /* __ardour_plugin_insert_h__ */