CriAtomExDsp API

Data Structures
struct	CriAtomExDspPitchShifterConfigTag
	Configuration structure used to attach a pitch shifter effect. More...
struct	CriAtomExDspTimeStretchConfigTag
	Configuration structure used to attach a time-stretching effect. More...

Macros
#define	criAtomExVoicePool_SetDefaultConfigForDspPitchShifter(p_config)
	Assign the default values to the configuration structure used to attach a pitch shifter DSP. More...
#define	criAtomExVoicePool_SetDefaultConfigForDspTimeStretch(p_config)
	Assign the default values to the configuration structure used to attach a time-streching DSP. More...

Typedefs
typedef struct CriAtomExDspPitchShifterConfigTag	CriAtomExDspPitchShifterConfig
	Configuration structure used to attach a pitch shifter effect. More...
typedef struct CriAtomExDspTimeStretchConfigTag	CriAtomExDspTimeStretchConfig
	Configuration structure used to attach a time-stretching effect. More...

Functions
void	criAtomExVoicePool_DetachDsp (CriAtomExVoicePoolHn pool)
	Detach a DSP. More...
CriSint32	criAtomExVoicePool_CalculateWorkSizeForDspPitchShifter (const CriAtomExDspPitchShifterConfig *config)
	Calculate the size of the work buffer required to attach a pitch shifter DSP. More...
void	criAtomExVoicePool_AttachDspPitchShifter (CriAtomExVoicePoolHn pool, const CriAtomExDspPitchShifterConfig *config, void *work, CriSint32 work_size)
	Attach a pitch shifter DSP. More...
CriSint32	criAtomExVoicePool_CalculateWorkSizeForDspTimeStretch (const CriAtomExDspTimeStretchConfig *config)
	Calculate the size of the work buffer required to attach a time-stretching DSP. More...
void	criAtomExVoicePool_AttachDspTimeStretch (CriAtomExVoicePoolHn pool, const CriAtomExDspTimeStretchConfig *config, void *work, CriSint32 work_size)
	Attach a time-stretching DSP. More...
CriSint32	criAtomExVoicePool_CalculateWorkSizeForDspAfx (const CriAtomExDspAfxConfig *config)
	Calculating Work Area Size for Time Stretch DSP Attach. More...
void	criAtomExVoicePool_AttachDspAfx (CriAtomExVoicePoolHn pool, const CriAtomExDspAfxConfig *config, void *work, CriSint32 work_size)
	Attaching AFX format DSP. More...

Detailed Description

Macro Definition Documentation

criAtomExVoicePool_SetDefaultConfigForDspPitchShifter

#define criAtomExVoicePool_SetDefaultConfigForDspPitchShifter

(

p_config

)

Value:

{\
    (p_config)->num_dsp = CRIATOMEX_DEFAULT_VOICES_PER_POOL;\
    (p_config)->max_channels = CRIATOM_DEFAULT_INPUT_MAX_CHANNELS;\
    (p_config)->max_sampling_rate = CRIATOM_DEFAULT_INPUT_MAX_SAMPLING_RATE;\
    (p_config)->specific.mode = 0;\
    (p_config)->specific.window_size = 1024;\
    (p_config)->specific.overlap_times = 4;\
}

Assign the default values to the configuration structure used to attach a pitch shifter DSP.

Parameters

[out]

p_config

pointer to the configuration structure used to attach a pitch shifter DSP

Description:

Assigns the default values to the configuration structure ( CriAtomExDspPitchShifterConfig ) used to attach a pitch shifter DSP.

See also

CriAtomExDspPitchShifterConfig, criAtomExVoicePool_AttachDspPitchShifter

criAtomExVoicePool_SetDefaultConfigForDspTimeStretch

#define criAtomExVoicePool_SetDefaultConfigForDspTimeStretch

(

p_config

)

Value:

{\
    (p_config)->num_dsp = CRIATOMEX_DEFAULT_VOICES_PER_POOL;\
    (p_config)->max_channels = CRIATOM_DEFAULT_INPUT_MAX_CHANNELS;\
    (p_config)->max_sampling_rate = CRIATOM_DEFAULT_INPUT_MAX_SAMPLING_RATE;\
    (p_config)->specific.reserved = 0;\
}

Assign the default values to the configuration structure used to attach a time-streching DSP.

Parameters

[out]

p_config

pointer to the configuration structure used to attach a time-streching DSP

Description:

Assigns the default values to the configuration structure ( CriAtomExDspTimeStretchConfig ) used to attach a time-streching DSP.

See also

CriAtomExDspTimeStretchConfig, criAtomExVoicePool_AttachDspTimeStretch

Typedef Documentation

CriAtomExDspPitchShifterConfig

typedef struct CriAtomExDspPitchShifterConfigTag CriAtomExDspPitchShifterConfig

Configuration structure used to attach a pitch shifter effect.

Description:

Structure used to attach a pitch shifter to a Voice Pool.

Attention

More members will be added in the future, so if you are not using the criAtomExVoicePool_SetDefaultConfigForDspPitchShifter macro, make sure to initialize the whole structure to zero before using it.
(Make sure that no member of the structure has an undefined value.)

See also

criAtomExVoicePool_AttachDspPitchShifter, criAtomExVoicePool_CalculateWorkSizeForDspPitchShifter, criAtomExVoicePool_SetDefaultConfigForDspPitchShifter

CriAtomExDspTimeStretchConfig

typedef struct CriAtomExDspTimeStretchConfigTag CriAtomExDspTimeStretchConfig

Configuration structure used to attach a time-stretching effect.

Description:

Structure used to attach a time-stretching effect to a Voice Pool.

Attention

More members will be added in the future, so if you are not using the criAtomExVoicePool_SetDefaultConfigForDspTimeStretch macro, make sure to initialize the whole structure to zero before using it.
(Make sure that no member of the structure has an undefined value.)

See also

criAtomExVoicePool_AttachDspTimeStretch, criAtomExVoicePool_CalculateWorkSizeForDspTimeStretch, criAtomExVoicePool_SetDefaultConfigForDspTimeStretch

Function Documentation

criAtomExVoicePool_DetachDsp()

void criAtomExVoicePool_DetachDsp

(

CriAtomExVoicePoolHn

pool

)

Detach a DSP.

Parameters

[in]

pool

Voice Pool handle

Description:

Detaches a DSP from the specified Voice Pool.

Attention

This is a blocking function.
Executing this function blocks the server processing of the Atom library for a while.
If this function is executed during audio playback, problems such as audio breakups may occur. Call this function only when a fluctuation in load is acceptable, for example when loading a new level.

Remarks: This function is currently unavailable on some platforms.

criAtomExVoicePool_CalculateWorkSizeForDspPitchShifter()

CriSint32 criAtomExVoicePool_CalculateWorkSizeForDspPitchShifter

(

const CriAtomExDspPitchShifterConfig *

config

)

Calculate the size of the work buffer required to attach a pitch shifter DSP.

Parameters

[in]

config

config for attach

Returns

CriSint32 work buffer size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculates the size of the work buffer required to attach the pitch shifter DSP.

See also

criAtomExVoicePool_AttachDspPitchShifter

criAtomExVoicePool_AttachDspPitchShifter()

void criAtomExVoicePool_AttachDspPitchShifter	(	CriAtomExVoicePoolHn	pool,
		const CriAtomExDspPitchShifterConfig *	config,
		void *	work,
		CriSint32	work_size
	)

Attach a pitch shifter DSP.

Parameters

[in]	pool	Attached Voice Pool Handle
[in]	config	config for attach
[in]	work	A pointer to the work area for attachment
[in]	work_size	Size of work area for attachment

Description:

Attaches a pitch shifter DSP to a Voice Pool.

Attention

This is a blocking function.
Executing this function blocks the server processing of the Atom library for a while.
If this function is executed during audio playback, problems such as audio breakups may occur. Call this function only when a fluctuation in load is acceptable, for example when loading a new level.

Remarks: This function is currently unavailable on some platforms.

criAtomExVoicePool_CalculateWorkSizeForDspTimeStretch()

CriSint32 criAtomExVoicePool_CalculateWorkSizeForDspTimeStretch

(

const CriAtomExDspTimeStretchConfig *

config

)

Calculate the size of the work buffer required to attach a time-stretching DSP.

Parameters

[in]

config

config for attach

Returns

CriSint32 work buffer size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculates the size of the work buffer required to attach a time-stretching DSP.

See also

criAtomExVoicePool_AttachDspTimeStretch

criAtomExVoicePool_AttachDspTimeStretch()

void criAtomExVoicePool_AttachDspTimeStretch	(	CriAtomExVoicePoolHn	pool,
		const CriAtomExDspTimeStretchConfig *	config,
		void *	work,
		CriSint32	work_size
	)

Attach a time-stretching DSP.

Parameters

[in]	pool	Attached Voice Pool Handle
[in]	config	config for attach
[in]	work	A pointer to the work area for attachment
[in]	work_size	Size of work area for attachment

Description:

Attaches a time-stretching DSP to a Voice Pool.

Attention

This is a blocking function.
Executing this function blocks the server processing of the Atom library for a while.
If this function is executed during audio playback, problems such as audio breakups may occur. Call this function only when a fluctuation in load is acceptable, for example when loading a new level.

Remarks: This function is currently unavailable on some platforms.

criAtomExVoicePool_CalculateWorkSizeForDspAfx()

CriSint32 criAtomExVoicePool_CalculateWorkSizeForDspAfx

(

const CriAtomExDspAfxConfig *

config

)

Calculating Work Area Size for Time Stretch DSP Attach.

Parameters

[in]

config

config for attach

Returns

CriSint32 work buffer size

Return values

>=	0 successfully completed
-1	error occurred

Description:

Calculate the work area size required to attach an AFX format DSP.

See also

criAtomExVoicePool_AttachDspAfx

criAtomExVoicePool_AttachDspAfx()

void criAtomExVoicePool_AttachDspAfx	(	CriAtomExVoicePoolHn	pool,
		const CriAtomExDspAfxConfig *	config,
		void *	work,
		CriSint32	work_size
	)

Attaching AFX format DSP.

Parameters

[in]	pool	Attached Voice Pool Handle
[in]	config	config for attach
[in]	work	A pointer to the work area for attachment
[in]	work_size	Size of work area for attachment

Description:

Adds an AFX style DSP to the voice pool.

Attention

This is a blocking function.
Executing this function blocks the server processing of the Atom library for a while.
If this function is executed during audio playback, problems such as audio breakups may occur. Call this function only when a fluctuation in load is acceptable, for example when loading a new level.

Remarks: This function is currently unavailable on some platforms.