/*
- Copyright (C) 2000 Paul Davis
+ Copyright (C) 2000-2006 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
-#ifndef __ardour_ladspa_h__
-#define __ardour_ladspa_h__
+#ifndef __ardour_plugin_h__
+#define __ardour_plugin_h__
#include <boost/shared_ptr.hpp>
#include <sigc++/signal.h>
+#include <glibmm/ustring.h>
-#include <pbd/stateful.h>
-#include <pbd/controllable.h>
+#include "pbd/statefuldestructible.h"
+#include "pbd/controllable.h"
#include <jack/types.h>
-#include <ardour/types.h>
-#include <ardour/plugin_state.h>
-#include <ardour/cycles.h>
+#include "ardour/chan_count.h"
+#include "ardour/chan_mapping.h"
+#include "ardour/cycles.h"
+#include "ardour/latent.h"
+#include "ardour/plugin_insert.h"
+#include "ardour/types.h"
#include <vector>
#include <set>
#include <map>
-using std::string;
-using std::vector;
-using std::set;
-using std::map;
-
namespace ARDOUR {
class AudioEngine;
class Session;
+class BufferSet;
+
+class Plugin;
+
+typedef boost::shared_ptr<Plugin> PluginPtr;
class PluginInfo {
public:
- enum Type {
- AudioUnit,
- LADSPA,
- VST
- };
-
- PluginInfo () { };
+ PluginInfo () { }
PluginInfo (const PluginInfo &o)
- : name(o.name), n_inputs(o.n_inputs), n_outputs(o.n_outputs),
- unique_id(o.unique_id), path (o.path), index(o.index) {}
- ~PluginInfo () { };
- string name;
- string category;
- uint32_t n_inputs;
- uint32_t n_outputs;
- Type type;
-
- long unique_id;
-
- private:
+ : name(o.name),
+ category (o.category),
+ creator (o.creator),
+ path (o.path),
+ n_inputs(o.n_inputs),
+ n_outputs(o.n_outputs),
+ unique_id(o.unique_id),
+ index(o.index) {}
+ virtual ~PluginInfo () { }
+
+ std::string name;
+ std::string category;
+ Glib::ustring creator;
+ Glib::ustring path;
+ ChanCount n_inputs;
+ ChanCount n_outputs;
+ ARDOUR::PluginType type;
+
+ std::string unique_id;
+
+ virtual PluginPtr load (Session& session) = 0;
+
+ protected:
friend class PluginManager;
- string path;
uint32_t index;
};
typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
typedef std::list<PluginInfoPtr> PluginInfoList;
-class Plugin : public Stateful, public sigc::trackable
-
+class Plugin : public PBD::StatefulDestructible, public Latent
{
public:
Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&);
Plugin (const Plugin&);
- ~Plugin ();
+ virtual ~Plugin ();
struct ParameterDescriptor {
bool toggled;
bool logarithmic;
bool sr_dependent;
- string label;
+ std::string label;
float lower;
float upper;
float step;
float smallstep;
float largestep;
-
- bool min_unbound;
- bool max_unbound;
+ bool min_unbound;
+ bool max_unbound;
};
- virtual uint32_t unique_id() const = 0;
+ virtual std::string unique_id() const = 0;
virtual const char * label() const = 0;
virtual const char * name() const = 0;
virtual const char * maker() const = 0;
virtual uint32_t parameter_count () const = 0;
virtual float default_value (uint32_t port) = 0;
- virtual jack_nframes_t latency() const = 0;
- virtual void set_parameter (uint32_t which, float val) = 0;
virtual float get_parameter(uint32_t which) const = 0;
virtual int get_parameter_descriptor (uint32_t which, ParameterDescriptor&) const = 0;
virtual uint32_t nth_parameter (uint32_t which, bool& ok) const = 0;
virtual void activate () = 0;
virtual void deactivate () = 0;
- virtual void set_block_size (jack_nframes_t nframes) = 0;
-
- virtual int connect_and_run (vector<Sample*>& bufs, uint32_t maxbuf, int32_t& in, int32_t& out, jack_nframes_t nframes, jack_nframes_t offset) = 0;
- virtual std::set<uint32_t> automatable() const = 0;
- virtual void store_state (ARDOUR::PluginState&) = 0;
- virtual void restore_state (ARDOUR::PluginState&) = 0;
- virtual string describe_parameter (uint32_t) = 0;
- virtual string state_node_name() const = 0;
+ virtual void set_block_size (nframes_t nframes) = 0;
+
+ virtual int connect_and_run (BufferSet& bufs,
+ ChanMapping in, ChanMapping out,
+ nframes_t nframes, nframes_t offset) = 0;
+
+ virtual std::set<Evoral::Parameter> automatable() const = 0;
+ virtual std::string describe_parameter (Evoral::Parameter) = 0;
+ virtual std::string state_node_name() const = 0;
virtual void print_parameter (uint32_t, char*, uint32_t len) const = 0;
virtual bool parameter_is_audio(uint32_t) const = 0;
virtual bool parameter_is_input(uint32_t) const = 0;
virtual bool parameter_is_output(uint32_t) const = 0;
- virtual bool save_preset(string name) = 0;
- virtual bool load_preset (const string preset_label);
- virtual std::vector<std::string> get_presets();
+ virtual bool save_preset (std::string uri) = 0;
+ virtual bool load_preset (const std::string uri);
+
+ struct PresetRecord {
+ PresetRecord(const std::string& u, const std::string& l) : uri(u), label(l) {}
+ std::string uri;
+ std::string label;
+ };
+
+ virtual std::vector<PresetRecord> get_presets();
+
+ const PresetRecord* preset_by_label(const std::string& label);
+ const PresetRecord* preset_by_uri(const std::string& uri);
virtual bool has_editor() const = 0;
sigc::signal<void,uint32_t,float> ParameterChanged;
- sigc::signal<void,Plugin *> GoingAway;
-
- PBD::Controllable *get_nth_control (uint32_t);
- PluginInfo & get_info() { return _info; }
- void set_info (const PluginInfo &inf) { _info = inf; }
+ /* NOTE: this block of virtual methods looks like the interface
+ to a Processor, but Plugin does not inherit from Processor.
+ It is therefore not required that these precisely match
+ the interface, but it is likely that they will evolve together.
+ */
+
+ /* this returns true if the plugin can change its inputs or outputs on demand.
+ LADSPA, LV2 and VST plugins cannot do this. AudioUnits can.
+ */
+
+ virtual bool reconfigurable_io() const { return false; }
+
+ /* this is only called if reconfigurable_io() returns true */
+ virtual bool configure_io (ChanCount in, ChanCount out) { return true; }
+
+ /* specific types of plugins can overload this. As of September 2008, only
+ AUPlugin does this.
+ */
+ virtual bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const { return false; }
+ virtual ChanCount output_streams() const;
+ virtual ChanCount input_streams() const;
+
+ PBD::Controllable *get_nth_control (uint32_t, bool do_not_create = false);
+ void make_nth_control (uint32_t, const XMLNode&);
+
+ PluginInfoPtr get_info() { return _info; }
+ void set_info (const PluginInfoPtr inf) { _info = inf; }
ARDOUR::AudioEngine& engine() const { return _engine; }
ARDOUR::Session& session() const { return _session; }
cycles_t cycles() const { return _cycles; }
protected:
- ARDOUR::AudioEngine& _engine;
- ARDOUR::Session& _session;
- PluginInfo _info;
- uint32_t _cycles;
- map<string,string> presets;
- bool save_preset(string name, string domain /* vst, ladspa etc. */);
-
- void setup_controls ();
-
- struct PortControllable : public PBD::Controllable {
- PortControllable (Plugin&, uint32_t abs_port_id,
- float lower, float upper, bool toggled, bool logarithmic);
-
- void set_value (float);
- float get_value () const;
-
- Plugin& plugin;
- uint32_t absolute_port;
- float upper;
- float lower;
- float range;
- bool toggled;
- bool logarithmic;
- };
+ friend class PluginInsert;
+ friend struct PluginInsert::PluginControl;
+
+ virtual void set_parameter (uint32_t which, float val) = 0;
+
+ bool save_preset (std::string uri, std::string domain /* vst, ladspa etc. */);
- vector<PortControllable*> controls;
+ ARDOUR::AudioEngine& _engine;
+ ARDOUR::Session& _session;
+ PluginInfoPtr _info;
+ uint32_t _cycles;
+ std::map<std::string,PresetRecord> presets;
};
-/* this is actually defined in plugin_manager.cc */
-
-boost::shared_ptr<Plugin> find_plugin(ARDOUR::Session&, string name, long unique_id, PluginInfo::Type);
+PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);
} // namespace ARDOUR
projects / ardour.git / blobdiff