X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fplugin.h;h=4f9ce3e7ea3db23883ae80f7d7e4f8b660d8234c;hb=ba0458cf1f6c69366e89631d8fff916ad183d768;hp=5c490693758f6f974db6d2c9e173ca415c1fef09;hpb=bbf41757133a29df0d37905f2fdce091878d2ffd;p=ardour.git diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h index 5c49069375..4f9ce3e7ea 100644 --- a/libs/ardour/ardour/plugin.h +++ b/libs/ardour/ardour/plugin.h @@ -1,5 +1,5 @@ /* - Copyright (C) 2000-2006 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 @@ -21,28 +21,23 @@ #define __ardour_plugin_h__ #include -#include +#include -#include -#include +#include "pbd/statefuldestructible.h" +#include "pbd/controllable.h" #include -#include -#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; @@ -56,24 +51,22 @@ typedef boost::shared_ptr PluginPtr; class PluginInfo { public: 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) {} virtual ~PluginInfo () { } - string name; - string category; + std::string name; + std::string category; + std::string creator; + std::string path; ChanCount n_inputs; ChanCount n_outputs; ARDOUR::PluginType type; - long unique_id; + std::string unique_id; virtual PluginPtr load (Session& session) = 0; protected: friend class PluginManager; - string path; uint32_t index; }; @@ -86,26 +79,26 @@ class Plugin : public PBD::StatefulDestructible, public Latent 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; - string label; - float lower; - float upper; - float step; - float smallstep; - float largestep; - bool min_unbound; - bool max_unbound; + /* 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; @@ -117,15 +110,17 @@ class Plugin : public PBD::StatefulDestructible, public Latent 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 int connect_and_run (BufferSet& bufs, uint32_t& in, uint32_t& out, nframes_t nframes, 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 (ParamID) = 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; @@ -133,12 +128,47 @@ 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(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(); } + + const PresetRecord* preset_by_label(const std::string& label); + const PresetRecord* preset_by_uri(const std::string& uri); virtual bool has_editor() const = 0; + 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; } + + /* 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() { return _info; } void set_info (const PluginInfoPtr inf) { _info = inf; } @@ -150,18 +180,21 @@ class Plugin : public PBD::StatefulDestructible, public Latent protected: friend class PluginInsert; + friend struct PluginInsert::PluginControl; + virtual void set_parameter (uint32_t which, float val) = 0; - ARDOUR::AudioEngine& _engine; - ARDOUR::Session& _session; - PluginInfoPtr _info; - uint32_t _cycles; - map presets; - bool save_preset(string name, string domain /* vst, ladspa etc. */); + bool save_preset (std::string, std::string /* vst, ladspa etc. */); + + ARDOUR::AudioEngine& _engine; + ARDOUR::Session& _session; + PluginInfoPtr _info; + uint32_t _cycles; + std::map presets; }; -PluginPtr find_plugin(ARDOUR::Session&, string name, long unique_id, ARDOUR::PluginType); +PluginPtr find_plugin(ARDOUR::Session&, std::string unique_id, ARDOUR::PluginType); } // namespace ARDOUR - + #endif /* __ardour_plugin_h__ */