| @@ -14,6 +14,15 @@ | |||||
| OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | ||||
| */ | */ | ||||
| /** | |||||
| @defgroup parameters Parameters | |||||
| Common parameters for audio processing, see | |||||
| <http://lv2plug.in/ns/ext/parameters>. | |||||
| @{ | |||||
| */ | |||||
| #ifndef LV2_PARAMETERS_H | #ifndef LV2_PARAMETERS_H | ||||
| #define LV2_PARAMETERS_H | #define LV2_PARAMETERS_H | ||||
| @@ -47,3 +56,7 @@ | |||||
| #define LV2_PARAMETERS__wetLevel LV2_PARAMETERS_PREFIX "wetLevel" | #define LV2_PARAMETERS__wetLevel LV2_PARAMETERS_PREFIX "wetLevel" | ||||
| #endif /* LV2_PARAMETERS_H */ | #endif /* LV2_PARAMETERS_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -15,11 +15,15 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file patch.h C header for the LV2 Patch extension | |||||
| <http://lv2plug.in/ns/ext/patch>. | |||||
| @defgroup patch Patch | |||||
| The patch extension is purely data, this header merely defines URIs | |||||
| for convenience. | |||||
| Messages for accessing and manipulating properties, see | |||||
| <http://lv2plug.in/ns/ext/patch> for details. | |||||
| Note the patch extension is purely data, this header merely defines URIs for | |||||
| convenience. | |||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_PATCH_H | #ifndef LV2_PATCH_H | ||||
| @@ -30,6 +34,7 @@ | |||||
| #define LV2_PATCH__Ack LV2_PATCH_PREFIX "Ack" | #define LV2_PATCH__Ack LV2_PATCH_PREFIX "Ack" | ||||
| #define LV2_PATCH__Delete LV2_PATCH_PREFIX "Delete" | #define LV2_PATCH__Delete LV2_PATCH_PREFIX "Delete" | ||||
| #define LV2_PATCH__Copy LV2_PATCH_PREFIX "Copy" | |||||
| #define LV2_PATCH__Error LV2_PATCH_PREFIX "Error" | #define LV2_PATCH__Error LV2_PATCH_PREFIX "Error" | ||||
| #define LV2_PATCH__Get LV2_PATCH_PREFIX "Get" | #define LV2_PATCH__Get LV2_PATCH_PREFIX "Get" | ||||
| #define LV2_PATCH__Message LV2_PATCH_PREFIX "Message" | #define LV2_PATCH__Message LV2_PATCH_PREFIX "Message" | ||||
| @@ -54,3 +59,7 @@ | |||||
| #define LV2_PATCH__writable LV2_PATCH_PREFIX "writable" | #define LV2_PATCH__writable LV2_PATCH_PREFIX "writable" | ||||
| #endif /* LV2_PATCH_H */ | #endif /* LV2_PATCH_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -15,9 +15,12 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file port-groups.h | |||||
| C definitions for the LV2 Port Groups extension | |||||
| <http://lv2plug.in/ns/ext/port-groups>. | |||||
| @defgroup port-groups Port Groups | |||||
| Multi-channel groups of LV2 ports, see | |||||
| <http://lv2plug.in/ns/ext/port-groups> for details. | |||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_PORT_GROUPS_H | #ifndef LV2_PORT_GROUPS_H | ||||
| @@ -62,3 +65,7 @@ | |||||
| #define LV2_PORT_GROUPS__subGroupOf LV2_PORT_GROUPS_PREFIX "subGroupOf" | #define LV2_PORT_GROUPS__subGroupOf LV2_PORT_GROUPS_PREFIX "subGroupOf" | ||||
| #endif /* LV2_PORT_GROUPS_H */ | #endif /* LV2_PORT_GROUPS_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -15,9 +15,11 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file port-props.h | |||||
| C definitions for the LV2 Port Props extension | |||||
| <http://lv2plug.in/ns/ext/port-props>. | |||||
| @defgroup port-props Port Properties | |||||
| Various port properties. | |||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_PORT_PROPS_H | #ifndef LV2_PORT_PROPS_H | ||||
| @@ -40,3 +42,7 @@ | |||||
| #define LV2_PORT_PROPS__trigger LV2_PORT_PROPS_PREFIX "trigger" | #define LV2_PORT_PROPS__trigger LV2_PORT_PROPS_PREFIX "trigger" | ||||
| #endif /* LV2_PORT_PROPS_H */ | #endif /* LV2_PORT_PROPS_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -15,10 +15,11 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file presets.h | |||||
| @defgroup presets Presets | |||||
| C definitions for the LV2 Presets extension | |||||
| <http://lv2plug.in/ns/ext/presets>. | |||||
| Presets for plugins, see <http://lv2plug.in/ns/ext/presets> for details. | |||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_PRESETS_H | #ifndef LV2_PRESETS_H | ||||
| @@ -32,3 +33,7 @@ | |||||
| #define LV2_PRESETS__value LV2_PRESETS_PREFIX "value" | #define LV2_PRESETS__value LV2_PRESETS_PREFIX "value" | ||||
| #endif /* LV2_PRESETS_H */ | #endif /* LV2_PRESETS_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -15,9 +15,12 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file units.h | |||||
| C definitions for the LV2 Units extension | |||||
| <http://lv2plug.in/ns/extensions/units>. | |||||
| @defgroup units Units | |||||
| Units for LV2 values, see <http://lv2plug.in/ns/extensions/units> for | |||||
| details. | |||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_UNITS_H | #ifndef LV2_UNITS_H | ||||
| @@ -60,3 +63,7 @@ | |||||
| #define LV2_UNITS__unit LV2_UNITS_PREFIX "unit" | #define LV2_UNITS__unit LV2_UNITS_PREFIX "unit" | ||||
| #endif /* LV2_UNITS_H */ | #endif /* LV2_UNITS_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -15,8 +15,9 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file | |||||
| C header for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>. | |||||
| @defgroup uri-map URI Map | |||||
| C API for the LV2 URI Map extension <http://lv2plug.in/ns/ext/uri-map>. | |||||
| This extension defines a simple mechanism for plugins to map URIs to | This extension defines a simple mechanism for plugins to map URIs to | ||||
| integers, usually for performance reasons (e.g. processing events typed by | integers, usually for performance reasons (e.g. processing events typed by | ||||
| @@ -25,6 +26,8 @@ | |||||
| values for use in the audio thread without doing any string comparison. | values for use in the audio thread without doing any string comparison. | ||||
| This allows the extensibility of RDF with the performance of integers (or | This allows the extensibility of RDF with the performance of integers (or | ||||
| centrally defined enumerations). | centrally defined enumerations). | ||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_URI_MAP_H | #ifndef LV2_URI_MAP_H | ||||
| @@ -96,3 +99,7 @@ typedef struct { | |||||
| #endif | #endif | ||||
| #endif /* LV2_URI_MAP_H */ | #endif /* LV2_URI_MAP_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||
| @@ -16,8 +16,12 @@ | |||||
| */ | */ | ||||
| /** | /** | ||||
| @file urid.h | |||||
| C header for the LV2 URID extension <http://lv2plug.in/ns/ext/urid> | |||||
| @defgroup urid URID | |||||
| Features for mapping URIs to and from integers, see | |||||
| <http://lv2plug.in/ns/ext/urid> for details. | |||||
| @{ | |||||
| */ | */ | ||||
| #ifndef LV2_URID_H | #ifndef LV2_URID_H | ||||
| @@ -106,11 +110,11 @@ typedef struct _LV2_URID_Unmap { | |||||
| /** | /** | ||||
| Get the URI for a previously mapped numeric ID. | Get the URI for a previously mapped numeric ID. | ||||
| Returns NULL if @p urid is not yet mapped. Otherwise, the corresponding | |||||
| Returns NULL if `urid` is not yet mapped. Otherwise, the corresponding | |||||
| URI is returned in a canonical form. This MAY not be the exact same | URI is returned in a canonical form. This MAY not be the exact same | ||||
| string that was originally passed to LV2_URID_Map::map(), but it MUST be | string that was originally passed to LV2_URID_Map::map(), but it MUST be | ||||
| an identical URI according to the URI syntax specification (RFC3986). A | an identical URI according to the URI syntax specification (RFC3986). A | ||||
| non-NULL return for a given @p urid will always be the same for the life | |||||
| non-NULL return for a given `urid` will always be the same for the life | |||||
| of the plugin. Plugins that intend to perform string comparison on | of the plugin. Plugins that intend to perform string comparison on | ||||
| unmapped URIs SHOULD first canonicalise URI strings with a call to | unmapped URIs SHOULD first canonicalise URI strings with a call to | ||||
| map_uri() followed by a call to unmap_uri(). | map_uri() followed by a call to unmap_uri(). | ||||
| @@ -127,3 +131,7 @@ typedef struct _LV2_URID_Unmap { | |||||
| #endif | #endif | ||||
| #endif /* LV2_URID_H */ | #endif /* LV2_URID_H */ | ||||
| /** | |||||
| @} | |||||
| */ | |||||