diff options
Diffstat (limited to 'lv2/lv2plug.in/ns')
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/atom/atom-test.c | 2 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/data-access/data-access.h | 6 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h | 36 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/event/event.h | 40 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/uri-map/uri-map.h | 12 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/lv2core/lv2.h | 30 |
6 files changed, 63 insertions, 63 deletions
diff --git a/lv2/lv2plug.in/ns/ext/atom/atom-test.c b/lv2/lv2plug.in/ns/ext/atom/atom-test.c index d2762f3..693ec92 100644 --- a/lv2/lv2plug.in/ns/ext/atom/atom-test.c +++ b/lv2/lv2plug.in/ns/ext/atom/atom-test.c @@ -283,7 +283,7 @@ main() } ++n_events; } - + unsigned n_props = 0; LV2_ATOM_OBJECT_FOREACH((LV2_Atom_Object*)obj, prop) { if (!prop->key) { diff --git a/lv2/lv2plug.in/ns/ext/data-access/data-access.h b/lv2/lv2plug.in/ns/ext/data-access/data-access.h index fac6974..244204a 100644 --- a/lv2/lv2plug.in/ns/ext/data-access/data-access.h +++ b/lv2/lv2plug.in/ns/ext/data-access/data-access.h @@ -31,7 +31,7 @@ /** The data field of the LV2_Feature for this extension. - + To support this feature the host must pass an LV2_Feature struct to the instantiate method with URI "http://lv2plug.in/ns/ext/data-access" and data pointed to an instance of this struct. @@ -40,11 +40,11 @@ typedef struct { /** A pointer to a method the UI can call to get data (of a type specified by some other extension) from the plugin. - + This call never is never guaranteed to return anything, UIs should degrade gracefully if direct access to the plugin data is not possible (in which case this function will return NULL). - + This is for access to large data that can only possibly work if the UI and plugin are running in the same process. For all other things, use the normal LV2 UI communication system. diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h index 51908b7..b62f8ef 100644 --- a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h +++ b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h @@ -37,7 +37,7 @@ extern "C" { /** Dynamic manifest generator handle. - + This handle indicates a particular status of a dynamic manifest generator. The host MUST NOT attempt to interpret it and, unlikely LV2_Handle, it is NOT even valid to compare this to NULL. The dynamic manifest generator MAY @@ -47,16 +47,16 @@ typedef void * LV2_Dyn_Manifest_Handle; /** Generate the dynamic manifest. - + @param handle Pointer to an uninitialized dynamic manifest generator handle. - + @param features NULL terminated array of LV2_Feature structs which represent the features the host supports. The dynamic manifest generator may refuse to (re)generate the dynamic manifest if required features are not found here (however hosts SHOULD NOT use this as a discovery mechanism, instead of reading the static manifest file). This array must always exist; if a host has no features, it MUST pass a single element array containing NULL. - + @return 0 on success, otherwise a non-zero error code. The host SHOULD evaluate the result of the operation by examining the returned value and MUST NOT try to interpret the value of handle. @@ -66,25 +66,25 @@ int lv2_dyn_manifest_open(LV2_Dyn_Manifest_Handle * handle, /** Fetch a "list" of subject URIs described in the dynamic manifest. - + The dynamic manifest generator has to fill the resource only with the needed triples to make the host aware of the "objects" it wants to expose. For example, if the plugin library exposes a regular LV2 plugin, it should output only a triple like the following: - + <http://www.example.com/plugin/uri> a lv2:Plugin . - + The objects that are elegible for exposure are those that would need to be represented by a subject node in a static manifest. - + @param handle Dynamic manifest generator handle. - + @param fp FILE * identifying the resource the host has to set up for the dynamic manifest generator. The host MUST pass a writable, empty resource to this function, and the dynamic manifest generator MUST ONLY perform write operations on it at the end of the stream (e.g., using only fprintf(), fwrite() and similar). - + @return 0 on success, otherwise a non-zero error code. */ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle, @@ -92,7 +92,7 @@ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle, /** Function that fetches data related to a specific URI. - + The dynamic manifest generator has to fill the resource with data related to object represented by the given URI. For example, if the library exposes a regular LV2 plugin whose URI, as retrieved by the host using @@ -106,18 +106,18 @@ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle, lv2:binary <mylib.so> ; etc:etc "..." . </pre> - + @param handle Dynamic manifest generator handle. - + @param fp FILE * identifying the resource the host has to set up for the dynamic manifest generator. The host MUST pass a writable resource to this function, and the dynamic manifest generator MUST ONLY perform write operations on it at the current position of the stream (e.g. using only fprintf(), fwrite() and similar). - + @param uri URI to get data about (in the "plain" form, i.e., absolute URI without Turtle prefixes). - + @return 0 on success, otherwise a non-zero error code. */ int lv2_dyn_manifest_get_data(LV2_Dyn_Manifest_Handle handle, @@ -126,13 +126,13 @@ int lv2_dyn_manifest_get_data(LV2_Dyn_Manifest_Handle handle, /** Function that ends the operations on the dynamic manifest generator. - + This function SHOULD be used by the dynamic manifest generator to perform cleanup operations, etc. - + Once this function is called, referring to handle will cause undefined behavior. - + @param handle Dynamic manifest generator handle. */ void lv2_dyn_manifest_close(LV2_Dyn_Manifest_Handle handle); diff --git a/lv2/lv2plug.in/ns/ext/event/event.h b/lv2/lv2plug.in/ns/ext/event/event.h index 477a34f..88ef01d 100644 --- a/lv2/lv2plug.in/ns/ext/event/event.h +++ b/lv2/lv2plug.in/ns/ext/event/event.h @@ -18,12 +18,12 @@ /** @file event.h C API for the LV2 Event extension <http://lv2plug.in/ns/ext/event>. - + This extension is a generic transport mechanism for time stamped events of any type (e.g. MIDI, OSC, ramps, etc). Each port can transport mixed events of any type; the type of events and timestamps are defined by a URI which is mapped to an integer by the host for performance reasons. - + This extension requires the host to support the LV2 URI Map extension. Any host which supports this extension MUST guarantee that any call to the LV2 URI Map uri_to_id function with the URI of this extension as the @@ -60,15 +60,15 @@ static const uint32_t LV2_EVENT_PPQN = 3136573440U; /** An LV2 event (header only). - + LV2 events are generic time-stamped containers for any type of event. The type field defines the format of a given event's contents. - + This struct defines the header of an LV2 event. An LV2 event is a single chunk of POD (plain old data), usually contained in a flat buffer (see LV2_EventBuffer below). Unless a required feature says otherwise, hosts may assume a deep copy of an LV2 event can be created safely using a simple: - + memcpy(ev_copy, ev, sizeof(LV2_Event) + ev->size); (or equivalent) */ typedef struct { @@ -119,16 +119,16 @@ typedef struct { /** A buffer of LV2 events (header only). - + Like events (which this contains) an event buffer is a single chunk of POD: the entire buffer (including contents) can be copied with a single memcpy. The first contained event begins sizeof(LV2_EventBuffer) bytes after the start of this struct. - + After this header, the buffer contains an event header (defined by struct LV2_Event), followed by that event's contents (padded to 64 bits), followed by another header, etc: - + | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |FRAMES |SUBFRMS|TYP|LEN|DATA..DATA..PAD|FRAMES | ... @@ -145,7 +145,7 @@ typedef struct { /** The size of this event header in bytes (including everything). - + This is to allow for extending this header in the future without breaking binary compatibility. Whenever this header is copied, it MUST be done using this field (and NOT the sizeof this struct). @@ -166,7 +166,7 @@ typedef struct { connect_port is called on the input port, at which time the host MUST have set the stamp_type field to the value that will be used for all subsequent run calls. - + OUTPUTS: The plugin may set this to any value that has been returned from uri_to_id with the URI of this extension for a 'map' argument. When connected to a buffer with connect_port, output ports MUST set this @@ -223,7 +223,7 @@ typedef void* LV2_Event_Callback_Data; /** Non-POD events feature. - + To support this feature the host must pass an LV2_Feature struct to the plugin's instantiate method with URI "http://lv2plug.in/ns/ext/event" and data pointed to an instance of this struct. Note this feature @@ -233,7 +233,7 @@ typedef struct { /** Opaque pointer to host data. - + The plugin MUST pass this to any call to functions in this struct. Otherwise, it must not be interpreted in any way. */ @@ -241,7 +241,7 @@ typedef struct { /** Take a reference to a non-POD event. - + If a plugin receives an event with type 0, it means the event is a pointer to some object in memory and not a flat sequence of bytes in the buffer. When receiving a non-POD event, the plugin already @@ -249,16 +249,16 @@ typedef struct { passed to an output, lv2_event_ref MUST be called on that event. If the event is only stored OR passed through, this is not necessary (as the plugin already has 1 implicit reference). - + @param event An event received at an input that will not be copied to an output or stored in any way. - + @param context The calling context. Like event types, this is a mapped URI, see lv2_context.h. Simple plugin with just a run() method should pass 0 here (the ID of the 'standard' LV2 run context). The host guarantees that this function is realtime safe iff @a context is realtime safe. - + PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS. */ uint32_t (*lv2_event_ref)(LV2_Event_Callback_Data callback_data, @@ -266,22 +266,22 @@ typedef struct { /** Drop a reference to a non-POD event. - + If a plugin receives an event with type 0, it means the event is a pointer to some object in memory and not a flat sequence of bytes in the buffer. If the plugin does not pass the event through to an output or store it internally somehow, it MUST call this function on the event (more information on using non-POD events below). - + @param event An event received at an input that will not be copied to an output or stored in any way. - + @param context The calling context. Like event types, this is a mapped URI, see lv2_context.h. Simple plugin with just a run() method should pass 0 here (the ID of the 'standard' LV2 run context). The host guarantees that this function is realtime safe iff @a context is realtime safe. - + PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS. */ uint32_t (*lv2_event_unref)(LV2_Event_Callback_Data callback_data, diff --git a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h index 6767cd1..df22cc7 100644 --- a/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h +++ b/lv2/lv2plug.in/ns/ext/uri-map/uri-map.h @@ -17,7 +17,7 @@ /** @file C header 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 integers, usually for performance reasons (e.g. processing events typed by URIs in real time). The expected use case is for plugins to map URIs to @@ -41,7 +41,7 @@ typedef void* LV2_URI_Map_Callback_Data; /** URI Map Feature. - + To support this feature the host must pass an LV2_Feature struct to the plugin's instantiate method with URI "http://lv2plug.in/ns/ext/uri-map" and data pointed to an instance of this struct. @@ -50,7 +50,7 @@ typedef struct { /** Opaque pointer to host data. - + The plugin MUST pass this to any call to functions in this struct. Otherwise, it must not be interpreted in any way. */ @@ -58,7 +58,7 @@ typedef struct { /** Get the numeric ID of a URI from the host. - + @param callback_data Must be the callback_data member of this struct. @param map The 'context' of this URI. Certain extensions may define a URI that must be passed here with certain restrictions on the return @@ -67,14 +67,14 @@ typedef struct { unless there is a specific need to do so, e.g. to restrict the range of the returned value. @param uri The URI to be mapped to an integer ID. - + This function is referentially transparent; any number of calls with the same arguments is guaranteed to return the same value over the life of a plugin instance (though the same URI may return different values with a different map parameter). However, this function is not necessarily very fast: plugins SHOULD cache any IDs they might need in performance critical situations. - + The return value 0 is reserved and indicates that an ID for that URI could not be created for whatever reason. Extensions MAY define more precisely what this means in a certain context, but in general plugins diff --git a/lv2/lv2plug.in/ns/lv2core/lv2.h b/lv2/lv2plug.in/ns/lv2core/lv2.h index 0a89491..42ea819 100644 --- a/lv2/lv2plug.in/ns/lv2core/lv2.h +++ b/lv2/lv2plug.in/ns/lv2core/lv2.h @@ -4,7 +4,7 @@ Based on LADSPA, Copyright 2000-2002 Richard W.E. Furse, Paul Barton-Davis, Stefan Westerfeld. - + Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. @@ -119,7 +119,7 @@ extern "C" { /** Plugin Instance Handle. - + This is a handle for one particular instance of a plugin. It is valid to compare to NULL (or 0 for C++) but otherwise the host MUST NOT attempt to interpret it. @@ -128,7 +128,7 @@ typedef void * LV2_Handle; /** Feature. - + Features allow hosts to make additional functionality available to plugins without requiring modification to the LV2 API. Extensions may define new features and specify the @ref URI and @ref data to be used if necessary. @@ -153,7 +153,7 @@ typedef struct _LV2_Feature { /** Plugin Descriptor. - + This structure provides the core functions necessary to instantiate and use a plugin. */ @@ -182,7 +182,7 @@ typedef struct _LV2_Descriptor { binary. It MUST include the trailing directory separator (e.g. '/') so that simply appending a filename will yield the path to that file in the bundle. - + @param features A NULL terminated array of LV2_Feature structs which represent the features the host supports. Plugins may refuse to instantiate if required features are not found here. However, hosts MUST @@ -193,7 +193,7 @@ typedef struct _LV2_Descriptor { NULL. @return A handle for the new plugin instance, or NULL if instantiation - has failed. + has failed. */ LV2_Handle (*instantiate)(const struct _LV2_Descriptor * descriptor, double sample_rate, @@ -206,7 +206,7 @@ typedef struct _LV2_Descriptor { Plugin writers should be aware that the host may elect to use the same buffer for more than one port and even use the same buffer for both input and output (see lv2:inPlaceBroken in lv2.ttl). - + If the plugin has the feature lv2:hardRTCapable then there are various things that the plugin MUST NOT do within the connect_port() function; see lv2core.ttl for details. @@ -240,14 +240,14 @@ typedef struct _LV2_Descriptor { /** Initialise a plugin instance and activate it for use. - + This is separated from instantiate() to aid real-time support and so that hosts can reinitialise a plugin instance by calling deactivate() and then activate(). In this case the plugin instance MUST reset all state information dependent on the history of the plugin instance except for any data locations provided by connect_port(). If there is nothing for activate() to do then this field may be NULL. - + When present, hosts MUST call this function once before run() is called for the first time. This call SHOULD be made as close to the run() call as possible and indicates to real-time plugins that they are now live, @@ -267,7 +267,7 @@ typedef struct _LV2_Descriptor { Note that if an activate() function exists then it must be called before run(). If deactivate() is called for a plugin instance then run() may not be called until activate() has been called again. - + If the plugin has the feature lv2:hardRTCapable then there are various things that the plugin MUST NOT do within the run() function (see lv2core.ttl for details). @@ -309,11 +309,11 @@ typedef struct _LV2_Descriptor { /** Clean up a plugin instance (counterpart to instantiate()). - + Once an instance of a plugin has been finished with it must be deleted using this function. The instance handle passed ceases to be valid after this call. - + If activate() was called for a plugin instance then a corresponding call to deactivate() MUST be made before cleanup() is called. Hosts MUST NOT call cleanup() unless instantiate() was previously called. @@ -325,12 +325,12 @@ typedef struct _LV2_Descriptor { A typical use of this facility is to return a struct containing function pointers to extend the LV2_Descriptor API. - + The actual type and meaning of the returned object MUST be specified precisely by the extension. This function MUST return NULL for any unsupported URI. If a plugin does not support any extension data, this field may be NULL. - + The host is never responsible for freeing the returned value. */ const void * (*extension_data)(const char * uri); @@ -354,7 +354,7 @@ typedef struct _LV2_Descriptor { available during discovery, and it relies on non-portable shared library constructors/destructors. However, this API is still supported and plugins are not required to migrate. - + Plugins are discovered by hosts using RDF data (not by loading libraries). See http://lv2plug.in for details on the discovery process, though most hosts should use an existing library to implement this functionality. |