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 class AudioEngine;
  35 class Session;
  36
  37 class LV2Plugin : public ARDOUR::Plugin, public ARDOUR::Workee
  38 {
  39   public:
  40         LV2Plugin (ARDOUR::AudioEngine& engine,
  41                    ARDOUR::Session&     session,
  42                    void*                c_plugin,
  43                    framecnt_t           sample_rate);
  44         LV2Plugin (const LV2Plugin &);
  45         ~LV2Plugin ();
  46
  47         std::string unique_id () const;
  48         const char* uri () const;
  49         const char* label () const;
  50         const char* name () const;
  51         const char* maker () const;
  52
  53         uint32_t   num_ports () const;
  54         uint32_t   parameter_count () const;
  55         float      default_value (uint32_t port);
  56         framecnt_t signal_latency () const;
  57         void       set_parameter (uint32_t port, float val);
  58         float      get_parameter (uint32_t port) const;
  59         int        get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  60         uint32_t   nth_parameter (uint32_t port, bool& ok) const;
  61
  62         const void* extension_data (const char* uri) const;
  63
  64         void* c_plugin();
  65         void* c_ui();
  66         void* c_ui_type();
  67
  68         bool is_external_ui () const;
  69         bool ui_is_resizable () const;
  70
  71         const char* port_symbol (uint32_t port) const;
  72         uint32_t    port_index (const char* symbol) const;
  73
  74         const LV2_Feature* const* features () { return _features; }
  75
  76         std::set<Evoral::Parameter> automatable () const;
  77
  78         void activate ();
  79         void deactivate ();
  80         void cleanup ();
  81
  82         int set_block_size (pframes_t /*nframes*/) { return 0; }
  83
  84         int connect_and_run (BufferSet& bufs,
  85                              ChanMapping in, ChanMapping out,
  86                              pframes_t nframes, framecnt_t offset);
  87
  88         std::string describe_parameter (Evoral::Parameter);
  89         std::string state_node_name () const { return "lv2"; }
  90
  91         void print_parameter (uint32_t param,
  92                               char*    buf,
  93                               uint32_t len) const;
  94
  95         bool parameter_is_audio (uint32_t) const;
  96         bool parameter_is_control (uint32_t) const;
  97         bool parameter_is_event (uint32_t) const;
  98         bool parameter_is_input (uint32_t) const;
  99         bool parameter_is_output (uint32_t) const;
 100         bool parameter_is_toggled (uint32_t) const;
 101
 102         boost::shared_ptr<Plugin::ScalePoints>
 103         get_scale_points(uint32_t port_index) const;
 104
 105         /// Return the URID of midi:MidiEvent
 106         static uint32_t midi_event_type (bool event_api) {
 107                 return event_api ? _midi_event_type_ev : _midi_event_type;
 108         }
 109
 110         void set_insert_info(const PluginInsert* insert);
 111
 112         int      set_state (const XMLNode& node, int version);
 113         bool     save_preset (std::string uri);
 114         void     remove_preset (std::string uri);
 115         bool     load_preset (PresetRecord);
 116         std::string current_preset () const;
 117
 118         bool has_editor () const;
 119         bool has_message_output () const;
 120
 121         uint32_t atom_eventTransfer() const;
 122
 123         void write_from_ui(uint32_t index, uint32_t protocol, uint32_t size, uint8_t* body);
 124
 125         typedef void UIMessageSink(void*       controller,
 126                                    uint32_t    index,
 127                                    uint32_t    size,
 128                                    uint32_t    format,
 129                                    const void* buffer);
 130
 131         void enable_ui_emmission();
 132         void emit_to_ui(void* controller, UIMessageSink sink);
 133
 134         Worker* worker() { return _worker; }
 135
 136         int work(uint32_t size, const void* data);
 137         int work_response(uint32_t size, const void* data);
 138
 139         static URIMap _uri_map;
 140
 141         static uint32_t _midi_event_type_ev;
 142         static uint32_t _midi_event_type;
 143         static uint32_t _chunk_type;
 144         static uint32_t _sequence_type;
 145         static uint32_t _event_transfer_type;
 146         static uint32_t _path_type;
 147
 148   private:
 149         struct Impl;
 150         Impl*         _impl;
 151         void*         _module;
 152         LV2_Feature** _features;
 153         Worker*       _worker;
 154         framecnt_t    _sample_rate;
 155         float*        _control_data;
 156         float*        _shadow_data;
 157         float*        _defaults;
 158         LV2_Evbuf**   _ev_buffers;
 159         float*        _bpm_control_port;  ///< Special input set by ardour
 160         float*        _freewheel_control_port;  ///< Special input set by ardour
 161         float*        _latency_control_port;  ///< Special output set by ardour
 162         PBD::ID       _insert_id;
 163
 164         typedef enum {
 165                 PORT_INPUT   = 1,
 166                 PORT_OUTPUT  = 1 << 1,
 167                 PORT_AUDIO   = 1 << 2,
 168                 PORT_CONTROL = 1 << 3,
 169                 PORT_EVENT   = 1 << 4,
 170                 PORT_MESSAGE = 1 << 5
 171         } PortFlag;
 172
 173         typedef unsigned PortFlags;
 174
 175         std::vector<PortFlags>         _port_flags;
 176         std::map<std::string,uint32_t> _port_indices;
 177
 178         /// Message send to/from UI via ports
 179         struct UIMessage {
 180                 uint32_t index;
 181                 uint32_t protocol;
 182                 uint32_t size;
 183         };
 184
 185         void write_to_ui(uint32_t index,
 186                          uint32_t protocol,
 187                          uint32_t size,
 188                          uint8_t* body);
 189
 190         void write_to(RingBuffer<uint8_t>* dest,
 191                       uint32_t             index,
 192                       uint32_t             protocol,
 193                       uint32_t             size,
 194                       uint8_t*             body);
 195
 196         // Created on demand so the space is only consumed if necessary
 197         RingBuffer<uint8_t>* _to_ui;
 198         RingBuffer<uint8_t>* _from_ui;
 199
 200         typedef struct {
 201                 const void* (*extension_data) (const char* uri);
 202         } LV2_DataAccess;
 203
 204         LV2_DataAccess _data_access_extension_data;
 205         LV2_Feature    _data_access_feature;
 206         LV2_Feature    _instance_access_feature;
 207         LV2_Feature    _make_path_feature;
 208         LV2_Feature    _work_schedule_feature;
 209
 210         mutable unsigned _state_version;
 211
 212         bool _was_activated;
 213         bool _has_state_interface;
 214
 215         const std::string plugin_dir () const;
 216         const std::string scratch_dir () const;
 217         const std::string file_dir () const;
 218         const std::string state_dir (unsigned num) const;
 219
 220         static char* lv2_state_make_path (void*       host_data,
 221                                           const char* path);
 222
 223         void init (void* c_plugin, framecnt_t rate);
 224         void run (pframes_t nsamples);
 225
 226         void latency_compute_run ();
 227         std::string do_save_preset (std::string);
 228         void do_remove_preset (std::string);
 229         void find_presets ();
 230         void add_state (XMLNode *) const;
 231 };
 232
 233
 234 class LV2PluginInfo : public PluginInfo {
 235 public:
 236         LV2PluginInfo (void* c_plugin);
 237         ~LV2PluginInfo ();
 238
 239         static PluginInfoList* discover ();
 240
 241         PluginPtr load (Session& session);
 242
 243         void* _c_plugin;
 244 };
 245
 246 typedef boost::shared_ptr<LV2PluginInfo> LV2PluginInfoPtr;
 247
 248 } // namespace ARDOUR
 249
 250 #endif /* __ardour_lv2_plugin_h__ */