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.
 
 SPDX-License-Identifier: ISC
*/
 
#include "zrythm-config.h"
 
#ifndef HAVE_SUIL
 
#ifndef SUIL_SUIL_H
#define SUIL_SUIL_H
 
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <stdbool.h>
#include <stdint.h>
 
#include "lv2/core/lv2.h"
#include "lv2/ui/ui.h"
 
#ifdef _WOE32
#include <windows.h>
#endif
#include <dlfcn.h>
 
#include <gtk/gtk.h>
 
#define GTK2_UI_URI  LV2_UI__GtkUI
#define GTK3_UI_URI  LV2_UI__Gtk3UI
#define GTK4_UI_URI  LV2_UI__Gtk4UI
#define QT4_UI_URI   LV2_UI__Qt4UI
#define QT5_UI_URI   LV2_UI__Qt5UI
#define X11_UI_URI   LV2_UI__X11UI
#define WIN_UI_URI   LV2_UI_PREFIX "WindowsUI"
#define COCOA_UI_URI LV2_UI__CocoaUI
 
#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;
 
void
suil_init(int* argc, char*** argv, SuilArg key, ...);
 
SuilHost*
suil_host_new(SuilPortWriteFunc       write_func,
              SuilPortIndexFunc       index_func,
              SuilPortSubscribeFunc   subscribe_func,
              SuilPortUnsubscribeFunc unsubscribe_func);
 
void
suil_host_set_touch_func(SuilHost*     host,
                         SuilTouchFunc touch_func);
 
void
suil_host_free(SuilHost* host);
 
unsigned
suil_ui_supported(const char* host_type_uri,
                  const char* ui_type_uri);
 
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);
 
void
suil_instance_free(SuilInstance* instance);
 
SuilHandle
suil_instance_get_handle(SuilInstance* instance);
 
SuilWidget
suil_instance_get_widget(SuilInstance* instance);
 
void
suil_instance_port_event(SuilInstance* instance,
                         uint32_t      port_index,
                         uint32_t      buffer_size,
                         uint32_t      format,
                         const void*   buffer);
 
const void*
suil_instance_extension_data(SuilInstance* instance,
                             const char*   uri);
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#include "lv2/ui/ui.h"
 
#define SUIL_ERRORF(fmt, ...) g_warning("suil error: " fmt, __VA_ARGS__)
 
struct SuilHostImpl {
  SuilPortWriteFunc       write_func;
  SuilPortIndexFunc       index_func;
  SuilPortSubscribeFunc   subscribe_func;
  SuilPortUnsubscribeFunc unsubscribe_func;
  SuilTouchFunc           touch_func;
  void*                   gtk_lib;
  int                     argc;
  char**                  argv;
};
 
struct _SuilWrapper;
 
typedef void (*SuilWrapperFreeFunc)(struct _SuilWrapper*);
 
typedef int (*SuilWrapperWrapFunc)(struct _SuilWrapper* wrapper,
                                   SuilInstance*        instance);
 
typedef struct _SuilWrapper {
  SuilWrapperWrapFunc wrap;
  SuilWrapperFreeFunc free;
  void*               impl;
  LV2UI_Resize        resize;
} SuilWrapper;
 
struct SuilInstanceImpl {
  void*                   lib_handle;
  const LV2UI_Descriptor* descriptor;
  LV2UI_Handle            handle;
  SuilWrapper*            wrapper;
  LV2_Feature**           features;
  LV2UI_Port_Map          port_map;
  LV2UI_Port_Subscribe    port_subscribe;
  LV2UI_Touch             touch;
  SuilWidget              ui_widget;
  SuilWidget              host_widget;
};
 
typedef SuilWrapper* (*SuilWrapperNewFunc)(SuilHost*      host,
                                           const char*    host_type_uri,
                                           const char*    ui_type_uri,
                                           LV2_Feature*** features,
                                           unsigned       n_features);
 
SuilWrapper*
suil_wrapper_new_x11 (SuilHost*      host,
                 const char*    host_type_uri,
                 const char*    ui_type_uri,
                 LV2_Feature*** features,
                 unsigned       n_features);
 
#ifdef __cplusplus
extern "C" {
#endif
SuilWrapper*
suil_wrapper_new_qt5 (SuilHost*      host,
                 const char*    host_type_uri,
                 const char*    ui_type_uri,
                 LV2_Feature*** features,
                 unsigned       n_features);
 
SuilWrapper*
suil_wrapper_new_woe (
  SuilHost*      host,
  const char*    host_type_uri,
  const char*    ui_type_uri,
  LV2_Feature*** features,
  unsigned       n_features);
 
SuilWrapper*
suil_wrapper_new_cocoa (
  SuilHost*      host,
  const char*    host_type_uri,
  const char*    ui_type_uri,
  LV2_Feature*** features,
  unsigned       n_features);
#ifdef __cplusplus
} // end extern "C"
#endif
 
void
suil_host_init(void);
 
 
typedef void (*SuilVoidFunc)(void);
 
static inline SuilVoidFunc
suil_dlfunc(void* handle, const char* symbol)
{
#ifdef _WOE32
   return (SuilVoidFunc)GetProcAddress((HMODULE)handle, (LPCSTR) symbol);
#else
  typedef SuilVoidFunc (*VoidFuncGetter)(void*, const char*);
  VoidFuncGetter dlfunc = (VoidFuncGetter)dlsym;
  return dlfunc(handle, symbol);
#endif
}
 
static inline void
suil_add_feature(LV2_Feature*** features,
                 unsigned*      n,
                 const char*    uri,
                 void*          data)
{
  for (unsigned i = 0; i < *n && (*features)[i]; ++i) {
    if (!strcmp((*features)[i]->URI, uri)) {
      (*features)[i]->data = data;
      return;
    }
  }
 
  *features = (LV2_Feature**)realloc(*features,
                                     sizeof(LV2_Feature*) * (*n + 2));
 
  (*features)[*n]       = (LV2_Feature*)malloc(sizeof(LV2_Feature));
  (*features)[*n]->URI  = uri;
  (*features)[*n]->data = data;
  (*features)[*n + 1]   = NULL;
  *n += 1;
}
 
#endif /* SUIL_SUIL_H */
 
#endif /* ifndef HAVE_SUIL */