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 namespace ARDOUR {
  33
  34 /** Parent class for VST plugins of both Windows and Linux varieties */
  35 class VSTPlugin : public Plugin
  36 {
  37 public:
  38         VSTPlugin (AudioEngine &, Session &, VSTHandle *);
  39         virtual ~VSTPlugin ();
  40
  41         void activate ();
  42         void deactivate ();
  43
  44         int set_block_size (pframes_t);
  45         float default_value (uint32_t port);
  46         float get_parameter (uint32_t port) const;
  47         uint32_t nth_parameter (uint32_t port, bool& ok) const;
  48         void set_parameter (uint32_t port, float val);
  49         bool load_preset (PresetRecord);
  50         int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  51         std::string describe_parameter (Evoral::Parameter);
  52         framecnt_t signal_latency() const;
  53         std::set<Evoral::Parameter> automatable() const;
  54
  55         bool parameter_is_audio (uint32_t) const { return false; }
  56         bool parameter_is_control (uint32_t) const { return true; }
  57         bool parameter_is_input (uint32_t) const { return true; }
  58         bool parameter_is_output (uint32_t) const { return false; }
  59
  60         int connect_and_run (
  61                 BufferSet&, ChanMapping in, ChanMapping out,
  62                 pframes_t nframes, framecnt_t offset
  63                 );
  64
  65         std::string unique_id () const;
  66         const char * label () const;
  67         const char * name () const;
  68         const char * maker () const;
  69         uint32_t parameter_count () const;
  70         void print_parameter (uint32_t, char*, uint32_t len) const;
  71
  72         bool has_editor () const;
  73
  74         AEffect * plugin () const { return _plugin; }
  75         VSTState * state () const { return _state; }
  76
  77         int set_state (XMLNode const &, int);
  78
  79         int first_user_preset_index () const;
  80
  81 protected:
  82         void set_plugin (AEffect *);
  83         gchar* get_chunk (bool) const;
  84         int set_chunk (gchar const *, bool);
  85         void add_state (XMLNode *) const;
  86         bool load_user_preset (PresetRecord);
  87         bool load_plugin_preset (PresetRecord);
  88         std::string do_save_preset (std::string name);
  89         void do_remove_preset (std::string name);
  90         XMLTree * presets_tree () const;
  91         std::string presets_file () const;
  92         void find_presets ();
  93
  94         VSTHandle* _handle;
  95         VSTState*  _state;
  96         AEffect*   _plugin;
  97 };
  98
  99 }
 100
 101 #endif