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