Pitch.h

Go to the documentation of this file.

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

/*
    Sonic Visualiser
    An audio file viewer and annotation editor.
    Centre for Digital Music, Queen Mary, University of London.
    This file copyright 2006 Chris Cannam.
    
    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 SV_PITCH_H
#define SV_PITCH_H

#include <QString>

class Pitch
{
public:
    static double getFrequencyForPitch(int midiPitch,
                                      double centsOffset = 0,
                                      double concertA = 0.0);

    static int getPitchForFrequency(double frequency,
                                    double *centsOffsetReturn = 0,
                                    double concertA = 0.0);

    static int getPitchForFrequency(double frequency,
                                    float *centsOffsetReturn,
                                    double concertA = 0.0) {
        double c;
        int p = getPitchForFrequency(frequency, &c, concertA);
        if (centsOffsetReturn) *centsOffsetReturn = float(c);
        return p;
    }

    static int getPitchForFrequencyDifference(double frequencyA,
                                              double frequencyB,
                                              double *centsOffsetReturn = 0,
                                              double concertA = 0.0);

    static int getPitchForFrequencyDifference(double frequencyA,
                                              double frequencyB,
                                              float *centsOffsetReturn,
                                              double concertA = 0.0) {
        double c;
        int p = getPitchForFrequencyDifference(frequencyA, frequencyB,
                                               &c, concertA);
        if (centsOffsetReturn) *centsOffsetReturn = float(c);
        return p;
    }
    
    static int getPitchForNoteAndOctave(int note, int octave);
    
    static void getNoteAndOctaveForPitch(int midiPitch, int &note, int &octave);

    static QString getPitchLabel(int midiPitch,
                                 double centsOffset = 0,
                                 bool useFlats = false);
    
    static QString getPitchLabelForFrequency(double frequency,
                                             double concertA = 0.0,
                                             bool useFlats = false);

    static QString getLabelForPitchRange(int semis, double cents = 0);

    static bool isFrequencyInMidiRange(double frequency,
                                       double concertA = 0.0);
};


#endif