libs/ardour/ardour/vst_plugin.h

   1 /*
   2     Copyright (C) 2004 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_vst_plugin_h__
  21 #define __ardour_vst_plugin_h__
  22
  23 #include <list>
  24 #include <map>
  25 #include <set>
  26 #include <vector>
  27 #include <string>
  28 #include <dlfcn.h>
  29
  30 #include "pbd/stateful.h"
  31 #include "ardour/plugin.h"
  32 #include "ardour/midi_state_tracker.h"
  33
  34 struct _FSTHandle;
  35 struct _FST;
  36 typedef struct _FSTHandle FSTHandle;
  37 typedef struct _FST FST;
  38 class AEffect;
  39
  40 namespace ARDOUR {
  41 class AudioEngine;
  42 class Session;
  43
  44 class VSTPlugin : public ARDOUR::Plugin
  45 {
  46   public:
  47         VSTPlugin (ARDOUR::AudioEngine&, ARDOUR::Session&, FSTHandle* handle);
  48         VSTPlugin (const VSTPlugin &);
  49         ~VSTPlugin ();
  50
  51         /* Plugin interface */
  52
  53         std::string unique_id() const;
  54         const char * label() const;
  55         const char * name() const;
  56         const char * maker() const;
  57         uint32_t parameter_count() const;
  58         float default_value (uint32_t port);
  59         framecnt_t signal_latency() const;
  60         void set_parameter (uint32_t port, float val);
  61         float get_parameter (uint32_t port) const;
  62         int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  63         std::set<Evoral::Parameter> automatable() const;
  64         uint32_t nth_parameter (uint32_t port, bool& ok) const;
  65         void activate ();
  66         void deactivate ();
  67         int set_block_size (pframes_t);
  68
  69         int connect_and_run (BufferSet&,
  70                         ChanMapping in, ChanMapping out,
  71                         pframes_t nframes, framecnt_t offset);
  72
  73         std::string describe_parameter (Evoral::Parameter);
  74         std::string state_node_name() const { return "vst"; }
  75         void print_parameter (uint32_t, char*, uint32_t len) const;
  76
  77         bool parameter_is_audio(uint32_t i) const { return false; }
  78         bool parameter_is_control(uint32_t i) const { return true; }
  79         bool parameter_is_input(uint32_t i) const { return true; }
  80         bool parameter_is_output(uint32_t i) const { return false; }
  81
  82         void realtime_handle_transport_stopped ();
  83
  84         bool load_preset (const std::string& preset_label);
  85         virtual std::vector<PresetRecord> get_presets ();
  86         int first_user_preset_index () const;
  87
  88         bool has_editor () const;
  89
  90         XMLNode& get_state();
  91         int set_state (XMLNode const &, int);
  92
  93         AEffect * plugin () const { return _plugin; }
  94         FST * fst () const { return _fst; }
  95
  96 private:
  97
  98         void do_remove_preset (std::string name);
  99         std::string do_save_preset (std::string name);
 100         gchar* get_chunk (bool);
 101         int set_chunk (gchar const *, bool);
 102         XMLTree * presets_tree () const;
 103
 104         FSTHandle* handle;
 105         FST*       _fst;
 106         AEffect*   _plugin;
 107         bool        been_resumed;
 108         MidiStateTracker _tracker;
 109         BufferSet  _pending_stop_events;
 110         bool _have_pending_stop_events;
 111 };
 112
 113 class VSTPluginInfo : public PluginInfo
 114 {
 115   public:
 116         VSTPluginInfo ();
 117         ~VSTPluginInfo () {}
 118
 119         PluginPtr load (Session& session);
 120 };
 121
 122 typedef boost::shared_ptr<VSTPluginInfo> VSTPluginInfoPtr;
 123
 124 } // namespace ARDOUR
 125
 126 #endif /* __ardour_vst_plugin_h__ */