finally get to the bottom of where NO_PLUGIN_STATE needs to be in order to be useful
[ardour.git] / libs / ardour / lv2_plugin.cc
index 58f5844501e11b02dd9f3ac07498d8fb8e2b0fd6..5ea76934a5ffe85923ee5be67d6c052aaacb45c5 100644 (file)
 
 #include <boost/utility.hpp>
 
+#include "pbd/pathscanner.h"
 #include "pbd/compose.h"
 #include "pbd/error.h"
 #include "pbd/xml++.h"
 
 #include "libardour-config.h"
 
-#include "ardour/types.h"
 #include "ardour/audio_buffer.h"
 #include "ardour/audioengine.h"
 #include "ardour/debug.h"
 #include "ardour/lv2_plugin.h"
 #include "ardour/session.h"
 #include "ardour/tempo.h"
+#include "ardour/types.h"
+#include "ardour/utils.h"
 #include "ardour/worker.h"
+#include "ardour/lv2_bundled_search_path.h"
 
 #include "i18n.h"
 #include <locale.h>
@@ -60,6 +63,7 @@
 #include "lv2/lv2plug.in/ns/ext/state/state.h"
 #include "lv2/lv2plug.in/ns/ext/time/time.h"
 #include "lv2/lv2plug.in/ns/ext/worker/worker.h"
+#include "lv2/lv2plug.in/ns/ext/resize-port/resize-port.h"
 #include "lv2/lv2plug.in/ns/extensions/ui/ui.h"
 #ifdef HAVE_NEW_LV2
 #include "lv2/lv2plug.in/ns/ext/buf-size/buf-size.h"
@@ -108,6 +112,8 @@ public:
        LV2World ();
        ~LV2World ();
 
+       void load_bundled_plugins();
+
        LilvWorld* world;
 
        LilvNode* atom_AtomPort;
@@ -118,20 +124,27 @@ public:
        LilvNode* atom_supports;
        LilvNode* ev_EventPort;
        LilvNode* ext_logarithmic;
+       LilvNode* ext_notOnGUI;
        LilvNode* lv2_AudioPort;
        LilvNode* lv2_ControlPort;
        LilvNode* lv2_InputPort;
        LilvNode* lv2_OutputPort;
        LilvNode* lv2_enumeration;
+       LilvNode* lv2_freewheeling;
        LilvNode* lv2_inPlaceBroken;
        LilvNode* lv2_integer;
+       LilvNode* lv2_reportsLatency;
        LilvNode* lv2_sampleRate;
        LilvNode* lv2_toggled;
        LilvNode* midi_MidiEvent;
        LilvNode* rdfs_comment;
+       LilvNode* rsz_minimumSize;
        LilvNode* time_Position;
        LilvNode* ui_GtkUI;
        LilvNode* ui_external;
+
+private:
+       bool _bundle_checked;
 };
 
 static LV2World _world;
@@ -394,7 +407,7 @@ LV2Plugin::init(const void* c_plugin, framecnt_t rate)
        // Load default state
        LilvState* state = lilv_state_new_from_world(
                _world.world, _uri_map.urid_map(), lilv_plugin_get_uri(_impl->plugin));
-       if (state) {
+       if (state && _has_state_interface) {
                lilv_state_restore(state, _impl->instance, NULL, NULL, 0, NULL);
        }
 #endif
@@ -405,6 +418,7 @@ LV2Plugin::init(const void* c_plugin, framecnt_t rate)
        for (uint32_t i = 0; i < num_ports; ++i) {
                const LilvPort* port  = lilv_plugin_get_port_by_index(_impl->plugin, i);
                PortFlags       flags = 0;
+               size_t          minimumSize = 0;
 
                if (lilv_port_is_a(_impl->plugin, port, _world.lv2_OutputPort)) {
                        flags |= PORT_OUTPUT;
@@ -439,6 +453,12 @@ LV2Plugin::init(const void* c_plugin, framecnt_t rate)
                                        flags |= PORT_POSITION;
                                }
                        }
+                       LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
+                       LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
+                       if (min_size && lilv_node_is_int(min_size)) {
+                               minimumSize = lilv_node_as_int(min_size);
+                       }
+                       lilv_nodes_free(min_size_v);
                        lilv_nodes_free(buffer_types);
                        lilv_nodes_free(atom_supports);
                } else {
@@ -449,6 +469,7 @@ LV2Plugin::init(const void* c_plugin, framecnt_t rate)
                }
 
                _port_flags.push_back(flags);
+               _port_minimumSize.push_back(minimumSize);
        }
 
        _control_data = new float[num_ports];
@@ -961,38 +982,38 @@ LV2Plugin::find_presets()
        lilv_node_free(lv2_appliesTo);
 }
 
-bool
-LV2Plugin::load_preset(PresetRecord r)
+static void
+set_port_value(const char* port_symbol,
+               void*       user_data,
+               const void* value,
+               uint32_t    /*size*/,
+               uint32_t    type)
 {
-       std::map<std::string,uint32_t>::iterator it;
-
-       LilvNode* lv2_port   = lilv_new_uri(_world.world, LILV_NS_LV2 "port");
-       LilvNode* lv2_symbol = lilv_new_uri(_world.world, LILV_NS_LV2 "symbol");
-       LilvNode* preset     = lilv_new_uri(_world.world, r.uri.c_str());
-       LilvNode* pset_value = lilv_new_uri(_world.world, LV2_PRESETS__value);
-
-       LilvNodes* ports = lilv_world_find_nodes(_world.world, preset, lv2_port, NULL);
-       LILV_FOREACH(nodes, i, ports) {
-               const LilvNode* port   = lilv_nodes_get(ports, i);
-               const LilvNode* symbol = get_value(_world.world, port, lv2_symbol);
-               const LilvNode* value  = get_value(_world.world, port, pset_value);
-               if (value && lilv_node_is_float(value)) {
-                       it = _port_indices.find(lilv_node_as_string(symbol));
-                       if (it != _port_indices.end()) {
-                               set_parameter(it->second,lilv_node_as_float(value));
-                       }
-               }
+       LV2Plugin* self = (LV2Plugin*)user_data;
+       if (type != 0 && type != self->_uri_map.uri_to_id(LV2_ATOM__Float)) {
+               return;  // TODO: Support non-float ports
        }
-       lilv_nodes_free(ports);
 
-       lilv_node_free(pset_value);
-       lilv_node_free(preset);
-       lilv_node_free(lv2_symbol);
-       lilv_node_free(lv2_port);
+       const uint32_t port_index = self->port_index(port_symbol);
+       if (port_index != (uint32_t)-1) {
+               self->set_parameter(port_index, *(const float*)value);
+       }
+}
 
-       Plugin::load_preset(r);
+bool
+LV2Plugin::load_preset(PresetRecord r)
+{
+       LilvWorld* world = _world.world;
+       LilvNode*  pset  = lilv_new_uri(world, r.uri.c_str());
+       LilvState* state = lilv_state_new_from_world(world, _uri_map.urid_map(), pset);
 
-       return true;
+       if (state) {
+               lilv_state_restore(state, _impl->instance, set_port_value, this, 0, NULL);
+               lilv_state_free(state);
+       }
+
+       lilv_node_free(pset);
+       return state;
 }
 
 const void*
@@ -1023,42 +1044,40 @@ ARDOUR::lv2plugin_get_port_value(const char* port_symbol,
 std::string
 LV2Plugin::do_save_preset(string name)
 {
-       string pset_uri = uri();
-       pset_uri += "#";
-       pset_uri += name;
-
-       string save_dir = Glib::build_filename(
+       const string base_name = legalize_for_uri(name);
+       const string file_name = base_name + ".ttl";
+       const string bundle    = Glib::build_filename(
                Glib::get_home_dir(),
-               Glib::build_filename(".lv2", "presets")
-       );
+               Glib::build_filename(".lv2", base_name + ".lv2"));
 
        LilvState* state = lilv_state_new_from_instance(
                _impl->plugin,
                _impl->instance,
                _uri_map.urid_map(),
-               scratch_dir().c_str(),                  // file_dir
-               NULL,                                   // copy_dir
-               NULL,                                   // link_dir
-               save_dir.c_str(),                       // save_dir
-               lv2plugin_get_port_value,               // get_value
-               (void*) this,                           // user_data
-               LV2_STATE_IS_POD|LV2_STATE_IS_PORTABLE, // flags
-               _features                               // features
+               scratch_dir().c_str(),                   // file_dir
+               bundle.c_str(),                          // copy_dir
+               bundle.c_str(),                          // link_dir
+               bundle.c_str(),                          // save_dir
+               lv2plugin_get_port_value,                // get_value
+               (void*)this,                             // user_data
+               LV2_STATE_IS_POD|LV2_STATE_IS_PORTABLE,  // flags
+               _features                                // features
        );
 
        lilv_state_set_label(state, name.c_str());
        lilv_state_save(
                _world.world,           // world
-               _uri_map.urid_map(),    // map
-               _uri_map.urid_unmap(),  // unmap
+               _uri_map.urid_map(),    // map
+               _uri_map.urid_unmap(),  // unmap
                state,                  // state
-               pset_uri.c_str(),       // uri
-               save_dir.c_str(),       // dir
-               (name + ".ttl").c_str() // filename
+               NULL,                   // uri (NULL = use file URI)
+               bundle.c_str(),         // dir
+               file_name.c_str()       // filename
        );
 
        lilv_state_free(state);
-       return pset_uri;
+
+       return Glib::filename_to_uri(Glib::build_filename(bundle, file_name));
 }
 
 void
@@ -1214,6 +1233,8 @@ LV2Plugin::set_state(const XMLNode& node, int version)
                return -1;
        }
 
+#ifndef NO_PLUGIN_STATE
+
        if (version < 3000) {
                nodes = node.children("port");
        } else {
@@ -1269,6 +1290,7 @@ LV2Plugin::set_state(const XMLNode& node, int version)
        }
 
        latency_compute_run();
+#endif
 
        return Plugin::set_state(node, version);
 }
@@ -1320,6 +1342,27 @@ string
 LV2Plugin::describe_parameter(Evoral::Parameter which)
 {
        if (( which.type() == PluginAutomation) && ( which.id() < parameter_count()) ) {
+
+               if (lilv_port_has_property(_impl->plugin,
+                                       lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.ext_notOnGUI)) {
+                       return X_("hidden");
+               }
+
+               if (lilv_port_has_property(_impl->plugin,
+                                       lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_freewheeling)) {
+                       return X_("hidden");
+               }
+
+               if (lilv_port_has_property(_impl->plugin,
+                                       lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_sampleRate)) {
+                       return X_("hidden");
+               }
+
+               if (lilv_port_has_property(_impl->plugin,
+                                       lilv_plugin_get_port_by_index(_impl->plugin, which.id()), _world.lv2_reportsLatency)) {
+                       return X_("latency");
+               }
+
                LilvNode* name = lilv_port_get_name(_impl->plugin,
                                                    lilv_plugin_get_port_by_index(_impl->plugin, which.id()));
                string ret(lilv_node_as_string(name));
@@ -1398,6 +1441,7 @@ LV2Plugin::allocate_atom_event_buffers()
         */
        int count_atom_out = 0;
        int count_atom_in = 0;
+       int minimumSize = 32768; // TODO use a per-port minimum-size
        for (uint32_t i = 0; i < lilv_plugin_get_num_ports(p); ++i) {
                const LilvPort* port  = lilv_plugin_get_port_by_index(p, i);
                if (lilv_port_is_a(p, port, _world.atom_AtomPort)) {
@@ -1414,6 +1458,12 @@ LV2Plugin::allocate_atom_event_buffers()
                                if (lilv_port_is_a(p, port, _world.lv2_OutputPort)) {
                                        count_atom_out++;
                                }
+                               LilvNodes* min_size_v = lilv_port_get_value(_impl->plugin, port, _world.rsz_minimumSize);
+                               LilvNode* min_size = min_size_v ? lilv_nodes_get_first(min_size_v) : NULL;
+                               if (min_size && lilv_node_is_int(min_size)) {
+                                       minimumSize = std::max(minimumSize, lilv_node_as_int(min_size));
+                               }
+                               lilv_nodes_free(min_size_v);
                        }
                        lilv_nodes_free(buffer_types);
                        lilv_nodes_free(atom_supports);
@@ -1431,7 +1481,7 @@ LV2Plugin::allocate_atom_event_buffers()
        DEBUG_TRACE(DEBUG::LV2, string_compose("allocate %1 atom_ev_buffers\n", total_atom_buffers));
        _atom_ev_buffers = (LV2_Evbuf**) malloc((total_atom_buffers + 1) * sizeof(LV2_Evbuf*));
        for (int i = 0; i < total_atom_buffers; ++i ) {
-               _atom_ev_buffers[i] = lv2_evbuf_new(32768, LV2_EVBUF_ATOM,
+               _atom_ev_buffers[i] = lv2_evbuf_new(minimumSize, LV2_EVBUF_ATOM,
                                LV2Plugin::urids.atom_Chunk, LV2Plugin::urids.atom_Sequence);
        }
        _atom_ev_buffers[total_atom_buffers] = 0;
@@ -1540,6 +1590,12 @@ LV2Plugin::connect_and_run(BufferSet& bufs,
                                        index = out_map.get(DataType::MIDI, midi_out_index++, &valid);
                                }
                                if (valid && bufs.count().n_midi() > index) {
+                                       /* Note, ensure_lv2_bufsize() is not RT safe!
+                                        * However free()/alloc() is only called if a
+                                        * plugin requires a rsz:minimumSize buffersize
+                                        * and the existing buffer if smaller.
+                                        */
+                                       bufs.ensure_lv2_bufsize((flags & PORT_INPUT), index, _port_minimumSize[port_index]);
                                        _ev_buffers[port_index] = bufs.get_lv2_midi(
                                                (flags & PORT_INPUT), index, (flags & PORT_EVENT));
                                }
@@ -1571,7 +1627,6 @@ LV2Plugin::connect_and_run(BufferSet& bufs,
                                        : m;
 
                                // Now merge MIDI and any transport events into the buffer
-                               LV2_Evbuf_Iterator i    = lv2_evbuf_end(_ev_buffers[port_index]);
                                const uint32_t     type = LV2Plugin::urids.midi_MidiEvent;
                                const framepos_t   tend = _session.transport_frame() + nframes;
                                ++metric_i;
@@ -1642,8 +1697,28 @@ LV2Plugin::connect_and_run(BufferSet& bufs,
                PortFlags flags = _port_flags[port_index];
                bool      valid = false;
 
-               // Flush MIDI (write back to Ardour MIDI buffers)
-               if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
+               /* TODO ask drobilla about comment
+                * "Make Ardour event buffers generic so plugins can communicate"
+                * in libs/ardour/buffer_set.cc:310
+                *
+                * ideally the user could choose which of the following two modes
+                * to use (e.g. instrument/effect chains  MIDI OUT vs MIDI TRHU).
+                *
+                * This implementation follows the discussion on IRC Mar 16 2013 16:47 UTC
+                * 16:51 < drobilla> rgareus: [..] i.e always replace with MIDI output [of LV2 plugin] if it's there
+                * 16:52 < drobilla> rgareus: That would probably be good enough [..] to make users not complain
+                *                            for quite a while at least ;)
+                */
+               // copy output of LV2 plugin's MIDI port to Ardour MIDI buffers -- MIDI OUT
+               if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE|PORT_MIDI))) {
+                       const uint32_t buf_index = out_map.get(
+                               DataType::MIDI, midi_out_index++, &valid);
+                       if (valid) {
+                               bufs.forward_lv2_midi(_ev_buffers[port_index], buf_index);
+                       }
+               }
+               // Flush MIDI (write back to Ardour MIDI buffers) -- MIDI THRU
+               else if ((flags & PORT_OUTPUT) && (flags & (PORT_EVENT|PORT_SEQUENCE))) {
                        const uint32_t buf_index = out_map.get(
                                DataType::MIDI, midi_out_index++, &valid);
                        if (valid) {
@@ -1826,10 +1901,20 @@ LV2Plugin::Impl::designated_input (const char* uri, void** bufptrs[], void** buf
        return port;
 }
 
+static bool lv2_filter (const string& str, void *arg)
+{
+       /* Not a dotfile, has a prefix before a period, suffix is "lv2" */
+       
+       return str[0] != '.' && (str.length() > 3 && str.find (".lv2") == (str.length() - 4));
+}
+
+
 LV2World::LV2World()
        : world(lilv_world_new())
+       , _bundle_checked(false)
 {
        lilv_world_load_all(world);
+
        atom_AtomPort      = lilv_new_uri(world, LV2_ATOM__AtomPort);
        atom_Chunk         = lilv_new_uri(world, LV2_ATOM__Chunk);
        atom_Sequence      = lilv_new_uri(world, LV2_ATOM__Sequence);
@@ -1838,17 +1923,21 @@ LV2World::LV2World()
        atom_eventTransfer = lilv_new_uri(world, LV2_ATOM__eventTransfer);
        ev_EventPort       = lilv_new_uri(world, LILV_URI_EVENT_PORT);
        ext_logarithmic    = lilv_new_uri(world, LV2_PORT_PROPS__logarithmic);
+       ext_notOnGUI       = lilv_new_uri(world, LV2_PORT_PROPS__notOnGUI);
        lv2_AudioPort      = lilv_new_uri(world, LILV_URI_AUDIO_PORT);
        lv2_ControlPort    = lilv_new_uri(world, LILV_URI_CONTROL_PORT);
        lv2_InputPort      = lilv_new_uri(world, LILV_URI_INPUT_PORT);
        lv2_OutputPort     = lilv_new_uri(world, LILV_URI_OUTPUT_PORT);
        lv2_inPlaceBroken  = lilv_new_uri(world, LV2_CORE__inPlaceBroken);
        lv2_integer        = lilv_new_uri(world, LV2_CORE__integer);
+       lv2_reportsLatency = lilv_new_uri(world, LV2_CORE__reportsLatency);
        lv2_sampleRate     = lilv_new_uri(world, LV2_CORE__sampleRate);
        lv2_toggled        = lilv_new_uri(world, LV2_CORE__toggled);
        lv2_enumeration    = lilv_new_uri(world, LV2_CORE__enumeration);
+       lv2_freewheeling   = lilv_new_uri(world, LV2_CORE__freeWheeling);
        midi_MidiEvent     = lilv_new_uri(world, LILV_URI_MIDI_EVENT);
        rdfs_comment       = lilv_new_uri(world, LILV_NS_RDFS "comment");
+       rsz_minimumSize    = lilv_new_uri(world, LV2_RESIZE_PORT__minimumSize);
        time_Position      = lilv_new_uri(world, LV2_TIME__Position);
        ui_GtkUI           = lilv_new_uri(world, LV2_UI__GtkUI);
        ui_external        = lilv_new_uri(world, "http://lv2plug.in/ns/extensions/ui#external");
@@ -1858,17 +1947,25 @@ LV2World::~LV2World()
 {
        lilv_node_free(ui_external);
        lilv_node_free(ui_GtkUI);
+       lilv_node_free(time_Position);
+       lilv_node_free(rsz_minimumSize);
+       lilv_node_free(rdfs_comment);
        lilv_node_free(midi_MidiEvent);
+       lilv_node_free(lv2_enumeration);
+       lilv_node_free(lv2_freewheeling);
        lilv_node_free(lv2_toggled);
        lilv_node_free(lv2_sampleRate);
+       lilv_node_free(lv2_reportsLatency);
        lilv_node_free(lv2_integer);
        lilv_node_free(lv2_inPlaceBroken);
        lilv_node_free(lv2_OutputPort);
        lilv_node_free(lv2_InputPort);
        lilv_node_free(lv2_ControlPort);
        lilv_node_free(lv2_AudioPort);
+       lilv_node_free(ext_notOnGUI);
        lilv_node_free(ext_logarithmic);
        lilv_node_free(ev_EventPort);
+       lilv_node_free(atom_supports);
        lilv_node_free(atom_eventTransfer);
        lilv_node_free(atom_bufferType);
        lilv_node_free(atom_Sequence);
@@ -1876,6 +1973,31 @@ LV2World::~LV2World()
        lilv_node_free(atom_AtomPort);
 }
 
+void
+LV2World::load_bundled_plugins()
+{
+       if (!_bundle_checked) {
+               cout << "Scanning folders for bundled LV2s: " << ARDOUR::lv2_bundled_search_path().to_string() << endl;
+               PathScanner scanner;
+               vector<string *> *plugin_objects = scanner (ARDOUR::lv2_bundled_search_path().to_string(), lv2_filter, 0, true, true);
+               if (plugin_objects) {
+                       for ( vector<string *>::iterator x = plugin_objects->begin(); x != plugin_objects->end (); ++x) {
+#ifdef WINDOWS
+                               string uri = "file:///" + **x + "/";
+#else
+                               string uri = "file://" + **x + "/";
+#endif
+                               LilvNode *node = lilv_new_uri(world, uri.c_str());
+                               lilv_world_load_bundle(world, node);
+                               lilv_node_free(node);
+                       }
+               }
+               delete (plugin_objects);
+
+               _bundle_checked = true;
+       }
+}
+
 LV2PluginInfo::LV2PluginInfo (const void* c_plugin)
        : _c_plugin(c_plugin)
 {
@@ -1907,6 +2029,8 @@ LV2PluginInfo::load(Session& session)
 PluginInfoList*
 LV2PluginInfo::discover()
 {
+       _world.load_bundled_plugins();
+
        PluginInfoList*    plugs   = new PluginInfoList;
        const LilvPlugins* plugins = lilv_world_get_all_plugins(_world.world);