aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/options
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2022-07-07 18:59:32 -0400
committerDavid Robillard <d@drobilla.net>2022-07-17 18:14:00 -0400
commit1eccbe4355685b322194df72b5de2382d5290b3b (patch)
tree0677b5c2f577a5024c351a164527f4bdd91a639b /lv2/options
parentd4a970f6962dda28133290194832b726b566ddab (diff)
downloadlv2-1eccbe4355685b322194df72b5de2382d5290b3b.tar.xz
Rearrange source tree to be directly usable by dependants
This allows the LV2 source distribution to be used as an include path for compilers and an LV2_PATH for applications, at the expense of self-contained bundles. That's a nice idea, but it made LV2 itself weird and annoying to depend on. This rearranges things so that directories in the source tree correspond more closely to installation directories. To make this possible, the "aux" directory in the documentation output has been changed to "style", to avoid the reserved name "aux" on Windows.
Diffstat (limited to 'lv2/options')
-rw-r--r--lv2/options/manifest.ttl9
-rw-r--r--lv2/options/meson.build40
-rw-r--r--lv2/options/options.h149
-rw-r--r--lv2/options/options.meta.ttl129
-rw-r--r--lv2/options/options.ttl45
5 files changed, 0 insertions, 372 deletions
diff --git a/lv2/options/manifest.ttl b/lv2/options/manifest.ttl
deleted file mode 100644
index 18db448..0000000
--- a/lv2/options/manifest.ttl
+++ /dev/null
@@ -1,9 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/options>
- a lv2:Specification ;
- lv2:minorVersion 1 ;
- lv2:microVersion 4 ;
- rdfs:seeAlso <options.ttl> .
-
diff --git a/lv2/options/meson.build b/lv2/options/meson.build
deleted file mode 100644
index 5644b87..0000000
--- a/lv2/options/meson.build
+++ /dev/null
@@ -1,40 +0,0 @@
-# Copyright 2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: CC0-1.0 OR ISC
-
-name = 'options'
-path = 'ns' / 'ext' / 'options'
-
-options_data = files(
- 'options.meta.ttl',
- 'options.ttl',
- 'manifest.ttl',
-)
-
-headers = files(
- 'options.h',
-)
-
-# Install specification bundle
-install_data(options_data, install_dir: lv2dir / name + '.lv2')
-install_headers(headers, subdir: 'lv2' / name)
-if get_option('old_headers')
- install_headers(headers, subdir: 'lv2' / 'lv2plug.in' / path)
-endif
-
-# Build documentation
-if build_docs
- lv2_options_docs = custom_target(
- name + '.html',
- command: lv2specgen_command_prefix + [
- '--docdir=../../html',
- '--style-uri=../../aux/style.css',
- '@INPUT@',
- '@OUTPUT@',
- ],
- depends: doc_deps,
- input: files('options.ttl'),
- install: true,
- install_dir: lv2_docdir / 'ns' / 'ext',
- output: name + '.html',
- )
-endif
diff --git a/lv2/options/options.h b/lv2/options/options.h
deleted file mode 100644
index 06e5db4..0000000
--- a/lv2/options/options.h
+++ /dev/null
@@ -1,149 +0,0 @@
-/*
- Copyright 2012-2016 David Robillard <d@drobilla.net>
-
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted, provided that the above
- copyright notice and this permission notice appear in all copies.
-
- THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
-*/
-
-#ifndef LV2_OPTIONS_H
-#define LV2_OPTIONS_H
-
-/**
- @defgroup options Options
- @ingroup lv2
-
- Instantiation time options.
-
- See <http://lv2plug.in/ns/ext/options> for details.
-
- @{
-*/
-
-#include "lv2/core/lv2.h"
-#include "lv2/urid/urid.h"
-
-#include <stdint.h>
-
-// clang-format off
-
-#define LV2_OPTIONS_URI "http://lv2plug.in/ns/ext/options" ///< http://lv2plug.in/ns/ext/options
-#define LV2_OPTIONS_PREFIX LV2_OPTIONS_URI "#" ///< http://lv2plug.in/ns/ext/options#
-
-#define LV2_OPTIONS__Option LV2_OPTIONS_PREFIX "Option" ///< http://lv2plug.in/ns/ext/options#Option
-#define LV2_OPTIONS__interface LV2_OPTIONS_PREFIX "interface" ///< http://lv2plug.in/ns/ext/options#interface
-#define LV2_OPTIONS__options LV2_OPTIONS_PREFIX "options" ///< http://lv2plug.in/ns/ext/options#options
-#define LV2_OPTIONS__requiredOption LV2_OPTIONS_PREFIX "requiredOption" ///< http://lv2plug.in/ns/ext/options#requiredOption
-#define LV2_OPTIONS__supportedOption LV2_OPTIONS_PREFIX "supportedOption" ///< http://lv2plug.in/ns/ext/options#supportedOption
-
-// clang-format on
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- The context of an Option, which defines the subject it applies to.
-*/
-typedef enum {
- /**
- This option applies to the instance itself. The subject must be
- ignored.
- */
- LV2_OPTIONS_INSTANCE,
-
- /**
- This option applies to some named resource. The subject is a URI mapped
- to an integer (a LV2_URID, like the key)
- */
- LV2_OPTIONS_RESOURCE,
-
- /**
- This option applies to some blank node. The subject is a blank node
- identifier, which is valid only within the current local scope.
- */
- LV2_OPTIONS_BLANK,
-
- /**
- This option applies to a port on the instance. The subject is the
- port's index.
- */
- LV2_OPTIONS_PORT
-} LV2_Options_Context;
-
-/**
- An option.
-
- This is a property with a subject, also known as a triple or statement.
-
- This struct is useful anywhere a statement needs to be passed where no
- memory ownership issues are present (since the value is a const pointer).
-
- Options can be passed to an instance via the feature LV2_OPTIONS__options
- with data pointed to an array of options terminated by a zeroed option, or
- accessed/manipulated using LV2_Options_Interface.
-*/
-typedef struct {
- LV2_Options_Context context; /**< Context (type of subject). */
- uint32_t subject; /**< Subject. */
- LV2_URID key; /**< Key (property). */
- uint32_t size; /**< Size of value in bytes. */
- LV2_URID type; /**< Type of value (datatype). */
- const void* value; /**< Pointer to value (object). */
-} LV2_Options_Option;
-
-/** A status code for option functions. */
-typedef enum {
- LV2_OPTIONS_SUCCESS = 0u, /**< Completed successfully. */
- LV2_OPTIONS_ERR_UNKNOWN = 1u, /**< Unknown error. */
- LV2_OPTIONS_ERR_BAD_SUBJECT = 1u << 1u, /**< Invalid/unsupported subject. */
- LV2_OPTIONS_ERR_BAD_KEY = 1u << 2u, /**< Invalid/unsupported key. */
- LV2_OPTIONS_ERR_BAD_VALUE = 1u << 3u /**< Invalid/unsupported value. */
-} LV2_Options_Status;
-
-/**
- Interface for dynamically setting options (LV2_OPTIONS__interface).
-*/
-typedef struct {
- /**
- Get the given options.
-
- Each element of the passed options array MUST have type, subject, and
- key set. All other fields (size, type, value) MUST be initialised to
- zero, and are set to the option value if such an option is found.
-
- This function is in the "instantiation" LV2 threading class, so no other
- instance functions may be called concurrently.
-
- @return Bitwise OR of LV2_Options_Status values.
- */
- uint32_t (*get)(LV2_Handle instance, LV2_Options_Option* options);
-
- /**
- Set the given options.
-
- This function is in the "instantiation" LV2 threading class, so no other
- instance functions may be called concurrently.
-
- @return Bitwise OR of LV2_Options_Status values.
- */
- uint32_t (*set)(LV2_Handle instance, const LV2_Options_Option* options);
-} LV2_Options_Interface;
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
-/**
- @}
-*/
-
-#endif /* LV2_OPTIONS_H */
diff --git a/lv2/options/options.meta.ttl b/lv2/options/options.meta.ttl
deleted file mode 100644
index 838b0b9..0000000
--- a/lv2/options/options.meta.ttl
+++ /dev/null
@@ -1,129 +0,0 @@
-@prefix dcs: <http://ontologi.es/doap-changeset#> .
-@prefix doap: <http://usefulinc.com/ns/doap#> .
-@prefix foaf: <http://xmlns.com/foaf/0.1/> .
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix opts: <http://lv2plug.in/ns/ext/options#> .
-@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
-@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
-
-<http://lv2plug.in/ns/ext/options>
- a doap:Project ;
- doap:name "LV2 Options" ;
- doap:shortdesc "Runtime options for LV2 plugins and UIs." ;
- doap:created "2012-08-20" ;
- doap:developer <http://drobilla.net/drobilla#me> ;
- doap:release [
- doap:revision "1.4" ;
- doap:created "2019-02-03" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.16.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Relax range of opts:requiredOption and opts:supportedOption"
- ]
- ]
- ] , [
- doap:revision "1.2" ;
- doap:created "2013-01-10" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.4.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Set the range of opts:requiredOption and opts:supportedOption to opts:Option."
- ]
- ]
- ] , [
- doap:revision "1.0" ;
- doap:created "2012-10-14" ;
- doap:file-release <http://lv2plug.in/spec/lv2-1.2.0.tar.bz2> ;
- dcs:blame <http://drobilla.net/drobilla#me> ;
- dcs:changeset [
- dcs:item [
- rdfs:label "Initial release."
- ]
- ]
- ] ;
- lv2:documentation """
-
-This extension defines a facility for <q>options</q>, which are values the host
-passes to a plugin or UI at run time.
-
-There are two facilities for passing options to an instance: opts:options
-allows passing options at instantiation time, and the opts:interface interface
-allows options to be dynamically set and retrieved after instantiation.
-
-Note that this extension is only for allowing hosts to configure plugins, and
-is not a <q>live</q> control mechanism. For real-time control, use event-based
-control via an atom:AtomPort with an atom:Sequence buffer.
-
-Instances may indicate they require an option with the opts:requiredOption
-property, or that they optionally support an option with the
-opts:supportedOption property.
-
-"""^^lv2:Markdown .
-
-opts:Option
- lv2:documentation """
-
-It is not required for a property to explicitly be an Option in order to be
-used as such. However, properties which are primarily intended for use as
-options, or are at least particularly useful as options, should be explicitly
-given this type for documentation purposes, and to assist hosts in discovering
-option definitions.
-
-"""^^lv2:Markdown .
-
-opts:interface
- lv2:documentation """
-
-An interface (LV2_Options_Interface) for dynamically setting and getting
-options. Note that this is intended for use by the host for configuring
-plugins only, and is not a <q>live</q> plugin control mechanism.
-
-The plugin data file should advertise this interface like so:
-
- :::turtle
- @prefix opts: <http://lv2plug.in/ns/ext/options#> .
-
- <plugin>
- a lv2:Plugin ;
- lv2:extensionData opts:interface .
-
-"""^^lv2:Markdown .
-
-opts:options
- lv2:documentation """
-
-To implement this feature, hosts MUST pass an LV2_Feature to the appropriate
-instantiate method with this URI and data pointed to an array of
-LV2_Options_Option terminated by an element with both key and value set to
-zero. The instance should cast this data pointer to `const
-LV2_Options_Option*` and scan the array for any options of interest. The
-instance MUST NOT modify the options array in any way.
-
-Note that requiring this feature may reduce the number of compatible hosts.
-Unless some options are strictly required by the instance, this feature SHOULD
-be listed as an lv2:optionalFeature.
-
-"""^^lv2:Markdown .
-
-opts:requiredOption
- lv2:documentation """
-
-The host MUST pass a value for the specified option via opts:options during
-instantiation.
-
-Note that use of this property may reduce the number of compatible hosts.
-Wherever possible, it is better to list options with opts:supportedOption and
-fall back to a reasonable default value if it is not provided.
-
-"""^^lv2:Markdown .
-
-opts:supportedOption
- lv2:documentation """
-
-The host SHOULD provide a value for the specified option if one is known, or
-provide the user an opportunity to specify one if possible.
-
-"""^^lv2:Markdown .
-
diff --git a/lv2/options/options.ttl b/lv2/options/options.ttl
deleted file mode 100644
index 78defef..0000000
--- a/lv2/options/options.ttl
+++ /dev/null
@@ -1,45 +0,0 @@
-@prefix lv2: <http://lv2plug.in/ns/lv2core#> .
-@prefix opts: <http://lv2plug.in/ns/ext/options#> .
-@prefix owl: <http://www.w3.org/2002/07/owl#> .
-@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#> .
-
-<http://lv2plug.in/ns/ext/options>
- a owl:Ontology ;
- rdfs:label "LV2 Options" ;
- rdfs:comment "Runtime options for LV2 plugins and UIs." ;
- rdfs:seeAlso <options.h> ,
- <options.meta.ttl> ;
- owl:imports <http://lv2plug.in/ns/lv2core> .
-
-opts:Option
- a rdfs:Class ;
- rdfs:label "Option" ;
- rdfs:subClassOf rdf:Property ;
- rdfs:comment "A value for a static option passed to an instance." .
-
-opts:interface
- a lv2:ExtensionData ;
- rdfs:label "interface" ;
- rdfs:comment "An interface for dynamically setting and getting options." .
-
-opts:options
- a lv2:Feature ;
- rdfs:label "options" ;
- rdfs:comment "The feature used to provide options to an instance." .
-
-opts:requiredOption
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range rdf:Property ;
- rdfs:label "required option" ;
- rdfs:comment "An option required by the instance to function at all." .
-
-opts:supportedOption
- a rdf:Property ,
- owl:ObjectProperty ;
- rdfs:range rdf:Property ;
- rdfs:label "supported option" ;
- rdfs:comment "An option supported or by the instance." .
-