Classes designed to parse and interpret ARAContentChord / ARAContentKeySignature data.
Classes | |
| class | ARA::PitchInterpreter |
| Base class for chord and key signature interpretation, provides basic configuration. More... | |
| class | ARA::ChordInterpreter |
| Provides a user-readable name for an ARAContentChord based on its interval description. More... | |
| class | ARA::KeySignatureInterpreter |
| Provides a user-readable name for an ARAContentKeySignature based on its interval description. More... | |
| class ARA::PitchInterpreter |
Base class for chord and key signature interpretation, provides basic configuration.
Public Member Functions | |
| PitchInterpreter (bool useAsciiSymbols=false, bool useGermanNoteNames=false) | |
| Construct to use ASCII symbols and/or German note names. | |
| bool | usesASCIISymbols () const noexcept |
| True if the interpreter uses ASCII symbols. | |
| void | setUseASCIISymbols (bool use) noexcept |
| Enable or disable the use of ASCII symbols. | |
| bool | usesGermanNoteNames () const noexcept |
| True if the interpreter uses German note names. | |
| void | setUseGermanNoteNames (bool use) noexcept |
| Enable or disable the use of German note names. | |
| std::string | getNoteNameForCircleOfFifthIndex (ARACircleOfFifthsIndex index) const |
| Get the name of the note at the given ARACircleOfFifthsIndex. If usesASCIISymbols() is false, the returned std::string may contain ARAUtf8Char (potentially multi-byte) symbols. | |
| class ARA::ChordInterpreter |
Provides a user-readable name for an ARAContentChord based on its interval description.
Public Member Functions | |
| std::string | getNameForChord (const ARAContentChord &chord) const |
Get the user-readable name of chord. Will always generate a name based on the abstract chord data and ignore ARAContentChord.name. If usesASCIISymbols() is false, the returned std::string may contain ARAUtf8Char (potentially multi-byte) symbols. | |
| PitchInterpreter (bool useAsciiSymbols=false, bool useGermanNoteNames=false) | |
| Construct to use ASCII symbols and/or German note names. | |
Public Member Functions inherited from ARA::PitchInterpreter | |
| PitchInterpreter (bool useAsciiSymbols=false, bool useGermanNoteNames=false) | |
| Construct to use ASCII symbols and/or German note names. | |
| bool | usesASCIISymbols () const noexcept |
| True if the interpreter uses ASCII symbols. | |
| void | setUseASCIISymbols (bool use) noexcept |
| Enable or disable the use of ASCII symbols. | |
| bool | usesGermanNoteNames () const noexcept |
| True if the interpreter uses German note names. | |
| void | setUseGermanNoteNames (bool use) noexcept |
| Enable or disable the use of German note names. | |
| std::string | getNoteNameForCircleOfFifthIndex (ARACircleOfFifthsIndex index) const |
| Get the name of the note at the given ARACircleOfFifthsIndex. If usesASCIISymbols() is false, the returned std::string may contain ARAUtf8Char (potentially multi-byte) symbols. | |
Static Public Member Functions | |
| static bool | isNoChord (const ARAContentChord &chord) noexcept |
Returns true if chord is the "no chord". A chord is considered "no chord" if it contains no notes, i.e. all intervals are unused. | |
| class ARA::KeySignatureInterpreter |
Provides a user-readable name for an ARAContentKeySignature based on its interval description.
Public Types | |
| enum | ScaleMode |
| Scale mode type returned from getScaleMode(). | |
Public Member Functions | |
| std::string | getNameForKeySignature (const ARAContentKeySignature &keySignature) const |
Get the user-readable name of keySignature. Will always try to generate a name based on the abstract key signature data and ignore ARAContentKeySignature.name. Only covers a commonly used subset of the key signatures that the abstract key signature data can describe - will return empty string if no suitable name can be provided. If usesASCIISymbols() is false, the returned std::string may contain ARAUtf8Char (potentially multi-byte) symbols. | |
| std::string | getRootNoteNameForKeySignature (const ARAContentKeySignature &keySignature) const |
Returns the name of the root note of keySignature (useful if getNameForKeySignature() fails). If usesASCIISymbols() is false, the returned std::string may contain ARAUtf8Char (potentially multi-byte) symbols. | |
| PitchInterpreter (bool useAsciiSymbols=false, bool useGermanNoteNames=false) | |
| Construct to use ASCII symbols and/or German note names. | |
Public Member Functions inherited from ARA::PitchInterpreter | |
| PitchInterpreter (bool useAsciiSymbols=false, bool useGermanNoteNames=false) | |
| Construct to use ASCII symbols and/or German note names. | |
| bool | usesASCIISymbols () const noexcept |
| True if the interpreter uses ASCII symbols. | |
| void | setUseASCIISymbols (bool use) noexcept |
| Enable or disable the use of ASCII symbols. | |
| bool | usesGermanNoteNames () const noexcept |
| True if the interpreter uses German note names. | |
| void | setUseGermanNoteNames (bool use) noexcept |
| Enable or disable the use of German note names. | |
| std::string | getNoteNameForCircleOfFifthIndex (ARACircleOfFifthsIndex index) const |
| Get the name of the note at the given ARACircleOfFifthsIndex. If usesASCIISymbols() is false, the returned std::string may contain ARAUtf8Char (potentially multi-byte) symbols. | |
Static Public Member Functions | |
| static bool | hasMajorThird (const ARAContentKeySignature &keySignature) noexcept |
True if scale of keySignature contains a major third, false otherwise. | |
| static bool | hasMinorThird (const ARAContentKeySignature &keySignature) noexcept |
True if scale of keySignature contains a minor third, false otherwise. | |
| static bool | hasMajorSeventh (const ARAContentKeySignature &keySignature) noexcept |
True if scale of keySignature contains a major seventh, false otherwise. | |
| static bool | hasMinorSeventh (const ARAContentKeySignature &keySignature) noexcept |
True if scale of keySignature contains a minor seventh, false otherwise. | |
| static ScaleMode | getScaleMode (const ARAContentKeySignature &keySignature) noexcept |
Returns the scale mode of keySignature. | |