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 #include <sigc++/signal.h>
  30
  31 #include <pbd/stateful.h>
  32
  33 #include <jack/types.h>
  34 #include <slv2/slv2.h>
  35 #include <ardour/plugin.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         SLV2Port   slv2_port(uint32_t i) { return slv2_plugin_get_port_by_index(_plugin, i); }
  68
  69         const char* port_symbol(uint32_t port);
  70
  71         const LV2_Feature* const* features() { return _features; }
  72
  73         std::set<Evoral::Parameter> automatable() const;
  74
  75         void activate () {
  76                 if (!_was_activated) {
  77                         slv2_instance_activate(_instance);
  78                         _was_activated = true;
  79                 }
  80         }
  81
  82         void deactivate () {
  83                 if (_was_activated) {
  84                         slv2_instance_deactivate(_instance);
  85                         _was_activated = false;
  86                 }
  87         }
  88
  89         void cleanup () {
  90                 activate();
  91                 deactivate();
  92                 slv2_instance_free(_instance);
  93                 _instance = NULL;
  94         }
  95
  96         void set_block_size (nframes_t nframes) {}
  97
  98         int         connect_and_run (BufferSet& bufs, uint32_t& in, uint32_t& out, nframes_t nframes, nframes_t offset);
  99         std::string describe_parameter (Evoral::Parameter);
 100         std::string state_node_name() const { return "lv2"; }
 101         void        print_parameter (uint32_t, char*, uint32_t len) const;
 102
 103         bool parameter_is_audio(uint32_t) const;
 104         bool parameter_is_control(uint32_t) const;
 105         bool parameter_is_midi(uint32_t) const;
 106         bool parameter_is_input(uint32_t) const;
 107         bool parameter_is_output(uint32_t) const;
 108         bool parameter_is_toggled(uint32_t) const;
 109
 110         XMLNode& get_state();
 111         int      set_state(const XMLNode& node);
 112         bool     save_preset(std::string uri);
 113         bool     load_preset(const string uri);
 114         virtual std::vector<Plugin::PresetRecord> get_presets();
 115
 116         bool has_editor() const;
 117
 118   private:
 119         void*                    _module;
 120         LV2World&                _world;
 121         LV2_Feature**            _features;
 122         SLV2Plugin               _plugin;
 123         SLV2UI                   _ui;
 124         SLV2Value                _name;
 125         SLV2Value                _author;
 126         SLV2Instance             _instance;
 127         nframes_t                _sample_rate;
 128         float*                   _control_data;
 129         float*                   _shadow_data;
 130         float*                   _defaults;
 131         float*                   _latency_control_port;
 132         bool                     _was_activated;
 133         vector<bool>             _port_is_input;
 134         map<string,uint32_t>     _port_indices;
 135
 136         typedef struct { const void* (*extension_data)(const char* uri); } LV2_DataAccess;
 137         LV2_DataAccess _data_access_extension_data;
 138         LV2_Feature _data_access_feature;
 139         LV2_Feature _instance_access_feature;
 140
 141         void init (LV2World& world, SLV2Plugin plugin, nframes_t rate);
 142         void run (nframes_t nsamples);
 143         void latency_compute_run ();
 144 };
 145
 146
 147 /** The SLV2World, and various cached (as symbols, fast) URIs.
 148  *
 149  * This object represents everything ardour 'knows' about LV2
 150  * (ie understood extensions/features/etc)
 151  */
 152 struct LV2World {
 153         LV2World();
 154         ~LV2World();
 155
 156         SLV2World world;
 157         SLV2Value input_class; ///< Input port
 158         SLV2Value output_class; ///< Output port
 159         SLV2Value audio_class; ///< Audio port
 160         SLV2Value control_class; ///< Control port
 161         SLV2Value event_class; ///< Event port
 162         SLV2Value midi_class; ///< MIDI event
 163         SLV2Value in_place_broken;
 164         SLV2Value integer;
 165         SLV2Value toggled;
 166         SLV2Value srate;
 167         SLV2Value gtk_gui;
 168 };
 169
 170
 171 class LV2PluginInfo : public PluginInfo {
 172 public:
 173         LV2PluginInfo (void* slv2_world, void* slv2_plugin);;
 174         ~LV2PluginInfo ();;
 175         static PluginInfoList discover (void* slv2_world);
 176
 177         PluginPtr load (Session& session);
 178
 179         void* _lv2_world;
 180         void* _slv2_plugin;
 181 };
 182
 183 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
 184
 185 } // namespace ARDOUR
 186
 187 #endif /* __ardour_lv2_plugin_h__ */