2 Copyright (C) 2000-2006 Paul Davis
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.
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.
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.
20 #ifndef __ardour_ladspa_plugin_h__
21 #define __ardour_ladspa_plugin_h__
27 #include <glibmm/module.h>
29 #include "pbd/stateful.h"
31 #include "ardour/ladspa.h"
32 #include "ardour/plugin.h"
38 class LIBARDOUR_API LadspaPlugin : public ARDOUR::Plugin
41 LadspaPlugin (std::string module_path, ARDOUR::AudioEngine&, ARDOUR::Session&, uint32_t index, framecnt_t sample_rate);
42 LadspaPlugin (const LadspaPlugin &);
45 /* Plugin interface */
47 std::string unique_id() const;
48 const char* label() const { return _descriptor->Label; }
49 const char* name() const { return _descriptor->Name; }
50 const char* maker() const { return _descriptor->Maker; }
51 uint32_t parameter_count() const { return _descriptor->PortCount; }
52 float default_value (uint32_t port) { return _default_value (port); }
53 framecnt_t signal_latency() const;
54 void set_parameter (uint32_t port, float val);
55 float get_parameter (uint32_t port) const;
56 int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const;
57 uint32_t nth_parameter (uint32_t port, bool& ok) const;
59 std::set<Evoral::Parameter> automatable() const;
62 if (!_was_activated && _descriptor->activate)
63 _descriptor->activate (_handle);
65 _was_activated = true;
69 if (_was_activated && _descriptor->deactivate)
70 _descriptor->deactivate (_handle);
72 _was_activated = false;
79 if (_descriptor->cleanup)
80 _descriptor->cleanup (_handle);
83 int set_block_size (pframes_t /*nframes*/) { return 0; }
85 int connect_and_run (BufferSet& bufs,
86 framepos_t start, framepos_t end, double speed,
87 ChanMapping in, ChanMapping out,
88 pframes_t nframes, framecnt_t offset);
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;
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;
100 boost::shared_ptr<ScalePoints>
101 get_scale_points(uint32_t port_index) const;
103 int set_state (const XMLNode&, int version);
105 bool load_preset (PresetRecord);
107 bool has_editor() const { return false; }
111 LADSPA_Properties properties() const { return _descriptor->Properties; }
112 uint32_t index() const { return _index; }
113 const char * copyright() const { return _descriptor->Copyright; }
114 LADSPA_PortDescriptor port_descriptor(uint32_t i) const;
115 const LADSPA_PortRangeHint* port_range_hints() const { return _descriptor->PortRangeHints; }
116 const char * const * port_names() const { return _descriptor->PortNames; }
118 void set_gain (float gain) { _descriptor->set_run_adding_gain (_handle, gain); }
119 void run_adding (uint32_t nsamples) { _descriptor->run_adding (_handle, nsamples); }
120 void connect_port (uint32_t port, float *ptr) { _descriptor->connect_port (_handle, port, ptr); }
123 float _default_value (uint32_t port) const;
124 std::string _module_path;
125 Glib::Module* _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;
135 void find_presets ();
137 void init (std::string module_path, 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;
149 class LIBARDOUR_API LadspaPluginInfo : public PluginInfo {
152 ~LadspaPluginInfo () { };
154 PluginPtr load (Session& session);
155 std::vector<Plugin::PresetRecord> get_presets (bool user_only) const;
158 typedef boost::shared_ptr<LadspaPluginInfo> LadspaPluginInfoPtr;
160 } // namespace ARDOUR
162 #endif /* __ardour_ladspa_plugin_h__ */