1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
// Copyright 2017 Stefan Riha, Artem Popov // Documentation copied from http://lv2plug.in/ns/lv2core/lv2.h // Copyright text of the original C file: // LV2 - An audio plugin interface specification. // Copyright 2006-2012 Steve Harris, David Robillard. // // 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. // // THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES // WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF // MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR // ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES // WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN // ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF // OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. // //! Documentation of the corresponding C header files: http://lv2plug.in/ns/lv2core/. use libc; /** 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. */ pub type LV2Handle = *mut libc::c_void; /** 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 `URI` and `data` to be used if necessary. Some features, such as lv2:isLive, do not require the host to pass data. */ #[repr(C)] pub struct LV2Feature { /** A globally unique, case-sensitive identifier (URI) for this feature. This MUST be a valid URI string as defined by RFC 3986. */ pub uri: *const libc::c_char, /** Pointer to arbitrary data. The format of this data is defined by the extension which describes the feature with the given `URI`. */ pub data: *mut libc::c_void, } /** Plugin Descriptor. This structure provides the core functions necessary to instantiate and use a plugin. */ #[repr(C)] pub struct LV2Descriptor { /** A globally unique, case-sensitive identifier for this plugin. This MUST be a valid URI string as defined by RFC 3986. All plugins with the same URI MUST be compatible to some degree, see http://lv2plug.in/ns/lv2core for details. */ pub uri: *const libc::c_char, /** Instantiate the plugin. Note that instance initialisation should generally occur in activate() rather than here. If a host calls instantiate(), it MUST call cleanup() at some point in the future. @param descriptor Descriptor of the plugin to instantiate. @param sample_rate Sample rate, in Hz, for the new plugin instance. @param bundle_path Path to the LV2 bundle which contains this plugin 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 NOT use this as a discovery mechanism: instead, use the RDF data to determine which features are required and do not attempt to instantiate unsupported plugins at all. This parameter MUST NOT be NULL, i.e. a host that supports no features MUST pass a single element array containing NULL. @return A handle for the new plugin instance, or NULL if instantiation has failed. */ pub instantiate: extern "C" fn(descriptor: *const LV2Descriptor, rate: f64, bundle_path: *const libc::c_char, features: *const (*const LV2Feature)) -> LV2Handle, /** Connect a port on a plugin instance to a memory location. 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. connect_port() MUST be called at least once for each port before run() is called, unless that port is lv2:connectionOptional. The plugin must pay careful attention to the block size passed to run() since the block allocated may only just be large enough to contain the data, and is not guaranteed to remain constant between run() calls. connect_port() may be called more than once for a plugin instance to allow the host to change the buffers that the plugin is reading or writing. These calls may be made before or after activate() or deactivate() calls. @param instance Plugin instance containing the port. @param port Index of the port to connect. The host MUST NOT try to connect a port index that is not defined in the plugin's RDF data. If it does, the plugin's behaviour is undefined (a crash is likely). @param data_location Pointer to data of the type defined by the port type in the plugin's RDF data (e.g. an array of float for an lv2:AudioPort). This pointer must be stored by the plugin instance and used to read/write data when run() is called. Data present at the time of the connect_port() call MUST NOT be considered meaningful. */ pub connect_port: extern "C" fn(handle: LV2Handle, port: u32, data: *mut libc::c_void), /** 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, however plugins MUST NOT rely on a prompt call to run() after activate(). The host MUST NOT call activate() again until deactivate() has been called first. If a host calls activate(), it MUST call deactivate() at some point in the future. Note that connect_port() may be called before or after activate(). */ pub activate: Option<extern "C" fn(instance: LV2Handle)>, /** Run a plugin instance for a block. 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). As a special case, when `sample_count` is 0, the plugin should update any output ports that represent a single instant in time (e.g. control ports, but not audio ports). This is particularly useful for latent plugins, which should update their latency output port so hosts can pre-roll plugins to compute latency. Plugins MUST NOT crash when `sample_count` is 0. @param instance Instance to be run. @param sample_count The block size (in samples) for which the plugin instance must run. */ pub run: extern "C" fn(instance: LV2Handle, n_samples: u32), /** Deactivate a plugin instance (counterpart to activate()). Hosts MUST deactivate all activated instances after they have been run() for the last time. This call SHOULD be made as close to the last run() call as possible and indicates to real-time plugins that they are no longer live, however plugins MUST NOT rely on prompt deactivation. If there is nothing for deactivate() to do then this field may be NULL Deactivation is not similar to pausing since the plugin instance will be reinitialised by activate(). However, deactivate() itself MUST NOT fully reset plugin state. For example, the host may deactivate a plugin, then store its state (using some extension to do so). Hosts MUST NOT call deactivate() unless activate() was previously called. Note that connect_port() may be called before or after deactivate(). */ pub deactivate: Option<extern "C" fn(instance: LV2Handle)>, /** 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. */ pub cleanup: extern "C" fn(instance: LV2Handle), /** Return additional plugin data defined by some extenion. 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. */ pub extension_data: extern "C" fn(uri: *const u8) -> (*const libc::c_void), }