X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fplugin.h;h=3d7c8d9c335c440da466b2ca7b0cc14677468303;hb=90172686b92b53cc5ab1d60c0e6daecb65d17d3d;hp=560ad06e3987fb7bfff33041916c11acf8f3126f;hpb=2dd3c9578fa01dc5dca94f6ba9e4ded8f36b539c;p=ardour.git diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h index 560ad06e39..3d7c8d9c33 100644 --- a/libs/ardour/ardour/plugin.h +++ b/libs/ardour/ardour/plugin.h @@ -1,5 +1,5 @@ /* - 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 @@ -15,108 +15,112 @@ 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 -#include +#include +#include + +#include "pbd/statefuldestructible.h" +#include "pbd/controllable.h" #include -#include -#include -#include -#include +#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 #include #include -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 PluginPtr; class PluginInfo { public: - enum Type { - LADSPA, - VST - }; + PluginInfo () { } + virtual ~PluginInfo () { } + + std::string name; + std::string category; + std::string creator; + std::string path; + ChanCount n_inputs; + ChanCount n_outputs; + ARDOUR::PluginType type; + + std::string unique_id; + + virtual PluginPtr load (Session& session) = 0; - PluginInfo () { }; - PluginInfo (const PluginInfo &o) - : name(o.name), n_inputs(o.n_inputs), n_outputs(o.n_outputs), - path (o.path), index(o.index) {} - ~PluginInfo () { }; - string name; - string category; - uint32_t n_inputs; - uint32_t n_outputs; - Type type; - - private: + protected: friend class PluginManager; - string path; uint32_t index; }; -class Plugin : public Stateful, public sigc::trackable +typedef boost::shared_ptr PluginInfoPtr; +typedef std::list PluginInfoList; +class Plugin : public PBD::StatefulDestructible, public Latent { public: Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&); Plugin (const Plugin&); - ~Plugin (); - - struct ParameterDescriptor { + virtual ~Plugin (); - /* essentially a union of LADSPA and VST info */ - - bool integer_step; - bool toggled; - bool logarithmic; - bool sr_dependent; - string label; - float lower; - float upper; - float step; - float smallstep; - float largestep; + struct ParameterDescriptor { + /* essentially a union of LADSPA and VST info */ + + bool integer_step; + bool toggled; + bool logarithmic; + bool sr_dependent; + std::string label; + float lower; + float upper; + float step; + float smallstep; + float largestep; 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& bufs, uint32_t maxbuf, int32_t& in, int32_t& out, jack_nframes_t nframes, jack_nframes_t offset) = 0; - virtual std::set 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 flush () { deactivate(); activate(); } + + virtual int 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 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; @@ -124,22 +128,51 @@ class Plugin : public Stateful, public sigc::trackable 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 get_presets(); + virtual bool save_preset (std::string) = 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 get_presets(); + virtual std::string current_preset() const { return std::string(); } + + static PBD::Signal0 PresetFileExists; + + 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 ParameterChanged; - sigc::signal GoingAway; - - void reset_midi_control (MIDI::Port*, bool); - void send_all_midi_feedback (); - MIDI::byte* write_midi_feedback (MIDI::byte*, int32_t& bufsize); - MIDI::Controllable *get_nth_midi_control (uint32_t); + PBD::Signal2 ParameterChanged; + + /* 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; } - PluginInfo & get_info() { return _info; } - void set_info (const PluginInfo &inf) { _info = inf; } + /* 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; + + PluginInfoPtr get_info() const { return _info; } + void set_info (const PluginInfoPtr inf) { _info = inf; } ARDOUR::AudioEngine& engine() const { return _engine; } ARDOUR::Session& session() const { return _session; } @@ -148,45 +181,22 @@ class Plugin : public Stateful, public sigc::trackable cycles_t cycles() const { return _cycles; } protected: - ARDOUR::AudioEngine& _engine; - ARDOUR::Session& _session; - PluginInfo _info; - uint32_t _cycles; - map presets; - bool save_preset(string name, string domain /* vst, ladspa etc. */); - - void setup_midi_controls (); - - - struct MIDIPortControl : public MIDI::Controllable { - MIDIPortControl (Plugin&, uint32_t abs_port_id, MIDI::Port *, - float lower, float upper, bool toggled, bool logarithmic); - - void set_value (float); - void send_feedback (float); - MIDI::byte* write_feedback (MIDI::byte* buf, int32_t& bufsize, float val, bool force = false); - - Plugin& plugin; - uint32_t absolute_port; - float upper; - float lower; - float range; - bool toggled; - bool logarithmic; - - bool setting; - float last_written; - }; + friend class PluginInsert; + friend struct PluginInsert::PluginControl; - vector midi_controls; + virtual void set_parameter (uint32_t which, float val) = 0; - -}; + bool save_preset (std::string, std::string /* vst, ladspa etc. */); -/* this is actually defined in plugin_manager.cc */ + ARDOUR::AudioEngine& _engine; + ARDOUR::Session& _session; + PluginInfoPtr _info; + uint32_t _cycles; + std::map presets; +}; -Plugin * find_plugin(ARDOUR::Session&, string name, PluginInfo::Type); +PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType); } // namespace ARDOUR - + #endif /* __ardour_plugin_h__ */