X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fplugin.h;h=ed028e35723abee666f9e6dae59912459cc1d653;hb=c35e94a3c83028220f6eb494fdfe9c1960aaf751;hp=aeec4ee32e0cbde302ae0362d793258dd67395ce;hpb=4650d86312e7c191d208eefb03c299bfc1b4c031;p=ardour.git diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h index aeec4ee32e..ed028e3572 100644 --- a/libs/ardour/ardour/plugin.h +++ b/libs/ardour/ardour/plugin.h @@ -21,19 +21,21 @@ #define __ardour_plugin_h__ #include -#include -#include +#include #include "pbd/statefuldestructible.h" #include "pbd/controllable.h" -#include +#include "ardour/buffer_set.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/libardour_visibility.h" +#include "ardour/midi_state_tracker.h" +#include "ardour/parameter_descriptor.h" #include "ardour/types.h" +#include "ardour/variant.h" #include #include @@ -44,29 +46,20 @@ namespace ARDOUR { class AudioEngine; class Session; class BufferSet; - +class PluginInsert; class Plugin; typedef boost::shared_ptr PluginPtr; -class PluginInfo { +class LIBARDOUR_API PluginInfo { public: PluginInfo () { } - PluginInfo (const PluginInfo &o) - : 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; + std::string creator; + std::string path; ChanCount n_inputs; ChanCount n_outputs; ARDOUR::PluginType type; @@ -74,6 +67,19 @@ class PluginInfo { std::string unique_id; virtual PluginPtr load (Session& session) = 0; + virtual bool is_instrument() const; + + /* 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; } protected: friend class PluginManager; @@ -83,30 +89,17 @@ class PluginInfo { typedef boost::shared_ptr PluginInfoPtr; typedef std::list PluginInfoList; -class Plugin : public PBD::StatefulDestructible, public Latent +class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent { public: Plugin (ARDOUR::AudioEngine&, ARDOUR::Session&); Plugin (const Plugin&); virtual ~Plugin (); - 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; - }; + XMLNode& get_state (); + virtual int set_state (const XMLNode &, int version); + + virtual void set_insert_id (PBD::ID id) {} virtual std::string unique_id() const = 0; virtual const char * label() const = 0; @@ -115,16 +108,20 @@ class Plugin : public PBD::StatefulDestructible, public Latent virtual uint32_t parameter_count () const = 0; virtual float default_value (uint32_t port) = 0; virtual float get_parameter(uint32_t which) const = 0; + virtual std::string get_docs () const { return ""; } + virtual std::string get_parameter_docs (uint32_t /*which*/) const { return ""; } 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 (nframes_t nframes) = 0; + virtual void flush () { deactivate(); activate(); } + + virtual int set_block_size (pframes_t nframes) = 0; virtual int connect_and_run (BufferSet& bufs, - ChanMapping in, ChanMapping out, - nframes_t nframes, nframes_t offset) = 0; + ChanMapping in, ChanMapping out, + pframes_t nframes, framecnt_t offset); virtual std::set automatable() const = 0; virtual std::string describe_parameter (Evoral::Parameter) = 0; @@ -136,48 +133,97 @@ class Plugin : public PBD::StatefulDestructible, public Latent virtual bool parameter_is_input(uint32_t) const = 0; virtual bool parameter_is_output(uint32_t) const = 0; - virtual bool save_preset (std::string uri) = 0; - virtual bool load_preset (const std::string uri); + virtual boost::shared_ptr get_scale_points(uint32_t /*port_index*/) const { + return boost::shared_ptr(); + } + + void realtime_handle_transport_stopped (); + void realtime_locate (); + void monitoring_changed (); struct PresetRecord { - PresetRecord(const std::string& u, const std::string& l) : uri(u), label(l) {} - std::string uri; - std::string label; + PresetRecord () : number (-1), user (true) {} + PresetRecord (const std::string& u, const std::string& l, int n = -1, bool s = true) : uri (u), label (l), number (n), user (s) {} + + bool operator!= (PresetRecord const & a) const { + return number != a.number || uri != a.uri || label != a.label; + } + + std::string uri; + std::string label; + int number; // if <0, invalid + bool user; }; - virtual std::vector get_presets(); + PresetRecord save_preset (std::string); + void remove_preset (std::string); - const PresetRecord* preset_by_label(const std::string& label); - const PresetRecord* preset_by_uri(const std::string& uri); + virtual bool load_preset (PresetRecord); + void clear_preset (); - virtual bool has_editor() const = 0; + const PresetRecord * preset_by_label (const std::string &); + const PresetRecord * preset_by_uri (const std::string &); - sigc::signal ParameterChanged; + std::vector get_presets (); - /* 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. - */ + /** @return true if this plugin will respond to MIDI program + * change messages by changing presets. + * + * This is hard to return a correct value for because most plugin APIs + * do not specify plugin behaviour. However, if you want to force + * the display of plugin built-in preset names rather than MIDI program + * numbers, return true. If you want a generic description, return + * false. + */ + virtual bool presets_are_MIDI_programs() const { return false; } - /* this returns true if the plugin can change its inputs or outputs on demand. - LADSPA, LV2 and VST plugins cannot do this. AudioUnits can. - */ + /** @return true if this plugin is General MIDI compliant, false + * otherwise. + * + * It is important to note that it is is almost impossible for a host + * (e.g. Ardour) to determine this for just about any plugin API + * known as of June 2012 + */ + virtual bool current_preset_uses_general_midi() const { return false; } - virtual bool reconfigurable_io() const { return false; } + /** @return Last preset to be requested; the settings may have + * been changed since; find out with parameter_changed_since_last_preset. + */ + PresetRecord last_preset () const { + return _last_preset; + } + + bool parameter_changed_since_last_preset () const { + return _parameter_changed_since_last_preset; + } + + virtual int first_user_preset_index () const { + return 0; + } + + /** Emitted when a preset is added or removed, respectively */ + PBD::Signal0 PresetAdded; + PBD::Signal0 PresetRemoved; + + /** Emitted when a preset has been loaded */ + PBD::Signal0 PresetLoaded; + + virtual bool has_editor () const = 0; + + /** Emitted when any parameter changes */ + PBD::Signal2 ParameterChanged; - /* 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 bool can_support_io_configuration (const ChanCount& /*in*/, ChanCount& /*out*/) { return false; } virtual ChanCount output_streams() const; virtual ChanCount input_streams() const; - PluginInfoPtr get_info() { return _info; } - void set_info (const PluginInfoPtr inf) { _info = inf; } + PluginInfoPtr get_info() const { return _info; } + virtual void set_info (const PluginInfoPtr inf); ARDOUR::AudioEngine& engine() const { return _engine; } ARDOUR::Session& session() const { return _session; } @@ -185,19 +231,79 @@ class Plugin : public PBD::StatefulDestructible, public Latent void set_cycles (uint32_t c) { _cycles = c; } cycles_t cycles() const { return _cycles; } - protected: + typedef std::map PropertyDescriptors; + + /** Get a descrption of all properties supported by this plugin. + * + * Properties are distinct from parameters in that they are potentially + * dynamic, referred to by key, and do not correspond 1:1 with ports. + * + * For LV2 plugins, properties are implemented by sending/receiving set/get + * messages to/from the plugin via event ports. + */ + virtual const PropertyDescriptors& get_supported_properties() const { + static const PropertyDescriptors nothing; + return nothing; + } + + virtual const ParameterDescriptor& get_property_descriptor(uint32_t id) const { + static const ParameterDescriptor nothing; + return nothing; + } + + /** Set a property from the UI. + * + * This is not UI-specific, but may only be used by one thread. If the + * Ardour UI is present, that is the UI thread, but otherwise, any thread + * except the audio thread may call this function as long as it is not + * called concurrently. + */ + virtual void set_property(uint32_t key, const Variant& value) {} + + /** Emit PropertyChanged for all current property values. */ + virtual void announce_property_values() {} + + /** Emitted when a property is changed in the plugin. */ + PBD::Signal2 PropertyChanged; + + PBD::Signal1 StartTouch; + PBD::Signal1 EndTouch; + +protected: + friend class PluginInsert; - friend struct PluginInsert::PluginControl; - virtual void set_parameter (uint32_t which, float val) = 0; + virtual void set_parameter (uint32_t which, float val); - bool save_preset (std::string uri, std::string domain /* vst, ladspa etc. */); + /** Do the actual saving of the current plugin settings to a preset of the provided name. + * Should return a URI on success, or an empty string on failure. + */ + virtual std::string do_save_preset (std::string) = 0; + /** Do the actual removal of a preset of the provided name */ + virtual void do_remove_preset (std::string) = 0; ARDOUR::AudioEngine& _engine; ARDOUR::Session& _session; PluginInfoPtr _info; uint32_t _cycles; - std::map presets; + std::map _presets; + +private: + + /** Fill _presets with our presets */ + virtual void find_presets () = 0; + + /** Add state to an existing XMLNode */ + virtual void add_state (XMLNode *) const = 0; + + bool _have_presets; + MidiStateTracker _tracker; + BufferSet _pending_stop_events; + bool _have_pending_stop_events; + PresetRecord _last_preset; + bool _parameter_changed_since_last_preset; + + void resolve_midi (); }; PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType);