libs/ardour/ardour/lv2_plugin.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Dave Robillard
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20
  21 #ifndef __ardour_lv2_plugin_h__
  22 #define __ardour_lv2_plugin_h__
  23
  24 #include <set>
  25 #include <vector>
  26 #include <string>
  27 #include <dlfcn.h>
  28
  29
  30 #include "pbd/stateful.h"
  31
  32 #include <jack/types.h>
  33 #include <slv2/slv2.h>
  34 #include "ardour/plugin.h"
  35 #include "ardour/uri_map.h"
  36
  37 namespace ARDOUR {
  38 class AudioEngine;
  39 class Session;
  40 struct LV2World;
  41
  42 class LV2Plugin : public ARDOUR::Plugin
  43 {
  44   public:
  45         LV2Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&, ARDOUR::LV2World&, SLV2Plugin plugin, nframes_t sample_rate);
  46         LV2Plugin (const LV2Plugin &);
  47         ~LV2Plugin ();
  48
  49         /* Plugin interface */
  50
  51         std::string unique_id() const;
  52         const char* label() const           { return slv2_value_as_string(_name); }
  53         const char* name() const            { return slv2_value_as_string(_name); }
  54         const char* maker() const           { return _author ? slv2_value_as_string(_author) : "Unknown"; }
  55         uint32_t    parameter_count() const { return slv2_plugin_get_num_ports(_plugin); }
  56         float       default_value (uint32_t port);
  57         nframes_t   signal_latency() const;
  58         void        set_parameter (uint32_t port, float val);
  59         float       get_parameter (uint32_t port) const;
  60         int         get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  61         uint32_t    nth_parameter (uint32_t port, bool& ok) const;
  62
  63         const void* extension_data(const char* uri) { return _instance->lv2_descriptor->extension_data(uri); }
  64
  65         SLV2Plugin slv2_plugin()         { return _plugin; }
  66         SLV2UI     slv2_ui()             { return _ui; }
  67         bool       is_external_ui() const;
  68         SLV2Port   slv2_port(uint32_t i) { return slv2_plugin_get_port_by_index(_plugin, i); }
  69
  70         const char* port_symbol(uint32_t port);
  71
  72         const LV2_Feature* const* features() { return _features; }
  73
  74         std::set<Evoral::Parameter> automatable() const;
  75
  76         void activate () {
  77                 if (!_was_activated) {
  78                         slv2_instance_activate(_instance);
  79                         _was_activated = true;
  80                 }
  81         }
  82
  83         void deactivate () {
  84                 if (_was_activated) {
  85                         slv2_instance_deactivate(_instance);
  86                         _was_activated = false;
  87                 }
  88         }
  89
  90         void cleanup () {
  91                 activate();
  92                 deactivate();
  93                 slv2_instance_free(_instance);
  94                 _instance = NULL;
  95         }
  96
  97         void set_block_size (nframes_t /*nframes*/) {}
  98
  99         int connect_and_run (BufferSet& bufs,
 100                         ChanMapping in, ChanMapping out,
 101                         nframes_t nframes, nframes_t offset);
 102
 103         std::string describe_parameter (Evoral::Parameter);
 104         std::string state_node_name() const { return "lv2"; }
 105         void        print_parameter (uint32_t, char*, uint32_t len) const;
 106
 107         bool parameter_is_audio(uint32_t) const;
 108         bool parameter_is_control(uint32_t) const;
 109         bool parameter_is_midi(uint32_t) const;
 110         bool parameter_is_input(uint32_t) const;
 111         bool parameter_is_output(uint32_t) const;
 112         bool parameter_is_toggled(uint32_t) const;
 113
 114         static uint32_t midi_event_type() { return _midi_event_type; }
 115
 116         XMLNode& get_state();
 117         int      set_state(const XMLNode& node, int version);
 118         bool     save_preset(std::string uri);
 119         bool     load_preset(const std::string& uri);
 120         virtual std::vector<Plugin::PresetRecord> get_presets();
 121
 122         bool has_editor() const;
 123
 124   private:
 125         void*                    _module;
 126         LV2World&                _world;
 127         LV2_Feature**            _features;
 128         SLV2Plugin               _plugin;
 129         SLV2UI                   _ui;
 130         SLV2Value                _name;
 131         SLV2Value                _author;
 132         SLV2Instance             _instance;
 133         nframes_t                _sample_rate;
 134         float*                   _control_data;
 135         float*                   _shadow_data;
 136         float*                   _defaults;
 137         float*                   _latency_control_port;
 138         bool                     _was_activated;
 139         std::vector<bool>        _port_is_input;
 140         std::map<std::string,uint32_t> _port_indices;
 141
 142         typedef struct { const void* (*extension_data)(const char* uri); } LV2_DataAccess;
 143         LV2_DataAccess _data_access_extension_data;
 144         LV2_Feature _data_access_feature;
 145         LV2_Feature _instance_access_feature;
 146
 147         static URIMap   _uri_map;
 148         static uint32_t _midi_event_type;
 149
 150         void init (LV2World& world, SLV2Plugin plugin, nframes_t rate);
 151         void run (nframes_t nsamples);
 152         void latency_compute_run ();
 153 };
 154
 155
 156 /** The SLV2World, and various cached (as symbols, fast) URIs.
 157  *
 158  * This object represents everything ardour 'knows' about LV2
 159  * (ie understood extensions/features/etc)
 160  */
 161 struct LV2World {
 162         LV2World();
 163         ~LV2World();
 164
 165         SLV2World world;
 166         SLV2Value input_class; ///< Input port
 167         SLV2Value output_class; ///< Output port
 168         SLV2Value audio_class; ///< Audio port
 169         SLV2Value control_class; ///< Control port
 170         SLV2Value event_class; ///< Event port
 171         SLV2Value midi_class; ///< MIDI event
 172         SLV2Value in_place_broken;
 173         SLV2Value integer;
 174         SLV2Value toggled;
 175         SLV2Value srate;
 176         SLV2Value gtk_gui;
 177         SLV2Value external_gui;
 178         SLV2Value logarithmic;
 179 };
 180
 181
 182 class LV2PluginInfo : public PluginInfo {
 183 public:
 184         LV2PluginInfo (void* slv2_world, void* slv2_plugin);;
 185         ~LV2PluginInfo ();;
 186         static PluginInfoList* discover (void* slv2_world);
 187
 188         PluginPtr load (Session& session);
 189
 190         void* _lv2_world;
 191         void* _slv2_plugin;
 192 };
 193
 194 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
 195
 196 } // namespace ARDOUR
 197
 198 #endif /* __ardour_lv2_plugin_h__ */