AudioMasker.H

Go to the documentation of this file.

/*
 libaudiomask - hybrid simultaneous audio masking threshold evaluation library
    Copyright (C) 2000-2018  Dr Matthew Raphael Flax

    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 3 of the License, or
    (at your option) any later version.

    This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef AUDIOMASKER_H_
#define AUDIOMASKER_H_

#ifdef _MSC_VER
#ifndef rint
#define rint round
#endif
#endif

#include <Debug.H>
#include <Eigen/Dense>
using namespace Eigen;

#define AUDIOMASKER_MULTICHANNEL_ERROR AUDIOMASKER_ERROR_OFFSET-1 
#define AUDIOMASKER_SAMPLECOUNT_ERROR AUDIOMASKER_ERROR_OFFSET-2 


class AudioMaskerDebug : virtual public Debug {
public:
    AudioMaskerDebug() {
#ifndef NDEBUG
    errors[AUDIOMASKER_MULTICHANNEL_ERROR]=std::string("AudioMasker: Can not handle more then one channel of audio. Please provide audio in a single column");
    errors[AUDIOMASKER_SAMPLECOUNT_ERROR]=std::string("AudioMasker: Please supply a sufficient number audio samples, try to provide at least 10*AudioMasker.getBankCount(). Please provide audio in a single column");
#endif
    }

    virtual ~AudioMaskerDebug() {}
};

#include "AudioMask/AudioMask.H"
#include "AudioMask/depukfb.H"
#include <fft/RealFFT.H>
#include <stdlib.h>

#define DEFAULT_FBCOUNT 100
#define DEFAULT_SAMPLECOUNT 512
#define DEFAULT_SAMPLEFREQ 44100
//#define DEFAULT_LOWFERQ 25

// Recurse defines the number of times we recurse the output to input >=2
//#define RECURSE 7

class AudioMasker : public AudioMask {
    double **output; 
    double **powOutput; 
    double *input; 
    int sampleCount; 
    int bankCount; 

    RealFFTData *fftData; 
    RealFFT *fft; 

    void FBDeMalloc(void);

    void FBMalloc(void);  

    void process(void); 
public:
    DepUKFB *pfb; 
    //  GTFB *gtfb; //!< gammatone filters

    AudioMasker(int sampFreq, int fBankCount);
    AudioMasker(void); 
    ~AudioMasker(void); 

    void excite(short int *Input, int sCount);

    void excite(double *Input, int sCount);

    template<typename Derived>
    int excite(const Eigen::DenseBase<Derived> &Input) {
        if (Input.cols()>Input.rows() || Input.cols()>1)
            return AUDIOMASKER_MULTICHANNEL_ERROR;
        if (Input.rows() < 10*bankCount)
            return AUDIOMASKER_SAMPLECOUNT_ERROR;

        if (Input.rows() != sampleCount)// Check for matrix re-size
            FBDeMalloc();

        sampleCount=Input.rows();

        if (!output) // Check for null matrix
            FBMalloc();

        for (int i=0;i<sampleCount;i++) //copy the input as double
            input[i]=Input(i,0);

        process(); //Do the processing
        return NO_ERROR;
    }

    double findThreshold(double freq);

    int getBankCount(void){return bankCount;}
};
#endif //AUDIOMASKER_H_