Audio Recording Framework Interface

RTOS-integrated Audio Recording Framework Interface. More...

Data Structures
struct	sf_audio_record_cfg_t
struct	sf_audio_record_api_t
struct	sf_audio_record_instance_t

Macros
#define	SF_AUDIO_RECORD_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	sf_audio_record_ctrl_t

Enumerations
enum	sf_audio_record_channel_t { SF_AUDIO_RECORD_CHANNEL_MONO, SF_AUDIO_RECORD_CHANNEL_STEREO }
enum	sf_audio_record_data_size_t { SF_AUDIO_RECORD_DATA_SIZE_8BIT = 1, SF_AUDIO_RECORD_DATA_SIZE_16BIT = 2 }
enum	sf_audio_record_event_t { SF_AUDIO_RECORD_EVENT_NEW_DATA }

Detailed Description

RTOS-integrated Audio Recording Framework Interface.

Summary

The Audio Record Interface is a ThreadX-aware Interface for Audio Recording. The Interface is implemented by the ADC Audio recording Framework using the ADC periodic Framework driver for recording. The interface is implemented by the I2S Audio recording Framework using the I2S driver for recording.

Interfaces used:

• ADC periodic Framework
• I2S Interface

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

Macro Definition Documentation

SF_AUDIO_RECORD_API_VERSION_MAJOR

#define SF_AUDIO_RECORD_API_VERSION_MAJOR   (2U)

Version of the API defined in this file

Typedef Documentation

sf_audio_record_ctrl_t

typedef void sf_audio_record_ctrl_t

Audio record framework control block. Allocate an instance specific control block to pass into the audio record framework API calls.

Implemented as

• sf_audio_record_adc_instance_ctrl_t
• sf_audio_record_i2s_instance_ctrl_t

Enumeration Type Documentation

sf_audio_record_channel_t

enum sf_audio_record_channel_t

Definition of audio recording mode.

Enumerator
SF_AUDIO_RECORD_CHANNEL_MONO	Support Mono Channel.
SF_AUDIO_RECORD_CHANNEL_STEREO	Support Stereo Channel.

sf_audio_record_data_size_t

enum sf_audio_record_data_size_t

Definition of audio recording data sample size.

Enumerator
SF_AUDIO_RECORD_DATA_SIZE_8BIT	data width in the sample is 8bit
SF_AUDIO_RECORD_DATA_SIZE_16BIT	data width in the sample is 16bit

sf_audio_record_event_t

enum sf_audio_record_event_t

Definition of events for audio recording.

Enumerator
SF_AUDIO_RECORD_EVENT_NEW_DATA	New data is available in the buffer.