plugin_descriptor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2021 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __PLUGINS_PLUGIN_DESCRIPTOR_H__
#define __PLUGINS_PLUGIN_DESCRIPTOR_H__
 
#include "zrythm-config.h"
 
#include "utils/types.h"
 
#include <gio/gio.h>
#include <glib/gi18n.h>
 
#include <CarlaBackend.h>
 
TYPEDEF_STRUCT_UNDERSCORED (WrappedObjectWithChangeSignal);
enum class TrackType;
enum class ZPluginSlotType;
 
#define PLUGIN_DESCRIPTOR_SCHEMA_VERSION 1
 
#ifdef __cplusplus
enum class ZPluginCategory
#else
typedef enum
#endif
{
  Z_PLUGIN_CATEGORY_NONE,
  Z_PLUGIN_CATEGORY_DELAY,
  Z_PLUGIN_CATEGORY_REVERB,
  Z_PLUGIN_CATEGORY_DISTORTION,
  Z_PLUGIN_CATEGORY_WAVESHAPER,
  Z_PLUGIN_CATEGORY_DYNAMICS,
  Z_PLUGIN_CATEGORY_AMPLIFIER,
  Z_PLUGIN_CATEGORY_COMPRESSOR,
  Z_PLUGIN_CATEGORY_ENVELOPE,
  Z_PLUGIN_CATEGORY_EXPANDER,
  Z_PLUGIN_CATEGORY_GATE,
  Z_PLUGIN_CATEGORY_LIMITER,
  Z_PLUGIN_CATEGORY_FILTER,
  Z_PLUGIN_CATEGORY_ALLPASS_FILTER,
  Z_PLUGIN_CATEGORY_BANDPASS_FILTER,
  Z_PLUGIN_CATEGORY_COMB_FILTER,
  Z_PLUGIN_CATEGORY_EQ,
  Z_PLUGIN_CATEGORY_MULTI_EQ,
  Z_PLUGIN_CATEGORY_PARA_EQ,
  Z_PLUGIN_CATEGORY_HIGHPASS_FILTER,
  Z_PLUGIN_CATEGORY_LOWPASS_FILTER,
  Z_PLUGIN_CATEGORY_GENERATOR,
  Z_PLUGIN_CATEGORY_CONSTANT,
  Z_PLUGIN_CATEGORY_INSTRUMENT,
  Z_PLUGIN_CATEGORY_OSCILLATOR,
  Z_PLUGIN_CATEGORY_MIDI,
  Z_PLUGIN_CATEGORY_MODULATOR,
  Z_PLUGIN_CATEGORY_CHORUS,
  Z_PLUGIN_CATEGORY_FLANGER,
  Z_PLUGIN_CATEGORY_PHASER,
  Z_PLUGIN_CATEGORY_SIMULATOR,
  Z_PLUGIN_CATEGORY_SIMULATOR_REVERB,
  Z_PLUGIN_CATEGORY_SPATIAL,
  Z_PLUGIN_CATEGORY_SPECTRAL,
  Z_PLUGIN_CATEGORY_PITCH,
  Z_PLUGIN_CATEGORY_UTILITY,
  Z_PLUGIN_CATEGORY_ANALYZER,
  Z_PLUGIN_CATEGORY_CONVERTER,
  Z_PLUGIN_CATEGORY_FUNCTION,
  Z_PLUGIN_CATEGORY_MIXER,
#ifdef __cplusplus
};
#else
} ZPluginCategory;
#endif
 
#ifdef __cplusplus
enum class ZPluginProtocol
#else
typedef enum
#endif
{
  Z_PLUGIN_PROTOCOL_DUMMY,
  Z_PLUGIN_PROTOCOL_LV2,
  Z_PLUGIN_PROTOCOL_DSSI,
  Z_PLUGIN_PROTOCOL_LADSPA,
  Z_PLUGIN_PROTOCOL_VST,
  Z_PLUGIN_PROTOCOL_VST3,
  Z_PLUGIN_PROTOCOL_AU,
  Z_PLUGIN_PROTOCOL_SFZ,
  Z_PLUGIN_PROTOCOL_SF2,
  Z_PLUGIN_PROTOCOL_CLAP,
  Z_PLUGIN_PROTOCOL_JSFX,
#ifdef __cplusplus
};
#else
} ZPluginProtocol;
#endif
 
enum class ZPluginArchitecture
{
  Z_PLUGIN_ARCHITECTURE_32,
  Z_PLUGIN_ARCHITECTURE_64
};
 
enum class CarlaBridgeMode
{
  None,
  UI,
  Full,
};
 
/***
 * A descriptor to be implemented by all plugins
 * This will be used throughout the UI
 */
typedef struct PluginDescriptor
{
  int             schema_version;
  char *          author;
  char *          name;
  char *          website;
  ZPluginCategory category;
  char * category_str;
  int num_audio_ins;
  int num_midi_ins;
  int num_audio_outs;
  int num_midi_outs;
  int num_ctrl_ins;
  int num_ctrl_outs;
  int num_cv_ins;
  int num_cv_outs;
  ZPluginArchitecture arch;
  ZPluginProtocol protocol;
  char * path;
  char * uri;
 
  int64_t unique_id;
 
  CarlaBridgeMode min_bridge_mode;
 
  bool has_custom_ui;
 
  unsigned int ghash;
 
  char * sha1;
 
  WrappedObjectWithChangeSignal * gobj;
} PluginDescriptor;
 
PluginDescriptor *
plugin_descriptor_new (void);
 
const char *
plugin_protocol_to_str (ZPluginProtocol prot);
 
ZPluginProtocol
plugin_protocol_from_str (const char * str);
 
static inline const char *
plugin_protocol_get_icon_name (ZPluginProtocol prot)
{
  const char * icon = NULL;
  switch (prot)
    {
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_LV2:
      icon = "logo-lv2";
      break;
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_LADSPA:
      icon = "logo-ladspa";
      break;
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_AU:
      icon = "logo-au";
      break;
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_VST:
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_VST3:
      icon = "logo-vst";
      break;
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_SFZ:
    case ZPluginProtocol::Z_PLUGIN_PROTOCOL_SF2:
      icon = "file-music-line";
      break;
    default:
      icon = "plug";
      break;
    }
  return icon;
}
 
bool
plugin_protocol_is_supported (ZPluginProtocol protocol);
 
const char *
plugin_category_to_string (ZPluginCategory category);
 
CarlaBackend::PluginType
plugin_descriptor_get_carla_plugin_type_from_protocol (ZPluginProtocol protocol);
 
ZPluginProtocol
plugin_descriptor_get_protocol_from_carla_plugin_type (
  CarlaBackend::PluginType ptype);
 
ZPluginCategory
plugin_descriptor_get_category_from_carla_category_str (const char * category);
 
ZPluginCategory
plugin_descriptor_get_category_from_carla_category (
  CarlaBackend::PluginCategory carla_cat);
 
NONNULL void
plugin_descriptor_copy (PluginDescriptor * dest, const PluginDescriptor * src);
 
NONNULL PluginDescriptor *
plugin_descriptor_clone (const PluginDescriptor * src);
 
NONNULL bool
plugin_descriptor_is_instrument (const PluginDescriptor * const descr);
 
NONNULL bool
plugin_descriptor_is_effect (const PluginDescriptor * const descr);
 
NONNULL int
plugin_descriptor_is_modulator (const PluginDescriptor * const descr);
 
NONNULL int
plugin_descriptor_is_midi_modifier (const PluginDescriptor * const descr);
 
NONNULL ZPluginCategory
plugin_descriptor_string_to_category (const char * str);
 
char *
plugin_descriptor_category_to_string (ZPluginCategory category);
 
const char *
plugin_descriptor_get_icon_name (const PluginDescriptor * const self);
 
bool
plugin_descriptor_is_valid_for_slot_type (
  const PluginDescriptor * self,
  ZPluginSlotType          slot_type,
  TrackType                track_type);
 
NONNULL bool
plugin_descriptor_is_same_plugin (
  const PluginDescriptor * a,
  const PluginDescriptor * b);
 
NONNULL bool
plugin_descriptor_has_custom_ui (const PluginDescriptor * self);
 
NONNULL CarlaBridgeMode
plugin_descriptor_get_min_bridge_mode (const PluginDescriptor * self);
 
NONNULL bool
plugin_descriptor_is_whitelisted (const PluginDescriptor * self);
 
NONNULL GMenuModel *
plugin_descriptor_generate_context_menu (const PluginDescriptor * self);
 
NONNULL void
plugin_descriptor_free (PluginDescriptor * self);
 
NONNULL void
plugin_descriptor_free_closure (void * data, GClosure * closure);
 
#endif