libs/ardour/ardour/lv2_plugin.h

   1 /*
   2     Copyright (C) 2008-2012 Paul Davis
   3     Author: David 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 #ifndef __ardour_lv2_plugin_h__
  21 #define __ardour_lv2_plugin_h__
  22
  23 #include <set>
  24 #include <string>
  25 #include <vector>
  26 #include <boost/enable_shared_from_this.hpp>
  27
  28 #include "ardour/plugin.h"
  29 #include "ardour/uri_map.h"
  30 #include "ardour/worker.h"
  31 #include "pbd/ringbuffer.h"
  32
  33 #ifndef PATH_MAX
  34 #define PATH_MAX 1024
  35 #endif
  36
  37 typedef struct LV2_Evbuf_Impl LV2_Evbuf;
  38
  39 namespace ARDOUR {
  40
  41 // a callback function for lilv_state_new_from_instance(). friend of LV2Plugin
  42 // so we can pass an LV2Plugin* in user_data and access its private members.
  43 const void* lv2plugin_get_port_value(const char* port_symbol,
  44                                      void*       user_data,
  45                                      uint32_t*   size,
  46                                      uint32_t*   type);
  47
  48 class AudioEngine;
  49 class Session;
  50
  51 class LIBARDOUR_API LV2Plugin : public ARDOUR::Plugin, public ARDOUR::Workee
  52 {
  53   public:
  54         LV2Plugin (ARDOUR::AudioEngine& engine,
  55                    ARDOUR::Session&     session,
  56                    const void*          c_plugin,
  57                    framecnt_t           sample_rate);
  58         LV2Plugin (const LV2Plugin &);
  59         ~LV2Plugin ();
  60
  61         std::string unique_id () const;
  62         const char* uri () const;
  63         const char* label () const;
  64         const char* name () const;
  65         const char* maker () const;
  66
  67         uint32_t    num_ports () const;
  68         uint32_t    parameter_count () const;
  69         float       default_value (uint32_t port);
  70         framecnt_t  signal_latency () const;
  71         void        set_parameter (uint32_t port, float val);
  72         float       get_parameter (uint32_t port) const;
  73         std::string get_docs() const;
  74         std::string get_parameter_docs(uint32_t which) const;
  75         int         get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  76         uint32_t    nth_parameter (uint32_t port, bool& ok) const;
  77
  78         const void* extension_data (const char* uri) const;
  79
  80         const void* c_plugin();
  81         const void* c_ui();
  82         const void* c_ui_type();
  83
  84         bool is_external_ui () const;
  85         bool is_external_kx () const;
  86         bool ui_is_resizable () const;
  87
  88         const char* port_symbol (uint32_t port) const;
  89         uint32_t    port_index (const char* symbol) const;
  90
  91         const LV2_Feature* const* features () { return _features; }
  92
  93         std::set<Evoral::Parameter> automatable () const;
  94
  95         void activate ();
  96         void deactivate ();
  97         void cleanup ();
  98
  99         int set_block_size (pframes_t);
 100
 101         int connect_and_run (BufferSet& bufs,
 102                              ChanMapping in, ChanMapping out,
 103                              pframes_t nframes, framecnt_t offset);
 104
 105         std::string describe_parameter (Evoral::Parameter);
 106         std::string state_node_name () const { return "lv2"; }
 107
 108         void print_parameter (uint32_t param,
 109                               char*    buf,
 110                               uint32_t len) const;
 111
 112         bool parameter_is_audio (uint32_t) const;
 113         bool parameter_is_control (uint32_t) const;
 114         bool parameter_is_event (uint32_t) const;
 115         bool parameter_is_input (uint32_t) const;
 116         bool parameter_is_output (uint32_t) const;
 117         bool parameter_is_toggled (uint32_t) const;
 118
 119         boost::shared_ptr<ScalePoints>
 120         get_scale_points(uint32_t port_index) const;
 121
 122         void set_insert_id(PBD::ID id);
 123
 124         int      set_state (const XMLNode& node, int version);
 125         bool     save_preset (std::string uri);
 126         void     remove_preset (std::string uri);
 127         bool     load_preset (PresetRecord);
 128         std::string current_preset () const;
 129
 130         bool has_editor () const;
 131         bool has_message_output () const;
 132
 133         bool write_from_ui(uint32_t       index,
 134                            uint32_t       protocol,
 135                            uint32_t       size,
 136                            const uint8_t* body);
 137
 138         typedef void UIMessageSink(void*       controller,
 139                                    uint32_t    index,
 140                                    uint32_t    size,
 141                                    uint32_t    format,
 142                                    const void* buffer);
 143
 144         void enable_ui_emission();
 145         void emit_to_ui(void* controller, UIMessageSink sink);
 146
 147         Worker* worker() { return _worker; }
 148
 149         URIMap&       uri_map()       { return _uri_map; }
 150         const URIMap& uri_map() const { return _uri_map; }
 151
 152         int work(uint32_t size, const void* data);
 153         int work_response(uint32_t size, const void* data);
 154
 155         void                       set_property(uint32_t key, const Variant& value);
 156         const PropertyDescriptors& get_supported_properties() const { return _property_descriptors; }
 157         const ParameterDescriptor& get_property_descriptor(uint32_t id) const;
 158         void                       announce_property_values();
 159
 160   private:
 161         struct Impl;
 162         Impl*         _impl;
 163         void*         _module;
 164         LV2_Feature** _features;
 165         Worker*       _worker;
 166         framecnt_t    _sample_rate;
 167         float*        _control_data;
 168         float*        _shadow_data;
 169         float*        _defaults;
 170         LV2_Evbuf**   _ev_buffers;
 171         LV2_Evbuf**   _atom_ev_buffers;
 172         float*        _bpm_control_port;  ///< Special input set by ardour
 173         float*        _freewheel_control_port;  ///< Special input set by ardour
 174         float*        _latency_control_port;  ///< Special output set by ardour
 175         framepos_t    _next_cycle_start;  ///< Expected start frame of next run cycle
 176         double        _next_cycle_speed;  ///< Expected start frame of next run cycle
 177         PBD::ID       _insert_id;
 178         uint32_t      _patch_port_in_index;
 179         uint32_t      _patch_port_out_index;
 180         URIMap&       _uri_map;
 181
 182         friend const void* lv2plugin_get_port_value(const char* port_symbol,
 183                                                     void*       user_data,
 184                                                     uint32_t*   size,
 185                                                     uint32_t*   type);
 186
 187         typedef enum {
 188                 PORT_INPUT    = 1,       ///< Input port
 189                 PORT_OUTPUT   = 1 << 1,  ///< Output port
 190                 PORT_AUDIO    = 1 << 2,  ///< Audio (buffer of float)
 191                 PORT_CONTROL  = 1 << 3,  ///< Control (single float)
 192                 PORT_EVENT    = 1 << 4,  ///< Old event API event port
 193                 PORT_SEQUENCE = 1 << 5,  ///< New atom API event port
 194                 PORT_MIDI     = 1 << 6,  ///< Event port understands MIDI
 195                 PORT_POSITION = 1 << 7,  ///< Event port understands position
 196                 PORT_PATCHMSG = 1 << 8   ///< Event port supports patch:Message
 197         } PortFlag;
 198
 199         typedef unsigned PortFlags;
 200
 201         std::vector<PortFlags>         _port_flags;
 202         std::vector<size_t>            _port_minimumSize;
 203         std::map<std::string,uint32_t> _port_indices;
 204
 205         PropertyDescriptors _property_descriptors;
 206
 207         /// Message send to/from UI via ports
 208         struct UIMessage {
 209                 uint32_t index;
 210                 uint32_t protocol;
 211                 uint32_t size;
 212         };
 213
 214         bool write_to_ui(uint32_t       index,
 215                          uint32_t       protocol,
 216                          uint32_t       size,
 217                          const uint8_t* body);
 218
 219         bool write_to(RingBuffer<uint8_t>* dest,
 220                       uint32_t             index,
 221                       uint32_t             protocol,
 222                       uint32_t             size,
 223                       const uint8_t*       body);
 224
 225         // Created on demand so the space is only consumed if necessary
 226         RingBuffer<uint8_t>* _to_ui;
 227         RingBuffer<uint8_t>* _from_ui;
 228
 229         typedef struct {
 230                 const void* (*extension_data) (const char* uri);
 231         } LV2_DataAccess;
 232
 233         LV2_DataAccess _data_access_extension_data;
 234         LV2_Feature    _data_access_feature;
 235         LV2_Feature    _instance_access_feature;
 236         LV2_Feature    _make_path_feature;
 237         LV2_Feature    _log_feature;
 238         LV2_Feature    _work_schedule_feature;
 239         LV2_Feature    _options_feature;
 240         LV2_Feature    _def_state_feature;
 241
 242         // Options passed to plugin
 243         int32_t _seq_size;
 244
 245         mutable unsigned _state_version;
 246
 247         bool _was_activated;
 248         bool _has_state_interface;
 249
 250         const std::string plugin_dir () const;
 251         const std::string scratch_dir () const;
 252         const std::string file_dir () const;
 253         const std::string state_dir (unsigned num) const;
 254
 255         static char* lv2_state_make_path (void*       host_data,
 256                                           const char* path);
 257
 258         void init (const void* c_plugin, framecnt_t rate);
 259         void allocate_atom_event_buffers ();
 260         void run (pframes_t nsamples);
 261
 262         void load_supported_properties(PropertyDescriptors& descs);
 263
 264         void latency_compute_run ();
 265         std::string do_save_preset (std::string);
 266         void do_remove_preset (std::string);
 267         void find_presets ();
 268         void add_state (XMLNode *) const;
 269 };
 270
 271
 272 class LIBARDOUR_API LV2PluginInfo : public PluginInfo , public boost::enable_shared_from_this<ARDOUR::LV2PluginInfo> {
 273 public:
 274         LV2PluginInfo (const char* plugin_uri);
 275         ~LV2PluginInfo ();
 276
 277         static PluginInfoList* discover ();
 278
 279         PluginPtr load (Session& session);
 280         virtual bool in_category (const std::string &c) const;
 281
 282         char * _plugin_uri;
 283 };
 284
 285 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
 286
 287 } // namespace ARDOUR
 288
 289 #endif /* __ardour_lv2_plugin_h__ */