summaryrefslogtreecommitdiffstats
path: root/slv2/port.h
diff options
context:
space:
mode:
Diffstat (limited to 'slv2/port.h')
-rw-r--r--slv2/port.h116
1 files changed, 116 insertions, 0 deletions
diff --git a/slv2/port.h b/slv2/port.h
new file mode 100644
index 0000000..749ea4e
--- /dev/null
+++ b/slv2/port.h
@@ -0,0 +1,116 @@
+/* LibSLV2
+ * Copyright (C) 2006 Dave Robillard <drobilla@connect.carleton.ca>
+ *
+ * This library is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License as published by the Free
+ * Software Foundation; either version 2 of the License, or (at your option)
+ * any later version.
+ *
+ * This library is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef __SLV2_PORT_H__
+#define __SLV2_PORT_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "types.h"
+#include "plugin.h"
+
+/** \addtogroup data
+ * @{
+ */
+
+
+/** A port on a plugin.
+ *
+ * The information necessary to use the port is stored here, any extra
+ * information can be queried with slv2port_get_property.
+ */
+/*struct LV2Port {
+ unsigned long index; ///< Index in ports array
+ char* short_name; ///< Guaranteed unique identifier
+ char* type; ///< eg. lv2:InputControlPort
+ char* data_type; ///< eg. lv2:float
+};*/
+
+
+/** Get a property of a port, by port index.
+ *
+ * Return value must be free()'d by caller.
+ */
+SLV2Property
+slv2_port_get_property(SLV2Plugin* plugin,
+ unsigned long index,
+ const uchar* property);
+
+
+/** Get the symbol of a port given the index.
+ *
+ * The 'symbol' is a short string, a valid C identifier.
+ * Returned string must be free()'d by caller.
+ *
+ * \return NULL when index is out of range
+ */
+uchar*
+slv2_port_get_symbol(SLV2Plugin* plugin,
+ unsigned long index);
+
+
+/** Get the class (direction and rate) of a port.
+ */
+enum SLV2PortClass
+slv2_port_get_class(SLV2Plugin* plugin,
+ unsigned long index);
+
+
+/** Get the data type of a port.
+ */
+enum SLV2DataType
+slv2_port_get_data_type(SLV2Plugin* plugin,
+ unsigned long index);
+
+
+/** Get the default value of a port.
+ *
+ * Only valid for ports with a data type of lv2:float.
+ */
+float
+slv2_port_get_default_value(SLV2Plugin* plugin,
+ unsigned long index);
+
+
+/** Get the minimum value of a port.
+ *
+ * Only valid for ports with a data type of lv2:float.
+ */
+float
+slv2_port_get_minimum_value(SLV2Plugin* plugin,
+ unsigned long index);
+
+
+/** Get the maximum value of a port.
+ *
+ * Only valid for ports with a data type of lv2:float.
+ */
+float
+slv2_port_get_maximum_value(SLV2Plugin* plugin,
+ unsigned long index);
+
+
+/** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __SLV2_PORT_H__ */