CZeroCrossings Class Reference

#include <FEAPIExamplePluginZeroCrossings.h>

Inherits CFeatureExtractBase.

Inheritance diagram for CZeroCrossings:

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

Public Member Functions
	CZeroCrossings ()
virtual	~CZeroCrossings ()
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

CZeroCrossings::CZeroCrossings (   )

Definition at line 118 of file FEAPIExamplePluginZeroCrossings.cpp. References zplVecLibDispatcher().

Here is the call graph for this function:

CZeroCrossings::~CZeroCrossings (   )  [virtual]

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

Here is the call graph for this function:

---

Member Function Documentation

float CZeroCrossings::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 359 of file FEAPIExamplePluginZeroCrossings.cpp. References CFeatureExtractBase::GetPluginNumOfParameters().

Here is the call graph for this function:

float CZeroCrossings::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 550 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_kMaxChannels, FEAPI_kMaxFrameSize, FEAPI_kMaxSampleRate, FEAPI_kMinChannels, FEAPI_kMinFrameSize, FEAPI_kMinSampleRate, FEAPI_kOptFrameSize, and kHopSize.

FEAPI_Error_t CZeroCrossings::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 521 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_Error_t, and CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

int CZeroCrossings::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 368 of file FEAPIExamplePluginZeroCrossings.cpp.

int CZeroCrossings::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 509 of file FEAPIExamplePluginZeroCrossings.cpp. References CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

FEAPI_Error_t CZeroCrossings::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 181 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_Error_t, FEAPI_TimeStamp_t, FEAPI_UserData_t, CFeatureExtractBase::GetPluginNumOfInputs(), CFeatureExtractBase::GetPluginNumOfResults(), CFeatureExtractBase::InitializePlugin(), kBlockSize, kFeatureDescription, kFeatureIndex, kFeatureIsQuantized, kFeatureName, kFeatureRangeMax, kFeatureRangeMin, kFeatureUnit, kHopSize, kParam1DefaultValue, kParam1Description, kParam1Index, kParam1IsChangeableInRealTime, kParam1Name, kParam1QuantizedTo, kParam1RangeMax, kParam1RangeMin, kParam1Unit, kParam2DefaultValue, kParam2Description, kParam2Index, kParam2IsChangeableInRealTime, kParam2Name, kParam2QuantizedTo, kParam2RangeMax, kParam2RangeMin, kParam2Unit, kParam3DefaultValue, kParam3Description, kParam3Index, kParam3IsChangeableInRealTime, kParam3Name, kParam3QuantizedTo, kParam3RangeMax, kParam3RangeMin, kParam3Unit, CFeatureExtractBase::SetPluginInputPinInfo(), CFeatureExtractBase::SetPluginParameterPinInfo(), CFeatureExtractBase::SetPluginResultPinInfo(), and zplfMalloc(). Referenced by SetPluginParameter().

Here is the call graph for this function:

FEAPI_Error_t CZeroCrossings::ProcessPlugin (  const float **  ppfInputBuffer, const FEAPI_TimeStamp_t *  ptFEAPI_TimeStamp, int  iNumberOfFrames )

Definition at line 396 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_Error_t, CRingBuffer< T >::GetOff(), CFeatureExtractBase::GetPluginNumOfInputs(), CFeatureExtractBase::GetPluginNumOfResults(), CRingBuffer< T >::GetSamplesInBuffer(), CRingBuffer< T >::PutPostInc(), and CRingBuffer< T >::SetReadPos().

Here is the call graph for this function:

FEAPI_Error_t CZeroCrossings::ProcessPluginDone (   )  [virtual]

Signals that no more input data is available (does the final processing). Returns: FEAPI_Error_t : FEAPI_kNoError when no error Reimplemented from CFeatureExtractBase. Definition at line 374 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_Error_t, CFeatureExtractBase::GetPluginNumOfResults(), CRingBuffer< T >::GetPostInc(), and CRingBuffer< T >::GetSamplesInBuffer().

Here is the call graph for this function:

FEAPI_Error_t CZeroCrossings::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 539 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_Error_t, CFeatureExtractBase::GetPluginNumOfInputs(), and CRingBuffer< T >::Reset().

Here is the call graph for this function:

FEAPI_Error_t CZeroCrossings::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 320 of file FEAPIExamplePluginZeroCrossings.cpp. References FEAPI_Error_t, CFeatureExtractBase::GetPluginNumOfParameters(), InitializePlugin(), kBlockSize, kChannelMode, and kHopSize.

Here is the call graph for this function:

---

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

• FEAPIExamplePluginZeroCrossings.h
• FEAPIExamplePluginZeroCrossings.cpp

---