summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/lv2_plugin.h
blob: 91dc2f61a58aa9317300595e89c91d5af57bb56a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/*
    Copyright (C) 2008-2011 Paul Davis
    Author: David Robillard

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_lv2_plugin_h__
#define __ardour_lv2_plugin_h__

#include <set>
#include <string>
#include <vector>

#include <dlfcn.h>

#include "pbd/stateful.h"

#include <jack/types.h>
#include <slv2/slv2.h>

#include "ardour/plugin.h"
#include "ardour/uri_map.h"

namespace ARDOUR {

class AudioEngine;
class LV2World;
class Session;

class LV2Plugin : public ARDOUR::Plugin
{
  public:
	LV2Plugin (ARDOUR::AudioEngine& engine,
	           ARDOUR::Session&     session,
	           ARDOUR::LV2World&    world,
	           SLV2Plugin           plugin,
	           framecnt_t           sample_rate);
	LV2Plugin (const LV2Plugin &);
	~LV2Plugin ();

	std::string unique_id () const;

	const char* label () const { return slv2_value_as_string(_name); }
	const char* name () const  { return slv2_value_as_string(_name); }
	const char* maker () const {
		return _author ? slv2_value_as_string (_author) : "Unknown";
	}

	uint32_t   parameter_count () const { return slv2_plugin_get_num_ports(_plugin); }
	float      default_value (uint32_t port);
	framecnt_t signal_latency () const;
	void       set_parameter (uint32_t port, float val);
	float      get_parameter (uint32_t port) const;
	int        get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
	uint32_t   nth_parameter (uint32_t port, bool& ok) const;

	const void* extension_data (const char* uri) {
		return _instance->lv2_descriptor->extension_data (uri);
	}

	SLV2Plugin slv2_plugin ()         { return _plugin; }
	SLV2UI     slv2_ui ()             { return _ui; }
	SLV2Value  ui_type()              { return _ui_type; }
	SLV2Port   slv2_port (uint32_t i) { return slv2_plugin_get_port_by_index (_plugin, i); }
	bool       is_external_ui () const;

	const char* port_symbol (uint32_t port) const;

	const LV2_Feature* const* features () { return _features; }

	std::set<Evoral::Parameter> automatable () const;

	void activate ();
	void deactivate ();
	void cleanup ();

	int set_block_size (pframes_t /*nframes*/) { return 0; }

	int connect_and_run (BufferSet& bufs,
	                     ChanMapping in, ChanMapping out,
	                     pframes_t nframes, framecnt_t offset);

	std::string describe_parameter (Evoral::Parameter);
	std::string state_node_name () const { return "lv2"; }

	void print_parameter (uint32_t param,
	                      char*    buf,
	                      uint32_t len) const;

	bool parameter_is_audio (uint32_t) const;
	bool parameter_is_control (uint32_t) const;
	bool parameter_is_midi (uint32_t) const;
	bool parameter_is_input (uint32_t) const;
	bool parameter_is_output (uint32_t) const;
	bool parameter_is_toggled (uint32_t) const;

	static uint32_t midi_event_type () { return _midi_event_type; }

	void set_insert_info(const PluginInsert* insert);

	int      set_state (const XMLNode& node, int version);
	bool     save_preset (std::string uri);
	void     remove_preset (std::string uri);
	bool     load_preset (PresetRecord);
	std::string current_preset () const;

	bool has_editor () const;

  private:
	void*             _module;
	LV2World&         _world;
	LV2_Feature**     _features;
	SLV2Plugin        _plugin;
	SLV2UI            _ui;
	SLV2Value         _ui_type;
	SLV2Value         _name;
	SLV2Value         _author;
	SLV2Instance      _instance;
	framecnt_t        _sample_rate;
	float*            _control_data;
	float*            _shadow_data;
	float*            _defaults;
	float*            _latency_control_port;
	bool              _was_activated;
	bool              _supports_persist;
	std::vector<bool> _port_is_input;

	std::map<std::string,uint32_t> _port_indices;

	PBD::ID _insert_id;

	typedef struct {
		const void* (*extension_data) (const char* uri);
	} LV2_DataAccess;

	LV2_DataAccess _data_access_extension_data;
	LV2_Feature    _data_access_feature;
	LV2_Feature    _instance_access_feature;
	LV2_Feature    _path_support_feature;
	LV2_Feature    _new_file_support_feature;
	LV2_Feature    _persist_feature;

	static URIMap   _uri_map;
	static uint32_t _midi_event_type;

	static int lv2_persist_store_callback (void*       host_data,
	                                       uint32_t    key,
	                                       const void* value,
	                                       size_t      size,
	                                       uint32_t    type,
	                                       uint32_t    flags);
	static const void* lv2_persist_retrieve_callback (void*     host_data,
	                                                  uint32_t  key,
	                                                  size_t*   size,
	                                                  uint32_t* type,
	                                                  uint32_t* flags);
	static char* lv2_files_abstract_path (void*       host_data,
	                                      const char* absolute_path);
	static char* lv2_files_absolute_path (void*       host_data,
	                                      const char* abstract_path);
	static char* lv2_files_new_file_path (void*       host_data,
	                                      const char* relative_path);

	void init (LV2World& world, SLV2Plugin plugin, framecnt_t rate);
	void run (pframes_t nsamples);

	void latency_compute_run ();
	std::string do_save_preset (std::string);
	void do_remove_preset (std::string);
	void find_presets ();
	void add_state (XMLNode *) const;
};


/** The SLV2World, and various cached (as symbols, fast) URIs.
 *
 * This object represents everything ardour 'knows' about LV2
 * (ie understood extensions/features/etc)
 */
class LV2World {
public:
	LV2World ();
	~LV2World ();

	SLV2World world;
	SLV2Value input_class; ///< Input port
	SLV2Value output_class; ///< Output port
	SLV2Value audio_class; ///< Audio port
	SLV2Value control_class; ///< Control port
	SLV2Value event_class; ///< Event port
	SLV2Value midi_class; ///< MIDI event
	SLV2Value in_place_broken;
	SLV2Value integer;
	SLV2Value toggled;
	SLV2Value srate;
	SLV2Value gtk_gui;
	SLV2Value external_gui;
	SLV2Value logarithmic;
};


class LV2PluginInfo : public PluginInfo {
public:
	LV2PluginInfo (void* slv2_world, void* slv2_plugin);
	~LV2PluginInfo ();
	static PluginInfoList* discover (void* slv2_world);

	PluginPtr load (Session& session);

	void* _lv2_world;
	void* _slv2_plugin;
};

typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;

} // namespace ARDOUR

#endif /* __ardour_lv2_plugin_h__ */