Scales.h

#ifndef MCC_SCALE_SCALES_H
#define MCC_SCALE_SCALES_H
 
#include <stddef.h>
#include <stdint.h>
 
#include <MCC/Pitch/NoteName.h>
#include <MCC/Scale/Scale.h>
#include <MCC/Scale/ScalePattern.h>
 
namespace MCC {

namespace Scales {

    enum class Id : uint8_t {
        Chromatic = 0,
        ChromaticFlats,
        Major,
        Minor,
        HarmonicMinor,
        MelodicMinor,
        HarmonicMajor,
        MajorPentatonic,
        MinorPentatonic,
        MinorBlues,
        MajorBlues,
        Dorian,
        Phrygian,
        Lydian,
        Mixolydian,
        Locrian,
        Algerian,
        Arabic,
        Augmented,
        Pelog,
        Byzantine,
        Chinese,
        Diminished,
        Egyptian,
        EightToneSpanish,
        Enigmatic,
        Hindu,
        Hirajoshi,
        Iwato,
        HungarianMinor,
        Japanese,
        Oriental,
        WholeTone,
        RomanianMinor,
        SpanishGypsy,
        SuperLocrian,
        Invalid = 0xFF
    };

    enum class Family : uint8_t {
        Western,
        Modal,
        Symmetric,
        Exotic,
        Invalid = 0xFF
    };

    constexpr uint8_t Count = static_cast<uint8_t>(Id::SuperLocrian) + 1;

    constexpr uint8_t AliasCount = 9;

    constexpr size_t NameCapacity = 24;

    ScalePattern Pattern(Id id) noexcept;

    Family FamilyOf(Id id) noexcept;

    size_t CopyName(Id id, char* destination, size_t capacity) noexcept;

    size_t CopyAlias(uint8_t index, char* destination, size_t capacity, Id& target) noexcept;

    Id Find(const char* name) noexcept;

    inline Scale Make(NoteName root, Id id) noexcept {
        return Scale(root, Pattern(id));
    }
 
} // namespace Scales
 
} // namespace MCC
 
#endif // MCC_SCALE_SCALES_H