suil.h

Go to the documentation of this file.

/*
  Copyright 2011-2017 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.
*/
 
#ifndef SUIL_SUIL_H
#define SUIL_SUIL_H
 
#include "lv2/core/lv2.h"
 
#include <stdbool.h>
 
#ifdef _WIN32
#    define SUIL_LIB_IMPORT __declspec(dllimport)
#    define SUIL_LIB_EXPORT __declspec(dllexport)
#else
#    define SUIL_LIB_IMPORT __attribute__((visibility("default")))
#    define SUIL_LIB_EXPORT __attribute__((visibility("default")))
#endif
 
#ifdef SUIL_SHARED
#    ifdef SUIL_INTERNAL
#        define SUIL_API SUIL_LIB_EXPORT
#    else
#        define SUIL_API SUIL_LIB_IMPORT
#    endif
#else
#    define SUIL_API
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct SuilHostImpl SuilHost;
 
typedef struct SuilInstanceImpl SuilInstance;
 
typedef void* SuilHandle;
 
typedef void* SuilWidget;
 
typedef void* SuilController;
 
typedef void (*SuilPortWriteFunc)(
        SuilController controller,
        uint32_t       port_index,
        uint32_t       buffer_size,
        uint32_t       protocol,
        void const*    buffer);
 
typedef uint32_t (*SuilPortIndexFunc)(
        SuilController controller,
        const char*    port_symbol);
 
typedef uint32_t (*SuilPortSubscribeFunc)(
        SuilController            controller,
        uint32_t                  port_index,
        uint32_t                  protocol,
        const LV2_Feature* const* features);
 
typedef uint32_t (*SuilPortUnsubscribeFunc)(
        SuilController            controller,
        uint32_t                  port_index,
        uint32_t                  protocol,
        const LV2_Feature* const* features);
 
typedef void (*SuilTouchFunc)(
        SuilController controller,
        uint32_t       port_index,
        bool           grabbed);
 
typedef enum {
        SUIL_ARG_NONE
} SuilArg;
 
SUIL_API
void
suil_init(int* argc, char*** argv, SuilArg key, ...);
 
SUIL_API
SuilHost*
suil_host_new(SuilPortWriteFunc       write_func,
              SuilPortIndexFunc       index_func,
              SuilPortSubscribeFunc   subscribe_func,
              SuilPortUnsubscribeFunc unsubscribe_func);
 
SUIL_API
void
suil_host_set_touch_func(SuilHost*     host,
                         SuilTouchFunc touch_func);
 
SUIL_API
void
suil_host_free(SuilHost* host);
 
SUIL_API
unsigned
suil_ui_supported(const char* host_type_uri,
                  const char* ui_type_uri);
 
SUIL_API
SuilInstance*
suil_instance_new(SuilHost*                 host,
                  SuilController            controller,
                  const char*               container_type_uri,
                  const char*               plugin_uri,
                  const char*               ui_uri,
                  const char*               ui_type_uri,
                  const char*               ui_bundle_path,
                  const char*               ui_binary_path,
                  const LV2_Feature* const* features);
 
SUIL_API
void
suil_instance_free(SuilInstance* instance);
 
SUIL_API
SuilHandle
suil_instance_get_handle(SuilInstance* instance);
 
SUIL_API
SuilWidget
suil_instance_get_widget(SuilInstance* instance);
 
SUIL_API
void
suil_instance_port_event(SuilInstance* instance,
                         uint32_t      port_index,
                         uint32_t      buffer_size,
                         uint32_t      format,
                         const void*   buffer);
 
SUIL_API
const void*
suil_instance_extension_data(SuilInstance* instance,
                             const char*   uri);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* SUIL_SUIL_H */