ui.h

Go to the documentation of this file.

/*
  LV2 UI Extension
  Copyright 2009-2016 David Robillard <d@drobilla.net>
  Copyright 2006-2011 Lars Luthman <lars.luthman@gmail.com>
 
  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_UI_H
#define LV2_UI_H
 
#include <stdint.h>
 
#include "lv2.h"
#include "urid.h"
 
#define LV2_UI_URI    "http://lv2plug.in/ns/extensions/ui"  
#define LV2_UI_PREFIX LV2_UI_URI "#"                        
 
#define LV2_UI__CocoaUI          LV2_UI_PREFIX "CocoaUI"           
#define LV2_UI__Gtk3UI           LV2_UI_PREFIX "Gtk3UI"            
#define LV2_UI__GtkUI            LV2_UI_PREFIX "GtkUI"             
#define LV2_UI__PortNotification LV2_UI_PREFIX "PortNotification"  
#define LV2_UI__PortProtocol     LV2_UI_PREFIX "PortProtocol"      
#define LV2_UI__Qt4UI            LV2_UI_PREFIX "Qt4UI"             
#define LV2_UI__Qt5UI            LV2_UI_PREFIX "Qt5UI"             
#define LV2_UI__UI               LV2_UI_PREFIX "UI"                
#define LV2_UI__WindowsUI        LV2_UI_PREFIX "WindowsUI"         
#define LV2_UI__X11UI            LV2_UI_PREFIX "X11UI"             
#define LV2_UI__backgroundColor  LV2_UI_PREFIX "backgroundColor"   
#define LV2_UI__binary           LV2_UI_PREFIX "binary"            
#define LV2_UI__fixedSize        LV2_UI_PREFIX "fixedSize"         
#define LV2_UI__foregroundColor  LV2_UI_PREFIX "foregroundColor"   
#define LV2_UI__idleInterface    LV2_UI_PREFIX "idleInterface"     
#define LV2_UI__noUserResize     LV2_UI_PREFIX "noUserResize"      
#define LV2_UI__notifyType       LV2_UI_PREFIX "notifyType"        
#define LV2_UI__parent           LV2_UI_PREFIX "parent"            
#define LV2_UI__plugin           LV2_UI_PREFIX "plugin"            
#define LV2_UI__portIndex        LV2_UI_PREFIX "portIndex"         
#define LV2_UI__portMap          LV2_UI_PREFIX "portMap"           
#define LV2_UI__portNotification LV2_UI_PREFIX "portNotification"  
#define LV2_UI__portSubscribe    LV2_UI_PREFIX "portSubscribe"     
#define LV2_UI__protocol         LV2_UI_PREFIX "protocol"          
#define LV2_UI__floatProtocol    LV2_UI_PREFIX "floatProtocol"     
#define LV2_UI__peakProtocol     LV2_UI_PREFIX "peakProtocol"      
#define LV2_UI__requestValue     LV2_UI_PREFIX "requestValue"      
#define LV2_UI__resize           LV2_UI_PREFIX "resize"            
#define LV2_UI__scaleFactor      LV2_UI_PREFIX "scaleFactor"       
#define LV2_UI__showInterface    LV2_UI_PREFIX "showInterface"     
#define LV2_UI__touch            LV2_UI_PREFIX "touch"             
#define LV2_UI__ui               LV2_UI_PREFIX "ui"                
#define LV2_UI__updateRate       LV2_UI_PREFIX "updateRate"        
#define LV2_UI__windowTitle      LV2_UI_PREFIX "windowTitle"       

#define LV2UI_INVALID_PORT_INDEX ((uint32_t)-1)
 
#ifdef __cplusplus
extern "C" {
#else
#    include <stdbool.h>
#endif

typedef void* LV2UI_Widget;

typedef void* LV2UI_Handle;

typedef void* LV2UI_Controller;

typedef void* LV2UI_Feature_Handle;

typedef void (*LV2UI_Write_Function)(LV2UI_Controller controller,
                                     uint32_t         port_index,
                                     uint32_t         buffer_size,
                                     uint32_t         port_protocol,
                                     const void*      buffer);

typedef struct _LV2UI_Descriptor {
        const char* URI;

        LV2UI_Handle (*instantiate)(const struct _LV2UI_Descriptor* descriptor,
                                    const char*                     plugin_uri,
                                    const char*                     bundle_path,
                                    LV2UI_Write_Function            write_function,
                                    LV2UI_Controller                controller,
                                    LV2UI_Widget*                   widget,
                                    const LV2_Feature* const*       features);
 

        void (*cleanup)(LV2UI_Handle ui);

        void (*port_event)(LV2UI_Handle ui,
                           uint32_t     port_index,
                           uint32_t     buffer_size,
                           uint32_t     format,
                           const void*  buffer);

        const void* (*extension_data)(const char* uri);
} LV2UI_Descriptor;

typedef struct _LV2UI_Resize {
        LV2UI_Feature_Handle handle;

        int (*ui_resize)(LV2UI_Feature_Handle handle, int width, int height);
} LV2UI_Resize;

typedef struct _LV2UI_Port_Map {
        LV2UI_Feature_Handle handle;

        uint32_t (*port_index)(LV2UI_Feature_Handle handle, const char* symbol);
} LV2UI_Port_Map;

typedef struct _LV2UI_Port_Subscribe {
        LV2UI_Feature_Handle handle;

        uint32_t (*subscribe)(LV2UI_Feature_Handle      handle,
                              uint32_t                  port_index,
                              uint32_t                  port_protocol,
                              const LV2_Feature* const* features);

        uint32_t (*unsubscribe)(LV2UI_Feature_Handle      handle,
                                uint32_t                  port_index,
                                uint32_t                  port_protocol,
                                const LV2_Feature* const* features);
} LV2UI_Port_Subscribe;

typedef struct _LV2UI_Touch {
        LV2UI_Feature_Handle handle;

        void (*touch)(LV2UI_Feature_Handle handle,
                      uint32_t             port_index,
                      bool                 grabbed);
} LV2UI_Touch;

typedef enum {
        LV2UI_REQUEST_VALUE_SUCCESS,

        LV2UI_REQUEST_VALUE_BUSY,

        LV2UI_REQUEST_VALUE_ERR_UNKNOWN,

        LV2UI_REQUEST_VALUE_ERR_UNSUPPORTED
} LV2UI_Request_Value_Status;

typedef struct {
        LV2UI_Feature_Handle handle;

        LV2UI_Request_Value_Status (*request)(LV2UI_Feature_Handle      handle,
                                              LV2_URID                  key,
                                              LV2_URID                  type,
                                              const LV2_Feature* const* features);
 
} LV2UI_Request_Value;

typedef struct _LV2UI_Idle_Interface {
        int (*idle)(LV2UI_Handle ui);
} LV2UI_Idle_Interface;

typedef struct _LV2UI_Show_Interface {
        int (*show)(LV2UI_Handle ui);

        int (*hide)(LV2UI_Handle ui);
} LV2UI_Show_Interface;

typedef struct _LV2UI_Peak_Data {
        uint32_t period_start;

        uint32_t period_size;

        float peak;
} LV2UI_Peak_Data;

LV2_SYMBOL_EXPORT
const LV2UI_Descriptor* lv2ui_descriptor(uint32_t index);

typedef const LV2UI_Descriptor* (*LV2UI_DescriptorFunction)(uint32_t index);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LV2_UI_H */