plugin_identifier.h

Go to the documentation of this file.

// clang-format off
// SPDX-FileCopyrightText: © 2020-2021, 2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
// clang-format on
 
#ifndef __PLUGINS_PLUGIN_IDENTIFIER_H__
#define __PLUGINS_PLUGIN_IDENTIFIER_H__
 
#include "zrythm-config.h"
 
#include <stdbool.h>
 
#include "utils/yaml.h"
 
#define PLUGIN_IDENTIFIER_SCHEMA_VERSION 1
 
typedef enum PluginSlotType
{
  PLUGIN_SLOT_INVALID,
  PLUGIN_SLOT_INSERT,
  PLUGIN_SLOT_MIDI_FX,
  PLUGIN_SLOT_INSTRUMENT,
 
  PLUGIN_SLOT_MODULATOR,
} PluginSlotType;
 
static const cyaml_strval_t plugin_slot_type_strings[] = {
  {"Invalid",     PLUGIN_SLOT_INVALID   },
  { "Insert",     PLUGIN_SLOT_INSERT    },
  { "MIDI FX",    PLUGIN_SLOT_MIDI_FX   },
  { "Instrument", PLUGIN_SLOT_INSTRUMENT},
  { "Modulator",  PLUGIN_SLOT_MODULATOR },
};
 
static inline const char *
plugin_slot_type_to_string (PluginSlotType type)
{
  return plugin_slot_type_strings[type].str;
}
 
typedef struct PluginIdentifier
{
  int schema_version;
 
  PluginSlotType slot_type;
 
  unsigned int track_name_hash;
 
  int slot;
} PluginIdentifier;
 
static const cyaml_schema_field_t plugin_identifier_fields_schema[] = {
  YAML_FIELD_INT (PluginIdentifier, schema_version),
  YAML_FIELD_ENUM (PluginIdentifier, slot_type, plugin_slot_type_strings),
  YAML_FIELD_UINT (PluginIdentifier, track_name_hash),
  YAML_FIELD_INT (PluginIdentifier, slot),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t plugin_identifier_schema = {
  CYAML_VALUE_MAPPING (
    CYAML_FLAG_POINTER,
    PluginIdentifier,
    plugin_identifier_fields_schema),
};
 
void
plugin_identifier_init (PluginIdentifier * self);
 
static inline int
plugin_identifier_is_equal (
  const PluginIdentifier * a,
  const PluginIdentifier * b)
{
  return a->slot_type == b->slot_type
         && a->track_name_hash == b->track_name_hash && a->slot == b->slot;
}
 
void
plugin_identifier_copy (PluginIdentifier * dest, const PluginIdentifier * src);
 
NONNULL bool
plugin_identifier_validate (const PluginIdentifier * self);
 
bool
plugin_identifier_validate_slot_type_slot_combo (
  PluginSlotType slot_type,
  int            slot);
 
void
plugin_identifier_print (const PluginIdentifier * self, char * str);
 
uint32_t
plugin_identifier_get_hash (const void * id);
 
#endif