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 samplecnt_t sample_rate);
63 LV2Plugin (const LV2Plugin &);
66 static bool force_state_save; // to be used only by session-state
68 std::string unique_id () const;
69 const char* uri () const;
70 const char* label () const;
71 const char* name () const;
72 const char* maker () const;
74 uint32_t num_ports () const;
75 uint32_t parameter_count () const;
76 float default_value (uint32_t port);
77 samplecnt_t max_latency () const;
78 samplecnt_t signal_latency () const;
79 void set_parameter (uint32_t port, float val);
80 float get_parameter (uint32_t port) const;
81 std::string get_docs() const;
82 std::string get_parameter_docs(uint32_t which) const;
83 int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
84 uint32_t nth_parameter (uint32_t port, bool& ok) const;
85 bool get_layout (uint32_t which, UILayoutHint&) const;
87 IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
89 const void* extension_data (const char* uri) const;
91 const void* c_plugin();
93 const void* c_ui_type();
95 bool is_external_ui () const;
96 bool is_external_kx () const;
97 bool ui_is_resizable () const;
99 const char* port_symbol (uint32_t port) const;
100 uint32_t port_index (const char* symbol) const;
102 const LV2_Feature* const* features () { return _features; }
104 std::set<Evoral::Parameter> automatable () const;
105 virtual void set_automation_control (uint32_t, boost::shared_ptr<AutomationControl>);
111 int set_block_size (pframes_t);
112 bool requires_fixed_sized_buffers () const;
114 int connect_and_run (BufferSet& bufs,
115 samplepos_t start, samplepos_t end, double speed,
116 ChanMapping in, ChanMapping out,
117 pframes_t nframes, samplecnt_t offset);
119 std::string describe_parameter (Evoral::Parameter);
120 std::string state_node_name () const { return "lv2"; }
122 void print_parameter (uint32_t param,
126 bool parameter_is_audio (uint32_t) const;
127 bool parameter_is_control (uint32_t) const;
128 bool parameter_is_event (uint32_t) const;
129 bool parameter_is_input (uint32_t) const;
130 bool parameter_is_output (uint32_t) const;
131 bool parameter_is_toggled (uint32_t) const;
133 uint32_t designated_bypass_port ();
135 boost::shared_ptr<ScalePoints>
136 get_scale_points(uint32_t port_index) const;
138 void set_insert_id(PBD::ID id);
139 void set_state_dir (const std::string& d = "");
141 int set_state (const XMLNode& node, int version);
142 bool save_preset (std::string uri);
143 void remove_preset (std::string uri);
144 bool load_preset (PresetRecord);
145 std::string current_preset () const;
147 bool has_editor () const;
148 bool has_message_output () const;
150 bool write_from_ui(uint32_t index,
153 const uint8_t* body);
155 typedef void UIMessageSink(void* controller,
161 void enable_ui_emission();
162 void emit_to_ui(void* controller, UIMessageSink sink);
164 Worker* worker() { return _worker; }
166 URIMap& uri_map() { return _uri_map; }
167 const URIMap& uri_map() const { return _uri_map; }
169 int work(Worker& worker, uint32_t size, const void* data);
170 int work_response(uint32_t size, const void* data);
172 void set_property(uint32_t key, const Variant& value);
173 const PropertyDescriptors& get_supported_properties() const { return _property_descriptors; }
174 const ParameterDescriptor& get_property_descriptor(uint32_t id) const;
175 void announce_property_values();
181 LV2_Feature** _features;
183 Worker* _state_worker;
184 samplecnt_t _sample_rate;
185 float* _control_data;
188 LV2_Evbuf** _ev_buffers;
189 LV2_Evbuf** _atom_ev_buffers;
190 float* _bpm_control_port; ///< Special input set by ardour
191 float* _freewheel_control_port; ///< Special input set by ardour
192 float* _latency_control_port; ///< Special output set by ardour
193 samplepos_t _next_cycle_start; ///< Expected start sample of next run cycle
194 double _next_cycle_speed; ///< Expected start sample of next run cycle
195 double _next_cycle_beat; ///< Expected bar_beat of next run cycle
198 std::string _plugin_state_dir;
199 uint32_t _patch_port_in_index;
200 uint32_t _patch_port_out_index;
202 bool _no_sample_accurate_ctrl;
203 bool _can_write_automation;
204 samplecnt_t _max_latency;
205 samplecnt_t _current_latency;
207 friend const void* lv2plugin_get_port_value(const char* port_symbol,
213 PORT_INPUT = 1, ///< Input port
214 PORT_OUTPUT = 1 << 1, ///< Output port
215 PORT_AUDIO = 1 << 2, ///< Audio (buffer of float)
216 PORT_CONTROL = 1 << 3, ///< Control (single float)
217 PORT_EVENT = 1 << 4, ///< Old event API event port
218 PORT_SEQUENCE = 1 << 5, ///< New atom API event port
219 PORT_MIDI = 1 << 6, ///< Event port understands MIDI
220 PORT_POSITION = 1 << 7, ///< Event port understands position
221 PORT_PATCHMSG = 1 << 8, ///< Event port supports patch:Message
222 PORT_AUTOCTRL = 1 << 9, ///< Event port supports auto:AutomationControl
223 PORT_CTRLED = 1 << 10, ///< Port prop auto:AutomationControlled (can be self controlled)
224 PORT_CTRLER = 1 << 11, ///< Port prop auto:AutomationController (can be self set)
225 PORT_NOAUTO = 1 << 12 ///< Port don't allow to automate
228 typedef unsigned PortFlags;
230 std::vector<PortFlags> _port_flags;
231 std::vector<size_t> _port_minimumSize;
232 std::map<std::string,uint32_t> _port_indices;
234 PropertyDescriptors _property_descriptors;
236 struct AutomationCtrl {
237 AutomationCtrl (const AutomationCtrl &other)
239 , guard (other.guard)
242 AutomationCtrl (boost::shared_ptr<ARDOUR::AutomationControl> c)
246 boost::shared_ptr<ARDOUR::AutomationControl> ac;
250 typedef boost::shared_ptr<AutomationCtrl> AutomationCtrlPtr;
251 typedef std::map<uint32_t, AutomationCtrlPtr> AutomationCtrlMap;
252 AutomationCtrlMap _ctrl_map;
253 AutomationCtrlPtr get_automation_control (uint32_t);
255 /// Message send to/from UI via ports
262 bool write_to_ui(uint32_t index,
265 const uint8_t* body);
267 bool write_to(PBD::RingBuffer<uint8_t>* dest,
271 const uint8_t* body);
273 // Created on demand so the space is only consumed if necessary
274 PBD::RingBuffer<uint8_t>* _to_ui;
275 PBD::RingBuffer<uint8_t>* _from_ui;
277 Glib::Threads::Mutex _work_mutex;
280 static void queue_draw (LV2_Inline_Display_Handle);
281 static void midnam_update (LV2_Midnam_Handle);
282 static void bankpatch_notify (LV2_BankPatch_Handle, uint8_t, uint32_t, uint8_t);
284 const LV2_Inline_Display_Interface* _display_interface;
285 bool _inline_display_in_gui;
286 const LV2_Midnam_Interface* _midname_interface;
288 uint32_t _bankpatch[16];
290 bool knows_bank_patch () { return seen_bankpatch; }
291 uint32_t bank_patch (uint8_t chn) {
293 if (chn > 15) return UINT32_MAX;
294 return _bankpatch[chn];
300 const void* (*extension_data) (const char* uri);
303 LV2_DataAccess _data_access_extension_data;
304 LV2_Feature _data_access_feature;
305 LV2_Feature _instance_access_feature;
306 LV2_Feature _make_path_feature;
307 LV2_Feature _log_feature;
308 LV2_Feature _work_schedule_feature;
309 LV2_Feature _options_feature;
310 LV2_Feature _def_state_feature;
312 LV2_Feature _queue_draw_feature;
313 LV2_Feature _midnam_feature;
314 LV2_Feature _bankpatch_feature;
317 // Options passed to plugin
320 mutable unsigned _state_version;
323 bool _has_state_interface;
325 const std::string plugin_dir () const;
326 const std::string scratch_dir () const;
327 const std::string file_dir () const;
328 const std::string state_dir (unsigned num) const;
330 static char* lv2_state_make_path (void* host_data,
333 void init (const void* c_plugin, samplecnt_t rate);
334 void allocate_atom_event_buffers ();
335 void run (pframes_t nsamples, bool sync_work = false);
337 void load_supported_properties(PropertyDescriptors& descs);
340 bool has_inline_display ();
341 bool inline_display_in_gui ();
342 Plugin::Display_Image_Surface* render_inline_display (uint32_t, uint32_t);
346 std::string midnam_model ();
350 void latency_compute_run ();
351 std::string do_save_preset (std::string);
352 void do_remove_preset (std::string);
353 void find_presets ();
354 void add_state (XMLNode *) const;
358 class LIBARDOUR_API LV2PluginInfo : public PluginInfo , public boost::enable_shared_from_this<ARDOUR::LV2PluginInfo> {
360 LV2PluginInfo (const char* plugin_uri);
363 static PluginInfoList* discover ();
365 PluginPtr load (Session& session);
366 std::vector<Plugin::PresetRecord> get_presets (bool user_only) const;
371 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
373 } // namespace ARDOUR
375 #endif /* __ardour_lv2_plugin_h__ */