CRI ADX  Last Updated: 2024-07-17 10:48 p
CriAtomExDsp API

结构体

struct  CriAtomExDspPitchShifterConfigTag
 Configuration structure used to attach a pitch shifter effect 更多...
 
struct  CriAtomExDspTimeStretchConfigTag
 Configuration structure used to attach a time-stretching effect 更多...
 

宏定义

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

类型定义

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

函数

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

详细描述

宏定义说明

◆ criAtomExVoicePool_SetDefaultConfigForDspPitchShifter

#define criAtomExVoicePool_SetDefaultConfigForDspPitchShifter (   p_config)
值:
{\
(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;\
}
#define CRIATOMEX_DEFAULT_VOICES_PER_POOL
Default number of voices
Definition: cri_le_atom_ex.h:117

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

参数
[out]p_configpointer 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.
参见
CriAtomExDspPitchShifterConfig, criAtomExVoicePool_AttachDspPitchShifter

◆ criAtomExVoicePool_SetDefaultConfigForDspTimeStretch

#define criAtomExVoicePool_SetDefaultConfigForDspTimeStretch (   p_config)
值:
{\
(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

参数
[out]p_configpointer 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.
参见
CriAtomExDspTimeStretchConfig, criAtomExVoicePool_AttachDspTimeStretch

类型定义说明

◆ CriAtomExDspPitchShifterConfig

Configuration structure used to attach a pitch shifter effect

Description:
Structure used to attach a pitch shifter to a Voice Pool.
注意
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.)
参见
criAtomExVoicePool_AttachDspPitchShifter, criAtomExVoicePool_CalculateWorkSizeForDspPitchShifter, criAtomExVoicePool_SetDefaultConfigForDspPitchShifter

◆ CriAtomExDspTimeStretchConfig

Configuration structure used to attach a time-stretching effect

Description:
Structure used to attach a time-stretching effect to a Voice Pool.
注意
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.)
参见
criAtomExVoicePool_AttachDspTimeStretch, criAtomExVoicePool_CalculateWorkSizeForDspTimeStretch, criAtomExVoicePool_SetDefaultConfigForDspTimeStretch

函数说明

◆ criAtomExVoicePool_DetachDsp()

void criAtomExVoicePool_DetachDsp ( CriAtomExVoicePoolHn  pool)

Detach a DSP

参数
[in]poolVoice Pool handle
Description:
Detaches a DSP from the specified Voice Pool.
注意
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

参数
[in]configconfig for attach
返回
CriSint32 work buffer size
返回值
>=0 successfully completed
-1error occurred
Description:
Calculates the size of the work buffer required to attach the pitch shifter DSP.
参见
criAtomExVoicePool_AttachDspPitchShifter

◆ criAtomExVoicePool_AttachDspPitchShifter()

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

Attach a pitch shifter DSP

参数
[in]poolAttached Voice Pool Handle
[in]configconfig for attach
[in]workA pointer to the work area for attachment
[in]work_sizeSize of work area for attachment
Description:
Attaches a pitch shifter DSP to a Voice Pool.
注意
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

参数
[in]configconfig for attach
返回
CriSint32 work buffer size
返回值
>=0 successfully completed
-1error occurred
Description:
Calculates the size of the work buffer required to attach a time-stretching DSP.
参见
criAtomExVoicePool_AttachDspTimeStretch

◆ criAtomExVoicePool_AttachDspTimeStretch()

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

Attach a time-stretching DSP

参数
[in]poolAttached Voice Pool Handle
[in]configconfig for attach
[in]workA pointer to the work area for attachment
[in]work_sizeSize of work area for attachment
Description:
Attaches a time-stretching DSP to a Voice Pool.
注意
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

参数
[in]configconfig for attach
返回
CriSint32 work buffer size
返回值
>=0 successfully completed
-1error occurred
Description:
Calculate the work area size required to attach an AFX format DSP.
参见
criAtomExVoicePool_AttachDspAfx

◆ criAtomExVoicePool_AttachDspAfx()

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

Attaching AFX format DSP

参数
[in]poolAttached Voice Pool Handle
[in]configconfig for attach
[in]workA pointer to the work area for attachment
[in]work_sizeSize of work area for attachment
Description:
Adds an AFX style DSP to the voice pool.
注意
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.