plugin.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __PLUGINS_BASE_PLUGIN_H__
#define __PLUGINS_BASE_PLUGIN_H__
 
#include "zrythm-config.h"
 
#include "dsp/port.h"
#include "plugins/plugin_descriptor.h"
#include "plugins/plugin_identifier.h"
#include "plugins/plugin_preset.h"
#include "settings/plugin_settings.h"
#include "utils/types.h"
 
/* pulled in from X11 */
#undef Bool
 
typedef struct Project           Project;
typedef struct Channel           Channel;
typedef struct AutomationTrack   AutomationTrack;
typedef struct _ModulatorWidget  ModulatorWidget;
typedef struct Lv2Plugin         Lv2Plugin;
typedef struct CarlaNativePlugin CarlaNativePlugin;
typedef struct MixerSelections   MixerSelections;
typedef struct _WrappedObjectWithChangeSignal
  WrappedObjectWithChangeSignal;
 
#define PLUGIN_SCHEMA_VERSION 1
 
#define PLUGIN_MAGIC 43198683
#define IS_PLUGIN(x) (((Plugin *) x)->magic == PLUGIN_MAGIC)
#define IS_PLUGIN_AND_NONNULL(x) (x && IS_PLUGIN (x))
 
#define PLUGIN_MIN_REFRESH_RATE 30.f
#define PLUGIN_MAX_REFRESH_RATE 121.f
 
#define PLUGIN_MIN_SCALE_FACTOR 0.5f
#define PLUGIN_MAX_SCALE_FACTOR 4.f
 
#define plugin_is_in_active_project(self) \
  (self->track && track_is_in_active_project (self->track))
 
#define plugin_is_auditioner(self) \
  (self->track && track_is_auditioner (self->track))
 
typedef struct Plugin
{
  int schema_version;
 
  PluginIdentifier id;
 
  Lv2Plugin * lv2;
 
  CarlaNativePlugin * carla;
 
  PluginSetting * setting;
 
  Port ** in_ports;
  int     num_in_ports;
  size_t  in_ports_size;
 
  /* caches */
  GPtrArray * ctrl_in_ports;
  GPtrArray * audio_in_ports;
  GPtrArray * cv_in_ports;
  GPtrArray * midi_in_ports;
 
  Port * midi_in_port;
 
  Port ** out_ports;
  int     num_out_ports;
  size_t  out_ports_size;
 
  Port ** lilv_ports;
  int     num_lilv_ports;
 
  Port * enabled;
 
  Port * own_enabled_port;
 
  Port * gain;
 
  Port * l_out;
  Port * r_out;
 
  PluginBank ** banks;
  int           num_banks;
  size_t        banks_size;
 
  PluginPresetIdentifier selected_bank;
  PluginPresetIdentifier selected_preset;
 
  bool visible;
 
  nframes_t latency;
 
  bool instantiated;
 
  bool instantiation_failed;
 
  bool activated;
 
  int ui_instantiated;
 
  float ui_update_hz;
 
  float ui_scale_factor;
 
  char * state_dir;
 
  bool deleting;
 
  GtkWidget * active_preset_item;
 
  GtkWindow * window;
 
  bool external_ui_visible;
 
  GtkBox * ev_box;
 
  GtkBox * vbox;
 
  gulong destroy_window_id;
 
  gulong close_request_id;
 
  int magic;
 
  ModulatorWidget * modulator_widget;
 
  guint update_ui_source_id;
 
  bool deactivating;
 
  int state_changed_event_sent;
 
  bool is_function;
 
  Track * track;
 
  MixerSelections * ms;
 
  WrappedObjectWithChangeSignal * gobj;
} Plugin;
 
static const cyaml_schema_field_t plugin_fields_schema[] = {
  YAML_FIELD_INT (Plugin, schema_version),
  YAML_FIELD_MAPPING_EMBEDDED (
    Plugin,
    id,
    plugin_identifier_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Plugin,
    setting,
    plugin_setting_fields_schema),
  YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT_OPT (
    Plugin,
    in_ports,
    port_schema),
  YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT_OPT (
    Plugin,
    out_ports,
    port_schema),
  YAML_FIELD_DYN_PTR_ARRAY_VAR_COUNT_OPT (
    Plugin,
    banks,
    plugin_bank_schema),
  YAML_FIELD_MAPPING_EMBEDDED (
    Plugin,
    selected_bank,
    plugin_preset_identifier_fields_schema),
  YAML_FIELD_MAPPING_EMBEDDED (
    Plugin,
    selected_preset,
    plugin_preset_identifier_fields_schema),
  YAML_FIELD_INT (Plugin, visible),
  YAML_FIELD_STRING_PTR_OPTIONAL (Plugin, state_dir),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t plugin_schema = {
  YAML_VALUE_PTR_NULLABLE (Plugin, plugin_fields_schema),
};
 
NONNULL_ARGS (1)
void plugin_init_loaded (
  Plugin *          self,
  Track *           track,
  MixerSelections * ms);
 
NONNULL void
plugin_add_automation_track (
  Plugin *          self,
  AutomationTrack * at);
 
NONNULL void
plugin_add_in_port (Plugin * pl, Port * port);
 
NONNULL void
plugin_add_out_port (Plugin * pl, Port * port);
 
NONNULL_ARGS (1)
Plugin * plugin_new_from_setting (
  PluginSetting * setting,
  unsigned int    track_name_hash,
  PluginSlotType  slot_type,
  int             slot,
  GError **       error);
 
Plugin *
plugin_new_dummy (
  ZPluginCategory cat,
  unsigned int    track_name_hash,
  int             slot);
 
NONNULL void
plugin_set_ui_refresh_rate (Plugin * self);
 
NONNULL Port *
plugin_get_enabled_port (Plugin * self);
 
NONNULL bool
plugin_validate (Plugin * self);
 
void
plugin_print (Plugin * self, char * buf, size_t buf_sz);
 
NONNULL void
plugin_remove_ats_from_automation_tracklist (
  Plugin * pl,
  bool     free_ats,
  bool     fire_events);
 
NONNULL_ARGS (1)
Plugin * plugin_clone (Plugin * src, GError ** error);
 
void
plugin_get_full_port_group_designation (
  Plugin *     self,
  const char * port_group,
  char *       buf);
 
NONNULL Port *
plugin_get_port_in_group (
  Plugin *     self,
  const char * port_group,
  bool         left);
 
NONNULL Port *
plugin_get_port_in_same_group (Plugin * self, Port * port);
 
NONNULL int
plugin_activate (Plugin * pl, bool activate);
 
NONNULL void
plugin_move (
  Plugin *       pl,
  Track *        track,
  PluginSlotType slot_type,
  int            slot,
  bool           fire_events);
 
NONNULL void
plugin_set_track_and_slot (
  Plugin *       pl,
  unsigned int   track_name_hash,
  PluginSlotType slot_type,
  int            slot);
 
NONNULL void
plugin_move_automation (
  Plugin *       pl,
  Track *        prev_track,
  Track *        track,
  PluginSlotType new_slot_type,
  int            new_slot);
 
NONNULL void
plugin_append_ports (Plugin * self, GPtrArray * ports);
 
NONNULL void
plugin_expose_ports (
  Plugin * pl,
  bool     expose,
  bool     inputs,
  bool     outputs);
 
NONNULL Port *
plugin_get_port_by_symbol (Plugin * pl, const char * sym);
 
NONNULL Port *
plugin_get_port_by_param_uri (Plugin * pl, const char * uri);
 
NONNULL MALLOC char *
plugin_get_escaped_name (Plugin * pl);
 
int
plugin_copy_state_dir (
  Plugin *     self,
  Plugin *     src,
  bool         is_backup,
  const char * abs_state_dir);
 
NONNULL MALLOC char *
plugin_get_abs_state_dir (
  Plugin * self,
  bool     is_backup,
  bool     create_if_not_exists);
 
NONNULL WARN_UNUSED_RESULT bool
plugin_ensure_state_dir (
  Plugin *  self,
  bool      is_backup,
  GError ** error);
 
NONNULL void
plugin_get_all (
  Project *   prj,
  GPtrArray * arr,
  bool        check_undo_manager);
 
NONNULL Channel *
plugin_get_channel (Plugin * self);
 
NONNULL Track *
plugin_get_track (Plugin * self);
 
NONNULL Plugin *
plugin_find (const PluginIdentifier * id);
 
NONNULL void
plugin_update_identifier (Plugin * self);
 
NONNULL void
plugin_update_latency (Plugin * pl);
 
NONNULL void
plugin_generate_automation_tracks (
  Plugin * plugin,
  Track *  track);
 
HOT NONNULL OPTIMIZE_O3 void
plugin_prepare_process (Plugin * self);
 
NONNULL_ARGS (1)
int plugin_instantiate (
  Plugin *    self,
  LilvState * state,
  GError **   error);
 
NONNULL void
plugin_set_track_name_hash (
  Plugin *     pl,
  unsigned int track_name_hash);
 
NONNULL HOT void
plugin_process (
  Plugin *                            plugin,
  const EngineProcessTimeInfo * const time_nfo);
 
NONNULL MALLOC char *
plugin_generate_window_title (Plugin * plugin);
 
NONNULL void
plugin_open_ui (Plugin * plugin);
 
NONNULL bool
plugin_is_selected (Plugin * pl);
 
NONNULL void
plugin_select (Plugin * self, bool select, bool exclusive);
 
NONNULL bool
plugin_is_enabled (Plugin * self, bool check_track);
 
NONNULL void
plugin_set_enabled (
  Plugin * self,
  bool     enabled,
  bool     fire_events);
 
HOT NONNULL void
plugin_process_passthrough (
  Plugin *                            self,
  const EngineProcessTimeInfo * const time_nfo);
 
NONNULL int
plugin_get_event_ports (Plugin * pl, Port ** ports, int input);
 
NONNULL void
plugin_close_ui (Plugin * plugin);
 
NONNULL void
plugin_update_automatables (Plugin * plugin);
 
PluginBank *
plugin_add_bank_if_not_exists (
  Plugin *     self,
  const char * uri,
  const char * name);
 
NONNULL void
plugin_add_preset_to_bank (
  Plugin *       self,
  PluginBank *   bank,
  PluginPreset * preset);
 
NONNULL void
plugin_set_selected_bank_from_index (Plugin * self, int idx);
 
NONNULL void
plugin_set_selected_preset_from_index (Plugin * self, int idx);
 
NONNULL void
plugin_set_selected_preset_by_name (
  Plugin *     self,
  const char * name);
 
NONNULL void
plugin_set_caches (Plugin * self);
 
NONNULL void
plugin_connect_to_plugin (Plugin * src, Plugin * dest);
 
NONNULL void
plugin_disconnect_from_plugin (Plugin * src, Plugin * dest);
 
NONNULL void
plugin_connect_to_prefader (Plugin * pl, Channel * ch);
 
NONNULL void
plugin_disconnect_from_prefader (Plugin * pl, Channel * ch);
 
NONNULL void
plugin_disconnect (Plugin * plugin);
 
NONNULL void
plugin_delete_state_files (Plugin * self);
 
NONNULL int
plugin_cleanup (Plugin * self);
 
NONNULL void
plugin_free (Plugin * plugin);
 
#endif