NoteRange.h

Go to the documentation of this file.

// Copyright (c) XJ Music Inc. (https://xjmusic.com) All Rights Reserved.
 
#ifndef XJMUSIC_MUSIC_NOTE_RANGE_H
#define XJMUSIC_MUSIC_NOTE_RANGE_H
 
#include <set>
 
#include "Note.h"
 
namespace XJ {
 
  class NoteRange {
  private:
    std::string UNKNOWN = "Unknown";
    int MAX_SEEK_OCTAVES = 3;
 
  public:
 
    std::optional<Note> low;
 
    std::optional<Note> high;
 
    NoteRange();
 
    NoteRange(std::optional<Note> low, std::optional<Note> high);
 
    NoteRange(const std::string &low, const std::string &high);
 
    static NoteRange from(Note low, Note high);
 
    static NoteRange from(const std::string &low, const std::string &high);
 
    static NoteRange copyOf(const NoteRange &range);
 
    static NoteRange ofNotes(std::vector<Note> notes);
 
    static NoteRange ofNotes(const std::set<Note>& notes);
 
    static NoteRange ofStrings(const std::vector<std::string> &notes);
 
    static NoteRange median(const NoteRange &r1, const NoteRange &r2);
 
    static int computeMedianOptimalRangeShiftOctaves(const NoteRange *sourceRange, const NoteRange *targetRange);
 
    std::string toString(Accidental accidental);
 
    void expand(const std::vector<Note> &notes);
 
    void expand(Note note);
 
    void expand(const NoteRange *range);
 
    int getDeltaSemitones(NoteRange target);
 
    std::optional<Note> getMedianNote();
 
    NoteRange shifted(int inc) const;
 
    bool empty() const;
 
    std::optional<Note> getNoteNearestMedian(PitchClass root);
 
    Note toAvailableOctave(Note note) const;
 
    bool includes(Note note) const;
  };
 
}// namespace XJ
 
#endif// XJMUSIC_MUSIC_NOTE_RANGE_H