Wide Dynamic Range Compression

group AUDIO_WDRC

Control and customize the Wide Dynamic Range Compression (WDRC) engine in the Audio Subsystem.

WDRC compresses the wide range of sound intensities into a limited dynamic range, making a broader range of sound intensities audible for the user.

Typedefs

typedef enum t_wdrc_content_type T_WDRC_CONTENT_TYPE

Define the supported WDRC content types.

Enums

enum t_wdrc_content_type

Define the supported WDRC content types.

Values:

enumerator WDRC_CONTENT_TYPE_AUDIO
enumerator WDRC_CONTENT_TYPE_VOICE
enumerator WDRC_CONTENT_TYPE_PASSTHROUGH

Functions

T_AUDIO_EFFECT_INSTANCE wdrc_create(T_WDRC_CONTENT_TYPE type, void *info_buf, uint16_t info_len)

Create a WDRC instance.

Parameters:

  • type – [in] WDRC content type T_WDRC_CONTENT_TYPE.

  • info_buf – [in] WDRC parameter buffer.

  • info_len – [in] WDRC parameter buffer length.

Returns:

The instance of the WDRC engine. If returned instance is NULL, the WDRC instance was failed to create.

bool wdrc_enable(T_AUDIO_EFFECT_INSTANCE instance)

Enable the specific WDRC instance.

Parameters:

instance – [in] WDRC instance T_AUDIO_EFFECT_INSTANCE.

Return values:

  • true – WDRC instance was enabled successfully.

  • false – WDRC instance was failed to enable.

Returns:

The status of enabling the WDRC instance.

bool wdrc_disable(T_AUDIO_EFFECT_INSTANCE instance)

Disable the specific WDRC instance.

Parameters:

instance – [in] WDRC instance T_AUDIO_EFFECT_INSTANCE.

Return values:

  • true – WDRC instance was disabled successfully.

  • false – WDRC instance was failed to disable.

Returns:

The status of disabling the WDRC instance.

bool wdrc_set(T_AUDIO_EFFECT_INSTANCE instance, void *info_buf, uint16_t info_len)

Set the specific WDRC instance parameter.

Parameters:

  • instance – [in] WDRC instance T_AUDIO_EFFECT_INSTANCE.

  • info_buf – [in] WDRC parameter buffer.

  • info_len – [in] WDRC parameter length.

Return values:

  • true – WDRC instance parameter was set successfully.

  • false – WDRC instance parameter was failed to set.

Returns:

The status of setting the WDRC instance parameter.

bool wdrc_release(T_AUDIO_EFFECT_INSTANCE instance)

Release the specific WDRC instance.

Parameters:

instance – [in] WDRC instance T_AUDIO_EFFECT_INSTANCE.

Return values:

  • true – WDRC instance was released successfully.

  • false – WDRC instance was failed to release.

Returns:

The status of releasing the WDRC instance.