lv2_plugin.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
/*
 * This file incorporates work covered by the following copyright and
 * permission notice:
 *
 * ---
 *
  Copyright 2007-2016 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 __PLUGINS_LV2_PLUGIN_H__
#define __PLUGINS_LV2_PLUGIN_H__
 
#include "zrythm-config.h"
 
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
 
#ifdef HAVE_ISATTY
#  include <unistd.h>
#endif
 
#include "dsp/port.h"
#include "dsp/position.h"
#include "plugins/lv2/ext/host_info.h"
#include "plugins/lv2/lv2_evbuf.h"
#include "plugins/lv2/lv2_external_ui.h"
#include "plugins/lv2/lv2_worker.h"
 
#include "zix/ring.h"
#include "zix/sem.h"
#include "zix/thread.h"
#include <lilv/lilv.h>
#include <lv2/data-access/data-access.h>
#include <lv2/log/log.h>
#include <lv2/options/options.h>
#include <lv2/state/state.h>
#include <lv2/urid/urid.h>
#include <sratom/sratom.h>
#include <suil/suil.h>
 
typedef struct Lv2Plugin         Lv2Plugin;
typedef struct _GtkWidget        GtkWidget;
typedef struct _GtkCheckMenuItem GtkCheckMenuItem;
typedef struct Port              Port;
typedef struct Plugin            Plugin;
typedef struct PluginDescriptor  PluginDescriptor;
 
#define LV2_PLUGIN_MAGIC 58173672
#define IS_LV2_PLUGIN(tr) (tr && tr->magic == LV2_PLUGIN_MAGIC)
 
#define LV2_ZRYTHM__defaultBank "https://lv2.zrythm.org#default-bank"
#define LV2_ZRYTHM__initPreset "https://lv2.zrythm.org#init-preset"
#define LV2_KX__externalUi \
  "http://kxstudio.sf.net/ns/lv2ext/" \
  "external-ui#Widget"
 
/* currently missing from the spec */
#ifndef LV2_CORE__enabled
#  define LV2_CORE__enabled LV2_CORE_PREFIX "enabled"
#endif
#ifndef LV2_CORE__isSideChain
#  define LV2_CORE__isSideChain LV2_CORE_PREFIX "isSideChain"
#endif
 
#define LV2_PARAM_MAX_STR_LEN 1200
 
#define lv2_plugin_is_in_active_project(self) \
  (plugin_is_in_active_project ((self)->plugin))
 
typedef struct Lv2Parameter
{
  LV2_URID urid;
 
  LV2_URID value_type_urid;
  bool     readable;
  bool     writable;
  char     symbol[LV2_PARAM_MAX_STR_LEN];
  char     label[LV2_PARAM_MAX_STR_LEN];
  char     comment[LV2_PARAM_MAX_STR_LEN];
 
  bool has_range;
 
  float minf;
  float maxf;
  float deff;
} Lv2Parameter;
 
typedef struct
{
  uint32_t index;
  uint32_t protocol;
  uint32_t size;
  uint8_t  body[];
} Lv2ControlChange;
 
typedef struct Lv2Plugin
{
  LV2_Feature map_feature;
  LV2_Feature unmap_feature;
  LV2_Feature make_path_temp_feature;
  LV2_Feature sched_feature;
  LV2_Feature state_sched_feature;
  LV2_Feature safe_restore_feature;
  LV2_Feature log_feature;
  LV2_Feature options_feature;
  LV2_Feature def_state_feature;
  LV2_Feature hard_rt_capable_feature;
  LV2_Feature data_access_feature;
  LV2_Feature instance_access_feature;
  LV2_Feature bounded_block_length_feature;
 
  const LV2_Feature * features[13];
 
  const LV2_Feature * state_features[7];
 
  LV2_Options_Option options[10];
 
  LV2_Extension_Data_Feature ext_data_feature;
 
  uint32_t comm_buffer_size;
 
  const LV2_Options_Interface * options_iface;
 
  LV2_Atom_Forge main_forge;
  LV2_Atom_Forge dsp_forge;
  Sratom * sratom;
  Sratom * ui_sratom;
  ZixRing * ui_to_plugin_events;
  ZixRing * plugin_to_ui_events;
  void * ui_event_buf;
  Lv2Worker worker;
  Lv2Worker state_worker;
  ZixSem work_lock;
  const LilvPlugin * lilv_plugin;
  LilvState * preset;
 
  LilvInstance * instance;
 
  SuilHost * suil_host;
  SuilInstance * suil_instance;
 
  char * temp_dir;
 
  uint32_t event_delta_t;
  uint32_t midi_event_id; 
  bool     exit;          
 
  bool request_update;
 
  bool safe_restore;
 
  bool has_default_state;
 
  int control_in;
 
  int enabled_in;
 
  ZixSem exit_sem;
 
  bool want_position;
 
  bool has_external_ui;
 
  LV2_External_UI_Widget * external_ui_widget;
 
  bool updating;
 
  LV2_URID_Map map;
 
  LV2_URID_Unmap unmap;
 
  SerdEnv * env;
 
  int rolling;
 
  unsigned_frame_t gframes;
 
  float bpm;
 
  Plugin * plugin;
 
  LV2_External_UI_Host extui;
 
  /* ---- plugin feature data ---- */
 
  LV2_State_Make_Path make_path_temp;
 
  LV2_Worker_Schedule sched;
 
  LV2_Worker_Schedule ssched;
 
  LV2_Log_Log llog;
 
  /* ---- end plugin feature data ---- */
 
  int magic;
 
} Lv2Plugin;
 
#if 0
static const cyaml_schema_field_t
  lv2_plugin_fields_schema[] =
{
  YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT (
    Lv2Plugin, ports, lv2_port_schema),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t
  lv2_plugin_schema =
{
  YAML_VALUE_PTR (
    Lv2Plugin, lv2_plugin_fields_schema),
};
#endif
 
NONNULL void
lv2_plugin_init_loaded (Lv2Plugin * self);
 
NONNULL PluginDescriptor *
lv2_plugin_create_descriptor_from_lilv (const LilvPlugin * lp);
 
NONNULL_ARGS (1, 2)
Lv2Plugin * lv2_plugin_new_from_uri (
  Plugin *     plugin,
  const char * uri,
  GError **    error);
 
NONNULL_ARGS (1)
int lv2_plugin_instantiate (
  Lv2Plugin * self,
  bool        use_state_file,
  char *      preset_uri,
  LilvState * state,
  GError **   error);
 
NONNULL Lv2Plugin *
lv2_plugin_new (Plugin * plugin);
 
NONNULL void
lv2_plugin_process (
  Lv2Plugin *                         self,
  const EngineProcessTimeInfo * const time_nfo);
 
NONNULL nframes_t
lv2_plugin_get_latency (Lv2Plugin * pl);
 
typedef enum Lv2PluginPickUiFlag
{
  LV2_PLUGIN_UI_WRAPPABLE,
 
  LV2_PLUGIN_UI_EXTERNAL,
 
  LV2_PLUGIN_UI_FOR_BRIDGING,
} Lv2PluginPickUiFlag;
 
NONNULL char *
lv2_plugin_has_deprecated_ui (const char * uri);
 
NONNULL bool
lv2_plugin_is_ui_supported (const char * pl_uri, const char * ui_uri);
 
void
lv2_plugin_get_uis (const char * pl_uri, char ** uris, int * num_uris);
 
bool
lv2_plugin_pick_ui (
  const LilvUIs *     uis,
  Lv2PluginPickUiFlag flag,
  const LilvUI **     out_ui,
  const LilvNode **   out_ui_type);
 
NONNULL char *
lv2_plugin_get_ui_class (const char * pl_uri, const char * ui_uri);
 
NONNULL char *
lv2_plugin_get_ui_bundle_uri (const char * pl_uri, const char * ui_uri);
 
NONNULL char *
lv2_plugin_get_ui_binary_uri (const char * pl_uri, const char * ui_uri);
 
bool
lv2_plugin_pick_most_preferable_ui (
  const char * plugin_uri,
  char **      out_ui,
  char **      out_ui_type,
  bool         allow_bridged,
  bool         print_result);
 
/* FIXME remove */
NONNULL bool
lv2_plugin_ui_type_is_external (const LilvNode * ui_type);
 
NONNULL bool
lv2_plugin_is_ui_external (const char * uri, const char * ui_uri, GError ** error);
 
void
lv2_plugin_set_control (
  Port *       port,
  uint32_t     size,
  LV2_URID     type,
  const void * body);
 
NONNULL Port *
lv2_plugin_get_property_port (Lv2Plugin * self, LV2_URID property);
 
const void *
lv2_plugin_get_port_value (
  const char * port_sym,
  void *       user_data,
  uint32_t *   size,
  uint32_t *   type);
 
NONNULL char *
lv2_plugin_get_library_path (Lv2Plugin * self);
 
NONNULL char *
lv2_plugin_get_abs_state_file_path (Lv2Plugin * self, bool is_backup);
 
NONNULL void
lv2_plugin_allocate_port_buffers (Lv2Plugin * plugin);
 
NONNULL int
lv2_plugin_activate (Lv2Plugin * self, bool activate);
 
NONNULL bool
lv2_plugin_can_cleanup (const char * uri);
 
NONNULL void
lv2_plugin_populate_banks (Lv2Plugin * self);
 
NONNULL int
lv2_plugin_cleanup (Lv2Plugin * self);
 
NONNULL void
lv2_plugin_free (Lv2Plugin * self);
 
#endif