tuner.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright 2016-2017 Karolin Stange, Christoph Wick, and Haye Hinrichsen
 *
 * This file is part of JustIntonation.
 *
 * JustIntonation 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 3 of the License, or (at your
 * option) any later version.
 *
 * JustIntonation is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along 
 * with JustIntonation. If not, see http://www.gnu.org/licenses/.
 *****************************************************************************/

//=============================================================================
//                  Tuner: Module for adaptive tuning
//=============================================================================

#ifndef TUNER_H
#define TUNER_H

#include <QObject>
#include <QVector>
#include <QMap>
#include <QVariant>
#include <QTimer>
#include <QElapsedTimer>
#include <QMidiMessage>

#include "tunerreadme.h"
#include "system/threadbase.h"
#include "tunerkeydata.h"
#include "tuneralgorithm.h"


class Tuner : public ThreadBase
{
    Q_OBJECT
public:
    Tuner();                            // Constructor
    bool init() override final;         // Initialization after construction
    bool start() override final;        // Start tuner thread

    //-------------------------------------------------------------------------

public slots:

    void setFrequencyOfA4 (double f=440);
    void setTuningMode (int mode, int wolfsShift);      // 0:ET  1:UT  2:JI
    void enableTuning (bool enable);
    void setStaticTuningMode (bool enable, int reference = 0);
    void setEnvelopeParameters (
         double secondsSustainBass,
         double secondsSustainTreble,
         double secondsRelease);

    void setIntervalSize   (int semitones, double cents);
    void setIntervalWeight (int semitones, double weight);
    void setPitchProgressionCompensationParameter (double lambda);
    void setDelayParameter (double delay);
    void setMemoryLength (double seconds);

    void receiveMidiEvent (QMidiMessage event);
    void resetPitchProgression();

    //-------------------------------------------------------------------------

signals:
    void signalReadyForReceivingParameters();

    void signalTuningCorrections (QMap<int,double> corrections);

    void signalAveragePitchDrift (double progression);

    void signalIntervalString (QVariant str);

    void signalTension (QVariant mu);

    //-------------------------------------------------------------------------

private:
    // Constants:
    const uint tuningIntervalMsec = 20;         

    // Constants for envelope simulation:
    const uint updateIntervalMsec = 20;         
    const uint noteTimeoutSeconds = 60;
    const double cutoffIntensity = 0.001;
    const double cutoffMemory = 0.0001;
    const double memoryOnSeconds = 0.3;
    const double memoryOnFactor  = exp(-0.005*updateIntervalMsec/memoryOnSeconds);

private:
    // Member variables
    TunerAlgorithm mTunerAlgorithm;             
    double mGlobalTargetPitchInCents;           
    int mTuningMode;                            
    int mStaticReferenceKey;                    
    int mWolfsIntervalShift;                    
    bool mTuningEnabled;                        
    QString mLastMessage;                       
    QVector<double> mIntervalSizes;             
    QVector<double> mIntervalWeights;           
    QVector<KeyData> mKeyDataVector;            
    QElapsedTimer *pElapsedTimer;               
    bool mStaticTuningModeEnabled;              
    double mPitchAutoCorrectionParameter;       
    double mDelayParameter;                     
    double mMemoryOffFactor;                    
    qint8 mWaitingTimeMsec;                     

private:
    friend class TunerAlgorithm;

    qint64 getNow();
    void handlePitchDrift();
    void emitPitchCorrections();

    virtual void initiallyCalledWorker() override final;
    virtual void periodicallyCalledWorker() override final;
    virtual void finallyCalledWorker() override final;

private slots:
    void tune();
};

#endif // TUNER_H