aboutsummaryrefslogtreecommitdiff
path: root/jackey
diff options
context:
space:
mode:
authorHanspeter Portner <dev@open-music-kontrollers.ch>2016-03-26 16:15:45 +0100
committerHanspeter Portner <dev@open-music-kontrollers.ch>2016-03-26 16:15:45 +0100
commit4bed617dcd0f9f472fc14d38cbfa3f6f85465c82 (patch)
tree077545654256bc0a0d967b0cde084b2a25390e97 /jackey
parent98d5375b118e09527534a4f4c87dfbeb55195518 (diff)
parentc1561917f9850206ff208c529234273623ebbefa (diff)
downloadsynthpod-4bed617dcd0f9f472fc14d38cbfa3f6f85465c82.tar.xz
Add 'jackey/' from commit 'c1561917f9850206ff208c529234273623ebbefa'
git-subtree-dir: jackey git-subtree-mainline: 98d5375b118e09527534a4f4c87dfbeb55195518 git-subtree-split: c1561917f9850206ff208c529234273623ebbefa
Diffstat (limited to 'jackey')
-rw-r--r--jackey/LICENSE21
-rw-r--r--jackey/README.md18
-rw-r--r--jackey/jackey.h72
3 files changed, 111 insertions, 0 deletions
diff --git a/jackey/LICENSE b/jackey/LICENSE
new file mode 100644
index 00000000..668fda22
--- /dev/null
+++ b/jackey/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 David 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. \ No newline at end of file
diff --git a/jackey/README.md b/jackey/README.md
new file mode 100644
index 00000000..4f75109f
--- /dev/null
+++ b/jackey/README.md
@@ -0,0 +1,18 @@
+Jackey
+======
+
+Jackey (jack-key) is a simple define-only header that serves as an ad-hoc
+standard for Jack Metadata property keys. Using a single header for this
+coordination makes it simple to discover, use, and extend the keys used by Jack
+clients.
+
+It is not necessary to use this header, since keys are defined by their URI
+string, but developers are encouraged to use and contribute to this header to
+promote interoperability in the Jack ecoystem.
+
+There are no rules about the namespaces (e.g. domains) used for keys here, but
+developers SHOULD NOT define keys in others' domains, with the exception of
+http://jackaudio.org/metadata assuming the proposed key is not defined by Jack
+itself, or the master jackey.h.
+
+ -- David Robillard <d@drobilla.net>
diff --git a/jackey/jackey.h b/jackey/jackey.h
new file mode 100644
index 00000000..02a77357
--- /dev/null
+++ b/jackey/jackey.h
@@ -0,0 +1,72 @@
+/*
+ Copyright 2014 David Robillard <http://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.
+*/
+
+/**
+ The supported event types of an event port.
+
+ This is a kludge around Jack only supporting MIDI, particularly for OSC.
+ This property is a comma-separated list of event types, currently "MIDI" or
+ "OSC". If this contains "OSC", the port may carry OSC bundles (first byte
+ '#') or OSC messages (first byte '/'). Note that the "status byte" of both
+ OSC events is not a valid MIDI status byte, so MIDI clients that check the
+ status byte will gracefully ignore OSC messages if the user makes an
+ inappropriate connection.
+*/
+#define JACKEY_EVENT_TYPES "http://jackaudio.org/metadata/event-types"
+
+/**
+ The type of an audio signal.
+
+ This property allows audio ports to be tagged with a "meaning". The value
+ is a simple string. Currently, the only type is "CV", for "control voltage"
+ ports. Hosts SHOULD be take care to not treat CV ports as audibile and send
+ their output directly to speakers. In particular, CV ports are not
+ necessarily periodic at all and may have very high DC.
+*/
+#define JACKEY_SIGNAL_TYPE "http://jackaudio.org/metadata/signal-type"
+
+/**
+ The name of the icon for the subject (typically client).
+
+ This is used for looking up icons on the system, possibly with many sizes or
+ themes. Icons should be searched for according to the freedesktop Icon
+ Theme Specification:
+
+ http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
+*/
+#define JACKEY_ICON_NAME "http://jackaudio.org/metadata/icon-name"
+
+/**
+ Channel designation for a port.
+
+ This allows ports to be tagged with a meaningful designation like "left",
+ "right", "lfe", etc.
+
+ The value MUST be a URI. An extensive set of URIs for designating audio
+ channels can be found at http://lv2plug.in/ns/ext/port-groups
+*/
+#define JACKEY_DESIGNATION "http://lv2plug.in/ns/lv2core#designation"
+
+/**
+ Order for a port.
+
+ This is used to specify the best order to show ports in user interfaces.
+ The value MUST be an integer. There are no other requirements, so there may
+ be gaps in the orders for several ports. Applications should compare the
+ orders of ports to determine their relative order, but must not assign any
+ other relevance to order values.
+*/
+#define JACKEY_ORDER "http://jackaudio.org/metadata/order"