annotate MonoNote.h @ 85:bf6b9338233d

added script

/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */

/*
    pYIN - A fundamental frequency estimator for monophonic audio
    Centre for Digital Music, Queen Mary, University of London.
    
    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.  See the file
    COPYING included with this distribution for more information.
*/

#ifndef _MONONOTE_H_
#define _MONONOTE_H_

#include "MonoNoteHMM.h"
#include "MonoNoteParameters.h"

#include <iostream>
#include <vector>
#include <exception>

using std::vector;
using std::pair;

class MonoNote {
public:
    MonoNote();
    virtual ~MonoNote();
    
    struct FrameOutput {
        size_t frameNumber;
        double pitch;
        size_t noteState; // unvoiced, attack, stable, release, inter
        FrameOutput() :  frameNumber(0), pitch(-1.0), noteState(0) { }
        FrameOutput(size_t _frameNumber, double _pitch, size_t _noteState) :
            frameNumber(_frameNumber), pitch(_pitch), noteState(_noteState) { }
    };
    // pitchProb is a frame-wise vector carrying a vector of pitch-probability pairs
    const vector<FrameOutput> process(const vector<vector<pair<double, double> > > pitchProb);
private:
    MonoNoteHMM hmm;
};

#endif