#include <boost/shared_ptr.hpp>
#include <string>
+#include <set>
#include "pbd/statefuldestructible.h"
#include "pbd/controllable.h"
typedef boost::shared_ptr<Plugin> PluginPtr;
typedef boost::shared_ptr<PluginInfo> PluginInfoPtr;
typedef std::list<PluginInfoPtr> PluginInfoList;
-
+typedef std::set<uint32_t> PluginOutputConfiguration;
+
+/** A plugin is an external module (usually 3rd party provided) loaded into Ardour
+ * for the purpose of digital signal processing.
+ *
+ * This class provides an abstraction for methords provided by
+ * all supported plugin standards such as presets, name, parameters etc.
+ *
+ * Plugins are not used directly in Ardour but always wrapped by a PluginInsert.
+ */
class LIBARDOUR_API Plugin : public PBD::StatefulDestructible, public Latent
{
public:
virtual bool parameter_is_input(uint32_t) const = 0;
virtual bool parameter_is_output(uint32_t) const = 0;
+ struct LIBARDOUR_API IOPortDescription {
+ public:
+ IOPortDescription (const std::string& n)
+ : name (n)
+ , is_sidechain (false)
+ {}
+ IOPortDescription (const IOPortDescription &other)
+ : name (other.name)
+ , is_sidechain (other.is_sidechain)
+ {}
+ std::string name;
+ bool is_sidechain;
+ };
+
+ virtual IOPortDescription describe_io_port (DataType dt, bool input, uint32_t id) const;
+ virtual PluginOutputConfiguration possible_output () const;
+
virtual void set_automation_control (uint32_t /*port_index*/, boost::shared_ptr<ARDOUR::AutomationControl>) { }
virtual boost::shared_ptr<ScalePoints> get_scale_points(uint32_t /*port_index*/) const {
return 0;
}
+ /** Emitted when a Latency Changes
+ *
+ * (this cannot be part of ARDOUR::Latent because
+ * signals cannot be copy-constructed).
+ */
+ PBD::Signal2<void,framecnt_t, framecnt_t> LatencyChanged;
+
+ /* overload Latent::set_user_latency w/signal emission */
+ virtual void set_user_latency (framecnt_t val) {
+ bool changed = val != _user_latency;
+ framecnt_t old = effective_latency ();
+ _user_latency = val;
+ if (changed) {
+ LatencyChanged (old, effective_latency ()); /* EMIT SIGNAL */
+ }
+ }
+
+ /** the max possible latency a plugin will have */
+ virtual framecnt_t max_latency () const { return 0; } // TODO = 0, require implementation
+
/** Emitted when a preset is added or removed, respectively */
PBD::Signal0<void> PresetAdded;
PBD::Signal0<void> PresetRemoved;
virtual PluginPtr load (Session& session) = 0;
virtual bool is_instrument() const;
+ virtual bool needs_midi_input() const { return is_instrument (); }
virtual bool in_category (const std::string &) const { return false; }
virtual std::vector<Plugin::PresetRecord> get_presets (bool user_only) const = 0;