CSpectralFeatures Class Reference

#include <FEAPIExamplePluginSpectral.h>

Inherits CFeatureExtractBase.

Inheritance diagram for CSpectralFeatures:

[legend]Collaboration diagram for CSpectralFeatures:[legend]List of all members.

Public Member Functions
	CSpectralFeatures ()
virtual	~CSpectralFeatures ()
FEAPI_Error_t	SetPluginParameter (int iParameterIndex, float fValue)
float	GetPluginParameter (int iParameterIndex)
int	GetPluginResultLatency (int iResultIndex)
float	GetPluginProperty (FEAPI_PluginProperty_t ePluginProperty)
FEAPI_Error_t	InitializePlugin (float fInputSampleRate, int iNumberOfAudioChannels, int iHostApiMajorVersion, FEAPI_UserData_t *pstUserData)
FEAPI_Error_t	ProcessPlugin (const float **ppfInputBuffer, const FEAPI_TimeStamp_t *ptFEAPI_TimeStamp, int iNumberOfFrames)
FEAPI_Error_t	ProcessPluginDone ()
int	GetPluginSizeOfResult (int iResultIndex)
FEAPI_Error_t	GetPluginResult (int iResultIndex, float *pfResult, FEAPI_TimeStamp_t *ptFEAPI_TimeStamp)
FEAPI_Error_t	ResetPlugin ()

---

Constructor & Destructor Documentation

CSpectralFeatures::CSpectralFeatures (   )

Definition at line 185 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_ParameterDescription_t_tag::fDefaultValue, and zplVecLibDispatcher().

Here is the call graph for this function:

CSpectralFeatures::~CSpectralFeatures (   )  [virtual]

Definition at line 221 of file FEAPIExamplePluginSpectral.cpp. References CFeatureExtractBase::GetPluginNumOfInputs(), and CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

---

Member Function Documentation

float CSpectralFeatures::GetPluginParameter (  int  iParameterIndex  )  [virtual]

Gets the current value of a parameter. Parameters: iParameterIndex  : index of the parameter (setting) requested, index ranges from 0...NumOfParameters-1 Returns: float : value of the parameter with index iParameterIndex Reimplemented from CFeatureExtractBase. Definition at line 444 of file FEAPIExamplePluginSpectral.cpp. References CFeatureExtractBase::GetPluginNumOfParameters().

Here is the call graph for this function:

float CSpectralFeatures::GetPluginProperty (  FEAPI_PluginProperty_t  ePluginProperty  )  [virtual]

Gets an indication of the plugins capabilities. Parameters: ePluginProperty  : requested property Returns: float : corresponding value Implements CFeatureExtractBase. Definition at line 721 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_kMaxChannels, FEAPI_kMaxFrameSize, FEAPI_kMaxSampleRate, FEAPI_kMinChannels, FEAPI_kMinFrameSize, FEAPI_kMinSampleRate, FEAPI_kOptFrameSize, and kParamHopSize.

FEAPI_Error_t CSpectralFeatures::GetPluginResult (  int  iResultIndex, float *  pfResult, FEAPI_TimeStamp_t *  ptFEAPI_TimeStamp )  [virtual]

Gets one result. Parameters: iResultIndex  : index of the requested result/feature, index ranges from 0...NumOfResults-1 pfResult  : the result data is copied into this buffer *ptFEAPI_TimeStamp  : the time stamp of the result Returns: FEAPI_Error_t : FEAPI_kNoError when no error Implements CFeatureExtractBase. Definition at line 692 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_Error_t, and CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

int CSpectralFeatures::GetPluginResultLatency (  int  iResultIndex  )  [virtual]

Gets the maximum latency of one result. Parameters: iResultIndex  : index of the requested result (feature), index ranges from 0...NumOfResults-1 Returns: int : number of samples (at audio input sample rate) which is required to calculate this result the first time (negative values are not allowed, 0 means undefined) Reimplemented from CFeatureExtractBase. Definition at line 453 of file FEAPIExamplePluginSpectral.cpp.

int CSpectralFeatures::GetPluginSizeOfResult (  int  iResultIndex  )  [virtual]

Gets the size of one result in FEAPI_Signal_t values (4 bytes per value). Parameters: iResultIndex  : index of the result/feature the size is requested for, index ranges from 0...NumOfResults-1 Returns: int : size of result in FEAPI_Signal_t values (4 bytes per value) Implements CFeatureExtractBase. Definition at line 680 of file FEAPIExamplePluginSpectral.cpp. References CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

FEAPI_Error_t CSpectralFeatures::InitializePlugin (  float  fInputSampleRate, int  iNumberOfAudioChannels, int  iHostApiMajorVersion, FEAPI_UserData_t *  pstUserData )

initializes a new instance of the plugin Parameters: fInputSampleRate  : sample rate of input(s) in Hz iNumberOfAudioChannels  : number of input audio channels iHostApiMajorVersion  : major version number of host pstUserData  : pointer to user or vendor defined data (may be NULL) Returns: FEAPI_Error_t : FEAPI_kNoError when no error Reimplemented from CFeatureExtractBase. Definition at line 269 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_Error_t, FEAPI_TimeStamp_t, FEAPI_UserData_t, CFeatureExtractBase::GetPluginNumOfInputs(), CFeatureExtractBase::GetPluginNumOfResults(), CFeatureExtractBase::InitializePlugin(), kNumFeatures, kParamBlockSize, kParamHopSize, kParamWindowType, CFeatureExtractBase::SetPluginInputPinInfo(), CFeatureExtractBase::SetPluginParameterPinInfo(), CFeatureExtractBase::SetPluginResultPinInfo(), and zplfMalloc(). Referenced by SetPluginParameter().

Here is the call graph for this function:

FEAPI_Error_t CSpectralFeatures::ProcessPlugin (  const float **  ppfInputBuffer, const FEAPI_TimeStamp_t *  ptTimeStamps, int  iNumberOfFrames )

< Todo: : do discriminate between results! Definition at line 518 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_Error_t, CRingBuffer< T >::GetOff(), CFeatureExtractBase::GetPluginNumOfInputs(), CFeatureExtractBase::GetPluginNumOfResults(), CRingBuffer< T >::GetSamplesInBuffer(), kFeatureCentroid, kFeatureFlux, kFeatureRolloff, kFeatureSpread, CRingBuffer< T >::PutPostInc(), CRingBuffer< T >::SetReadPos(), and CzplfFFT_If::zplfFFT().

Here is the call graph for this function:

FEAPI_Error_t CSpectralFeatures::ProcessPluginDone (   )  [virtual]

< < < < < Todo: : take into account lower cutoff frequency : do discriminate between results! : do discriminate between results! : do discriminate between results! : do discriminate between results! Reimplemented from CFeatureExtractBase. Definition at line 459 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_Error_t, CFeatureExtractBase::GetPluginNumOfResults(), CRingBuffer< T >::GetPostInc(), CRingBuffer< T >::GetSamplesInBuffer(), kFeatureCentroid, kFeatureFlux, kFeatureRolloff, kFeatureSpread, and CzplfFFT_If::zplfFFT().

Here is the call graph for this function:

FEAPI_Error_t CSpectralFeatures::ResetPlugin (   )  [virtual]

Resets/clears all internal buffers and states, so that the plugin is in a state where it can start processing a new audio stream. Returns: FEAPI_Error_t : FEAPI_kNoError when no error Reimplemented from CFeatureExtractBase. Definition at line 710 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_Error_t, CFeatureExtractBase::GetPluginNumOfInputs(), and CRingBuffer< T >::Reset().

Here is the call graph for this function:

FEAPI_Error_t CSpectralFeatures::SetPluginParameter (  int  iParameterIndex, float  fValue )  [virtual]

Sets a parameter to a specified value. Parameters: iParameterIndex  : index of the parameter (setting) to be changed, index ranges from 0...NumOfParameters-1 fValue  : new value of the parameter Returns: FEAPI_Error_t : FEAPI_kNoError when no error Reimplemented from CFeatureExtractBase. Definition at line 423 of file FEAPIExamplePluginSpectral.cpp. References FEAPI_Error_t, FEAPI_ParameterDescription_t_tag::fRangeMax, FEAPI_ParameterDescription_t_tag::fRangeMin, fValue, CFeatureExtractBase::GetPluginNumOfParameters(), and InitializePlugin().

Here is the call graph for this function:

---

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

• FEAPIExamplePluginSpectral.h
• FEAPIExamplePluginSpectral.cpp

---