libs/ardour/ardour/ladspa_plugin.h

   1 /*
   2     Copyright (C) 2000-2006 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_ladspa_plugin_h__
  21 #define __ardour_ladspa_plugin_h__
  22
  23 #include <set>
  24 #include <vector>
  25 #include <string>
  26 #include <dlfcn.h>
  27
  28
  29 #include "pbd/stateful.h"
  30
  31 #include <jack/types.h>
  32 #include "ardour/ladspa.h"
  33 #include "ardour/plugin.h"
  34
  35 namespace ARDOUR {
  36 class AudioEngine;
  37 class Session;
  38
  39 class LadspaPlugin : public ARDOUR::Plugin
  40 {
  41   public:
  42         LadspaPlugin (void *module, ARDOUR::AudioEngine&, ARDOUR::Session&, uint32_t index, framecnt_t sample_rate);
  43         LadspaPlugin (const LadspaPlugin &);
  44         ~LadspaPlugin ();
  45
  46         /* Plugin interface */
  47
  48         std::string unique_id() const;
  49         const char* label() const           { return _descriptor->Label; }
  50         const char* name() const            { return _descriptor->Name; }
  51         const char* maker() const           { return _descriptor->Maker; }
  52         uint32_t    parameter_count() const { return _descriptor->PortCount; }
  53         float       default_value (uint32_t port);
  54         framecnt_t  signal_latency() const;
  55         void        set_parameter (uint32_t port, float val);
  56         float       get_parameter (uint32_t port) const;
  57         int         get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
  58         uint32_t    nth_parameter (uint32_t port, bool& ok) const;
  59
  60         std::set<Evoral::Parameter> automatable() const;
  61
  62         void activate () {
  63                 if (!_was_activated && _descriptor->activate)
  64                         _descriptor->activate (_handle);
  65
  66                 _was_activated = true;
  67         }
  68
  69         void deactivate () {
  70                 if (_was_activated && _descriptor->deactivate)
  71                         _descriptor->deactivate (_handle);
  72
  73                 _was_activated = false;
  74         }
  75
  76         void cleanup () {
  77                 activate();
  78                 deactivate();
  79
  80                 if (_descriptor->cleanup)
  81                         _descriptor->cleanup (_handle);
  82         }
  83
  84         int set_block_size (pframes_t /*nframes*/) { return 0; }
  85
  86         int connect_and_run (BufferSet& bufs,
  87                         ChanMapping in, ChanMapping out,
  88                         pframes_t nframes, framecnt_t offset);
  89
  90         std::string describe_parameter (Evoral::Parameter);
  91         std::string state_node_name() const { return "ladspa"; }
  92         void        print_parameter (uint32_t, char*, uint32_t len) const;
  93
  94         bool parameter_is_audio(uint32_t) const;
  95         bool parameter_is_control(uint32_t) const;
  96         bool parameter_is_input(uint32_t) const;
  97         bool parameter_is_output(uint32_t) const;
  98         bool parameter_is_toggled(uint32_t) const;
  99
 100         boost::shared_ptr<Plugin::ScalePoints>
 101         get_scale_points(uint32_t port_index) const;
 102
 103         int set_state (const XMLNode&, int version);
 104
 105         bool load_preset (PresetRecord);
 106
 107         bool has_editor() const { return false; }
 108
 109         int require_output_streams (uint32_t);
 110
 111         /* LADSPA extras */
 112
 113         LADSPA_Properties           properties() const                { return _descriptor->Properties; }
 114         uint32_t                    index() const                     { return _index; }
 115         const char *                copyright() const                 { return _descriptor->Copyright; }
 116         LADSPA_PortDescriptor       port_descriptor(uint32_t i) const;
 117         const LADSPA_PortRangeHint* port_range_hints() const          { return _descriptor->PortRangeHints; }
 118         const char * const *        port_names() const                { return _descriptor->PortNames; }
 119
 120         void set_gain (float gain)                    { _descriptor->set_run_adding_gain (_handle, gain); }
 121         void run_adding (uint32_t nsamples)           { _descriptor->run_adding (_handle, nsamples); }
 122         void connect_port (uint32_t port, float *ptr) { _descriptor->connect_port (_handle, port, ptr); }
 123
 124   private:
 125         void*                    _module;
 126         const LADSPA_Descriptor* _descriptor;
 127         LADSPA_Handle            _handle;
 128         framecnt_t               _sample_rate;
 129         LADSPA_Data*             _control_data;
 130         LADSPA_Data*             _shadow_data;
 131         LADSPA_Data*             _latency_control_port;
 132         uint32_t                 _index;
 133         bool                     _was_activated;
 134
 135         void find_presets ();
 136
 137         void init (void *mod, uint32_t index, framecnt_t rate);
 138         void run_in_place (pframes_t nsamples);
 139         void latency_compute_run ();
 140         int set_state_2X (const XMLNode&, int version);
 141         std::string do_save_preset (std::string name);
 142         void do_remove_preset (std::string name);
 143         std::string preset_envvar () const;
 144         std::string preset_source (std::string) const;
 145         bool write_preset_file (std::string);
 146         void add_state (XMLNode *) const;
 147 };
 148
 149 class LadspaPluginInfo : public PluginInfo {
 150   public:
 151         LadspaPluginInfo ();
 152         ~LadspaPluginInfo () { };
 153
 154         PluginPtr load (Session& session);
 155 };
 156
 157 typedef boost::shared_ptr<LadspaPluginInfo> LadspaPluginInfoPtr;
 158
 159 } // namespace ARDOUR
 160
 161 #endif /* __ardour_ladspa_plugin_h__ */