Synergy Software Package User's Manual
sf_audio_playback_common_instance_ctrl_t Struct Reference

#include <sf_audio_playback.h>

Public Member Functions

uint8_t stack [SF_AUDIO_PLAYBACK_STACK_SIZEBSP_ALIGN_VARIABLE_V2 (BSP_STACK_ALIGNMENT)
 

Data Fields

uint32_t open
 Used to determine if driver is initialized.
 
void const * p_next_buffer
 Pointer to next buffer (to be played when the current buffer completes).
 
uint32_t next_length
 Length of next buffer (to be played when the current buffer completes).
 
sf_message_instance_t const * p_message
 Pointer to message control block.
 
TX_QUEUE * p_queue
 Queue subscribed to SF_MESSAGE_EVENT_CLASS_AUDIO events.
 
sf_audio_playback_hw_instance_t const * p_lower_lvl_hw
 Hardware API's used.
 
sf_audio_playback_instance_ctrl_t * p_stream [SF_AUDIO_PLAYBACK_CFG_MAX_STREAMS]
 Stream specific data.
 
TX_THREAD thread
 Main audio thread.
 
TX_EVENT_FLAGS_GROUP flags
 Event flags used to end wait in audio thread.
 
sf_audio_playback_data_type_t data_type
 Sample format required by the hardware.
 
uint8_t volume
 Volume from 0 (muted) to 255 (maximum, default on open).
 
uint8_t buffer_index
 Which ping pong buffer to use.
 
int16_t samples [2][SF_AUDIO_PLAYBACK_CFG_BUFFER_SIZE_BYTES/sizeof(int16_t)]
 
volatile bool playing
 State of audio instance (currently playing if true)
 
TX_MUTEX common_instance_mutex
 Mutex for internal use.
 

Detailed Description

Audio common instance control block. DO NOT INITIALIZE. Initialization the first time sf_audio_playback_api_t::open is called. Shared by all streams.

Member Function Documentation

◆ BSP_ALIGN_VARIABLE_V2()

uint8_t stack [SF_AUDIO_PLAYBACK_STACK_SIZE] sf_audio_playback_common_instance_ctrl_t::BSP_ALIGN_VARIABLE_V2 ( BSP_STACK_ALIGNMENT  )

Stack for audio thread.

Field Documentation

◆ samples

int16_t sf_audio_playback_common_instance_ctrl_t::samples[2][SF_AUDIO_PLAYBACK_CFG_BUFFER_SIZE_BYTES/sizeof(int16_t)]

Ping pong buffers, used to store converted data during transfer.


The documentation for this struct was generated from the following file: