musicalscale.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_MUSIC
#include <promeki/string.h>
#include <promeki/list.h>
#include <promeki/array.h>
#include <promeki/error.h>
#include <promeki/result.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class MusicalScale {
        public:
                enum Mode {
                        Chromatic,
                        Major,
                        NaturalMinor,
                        HarmonicMinor,
                        MelodicMinor,
                        Pentatonic,
                        Blues
                };
 
                using MembershipMask = Array<int, 12>;
 
                MusicalScale();
 
                MusicalScale(int rootPitchClass, Mode mode);
 
                static Result<MusicalScale> fromName(const String &name);
 
                int rootPitchClass() const { return _rootPitchClass; }
 
                Mode mode() const { return _mode; }
 
                int degreesPerOctave() const { return static_cast<int>(_intervals.size()); }
 
                float midiNoteForDegree(int degree, int octave) const;
 
                bool containsNote(int midiNote) const;
 
                float constrainNote(float midiNote, float strength = 1.0f) const;
 
                static int pitchClassFromName(const String &name);
 
                static const char *pitchClassName(int pitchClass);
 
                static Result<Mode> modeFromName(const String &name);
 
                static const char *modeName(Mode mode);
 
                static List<int> intervalsForMode(Mode mode);
 
                static const MembershipMask &membershipMaskForMode(Mode mode);
 
        private:
                int       _rootPitchClass = 0;
                Mode      _mode = Chromatic;
                List<int> _intervals;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_MUSIC