scale.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_SCALE_H__
#define __AUDIO_SCALE_H__
 
#include <cstdint>
 
#include "dsp/chord_descriptor.h"
 
#include <glib/gi18n.h>
 
#define SCALE_SCHEMA_VERSION 2
 
enum class MusicalScaleType
{
  SCALE_CHROMATIC,
 
  /* --- popular scales --- */
 
  SCALE_MAJOR,
 
  SCALE_MINOR,
 
  SCALE_IONIAN,
 
  SCALE_DORIAN,
  SCALE_PHRYGIAN,
  SCALE_LYDIAN,
  SCALE_MIXOLYDIAN,
 
  SCALE_AEOLIAN,
 
  SCALE_LOCRIAN,
  SCALE_MELODIC_MINOR,
  SCALE_HARMONIC_MINOR,
  SCALE_WHOLE_TONE,
  SCALE_MAJOR_PENTATONIC,
  SCALE_MINOR_PENTATONIC,
  SCALE_OCTATONIC_HALF_WHOLE,
  SCALE_OCTATONIC_WHOLE_HALF,
 
  /* --- exotic scales --- */
 
  SCALE_ACOUSTIC,
 
  SCALE_HARMONIC_MAJOR,
  SCALE_PHRYGIAN_DOMINANT,
  SCALE_MAJOR_LOCRIAN,
  SCALE_ALGERIAN,
  SCALE_AUGMENTED,
  SCALE_DOUBLE_HARMONIC,
  SCALE_CHINESE,
  SCALE_DIMINISHED,
  SCALE_DOMINANT_DIMINISHED,
  SCALE_EGYPTIAN,
  SCALE_EIGHT_TONE_SPANISH,
  SCALE_ENIGMATIC,
  SCALE_GEEZ,
  SCALE_HINDU,
  SCALE_HIRAJOSHI,
  SCALE_HUNGARIAN_GYPSY,
  SCALE_INSEN,
  SCALE_NEAPOLITAN_MAJOR,
  SCALE_NEAPOLITAN_MINOR,
  SCALE_ORIENTAL,
  SCALE_ROMANIAN_MINOR,
  SCALE_ALTERED,
  SCALE_MAQAM,
  SCALE_YO,
  SCALE_BEBOP_LOCRIAN,
  SCALE_BEBOP_DOMINANT,
  SCALE_BEBOP_MAJOR,
  SCALE_SUPER_LOCRIAN,
  SCALE_ENIGMATIC_MINOR,
  SCALE_COMPOSITE,
  SCALE_BHAIRAV,
  SCALE_HUNGARIAN_MINOR,
  SCALE_PERSIAN,
  SCALE_IWATO,
  SCALE_KUMOI,
  SCALE_PELOG,
  SCALE_PROMETHEUS,
  SCALE_PROMETHEUS_NEAPOLITAN,
  SCALE_PROMETHEUS_LISZT,
  SCALE_BALINESE,
  SCALE_RAGATODI,
  SCALE_JAPANESE1,
  SCALE_JAPANESE2,
 
  /* --- TODO unimplemented --- */
 
  SCALE_BLUES,
  SCALE_FLAMENCO,
  SCALE_GYPSY,
  SCALE_HALF_DIMINISHED,
  SCALE_IN,
  SCALE_ISTRIAN,
  SCALE_LYDIAN_AUGMENTED,
  SCALE_TRITONE,
  SCALE_UKRANIAN_DORIAN,
};
 
typedef struct MusicalScale
{
  MusicalScaleType type;
 
  MusicalNote root_key;
} MusicalScale;
 
MusicalScale *
musical_scale_new (MusicalScaleType type, MusicalNote root);
 
const bool *
musical_scale_get_notes (MusicalScaleType scale_type, bool ascending);
 
RETURNS_NONNULL
const ChordType *
musical_scale_get_triad_types (MusicalScaleType scale_type, bool ascending);
 
MusicalScale *
musical_scale_clone (MusicalScale * src);
 
const char *
musical_scale_type_to_string (const MusicalScaleType type);
 
char *
musical_scale_to_string (const MusicalScale * const self);
 
void
musical_scale_strcpy (MusicalScale * scale, char * buf);
 
static inline int
musical_scale_is_equal (MusicalScale * a, MusicalScale * b)
{
  return a->type == b->type && a->root_key == b->root_key;
}
 
bool
musical_scale_contains_chord (
  const MusicalScale * const    scale,
  const ChordDescriptor * const chord);
 
int
musical_scale_is_accent_in_scale (
  MusicalScale * scale,
  MusicalNote    chord_root,
  ChordType      type,
  ChordAccent    chord_accent);
 
bool
musical_scale_contains_note (const MusicalScale * scale, MusicalNote note);
 
char *
musical_scale_as_string (MusicalScale * scale);
 
void
musical_scale_free (MusicalScale * scale);
 
#endif