13
0
livetrax/libs/ardour/lv2_plugin.cc
Carl Hetherington 7be510a26a Set up default and upper/lower limit correctly on LV2 ports
whose values are expressed as a fraction of the sampling
rate.  Should fix #3767.


git-svn-id: svn://localhost/ardour2/branches/3.0@9848 d708f5d6-7413-0410-9779-e7cbd77b26cf
2011-07-12 20:30:02 +00:00

1226 lines
34 KiB
C++

/*
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.
*/
#include <string>
#include <vector>
#include <cmath>
#include <cstdlib>
#include <cstring>
#include <glibmm.h>
#include <boost/utility.hpp>
#include "pbd/compose.h"
#include "pbd/error.h"
#include "pbd/pathscanner.h"
#include "pbd/stl_delete.h"
#include "pbd/xml++.h"
#include "libardour-config.h"
#include "ardour/ardour.h"
#include "ardour/audio_buffer.h"
#include "ardour/audioengine.h"
#include "ardour/debug.h"
#include "ardour/lv2_event_buffer.h"
#include "ardour/lv2_plugin.h"
#include "ardour/lv2_state.h"
#include "ardour/session.h"
#include "i18n.h"
#include <locale.h>
#include <slv2/slv2.h>
#include "lv2ext/lv2_files.h"
#include "lv2ext/lv2_persist.h"
#include "rdff.h"
#ifdef HAVE_SUIL
#include <suil/suil.h>
#endif
#define NS_DC "http://dublincore.org/documents/dcmi-namespace/"
#define NS_LV2 "http://lv2plug.in/ns/lv2core#"
#define NS_PSET "http://lv2plug.in/ns/dev/presets#"
#define NS_UI "http://lv2plug.in/ns/extensions/ui#"
using namespace std;
using namespace ARDOUR;
using namespace PBD;
URIMap LV2Plugin::_uri_map;
uint32_t LV2Plugin::_midi_event_type = _uri_map.uri_to_id(
"http://lv2plug.in/ns/ext/event",
"http://lv2plug.in/ns/ext/midi#MidiEvent");
class LV2World : boost::noncopyable {
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;
};
static LV2World _world;
struct LV2Plugin::Impl {
Impl() : plugin(0), ui(0), ui_type(0), name(0), author(0), instance(0) {}
SLV2Plugin plugin;
SLV2UI ui;
SLV2Value ui_type;
SLV2Value name;
SLV2Value author;
SLV2Instance instance;
};
LV2Plugin::LV2Plugin (AudioEngine& engine,
Session& session,
void* c_plugin,
framecnt_t rate)
: Plugin(engine, session)
, _impl(new Impl())
, _features(NULL)
, _insert_id("0")
{
init(c_plugin, rate);
}
LV2Plugin::LV2Plugin (const LV2Plugin& other)
: Plugin(other)
, _impl(new Impl())
, _features(NULL)
, _insert_id(other._insert_id)
{
init(other._impl->plugin, other._sample_rate);
for (uint32_t i = 0; i < parameter_count(); ++i) {
_control_data[i] = other._shadow_data[i];
_shadow_data[i] = other._shadow_data[i];
}
}
void
LV2Plugin::init(void* c_plugin, framecnt_t rate)
{
DEBUG_TRACE(DEBUG::LV2, "init\n");
_impl->plugin = (SLV2Plugin)c_plugin;
_impl->ui = NULL;
_impl->ui_type = NULL;
_control_data = 0;
_shadow_data = 0;
_latency_control_port = 0;
_was_activated = false;
_instance_access_feature.URI = "http://lv2plug.in/ns/ext/instance-access";
_data_access_feature.URI = "http://lv2plug.in/ns/ext/data-access";
_path_support_feature.URI = LV2_FILES_PATH_SUPPORT_URI;
_new_file_support_feature.URI = LV2_FILES_NEW_FILE_SUPPORT_URI;
_persist_feature.URI = "http://lv2plug.in/ns/ext/persist";
_persist_feature.data = NULL;
SLV2Plugin plugin = _impl->plugin;
SLV2Value persist_uri = slv2_value_new_uri(_world.world, _persist_feature.URI);
_supports_persist = slv2_plugin_has_feature(plugin, persist_uri);
slv2_value_free(persist_uri);
_features = (LV2_Feature**)malloc(sizeof(LV2_Feature*) * 7);
_features[0] = &_instance_access_feature;
_features[1] = &_data_access_feature;
_features[2] = &_path_support_feature;
_features[3] = &_new_file_support_feature;
_features[4] = &_persist_feature;
_features[5] = _uri_map.feature();
_features[6] = NULL;
LV2_Files_Path_Support* path_support = (LV2_Files_Path_Support*)malloc(
sizeof(LV2_Files_Path_Support));
path_support->host_data = this;
path_support->abstract_path = &lv2_files_abstract_path;
path_support->absolute_path = &lv2_files_absolute_path;
_path_support_feature.data = path_support;
LV2_Files_New_File_Support* new_file_support = (LV2_Files_New_File_Support*)malloc(
sizeof(LV2_Files_New_File_Support));
new_file_support->host_data = this;
new_file_support->new_file_path = &lv2_files_new_file_path;
_new_file_support_feature.data = new_file_support;
_impl->instance = slv2_plugin_instantiate(plugin, rate, _features);
_impl->name = slv2_plugin_get_name(plugin);
_impl->author = slv2_plugin_get_author_name(plugin);
if (_impl->instance == 0) {
error << _("LV2: Failed to instantiate plugin ") << uri() << endmsg;
throw failed_constructor();
}
_instance_access_feature.data = (void*)_impl->instance->lv2_handle;
_data_access_extension_data.extension_data = _impl->instance->lv2_descriptor->extension_data;
_data_access_feature.data = &_data_access_extension_data;
if (slv2_plugin_has_feature(plugin, _world.in_place_broken)) {
error << string_compose(
_("LV2: \"%1\" cannot be used, since it cannot do inplace processing"),
slv2_value_as_string(_impl->name)) << endmsg;
slv2_value_free(_impl->name);
slv2_value_free(_impl->author);
throw failed_constructor();
}
_sample_rate = rate;
const uint32_t num_ports = this->num_ports();
const bool latent = slv2_plugin_has_latency(plugin);
const uint32_t latency_port = (latent)
? slv2_plugin_get_latency_port_index(plugin)
: 0;
_control_data = new float[num_ports];
_shadow_data = new float[num_ports];
_defaults = new float[num_ports];
for (uint32_t i = 0; i < num_ports; ++i) {
SLV2Port port = slv2_plugin_get_port_by_index(plugin, i);
SLV2Value sym = slv2_port_get_symbol(plugin, port);
// Store index in map so we can look up index by symbol
_port_indices.insert(std::make_pair(slv2_value_as_string(sym), i));
// Get range and default value if applicable
if (parameter_is_control(i)) {
SLV2Value def;
slv2_port_get_range(plugin, port, &def, NULL, NULL);
_defaults[i] = def ? slv2_value_as_float(def) : 0.0f;
if (slv2_port_has_property(_impl->plugin, port, _world.srate)) {
_defaults[i] *= _session.frame_rate ();
}
slv2_value_free(def);
slv2_instance_connect_port(_impl->instance, i, &_control_data[i]);
if (latent && ( i == latency_port) ) {
_latency_control_port = &_control_data[i];
*_latency_control_port = 0;
}
if (parameter_is_input(i)) {
_shadow_data[i] = default_value(i);
}
} else {
_defaults[i] = 0.0f;
}
}
SLV2UIs uis = slv2_plugin_get_uis(plugin);
if (slv2_uis_size(uis) > 0) {
#if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
// Look for embeddable UI
SLV2Value ui_type = NULL;
SLV2_FOREACH(uis, u, uis) {
SLV2UI this_ui = slv2_uis_get(uis, u);
SLV2Value this_ui_type = NULL;
if (slv2_ui_is_supported(this_ui,
suil_ui_supported,
_world.gtk_gui,
&this_ui_type)) {
// TODO: Multiple UI support
_ui = this_ui;
_ui_type = this_ui_type;
break;
}
}
#else
// Look for Gtk native UI
for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
SLV2UI ui = slv2_uis_get_at(uis, i);
if (slv2_ui_is_a(ui, _world.gtk_gui)) {
_impl->ui = ui;
_impl->ui_type = _world.gtk_gui;
break;
}
}
#endif
// If Gtk UI is not available, try to find external UI
if (!_impl->ui) {
for (unsigned i = 0; i < slv2_uis_size(uis); ++i) {
SLV2UI ui = slv2_uis_get_at(uis, i);
if (slv2_ui_is_a(ui, _world.external_gui)) {
_impl->ui = ui;
_impl->ui_type = _world.external_gui;
break;
}
}
}
}
latency_compute_run();
}
LV2Plugin::~LV2Plugin ()
{
DEBUG_TRACE(DEBUG::LV2, string_compose("%1 destroy\n", name()));
deactivate();
cleanup();
slv2_instance_free(_impl->instance);
slv2_value_free(_impl->name);
slv2_value_free(_impl->author);
#if defined(HAVE_NEW_SLV2) and defined(HAVE_SUIL)
slv2_value_free(_impl->ui_type);
#else
/* _ui_type points to a global, so leave it alone */
#endif
delete [] _control_data;
delete [] _shadow_data;
}
bool
LV2Plugin::is_external_ui() const
{
if (!_impl->ui) {
return false;
}
return slv2_ui_is_a(_impl->ui, _world.external_gui);
}
string
LV2Plugin::unique_id() const
{
return slv2_value_as_uri(slv2_plugin_get_uri(_impl->plugin));
}
const char*
LV2Plugin::uri() const
{
return slv2_value_as_uri(slv2_plugin_get_uri(_impl->plugin));
}
const char*
LV2Plugin::label() const
{
return slv2_value_as_string(_impl->name);
}
const char*
LV2Plugin::name() const
{
return slv2_value_as_string(_impl->name);
}
const char*
LV2Plugin::maker() const
{
return _impl->author ? slv2_value_as_string (_impl->author) : "Unknown";
}
uint32_t
LV2Plugin::num_ports() const
{
return slv2_plugin_get_num_ports(_impl->plugin);
}
uint32_t
LV2Plugin::parameter_count() const
{
return slv2_plugin_get_num_ports(_impl->plugin);
}
float
LV2Plugin::default_value(uint32_t port)
{
return _defaults[port];
}
const char*
LV2Plugin::port_symbol(uint32_t index) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, index);
if (!port) {
error << name() << ": Invalid port index " << index << endmsg;
}
SLV2Value sym = slv2_port_get_symbol(_impl->plugin, port);
return slv2_value_as_string(sym);
}
void
LV2Plugin::set_parameter(uint32_t which, float val)
{
DEBUG_TRACE(DEBUG::LV2, string_compose(
"%1 set parameter %2 to %3\n", name(), which, val));
if (which < slv2_plugin_get_num_ports(_impl->plugin)) {
_shadow_data[which] = val;
} else {
warning << string_compose(
_("Illegal parameter number used with plugin \"%1\". "
"This is a bug in either %2 or the LV2 plugin <%3>"),
name(), PROGRAM_NAME, unique_id()) << endmsg;
}
Plugin::set_parameter(which, val);
}
float
LV2Plugin::get_parameter(uint32_t which) const
{
if (parameter_is_input(which)) {
return (float)_shadow_data[which];
} else {
return (float)_control_data[which];
}
return 0.0f;
}
uint32_t
LV2Plugin::nth_parameter(uint32_t n, bool& ok) const
{
ok = false;
for (uint32_t c = 0, x = 0; x < slv2_plugin_get_num_ports(_impl->plugin); ++x) {
if (parameter_is_control(x)) {
if (c++ == n) {
ok = true;
return x;
}
}
}
return 0;
}
const void*
LV2Plugin::extension_data (const char* uri) const
{
return slv2_instance_get_extension_data(_impl->instance, uri);
}
void*
LV2Plugin::c_plugin ()
{
return _impl->plugin;
}
void*
LV2Plugin::c_ui ()
{
return _impl->ui;
}
void*
LV2Plugin::c_ui_type ()
{
return _impl->ui_type;
}
int
LV2Plugin::lv2_persist_store_callback(void* host_data,
uint32_t key,
const void* value,
size_t size,
uint32_t type,
uint32_t flags)
{
DEBUG_TRACE(DEBUG::LV2, string_compose(
"persist store %1 (size: %2, type: %3)\n",
_uri_map.id_to_uri(NULL, key),
size,
_uri_map.id_to_uri(NULL, type)));
LV2PersistState* state = (LV2PersistState*)host_data;
state->add_uri(key, _uri_map.id_to_uri(NULL, key));
state->add_uri(type, _uri_map.id_to_uri(NULL, type));
return state->add_value(key, value, size, type, flags);
}
const void*
LV2Plugin::lv2_persist_retrieve_callback(void* host_data,
uint32_t key,
size_t* size,
uint32_t* type,
uint32_t* flags)
{
LV2PersistState* state = (LV2PersistState*)host_data;
LV2PersistState::Values::const_iterator i = state->values.find(key);
if (i == state->values.end()) {
warning << "LV2 plugin attempted to retrieve nonexistent key: "
<< _uri_map.id_to_uri(NULL, key) << endmsg;
return NULL;
}
*size = i->second.size;
*type = i->second.type;
*flags = LV2_PERSIST_IS_POD | LV2_PERSIST_IS_PORTABLE; // FIXME
DEBUG_TRACE(DEBUG::LV2, string_compose(
"persist retrieve %1 = %2 (size: %3, type: %4)\n",
_uri_map.id_to_uri(NULL, key),
i->second.value, *size, *type));
return i->second.value;
}
char*
LV2Plugin::lv2_files_abstract_path(LV2_Files_Host_Data host_data,
const char* absolute_path)
{
LV2Plugin* me = (LV2Plugin*)host_data;
if (me->_insert_id == PBD::ID("0")) {
return g_strdup(absolute_path);
}
const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
me->_insert_id.to_s());
char* ret = NULL;
if (strncmp(absolute_path, state_dir.c_str(), state_dir.length())) {
ret = g_strdup(absolute_path);
} else {
const std::string path(absolute_path + state_dir.length() + 1);
ret = g_strndup(path.c_str(), path.length());
}
DEBUG_TRACE(DEBUG::LV2, string_compose("abstract path %1 => %2\n",
absolute_path, ret));
return ret;
}
char*
LV2Plugin::lv2_files_absolute_path(LV2_Files_Host_Data host_data,
const char* abstract_path)
{
LV2Plugin* me = (LV2Plugin*)host_data;
if (me->_insert_id == PBD::ID("0")) {
return g_strdup(abstract_path);
}
char* ret = NULL;
if (g_path_is_absolute(abstract_path)) {
ret = g_strdup(abstract_path);
} else {
const std::string apath(abstract_path);
const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
me->_insert_id.to_s());
const std::string path = Glib::build_filename(state_dir,
apath);
ret = g_strndup(path.c_str(), path.length());
}
DEBUG_TRACE(DEBUG::LV2, string_compose("absolute path %1 => %2\n",
abstract_path, ret));
return ret;
}
char*
LV2Plugin::lv2_files_new_file_path(LV2_Files_Host_Data host_data,
const char* relative_path)
{
LV2Plugin* me = (LV2Plugin*)host_data;
if (me->_insert_id == PBD::ID("0")) {
return g_strdup(relative_path);
}
const std::string state_dir = Glib::build_filename(me->_session.plugins_dir(),
me->_insert_id.to_s());
const std::string path = Glib::build_filename(state_dir,
relative_path);
char* dirname = g_path_get_dirname(path.c_str());
g_mkdir_with_parents(dirname, 0744);
free(dirname);
DEBUG_TRACE(DEBUG::LV2, string_compose("new file path %1 => %2\n",
relative_path, path));
return g_strndup(path.c_str(), path.length());
}
void
LV2Plugin::add_state(XMLNode* root) const
{
assert(_insert_id != PBD::ID("0"));
XMLNode* child;
char buf[16];
LocaleGuard lg(X_("POSIX"));
for (uint32_t i = 0; i < parameter_count(); ++i) {
if (parameter_is_input(i) && parameter_is_control(i)) {
child = new XMLNode("Port");
child->add_property("symbol", port_symbol(i));
snprintf(buf, sizeof(buf), "%+f", _shadow_data[i]);
child->add_property("value", string(buf));
root->add_child_nocopy(*child);
}
}
if (_supports_persist) {
// Create state directory for this plugin instance
const std::string state_filename = _insert_id.to_s() + ".rdff";
const std::string state_path = Glib::build_filename(
_session.plugins_dir(), state_filename);
cout << "Saving LV2 plugin state to " << state_path << endl;
// Get LV2 Persist extension data from plugin instance
LV2_Persist* persist = (LV2_Persist*)extension_data(
"http://lv2plug.in/ns/ext/persist");
if (!persist) {
warning << string_compose(
_("Plugin \"%1\% failed to return LV2 persist data"),
unique_id());
return;
}
// Save plugin state to state object
LV2PersistState state(_uri_map);
persist->save(_impl->instance->lv2_handle,
&LV2Plugin::lv2_persist_store_callback,
&state);
// Write state object to RDFF file
RDFF file = rdff_open(state_path.c_str(), true);
state.write(file);
rdff_close(file);
root->add_property("state-file", state_filename);
}
}
static inline SLV2Value
get_value(SLV2Plugin p, SLV2Value subject, SLV2Value predicate)
{
SLV2Values vs = slv2_plugin_get_value_for_subject(p, subject, predicate);
return vs ? slv2_values_get_at(vs, 0) : NULL;
}
void
LV2Plugin::find_presets()
{
SLV2Value dc_title = slv2_value_new_uri(_world.world, NS_DC "title");
SLV2Value pset_hasPreset = slv2_value_new_uri(_world.world, NS_PSET "hasPreset");
SLV2Values presets = slv2_plugin_get_value(_impl->plugin, pset_hasPreset);
for (unsigned i = 0; i < slv2_values_size(presets); ++i) {
SLV2Value preset = slv2_values_get_at(presets, i);
SLV2Value name = get_value(_impl->plugin, preset, dc_title);
if (name) {
_presets.insert(std::make_pair(slv2_value_as_string(preset),
PresetRecord(
slv2_value_as_string(preset),
slv2_value_as_string(name))));
} else {
warning << string_compose(
_("Plugin \"%1\% preset \"%2%\" is missing a dc:title\n"),
unique_id(), slv2_value_as_string(preset));
}
}
slv2_values_free(presets);
slv2_value_free(pset_hasPreset);
slv2_value_free(dc_title);
}
bool
LV2Plugin::load_preset(PresetRecord r)
{
Plugin::load_preset(r);
#ifdef HAVE_NEW_SLV2
// New (>= 0.7.0) slv2 no longer supports SPARQL, but exposes blank nodes
// so querying ports is possible with the simple/fast API
SLV2Value lv2_port = slv2_value_new_uri(_world.world, NS_LV2 "port");
SLV2Value lv2_symbol = slv2_value_new_uri(_world.world, NS_LV2 "symbol");
SLV2Value pset_value = slv2_value_new_uri(_world.world, NS_PSET "value");
SLV2Value preset = slv2_value_new_uri(_world.world, r.uri.c_str());
SLV2Values ports = slv2_plugin_get_value_for_subject(_impl->plugin, preset, lv2_port);
for (unsigned i = 0; i < slv2_values_size(ports); ++i) {
SLV2Value port = slv2_values_get_at(ports, i);
SLV2Value symbol = get_value(_impl->plugin, port, lv2_symbol);
SLV2Value value = get_value(_impl->plugin, port, pset_value);
if (value && slv2_value_is_float(value)) {
set_parameter(_port_indices[slv2_value_as_string(symbol)],
slv2_value_as_float(value));
}
}
slv2_values_free(ports);
slv2_value_free(preset);
slv2_value_free(pset_value);
slv2_value_free(lv2_symbol);
slv2_value_free(lv2_port);
#else
const string query = string(
"PREFIX lv2p: <http://lv2plug.in/ns/dev/presets#>\n"
"PREFIX dc: <http://dublincore.org/documents/dcmi-namespace/>\n"
"SELECT ?sym ?val WHERE { <") + r.uri + "> lv2:port ?port . "
" ?port lv2:symbol ?sym ; lv2p:value ?val . }";
SLV2Results values = slv2_plugin_query_sparql(_impl->plugin, query.c_str());
for (; !slv2_results_finished(values); slv2_results_next(values)) {
SLV2Value sym = slv2_results_get_binding_value(values, 0);
SLV2Value val = slv2_results_get_binding_value(values, 1);
if (slv2_value_is_float(val)) {
uint32_t index = _port_indices[slv2_value_as_string(sym)];
set_parameter(index, slv2_value_as_float(val));
}
}
slv2_results_free(values);
#endif
return true;
}
std::string
LV2Plugin::do_save_preset(string /*name*/)
{
return "";
}
void
LV2Plugin::do_remove_preset(string /*name*/)
{}
bool
LV2Plugin::has_editor() const
{
return _impl->ui != NULL;
}
void
LV2Plugin::set_insert_info(const PluginInsert* insert)
{
_insert_id = insert->id();
}
int
LV2Plugin::set_state(const XMLNode& node, int version)
{
XMLNodeList nodes;
const XMLProperty* prop;
XMLNodeConstIterator iter;
XMLNode* child;
const char* sym;
const char* value;
uint32_t port_id;
LocaleGuard lg(X_("POSIX"));
if (node.name() != state_node_name()) {
error << _("Bad node sent to LV2Plugin::set_state") << endmsg;
return -1;
}
if (version < 3000) {
nodes = node.children("port");
} else {
nodes = node.children("Port");
}
for (iter = nodes.begin(); iter != nodes.end(); ++iter) {
child = *iter;
if ((prop = child->property("symbol")) != 0) {
sym = prop->value().c_str();
} else {
warning << _("LV2: port has no symbol, ignored") << endmsg;
continue;
}
map<string, uint32_t>::iterator i = _port_indices.find(sym);
if (i != _port_indices.end()) {
port_id = i->second;
} else {
warning << _("LV2: port has unknown index, ignored") << endmsg;
continue;
}
if ((prop = child->property("value")) != 0) {
value = prop->value().c_str();
} else {
warning << _("LV2: port has no value, ignored") << endmsg;
continue;
}
set_parameter(port_id, atof(value));
}
if ((prop = node.property("state-file")) != 0) {
std::string state_path = Glib::build_filename(_session.plugins_dir(),
prop->value());
cout << "LV2 state path " << state_path << endl;
// Get LV2 Persist extension data from plugin instance
LV2_Persist* persist = (LV2_Persist*)extension_data(
"http://lv2plug.in/ns/ext/persist");
if (persist) {
cout << "Loading LV2 state from " << state_path << endl;
RDFF file = rdff_open(state_path.c_str(), false);
LV2PersistState state(_uri_map);
state.read(file);
persist->restore(_impl->instance->lv2_handle,
&LV2Plugin::lv2_persist_retrieve_callback,
&state);
rdff_close(file);
} else {
warning << string_compose(
_("Plugin \"%1\% failed to return LV2 persist data"),
unique_id());
}
}
latency_compute_run();
return Plugin::set_state(node, version);
}
int
LV2Plugin::get_parameter_descriptor(uint32_t which, ParameterDescriptor& desc) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, which);
SLV2Value def, min, max;
slv2_port_get_range(_impl->plugin, port, &def, &min, &max);
desc.integer_step = slv2_port_has_property(_impl->plugin, port, _world.integer);
desc.toggled = slv2_port_has_property(_impl->plugin, port, _world.toggled);
desc.logarithmic = slv2_port_has_property(_impl->plugin, port, _world.logarithmic);
desc.sr_dependent = slv2_port_has_property(_impl->plugin, port, _world.srate);
desc.label = slv2_value_as_string(slv2_port_get_name(_impl->plugin, port));
desc.lower = min ? slv2_value_as_float(min) : 0.0f;
desc.upper = max ? slv2_value_as_float(max) : 1.0f;
if (desc.sr_dependent) {
desc.lower *= _session.frame_rate ();
desc.upper *= _session.frame_rate ();
}
desc.min_unbound = false; // TODO: LV2 extension required
desc.max_unbound = false; // TODO: LV2 extension required
if (desc.integer_step) {
desc.step = 1.0;
desc.smallstep = 0.1;
desc.largestep = 10.0;
} else {
const float delta = desc.upper - desc.lower;
desc.step = delta / 1000.0f;
desc.smallstep = delta / 10000.0f;
desc.largestep = delta / 10.0f;
}
slv2_value_free(def);
slv2_value_free(min);
slv2_value_free(max);
return 0;
}
string
LV2Plugin::describe_parameter(Evoral::Parameter which)
{
if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
SLV2Value name = slv2_port_get_name(_impl->plugin,
slv2_plugin_get_port_by_index(_impl->plugin, which.id()));
string ret(slv2_value_as_string(name));
slv2_value_free(name);
return ret;
} else {
return "??";
}
}
framecnt_t
LV2Plugin::signal_latency() const
{
if (_latency_control_port) {
return (framecnt_t)floor(*_latency_control_port);
} else {
return 0;
}
}
set<Evoral::Parameter>
LV2Plugin::automatable() const
{
set<Evoral::Parameter> ret;
for (uint32_t i = 0; i < parameter_count(); ++i) {
if (parameter_is_input(i) && parameter_is_control(i)) {
ret.insert(ret.end(), Evoral::Parameter(PluginAutomation, 0, i));
}
}
return ret;
}
void
LV2Plugin::activate()
{
DEBUG_TRACE(DEBUG::LV2, string_compose("%1 activate\n", name()));
if (!_was_activated) {
slv2_instance_activate(_impl->instance);
_was_activated = true;
}
}
void
LV2Plugin::deactivate()
{
DEBUG_TRACE(DEBUG::LV2, string_compose("%1 deactivate\n", name()));
if (_was_activated) {
slv2_instance_deactivate(_impl->instance);
_was_activated = false;
}
}
void
LV2Plugin::cleanup()
{
DEBUG_TRACE(DEBUG::LV2, string_compose("%1 cleanup\n", name()));
activate();
deactivate();
slv2_instance_free(_impl->instance);
_impl->instance = NULL;
}
int
LV2Plugin::connect_and_run(BufferSet& bufs,
ChanMapping in_map, ChanMapping out_map,
pframes_t nframes, framecnt_t offset)
{
DEBUG_TRACE(DEBUG::LV2, string_compose("%1 run %2 offset %3\n", name(), nframes, offset));
Plugin::connect_and_run(bufs, in_map, out_map, nframes, offset);
cycles_t then = get_cycles();
uint32_t audio_in_index = 0;
uint32_t audio_out_index = 0;
uint32_t midi_in_index = 0;
uint32_t midi_out_index = 0;
for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
if (parameter_is_audio(port_index)) {
if (parameter_is_input(port_index)) {
const uint32_t buf_index = in_map.get(DataType::AUDIO, audio_in_index++);
slv2_instance_connect_port(_impl->instance, port_index,
bufs.get_audio(buf_index).data(offset));
} else if (parameter_is_output(port_index)) {
const uint32_t buf_index = out_map.get(DataType::AUDIO, audio_out_index++);
//cerr << port_index << " : " << " AUDIO OUT " << buf_index << endl;
slv2_instance_connect_port(_impl->instance, port_index,
bufs.get_audio(buf_index).data(offset));
}
} else if (parameter_is_midi(port_index)) {
if (parameter_is_input(port_index)) {
const uint32_t buf_index = in_map.get(DataType::MIDI, midi_in_index++);
slv2_instance_connect_port(_impl->instance, port_index,
bufs.get_lv2_midi(true, buf_index).data());
} else if (parameter_is_output(port_index)) {
const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
slv2_instance_connect_port(_impl->instance, port_index,
bufs.get_lv2_midi(false, buf_index).data());
}
} else if (!parameter_is_control(port_index)) {
// Optional port (it'd better be if we've made it this far...)
slv2_instance_connect_port(_impl->instance, port_index, NULL);
}
}
run(nframes);
midi_out_index = 0;
for (uint32_t port_index = 0; port_index < parameter_count(); ++port_index) {
if (parameter_is_midi(port_index) && parameter_is_output(port_index)) {
const uint32_t buf_index = out_map.get(DataType::MIDI, midi_out_index++);
bufs.flush_lv2_midi(true, buf_index);
}
}
cycles_t now = get_cycles();
set_cycles((uint32_t)(now - then));
return 0;
}
bool
LV2Plugin::parameter_is_control(uint32_t param) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
return slv2_port_is_a(_impl->plugin, port, _world.control_class);
}
bool
LV2Plugin::parameter_is_audio(uint32_t param) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
return slv2_port_is_a(_impl->plugin, port, _world.audio_class);
}
bool
LV2Plugin::parameter_is_midi(uint32_t param) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
return slv2_port_is_a(_impl->plugin, port, _world.event_class);
// && slv2_port_supports_event(_impl->plugin, port, _world.midi_class);
}
bool
LV2Plugin::parameter_is_output(uint32_t param) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
return slv2_port_is_a(_impl->plugin, port, _world.output_class);
}
bool
LV2Plugin::parameter_is_input(uint32_t param) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, param);
return slv2_port_is_a(_impl->plugin, port, _world.input_class);
}
void
LV2Plugin::print_parameter(uint32_t param, char* buf, uint32_t len) const
{
if (buf && len) {
if (param < parameter_count()) {
snprintf(buf, len, "%.3f", get_parameter(param));
} else {
strcat(buf, "0");
}
}
}
boost::shared_ptr<Plugin::ScalePoints>
LV2Plugin::get_scale_points(uint32_t port_index) const
{
SLV2Port port = slv2_plugin_get_port_by_index(_impl->plugin, port_index);
SLV2ScalePoints points = slv2_port_get_scale_points(_impl->plugin, port);
boost::shared_ptr<Plugin::ScalePoints> ret;
if (!points) {
return ret;
}
ret = boost::shared_ptr<Plugin::ScalePoints>(new ScalePoints());
for (unsigned i = 0; i < slv2_scale_points_size(points); ++i) {
SLV2ScalePoint p = slv2_scale_points_get_at(points, i);
SLV2Value label = slv2_scale_point_get_label(p);
SLV2Value value = slv2_scale_point_get_value(p);
if (label && (slv2_value_is_float(value) || slv2_value_is_int(value))) {
ret->insert(make_pair(slv2_value_as_string(label),
slv2_value_as_float(value)));
}
}
slv2_scale_points_free(points);
return ret;
}
void
LV2Plugin::run(pframes_t nframes)
{
for (uint32_t i = 0; i < parameter_count(); ++i) {
if (parameter_is_control(i) && parameter_is_input(i)) {
_control_data[i] = _shadow_data[i];
}
}
slv2_instance_run(_impl->instance, nframes);
}
void
LV2Plugin::latency_compute_run()
{
if (!_latency_control_port) {
return;
}
// Run the plugin so that it can set its latency parameter
activate();
uint32_t port_index = 0;
uint32_t in_index = 0;
uint32_t out_index = 0;
const framecnt_t bufsize = 1024;
float buffer[bufsize];
memset(buffer, 0, sizeof(float) * bufsize);
// FIXME: Ensure plugins can handle in-place processing
port_index = 0;
while (port_index < parameter_count()) {
if (parameter_is_audio(port_index)) {
if (parameter_is_input(port_index)) {
slv2_instance_connect_port(_impl->instance, port_index, buffer);
in_index++;
} else if (parameter_is_output(port_index)) {
slv2_instance_connect_port(_impl->instance, port_index, buffer);
out_index++;
}
}
port_index++;
}
run(bufsize);
deactivate();
}
LV2World::LV2World()
: world(slv2_world_new())
{
slv2_world_load_all(world);
input_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_INPUT);
output_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_OUTPUT);
control_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_CONTROL);
audio_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_AUDIO);
event_class = slv2_value_new_uri(world, SLV2_PORT_CLASS_EVENT);
midi_class = slv2_value_new_uri(world, SLV2_EVENT_CLASS_MIDI);
in_place_broken = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "inPlaceBroken");
integer = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "integer");
toggled = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "toggled");
srate = slv2_value_new_uri(world, SLV2_NAMESPACE_LV2 "sampleRate");
gtk_gui = slv2_value_new_uri(world, NS_UI "GtkUI");
external_gui = slv2_value_new_uri(world, NS_UI "external");
logarithmic = slv2_value_new_uri(world, "http://lv2plug.in/ns/dev/extportinfo#logarithmic");
}
LV2World::~LV2World()
{
slv2_value_free(input_class);
slv2_value_free(output_class);
slv2_value_free(control_class);
slv2_value_free(audio_class);
slv2_value_free(event_class);
slv2_value_free(midi_class);
slv2_value_free(in_place_broken);
}
LV2PluginInfo::LV2PluginInfo (void* c_plugin)
: _c_plugin(c_plugin)
{
type = ARDOUR::LV2;
}
LV2PluginInfo::~LV2PluginInfo()
{}
PluginPtr
LV2PluginInfo::load(Session& session)
{
try {
PluginPtr plugin;
plugin.reset(new LV2Plugin(session.engine(), session,
(SLV2Plugin)_c_plugin,
session.frame_rate()));
plugin->set_info(PluginInfoPtr(new LV2PluginInfo(*this)));
return plugin;
} catch (failed_constructor& err) {
return PluginPtr((Plugin*)0);
}
return PluginPtr();
}
PluginInfoList*
LV2PluginInfo::discover()
{
PluginInfoList* plugs = new PluginInfoList;
SLV2Plugins plugins = slv2_world_get_all_plugins(_world.world);
cerr << "LV2: Discovering " << slv2_plugins_size(plugins) << " plugins" << endl;
for (unsigned i = 0; i < slv2_plugins_size(plugins); ++i) {
SLV2Plugin p = slv2_plugins_get_at(plugins, i);
LV2PluginInfoPtr info(new LV2PluginInfo(p));
SLV2Value name = slv2_plugin_get_name(p);
if (!name) {
cerr << "LV2: invalid plugin\n";
continue;
}
info->type = LV2;
info->name = string(slv2_value_as_string(name));
slv2_value_free(name);
SLV2PluginClass pclass = slv2_plugin_get_class(p);
SLV2Value label = slv2_plugin_class_get_label(pclass);
info->category = slv2_value_as_string(label);
SLV2Value author_name = slv2_plugin_get_author_name(p);
info->creator = author_name ? string(slv2_value_as_string(author_name)) : "Unknown";
slv2_value_free(author_name);
info->path = "/NOPATH"; // Meaningless for LV2
info->n_inputs.set_audio(
slv2_plugin_get_num_ports_of_class(
p, _world.input_class, _world.audio_class, NULL));
info->n_inputs.set_midi(
slv2_plugin_get_num_ports_of_class(
p, _world.input_class, _world.event_class, NULL));
info->n_outputs.set_audio(
slv2_plugin_get_num_ports_of_class(
p, _world.output_class, _world.audio_class, NULL));
info->n_outputs.set_midi(
slv2_plugin_get_num_ports_of_class(
p, _world.output_class, _world.event_class, NULL));
info->unique_id = slv2_value_as_uri(slv2_plugin_get_uri(p));
info->index = 0; // Meaningless for LV2
plugs->push_back(info);
}
cerr << "Done LV2 discovery" << endl;
return plugs;
}