fader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_FADER_H__
#define __AUDIO_FADER_H__
 
#include "dsp/port.h"
#include "utils/types.h"
#include "utils/yaml.h"
 
typedef struct StereoPorts     StereoPorts;
typedef struct Port            Port;
typedef struct Channel         Channel;
typedef struct AudioEngine     AudioEngine;
typedef struct ControlRoom     ControlRoom;
typedef struct SampleProcessor SampleProcessor;
typedef struct PortIdentifier  PortIdentifier;
 
#define FADER_SCHEMA_VERSION 2
 
#define MONITOR_FADER (CONTROL_ROOM->monitor_fader)
 
#define FADER_MAGIC 32548791
#define IS_FADER(f) (f->magic == FADER_MAGIC)
#define IS_FADER_AND_NONNULL(f) (f && f->magic == FADER_MAGIC)
 
#define FADER_DEFAULT_FADE_FRAMES_SHORT 1024
#define FADER_DEFAULT_FADE_FRAMES \
  (ZRYTHM_TESTING ? FADER_DEFAULT_FADE_FRAMES_SHORT : 8192)
 
#define FADER_FADE_FRAMES_FOR_TYPE(f) \
  ((f)->type == FADER_TYPE_MONITOR \
     ? FADER_DEFAULT_FADE_FRAMES \
     : FADER_DEFAULT_FADE_FRAMES_SHORT)
 
#define fader_is_in_active_project(self) \
  ((self->track != NULL \
    && track_is_in_active_project (self->track)) \
   || \
   (self->sample_processor != NULL \
    && \
    sample_processor_is_in_active_project ( \
      self->sample_processor)) \
   || \
   (self->control_room != NULL \
    && \
    control_room_is_in_active_project ( \
      self->control_room)))
 
typedef enum FaderType
{
  FADER_TYPE_NONE,
 
  FADER_TYPE_MONITOR,
 
  FADER_TYPE_SAMPLE_PROCESSOR,
 
  FADER_TYPE_AUDIO_CHANNEL,
 
  /* MIDI fader for Channel's. */
  FADER_TYPE_MIDI_CHANNEL,
 
  FADER_TYPE_GENERIC,
} FaderType;
 
static const cyaml_strval_t fader_type_strings[] = {
  {"none",              FADER_TYPE_NONE            },
  { "monitor",          FADER_TYPE_MONITOR         },
  { "sample processor", FADER_TYPE_SAMPLE_PROCESSOR},
  { "audio channel",    FADER_TYPE_AUDIO_CHANNEL   },
  { "midi channel",     FADER_TYPE_MIDI_CHANNEL    },
  { "generic",          FADER_TYPE_GENERIC         },
};
 
typedef enum MidiFaderMode
{
  MIDI_FADER_MODE_VEL_MULTIPLIER,
 
  MIDI_FADER_MODE_CC_VOLUME,
} MidiFaderMode;
 
static const cyaml_strval_t midi_fader_mode_strings[] = {
  {"vel_multiplier", MIDI_FADER_MODE_VEL_MULTIPLIER},
  { "cc_volume",     MIDI_FADER_MODE_CC_VOLUME     },
};
 
typedef struct Fader
{
  int schema_version;
 
  float volume;
 
  float phase;
 
  float fader_val;
 
  float last_cc_volume;
 
  Port * amp;
 
  Port * balance;
 
  Port * mute;
 
  Port * solo;
 
  Port * listen;
 
  Port * mono_compat_enabled;
 
  Port * swap_phase;
 
  StereoPorts * stereo_in;
 
  StereoPorts * stereo_out;
 
  Port * midi_in;
 
  Port * midi_out;
 
  float l_port_db;
  float r_port_db;
 
  FaderType type;
 
  MidiFaderMode midi_mode;
 
  bool passthrough;
 
  Track * track;
 
  ControlRoom * control_room;
 
  SampleProcessor * sample_processor;
 
  int magic;
 
  bool is_project;
 
  /* TODO Caches to be set when recalculating the
   * graph. */
  bool implied_soloed;
  bool soloed;
 
  int fade_in_samples;
 
  int fade_out_samples;
 
  int fading_out;
 
  bool was_effectively_muted;
} Fader;
 
static const cyaml_schema_field_t fader_fields_schema[] = {
  YAML_FIELD_INT (Fader, schema_version),
  YAML_FIELD_ENUM (Fader, type, fader_type_strings),
  YAML_FIELD_FLOAT (Fader, volume),
  YAML_FIELD_MAPPING_PTR (Fader, amp, port_fields_schema),
  YAML_FIELD_FLOAT (Fader, phase),
  YAML_FIELD_MAPPING_PTR (Fader, balance, port_fields_schema),
  YAML_FIELD_MAPPING_PTR (Fader, mute, port_fields_schema),
  YAML_FIELD_MAPPING_PTR (Fader, solo, port_fields_schema),
  YAML_FIELD_MAPPING_PTR (Fader, listen, port_fields_schema),
  YAML_FIELD_MAPPING_PTR (Fader, mono_compat_enabled, port_fields_schema),
  YAML_FIELD_MAPPING_PTR (Fader, swap_phase, port_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (Fader, midi_in, port_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (Fader, midi_out, port_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (Fader, stereo_in, stereo_ports_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (Fader, stereo_out, stereo_ports_fields_schema),
  YAML_FIELD_ENUM (Fader, midi_mode, midi_fader_mode_strings),
  YAML_FIELD_INT (Fader, passthrough),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t fader_schema = {
  YAML_VALUE_PTR (Fader, fader_fields_schema),
};
 
COLD NONNULL_ARGS (1) void fader_init_loaded (
  Fader *           self,
  Track *           track,
  ControlRoom *     control_room,
  SampleProcessor * sample_processor);
 
COLD Fader *
fader_new (
  FaderType         type,
  bool              passthrough,
  Track *           track,
  ControlRoom *     control_room,
  SampleProcessor * sample_processor);
 
Fader *
fader_find_from_port_identifier (const PortIdentifier * id);
 
Port *
fader_create_swap_phase_port (Fader * self, bool passthrough);
 
NONNULL void
fader_append_ports (const Fader * self, GPtrArray * ports);
 
void
fader_set_amp (void * self, float amp);
 
void
fader_set_amp_with_action (
  Fader * self,
  float   amp_from,
  float   amp_to,
  bool    skip_if_equal);
 
void
fader_add_amp (void * self, float amp);
 
NONNULL void
fader_set_midi_mode (
  Fader *       self,
  MidiFaderMode mode,
  bool          with_action,
  bool          fire_events);
 
void
fader_set_muted (Fader * self, bool mute, bool fire_events);
 
NONNULL PURE bool
fader_get_muted (const Fader * const self);
 
HOT NONNULL PURE bool
fader_get_soloed (const Fader * const self);
 
bool
fader_get_implied_soloed (Fader * self);
 
#define fader_get_listened(self) (control_port_is_toggled (self->listen))
 
void
fader_set_listened (Fader * self, bool listen, bool fire_events);
 
void
fader_set_soloed (Fader * self, bool solo, bool fire_events);
 
NONNULL PURE float
fader_get_amp (void * self);
 
bool
fader_get_mono_compat_enabled (Fader * self);
 
void
fader_set_mono_compat_enabled (Fader * self, bool enabled, bool fire_events);
 
bool
fader_get_swap_phase (Fader * self);
 
void
fader_set_swap_phase (Fader * self, bool enabled, bool fire_events);
 
float
fader_get_fader_val (void * self);
 
float
fader_get_default_fader_val (void * self);
 
void
fader_db_string_getter (void * obj, char * buf);
 
Channel *
fader_get_channel (Fader * self);
 
NONNULL Track *
fader_get_track (Fader * self);
 
void
fader_update_volume_and_fader_val (Fader * self);
 
HOT NONNULL void
fader_clear_buffers (Fader * self);
 
void
fader_set_fader_val (Fader * self, float fader_val);
 
void
fader_disconnect_all (Fader * self);
 
void
fader_copy_values (Fader * src, Fader * dest);
 
NONNULL HOT void
fader_process (Fader * self, const EngineProcessTimeInfo * const time_nfo);
 
#if 0
void
fader_update_track_pos (
  Fader * self,
  int     pos);
#endif
 
Fader *
fader_clone (const Fader * src);
 
void
fader_free (Fader * self);
 
#endif