Class Notes

Lib/Model/Notes.h:20–263

* Class to extract note events from posteriorgrams (outputs of basic pitch cnn). */

 * Class to extract note events from posteriorgrams (outputs of basic pitch cnn).
 */
class Notes
{
public:
    typedef struct Event {
        double startTime;
        double endTime;
        int startFrame;
        int endFrame;
        int pitch; // pitch is not in Hz, but in "MIDI note number"
        double amplitude;
        std::vector<int> bends; // One vale of pitch bend per frame. Units is 1/3 of semitones.

        bool operator==(const struct Event&) const;
    } Event;

    typedef struct ConvertParams {
        /* Note segmentation (0.05 - 0.95, Split-Merge Notes) */
        float onsetThreshold = 0.3;
        /* Confidence threshold (0.05 to 0.95, More-Less notes) */
        float frameThreshold = 0.5;
        /* Minimum note length in number of frames */
        int minNoteLengthFrames = 11;
        bool inferOnsets = true;
        float maxFrequency = -1; // in Hz, -1 means unset
        float minFrequency = -1; // in Hz, -1 means unset
        bool melodiaTrick = true;
        PitchBendModes pitchBend = NoPitchBend;
        int energyThreshold = 11;
    } ConvertParams;

    /**
     * Create note events based on postegriorgram inputs
     * @param inNotesPG Note posteriorgrams
     * @param inOnsetsPG Onset posteriorgrams
     * @param inContoursPG Contour posteriorgrams
     * @param inParams input parameters
     * @param inNewAudio True: first time calling this function with this audio (these inNotesPG, inOnsetsPG, inContoursPG).
     *  False if same audio as last time with updated parameters.
     * @return
     */
    std::vector<Event> convert(const std::vector<std::vector<float>>& inNotesPG,
                               const std::vector<std::vector<float>>& inOnsetsPG,
                               const std::vector<std::vector<float>>& inContoursPG,
                               const ConvertParams& inParams,
                               bool inNewAudio);

    /**
     * Release any memory allocated by the class.
     */
    void clear();

    /**
     * Inplace sort of note events.
     * @param inOutEvents
     */
    static inline void sortEvents(std::vector<Notes::Event>& inOutEvents)
    {
        std::sort(inOutEvents.begin(), inOutEvents.end(), [](const Event& a, const Event& b) {