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__
23 #include <glibmm/threads.h>
27 #include <boost/enable_shared_from_this.hpp>
29 #include "ardour/plugin.h"
30 #include "ardour/uri_map.h"
31 #include "ardour/worker.h"
32 #include "pbd/ringbuffer.h"
34 #ifdef LV2_EXTENDED // -> needs to eventually go upstream to lv2plug.in
35 #include "ardour/lv2_extensions.h"
42 typedef struct LV2_Evbuf_Impl LV2_Evbuf;
46 // a callback function for lilv_state_new_from_instance(). friend of LV2Plugin
47 // so we can pass an LV2Plugin* in user_data and access its private members.
48 const void* lv2plugin_get_port_value(const char* port_symbol,
56 class LIBARDOUR_API LV2Plugin : public ARDOUR::Plugin, public ARDOUR::Workee
59 LV2Plugin (ARDOUR::AudioEngine& engine,
60 ARDOUR::Session& session,
62 framecnt_t sample_rate);
63 LV2Plugin (const LV2Plugin &);
66 std::string unique_id () const;
67 const char* uri () const;
68 const char* label () const;
69 const char* name () const;
70 const char* maker () const;
72 uint32_t num_ports () const;
73 uint32_t parameter_count () const;
74 float default_value (uint32_t port);
75 framecnt_t max_latency () const;
76 framecnt_t signal_latency () const;
77 void set_parameter (uint32_t port, float val);
78 float get_parameter (uint32_t port) const;
79 std::string get_docs() const;
80 std::string get_parameter_docs(uint32_t which) const;
81 int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
82 uint32_t nth_parameter (uint32_t port, bool& ok) const;
83 bool get_layout (uint32_t which, UILayoutHint&) const;
85 IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
87 const void* extension_data (const char* uri) const;
89 const void* c_plugin();
91 const void* c_ui_type();
93 bool is_external_ui () const;
94 bool is_external_kx () const;
95 bool ui_is_resizable () const;
97 const char* port_symbol (uint32_t port) const;
98 uint32_t port_index (const char* symbol) const;
100 const LV2_Feature* const* features () { return _features; }
102 std::set<Evoral::Parameter> automatable () const;
103 virtual void set_automation_control (uint32_t, boost::shared_ptr<AutomationControl>);
109 int set_block_size (pframes_t);
110 bool requires_fixed_sized_buffers () const;
112 int connect_and_run (BufferSet& bufs,
113 framepos_t start, framepos_t end, double speed,
114 ChanMapping in, ChanMapping out,
115 pframes_t nframes, framecnt_t offset);
117 std::string describe_parameter (Evoral::Parameter);
118 std::string state_node_name () const { return "lv2"; }
120 void print_parameter (uint32_t param,
124 bool parameter_is_audio (uint32_t) const;
125 bool parameter_is_control (uint32_t) const;
126 bool parameter_is_event (uint32_t) const;
127 bool parameter_is_input (uint32_t) const;
128 bool parameter_is_output (uint32_t) const;
129 bool parameter_is_toggled (uint32_t) const;
131 uint32_t designated_bypass_port ();
133 boost::shared_ptr<ScalePoints>
134 get_scale_points(uint32_t port_index) const;
136 void set_insert_id(PBD::ID id);
137 void set_state_dir (const std::string& d = "");
139 int set_state (const XMLNode& node, int version);
140 bool save_preset (std::string uri);
141 void remove_preset (std::string uri);
142 bool load_preset (PresetRecord);
143 std::string current_preset () const;
145 bool has_editor () const;
146 bool has_message_output () const;
148 bool write_from_ui(uint32_t index,
151 const uint8_t* body);
153 typedef void UIMessageSink(void* controller,
159 void enable_ui_emission();
160 void emit_to_ui(void* controller, UIMessageSink sink);
162 Worker* worker() { return _worker; }
164 URIMap& uri_map() { return _uri_map; }
165 const URIMap& uri_map() const { return _uri_map; }
167 int work(Worker& worker, uint32_t size, const void* data);
168 int work_response(uint32_t size, const void* data);
170 void set_property(uint32_t key, const Variant& value);
171 const PropertyDescriptors& get_supported_properties() const { return _property_descriptors; }
172 const ParameterDescriptor& get_property_descriptor(uint32_t id) const;
173 void announce_property_values();
179 LV2_Feature** _features;
181 Worker* _state_worker;
182 framecnt_t _sample_rate;
183 float* _control_data;
186 LV2_Evbuf** _ev_buffers;
187 LV2_Evbuf** _atom_ev_buffers;
188 float* _bpm_control_port; ///< Special input set by ardour
189 float* _freewheel_control_port; ///< Special input set by ardour
190 float* _latency_control_port; ///< Special output set by ardour
191 framepos_t _next_cycle_start; ///< Expected start frame of next run cycle
192 double _next_cycle_speed; ///< Expected start frame of next run cycle
194 std::string _plugin_state_dir;
195 uint32_t _patch_port_in_index;
196 uint32_t _patch_port_out_index;
198 bool _no_sample_accurate_ctrl;
199 bool _can_write_automation;
200 framecnt_t _max_latency;
201 framecnt_t _current_latency;
203 friend const void* lv2plugin_get_port_value(const char* port_symbol,
209 PORT_INPUT = 1, ///< Input port
210 PORT_OUTPUT = 1 << 1, ///< Output port
211 PORT_AUDIO = 1 << 2, ///< Audio (buffer of float)
212 PORT_CONTROL = 1 << 3, ///< Control (single float)
213 PORT_EVENT = 1 << 4, ///< Old event API event port
214 PORT_SEQUENCE = 1 << 5, ///< New atom API event port
215 PORT_MIDI = 1 << 6, ///< Event port understands MIDI
216 PORT_POSITION = 1 << 7, ///< Event port understands position
217 PORT_PATCHMSG = 1 << 8, ///< Event port supports patch:Message
218 PORT_AUTOCTRL = 1 << 9, ///< Event port supports auto:AutomationControl
219 PORT_CTRLED = 1 << 10, ///< Port prop auto:AutomationControlled (can be self controlled)
220 PORT_CTRLER = 1 << 11, ///< Port prop auto:AutomationController (can be self set)
221 PORT_NOAUTO = 1 << 12 ///< Port don't allow to automate
224 typedef unsigned PortFlags;
226 std::vector<PortFlags> _port_flags;
227 std::vector<size_t> _port_minimumSize;
228 std::map<std::string,uint32_t> _port_indices;
230 PropertyDescriptors _property_descriptors;
232 struct AutomationCtrl {
233 AutomationCtrl (const AutomationCtrl &other)
235 , guard (other.guard)
238 AutomationCtrl (boost::shared_ptr<ARDOUR::AutomationControl> c)
242 boost::shared_ptr<ARDOUR::AutomationControl> ac;
246 typedef boost::shared_ptr<AutomationCtrl> AutomationCtrlPtr;
247 typedef std::map<uint32_t, AutomationCtrlPtr> AutomationCtrlMap;
248 AutomationCtrlMap _ctrl_map;
249 AutomationCtrlPtr get_automation_control (uint32_t);
251 /// Message send to/from UI via ports
258 bool write_to_ui(uint32_t index,
261 const uint8_t* body);
263 bool write_to(RingBuffer<uint8_t>* dest,
267 const uint8_t* body);
269 // Created on demand so the space is only consumed if necessary
270 RingBuffer<uint8_t>* _to_ui;
271 RingBuffer<uint8_t>* _from_ui;
273 Glib::Threads::Mutex _work_mutex;
276 const LV2_Inline_Display_Interface* _display_interface;
280 const void* (*extension_data) (const char* uri);
283 LV2_DataAccess _data_access_extension_data;
284 LV2_Feature _data_access_feature;
285 LV2_Feature _instance_access_feature;
286 LV2_Feature _make_path_feature;
287 LV2_Feature _log_feature;
288 LV2_Feature _work_schedule_feature;
289 LV2_Feature _options_feature;
290 LV2_Feature _def_state_feature;
292 LV2_Feature _queue_draw_feature;
295 // Options passed to plugin
298 mutable unsigned _state_version;
301 bool _has_state_interface;
303 const std::string plugin_dir () const;
304 const std::string scratch_dir () const;
305 const std::string file_dir () const;
306 const std::string state_dir (unsigned num) const;
308 static char* lv2_state_make_path (void* host_data,
311 void init (const void* c_plugin, framecnt_t rate);
312 void allocate_atom_event_buffers ();
313 void run (pframes_t nsamples);
315 void load_supported_properties(PropertyDescriptors& descs);
318 bool has_inline_display ();
319 Plugin::Display_Image_Surface* render_inline_display (uint32_t, uint32_t);
322 void latency_compute_run ();
323 std::string do_save_preset (std::string);
324 void do_remove_preset (std::string);
325 void find_presets ();
326 void add_state (XMLNode *) const;
330 class LIBARDOUR_API LV2PluginInfo : public PluginInfo , public boost::enable_shared_from_this<ARDOUR::LV2PluginInfo> {
332 LV2PluginInfo (const char* plugin_uri);
335 static PluginInfoList* discover ();
337 PluginPtr load (Session& session);
338 std::vector<Plugin::PresetRecord> get_presets (bool user_only) const;
339 virtual bool in_category (const std::string &c) const;
340 virtual bool is_instrument() const;
345 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
347 } // namespace ARDOUR
349 #endif /* __ardour_lv2_plugin_h__ */