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