#include <AudioMasker.H>

Inheritance diagram for AudioMasker:

Collaboration diagram for AudioMasker:

Public Member Functions
	AudioMasker (int sampFreq, int fBankCount)

	AudioMasker (void)
	Audio masker constructor - allowing specification of fs and sub-band count later. More...

	~AudioMasker (void)
	Audio masker deconstructor. More...

void	excite (short int *Input, int sCount)

void	excite (double *Input, int sCount)

template<typename Derived >
int	excite (const Eigen::DenseBase< Derived > &Input)

double	findThreshold (double freq)

int	getBankCount (void)

Public Member Functions inherited from AudioMask
	AudioMask (int sampFreq, int fBankCount)

	~AudioMask (void)
	Deconstructor. More...

void	setCFreq (int which, double value)

void	exciteTerhardt (double **filterBankOutput, int sampleCount)

void	exciteBeerends (double **filterBankOutput, int sampleCount)

Public Attributes
DepUKFB *	pfb
	roex filters More...

Public Attributes inherited from AudioMask
double *	mask
	The audio mask. More...

double	max
	The maximum value of the mask. More...

Private Member Functions
void	FBDeMalloc (void)
	Filter bank output matrix memory de-allocation. More...

void	FBMalloc (void)
	Filter bank output matrix memory allocation. More...

void	process (void)
	Process the transformation. More...

Private Attributes
double **	output
	Filter bank output. More...

double **	powOutput
	Filter bank output power. More...

double *	input
	Filter bank input. More...

int	sampleCount
	The sample count. More...

int	bankCount
	The filter bank count. More...

RealFFTData *	fftData
	The FFT data. More...

RealFFT *	fft
	The FFT. More...

Additional Inherited Members
Protected Attributes inherited from AudioMask
int	fs
	Sample frequency. More...

Detailed Description

libAudioMask - Simultaneous audio mask threshold estimation library

This code also implements the roex auditory filters.

Please read the article located on the debian file system file:///usr/shar/doc/libaudiomask-1.0/Flax.2000.Improved.Auditory.Masking.Models.pdf

It may also be found on the web http://www.assta.org/sst/SST-00/cache/SST-00-Chapter9-p2.pdf

This example shows how to use the hybrid simultaneous audio masking class to find the masking threshold of a time domain signal.

========================= HOWTO =============================== See the AudioMaskerExample.C example for a more detailed scenario.

// First find the masking threshold
AudioMasker masker(sampleFreq, count); // Create the audio masker class using fs=sampleFreq and count filters
masker.excite(input, sampleCount); // find the mask for the array of input data which has sampleCount time samples.
// Now do something with the masking threshold ...
// The frequency domain mask is now located here
for (int j=0; j<count;j++)
    masker.mask[j]; // This is the mask at each of the count frequencies of interest
// A more sophisticated example - find the threshold for each Fourier bin
double fact=(double)sampleFreq/((double)sampleCount-1.0); // convert from an index to the equivalent * Fourier bin frequency
for (int j=0; j<halfSampleCount;j++){
    cout<<"finding for freq "<<j*fact<<'\t'; // The frequency we are inspecting
    double threshold=masker.findThreshold(j*fact); // The masking threshold
    20*log10(threshold); // The threshold in decibels (dB)
}

Examples:: AudioMaskerExample.C.

Definition at line 100 of file AudioMasker.H.

Constructor & Destructor Documentation

◆ AudioMasker() [1/2]

AudioMasker::AudioMasker	(	int	sampFreq,
		int	fBankCount
	)

The Audio masking constructor @ sampFreq The sample frequency of the time domain data @ fBankCount The number of filter banks

Definition at line 30 of file AudioMasker.C.

Here is the call graph for this function:

◆ AudioMasker() [2/2]

AudioMasker::AudioMasker ( void )

Audio masker constructor - allowing specification of fs and sub-band count later.

Definition at line 46 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~AudioMasker()

AudioMasker::~AudioMasker ( void )

Audio masker deconstructor.

Definition at line 62 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

◆ excite() [1/3]

void AudioMasker::excite	(	short int *	Input,
		int	sCount
	)

Finds the excitation for input data @ Input Using short int input data @ sCount samples

These should be implemented differently for different Input types

Examples:: AudioMaskerExample.C.

Definition at line 171 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ excite() [2/3]

void AudioMasker::excite	(	double *	Input,
		int	sCount
	)

Finds the excitation for input data @ Input Using double input data @ sCount samples

Definition at line 187 of file AudioMasker.C.

Here is the call graph for this function:

◆ excite() [3/3]

template<typename Derived >

int AudioMasker::excite ( const Eigen::DenseBase< Derived > & Input )

inline

Finds the excitation for input data. @ Input The data in the form of an Eigen column.

Returns: NO_ERROR on success, or the appropriate error otherwise.

Definition at line 148 of file AudioMasker.H.

Here is the call graph for this function:

◆ FBDeMalloc()

void AudioMasker::FBDeMalloc ( void )

private

Filter bank output matrix memory de-allocation.

Definition at line 69 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FBMalloc()

void AudioMasker::FBMalloc ( void )

private

Filter bank output matrix memory allocation.

Definition at line 102 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findThreshold()

double AudioMasker::findThreshold ( double freq )

Returns the simultaneous masking threshold at a particular frequency @ freq The frequency of interest

Examples:: AudioMaskerExample.C.

Definition at line 203 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBankCount()

int AudioMasker::getBankCount ( void )

inline

Returns: The number of auditoy filters in use.

Definition at line 177 of file AudioMasker.H.

Here is the caller graph for this function:

◆ process()

void AudioMasker::process ( void )

private

Process the transformation.

Definition at line 217 of file AudioMasker.C.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ bankCount

int AudioMasker::bankCount

private

The filter bank count.

Definition at line 105 of file AudioMasker.H.

◆ fft

RealFFT* AudioMasker::fft

private

The FFT.

Definition at line 108 of file AudioMasker.H.

◆ fftData

RealFFTData* AudioMasker::fftData

private

The FFT data.

Definition at line 107 of file AudioMasker.H.

◆ input

double* AudioMasker::input

private

Filter bank input.

Definition at line 103 of file AudioMasker.H.

◆ output

double** AudioMasker::output

private

Filter bank output.

Definition at line 101 of file AudioMasker.H.

◆ pfb

DepUKFB* AudioMasker::pfb

roex filters

Definition at line 116 of file AudioMasker.H.

◆ powOutput

double** AudioMasker::powOutput

private

Filter bank output power.

Definition at line 102 of file AudioMasker.H.

◆ sampleCount

int AudioMasker::sampleCount

private

The sample count.

Definition at line 104 of file AudioMasker.H.

The documentation for this class was generated from the following files:

/tmp/gtkiostream/include/AudioMask/AudioMasker.H
/tmp/gtkiostream/src/AudioMask/AudioMasker.C

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AudioMasker() [1/2]

◆ AudioMasker() [2/2]

◆ ~AudioMasker()

Member Function Documentation

◆ excite() [1/3]

◆ excite() [2/3]

◆ excite() [3/3]

◆ FBDeMalloc()

◆ FBMalloc()

◆ findThreshold()

◆ getBankCount()

◆ process()

Member Data Documentation

◆ bankCount

◆ fft

◆ fftData

◆ input

◆ output

◆ pfb

◆ powOutput

◆ sampleCount