AAX_CHostProcessor Class Reference

#include <AAX_CHostProcessor.h>

Inheritance diagram for AAX_CHostProcessor:

Collaboration diagram for AAX_CHostProcessor:

Description

Concrete implementation of the AAX_IHostProcessor interface for non-real-time processing.

Host processor objects are used to process regions of audio data in a non-real-time context.

• Host processors must generate output samples linearly and incrementally, but may randomly access samples from the processing region on the timeline for input. See GetAudio() for more information.
• Host processors may re-define the processing region using AAX_CHostProcessor::TranslateOutputBounds().

See Also

AAX_IHostProcessorDelegate

Public Member Functions
	AAX_CHostProcessor (void)
virtual	~AAX_CHostProcessor ()
Initialization and uninitialization
virtual AAX_Result	Initialize (IACFUnknown *iController)
	Host Processor initialization. More...
virtual AAX_Result	Uninitialize ()
	Host Processor teardown. More...
Host processor interface
virtual AAX_Result	InitOutputBounds (int64_t iSrcStart, int64_t iSrcEnd, int64_t *oDstStart, int64_t *oDstEnd)
	Sets the processing region. More...
virtual AAX_Result	SetLocation (int64_t iSample)
	Updates the relative sample location of the current processing frame. More...
virtual AAX_Result	RenderAudio (const float *const iAudioIns[], int32_t iAudioInCount, float *const iAudioOuts[], int32_t iAudioOutCount, int32_t *ioWindowSize)
	Perform the signal processing. More...
virtual AAX_Result	PreRender (int32_t iAudioInCount, int32_t iAudioOutCount, int32_t iWindowSize)
	Invoked right before the start of a Preview or Render pass. More...
virtual AAX_Result	PostRender ()
	Invoked at the end of a Render pass. More...
virtual AAX_Result	AnalyzeAudio (const float *const iAudioIns[], int32_t iAudioInCount, int32_t *ioWindowSize)
	Override this method if the plug-in needs to analyze the audio prior to a Render pass. More...
virtual AAX_Result	PreAnalyze (int32_t iAudioInCount, int32_t iWindowSize)
	Invoked right before the start of an Analysis pass. More...
virtual AAX_Result	PostAnalyze ()
	Invoked at the end of an Analysis pass. More...
Public Member Functions inherited from AAX_IHostProcessor
ACFMETHOD()	InternalQueryInterface (const acfIID &riid, void **ppvObjOut)
Public Member Functions inherited from IACFUnknown
virtual BEGIN_ACFINTERFACE ACFRESULT ACFMETHODCALLTYPE	QueryInterface (const acfIID &iid, void **ppOut)=0
	Returns pointers to supported interfaces. More...
virtual acfUInt32 ACFMETHODCALLTYPE	AddRef (void)=0
	Increments reference count. More...
virtual acfUInt32 ACFMETHODCALLTYPE	Release (void)=0
	Decrements reference count. More...

Convenience methods
AAX_IEffectParameters *	GetEffectParameters ()
const AAX_IEffectParameters *	GetEffectParameters () const
AAX_IHostProcessorDelegate *	GetHostProcessorDelegate ()
const AAX_IHostProcessorDelegate *	GetHostProcessorDelegate () const
int64_t	GetLocation () const
	The relative sample location of the current processing frame. More...
int64_t	GetInputRange () const
	The length (in samples) of the current timeline selection. More...
int64_t	GetOutputRange () const
	The length (in samples) of the clip that will be rendered to the timeline. More...
int64_t	GetSrcStart () const
	The sample position of the beginning of the current timeline selection, relative to the beginning current selection, i.e. 0. More...
int64_t	GetSrcEnd () const
	The sample position of the end of the current timeline selection, relative to the beginning of the current selection. More...
int64_t	GetDstStart () const
	The sample position of the beginning of the of the clip that will be rendered to the timeline, relative to the beginning current selection. More...
int64_t	GetDstEnd () const
	The sample position of the end of the of the clip that will be rendered to the timeline, relative to the beginning current selection. More...
virtual AAX_Result	TranslateOutputBounds (int64_t iSrcStart, int64_t iSrcEnd, int64_t &oDstStart, int64_t &oDstEnd)
	Define the boundaries of the clip that will be rendered to the timeline. More...
virtual AAX_Result	GetAudio (const float *const iAudioIns[], int32_t iAudioInCount, int64_t iLocation, int32_t *ioNumSamples)
	Randomly access audio from the timeline. More...
virtual int32_t	GetSideChainInputNum ()
	CALL: Returns the index of the side chain input buffer. More...
AAX_IController *	Controller ()
const AAX_IController *	Controller () const
AAX_IHostProcessorDelegate *	HostProcessorDelegate ()
const AAX_IHostProcessorDelegate *	HostProcessorDelegate () const
AAX_IEffectParameters *	EffectParameters ()
const AAX_IEffectParameters *	EffectParameters () const

Constructor & Destructor Documentation

AAX_CHostProcessor::AAX_CHostProcessor

(

void

)

virtual AAX_CHostProcessor::~AAX_CHostProcessor ( )

virtual

Member Function Documentation

virtual AAX_Result AAX_CHostProcessor::Initialize ( IACFUnknown *  iController )

virtual

Host Processor initialization.

Parameters

[in]

iController

A versioned reference that can be resolved to both an AAX_IController interface and an AAX_IHostProcessorDelegate

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::Uninitialize ( )

virtual

Host Processor teardown.

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::InitOutputBounds ( int64_t  iSrcStart, int64_t  iSrcEnd, int64_t *  oDstStart, int64_t *  oDstEnd  )

virtual

Sets the processing region.

This method allows offline processing plug-ins to vary the length and/or start start/end points of the audio processing region.

This method is called in a few different scenarios:

• Before an analyze, process or preview of data begins.
• At the end of every preview loop.
• After the user makes a new data selection on the timeline.

Plug-ins that inherit from AAX_CHostProcessor should not override this method. Instead, use the following convenience functions:

• To retrieve the length or boundaries of the processing region, use GetInputRange(), GetSrcStart(), etc.
• To change the boundaries of the processing region before processing begins, use AAX_CHostProcessor::TranslateOutputBounds()

Note

Currently, a host processor may not randomly access samples outside of the boundary defined by oDstStart and oDstEnd

Legacy Porting Notes:

DAE no longer makes use of the mStartBound and mEndBounds member variables that existed in the legacy RTAS/TDM SDK. Use oDstStart and oDstEnd instead (preferably by overriding TranslateOutputBounds().)

Parameters

[in]	iSrcStart	The selection start of the user selected region. This is will always return 0 for a given selection on the timeline.
[in]	iSrcEnd	The selection end of the user selected region. This will always return the value of the selection length on the timeline.
[in]	oDstStart	The starting sample location in the output audio region. By default, this is the same as iSrcStart.
[in]	oDstEnd	The ending sample location in the output audio region. By default, this is the same as iSrcEnd.

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::SetLocation ( int64_t  iSample )

virtual

Updates the relative sample location of the current processing frame.

This method is called by the host to update the relative sample location of the current processing frame.

Note

Plug-ins should not override this method; instead, use AAX_CHostProcessor::GetLocation() to retrieve the current relative sample location.

Parameters

[in]

iSample

The sample location of the first sample in the current processing frame relative to the beginning of the full processing buffer

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::RenderAudio ( const float *const  iAudioIns[], int32_t  iAudioInCount, float *const  iAudioOuts[], int32_t  iAudioOutCount, int32_t *  ioWindowSize  )

virtual

Perform the signal processing.

This method is called by the host to invoke the plug-in's signal processing.

Legacy Porting Notes:

This method is a replacement for the AudioSuite ProcessAudio method

Parameters

[in]	iAudioIns	Input audio buffer
[in]	iAudioInCount	The number if input channels
[in]	iAudioOuts	The number of output channels
[in]	iAudioOutCount	A user defined destination end of the ingested audio
[in]	ioWindowSize	Window buffer length of the received audio

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::PreRender ( int32_t  iAudioInCount, int32_t  iAudioOutCount, int32_t  iWindowSize  )

virtual

Invoked right before the start of a Preview or Render pass.

This method is called by the host to allow a plug-in to make any initializations before processing actually begins. Upon a Preview pass, PreRender will also be called at the beginning of every "loop".

Parameters

[in]	iAudioInCount	The number if input channels
[in]	iAudioOutCount	The number of output channels
[in]	iWindowSize	Window buffer length of the ingested audio

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::PostRender ( )

virtual

Invoked at the end of a Render pass.

Note

Upon a Preview pass, PostRender will not be called until Preview has stopped.

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::AnalyzeAudio ( const float *const  iAudioIns[], int32_t  iAudioInCount, int32_t *  ioWindowSize  )

virtual

Override this method if the plug-in needs to analyze the audio prior to a Render pass.

Use this after declaring the appropriate properties in Describe. See AAX_eProperty_RequiresAnalysis and AAX_eProperty_OptionalAnalysis

Legacy Porting Notes:

Ported from AudioSuite's AnalyzeAudio(bool isMasterBypassed) method

Parameters

[in]	iAudioIns	Input audio buffer
[in]	iAudioInCount	Output audio buffer
[in]	ioWindowSize	Window buffer length of the ingested audio

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::PreAnalyze ( int32_t  iAudioInCount, int32_t  iWindowSize  )

virtual

Invoked right before the start of an Analysis pass.

This method is called by the host to allow a plug-in to make any initializations before an Analysis pass actually begins.

Parameters

[in]	iAudioInCount	The number if input channels
[in]	iWindowSize	Window buffer length of the ingested audio

Implements AAX_IACFHostProcessor.

virtual AAX_Result AAX_CHostProcessor::PostAnalyze ( )

virtual

Invoked at the end of an Analysis pass.

Implements AAX_IACFHostProcessor.

AAX_IEffectParameters* AAX_CHostProcessor::GetEffectParameters ( void  )

inline

const AAX_IEffectParameters* AAX_CHostProcessor::GetEffectParameters ( void  ) const

inline

AAX_IHostProcessorDelegate* AAX_CHostProcessor::GetHostProcessorDelegate ( )

inline

const AAX_IHostProcessorDelegate* AAX_CHostProcessor::GetHostProcessorDelegate ( ) const

inline

int64_t AAX_CHostProcessor::GetLocation ( ) const

inline

The relative sample location of the current processing frame.

This method returns the relative sample location for the current RenderAudio() processing frame. For example, if a value of 10 is provided for the RenderAudio() ioWindow parameter, then calls to this method from within each execution of RenderAudio() will return 0, 10, 20,...

int64_t AAX_CHostProcessor::GetInputRange ( ) const

inline

The length (in samples) of the current timeline selection.

int64_t AAX_CHostProcessor::GetOutputRange ( ) const

inline

The length (in samples) of the clip that will be rendered to the timeline.

int64_t AAX_CHostProcessor::GetSrcStart ( ) const

inline

The sample position of the beginning of the current timeline selection, relative to the beginning current selection, i.e. 0.

int64_t AAX_CHostProcessor::GetSrcEnd ( ) const

inline

The sample position of the end of the current timeline selection, relative to the beginning of the current selection.

int64_t AAX_CHostProcessor::GetDstStart ( ) const

inline

The sample position of the beginning of the of the clip that will be rendered to the timeline, relative to the beginning current selection.

This value will be equal to the value returned by GetSrcStart() unless the selection boundaries have been modified by overriding TranslateOutputBounds()

int64_t AAX_CHostProcessor::GetDstEnd ( ) const

inline

The sample position of the end of the of the clip that will be rendered to the timeline, relative to the beginning current selection.

This value will be equal to the value returned by GetSrcStart() unless the selection boundaries have been modified by overriding TranslateOutputBounds()

virtual AAX_Result AAX_CHostProcessor::TranslateOutputBounds ( int64_t  iSrcStart, int64_t  iSrcEnd, int64_t &  oDstStart, int64_t &  oDstEnd  )

protectedvirtual

Define the boundaries of the clip that will be rendered to the timeline.

This method is called from AAX_CHostProcessor::InitOutputBounds(), providing a convenient hook for re-defining the processing region boundaries. See InitOutputBounds() for more information.

Parameters

[in]	iSrcStart	The selection start of the user selected region. This is will always return 0 for a given selection on the timeline.
[in]	iSrcEnd	The selection end of the user selected region. This will always return the value of the selection length on the timeline.
[in]	oDstStart	The starting sample location in the output audio region. By default, this is the same as iSrcStart.
[in]	oDstEnd	The ending sample location in the output audio region. By default, this is the same as iSrcEnd.

virtual AAX_Result AAX_CHostProcessor::GetAudio ( const float *const  iAudioIns[], int32_t  iAudioInCount, int64_t  iLocation, int32_t *  ioNumSamples  )

protectedvirtual

Randomly access audio from the timeline.

This is a convenience wrapper around AAX_IHostProcessorDelegate::GetAudio().

Parameters

[in]

iAudioIns

Timeline audio buffer(s). This must be set to iAudioIns from AAX_IHostProcessor::RenderAudio()

Parameters

[in]

iAudioInCount

Number of buffers in iAudioIns. This must be set to iAudioInCount from AAX_IHostProcessor::RenderAudio()

Parameters

[in]	iLocation	A sample location relative to the beginning of the currently processed region, e.g. a value of 0 corresponds to the timeline location returned by AAX_CHostProcessor::GetSrcStart()
[in,out]	ioNumSamples	Input: The maximum number of samples to read. Output: The actual number of samples that were read from the timeline

virtual int32_t AAX_CHostProcessor::GetSideChainInputNum ( )

protectedvirtual

CALL: Returns the index of the side chain input buffer.

This is a convenience wrapper around AAX_IHostProcessorDelegate::GetSideChainInputNum()

AAX_IController* AAX_CHostProcessor::Controller ( void  )

inlineprotected

const AAX_IController* AAX_CHostProcessor::Controller ( void  ) const

inlineprotected

AAX_IHostProcessorDelegate* AAX_CHostProcessor::HostProcessorDelegate ( )

inlineprotected

const AAX_IHostProcessorDelegate* AAX_CHostProcessor::HostProcessorDelegate ( ) const

inlineprotected

AAX_IEffectParameters* AAX_CHostProcessor::EffectParameters ( void  )

inlineprotected

const AAX_IEffectParameters* AAX_CHostProcessor::EffectParameters ( void  ) const

inlineprotected

---

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

• AAX_CHostProcessor.h