Note.h

Go to the documentation of this file.

// Copyright (c) XJ Music Inc. (https://xjmusic.com) All Rights Reserved.
 
#ifndef XJMUSIC_MUSIC_NOTE_H
#define XJMUSIC_MUSIC_NOTE_H
 
#include <optional>
#include <regex>
#include <string>
 
#include "PitchClass.h"
 
namespace XJ {
 
  class Note {
  private:
    static std::regex rgxValidNote;
 
    // this max is only for extreme-case infinite loop prevention
    static int MAX_DELTA_SEMITONES;
 
  public:
    int octave;
 
    PitchClass pitchClass;
 
    bool operator==(const Note &other) const;
 
    bool operator<(const Note &other) const;
 
    bool operator>(const Note &other) const;
 
    bool operator<=(const Note &other) const;
 
    bool operator>=(const Note &other) const;
 
    static std::string ATONAL;
 
    Note();
 
    explicit Note(const std::string &name);
 
    Note(PitchClass pitchClass, int octave);
 
    static Note of(const std::string &name);
 
    static Note of(PitchClass pitchClass, int octave);
 
    static Note atonal();
 
    static std::optional<Note> ifValid(const std::string &name);
 
    static std::optional<Note> ifTonal(const std::string &name);
 
    static bool isValid(const std::string &name);
 
    static bool containsAnyValidNotes(const std::string &noteCsv);
 
    static std::optional<Note> median(std::optional<Note> n1, std::optional<Note> n2);
 
    [[nodiscard]] std::string toString(Accidental accidental) const;
 
    [[nodiscard]] Note shift(int inc) const;
 
    [[nodiscard]] Note shiftOctave(int inc) const;
 
    [[nodiscard]] Note copy() const;
 
    Note setOctaveNearest(Note fromNote);
 
    [[nodiscard]] int delta(const Note &target) const;
 
    [[nodiscard]] bool isAtonal() const;
 
    Note nextUp(PitchClass target) const;
 
    Note nextDown(PitchClass target) const;
 
    Note next(PitchClass target, int delta) const;
  };
 
}// namespace XJ
 
#endif// XJMUSIC_MUSIC_NOTE_H