169 lines
4.8 KiB
C
169 lines
4.8 KiB
C
/* 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_PLUGIN_H__
|
|
#define __SLV2_PLUGIN_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <stddef.h>
|
|
#include <stdbool.h>
|
|
#include "types.h"
|
|
|
|
|
|
typedef const struct _Plugin SLV2Plugin;
|
|
|
|
|
|
/** \defgroup data Plugin data file access
|
|
*
|
|
* These functions work exclusively with the plugin's RDF data file. They do
|
|
* not load the plugin dynamic library (or access
|
|
* it in any way).
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
|
|
/** Check if this plugin is valid.
|
|
*
|
|
* This is used by plugin lists to avoid loading plugins that are not valid
|
|
* and will not work with libslv2 (eg plugins missing required fields, or
|
|
* having multiple values for mandatory single-valued fields, etc.
|
|
*
|
|
* Note that normal hosts do not need to worry about list - libslv2 does not
|
|
* load invalid plugins in to plugin lists. This is included for plugin
|
|
* testing utilities, etc.
|
|
*
|
|
* \return True if \a plugin is valid.
|
|
*/
|
|
bool
|
|
slv2_plugin_verify(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Duplicate a plugin.
|
|
*
|
|
* Use this if you want to keep an SLV2Plugin around but free the list it came
|
|
* from.
|
|
*
|
|
* \return a newly allocated SLV2Plugin identical to \a plugin (a deep copy).
|
|
*/
|
|
SLV2Plugin*
|
|
slv2_plugin_duplicate(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Get the URI of \a plugin.
|
|
*
|
|
* Any serialization that refers to plugins should refer to them by this.
|
|
* Hosts SHOULD NOT save any filesystem paths, plugin indexes, etc. in saved
|
|
* files; save only the URI.
|
|
*
|
|
* The URI is a globally unique identifier for one specific plugin. Two
|
|
* plugins with the same URI are compatible in port signature, and should
|
|
* be guaranteed to work in a compatible and consistent way. If a plugin
|
|
* is upgraded in an incompatible way (eg if it has different ports), it
|
|
* MUST have a different URI than it's predecessor.
|
|
*
|
|
* \return a shared string which must not be modified or free()'d.
|
|
*/
|
|
const unsigned char*
|
|
slv2_plugin_get_uri(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Get the URL of the RDF data file plugin information is located in.
|
|
*
|
|
* Only file: URL's are supported at this time.
|
|
*
|
|
* \return a complete URL eg. "file:///usr/foo/SomeBundle.lv2/someplug.ttl",
|
|
* which is shared and must not be modified or free()'d.
|
|
*/
|
|
const unsigned char*
|
|
slv2_plugin_get_data_url(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Get the local filesystem path of the RDF data file for \a plugin.
|
|
*
|
|
* \return a valid path on the local filesystem
|
|
* eg. "/usr/foo/SomeBundle.lv2/someplug.ttl" which is shared and must not
|
|
* be free()'d; or NULL if URL is not a local filesystem path.
|
|
*/
|
|
const unsigned char*
|
|
slv2_plugin_get_data_path(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Get the URL of the shared library for \a plugin.
|
|
*
|
|
* \return a shared string which must not be modified or free()'d.
|
|
*/
|
|
const unsigned char*
|
|
slv2_plugin_get_library_url(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Get the local filesystem path of the shared library for \a plugin.
|
|
*
|
|
* \return a valid path on the local filesystem
|
|
* eg. "/usr/foo/SomeBundle.lv2/someplug.so" which is shared and must not
|
|
* be free()'d; or NULL if URL is not a local filesystem path.
|
|
*/
|
|
const unsigned char*
|
|
slv2_plugin_get_library_path(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Get the name of \a plugin.
|
|
*
|
|
* This is guaranteed to return the untranslated name (the doap:name in the
|
|
* data file without a language tag). Returned value must be free()'d by
|
|
* the caller.
|
|
*/
|
|
unsigned char*
|
|
slv2_plugin_get_name(const SLV2Plugin* plugin);
|
|
|
|
|
|
/** Request some property of the plugin.
|
|
*
|
|
* May return NULL if the property was not found (ie is not defined in the
|
|
* data file).
|
|
*
|
|
* Return value must be free()'d by caller.
|
|
*
|
|
* Note that some properties may have multiple values. If the property is a
|
|
* string with multiple languages defined, the translation according to
|
|
* $LANG will be returned if it is set. Otherwise all values will be
|
|
* returned.
|
|
*/
|
|
SLV2Property
|
|
slv2_plugin_get_property(const SLV2Plugin* p,
|
|
const char* property);
|
|
|
|
|
|
/** Get the number of ports on this plugin.
|
|
*/
|
|
unsigned long
|
|
slv2_plugin_get_num_ports(const SLV2Plugin* p);
|
|
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __SLV2_PLUGIN_H__ */
|
|
|