libs/ardour/ardour/lv2_extensions.h

   1 /*
   2   Copyright 2016 Robin Gareus <robin@gareus.org>
   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 #ifndef _ardour_lv2_extensions_h_
  18 #define _ardour_lv2_extensions_h_
  19
  20 #include "lv2/lv2plug.in/ns/lv2core/lv2.h"
  21
  22 /**
  23    @defgroup inlinedisplay Inline-Display
  24
  25    Support for displaying a miniaturized generic view
  26          directly in the host's Mixer Window.
  27
  28    @{
  29 */
  30
  31 #define LV2_INLINEDISPLAY_URI "http://harrisonconsoles.com/lv2/inlinedisplay"
  32 #define LV2_INLINEDISPLAY_PREFIX LV2_INLINEDISPLAY_URI "#"
  33 #define LV2_INLINEDISPLAY__interface LV2_INLINEDISPLAY_PREFIX "interface"
  34 #define LV2_INLINEDISPLAY__queue_draw LV2_INLINEDISPLAY_PREFIX "queue_draw"
  35
  36 /** Opaque handle for LV2_Inline_Display::queue_draw() */
  37 typedef void* LV2_Inline_Display_Handle;
  38
  39 /** raw image pixmap format is ARGB32,
  40  * the data pointer is owned by the plugin and must be valid
  41  * from the first call to render until cleanup.
  42  */
  43 typedef struct {
  44         unsigned char *data;
  45         int width;
  46         int height;
  47         int stride;
  48 } LV2_Inline_Display_Image_Surface;
  49
  50 /** a LV2 Feature provided by the Host to the plugin */
  51 typedef struct {
  52         /** Opaque host data */
  53         LV2_Inline_Display_Handle handle;
  54         /** Request from run() that the host should call render() at a later time
  55          * to update the inline display */
  56         void (*queue_draw)(LV2_Inline_Display_Handle handle);
  57 } LV2_Inline_Display;
  58
  59 /**
  60  * Plugin Inline-Display Interface.
  61  */
  62 typedef struct {
  63         /**
  64          * The render method. This is called by the host in a non-realtime context,
  65          * usually the main GUI thread.
  66          * The data pointer is owned by the plugin and must be valid
  67          * from the first call to render until cleanup.
  68          *
  69          * @param instance The LV2 instance
  70          * @param w the max available width
  71          * @param h the max available height
  72          * @return pointer to a LV2_Inline_Display_Image_Surface or NULL
  73          */
  74         LV2_Inline_Display_Image_Surface* (*render)(LV2_Handle instance, uint32_t w, uint32_t h);
  75 } LV2_Inline_Display_Interface;
  76
  77 /**
  78    @}
  79 */
  80
  81 /**
  82    @defgroup automate Self-Automation
  83
  84    Support for plugins to write automation data via Atom Events
  85
  86    @{
  87 */
  88
  89 #define LV2_AUTOMATE_URI "http://ardour.org/lv2/automate"
  90 #define LV2_AUTOMATE_URI_PREFIX LV2_AUTOMATE_URI "#"
  91 /** an lv2:optionalFeature */
  92 #define LV2_AUTOMATE_URI__can_write LV2_AUTOMATE_URI_PREFIX "canWriteAutomatation"
  93 /** atom:supports */
  94 #define LV2_AUTOMATE_URI__control LV2_AUTOMATE_URI_PREFIX "automationControl"
  95 /** lv2:portProperty */
  96 #define LV2_AUTOMATE_URI__controlled LV2_AUTOMATE_URI_PREFIX "automationControlled"
  97
  98 /** atom messages */
  99 #define LV2_AUTOMATE_URI__event LV2_AUTOMATE_URI_PREFIX "event"
 100 #define LV2_AUTOMATE_URI__setup LV2_AUTOMATE_URI_PREFIX "setup"
 101 #define LV2_AUTOMATE_URI__finalize LV2_AUTOMATE_URI_PREFIX "finalize"
 102 #define LV2_AUTOMATE_URI__start LV2_AUTOMATE_URI_PREFIX "start"
 103 #define LV2_AUTOMATE_URI__end LV2_AUTOMATE_URI_PREFIX "end"
 104 #define LV2_AUTOMATE_URI__parameter LV2_AUTOMATE_URI_PREFIX "parameter"
 105 #define LV2_AUTOMATE_URI__value LV2_AUTOMATE_URI_PREFIX "value"
 106
 107 /**
 108    @}
 109 */
 110
 111 /**
 112    @defgroup license License-Report
 113
 114    Allow for commercial LV2 to report their
 115          licensing status.
 116
 117    @{
 118 */
 119
 120 #define LV2_PLUGINLICENSE_URI "http://harrisonconsoles.com/lv2/license"
 121 #define LV2_PLUGINLICENSE_PREFIX LV2_INLINEDISPLAY_URI "#"
 122 #define LV2_PLUGINLICENSE__interface LV2_INLINEDISPLAY_PREFIX "interface"
 123
 124 typedef struct _LV2_License_Interface {
 125         /* @return -1 if no license is needed; 0 if unlicensed, 1 if licensed */
 126         int   (*is_licensed)(LV2_Handle instance);
 127         /* @return a string copy of the licensee name if licensed, or NULL, the caller needs to free this */
 128         char* (*licensee)(LV2_Handle instance);
 129         /* @return a URI identifying the plugin-bundle or plugin for which a given license is valid */
 130         const char* (*product_uri)(LV2_Handle instance);
 131         /* @return human readable product name for the URI */
 132         const char* (*product_name)(LV2_Handle instance);
 133         /* @return link to website or webstore */
 134         const char* (*store_url)(LV2_Handle instance);
 135 } LV2_License_Interface;
 136
 137 /**
 138    @}
 139 */
 140
 141 #endif