Audio Framework Interface

RTOS-integrated Audio Framework Interface. More...

Data Structures
struct	sf_audio_playback_data_t
struct	sf_audio_playback_common_cfg_t
struct	sf_audio_playback_cfg_t
struct	sf_audio_playback_api_t
struct	sf_audio_playback_instance_t

Macros
#define	SF_AUDIO_PLAYBACK_API_VERSION_MAJOR   (2U)
#define	SF_AUDIO_PLAYBACK_MESSAGE_WORDS   ((sizeof(sf_message_payload_audio_t) + 3) / 4)
#define	SF_AUDIO_PLAYBACK_MAX_VOLUME   (255)

Typedefs
typedef void	sf_audio_playback_common_ctrl_t
typedef void	sf_audio_playback_ctrl_t

Enumerations
enum	sf_audio_playback_status_t { SF_AUDIO_PLAYBACK_STATUS_STOPPED, SF_AUDIO_PLAYBACK_STATUS_PAUSED, SF_AUDIO_PLAYBACK_STATUS_PLAYING, SF_AUDIO_PLAYBACK_STATUS_WAITING }

Detailed Description

RTOS-integrated Audio Framework Interface.

Summary

The Audio Interface is a ThreadX-aware Audio Framework Interface. The Interface is implemented by the Audio Framework using the Timer driver, the Transfer driver, and a choice of the following drivers for playback: DAC, PWM (to be implemented), or I2S (to be implemented).

Interfaces used:

• Transfer Interface
• DAC Interface
• Timer Interface

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

Audio Framework Interface description: Audio Playback Framework

Macro Definition Documentation

SF_AUDIO_PLAYBACK_API_VERSION_MAJOR

#define SF_AUDIO_PLAYBACK_API_VERSION_MAJOR   (2U)

Version of the API defined in this file

SF_AUDIO_PLAYBACK_MAX_VOLUME

#define SF_AUDIO_PLAYBACK_MAX_VOLUME   (255)

Macro defining the maximum volume.

SF_AUDIO_PLAYBACK_MESSAGE_WORDS

#define SF_AUDIO_PLAYBACK_MESSAGE_WORDS   ((sizeof(sf_message_payload_audio_t) + 3) / 4)

Audio playback message size in 4 byte words, rounded up.

Typedef Documentation

sf_audio_playback_common_ctrl_t

typedef void sf_audio_playback_common_ctrl_t

Audio playback common control block. Allocate an instance specific control block to pass to sf_audio_playback_api_t::open in sf_audio_playback_cfg_t.

Implemented as

• sf_audio_playback_common_instance_ctrl_t

sf_audio_playback_ctrl_t

typedef void sf_audio_playback_ctrl_t

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

Implemented as

• sf_audio_playback_instance_ctrl_t

Enumeration Type Documentation

sf_audio_playback_status_t

enum sf_audio_playback_status_t

Audio playback status.

Enumerator
SF_AUDIO_PLAYBACK_STATUS_STOPPED	Stream is available to be used.
SF_AUDIO_PLAYBACK_STATUS_PAUSED	Stream is paused.
SF_AUDIO_PLAYBACK_STATUS_PLAYING	Stream is playing data.
SF_AUDIO_PLAYBACK_STATUS_WAITING	Stream is between packets, waiting for the next data message.