Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

CFindAbsoluteRms Class Reference

#include <FEAPIExamplePluginFindRms.h>

Inherits CFeatureExtractBase.

Inheritance diagram for CFindAbsoluteRms:

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

Detailed Description

the class CFindAbsoluteMax is an example class to demonstrate how to implement a plugin for the Feature Extraction plugin API. The functionality of this plugin is to find the absolute maximum value per audio channel for each input block and return the two results in dBFS.

Definition at line 50 of file FEAPIExamplePluginFindRms.h.

Public Member Functions

 CFindAbsoluteRms ()
virtual ~CFindAbsoluteRms ()
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

CFindAbsoluteRms::CFindAbsoluteRms (   ) 
 

Definition at line 68 of file FEAPIExamplePluginFindRms.cpp.

CFindAbsoluteRms::~CFindAbsoluteRms (   )  [virtual]
 

Definition at line 89 of file FEAPIExamplePluginFindRms.cpp.

Member Function Documentation

float CFindAbsoluteRms::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 175 of file FEAPIExamplePluginFindRms.cpp.

float CFindAbsoluteRms::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 261 of file FEAPIExamplePluginFindRms.cpp.

References FEAPI_kMaxChannels, FEAPI_kMaxFrameSize, FEAPI_kMaxSampleRate, FEAPI_kMinChannels, FEAPI_kMinFrameSize, FEAPI_kMinSampleRate, and FEAPI_kOptFrameSize.

FEAPI_Error_t CFindAbsoluteRms::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 233 of file FEAPIExamplePluginFindRms.cpp.

References FEAPI_Error_t, and CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

int CFindAbsoluteRms::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 182 of file FEAPIExamplePluginFindRms.cpp.

int CFindAbsoluteRms::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 221 of file FEAPIExamplePluginFindRms.cpp.

References CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

FEAPI_Error_t CFindAbsoluteRms::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 107 of file FEAPIExamplePluginFindRms.cpp.

References _FEATURE_DESCRIPTION, _FEATURE_NAME, _FEATURE_QUANTIZED, _FEATURE_RANGE_MAX, _FEATURE_RANGE_MIN, _FEATURE_SAMPLERATE, _FEATURE_UNIT, FEAPI_Error_t, FEAPI_TimeStamp_t, FEAPI_UserData_t, CFeatureExtractBase::InitializePlugin(), CFeatureExtractBase::SetPluginInputPinInfo(), and CFeatureExtractBase::SetPluginResultPinInfo().

Here is the call graph for this function:

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

Definition at line 194 of file FEAPIExamplePluginFindRms.cpp.

References FEAPI_Error_t, and CFeatureExtractBase::GetPluginNumOfInputs().

Here is the call graph for this function:

FEAPI_Error_t CFindAbsoluteRms::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 188 of file FEAPIExamplePluginFindRms.cpp.

References FEAPI_Error_t.

FEAPI_Error_t CFindAbsoluteRms::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 249 of file FEAPIExamplePluginFindRms.cpp.

References FEAPI_Error_t, and CFeatureExtractBase::GetPluginNumOfResults().

Here is the call graph for this function:

FEAPI_Error_t CFindAbsoluteRms::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 168 of file FEAPIExamplePluginFindRms.cpp.

References FEAPI_Error_t.

The documentation for this class was generated from the following files:
Generated on Fri Mar 23 10:28:57 2007 for FEAPI Plugin Documentation by  doxygen 1.3.9.1