diff options
-rw-r--r-- | Makefile.am | 4 | ||||
-rw-r--r-- | configure.ac | 11 | ||||
-rw-r--r-- | data/Makefile.am | 2 | ||||
-rw-r--r-- | data/lv2core.lv2/Makefile.am | 7 | ||||
-rw-r--r-- | data/lv2core.lv2/lv2.ttl | 593 | ||||
-rw-r--r-- | data/lv2core.lv2/manifest.ttl | 7 | ||||
-rw-r--r-- | debian/changelog | 6 | ||||
-rw-r--r-- | slv2/Makefile.am | 1 | ||||
-rw-r--r-- | slv2/lv2.h | 392 | ||||
-rw-r--r-- | slv2/plugininstance.h | 2 | ||||
-rw-r--r-- | src/Makefile.am | 2 | ||||
-rw-r--r-- | utils/Makefile.am | 2 |
12 files changed, 18 insertions, 1011 deletions
diff --git a/Makefile.am b/Makefile.am index e8a99d7..a256646 100644 --- a/Makefile.am +++ b/Makefile.am @@ -13,8 +13,8 @@ dist-check-doxygen: @false endif -SUBDIRS = src slv2 utils hosts data $(DOC_DIR) swig debian -DIST_SUBDIRS = src slv2 utils hosts data doc swig debian +SUBDIRS = src slv2 utils hosts $(DOC_DIR) swig debian +DIST_SUBDIRS = src slv2 utils hosts doc swig debian pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = slv2.pc diff --git a/configure.ac b/configure.ac index 420079a..eef04b5 100644 --- a/configure.ac +++ b/configure.ac @@ -1,6 +1,6 @@ AC_PREREQ(2.59) -AC_INIT([slv2],0.4.1,[dave@drobilla.net]) +AC_INIT([slv2],0.4.2,[dave@drobilla.net]) AC_CONFIG_AUX_DIR([config]) @@ -28,8 +28,10 @@ AM_INIT_AUTOMAKE # 0.3.1 = 4,0,0 # 0.3.2 = 5,0,1 # 0.4.0 = 6,0,0 +# 0.4.1 = 6,0,0 +# 0.4.2 = 6,0,0 -SLV2_VERSION="0.4.1" +SLV2_VERSION="0.4.2" SLV2_API_CURRENT="6" SLV2_API_REVISION="0" SLV2_API_AGE="0" @@ -62,6 +64,9 @@ AM_PROG_CC_C_O # Library building stuff AC_PROG_LIBTOOL +# LV2 core package +PKG_CHECK_MODULES(LV2CORE, lv2core >= 1) + # Check for debugging flag debug="no" AC_ARG_ENABLE(debug, @@ -150,8 +155,6 @@ AC_CONFIG_FILES([slv2/Makefile]) AC_CONFIG_FILES([utils/Makefile]) AC_CONFIG_FILES([hosts/Makefile]) AC_CONFIG_FILES([swig/Makefile]) -AC_CONFIG_FILES([data/Makefile]) -AC_CONFIG_FILES([data/lv2core.lv2/Makefile]) AC_CONFIG_FILES([slv2.pc]) AC_CONFIG_FILES([doc/Makefile]) AC_CONFIG_FILES([doc/reference.doxygen]) diff --git a/data/Makefile.am b/data/Makefile.am deleted file mode 100644 index 3eab75c..0000000 --- a/data/Makefile.am +++ /dev/null @@ -1,2 +0,0 @@ -SUBDIRS = lv2core.lv2 - diff --git a/data/lv2core.lv2/Makefile.am b/data/lv2core.lv2/Makefile.am deleted file mode 100644 index cd25516..0000000 --- a/data/lv2core.lv2/Makefile.am +++ /dev/null @@ -1,7 +0,0 @@ -EXTRA_DIST = manifest.ttl lv2.ttl - -bundledir = $(libdir)/lv2/lv2core.lv2 -bundle_DATA = manifest.ttl lv2.ttl - -uninstall-hook: - rm -rf $(bundledir)/ diff --git a/data/lv2core.lv2/lv2.ttl b/data/lv2core.lv2/lv2.ttl deleted file mode 100644 index 3e1bbc7..0000000 --- a/data/lv2core.lv2/lv2.ttl +++ /dev/null @@ -1,593 +0,0 @@ -# RDF Schema for LV2 plugins -# *** PROVISIONAL Revision 1.0beta7 (2007-11-14) *** -# -# This document describes the classes and properties that are defined by the -# core LV2 specification. See <http://lv2plug.in> for more information. -# -# Copyright (C) 2006-2007 Steve Harris, Dave Robillard -# -# Permission is hereby granted, free of charge, to any person obtaining a -# copy of this software and associated documentation files (the "Software"), -# to deal in the Software without restriction, including without limitation -# the rights to use, copy, modify, merge, publish, distribute, sublicense, -# and/or sell copies of the Software, and to permit persons to whom the -# Software is furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included -# in all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL -# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR -# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -# OTHER DEALINGS IN THE SOFTWARE. - -@prefix : <http://lv2plug.in/ns/lv2core#> . -@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . -@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . -@prefix xsd: <http://www.w3.org/2001/XMLSchema> . -@prefix doap: <http://usefulinc.com/ns/doap#> . -@prefix foaf: <http://xmlns.com/foaf/0.1/> . - -:Specification a rdfs:Class ; - rdfs:comment """ -An LV2 specification (ie this specification, or an LV2 extension). - -Specification data, like plugins, is distributed in standardized -bundles so hosts may discover all present LV2 data. -See http://lv2plug.in/docs for more details. -""" . - -<> a doap:Project ; - a :Specification ; - doap:license <http://usefulinc.com/doap/licenses/mit> ; - doap:name "LV2" ; - doap:homepage <http://lv2plug.in> ; - doap:created "2004-04-21" ; - doap:shortdesc "An audio processing plugin specification" ; - doap:programming-language "C" ; - doap:release [ - doap:revision "1.0beta7" ; - doap:created "2007-11-14" - ] ; - doap:maintainer [ - a foaf:Person ; - foaf:name "Steve Harris" ; - foaf:homepage <http://plugin.org.uk/> ; - rdfs:seeAlso <http://plugin.org.uk/swh.xrdf> - ] , [ - a foaf:Person ; - foaf:name "Dave Robillard" ; - foaf:homepage <http://drobilla.net/> ; - rdfs:seeAlso <http://drobilla.net/drobilla.xrdf> - ]. - - -################## -## Plugin Class ## -################## - -:Plugin a rdfs:Class ; - rdfs:label "Plugin" ; - rdfs:comment """ -The class which represents an LV2 plugin. - -To be used by a host a Plugin must have at least the following properties: - rdf:type (with object :Plugin) - doap:name (one without language tag) - doap:license - :port - -The doap:name property should be at most a few words in length using title -capitalization, e.g. "Tape Delay Unit". Use doap:shortdesc or -doap:description for more detailed descriptions. -""" . - - - -################## -## Port Classes ## -################## - -:Port a rdfs:Class ; - rdfs:label "Port" ; - rdfs:comment """ -The class which represents an LV2 port. - -In order for it to be used by a host it must have at least -the following properties: - rdf:type (with object one of :Port, :InputPort, :OutputPort) - rdf:type (more specific port class, see below) - :index - :symbol - :name - -All LV2 port descriptions MUST have a property rdf:type where the object -is one of :Port :InputPort or :OutputPort. Additionally there MUST be -at least one other rdf:type property which more specifically describes -type of the port (e.g. :AudioPort). - -Hosts that do not support a specific port class MUST NOT instantiate the -plugin, unless that port has the connectionOptional property set (in which case -the host can simply "connect" that port to NULL). If a host is interested -in plugins to insert in a certain signal path (e.g. stereo audio), it SHOULD -consider all the classes of a port to determine which ports are most suitable -for connection (e.g. by ignoring ports with additional classes the host does -not recognize). -""" . - -:InputPort a rdfs:Class ; - rdfs:label "Input port" ; - rdfs:subClassOf :Port ; - rdfs:comment """ -Ports of this type will be connected to a pointer to some value, which will -be read by the plugin during their run method. -""" . - -:OutputPort a rdfs:Class ; - rdfs:label "Output port" ; - rdfs:subClassOf :Port ; - rdfs:comment """ -Ports of this type will be connected to a pointer to some value, which will -be written to by the plugin during their run method. -""" . - -:ControlPort a rdfs:Class ; - rdfs:label "Control port" ; - rdfs:subClassOf :Port ; - rdfs:comment """ -Ports of this type will be connected to a pointer to a single value conforming -to the 32bit IEEE-754 floating point specification. -""" . - -:AudioPort a rdfs:Class ; - rdfs:label "Audio port" ; - rdfs:subClassOf :Port ; - rdfs:comment """ -Ports of this type will be connected to an array of length SampleCount -conforming to the 32bit IEEE-754 floating point specification. -""" . - - -##################################### -## Mandatory Plugin RDF Properties ## -##################################### - -:port a rdf:Property ; - rdfs:domain :Plugin ; - rdfs:range :Port ; - rdfs:label "port" ; - rdfs:comment "Relates a Plugin to the Ports it contains" . - - -#################################### -## Optional Plugin RDF Properties ## -#################################### - -:documentation a rdf:Property ; - rdfs:domain :Plugin ; - rdfs:label "documentation" ; - rdfs:comment "Relates a Plugin to some text/audio/video documentation either online or included with the plugin package" . - - - -################################### -## Mandatory Port RDF Properties ## -################################### - -:index a rdf:Property ; - rdfs:domain :Port ; - rdfs:range xsd:nonNegativeInteger ; - rdfs:label "index" ; - rdfs:comment """ -Specifies the index of the port, passed as an argument to the connect port -function. This number uniqely identifies the port within the plugin. - -The plugin author MUST change the plugin URI if a port index is changed. -""" . - -:symbol a rdf:Property ; - rdfs:label "symbol" ; - rdfs:comment """ -A short name used as a machine and human readable identifier. - -The first character must be one of _, a-z or A-Z and subsequenct characters can -be from _, a-z, A-Z and 0-9. - -A language tag MUST NOT be used on this property. The plugin author MUST change -the plugin URI if a port symbol is changed. -""" . - -:name a rdf:Property ; - rdfs:domain :Port ; - rdfs:label "name" ; - rdfs:comment """ -A display name for labeling the Port in a user interface. - -This property is required for Ports, but MUST NOT be used by the host for -port identification. The plugin author may change the values of this -property without changing the Plugin URI. -""" . - - - -################################## -## Optional Port RDF Properties ## -################################## - -:Point a rdfs:Class ; - rdfs:label "Port value point" ; - rdfs:comment """ -Used to describe interesting values in a Port's range. To be valid it requires -two rdf:properties, rdfs:label and rdf:value. - -There are 3 specially defined Points in the LV2 specification (default, -minimum, and maximum), though future extensions may define more. -""" . - -:ScalePoint a rdfs:Class ; - rdfs:subClassOf :Point ; - rdfs:comment "A single :float Point (for control inputs)" . - -:scalePoint a rdf:Property ; - rdfs:domain :Port ; - rdfs:range :ScalePoint ; - rdfs:label "Scale point" ; - rdfs:comment "Relates a Port to its ScalePoints." . - -:default a rdf:Property ; - rdfs:subPropertyOf :scalePoint ; - rdfs:label "Default value" ; - rdfs:comment """ -The default value that the host SHOULD set this port to when there is no other -information available. -""" . - -:minimum a rdf:Property ; - rdfs:subPropertyOf :scalePoint ; - rdfs:label "Minimum value" ; - rdfs:comment """ -A hint to the host for the minimum useful value that the port will use. -This is a "soft" limit - the plugin is required to gracefully accept all -values in the range of :float. -""" . - -:maximum a rdf:Property ; - rdfs:subPropertyOf :scalePoint ; - rdfs:label "Maximum value" ; - rdfs:comment """ -A hint to the host for the maximum useful value that the port will use. -This is a "soft" limit - the plugin is required to gracefully accept all -values in the range of :float. -""" . - - - -############## -## Features ## -############## - -:Feature a rdfs:Class ; - rdfs:label "Feature" ; - rdfs:comment "An additional feature which a plugin may use (possibly require).". - -:optionalFeature a rdf:Property ; - rdfs:domain :Plugin ; - rdfs:range :Feature ; - rdfs:label "Optional feature" ; - rdfs:comment """ -Signifies that a plugin is able to make use of or provide a certain feature. -If the host supports this feature, it MUST pass its URI and any additional -data to the plugin in the instantiate() function. The plugin MUST NOT fail to -instantiate if an optional feature is not supported by the host.""" . - -:requiredFeature a rdf:Property ; - rdfs:domain :Plugin ; - rdfs:range :Feature ; - rdfs:label "Required feature" ; - rdfs:comment """ -Signifies that a plugin requires a certain feature in order to function. -If the host supports this feature, it MUST pass its URI and any additional -data to the plugin in the instantiate() function. The plugin MUST fail to -instantiate if a required feature is not present; hosts SHOULD always check -this before attempting to instantiate a plugin (i.e. discovery by attempting -to instantiate is strongly discouraged). -""" . - - -#################### -## PortProperties ## -#################### - -:PortProperty a rdfs:Class ; - rdfs:label "Port property" ; - rdfs:comment """ -A port propety - a useful piece of information that allows a host to make more -sensible decisions (e.g. to provide a better interface). -""" . - -:portProperty a rdf:Property ; - rdfs:domain :Port ; - rdfs:range :PortProperty ; - rdfs:label "Port property" ; - rdfs:comment """ -Relates Ports to PortProperties. The PortProperty may be ignored without -catastrophic effects, though it may be useful e.g. for providing a sensible -interface for the port. -""". - - -####################### -## Standard Features ## -####################### - -:isLive a :Feature ; - rdfs:label "Has a live (realtime) dependency" ; - rdfs:comment """ -Indicates that the plugin has a real-time dependency (e.g. queues data from a -socket) and so its output must not be cached or subject to significant latency, -and calls to the run method should be done in rapid succession. -""" . - -:inPlaceBroken a :Feature ; - rdfs:label "in-place broken" ; - rdfs:comment """ -Indicates that the plugin may cease to work correctly if the host elects to use -the same data location for both input and output. Plugins that will fail to -work correctly if ANY input buffer is set to the same location as ANY output -buffer (with connect_port()) MUST require this Feature. Doing so should be -avoided as it makes it impossible for hosts to use the plugin to process audio -"in-place". -""" . - -:hardRTCapable a :Feature ; - rdfs:label "Hard realtime capable" ; - rdfs:comment """ -Indicates that the plugin is capable of running not only in a conventional host -but also in a "hard real-time" environment. To qualify for this the plugin must -satisfy all of the following: - - (1) The plugin must not use malloc(), free() or other heap memory - management within its Audio class functions. All new memory used in - Audio class functions must be managed via the stack. These restrictions - only apply to the Audio class functions. - - (2) The plugin will not attempt to make use of any library - functions in its Audio class functions, with the exceptions of functions - in the ANSI standard C and C maths libraries, which the host is expected to - provide. - - (3) The plugin will not access files, devices, pipes, sockets, IPC - or any other mechanism that might result in process or thread - blocking within its Audio class functions. - - (4) The plugin will take an amount of time to execute a run() call - approximately of form (A+B*SampleCount) where A and B depend on the - machine and host in use. This amount of time may not depend on input - signals or plugin state. The host is left the responsibility to perform - timings to estimate upper bounds for A and B. The plugin will also take an - approximately constant amount of time to execute a connect_port() call. -""" . - - -############################# -## Standard PortProperties ## -############################# - -:connectionOptional a :PortProperty ; - rdfs:label "Optionally connected port" ; - rdfs:comment """ -Indicates that this port does not have to be connected to valid data by the -host. If it is to be disconnected then the port MUST set to NULL with a call -to the connectPort method. -""" . - -:reportsLatency a :PortProperty ; - rdfs:label "Latency reporting port" ; - rdfs:comment """ -Indicates that the port is used to express the processing latency incurred by -the plugin, expressed in samples. The latency may be affected by the current -sample rate, plugin settings, or other factors, and may be changed by the -plugin at any time. Where the latency is frequency dependent the plugin may -choose any appropriate value. If a plugin introduces latency it MUST provide -EXACTLY ONE port with this property set which informs the host of the "correct" -latency. In "fuzzy" cases the value output should be the most reasonable based -on user expectation of input/output alignment (eg. musical delay/echo plugins -should not report their delay as latency, as it is an intentional effect). -""". - -:toggled a :PortProperty ; - rdfs:label "Toggled" ; - rdfs:comment """ -Indicates that the data item should be considered a Boolean toggle. Data less -than or equal to zero should be considered "off" or "false", and data above -zero should be considered "on" or "true". -""" . - -:sampleRate a :PortProperty ; - rdfs:label "Sample rate" ; - rdfs:comment """ -Indicates that any bounds specified should be interpreted as multiples of the -sample rate. For instance, a frequency range from 0Hz to the Nyquist frequency -(half the sample rate) could be requested by this property in conjunction with -:minimum 0.0 and :maximum 0.5. Hosts that support bounds at all must support -this property to retain meaning. -""" . - -:integer a :PortProperty ; - rdfs:label "Integer" ; - rdfs:comment """ -Indicates that a port's reasonable values are integers (eg. a user interface -would likely wish to provide a stepped control allowing only integer input). -A plugin MUST operate reasonably even if such a port has a non-integer input. -""" . - - - -#################### -## Plugin Classes ## -#################### - -:GeneratorPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Generator" ; - rdfs:comment """ -Any plugin that generates sound internally, rather than processing its input. -""" . - -:InstrumentPlugin a rdfs:Class ; - rdfs:subClassOf :GeneratorPlugin ; - rdfs:label "Instrument" ; - rdfs:comment """ -Any plugin that is intended to be played as a musical instrument. -""" . - -:OscillatorPlugin a rdfs:Class ; - rdfs:subClassOf :GeneratorPlugin ; - rdfs:label "Oscillator" . - -:UtilityPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Utility" ; - rdfs:comment """ -Includes things like mathematical functions and non-musical delays. -""" . - -:ConverterPlugin a rdfs:Class ; - rdfs:subClassOf :UtilityPlugin ; - rdfs:label "Converter" ; - rdfs:comment """ -Any plugin that converts some form of input into a different form of output. -""" . - -:AnalyserPlugin a rdfs:Class ; - rdfs:subClassOf :UtilityPlugin ; - rdfs:label "Analyser" ; - rdfs:comment """ -Any plugin that analyses input to output some useful information. -""" . - -:MixerPlugin a rdfs:Class ; - rdfs:subClassOf :UtilityPlugin ; - rdfs:label "Mixer" ; - rdfs:comment """ -A plugin which mixes some number of inputs into some number of outputs. -""" . - -:SimulatorPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Simulator" ; - rdfs:comment """ -Plugins that aim to duplicate the effect of some environmental effect or -musical equipment. -""" . - -:DelayPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Delay" ; - rdfs:comment """ -Plugins that intentionally delay their input signal as an effect. -""" . - -:ModulatorPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Modulator" . - -:ReverbPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:subClassOf :SimulatorPlugin ; - rdfs:subClassOf :DelayPlugin ; - rdfs:label "Reverb" . - -:PhaserPlugin a rdfs:Class ; - rdfs:subClassOf :ModulatorPlugin ; - rdfs:label "Phaser" . - -:FlangerPlugin a rdfs:Class ; - rdfs:subClassOf :ModulatorPlugin ; - rdfs:label "Flanger" . - -:ChorusPlugin a rdfs:Class ; - rdfs:subClassOf :ModulatorPlugin ; - rdfs:label "Chorus" . - -:FilterPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Filter" . - -:LowpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Lowpass" . - -:BandpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Bandpass" . - -:HighpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Highpass" . - -:CombPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Comb" . - -:AllpassPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Allpass" . - -:EQPlugin a rdfs:Class ; - rdfs:subClassOf :FilterPlugin ; - rdfs:label "Equaliser" . - -:ParaEQPlugin a rdfs:Class ; - rdfs:subClassOf :EQPlugin ; - rdfs:label "Parametric" . - -:MultiEQPlugin a rdfs:Class ; - rdfs:subClassOf :EQPlugin ; - rdfs:label "Multiband" . - -:SpectralPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Spectral Processor" . - -:PitchPlugin a rdfs:Class ; - rdfs:subClassOf :SpectralPlugin ; - rdfs:label "Pitch Shifter" . - -:AmplifierPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Amplifier" . - -:DistortionPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Distortion" . - -:WaveshaperPlugin a rdfs:Class ; - rdfs:subClassOf :DistortionPlugin ; - rdfs:label "Waveshaper" . - -:DynamicsPlugin a rdfs:Class ; - rdfs:subClassOf :Plugin ; - rdfs:label "Dynamics Processor" ; - rdfs:comment """ -Plugins that alter the envelope or dynamic range of the processed audio. -""" . - -:CompressorPlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Compressor" . - -:ExpanderPlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Expander" . - -:LimiterPlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Limiter" . - -:GatePlugin a rdfs:Class ; - rdfs:subClassOf :DynamicsPlugin ; - rdfs:label "Gate" . diff --git a/data/lv2core.lv2/manifest.ttl b/data/lv2core.lv2/manifest.ttl deleted file mode 100644 index fabe17e..0000000 --- a/data/lv2core.lv2/manifest.ttl +++ /dev/null @@ -1,7 +0,0 @@ -@prefix lv2: <http://lv2plug.in/ns/lv2core#>. -@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#>. - -<http://lv2plug.in/ns/lv2core> - a lv2:Specification ; - rdfs:seeAlso <lv2.ttl> . - diff --git a/debian/changelog b/debian/changelog index 6eafc19..16c1927 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +slv2 (0.4.2) unstable; urgency=low + + * Update for LV2 specification release 1 + + -- Dave Robillard <dave@drobilla.net> Tue, 08 Jan 2008 20:16:56 -0500 + slv2 (0.4.1) unstable; urgency=low * Debian packaging (no functional changes) diff --git a/slv2/Makefile.am b/slv2/Makefile.am index 89d0cd0..924fbec 100644 --- a/slv2/Makefile.am +++ b/slv2/Makefile.am @@ -1,7 +1,6 @@ slv2includedir = $(includedir)/slv2 slv2include_HEADERS = \ - lv2.h \ lv2_gui.h \ plugin.h \ pluginclass.h \ diff --git a/slv2/lv2.h b/slv2/lv2.h deleted file mode 100644 index 8241cc6..0000000 --- a/slv2/lv2.h +++ /dev/null @@ -1,392 +0,0 @@ -/* LV2 - LADSPA (Linux Audio Developer's Simple Plugin API) Version 2.0 - * *** PROVISIONAL Revision 1.0beta7 (2007-11-14) *** - * - * Copyright (C) 2000-2002 Richard W.E. Furse, Paul Barton-Davis, - * Stefan Westerfeld. - * Copyright (C) 2006-2007 Steve Harris, Dave Robillard. - * - * This header is free software; you can redistribute it and/or modify it - * under the terms of the GNU Lesser General Public License as published - * by the Free Software Foundation; either version 2.1 of the License, - * or (at your option) any later version. - * - * This header 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 - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 - * USA. - */ - -#ifndef LV2_H_INCLUDED -#define LV2_H_INCLUDED - -#include <stdint.h> - -#ifdef __cplusplus -extern "C" { -#endif - - -/* ************************************************************************* */ - - -/** @file lv2.h - * - * Revision: 1.0beta7 - * - * == Overview == - * - * There are a large number of open source and free software synthesis - * packages in use or development at this time. This API ('LV2') - * attempts to give programmers the ability to write simple 'plugin' - * audio processors in C/C++ and link them dynamically ('plug') into - * a range of these packages ('hosts'). It should be possible for any - * host and any plugin to communicate completely through this interface. - * - * This API is deliberately as short and simple as possible. - * The information required to use a plugin is in a companion data - * (RDF) file. The shared library portion of the API (defined in this - * header) does not contain enough information to make use of the plugin - * possible - the data file is mandatory. - * - * Plugins are expected to distinguish between control rate and audio - * rate data (or other types of data defined by extensions). Plugins have - * 'ports' that are inputs or outputs and each plugin is 'run' for a 'block' - * corresponding to a short time interval measured in samples. Audio rate - * data is communicated using arrays with one element per sample processed, - * allowing a block of audio to be processed by the plugin in a single - * pass. Control rate data is communicated using single values. Control - * rate data has a single value at the start of a call to the 'run()' - * function, and may be considered to remain this value for its duration. - * Thus the 'control rate' is determined by the block size, controlled by - * the host. The plugin may assume that all its input and output ports have - * been connected to the relevant data location (see the 'connect_port()' - * function below) before it is asked to run, unless the port has been set - * 'connection optional' in the plugin's data file. - * - * Plugins will reside in shared object files suitable for dynamic linking - * by dlopen() and family. The file will provide a number of 'plugin - * types' that can be used to instantiate actual plugins (sometimes known - * as 'plugin instances') that can be connected together to perform tasks. - * The host can access these plugin types using the lv2_descriptor() - * function. - * - * This API contains very limited error-handling. - * - * == Threading rules == - * - * Certain hosts may need to call the functions provided by a plugin from - * multiple threads. For this to be safe, the plugin must be written so that - * those functions can be executed simultaneously without problems. - * To facilitate this, the functions provided by a plugin are divided into - * classes: - * - * - Discovery class: lv2_descriptor(), extension_data() - * - Instantiation class: instantiate(), cleanup(), activate(), deactivate() - * - Audio class: run(), connect_port() - * - * Extensions to this specification which add new functions MUST declare in - * which of these classes the functions belong, or define new classes for them. - * The rules that hosts must follow are these: - * - * - When a function from the Discovery class is running, no other - * functions in the same shared object file may run. - * - When a function from the Instantiation class is running for a plugin - * instance, no other functions for that instance may run. - * - When a function is running for a plugin instance, no other - * function in the same class may run for that instance. - * - * Any simultaneous calls that are not explicitly forbidden by these rules - * are allowed. For example, a host may call run() for two different plugin - * instances simultaneously. - */ - - -/* ************************************************************************* */ - - -/** Plugin Handle. - * - * This plugin handle indicates a particular instance of the plugin - * concerned. It is valid to compare this to NULL (0 for C++) but - * otherwise the host MUST NOT attempt to interpret it. The plugin - * may use it to reference internal instance data. */ -typedef void * LV2_Handle; - - -/* ************************************************************************* */ - - -/** Feature data. - * - * These are passed to a plugin's instantiate method to represent a special - * feature the host has which the plugin may depend on. This is to allow - * extensions to the LV2 specification without causing any breakage. - * Extensions may specify what data needs to be passed here. The base - * LV2 specification does not define any features; hosts are not required - * to use this facility. */ -typedef struct _LV2_Feature { - /** A globally unique, case-sensitive identifier for this feature. - * - * This MUST be defined in the specification of any LV2 extension which - * defines a host feature. */ - const char * URI; - - /** Pointer to arbitrary data. - * - * This is to allow hosts to pass data to a plugin (simple values, data - * structures, function pointers, etc) as part of a 'feature'. The LV2 - * specification makes no restrictions on the contents of this data. - * The data here MUST be cleary defined by the LV2 extension which defines - * this feature. - * If no data is required, this may be set to NULL. */ - void * data; -} LV2_Feature; - - -/* ************************************************************************* */ - - -/** Descriptor for a Type of Plugin. - * - * This structure is used to describe a plugin type. It provides a number - * of functions to instantiate it, link it to buffers and run it. */ -typedef struct _LV2_Descriptor { - - /** A globally unique, case-sensitive identifier for this plugin type. - * - * All plugins with the same URI MUST be compatible in terms of 'port - * signature', meaning they have the same number of ports, same port - * shortnames, and roughly the same functionality. URIs should - * probably contain a version number (or similar) for this reason. - * - * Rationale: When serializing session/patch/etc files, hosts MUST - * refer to a loaded plugin by the plugin URI only. In the future - * loading a plugin with this URI MUST yield a plugin with the - * same ports (etc) which is 100% compatible. */ - const char * URI; - - /** Function pointer that instantiates a plugin. - * - * A handle is returned indicating the new plugin instance. The - * instantiation function accepts a sample rate as a parameter as well - * as the plugin descriptor from which this instantiate function was - * found. This function must return NULL if instantiation fails. - * - * bundle_path is a string of the path to the LV2 bundle which contains - * this plugin binary. It MUST include the trailing directory separator - * (e.g. '/') so that BundlePath + filename gives the path to a file - * in the bundle. - * - * features is 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 - * SHOULD NOT use this as a discovery mechanism, instead reading the - * data file before attempting to instantiate the plugin). This array - * must always exist; if a host has no features, it MUST pass a single - * element array containing NULL (to simplify plugins). - * - * 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. */ - LV2_Handle (*instantiate)(const struct _LV2_Descriptor * descriptor, - double sample_rate, - const char * bundle_path, - const LV2_Feature *const * features); - - /** Function pointer that connects a port on a plugin instance to a memory - * location where the block of data for the port will be read/written. - * - * The data location is expected to be of the type defined in the - * plugin's data file (e.g. an array of float for an lv2:AudioPort). - * Memory issues are managed by the host. The plugin must read/write - * the data at these locations every time run() is called, data - * present at the time of this connection call MUST NOT be - * considered meaningful. - * - * The host MUST NOT try to connect a data buffer to a port index - * that is not defined in the RDF data for the plugin. If it does, - * the plugin's behaviour is undefined. - * - * 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. Note that there may be realtime constraints - * on connect_port (see lv2:hardRTCapable in lv2.ttl). - * - * connect_port() MUST be called at least once for each port before - * run() is called. The plugin must pay careful attention to the block - * size passed to the run function as the block allocated may only just - * be large enough to contain the block of data (typically samples), and - * is not guaranteed to be constant. - * - * 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). - * However, overlapped buffers or use of a single buffer for both - * audio and control data may result in unexpected behaviour. - * - * 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 lv2.ttl). */ - void (*connect_port)(LV2_Handle instance, - uint32_t port, - void * data_location); - - /** Function pointer that initialises a plugin instance and activates - * 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 the plugin writer may provide - * a NULL rather than an empty function. - * - * 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(). activate() may not be called again - * unless deactivate() is called first (after which activate() may be - * called again, followed by deactivate, etc. etc.). 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 a call to - * activate(). */ - void (*activate)(LV2_Handle instance); - - /** Function pointer that runs a plugin instance for a block. - * - * Two parameters are required: the first is a handle to the particular - * instance to be run and the second indicates the block size (in - * samples) for which the plugin instance may run. - * - * Note that if an activate() function exists then it must be called - * before run(). If deactivate() is called for a plugin instance then - * the plugin instance may not be reused 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 lv2.ttl). */ - void (*run)(LV2_Handle instance, - uint32_t sample_count); - - /** This is the counterpart to activate() (see above). If there is - * nothing for deactivate() to do then the plugin writer may provide - * a NULL rather than an empty function. - * - * Hosts must deactivate all activated units 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. Note that connect_port() may be called before or - * after a call to deactivate(). - * - * Note that deactivation is not similar to pausing as the plugin - * instance will be reinitialised when activate() is called to reuse it. - * Hosts MUST NOT call deactivate() unless activate() was previously - * called. */ - void (*deactivate)(LV2_Handle instance); - - /** This is the counterpart to instantiate() (see above). Once an instance - * of a plugin has been finished with it can 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. */ - void (*cleanup)(LV2_Handle instance); - - /** Function pointer that can be used to return additional instance data for - * a plugin defined by some extenion (e.g. a struct containing additional - * function pointers). - * - * The actual type and meaning of the returned object MUST be specified - * precisely by the extension if it defines any extra data. If a particular - * extension does not define extra instance data, this function MUST return - * NULL for that extension's URI. If a plugin does not support any - * extensions that define extra instance data, this function pointer may be - * set to NULL rather than providing an empty function. - * - * The only parameter is the URI of the extension. The plugin MUST return - * NULL if it does not support the extension, but hosts SHOULD NOT use this - * as a discovery method (e.g. hosts should only call this function for - * extensions known to be supported by the plugin from the data file). - * - * The host is never responsible for freeing the returned value. - * - * NOTE: This function should return a struct (likely containing function - * pointers) and NOT a direct function pointer. Standard C and C++ do not - * allow type casts from void* to a function pointer type. To provide - * additional functions a struct should be returned containing the extra - * function pointers (which is valid standard code, and a much better idea - * for extensibility anyway). */ - const void* (*extension_data)(const char * uri); - -} LV2_Descriptor; - - -/* ****************************************************************** */ - - -/** Accessing Plugin Types. - * - * The exact mechanism by which plugins are loaded is host-dependent, - * however all most hosts will need to know is the URI of the plugin they - * wish to load. The environment variable LV2_PATH, if present, should - * contain a colon-separated path indicating directories (containing - * plugin bundle subdirectories) that should be searched (in order) - * for plugins. It is expected that hosts will use a library to provide - * this functionality. - * - * A plugin programmer must include a function called "lv2_descriptor" - * with the following function prototype within the shared object - * file. This function will have C-style linkage (if you are using - * C++ this is taken care of by the 'extern "C"' clause at the top of - * the file). - * - * A host will find the plugin shared object file by one means or another, - * find the lv2_descriptor() function, call it, and proceed from there. - * - * Plugin types are accessed by index (not ID) using values from 0 - * upwards. Out of range indexes must result in this function returning - * NULL, so the plugin count can be determined by checking for the least - * index that results in NULL being returned. Index has no meaning, - * hosts MUST NOT depend on it remaining constant (ie when serialising) - * in any way. */ -const LV2_Descriptor * lv2_descriptor(uint32_t index); - - -/** Datatype corresponding to the lv2_descriptor() function. */ -typedef const LV2_Descriptor * -(*LV2_Descriptor_Function)(uint32_t index); - - -/* ******************************************************************** */ - - -/* Put this (LV2_SYMBOL_EXPORT) before any functions that are to be loaded - * by the host as a symbol from the dynamic library. - */ -#ifdef WIN32 -#define LV2_SYMBOL_EXPORT __declspec(dllexport) -#else -#define LV2_SYMBOL_EXPORT -#endif - - -#ifdef __cplusplus -} -#endif - -#endif /* LV2_H_INCLUDED */ - diff --git a/slv2/plugininstance.h b/slv2/plugininstance.h index d72c8ad..8f2b7fd 100644 --- a/slv2/plugininstance.h +++ b/slv2/plugininstance.h @@ -24,7 +24,7 @@ extern "C" { #endif #include <assert.h> -#include <slv2/lv2.h> +#include <lv2.h> #include <slv2/plugin.h> #include <slv2/port.h> diff --git a/src/Makefile.am b/src/Makefile.am index 92e9515..ec2a617 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,4 +1,4 @@ -AM_CFLAGS = -std=c99 @SLV2_CFLAGS@ @REDLAND_CFLAGS@ @RAPTOR_CFLAGS@ -DLIBSLV2_SOURCE +AM_CFLAGS = -std=c99 @LV2CORE_CFLAGS@ @SLV2_CFLAGS@ @REDLAND_CFLAGS@ @RAPTOR_CFLAGS@ -DLIBSLV2_SOURCE lib_LTLIBRARIES = libslv2.la libslv2_la_LIBADD = @REDLAND_LIBS@ @RAPTOR_LIBS@ -ldl diff --git a/utils/Makefile.am b/utils/Makefile.am index d263e25..f445519 100644 --- a/utils/Makefile.am +++ b/utils/Makefile.am @@ -1,6 +1,6 @@ EXTRA_DIST = ladspa.h -AM_CFLAGS = -std=c99 -I$(top_srcdir) @REDLAND_CFLAGS@ @SLV2_CFLAGS@ +AM_CFLAGS = -std=c99 -I$(top_srcdir) @REDLAND_CFLAGS@ @SLV2_CFLAGS@ @LV2CORE_CFLAGS@ bin_PROGRAMS = lv2_list lv2_inspect noinst_PROGRAMS = ladspa2lv2 |