diff options
Diffstat (limited to 'slv2/plugininstance.h')
| -rw-r--r-- | slv2/plugininstance.h | 192 |
1 files changed, 0 insertions, 192 deletions
diff --git a/slv2/plugininstance.h b/slv2/plugininstance.h deleted file mode 100644 index a96dc43..0000000 --- a/slv2/plugininstance.h +++ /dev/null @@ -1,192 +0,0 @@ -/* SLV2 - * Copyright (C) 2007-2011 David Robillard <http://drobilla.net> - * - * 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_PLUGININSTANCE_H__ -#define __SLV2_PLUGININSTANCE_H__ - -#ifdef __cplusplus -extern "C" { -#endif - -#include <stddef.h> -#include <stdlib.h> -#include "lv2.h" -#include "slv2/plugin.h" -#include "slv2/port.h" - -typedef struct _InstanceImpl* SLV2InstanceImpl; - -/** @cond IGNORE */ - -/* Instance of a plugin. - * - * The LV2 descriptor and handle of this are exposed to allow inlining of - * performance critical functions like slv2_instance_run (which are exposed - * in lv2.h anyway). This is for performance only, this struct is not - * documented and should not be used directly. The remaining implementation - * details are in the opaque pimpl member. - */ -typedef struct _Instance { - const LV2_Descriptor* lv2_descriptor; - LV2_Handle lv2_handle; - SLV2InstanceImpl pimpl; ///< Private implementation -}* SLV2Instance; - -/** @endcond */ - -/** @defgroup slv2_library Plugin library access - * - * An SLV2Instance is an instantiated SLV2Plugin (ie a loaded dynamic - * library). These functions interact with the binary library code only, - * they do not read data files in any way. - * - * @{ - */ - -/** Instantiate a plugin. - * The returned object represents shared library objects loaded into memory, - * it must be cleaned up with slv2_instance_free when no longer - * needed. - * - * @a plugin is not modified or directly referenced by the returned object - * (instances store only a copy of the plugin's URI). - * - * @a host_features NULL-terminated array of features the host supports. - * NULL may be passed if the host supports no additional features (unlike - * the LV2 specification - SLV2 takes care of it). - * - * @return NULL if instantiation failed. - */ -SLV2_API -SLV2Instance -slv2_plugin_instantiate(SLV2Plugin plugin, - double sample_rate, - const LV2_Feature*const* features); - -/** Free a plugin instance. - * @a instance is invalid after this call. - */ -SLV2_API -void -slv2_instance_free(SLV2Instance instance); - -#ifndef SLV2_INTERNAL - -/** Get the URI of the plugin which @a instance is an instance of. - * Returned string is shared and must not be modified or deleted. - */ -static inline const char* -slv2_instance_get_uri(SLV2Instance instance) -{ - return instance->lv2_descriptor->URI; -} - -/** Connect a port to a data location. - * This may be called regardless of whether the plugin is activated, - * activation and deactivation does not destroy port connections. - */ -static inline void -slv2_instance_connect_port(SLV2Instance instance, - uint32_t port_index, - void* data_location) -{ - instance->lv2_descriptor->connect_port - (instance->lv2_handle, port_index, data_location); -} - -/** Activate a plugin instance. - * This resets all state information in the plugin, except for port data - * locations (as set by slv2_instance_connect_port). This MUST be called - * before calling slv2_instance_run. - */ -static inline void -slv2_instance_activate(SLV2Instance instance) -{ - if (instance->lv2_descriptor->activate) - instance->lv2_descriptor->activate(instance->lv2_handle); -} - -/** Run @a instance for @a sample_count frames. - * If the hint lv2:hardRTCapable is set for this plugin, this function is - * guaranteed not to block. - */ -static inline void -slv2_instance_run(SLV2Instance instance, - uint32_t sample_count) -{ - instance->lv2_descriptor->run(instance->lv2_handle, sample_count); -} - -/** Deactivate a plugin instance. - * Note that to run the plugin after this you must activate it, which will - * reset all state information (except port connections). - */ -static inline void -slv2_instance_deactivate(SLV2Instance instance) -{ - if (instance->lv2_descriptor->deactivate) - instance->lv2_descriptor->deactivate(instance->lv2_handle); -} - -/** Get extension data from the plugin instance. - * The type and semantics of the data returned is specific to the particular - * extension, though in all cases it is shared and must not be deleted. - */ -static inline const void* -slv2_instance_get_extension_data(SLV2Instance instance, - const char* uri) -{ - if (instance->lv2_descriptor->extension_data) - return instance->lv2_descriptor->extension_data(uri); - else - return NULL; -} - -/** Get the LV2_Descriptor of the plugin instance. - * Normally hosts should not need to access the LV2_Descriptor directly, - * use the slv2_instance_* functions. - * - * The returned descriptor is shared and must not be deleted. - */ -static inline const LV2_Descriptor* -slv2_instance_get_descriptor(SLV2Instance instance) -{ - return instance->lv2_descriptor; -} - -/** Get the LV2_Handle of the plugin instance. - * Normally hosts should not need to access the LV2_Handle directly, - * use the slv2_instance_* functions. - * - * The returned handle is shared and must not be deleted. - */ -static inline LV2_Handle -slv2_instance_get_handle(SLV2Instance instance) -{ - return instance->lv2_handle; -} - -#endif /* LIBSLV2_SOURCE */ - -/** @} */ - -#ifdef __cplusplus -} /* extern "C" */ -#endif - -#endif /* __SLV2_PLUGININSTANCE_H__ */ |