libs/ardour/ardour/vst_plugin.h

   1 /*
   2     Copyright (C) 2010 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 "ardour/plugin.h"
  24
  25 struct _AEffect;
  26 typedef struct _AEffect AEffect;
  27 struct _VSTHandle;
  28 typedef struct _VSTHandle VSTHandle;
  29 struct _VSTState;
  30 typedef struct _VSTState VSTState;
  31
  32 #include "ardour/vestige/aeffectx.h"
  33
  34 namespace ARDOUR {
  35
  36 class PluginInsert;
  37
  38 /** Parent class for VST plugins of both Windows and Linux varieties */
  39 class LIBARDOUR_API VSTPlugin : public Plugin
  40 {
  41 public:
  42         VSTPlugin (AudioEngine &, Session &, VSTHandle *);
  43         virtual ~VSTPlugin ();
  44
  45         void activate ();
  46         void deactivate ();
  47
  48         int set_block_size (pframes_t);
  49         bool inplace_broken() const { return true; }
  50         float default_value (uint32_t port);
  51         float get_parameter (uint32_t port) const;
  52         uint32_t nth_parameter (uint32_t port, bool& ok) const;
  53         void set_parameter (uint32_t port, float val);
  54         void set_parameter_automated (uint32_t port, float val);
  55         bool load_preset (PresetRecord);
  56         int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  57         std::string describe_parameter (Evoral::Parameter);
  58         framecnt_t signal_latency() const;
  59         std::set<Evoral::Parameter> automatable() const;
  60
  61         bool parameter_is_audio (uint32_t) const { return false; }
  62         bool parameter_is_control (uint32_t) const { return true; }
  63         bool parameter_is_input (uint32_t) const { return true; }
  64         bool parameter_is_output (uint32_t) const { return false; }
  65
  66         int connect_and_run (BufferSet&,
  67                         framepos_t start, framepos_t end, double speed,
  68                         ChanMapping in, ChanMapping out,
  69                         pframes_t nframes, framecnt_t offset
  70                         );
  71
  72         std::string unique_id () const;
  73         const char * label () const;
  74         const char * name () const;
  75         const char * maker () const;
  76         uint32_t parameter_count () const;
  77         void print_parameter (uint32_t, char*, uint32_t len) const;
  78
  79         bool has_editor () const;
  80
  81         AEffect * plugin () const { return _plugin; }
  82         VSTState * state () const { return _state; }
  83         MidiBuffer * midi_buffer () const { return _midi_out_buf; }
  84
  85         int set_state (XMLNode const &, int);
  86
  87         int first_user_preset_index () const;
  88
  89         void set_insert (PluginInsert* pi, uint32_t num) { _pi = pi; _num = num; }
  90         PluginInsert* plugin_insert () const { return _pi; }
  91         uint32_t plugin_number () const { return _num; }
  92         VstTimeInfo* timeinfo () { return &_timeInfo; }
  93         framepos_t transport_frame () const { return _transport_frame; }
  94         float transport_speed () const { return _transport_speed; }
  95
  96
  97 protected:
  98         void set_plugin (AEffect *);
  99         gchar* get_chunk (bool) const;
 100         int set_chunk (gchar const *, bool);
 101         void add_state (XMLNode *) const;
 102         bool load_user_preset (PresetRecord);
 103         bool load_plugin_preset (PresetRecord);
 104         std::string do_save_preset (std::string name);
 105         void do_remove_preset (std::string name);
 106         XMLTree * presets_tree () const;
 107         std::string presets_file () const;
 108         void find_presets ();
 109
 110         VSTHandle* _handle;
 111         VSTState*  _state;
 112         AEffect*   _plugin;
 113         PluginInsert* _pi;
 114         uint32_t      _num;
 115
 116         MidiBuffer* _midi_out_buf;
 117         VstTimeInfo _timeInfo;
 118
 119         framepos_t _transport_frame;
 120         float      _transport_speed;
 121         mutable std::map <uint32_t, float> _parameter_defaults;
 122 };
 123
 124 }
 125
 126 #endif