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