X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Fplugin.h;h=a69b87efbdf14da59ddce9cbc0aea969bc2be207;hb=8f930477be9e2c88859a8ea30b213fba3f7fc443;hp=649d045d413dfda064216e0589e6acffd9dbd1cf;hpb=4ae4704112fcbd5f4eacf5947fc1ffca06c630d5;p=ardour.git diff --git a/libs/ardour/ardour/plugin.h b/libs/ardour/ardour/plugin.h index 649d045d41..a69b87efbd 100644 --- a/libs/ardour/ardour/plugin.h +++ b/libs/ardour/ardour/plugin.h @@ -32,6 +32,7 @@ #include "ardour/cycles.h" #include "ardour/latent.h" #include "ardour/plugin_insert.h" +#include "ardour/libardour_visibility.h" #include "ardour/types.h" #include "ardour/midi_state_tracker.h" @@ -49,7 +50,7 @@ class Plugin; typedef boost::shared_ptr PluginPtr; -class PluginInfo { +class LIBARDOUR_API PluginInfo { public: PluginInfo () { } virtual ~PluginInfo () { } @@ -65,6 +66,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; @@ -74,7 +88,7 @@ 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&); @@ -83,7 +97,23 @@ class Plugin : public PBD::StatefulDestructible, public Latent struct ParameterDescriptor { - /* essentially a union of LADSPA and VST info */ + ParameterDescriptor () + : integer_step(false) + , toggled (false) + , logarithmic (false) + , sr_dependent (false) + , lower (0) + , upper (0) + , step (0) + , smallstep (0) + , largestep (0) + , min_unbound (0) + , max_unbound (0) + , enumeration (false) + , midinote(false) + {} + + /* essentially a union of LADSPA, VST and LV2 info */ bool integer_step; bool toggled; @@ -97,12 +127,14 @@ class Plugin : public PBD::StatefulDestructible, public Latent float largestep; bool min_unbound; bool max_unbound; + bool enumeration; + bool midinote; ///< only used if integer_step is also true }; XMLNode& get_state (); virtual int set_state (const XMLNode &, int version); - virtual void set_insert_info(const PluginInsert* insert) {} + virtual void set_insert_info (const PluginInsert*) {} virtual std::string unique_id() const = 0; virtual const char * label() const = 0; @@ -111,12 +143,14 @@ 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 flush () { deactivate(); activate(); } + virtual void flush () { deactivate(); activate(); } virtual int set_block_size (pframes_t nframes) = 0; @@ -134,46 +168,76 @@ 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; + typedef std::map ScalePoints; + + 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 () : user (true) {} - PresetRecord (const std::string& u, const std::string& l, bool s = true) : uri (u), label (l), user (s) {} - - bool operator!= (PresetRecord const & a) const { - return uri != a.uri || label != a.label; - } - - std::string uri; - std::string label; - bool user; + 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; }; PresetRecord save_preset (std::string); void remove_preset (std::string); virtual bool load_preset (PresetRecord); - + void clear_preset (); + const PresetRecord * preset_by_label (const std::string &); const PresetRecord * preset_by_uri (const std::string &); std::vector get_presets (); + /** @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; } + + /** @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; } + /** @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; @@ -186,30 +250,17 @@ class Plugin : public PBD::StatefulDestructible, public Latent /** Emitted when any parameter changes */ 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 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() const { return _info; } - void set_info (const PluginInfoPtr inf) { _info = inf; } + virtual void set_info (const PluginInfoPtr inf); ARDOUR::AudioEngine& engine() const { return _engine; } ARDOUR::Session& session() const { return _session; } @@ -217,8 +268,11 @@ class Plugin : public PBD::StatefulDestructible, public Latent void set_cycles (uint32_t c) { _cycles = c; } cycles_t cycles() const { return _cycles; } + PBD::Signal1 StartTouch; + PBD::Signal1 EndTouch; + protected: - + friend class PluginInsert; friend struct PluginInsert::PluginControl; @@ -251,6 +305,8 @@ private: 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);