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/io.h"
32 #include "ardour/types.h"
33 #include "ardour/parameter_descriptor.h"
34 #include "ardour/processor.h"
35 #include "ardour/sidechain.h"
36 #include "ardour/automation_control.h"
46 /** Plugin inserts: send data through a plugin
48 class LIBARDOUR_API PluginInsert : public Processor
51 PluginInsert (Session&, boost::shared_ptr<Plugin> = boost::shared_ptr<Plugin>());
54 static const std::string port_automation_node_name;
57 XMLNode& get_state(void);
58 int set_state(const XMLNode&, int version);
59 void update_id (PBD::ID);
60 void set_state_dir (const std::string& d = "");
62 void run (BufferSet& in, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
63 void silence (framecnt_t nframes);
69 bool reset_parameters_to_default ();
70 bool can_reset_all_parameters ();
72 int set_block_size (pframes_t nframes);
74 ChanMapping input_map (uint32_t num) const {
75 if (num < _in_map.size()) {
76 return _in_map.find (num)->second;
78 return ChanMapping ();
82 ChanMapping output_map (uint32_t num) const {
83 if (num < _out_map.size()) {
84 return _out_map.find (num)->second;
86 return ChanMapping ();
90 ChanMapping input_map () const;
91 ChanMapping output_map () const;
92 bool has_midi_bypass () const;
94 void set_input_map (uint32_t, ChanMapping);
95 void set_output_map (uint32_t, ChanMapping);
96 bool reset_map (bool emit = true);
97 bool sanitize_maps ();
99 // these are ports visible on the outside
100 ChanCount output_streams() const;
101 ChanCount input_streams() const;
102 ChanCount internal_streams() const; // with side-chain
104 // actual ports of all plugins.
105 // n * natural_i/o or result of reconfigurable i/o
106 ChanCount internal_output_streams() const;
107 ChanCount internal_input_streams() const;
109 // a single plugin's internal i/o
110 ChanCount natural_output_streams() const;
111 ChanCount natural_input_streams() const;
113 /** plugin ports marked as sidechain */
114 ChanCount sidechain_input_pins() const;
116 /** Plugin-Insert IO sidechain ports */
117 ChanCount sidechain_input_ports() const {
119 return _sidechain->input ()->n_ports ();
125 // allow to override output_streams(), implies "Custom Mode"
127 // only the owning route may call these (with process lock held)
128 // route is not a friend class, it owns us
129 bool set_count (uint32_t num);
130 void set_outputs (const ChanCount&);
131 void set_strict_io (bool b);
132 void set_custom_cfg (bool b);
133 bool add_sidechain (uint32_t n_audio = 1);
134 bool del_sidechain ();
135 boost::shared_ptr<SideChain> sidechain () const { return _sidechain; }
136 // end C++ class slavery!
138 uint32_t get_count () const { return _plugins.size(); }
139 bool strict_io () const { return _strict_io; }
140 bool custom_cfg () const { return _custom_cfg; }
142 bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
143 bool configure_io (ChanCount in, ChanCount out);
145 bool has_no_inputs() const;
146 bool has_no_audio_inputs() const;
147 bool is_midi_instrument() const;
149 void realtime_handle_transport_stopped ();
150 void realtime_locate ();
151 void monitoring_changed ();
153 /** A control that manipulates a plugin parameter (control port). */
154 struct PluginControl : public AutomationControl
156 PluginControl (PluginInsert* p,
157 const Evoral::Parameter& param,
158 const ParameterDescriptor& desc,
159 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
161 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
162 void set_value_unchecked (double);
163 double get_value (void) const;
164 void catch_up_with_external_value (double val);
165 XMLNode& get_state();
168 PluginInsert* _plugin;
169 void _set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
172 /** A control that manipulates a plugin property (message). */
173 struct PluginPropertyControl : public AutomationControl
175 PluginPropertyControl (PluginInsert* p,
176 const Evoral::Parameter& param,
177 const ParameterDescriptor& desc,
178 boost::shared_ptr<AutomationList> list=boost::shared_ptr<AutomationList>());
180 void set_value (double val, PBD::Controllable::GroupControlDisposition group_override);
181 void set_value_unchecked (double);
182 double get_value (void) const;
183 XMLNode& get_state();
186 PluginInsert* _plugin;
190 boost::shared_ptr<Plugin> plugin(uint32_t num=0) const {
191 if (num < _plugins.size()) {
192 return _plugins[num];
194 return _plugins[0]; // we always have one
198 bool has_sidechain () const {
199 return _sidechain ? true : false;
202 boost::shared_ptr<IO> sidechain_input () const {
204 return _sidechain->input ();
206 return boost::shared_ptr<IO> ();
211 std::string describe_parameter (Evoral::Parameter param);
213 framecnt_t signal_latency () const;
215 boost::shared_ptr<Plugin> get_impulse_analysis_plugin();
217 void collect_signal_for_analysis (framecnt_t nframes);
219 bool strict_io_configured () const {
220 return _match.strict_io;
223 bool splitting () const {
224 return _match.method == Split;
227 void configured_io (ChanCount &in, ChanCount &out) const {
229 out = _configured_out;
232 PBD::Signal2<void,BufferSet*, BufferSet*> AnalysisDataGathered;
233 PBD::Signal0<void> PluginIoReConfigure;
234 PBD::Signal0<void> PluginMapChanged;
235 PBD::Signal0<void> PluginConfigChanged;
237 /** Enumeration of the ways in which we can match our insert's
238 * IO to that of the plugin(s).
240 enum MatchingMethod {
241 Impossible, ///< we can't
242 Delegate, ///< we are delegating to the plugin, and it can handle it
243 NoInputs, ///< plugin has no inputs, so anything goes
244 ExactMatch, ///< our insert's inputs are the same as the plugin's
245 Replicate, ///< we have multiple instances of the plugin
246 Split, ///< we copy one of our insert's inputs to multiple plugin inputs
247 Hide, ///< we `hide' some of the plugin's inputs by feeding them silence
250 /** Description of how we can match our plugin's IO to our own insert IO */
252 Match () : method (Impossible), plugins (0), strict_io (false), custom_cfg (false) {}
253 Match (MatchingMethod m, int32_t p,
254 bool strict = false, bool custom = false, ChanCount h = ChanCount ())
255 : method (m), plugins (p), hide (h), strict_io (strict), custom_cfg (custom) {}
257 MatchingMethod method; ///< method to employ
258 int32_t plugins; ///< number of copies of the plugin that we need
259 ChanCount hide; ///< number of channels to hide
260 bool strict_io; ///< force in == out
261 bool custom_cfg; ///< custom config (if not strict)
265 /* disallow copy construction */
266 PluginInsert (const PluginInsert&);
268 void parameter_changed_externally (uint32_t, float);
270 void set_parameter (Evoral::Parameter param, float val);
272 float default_parameter_value (const Evoral::Parameter& param);
274 typedef std::vector<boost::shared_ptr<Plugin> > Plugins;
277 boost::shared_ptr<SideChain> _sidechain;
279 boost::weak_ptr<Plugin> _impulseAnalysisPlugin;
281 framecnt_t _signal_analysis_collected_nframes;
282 framecnt_t _signal_analysis_collect_nframes_max;
284 BufferSet _signal_analysis_inputs;
285 BufferSet _signal_analysis_outputs;
287 ChanCount _configured_in;
288 ChanCount _configured_internal; // with side-chain
289 ChanCount _configured_out;
290 ChanCount _custom_out;
291 ChanCount _cached_sidechain_pins;
297 bool _maps_from_state;
299 Match private_can_support_io_configuration (ChanCount const &, ChanCount &) const;
300 Match automatic_can_support_io_configuration (ChanCount const &, ChanCount &) const;
302 /** details of the match currently being used */
305 typedef std::map <uint32_t, ARDOUR::ChanMapping> PinMappings;
307 PinMappings _out_map;
309 void automation_run (BufferSet& bufs, framepos_t start, pframes_t nframes);
310 void connect_and_run (BufferSet& bufs, pframes_t nframes, framecnt_t offset, bool with_auto, framepos_t now = 0);
312 void create_automatable_parameters ();
313 void control_list_automation_state_changed (Evoral::Parameter, AutoState);
314 void set_parameter_state_2X (const XMLNode& node, int version);
315 void set_control_ids (const XMLNode&, int version);
317 boost::shared_ptr<Plugin> plugin_factory (boost::shared_ptr<Plugin>);
318 void add_plugin (boost::shared_ptr<Plugin>);
320 void start_touch (uint32_t param_id);
321 void end_touch (uint32_t param_id);
324 } // namespace ARDOUR
326 std::ostream& operator<<(std::ostream& o, const ARDOUR::PluginInsert::Match& m);
328 #endif /* __ardour_plugin_insert_h__ */