source/includes/lv2/inline-display.h

   1 /*
   2   Copyright 2012 David Robillard <http://drobilla.net>
   3   Copyright 2016 Robin Gareus <robin@gareus.org>
   4
   5   Permission to use, copy, modify, and/or distribute this software for any
   6   purpose with or without fee is hereby granted, provided that the above
   7   copyright notice and this permission notice appear in all copies.
   8
   9   THIS SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10   WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11   MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12   ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13   WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14   ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15   OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 */
  17
  18 /**
  19    @defgroup inlinedisplay Inline-Display
  20
  21    Support for displaying a miniaturized, non-interactive view
  22    in the host's mixer strip.
  23
  24    @{
  25 */
  26
  27 #ifndef LV2_INLINE_DISPLAY_H
  28 #define LV2_INLINE_DISPLAY_H
  29
  30 #include <stdint.h>
  31
  32 #include "lv2.h"
  33
  34 #define LV2_INLINEDISPLAY_URI "http://harrisonconsoles.com/lv2/inlinedisplay"
  35 #define LV2_INLINEDISPLAY_PREFIX LV2_INLINEDISPLAY_URI "#"
  36 #define LV2_INLINEDISPLAY__interface LV2_INLINEDISPLAY_PREFIX "interface"
  37 #define LV2_INLINEDISPLAY__queue_draw LV2_INLINEDISPLAY_PREFIX "queue_draw"
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /** Opaque handle for LV2_Inline_Display::queue_draw() */
  44 typedef void* LV2_Inline_Display_Handle;
  45
  46 /** raw image pixmap format is ARGB32,
  47  * the data pointer is owned by the plugin and must be valid
  48  * from the first call to render until cleanup.
  49  */
  50 typedef struct {
  51         unsigned char *data;
  52         int width;
  53         int height;
  54         int stride;
  55 } LV2_Inline_Display_Image_Surface;
  56
  57 /** a LV2 Feature provided by the Host to the plugin
  58  *
  59  * This allows a the plugin during in realtime context to
  60  * invalidate the currently displayed data and request from
  61  * the host to call render() as soon as feasible.
  62  */
  63 typedef struct {
  64         /** Opaque host data */
  65         LV2_Inline_Display_Handle handle;
  66         /** Request from run() that the host should call render() at a later
  67          * time to update the inline display
  68          */
  69         void (*queue_draw)(LV2_Inline_Display_Handle handle);
  70 } LV2_Inline_Display;
  71
  72 /**
  73  * Plugin Inline-Display Interface.
  74  */
  75 typedef struct {
  76         /**
  77          * The render method. This is called by the host in the main GUI thread
  78          * (non realtime, the context with access to graphics drawing APIs).
  79          *
  80          * The data pointer is owned by the plugin and must be valid
  81          * from the first call to render until cleanup.
  82          *
  83          * The host specifies a maxium available area for the plugin to draw.
  84          * the returned Image Surface contains the actual area which
  85          * the plugin allocated.
  86          *
  87          * @param instance The LV2 instance
  88          * @param w the max available width
  89          * @param h the max available height
  90          * @return pointer to a LV2_Inline_Display_Image_Surface or NULL
  91          */
  92         const LV2_Inline_Display_Image_Surface* (*render)(
  93                                                  LV2_Handle instance,
  94                                                  uint32_t w, uint32_t h);
  95 } LV2_Inline_Display_Interface;
  96
  97 #ifdef __cplusplus
  98 }  /* extern "C" */
  99 #endif
 100
 101 #endif  /* LV2_INLINE_DISPLAY_H */
 102
 103 /**
 104    @}
 105 */