mirror of
https://github.com/cookiengineer/audacity
synced 2026-01-12 07:35:51 +01:00
Move library tree where it belongs
This commit is contained in:
ra
34
lib-src/slv2/doc/Makefile.am
Normal file
34
lib-src/slv2/doc/Makefile.am
Normal file
@@ -0,0 +1,34 @@
|
||||
dist_man_MANS = \
|
||||
man/man3/slv2.3 \
|
||||
man/man3/slv2_collections.3 \
|
||||
man/man3/slv2_data.3 \
|
||||
man/man3/slv2_library.3 \
|
||||
man/man3/slv2_util.3 \
|
||||
man/man3/slv2_world.3
|
||||
|
||||
if HAVE_DOXYGEN
|
||||
man_MANS = $(dist_man_MANS)
|
||||
all: docs
|
||||
else
|
||||
man_mans =
|
||||
all:
|
||||
endif
|
||||
|
||||
EXTRA_DIST = mainpage.dox reference.doxygen.in $(man_MANS)
|
||||
|
||||
|
||||
|
||||
%.3:
|
||||
make docs
|
||||
|
||||
reference.doxygen: @SLV2_SRCDIR@/doc/reference.doxygen.in
|
||||
|
||||
distclean-local:
|
||||
rm -rf man html
|
||||
|
||||
docs: reference.doxygen @SLV2_SRCDIR@/slv2/*.h
|
||||
doxygen reference.doxygen
|
||||
|
||||
# Don't install man pages with this target,
|
||||
# only install with install-man (for debian package building)
|
||||
install-data:
|
||||
431
lib-src/slv2/doc/Makefile.in
Normal file
431
lib-src/slv2/doc/Makefile.in
Normal file
@@ -0,0 +1,431 @@
|
||||
# Makefile.in generated by automake 1.10.2 from Makefile.am.
|
||||
# @configure_input@
|
||||
|
||||
# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
|
||||
# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
|
||||
# This Makefile.in is free software; the Free Software Foundation
|
||||
# gives unlimited permission to copy and/or distribute it,
|
||||
# with or without modifications, as long as this notice is preserved.
|
||||
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY, to the extent permitted by law; without
|
||||
# even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
||||
# PARTICULAR PURPOSE.
|
||||
|
||||
@SET_MAKE@
|
||||
VPATH = @srcdir@
|
||||
pkgdatadir = $(datadir)/@PACKAGE@
|
||||
pkglibdir = $(libdir)/@PACKAGE@
|
||||
pkgincludedir = $(includedir)/@PACKAGE@
|
||||
am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd
|
||||
install_sh_DATA = $(install_sh) -c -m 644
|
||||
install_sh_PROGRAM = $(install_sh) -c
|
||||
install_sh_SCRIPT = $(install_sh) -c
|
||||
INSTALL_HEADER = $(INSTALL_DATA)
|
||||
transform = $(program_transform_name)
|
||||
NORMAL_INSTALL = :
|
||||
PRE_INSTALL = :
|
||||
POST_INSTALL = :
|
||||
NORMAL_UNINSTALL = :
|
||||
PRE_UNINSTALL = :
|
||||
POST_UNINSTALL = :
|
||||
build_triplet = @build@
|
||||
host_triplet = @host@
|
||||
subdir = doc
|
||||
DIST_COMMON = $(dist_man_MANS) $(srcdir)/Makefile.am \
|
||||
$(srcdir)/Makefile.in $(srcdir)/reference.doxygen.in
|
||||
ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
|
||||
am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
|
||||
$(top_srcdir)/configure.ac
|
||||
am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \
|
||||
$(ACLOCAL_M4)
|
||||
mkinstalldirs = $(install_sh) -d
|
||||
CONFIG_HEADER = $(top_builddir)/config/config.h
|
||||
CONFIG_CLEAN_FILES = reference.doxygen
|
||||
SOURCES =
|
||||
DIST_SOURCES =
|
||||
man3dir = $(mandir)/man3
|
||||
am__installdirs = "$(DESTDIR)$(man3dir)"
|
||||
NROFF = nroff
|
||||
MANS = $(dist_man_MANS) $(man_MANS)
|
||||
DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST)
|
||||
ACLOCAL = @ACLOCAL@
|
||||
AMTAR = @AMTAR@
|
||||
AR = @AR@
|
||||
AUTOCONF = @AUTOCONF@
|
||||
AUTOHEADER = @AUTOHEADER@
|
||||
AUTOMAKE = @AUTOMAKE@
|
||||
AWK = @AWK@
|
||||
CC = @CC@
|
||||
CCDEPMODE = @CCDEPMODE@
|
||||
CFLAGS = @CFLAGS@
|
||||
CPP = @CPP@
|
||||
CPPFLAGS = @CPPFLAGS@
|
||||
CXX = @CXX@
|
||||
CXXCPP = @CXXCPP@
|
||||
CXXDEPMODE = @CXXDEPMODE@
|
||||
CXXFLAGS = @CXXFLAGS@
|
||||
CYGPATH_W = @CYGPATH_W@
|
||||
DEFS = @DEFS@
|
||||
DEPDIR = @DEPDIR@
|
||||
DSYMUTIL = @DSYMUTIL@
|
||||
ECHO = @ECHO@
|
||||
ECHO_C = @ECHO_C@
|
||||
ECHO_N = @ECHO_N@
|
||||
ECHO_T = @ECHO_T@
|
||||
EGREP = @EGREP@
|
||||
EXEEXT = @EXEEXT@
|
||||
F77 = @F77@
|
||||
FFLAGS = @FFLAGS@
|
||||
GREP = @GREP@
|
||||
HAVE_DOXYGEN = @HAVE_DOXYGEN@
|
||||
INSTALL = @INSTALL@
|
||||
INSTALL_DATA = @INSTALL_DATA@
|
||||
INSTALL_PROGRAM = @INSTALL_PROGRAM@
|
||||
INSTALL_SCRIPT = @INSTALL_SCRIPT@
|
||||
INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@
|
||||
JACK_CFLAGS = @JACK_CFLAGS@
|
||||
JACK_LIBS = @JACK_LIBS@
|
||||
LDFLAGS = @LDFLAGS@
|
||||
LIBOBJS = @LIBOBJS@
|
||||
LIBS = @LIBS@
|
||||
LIBTOOL = @LIBTOOL@
|
||||
LN_S = @LN_S@
|
||||
LTLIBOBJS = @LTLIBOBJS@
|
||||
MAKEINFO = @MAKEINFO@
|
||||
MKDIR_P = @MKDIR_P@
|
||||
NMEDIT = @NMEDIT@
|
||||
OBJEXT = @OBJEXT@
|
||||
PACKAGE = @PACKAGE@
|
||||
PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@
|
||||
PACKAGE_NAME = @PACKAGE_NAME@
|
||||
PACKAGE_STRING = @PACKAGE_STRING@
|
||||
PACKAGE_TARNAME = @PACKAGE_TARNAME@
|
||||
PACKAGE_VERSION = @PACKAGE_VERSION@
|
||||
PATH_SEPARATOR = @PATH_SEPARATOR@
|
||||
PKG_CONFIG = @PKG_CONFIG@
|
||||
PYTHON = @PYTHON@
|
||||
PYTHON_CPPFLAGS = @PYTHON_CPPFLAGS@
|
||||
PYTHON_EXTRA_LDFLAGS = @PYTHON_EXTRA_LDFLAGS@
|
||||
PYTHON_EXTRA_LIBS = @PYTHON_EXTRA_LIBS@
|
||||
PYTHON_LDFLAGS = @PYTHON_LDFLAGS@
|
||||
PYTHON_SITE_PKG = @PYTHON_SITE_PKG@
|
||||
PYTHON_VERSION = @PYTHON_VERSION@
|
||||
RANLIB = @RANLIB@
|
||||
REDLAND_CFLAGS = @REDLAND_CFLAGS@
|
||||
REDLAND_LIBS = @REDLAND_LIBS@
|
||||
SED = @SED@
|
||||
SET_MAKE = @SET_MAKE@
|
||||
SHELL = @SHELL@
|
||||
SLV2_API_AGE = @SLV2_API_AGE@
|
||||
SLV2_API_CURRENT = @SLV2_API_CURRENT@
|
||||
SLV2_API_REVISION = @SLV2_API_REVISION@
|
||||
SLV2_CFLAGS = @SLV2_CFLAGS@
|
||||
SLV2_LIBS = @SLV2_LIBS@
|
||||
SLV2_SO_VERSION = @SLV2_SO_VERSION@
|
||||
SLV2_SRCDIR = @SLV2_SRCDIR@
|
||||
SLV2_VERSION = @SLV2_VERSION@
|
||||
STRIP = @STRIP@
|
||||
SWIG = @SWIG@
|
||||
VERSION = @VERSION@
|
||||
abs_builddir = @abs_builddir@
|
||||
abs_srcdir = @abs_srcdir@
|
||||
abs_top_builddir = @abs_top_builddir@
|
||||
abs_top_srcdir = @abs_top_srcdir@
|
||||
ac_ct_CC = @ac_ct_CC@
|
||||
ac_ct_CXX = @ac_ct_CXX@
|
||||
ac_ct_F77 = @ac_ct_F77@
|
||||
am__include = @am__include@
|
||||
am__leading_dot = @am__leading_dot@
|
||||
am__quote = @am__quote@
|
||||
am__tar = @am__tar@
|
||||
am__untar = @am__untar@
|
||||
bindir = @bindir@
|
||||
build = @build@
|
||||
build_alias = @build_alias@
|
||||
build_cpu = @build_cpu@
|
||||
build_os = @build_os@
|
||||
build_vendor = @build_vendor@
|
||||
builddir = @builddir@
|
||||
datadir = @datadir@
|
||||
datarootdir = @datarootdir@
|
||||
docdir = @docdir@
|
||||
dvidir = @dvidir@
|
||||
exec_prefix = @exec_prefix@
|
||||
host = @host@
|
||||
host_alias = @host_alias@
|
||||
host_cpu = @host_cpu@
|
||||
host_os = @host_os@
|
||||
host_vendor = @host_vendor@
|
||||
htmldir = @htmldir@
|
||||
includedir = @includedir@
|
||||
infodir = @infodir@
|
||||
install_sh = @install_sh@
|
||||
libdir = @libdir@
|
||||
libexecdir = @libexecdir@
|
||||
localedir = @localedir@
|
||||
localstatedir = @localstatedir@
|
||||
mandir = @mandir@
|
||||
mkdir_p = @mkdir_p@
|
||||
oldincludedir = @oldincludedir@
|
||||
pdfdir = @pdfdir@
|
||||
prefix = @prefix@
|
||||
program_transform_name = @program_transform_name@
|
||||
psdir = @psdir@
|
||||
sbindir = @sbindir@
|
||||
sharedstatedir = @sharedstatedir@
|
||||
srcdir = @srcdir@
|
||||
sysconfdir = @sysconfdir@
|
||||
target_alias = @target_alias@
|
||||
top_build_prefix = @top_build_prefix@
|
||||
top_builddir = @top_builddir@
|
||||
top_srcdir = @top_srcdir@
|
||||
dist_man_MANS = \
|
||||
man/man3/slv2.3 \
|
||||
man/man3/slv2_collections.3 \
|
||||
man/man3/slv2_data.3 \
|
||||
man/man3/slv2_library.3 \
|
||||
man/man3/slv2_util.3 \
|
||||
man/man3/slv2_world.3
|
||||
|
||||
@HAVE_DOXYGEN_TRUE@man_MANS = $(dist_man_MANS)
|
||||
@HAVE_DOXYGEN_FALSE@man_mans =
|
||||
EXTRA_DIST = mainpage.dox reference.doxygen.in $(man_MANS)
|
||||
all: all-am
|
||||
|
||||
.SUFFIXES:
|
||||
$(srcdir)/Makefile.in: $(srcdir)/Makefile.am $(am__configure_deps)
|
||||
@for dep in $?; do \
|
||||
case '$(am__configure_deps)' in \
|
||||
*$$dep*) \
|
||||
( cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh ) \
|
||||
&& { if test -f $@; then exit 0; else break; fi; }; \
|
||||
exit 1;; \
|
||||
esac; \
|
||||
done; \
|
||||
echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu doc/Makefile'; \
|
||||
cd $(top_srcdir) && \
|
||||
$(AUTOMAKE) --gnu doc/Makefile
|
||||
.PRECIOUS: Makefile
|
||||
Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status
|
||||
@case '$?' in \
|
||||
*config.status*) \
|
||||
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \
|
||||
*) \
|
||||
echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \
|
||||
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \
|
||||
esac;
|
||||
|
||||
$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES)
|
||||
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
|
||||
|
||||
$(top_srcdir)/configure: $(am__configure_deps)
|
||||
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
|
||||
$(ACLOCAL_M4): $(am__aclocal_m4_deps)
|
||||
cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh
|
||||
reference.doxygen: $(top_builddir)/config.status $(srcdir)/reference.doxygen.in
|
||||
cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@
|
||||
|
||||
mostlyclean-libtool:
|
||||
-rm -f *.lo
|
||||
|
||||
clean-libtool:
|
||||
-rm -rf .libs _libs
|
||||
install-man3: $(man3_MANS) $(man_MANS)
|
||||
@$(NORMAL_INSTALL)
|
||||
test -z "$(man3dir)" || $(MKDIR_P) "$(DESTDIR)$(man3dir)"
|
||||
@list='$(man3_MANS) $(dist_man3_MANS) $(nodist_man3_MANS)'; \
|
||||
l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
|
||||
for i in $$l2; do \
|
||||
case "$$i" in \
|
||||
*.3*) list="$$list $$i" ;; \
|
||||
esac; \
|
||||
done; \
|
||||
for i in $$list; do \
|
||||
if test -f $$i; then file=$$i; \
|
||||
else file=$(srcdir)/$$i; fi; \
|
||||
ext=`echo $$i | sed -e 's/^.*\\.//'`; \
|
||||
case "$$ext" in \
|
||||
3*) ;; \
|
||||
*) ext='3' ;; \
|
||||
esac; \
|
||||
inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
|
||||
inst=`echo $$inst | sed -e 's/^.*\///'`; \
|
||||
inst=`echo $$inst | sed '$(transform)'`.$$ext; \
|
||||
echo " $(INSTALL_DATA) '$$file' '$(DESTDIR)$(man3dir)/$$inst'"; \
|
||||
$(INSTALL_DATA) "$$file" "$(DESTDIR)$(man3dir)/$$inst"; \
|
||||
done
|
||||
uninstall-man3:
|
||||
@$(NORMAL_UNINSTALL)
|
||||
@list='$(man3_MANS) $(dist_man3_MANS) $(nodist_man3_MANS)'; \
|
||||
l2='$(man_MANS) $(dist_man_MANS) $(nodist_man_MANS)'; \
|
||||
for i in $$l2; do \
|
||||
case "$$i" in \
|
||||
*.3*) list="$$list $$i" ;; \
|
||||
esac; \
|
||||
done; \
|
||||
for i in $$list; do \
|
||||
ext=`echo $$i | sed -e 's/^.*\\.//'`; \
|
||||
case "$$ext" in \
|
||||
3*) ;; \
|
||||
*) ext='3' ;; \
|
||||
esac; \
|
||||
inst=`echo $$i | sed -e 's/\\.[0-9a-z]*$$//'`; \
|
||||
inst=`echo $$inst | sed -e 's/^.*\///'`; \
|
||||
inst=`echo $$inst | sed '$(transform)'`.$$ext; \
|
||||
echo " rm -f '$(DESTDIR)$(man3dir)/$$inst'"; \
|
||||
rm -f "$(DESTDIR)$(man3dir)/$$inst"; \
|
||||
done
|
||||
tags: TAGS
|
||||
TAGS:
|
||||
|
||||
ctags: CTAGS
|
||||
CTAGS:
|
||||
|
||||
|
||||
distdir: $(DISTFILES)
|
||||
@srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
|
||||
topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \
|
||||
list='$(DISTFILES)'; \
|
||||
dist_files=`for file in $$list; do echo $$file; done | \
|
||||
sed -e "s|^$$srcdirstrip/||;t" \
|
||||
-e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \
|
||||
case $$dist_files in \
|
||||
*/*) $(MKDIR_P) `echo "$$dist_files" | \
|
||||
sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \
|
||||
sort -u` ;; \
|
||||
esac; \
|
||||
for file in $$dist_files; do \
|
||||
if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \
|
||||
if test -d $$d/$$file; then \
|
||||
dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \
|
||||
if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \
|
||||
cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \
|
||||
fi; \
|
||||
cp -pR $$d/$$file $(distdir)$$dir || exit 1; \
|
||||
else \
|
||||
test -f $(distdir)/$$file \
|
||||
|| cp -p $$d/$$file $(distdir)/$$file \
|
||||
|| exit 1; \
|
||||
fi; \
|
||||
done
|
||||
check-am: all-am
|
||||
check: check-am
|
||||
all-am: Makefile $(MANS)
|
||||
installdirs:
|
||||
for dir in "$(DESTDIR)$(man3dir)"; do \
|
||||
test -z "$$dir" || $(MKDIR_P) "$$dir"; \
|
||||
done
|
||||
install: install-am
|
||||
install-exec: install-exec-am
|
||||
uninstall: uninstall-am
|
||||
|
||||
install-am: all-am
|
||||
@$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am
|
||||
|
||||
installcheck: installcheck-am
|
||||
install-strip:
|
||||
$(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \
|
||||
install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \
|
||||
`test -z '$(STRIP)' || \
|
||||
echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install
|
||||
mostlyclean-generic:
|
||||
|
||||
clean-generic:
|
||||
|
||||
distclean-generic:
|
||||
-test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES)
|
||||
|
||||
maintainer-clean-generic:
|
||||
@echo "This command is intended for maintainers to use"
|
||||
@echo "it deletes files that may require special tools to rebuild."
|
||||
clean: clean-am
|
||||
|
||||
clean-am: clean-generic clean-libtool mostlyclean-am
|
||||
|
||||
distclean: distclean-am
|
||||
-rm -f Makefile
|
||||
distclean-am: clean-am distclean-generic distclean-local
|
||||
|
||||
dvi: dvi-am
|
||||
|
||||
dvi-am:
|
||||
|
||||
html: html-am
|
||||
|
||||
info: info-am
|
||||
|
||||
info-am:
|
||||
|
||||
install-data-am: install-man
|
||||
|
||||
install-dvi: install-dvi-am
|
||||
|
||||
install-exec-am:
|
||||
|
||||
install-html: install-html-am
|
||||
|
||||
install-info: install-info-am
|
||||
|
||||
install-man: install-man3
|
||||
|
||||
install-pdf: install-pdf-am
|
||||
|
||||
install-ps: install-ps-am
|
||||
|
||||
installcheck-am:
|
||||
|
||||
maintainer-clean: maintainer-clean-am
|
||||
-rm -f Makefile
|
||||
maintainer-clean-am: distclean-am maintainer-clean-generic
|
||||
|
||||
mostlyclean: mostlyclean-am
|
||||
|
||||
mostlyclean-am: mostlyclean-generic mostlyclean-libtool
|
||||
|
||||
pdf: pdf-am
|
||||
|
||||
pdf-am:
|
||||
|
||||
ps: ps-am
|
||||
|
||||
ps-am:
|
||||
|
||||
uninstall-am: uninstall-man
|
||||
|
||||
uninstall-man: uninstall-man3
|
||||
|
||||
.MAKE: install-am install-strip
|
||||
|
||||
.PHONY: all all-am check check-am clean clean-generic clean-libtool \
|
||||
distclean distclean-generic distclean-libtool distclean-local \
|
||||
distdir dvi dvi-am html html-am info info-am install \
|
||||
install-am install-data install-data-am install-dvi \
|
||||
install-dvi-am install-exec install-exec-am install-html \
|
||||
install-html-am install-info install-info-am install-man \
|
||||
install-man3 install-pdf install-pdf-am install-ps \
|
||||
install-ps-am install-strip installcheck installcheck-am \
|
||||
installdirs maintainer-clean maintainer-clean-generic \
|
||||
mostlyclean mostlyclean-generic mostlyclean-libtool pdf pdf-am \
|
||||
ps ps-am uninstall uninstall-am uninstall-man uninstall-man3
|
||||
|
||||
@HAVE_DOXYGEN_TRUE@all: docs
|
||||
@HAVE_DOXYGEN_FALSE@all:
|
||||
|
||||
%.3:
|
||||
make docs
|
||||
|
||||
reference.doxygen: @SLV2_SRCDIR@/doc/reference.doxygen.in
|
||||
|
||||
distclean-local:
|
||||
rm -rf man html
|
||||
|
||||
docs: reference.doxygen @SLV2_SRCDIR@/slv2/*.h
|
||||
doxygen reference.doxygen
|
||||
|
||||
# Don't install man pages with this target,
|
||||
# only install with install-man (for debian package building)
|
||||
install-data:
|
||||
# Tell versions [3.59,3.63) of GNU make to not export all variables.
|
||||
# Otherwise a system limit (for SysV at least) may be exceeded.
|
||||
.NOEXPORT:
|
||||
60
lib-src/slv2/doc/mainpage.dox
Normal file
60
lib-src/slv2/doc/mainpage.dox
Normal file
@@ -0,0 +1,60 @@
|
||||
/* This duplication sucks :( */
|
||||
|
||||
/* HTML */
|
||||
|
||||
/** @mainpage
|
||||
* @section Overview
|
||||
*
|
||||
* SLV2 is a host library to simplify the discovery, loading, and use of LV2
|
||||
* plugins (http://lv2plug.in).
|
||||
*
|
||||
* SLV2 is written in standard C99, and depends only on the Redland RDF library
|
||||
* (http://librdf.org). It should be portable to any system with Redland, and
|
||||
* is tested on various GNU/Linux distributions (often), and MacOS X (occasionally).
|
||||
*
|
||||
* The Data (RDF) and code (shared library) functionality in SLV2 is strictly
|
||||
* separated so it is simple to control where each is used (e.g. it is
|
||||
* possible to discover/investigate plugins and related data without loading
|
||||
* any shared libraries, avoiding the associated risks).
|
||||
*
|
||||
* The SLV2 documentation is broken into several pages:
|
||||
*
|
||||
* \li \link slv2_world slv2_world \endlink - Global library initialisation, state, plugin discovery, etc.
|
||||
*
|
||||
* \li \link slv2_util slv2_util \endlink - Generally useful utility functions
|
||||
*
|
||||
* \li \link slv2_collections slv2_collections \endlink - Collections of values (literals and URIs) and objects
|
||||
*
|
||||
* \li \link slv2_data slv2_data \endlink - Access to plugin RDF data
|
||||
*
|
||||
* \li \link slv2_library slv2_library \endlink - Access to plugin shared libraries
|
||||
*/
|
||||
|
||||
|
||||
/* man page */
|
||||
|
||||
/** @defgroup slv2 SLV2
|
||||
* SLV2 is a host library to simplify the discovery, loading, and use of LV2
|
||||
* plugins (http://lv2plug.in).
|
||||
*
|
||||
* SLV2 is written in standard C99, and depends only on the Redland RDF library
|
||||
* (http://librdf.org). It should be portable to any system with Redland, and
|
||||
* is tested on various GNU/Linux distributions (often), and MacOS X (occasionally).
|
||||
*
|
||||
* The Data (RDF) and code (shared library) functionality in SLV2 is strictly
|
||||
* separated so it is simple to control where each is used (e.g. it is
|
||||
* possible to discover/investigate plugins and related data without loading
|
||||
* any shared libraries, avoiding the associated risks).
|
||||
*
|
||||
* The SLV2 documentation is broken into several pages:
|
||||
*
|
||||
* \li \link slv2_world slv2_world \endlink - Global library initialisation, state, plugin discovery, etc.
|
||||
*
|
||||
* \li \link slv2_util slv2_util \endlink - Generally useful utility functions
|
||||
*
|
||||
* \li \link slv2_collections slv2_collections \endlink - Collections of values (literals and URIs) and objects
|
||||
*
|
||||
* \li \link slv2_data slv2_data \endlink - Access to plugin RDF data
|
||||
*
|
||||
* \li \link slv2_library slv2_library \endlink - Access to plugin shared libraries
|
||||
*/
|
||||
34
lib-src/slv2/doc/man/man3/slv2.3
Normal file
34
lib-src/slv2/doc/man/man3/slv2.3
Normal file
@@ -0,0 +1,34 @@
|
||||
.TH "SLV2" 3 "6 Jul 2008" "Version 0.6.0" "SLV2" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
SLV2 \- SLV2 is a host library to simplify the discovery, loading, and use of LV2 plugins (http://lv2plug.in).
|
||||
|
||||
.PP
|
||||
SLV2 is written in standard C99, and depends only on the Redland RDF library (http://librdf.org). It should be portable to any system with Redland, and is tested on various GNU/Linux distributions (often), and MacOS X (occasionally).
|
||||
.PP
|
||||
The Data (RDF) and code (shared library) functionality in SLV2 is strictly separated so it is simple to control where each is used (e.g. it is possible to discover/investigate plugins and related data without loading any shared libraries, avoiding the associated risks).
|
||||
.PP
|
||||
The SLV2 documentation is broken into several pages:
|
||||
.PP
|
||||
.PD 0
|
||||
.IP "\(bu" 2
|
||||
\fBslv2_world \fP - Global library initialisation, state, plugin discovery, etc.
|
||||
.PP
|
||||
.PD 0
|
||||
.IP "\(bu" 2
|
||||
\fBslv2_util \fP - Generally useful utility functions
|
||||
.PP
|
||||
.PD 0
|
||||
.IP "\(bu" 2
|
||||
\fBslv2_collections \fP - Collections of values (literals and URIs) and objects
|
||||
.PP
|
||||
.PD 0
|
||||
.IP "\(bu" 2
|
||||
\fBslv2_data \fP - Access to plugin RDF data
|
||||
.PP
|
||||
.PD 0
|
||||
.IP "\(bu" 2
|
||||
\fBslv2_library \fP - Access to plugin shared libraries
|
||||
.PP
|
||||
|
||||
179
lib-src/slv2/doc/man/man3/slv2_collections.3
Normal file
179
lib-src/slv2/doc/man/man3/slv2_collections.3
Normal file
@@ -0,0 +1,179 @@
|
||||
.TH "Collections of values/objects" 3 "6 Jul 2008" "Version 0.6.0" "SLV2" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
Collections of values/objects \- Ordered collections of typed values which are fast for random access by index (i.e.
|
||||
|
||||
.PP
|
||||
.SS "Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "SLV2PluginClass \fBslv2_plugin_classes_get_by_uri\fP (SLV2PluginClasses classes, SLV2Value uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2PluginClass \fBslv2_plugin_classes_get_at\fP (SLV2PluginClasses classes, unsigned index)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_plugins_free\fP (SLV2World world, SLV2Plugins plugins)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Plugin \fBslv2_plugins_get_by_uri\fP (SLV2Plugins plugins, SLV2Value uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Plugin \fBslv2_plugins_get_at\fP (SLV2Plugins plugins, unsigned index)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_uis_free\fP (SLV2UIs list)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2UI \fBslv2_uis_get_by_uri\fP (SLV2UIs list, SLV2Value uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2UI \fBslv2_uis_get_at\fP (SLV2UIs list, unsigned index)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_values_get_at\fP (SLV2Values values, unsigned index)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_values_contains\fP (SLV2Values values, SLV2Value value)"
|
||||
.br
|
||||
.in -1c
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
a fancy array).
|
||||
.SH "Function Documentation"
|
||||
.PP
|
||||
.SS "unsigned slv2_plugin_classes_size (SLV2PluginClasses classes)"
|
||||
.PP
|
||||
Get the number of plugins in the collection.
|
||||
.PP
|
||||
.SS "SLV2PluginClass slv2_plugin_classes_get_by_uri (SLV2PluginClasses classes, SLV2Value uri)"
|
||||
.PP
|
||||
Get a plugin class from the collection by URI.
|
||||
.PP
|
||||
Return value is shared (stored in \fIclasses\fP) and must not be freed or modified by the caller in any way.
|
||||
.PP
|
||||
Time = O(log2(n))
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if plugin with \fIurl\fP not found in \fIclasses\fP.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "SLV2PluginClass slv2_plugin_classes_get_at (SLV2PluginClasses classes, unsigned index)"
|
||||
.PP
|
||||
Get a plugin from the collection by index.
|
||||
.PP
|
||||
\fIindex\fP has no significance other than as an index into \fIclasses\fP. Any \fIindex\fP not less than slv2_plugin_classes_get_length(classes) will return NULL, so all plugin_classes in a classes can be enumerated by repeated calls to this function starting with \fIindex\fP = 0.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if \fIindex\fP out of range.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "void slv2_plugins_free (SLV2World world, SLV2Plugins plugins)"
|
||||
.PP
|
||||
Free a plugin plugins.
|
||||
.PP
|
||||
Freeing a plugin collection does not destroy the plugins it contains (plugins are owned by the world). \fIplugins\fP is invalid after this call.
|
||||
.SS "unsigned slv2_plugins_size (SLV2Plugins plugins)"
|
||||
.PP
|
||||
Get the number of plugins in the collection.
|
||||
.PP
|
||||
.SS "SLV2Plugin slv2_plugins_get_by_uri (SLV2Plugins plugins, SLV2Value uri)"
|
||||
.PP
|
||||
Get a plugin from the collection by URI.
|
||||
.PP
|
||||
Return value is shared (stored in \fIplugins\fP) and must not be freed or modified by the caller in any way.
|
||||
.PP
|
||||
Time = O(log2(n))
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if plugin with \fIurl\fP not found in \fIplugins\fP.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "SLV2Plugin slv2_plugins_get_at (SLV2Plugins plugins, unsigned index)"
|
||||
.PP
|
||||
Get a plugin from the plugins by index.
|
||||
.PP
|
||||
\fIindex\fP has no significance other than as an index into this plugins. Any \fIindex\fP not less than slv2_plugins_get_length(plugins) will return NULL, so all plugins in a plugins can be enumerated by repeated calls to this function starting with \fIindex\fP = 0.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if \fIindex\fP out of range.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "void slv2_uis_free (SLV2UIs list)"
|
||||
.PP
|
||||
Free a plugin list.
|
||||
.PP
|
||||
Freeing a plugin list does not destroy the plugins it contains (plugins are owned by the world). \fIlist\fP is invalid after this call.
|
||||
.SS "unsigned slv2_uis_size (SLV2UIs list)"
|
||||
.PP
|
||||
Get the number of plugins in the list.
|
||||
.PP
|
||||
.SS "SLV2UI slv2_uis_get_by_uri (SLV2UIs list, SLV2Value uri)"
|
||||
.PP
|
||||
Get a plugin from the list by URI.
|
||||
.PP
|
||||
Return value is shared (stored in \fIlist\fP) and must not be freed or modified by the caller in any way.
|
||||
.PP
|
||||
Time = O(log2(n))
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if plugin with \fIurl\fP not found in \fIlist\fP.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "SLV2UI slv2_uis_get_at (SLV2UIs list, unsigned index)"
|
||||
.PP
|
||||
Get a plugin from the list by index.
|
||||
.PP
|
||||
\fIindex\fP has no significance other than as an index into this list. Any \fIindex\fP not less than slv2_list_get_length(list) will return NULL, so all plugins in a list can be enumerated by repeated calls to this function starting with \fIindex\fP = 0.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if \fIindex\fP out of range.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "SLV2Values slv2_values_new ()"
|
||||
.PP
|
||||
Allocate a new, empty SLV2Values.
|
||||
.PP
|
||||
.SS "void slv2_values_free (SLV2Values)"
|
||||
.PP
|
||||
Free an SLV2Values.
|
||||
.PP
|
||||
.SS "unsigned slv2_values_size (SLV2Values values)"
|
||||
.PP
|
||||
Get the number of elements in a value collection.
|
||||
.PP
|
||||
.SS "SLV2Value slv2_values_get_at (SLV2Values values, unsigned index)"
|
||||
.PP
|
||||
Get the value at a given index in the collection.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
the element at \fIindex\fP, or NULL if index is out of range.
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_values_contains (SLV2Values values, SLV2Value value)"
|
||||
.PP
|
||||
Return whether \fIvalues\fP contains \fIvalue\fP.
|
||||
.PP
|
||||
Time = O(n)
|
||||
686
lib-src/slv2/doc/man/man3/slv2_data.3
Normal file
686
lib-src/slv2/doc/man/man3/slv2_data.3
Normal file
@@ -0,0 +1,686 @@
|
||||
.TH "Plugin data access" 3 "6 Jul 2008" "Version 0.6.0" "SLV2" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
Plugin data access \- These functions work exclusively with the plugin's RDF data, they do not access the plugin's shared library in any way.
|
||||
|
||||
.PP
|
||||
.SS "Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_plugin_verify\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_uri\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_bundle_uri\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_data_uris\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_library_uri\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_name\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_value\fP (SLV2Plugin p, SLV2Value predicate)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_value_by_qname\fP (SLV2Plugin p, const char *predicate)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_value_for_subject\fP (SLV2Plugin p, SLV2Value subject_uri, SLV2Value predicate_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_plugin_has_feature\fP (SLV2Plugin p, SLV2Value feature_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_supported_features\fP (SLV2Plugin p)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_required_features\fP (SLV2Plugin p)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_get_optional_features\fP (SLV2Plugin p)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "uint32_t \fBslv2_plugin_get_num_ports\fP (SLV2Plugin p)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_plugin_get_port_ranges_float\fP (SLV2Plugin p, float *min_values, float *max_values, float *def_values)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "uint32_t \fBslv2_plugin_get_num_ports_of_class\fP (SLV2Plugin p, SLV2Value class_1,...)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_plugin_has_latency\fP (SLV2Plugin p)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "uint32_t \fBslv2_plugin_get_latency_port_index\fP (SLV2Plugin p)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_plugin_query_variable\fP (SLV2Plugin plugin, const char *sparql_str, unsigned variable)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "unsigned \fBslv2_plugin_query_count\fP (SLV2Plugin plugin, const char *sparql_str)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Port \fBslv2_plugin_get_port_by_index\fP (SLV2Plugin plugin, uint32_t index)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Port \fBslv2_plugin_get_port_by_symbol\fP (SLV2Plugin plugin, SLV2Value symbol)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2UIs \fBslv2_plugin_get_uis\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_author_name\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_author_email\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_get_author_homepage\fP (SLV2Plugin plugin)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_class_get_parent_uri\fP (SLV2PluginClass plugin_class)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_class_get_uri\fP (SLV2PluginClass plugin_class)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_plugin_class_get_label\fP (SLV2PluginClass plugin_class)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2PluginClasses \fBslv2_plugin_class_get_children\fP (SLV2PluginClass plugin_class)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_ui_get_uri\fP (SLV2UI ui)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_ui_get_classes\fP (SLV2UI ui)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_ui_is_a\fP (SLV2UI ui, SLV2Value class_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_ui_get_bundle_uri\fP (SLV2UI ui)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_ui_get_binary_uri\fP (SLV2UI ui)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_port_get_value_by_qname\fP (SLV2Plugin plugin, SLV2Port port, const char *property_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_port_get_properties\fP (SLV2Plugin plugin, SLV2Port port)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_port_has_property\fP (SLV2Plugin p, SLV2Port port, SLV2Value property_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_port_supports_event\fP (SLV2Plugin p, SLV2Port port, SLV2Value event_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_port_get_symbol\fP (SLV2Plugin plugin, SLV2Port port)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_port_get_name\fP (SLV2Plugin plugin, SLV2Port port)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Values \fBslv2_port_get_classes\fP (SLV2Plugin plugin, SLV2Port port)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_port_is_a\fP (SLV2Plugin plugin, SLV2Port port, SLV2Value port_class)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_port_get_range\fP (SLV2Plugin plugin, SLV2Port port, SLV2Value *def, SLV2Value *min, SLV2Value *max)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2ScalePoints \fBslv2_port_get_scale_points\fP (SLV2Plugin plugin, SLV2Port port)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Value \fBslv2_value_new_uri\fP (SLV2World world, const char *uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "char * \fBslv2_value_get_turtle_token\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_value_is_uri\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "const char * \fBslv2_value_as_uri\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_value_is_literal\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_value_is_string\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "const char * \fBslv2_value_as_string\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_value_is_float\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "float \fBslv2_value_as_float\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "bool \fBslv2_value_is_int\fP (SLV2Value value)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "int \fBslv2_value_as_int\fP (SLV2Value value)"
|
||||
.br
|
||||
.in -1c
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
An SLV2Plugin contains an in-memory cache of the plugin data, loaded on demand. Duplicating plugins should be avoided when possible for performance reasons.
|
||||
.SH "Function Documentation"
|
||||
.PP
|
||||
.SS "bool slv2_plugin_verify (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Check if this plugin is valid.
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
Note that normal hosts do NOT need to use this - slv2 does not load invalid plugins into plugin lists. This is included for plugin testing utilities, etc.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
true if \fIplugin\fP is valid.
|
||||
.RE
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_plugin_get_uri (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the URI of \fIplugin\fP.
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
a shared string which must not be modified or free()'d.
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_plugin_get_bundle_uri (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the (resolvable) URI of the plugins 'main' bundle.
|
||||
.PP
|
||||
This returns the URI of the bundle where the plugin itself was found. Note that the data for a plugin may be spread over many bundles, that is, slv2_plugin_get_data_uris may returns URIs which are not below this one.
|
||||
.PP
|
||||
Typical hosts should not need to use this function.
|
||||
.PP
|
||||
Note this always returns a fully qualified URI. If you want a local filesystem path, use slv2_uri_to_path.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
a shared string which must not be modified or freed.
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Values slv2_plugin_get_data_uris (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the (resolvable) URIs of the RDF data files that define a plugin.
|
||||
.PP
|
||||
Typical hosts should not need to use this function.
|
||||
.PP
|
||||
Note this always returns fully qualified URIs. If you want local filesystem paths, use slv2_uri_to_path.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
a list of complete URLs eg. 'file:///foo/ABundle.lv2/aplug.ttl', which is shared and must not be modified or freed.
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_plugin_get_library_uri (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the (resolvable) URI of the shared library for \fIplugin\fP.
|
||||
.PP
|
||||
Note this always returns a fully qualified URI. If you want a local filesystem path, use slv2_uri_to_path.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
a shared string which must not be modified or freed.
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_plugin_get_name (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the name of \fIplugin\fP.
|
||||
.PP
|
||||
This is guaranteed to return the untranslated name (the doap:name in the data file without a language tag). Returned value must be freed by the caller.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2PluginClass slv2_plugin_get_class (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the class this plugin belongs to (ie Filters).
|
||||
.PP
|
||||
.SS "SLV2Values slv2_plugin_get_value (SLV2Plugin p, SLV2Value predicate)"
|
||||
.PP
|
||||
Get a value associated with the plugin in a plugin's data files.
|
||||
.PP
|
||||
Returns the ?object of all triples found of the form:
|
||||
.PP
|
||||
\fC<plugin-uri> predicate ?object\fP
|
||||
.PP
|
||||
May return NULL if the property was not found, or if object(s) is not sensibly represented as an SLV2Values (e.g. blank nodes).
|
||||
.PP
|
||||
Return value must be freed by caller with slv2_values_free.
|
||||
.PP
|
||||
\fIpredicate\fP must be either a URI or a QName. See SLV2URIType documentation for examples.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_plugin_get_value_by_qname (SLV2Plugin p, const char * predicate)"
|
||||
.PP
|
||||
Get a value associated with the plugin in a plugin's data files.
|
||||
.PP
|
||||
This function is identical to slv2_plugin_get_value, but takes a QName string parameter for a predicate instead of an SLV2Value, which may be more convenient.
|
||||
.SS "SLV2Values slv2_plugin_get_value_for_subject (SLV2Plugin p, SLV2Value subject_uri, SLV2Value predicate_uri)"
|
||||
.PP
|
||||
Get a value associated with some subject in a plugin's data files.
|
||||
.PP
|
||||
Returns the ?object of all triples found of the form:
|
||||
.PP
|
||||
\fCsubject predicate ?object\fP
|
||||
.PP
|
||||
This can be used to investigate URIs returned by slv2_plugin_get_value (if information about it is contained in the plugin's data files).
|
||||
.PP
|
||||
May return NULL if the property was not found, or if object is not sensibly represented as an SLV2Values (e.g. blank nodes).
|
||||
.PP
|
||||
\fIpredicate\fP must be either a URI or a QName. See SLV2URIType documentation for examples.
|
||||
.PP
|
||||
Return value must be freed by caller with slv2_values_free.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "bool slv2_plugin_has_feature (SLV2Plugin p, SLV2Value feature_uri)"
|
||||
.PP
|
||||
Return whether a feature is supported by a plugin.
|
||||
.PP
|
||||
This will return true if the feature is an optional or required feature of the plugin.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_plugin_get_supported_features (SLV2Plugin p)"
|
||||
.PP
|
||||
Get the LV2 Features supported (required or optionally) by a plugin.
|
||||
.PP
|
||||
A feature is 'supported' by a plugin if it is required OR optional.
|
||||
.PP
|
||||
Since required features have special rules the host must obey, this function probably shouldn't be used by normal hosts. Using slv2_plugin_get_optional_features and slv2_plugin_get_required_features separately is best in most cases.
|
||||
.PP
|
||||
Returned value must be freed by caller with slv2_values_free.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_plugin_get_required_features (SLV2Plugin p)"
|
||||
.PP
|
||||
Get the LV2 Features required by a plugin.
|
||||
.PP
|
||||
If a feature is required by a plugin, hosts MUST NOT use the plugin if they do not understand (or are unable to support) that feature.
|
||||
.PP
|
||||
All values returned here MUST be passed to the plugin's instantiate method (along with data, if necessary, as defined by the feature specification) or plugin instantiation will fail.
|
||||
.PP
|
||||
Return value must be freed by caller with slv2_values_free.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_plugin_get_optional_features (SLV2Plugin p)"
|
||||
.PP
|
||||
Get the LV2 Features optionally supported by a plugin.
|
||||
.PP
|
||||
Hosts MAY ignore optional plugin features for whatever reasons. Plugins MUST operate (at least somewhat) if they are instantiated without being passed optional features.
|
||||
.PP
|
||||
Return value must be freed by caller with slv2_values_free.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "uint32_t slv2_plugin_get_num_ports (SLV2Plugin p)"
|
||||
.PP
|
||||
Get the number of ports on this plugin.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "void slv2_plugin_get_port_ranges_float (SLV2Plugin p, float * min_values, float * max_values, float * def_values)"
|
||||
.PP
|
||||
Get the port ranges (minimum, maximum and default values) for all ports.
|
||||
.PP
|
||||
\fImin_values\fP, \fImax_values\fP and \fIdef_values\fP must either point to an array of N floats, where N is the value returned by \fBslv2_plugin_get_num_ports()\fP for this plugin, or NULL. The elements of the array will be set to the the minimum, maximum and default values of the ports on this plugin, with array index corresponding to port index. If a port doesn't have a minimum, maximum or default value, or the port's type is not float, the corresponding array element will be set to NAN.
|
||||
.PP
|
||||
This is a convenience method for the common case of getting the range of all float ports on a plugin, and may be significantly faster than repeated calls to slv2_port_get_range.
|
||||
.SS "uint32_t slv2_plugin_get_num_ports_of_class (SLV2Plugin p, SLV2Value class_1, ...)"
|
||||
.PP
|
||||
Get the number of ports on this plugin that are members of some class(es).
|
||||
.PP
|
||||
Note that this is a varargs function so ports fitting any type 'profile' desired can be found quickly. REMEMBER TO TERMINATE THE PARAMETER LIST OF THIS FUNCTION WITH NULL OR VERY NASTY THINGS WILL HAPPEN.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_plugin_has_latency (SLV2Plugin p)"
|
||||
.PP
|
||||
Return whether or not the plugin introduces (and reports) latency.
|
||||
.PP
|
||||
The index of the latency port can be found with slv2_plugin_get_latency_port ONLY if this function returns true.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "uint32_t slv2_plugin_get_latency_port_index (SLV2Plugin p)"
|
||||
.PP
|
||||
Return the index of the plugin's latency port.
|
||||
.PP
|
||||
It is a fatal error to call this on a plugin without checking if the port exists by first calling slv2_plugin_has_latency.
|
||||
.PP
|
||||
Any plugin that introduces unwanted latency that should be compensated for (by hosts with the ability/need) MUST provide this port, which is a control rate output port that reports the latency for each cycle in frames.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_plugin_query_variable (SLV2Plugin plugin, const char * sparql_str, unsigned variable)"
|
||||
.PP
|
||||
Query a plugin for a single variable (i.e.
|
||||
.PP
|
||||
SELECT a single ?value).
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIplugin\fP The plugin to query.
|
||||
.br
|
||||
\fIsparql_str\fP A SPARQL SELECT query.
|
||||
.br
|
||||
\fIvariable\fP The index of the variable to return results for (e.g. with '<code>SELECT ?foo ?bar</code>' foo=0, bar=1).
|
||||
.RE
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
All matches for \fIvariable\fP.
|
||||
.RE
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "unsigned slv2_plugin_query_count (SLV2Plugin plugin, const char * sparql_str)"
|
||||
.PP
|
||||
Query a plugin and return the number of results found.
|
||||
.PP
|
||||
Note that this function will work, but is mostly meaningless for queries that are not SELECT DISTINCT.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIplugin\fP The plugin to query.
|
||||
.br
|
||||
\fIsparql_str\fP A SPARQL SELECT DISTINCT query.
|
||||
.RE
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Port slv2_plugin_get_port_by_index (SLV2Plugin plugin, uint32_t index)"
|
||||
.PP
|
||||
Get a port on this plugin by \fIindex\fP.
|
||||
.PP
|
||||
To perform multiple calls on a port, the returned value should be cached and used repeatedly.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Port slv2_plugin_get_port_by_symbol (SLV2Plugin plugin, SLV2Value symbol)"
|
||||
.PP
|
||||
Get a port on this plugin by \fIsymbol\fP.
|
||||
.PP
|
||||
To perform multiple calls on a port, the returned value should be cached and used repeatedly. Note this function is slower than slv2_plugin_get_port_by_index, especially on plugins with a very large number of ports.
|
||||
.PP
|
||||
Time = O(n)
|
||||
.SS "SLV2UIs slv2_plugin_get_uis (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get a list of all UIs available for this plugin.
|
||||
.PP
|
||||
Note this returns the URI of the UI, and not the path/URI to its shared library, use slv2_ui_get_library_uri with the values returned here for that.
|
||||
.PP
|
||||
Returned value must be freed by caller using slv2_uis_free.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIplugin\fP The plugin to get the UIs for.
|
||||
.RE
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_plugin_get_author_name (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the full name of the plugin's author.
|
||||
.PP
|
||||
Returns NULL if author name is not present. Returned value must be freed by caller.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_plugin_get_author_email (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the email address of the plugin's author.
|
||||
.PP
|
||||
Returns NULL if author email address is not present. Returned value must be freed by caller.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_plugin_get_author_homepage (SLV2Plugin plugin)"
|
||||
.PP
|
||||
Get the email address of the plugin's author.
|
||||
.PP
|
||||
Returns NULL if author homepage is not present. Returned value must be freed by caller.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_plugin_class_get_parent_uri (SLV2PluginClass plugin_class)"
|
||||
.PP
|
||||
Get the URI of this class' superclass.
|
||||
.PP
|
||||
Returned value is owned by \fIplugin_class\fP and must not be freed by caller. Returned value may be NULL, if class has no parent.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_plugin_class_get_uri (SLV2PluginClass plugin_class)"
|
||||
.PP
|
||||
Get the URI of this plugin class.
|
||||
.PP
|
||||
Returned value is owned by \fIplugin_class\fP and must not be freed by caller.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_plugin_class_get_label (SLV2PluginClass plugin_class)"
|
||||
.PP
|
||||
Get the label of this plugin class, ie 'Oscillators'.
|
||||
.PP
|
||||
Returned value is owned by \fIplugin_class\fP and must not be freed by caller.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2PluginClasses slv2_plugin_class_get_children (SLV2PluginClass plugin_class)"
|
||||
.PP
|
||||
Get the subclasses of this plugin class.
|
||||
.PP
|
||||
Returned value must be freed by caller with slv2_plugin_classes_free.
|
||||
.PP
|
||||
Time = O(nclasses)
|
||||
.SS "SLV2Value slv2_ui_get_uri (SLV2UI ui)"
|
||||
.PP
|
||||
Get the URI of a Plugin UI.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIui\fP The Plugin UI
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Values slv2_ui_get_classes (SLV2UI ui)"
|
||||
.PP
|
||||
Get the types (URIs of RDF classes) of a Plugin UI.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIui\fP The Plugin UI
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_ui_is_a (SLV2UI ui, SLV2Value class_uri)"
|
||||
.PP
|
||||
Check whether a plugin UI is a given type.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIui\fP The Plugin UI
|
||||
.br
|
||||
\fIclass_uri\fP The URI of the LV2 UI type to check this UI against
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_ui_get_bundle_uri (SLV2UI ui)"
|
||||
.PP
|
||||
Get the URI for a Plugin UI's bundle.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIui\fP The Plugin UI
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Value slv2_ui_get_binary_uri (SLV2UI ui)"
|
||||
.PP
|
||||
Get the URI for a Plugin UI's shared library.
|
||||
.PP
|
||||
\fBParameters:\fP
|
||||
.RS 4
|
||||
\fIui\fP The Plugin UI
|
||||
.RE
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Values slv2_port_get_value_by_qname (SLV2Plugin plugin, SLV2Port port, const char * property_uri)"
|
||||
.PP
|
||||
Port analog of slv2_plugin_get_value.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_port_get_properties (SLV2Plugin plugin, SLV2Port port)"
|
||||
.PP
|
||||
Return the LV2 port properties of a port.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "bool slv2_port_has_property (SLV2Plugin p, SLV2Port port, SLV2Value property_uri)"
|
||||
.PP
|
||||
Return whether a port has a certain property.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "bool slv2_port_supports_event (SLV2Plugin p, SLV2Port port, SLV2Value event_uri)"
|
||||
.PP
|
||||
Return whether a port is an event port and supports a certain event type.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_port_get_symbol (SLV2Plugin plugin, SLV2Port port)"
|
||||
.PP
|
||||
Get the symbol of a port.
|
||||
.PP
|
||||
The 'symbol' is a short string, a valid C identifier. Returned value is owned by \fIport\fP and must not be freed.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Value slv2_port_get_name (SLV2Plugin plugin, SLV2Port port)"
|
||||
.PP
|
||||
Get the name of a port.
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2Values slv2_port_get_classes (SLV2Plugin plugin, SLV2Port port)"
|
||||
.PP
|
||||
Get all the classes of a port.
|
||||
.PP
|
||||
This can be used to determine if a port is an input, output, audio, control, midi, etc, etc, though it's simpler to use slv2_port_is_a. The returned list does not include lv2:Port, which is implied.
|
||||
.PP
|
||||
Returned value is shared and must not be destroyed by caller.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_port_is_a (SLV2Plugin plugin, SLV2Port port, SLV2Value port_class)"
|
||||
.PP
|
||||
Determine if a port is of a given class (input, output, audio, etc).
|
||||
.PP
|
||||
For convenience/performance/extensibility reasons, hosts are expected to create an SLV2Value for each port class they 'care about'. Well-known type URI strings are defined (e.g. SLV2_PORT_CLASS_INPUT) for convenience, but this function is designed so that SLV2 is usable with any port types without requiring explicit support in SLV2.
|
||||
.PP
|
||||
Time = O(n) (n pointer comparisons where n is the number of classes of this port, so this method is suitable for realtime use on any sane port).
|
||||
.SS "void slv2_port_get_range (SLV2Plugin plugin, SLV2Port port, SLV2Value * def, SLV2Value * min, SLV2Value * max)"
|
||||
.PP
|
||||
Get the default, minimum, and maximum values of a port.
|
||||
.PP
|
||||
\fIdef\fP, \fImin\fP, and \fImax\fP are outputs, pass pointers to uninitialized (i.e. NOT created with slv2_value_new) SLV2Value variables. These will be set to point at new values (which must be freed by the caller using slv2_value_free), or NULL if the value does not exist.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2ScalePoints slv2_port_get_scale_points (SLV2Plugin plugin, SLV2Port port)"
|
||||
.PP
|
||||
Get the scale points (enumeration values) of a port.
|
||||
.PP
|
||||
This returns a collection of 'interesting' named values of a port (e.g. appropriate entries for a UI selector associated with this port).
|
||||
.PP
|
||||
Returned value may be NULL if \fIport\fP has no scale points, otherwise it must be freed by caller with slv2_scale_points_free.
|
||||
.SS "SLV2Value slv2_value_new_uri (SLV2World world, const char * uri)"
|
||||
.PP
|
||||
Create a new URI value.
|
||||
.PP
|
||||
Returned value must be freed by called with slv2_value_free.
|
||||
.SS "void slv2_value_free (SLV2Value val)"
|
||||
.PP
|
||||
Free an SLV2Value.
|
||||
.PP
|
||||
.SS "SLV2Value slv2_value_duplicate (SLV2Value val)"
|
||||
.PP
|
||||
Duplicate an SLV2Value.
|
||||
.PP
|
||||
.SS "bool slv2_value_equals (SLV2Value value, SLV2Value other)"
|
||||
.PP
|
||||
Return whether two values are equivalent.
|
||||
.PP
|
||||
.SS "char* slv2_value_get_turtle_token (SLV2Value value)"
|
||||
.PP
|
||||
Return this value as a Turtle/SPARQL token.
|
||||
.PP
|
||||
Examples: <http://example.org/foo> doap:name 'this is a string' 1.0 1
|
||||
.PP
|
||||
Returned string is newly allocation and must be freed by caller.
|
||||
.SS "bool slv2_value_is_uri (SLV2Value value)"
|
||||
.PP
|
||||
Return whether the value is a URI (resource).
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "const char* slv2_value_as_uri (SLV2Value value)"
|
||||
.PP
|
||||
Return this value as a URI string, e.g.
|
||||
.PP
|
||||
'http://example.org/foo'.
|
||||
.PP
|
||||
Valid to call only if slv2_value_is_uri(\fIvalue\fP) returns true. Returned value is owned by \fIvalue\fP and must not be freed by caller.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_value_is_literal (SLV2Value value)"
|
||||
.PP
|
||||
Return whether this value is a literal (i.e.
|
||||
.PP
|
||||
not a URI).
|
||||
.PP
|
||||
Returns true if \fIvalue\fP is a string or numeric value.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_value_is_string (SLV2Value value)"
|
||||
.PP
|
||||
Return whether this value is a string literal.
|
||||
.PP
|
||||
Returns true if \fIvalue\fP is a string (but not numeric) value.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "const char* slv2_value_as_string (SLV2Value value)"
|
||||
.PP
|
||||
Return whether this value is a string literal.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_value_is_float (SLV2Value value)"
|
||||
.PP
|
||||
Return whether this value is a decimal literal.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "float slv2_value_as_float (SLV2Value value)"
|
||||
.PP
|
||||
Return \fIvalue\fP as a float.
|
||||
.PP
|
||||
Valid to call only if slv2_value_is_float(\fIvalue\fP) or slv2_value_is_int(\fIvalue\fP) returns true.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "bool slv2_value_is_int (SLV2Value value)"
|
||||
.PP
|
||||
Return whether this value is an integer literal.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "int slv2_value_as_int (SLV2Value value)"
|
||||
.PP
|
||||
Return \fIvalue\fP as an integer.
|
||||
.PP
|
||||
Valid to call only if slv2_value_is_int(\fIvalue\fP) returns true.
|
||||
.PP
|
||||
Time = O(1)
|
||||
156
lib-src/slv2/doc/man/man3/slv2_library.3
Normal file
156
lib-src/slv2/doc/man/man3/slv2_library.3
Normal file
@@ -0,0 +1,156 @@
|
||||
.TH "Plugin library access" 3 "6 Jul 2008" "Version 0.6.0" "SLV2" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
Plugin library access \- An SLV2Instance is an instantiated SLV2Plugin (ie a loaded dynamic library).
|
||||
|
||||
.PP
|
||||
.SS "Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "SLV2Instance \fBslv2_plugin_instantiate\fP (SLV2Plugin plugin, double sample_rate, const LV2_Feature *const *features)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_instance_free\fP (SLV2Instance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static const char * \fBslv2_instance_get_uri\fP (SLV2Instance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static void \fBslv2_instance_connect_port\fP (SLV2Instance instance, uint32_t port_index, void *data_location)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static void \fBslv2_instance_activate\fP (SLV2Instance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static void \fBslv2_instance_run\fP (SLV2Instance instance, uint32_t sample_count)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static void \fBslv2_instance_deactivate\fP (SLV2Instance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static const LV2_Descriptor * \fBslv2_instance_get_descriptor\fP (SLV2Instance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "static LV2_Handle \fBslv2_instance_get_handle\fP (SLV2Instance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2UIInstance \fBslv2_ui_instantiate\fP (SLV2Plugin plugin, SLV2UI ui, LV2UI_Write_Function write_function, LV2UI_Controller controller, const LV2_Feature *const *features)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_ui_instance_free\fP (SLV2UIInstance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "const LV2UI_Descriptor * \fBslv2_ui_instance_get_descriptor\fP (SLV2UIInstance instance)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "LV2UI_Handle \fBslv2_ui_instance_get_handle\fP (SLV2UIInstance instance)"
|
||||
.br
|
||||
.in -1c
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
These functions interact with the binary library code only, they do not read data files in any way.
|
||||
.SH "Function Documentation"
|
||||
.PP
|
||||
.SS "SLV2Instance slv2_plugin_instantiate (SLV2Plugin plugin, double sample_rate, const LV2_Feature *const * features)"
|
||||
.PP
|
||||
Instantiate a plugin.
|
||||
.PP
|
||||
The returned object represents shared library objects loaded into memory, it must be cleaned up with slv2_instance_free when no longer needed.
|
||||
.PP
|
||||
\fIplugin\fP is not modified or directly referenced by the returned object (instances store only a copy of the plugin's URI).
|
||||
.PP
|
||||
\fIhost_features\fP 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).
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if instantiation failed.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "void slv2_instance_free (SLV2Instance instance)"
|
||||
.PP
|
||||
Free a plugin instance.
|
||||
.PP
|
||||
\fIinstance\fP is invalid after this call.
|
||||
.SS "static const char* slv2_instance_get_uri (SLV2Instance instance)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Get the URI of the plugin which \fIinstance\fP is an instance of.
|
||||
.PP
|
||||
Returned string is shared and must not be modified or deleted.
|
||||
.SS "static void slv2_instance_connect_port (SLV2Instance instance, uint32_t port_index, void * data_location)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Connect a port to a data location.
|
||||
.PP
|
||||
This may be called regardless of whether the plugin is activated, activation and deactivation does not destroy port connections.
|
||||
.SS "static void slv2_instance_activate (SLV2Instance instance)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Activate a plugin instance.
|
||||
.PP
|
||||
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.
|
||||
.SS "static void slv2_instance_run (SLV2Instance instance, uint32_t sample_count)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Run \fIinstance\fP for \fIsample_count\fP frames.
|
||||
.PP
|
||||
If the hint lv2:hardRtCapable is set for this plugin, this function is guaranteed not to block.
|
||||
.SS "static void slv2_instance_deactivate (SLV2Instance instance)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Deactivate a plugin instance.
|
||||
.PP
|
||||
Note that to run the plugin after this you must activate it, which will reset all state information (except port connections).
|
||||
.SS "static const LV2_Descriptor* slv2_instance_get_descriptor (SLV2Instance instance)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Get the LV2_Descriptor of the plugin instance.
|
||||
.PP
|
||||
Normally hosts should not need to access the LV2_Descriptor directly, use the slv2_instance_* functions.
|
||||
.PP
|
||||
The returned descriptor is shared and must not be deleted.
|
||||
.SS "static LV2_Handle slv2_instance_get_handle (SLV2Instance instance)\fC [inline, static]\fP"
|
||||
.PP
|
||||
Get the LV2_Handle of the plugin instance.
|
||||
.PP
|
||||
Normally hosts should not need to access the LV2_Handle directly, use the slv2_instance_* functions.
|
||||
.PP
|
||||
The returned handle is shared and must not be deleted.
|
||||
.SS "SLV2UIInstance slv2_ui_instantiate (SLV2Plugin plugin, SLV2UI ui, LV2UI_Write_Function write_function, LV2UI_Controller controller, const LV2_Feature *const * features)"
|
||||
.PP
|
||||
Instantiate a plugin UI.
|
||||
.PP
|
||||
The returned object represents shared library objects loaded into memory, it must be cleaned up with slv2_ui_instance_free when no longer needed.
|
||||
.PP
|
||||
\fIplugin\fP is not modified or directly referenced by the returned object (instances store only a copy of the plugin's URI).
|
||||
.PP
|
||||
\fIhost_features\fP 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).
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
NULL if instantiation failed.
|
||||
.RE
|
||||
.PP
|
||||
|
||||
.SS "void slv2_ui_instance_free (SLV2UIInstance instance)"
|
||||
.PP
|
||||
Free a plugin UI instance.
|
||||
.PP
|
||||
It is the caller's responsibility to ensure all references to the UI instance (including any returned widgets) are cut before calling this function.
|
||||
.PP
|
||||
\fIinstance\fP is invalid after this call.
|
||||
.SS "LV2UI_Widget slv2_ui_instance_get_widget (SLV2UIInstance instance)"
|
||||
.PP
|
||||
Get the widget for the UI instance.
|
||||
.PP
|
||||
.SS "const LV2UI_Descriptor* slv2_ui_instance_get_descriptor (SLV2UIInstance instance)"
|
||||
.PP
|
||||
Get the LV2UI_Descriptor of the plugin UI instance.
|
||||
.PP
|
||||
Normally hosts should not need to access the LV2UI_Descriptor directly, use the slv2_ui_instance_* functions.
|
||||
.PP
|
||||
The returned descriptor is shared and must not be deleted.
|
||||
.SS "LV2UI_Handle slv2_ui_instance_get_handle (SLV2UIInstance instance)"
|
||||
.PP
|
||||
Get the LV2UI_Handle of the plugin UI instance.
|
||||
.PP
|
||||
Normally hosts should not need to access the LV2UI_Handle directly, use the slv2_ui_instance_* functions.
|
||||
.PP
|
||||
The returned handle is shared and must not be deleted.
|
||||
28
lib-src/slv2/doc/man/man3/slv2_util.3
Normal file
28
lib-src/slv2/doc/man/man3/slv2_util.3
Normal file
@@ -0,0 +1,28 @@
|
||||
.TH "Utility functions" 3 "6 Jul 2008" "Version 0.6.0" "SLV2" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
Utility functions \-
|
||||
.SS "Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "const char * \fBslv2_uri_to_path\fP (const char *uri)"
|
||||
.br
|
||||
.in -1c
|
||||
.SH "Function Documentation"
|
||||
.PP
|
||||
.SS "const char* slv2_uri_to_path (const char * uri)"
|
||||
.PP
|
||||
Convert a full URI (eg file://foo/bar/baz.ttl) to a local path (e.g.
|
||||
.PP
|
||||
/foo/bar/baz.ttl).
|
||||
.PP
|
||||
Return value is shared and must not be deleted by caller.
|
||||
.PP
|
||||
\fBReturns:\fP
|
||||
.RS 4
|
||||
\fIuri\fP converted to a path, or NULL on failure (URI is not local).
|
||||
.RE
|
||||
.PP
|
||||
|
||||
112
lib-src/slv2/doc/man/man3/slv2_world.3
Normal file
112
lib-src/slv2/doc/man/man3/slv2_world.3
Normal file
@@ -0,0 +1,112 @@
|
||||
.TH "Global library state" 3 "6 Jul 2008" "Version 0.6.0" "SLV2" \" -*- nroff -*-
|
||||
.ad l
|
||||
.nh
|
||||
.SH NAME
|
||||
Global library state \- The 'world' represents all library state, and the data found in bundles' manifest.ttl (ie it is an in-memory index of all things LV2 found).
|
||||
|
||||
.PP
|
||||
.SS "Functions"
|
||||
|
||||
.in +1c
|
||||
.ti -1c
|
||||
.RI "SLV2World \fBslv2_world_new\fP ()"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_world_free\fP (SLV2World world)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_world_load_all\fP (SLV2World world)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "void \fBslv2_world_load_bundle\fP (SLV2World world, SLV2Value bundle_uri)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2PluginClass \fBslv2_world_get_plugin_class\fP (SLV2World world)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2PluginClasses \fBslv2_world_get_plugin_classes\fP (SLV2World world)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Plugins \fBslv2_world_get_all_plugins\fP (SLV2World world)"
|
||||
.br
|
||||
.ti -1c
|
||||
.RI "SLV2Plugins \fBslv2_world_get_plugins_by_filter\fP (SLV2World world, bool(*include)(SLV2Plugin))"
|
||||
.br
|
||||
.in -1c
|
||||
.SH "Detailed Description"
|
||||
.PP
|
||||
Plugins (and plugin extensions) and the LV2 specification (and LV2 extensions) itself can be queried from the world for use.
|
||||
.PP
|
||||
Normal hosts which just want to easily load plugins by URI are strongly recommended to simply call \fBslv2_world_load_all\fP to find all installed data in the recommended way.
|
||||
.PP
|
||||
Normal hosts should NOT have to refer to bundles directly under normal circumstances. However, functions are provided to load individual bundles explicitly, intended for hosts which depend on a specific bundle (which is shipped with the application).
|
||||
.SH "Function Documentation"
|
||||
.PP
|
||||
.SS "SLV2World slv2_world_new ()"
|
||||
.PP
|
||||
Initialize a new, empty world.
|
||||
.PP
|
||||
If initialization fails, NULL is returned.
|
||||
.SS "SLV2World slv2_world_new_using_rdf_world (librdf_world * world)"
|
||||
.PP
|
||||
Initialize a new, empty world, using an existing Redland context.
|
||||
.PP
|
||||
.SS "void slv2_world_free (SLV2World world)"
|
||||
.PP
|
||||
Destroy the world, mwahaha.
|
||||
.PP
|
||||
NB: Destroying the world will leave dangling references in any plugin lists, plugins, etc. Do not destroy the world until you are finished with all objects that came from it.
|
||||
.SS "void slv2_world_load_all (SLV2World world)"
|
||||
.PP
|
||||
Load all installed LV2 bundles on the system.
|
||||
.PP
|
||||
This is the recommended way for hosts to load LV2 data. It does the most reasonable thing to find all installed plugins, extensions, etc. on the system. The environment variable LV2_PATH may be used to set the directories inside which this function will look for bundles. Otherwise a sensible, standard default will be used.
|
||||
.PP
|
||||
Use of other functions for loading bundles is \fIhighly\fP discouraged without a special reason to do so - use this one.
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "void slv2_world_load_bundle (SLV2World world, SLV2Value bundle_uri)"
|
||||
.PP
|
||||
Load a specific bundle.
|
||||
.PP
|
||||
.PD 0
|
||||
.IP "\(bu" 2
|
||||
bundle_uri A fully qualified URI to the bundle directory, with the trailing slash, eg. file:///usr/lib/lv2/someBundle/
|
||||
.PP
|
||||
Normal hosts should not use this function.
|
||||
.PP
|
||||
Hosts should \fBnever\fP attach any long-term significance to bundle paths as there are no guarantees they will remain consistent whatsoever. Plugins (and other things) are identified by URIs, \fBnot\fP bundle or file names.
|
||||
.PP
|
||||
This function should only be used by apps which ship with a special bundle (which it knows exists at some path because the bundle is shipped with the application).
|
||||
.PP
|
||||
Time = Query
|
||||
.SS "SLV2PluginClass slv2_world_get_plugin_class (SLV2World world)"
|
||||
.PP
|
||||
Get the parent of all other plugin classes, lv2:Plugin.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2PluginClasses slv2_world_get_plugin_classes (SLV2World world)"
|
||||
.PP
|
||||
Return a list of all found plugin classes.
|
||||
.PP
|
||||
Returned list is owned by world and must not be freed by the caller.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Plugins slv2_world_get_all_plugins (SLV2World world)"
|
||||
.PP
|
||||
Return a list of all found plugins.
|
||||
.PP
|
||||
The returned list contains just enough references to query or instantiate plugins. The data for a particular plugin will not be loaded into memory until a call to an slv2_plugin_* function results in a query (at which time the data is cached with the SLV2Plugin so future queries are very fast).
|
||||
.PP
|
||||
Returned list must be freed by user with slv2_plugins_free. The contained plugins are owned by \fIworld\fP and must not be freed by caller.
|
||||
.PP
|
||||
Time = O(1)
|
||||
.SS "SLV2Plugins slv2_world_get_plugins_by_filter (SLV2World world, bool(*)(SLV2Plugin) include)"
|
||||
.PP
|
||||
Return a list of found plugins filtered by a user-defined filter function.
|
||||
.PP
|
||||
All plugins currently found in \fIworld\fP that return true when passed to \fIinclude\fP (a pointer to a function which takes an SLV2Plugin and returns a bool) will be in the returned list.
|
||||
.PP
|
||||
Returned list must be freed by user with slv2_plugins_free. The contained plugins are owned by \fIworld\fP and must not be freed by caller.
|
||||
.PP
|
||||
Time = O(n * Time(include))
|
||||
1271
lib-src/slv2/doc/reference.doxygen.in
Normal file
1271
lib-src/slv2/doc/reference.doxygen.in
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user