2 Copyright (C) 2008-2012 Paul Davis
3 Author: David Robillard
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_lv2_plugin_h__
21 #define __ardour_lv2_plugin_h__
26 #include <boost/enable_shared_from_this.hpp>
28 #include "ardour/plugin.h"
29 #include "ardour/uri_map.h"
30 #include "ardour/worker.h"
31 #include "pbd/ringbuffer.h"
33 #ifdef LV2_EXTENDED // -> needs to eventually go upstream to lv2plug.in
34 #include "ardour/lv2_extensions.h"
41 typedef struct LV2_Evbuf_Impl LV2_Evbuf;
45 // a callback function for lilv_state_new_from_instance(). friend of LV2Plugin
46 // so we can pass an LV2Plugin* in user_data and access its private members.
47 const void* lv2plugin_get_port_value(const char* port_symbol,
55 class LIBARDOUR_API LV2Plugin : public ARDOUR::Plugin, public ARDOUR::Workee
58 LV2Plugin (ARDOUR::AudioEngine& engine,
59 ARDOUR::Session& session,
61 framecnt_t sample_rate);
62 LV2Plugin (const LV2Plugin &);
65 std::string unique_id () const;
66 const char* uri () const;
67 const char* label () const;
68 const char* name () const;
69 const char* maker () const;
71 uint32_t num_ports () const;
72 uint32_t parameter_count () const;
73 float default_value (uint32_t port);
74 framecnt_t max_latency () const;
75 framecnt_t signal_latency () const;
76 void set_parameter (uint32_t port, float val);
77 float get_parameter (uint32_t port) const;
78 std::string get_docs() const;
79 std::string get_parameter_docs(uint32_t which) const;
80 int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
81 uint32_t nth_parameter (uint32_t port, bool& ok) const;
83 IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
85 const void* extension_data (const char* uri) const;
87 const void* c_plugin();
89 const void* c_ui_type();
91 bool is_external_ui () const;
92 bool is_external_kx () const;
93 bool ui_is_resizable () const;
95 const char* port_symbol (uint32_t port) const;
96 uint32_t port_index (const char* symbol) const;
98 const LV2_Feature* const* features () { return _features; }
100 std::set<Evoral::Parameter> automatable () const;
101 virtual void set_automation_control (uint32_t, boost::shared_ptr<AutomationControl>);
107 int set_block_size (pframes_t);
108 bool requires_fixed_sized_buffers () const;
110 int connect_and_run (BufferSet& bufs,
111 framepos_t start, framepos_t end, double speed,
112 ChanMapping in, ChanMapping out,
113 pframes_t nframes, framecnt_t offset);
115 std::string describe_parameter (Evoral::Parameter);
116 std::string state_node_name () const { return "lv2"; }
118 void print_parameter (uint32_t param,
122 bool parameter_is_audio (uint32_t) const;
123 bool parameter_is_control (uint32_t) const;
124 bool parameter_is_event (uint32_t) const;
125 bool parameter_is_input (uint32_t) const;
126 bool parameter_is_output (uint32_t) const;
127 bool parameter_is_toggled (uint32_t) const;
129 uint32_t designated_bypass_port ();
131 boost::shared_ptr<ScalePoints>
132 get_scale_points(uint32_t port_index) const;
134 void set_insert_id(PBD::ID id);
135 void set_state_dir (const std::string& d = "");
137 int set_state (const XMLNode& node, int version);
138 bool save_preset (std::string uri);
139 void remove_preset (std::string uri);
140 bool load_preset (PresetRecord);
141 std::string current_preset () const;
143 bool has_editor () const;
144 bool has_message_output () const;
146 bool write_from_ui(uint32_t index,
149 const uint8_t* body);
151 typedef void UIMessageSink(void* controller,
157 void enable_ui_emission();
158 void emit_to_ui(void* controller, UIMessageSink sink);
160 Worker* worker() { return _worker; }
162 URIMap& uri_map() { return _uri_map; }
163 const URIMap& uri_map() const { return _uri_map; }
165 int work(uint32_t size, const void* data);
166 int work_response(uint32_t size, const void* data);
168 void set_property(uint32_t key, const Variant& value);
169 const PropertyDescriptors& get_supported_properties() const { return _property_descriptors; }
170 const ParameterDescriptor& get_property_descriptor(uint32_t id) const;
171 void announce_property_values();
177 LV2_Feature** _features;
179 framecnt_t _sample_rate;
180 float* _control_data;
183 LV2_Evbuf** _ev_buffers;
184 LV2_Evbuf** _atom_ev_buffers;
185 float* _bpm_control_port; ///< Special input set by ardour
186 float* _freewheel_control_port; ///< Special input set by ardour
187 float* _latency_control_port; ///< Special output set by ardour
188 framepos_t _next_cycle_start; ///< Expected start frame of next run cycle
189 double _next_cycle_speed; ///< Expected start frame of next run cycle
191 std::string _plugin_state_dir;
192 uint32_t _patch_port_in_index;
193 uint32_t _patch_port_out_index;
195 bool _no_sample_accurate_ctrl;
196 bool _can_write_automation;
197 framecnt_t _max_latency;
198 framecnt_t _current_latency;
200 friend const void* lv2plugin_get_port_value(const char* port_symbol,
206 PORT_INPUT = 1, ///< Input port
207 PORT_OUTPUT = 1 << 1, ///< Output port
208 PORT_AUDIO = 1 << 2, ///< Audio (buffer of float)
209 PORT_CONTROL = 1 << 3, ///< Control (single float)
210 PORT_EVENT = 1 << 4, ///< Old event API event port
211 PORT_SEQUENCE = 1 << 5, ///< New atom API event port
212 PORT_MIDI = 1 << 6, ///< Event port understands MIDI
213 PORT_POSITION = 1 << 7, ///< Event port understands position
214 PORT_PATCHMSG = 1 << 8, ///< Event port supports patch:Message
215 PORT_AUTOCTRL = 1 << 9, ///< Event port supports auto:AutomationControl
216 PORT_CTRLED = 1 << 10, ///< Port prop auto:AutomationControlled (can be self controlled)
217 PORT_CTRLER = 1 << 11, ///< Port prop auto:AutomationController (can be self set)
218 PORT_NOAUTO = 1 << 12 ///< Port don't allow to automate
221 typedef unsigned PortFlags;
223 std::vector<PortFlags> _port_flags;
224 std::vector<size_t> _port_minimumSize;
225 std::map<std::string,uint32_t> _port_indices;
227 PropertyDescriptors _property_descriptors;
229 struct AutomationCtrl {
230 AutomationCtrl (const AutomationCtrl &other)
232 , guard (other.guard)
235 AutomationCtrl (boost::shared_ptr<ARDOUR::AutomationControl> c)
239 boost::shared_ptr<ARDOUR::AutomationControl> ac;
243 typedef boost::shared_ptr<AutomationCtrl> AutomationCtrlPtr;
244 typedef std::map<uint32_t, AutomationCtrlPtr> AutomationCtrlMap;
245 AutomationCtrlMap _ctrl_map;
246 AutomationCtrlPtr get_automation_control (uint32_t);
248 /// Message send to/from UI via ports
255 bool write_to_ui(uint32_t index,
258 const uint8_t* body);
260 bool write_to(RingBuffer<uint8_t>* dest,
264 const uint8_t* body);
266 // Created on demand so the space is only consumed if necessary
267 RingBuffer<uint8_t>* _to_ui;
268 RingBuffer<uint8_t>* _from_ui;
271 const LV2_Inline_Display_Interface* _display_interface;
275 const void* (*extension_data) (const char* uri);
278 LV2_DataAccess _data_access_extension_data;
279 LV2_Feature _data_access_feature;
280 LV2_Feature _instance_access_feature;
281 LV2_Feature _make_path_feature;
282 LV2_Feature _log_feature;
283 LV2_Feature _work_schedule_feature;
284 LV2_Feature _options_feature;
285 LV2_Feature _def_state_feature;
287 LV2_Feature _queue_draw_feature;
290 // Options passed to plugin
293 mutable unsigned _state_version;
296 bool _has_state_interface;
298 const std::string plugin_dir () const;
299 const std::string scratch_dir () const;
300 const std::string file_dir () const;
301 const std::string state_dir (unsigned num) const;
303 static char* lv2_state_make_path (void* host_data,
306 void init (const void* c_plugin, framecnt_t rate);
307 void allocate_atom_event_buffers ();
308 void run (pframes_t nsamples);
310 void load_supported_properties(PropertyDescriptors& descs);
313 bool has_inline_display ();
314 Plugin::Display_Image_Surface* render_inline_display (uint32_t, uint32_t);
317 void latency_compute_run ();
318 std::string do_save_preset (std::string);
319 void do_remove_preset (std::string);
320 void find_presets ();
321 void add_state (XMLNode *) const;
325 class LIBARDOUR_API LV2PluginInfo : public PluginInfo , public boost::enable_shared_from_this<ARDOUR::LV2PluginInfo> {
327 LV2PluginInfo (const char* plugin_uri);
330 static PluginInfoList* discover ();
332 PluginPtr load (Session& session);
333 std::vector<Plugin::PresetRecord> get_presets (bool user_only) const;
334 virtual bool in_category (const std::string &c) const;
335 virtual bool is_instrument() const;
340 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
342 } // namespace ARDOUR
344 #endif /* __ardour_lv2_plugin_h__ */