source/includes/jackey.h

   1 /*
   2   Copyright 2014 David Robillard <http://drobilla.net>
   3
   4   Permission to use, copy, modify, and/or distribute this software for any
   5   purpose with or without fee is hereby granted, provided that the above
   6   copyright notice and this permission notice appear in all copies.
   7
   8   THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
   9   WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  10   MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  11   ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  12   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  13   ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  14   OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  15 */
  16
  17 /**
  18    The supported event types of an event port.
  19
  20    This is a kludge around Jack only supporting MIDI, particularly for OSC.
  21    This property is a comma-separated list of event types, currently "MIDI" or
  22    "OSC".  If this contains "OSC", the port may carry OSC bundles (first byte
  23    '#') or OSC messages (first byte '/').  Note that the "status byte" of both
  24    OSC events is not a valid MIDI status byte, so MIDI clients that check the
  25    status byte will gracefully ignore OSC messages if the user makes an
  26    inappropriate connection.
  27 */
  28 #define JACKEY_EVENT_TYPES "http://jackaudio.org/metadata/event-types"
  29
  30 /**
  31    The type of an audio signal.
  32
  33    This property allows audio ports to be tagged with a "meaning".  The value
  34    is a simple string.  Currently, the only type is "CV", for "control voltage"
  35    ports.  Hosts SHOULD be take care to not treat CV ports as audibile and send
  36    their output directly to speakers.  In particular, CV ports are not
  37    necessarily periodic at all and may have very high DC.
  38 */
  39 #define JACKEY_SIGNAL_TYPE "http://jackaudio.org/metadata/signal-type"
  40
  41 /**
  42    The name of the icon for the subject (typically client).
  43
  44    This is used for looking up icons on the system, possibly with many sizes or
  45    themes.  Icons should be searched for according to the freedesktop Icon
  46    Theme Specification:
  47
  48    http://standards.freedesktop.org/icon-theme-spec/icon-theme-spec-latest.html
  49 */
  50 #define JACKEY_ICON_NAME "http://jackaudio.org/metadata/icon-name"
  51
  52 /**
  53    Channel designation for a port.
  54
  55    This allows ports to be tagged with a meaningful designation like "left",
  56    "right", "lfe", etc.
  57
  58    The value MUST be a URI.  An extensive set of URIs for designating audio
  59    channels can be found at http://lv2plug.in/ns/ext/port-groups
  60 */
  61 #define JACKEY_DESIGNATION "http://lv2plug.in/ns/lv2core#designation"
  62
  63 /**
  64    Order for a port.
  65
  66    This is used to specify the best order to show ports in user interfaces.
  67    The value MUST be an integer.  There are no other requirements, so there may
  68    be gaps in the orders for several ports.  Applications should compare the
  69    orders of ports to determine their relative order, but must not assign any
  70    other relevance to order values.
  71 */
  72 #define JACKEY_ORDER "http://jackaudio.org/metadata/order"