Sound Open Firmware
Loading...
Searching...
No Matches
audio_buffer_ops Struct Reference

#include <audio_buffer.h>

Data Fields

void(* free )(struct sof_audio_buffer *buffer)
 this method must free all structures allocated by buffer implementation and the buffer itself OBLIGATORY
void(* reset )(struct sof_audio_buffer *buffer)
 clean all buffer data, set buffer positions to initial, leaving config as is the procedure is to be called only when buffer is not in use OPTIONAL
int(* on_audio_format_set )(struct sof_audio_buffer *buffer)
 OPTIONAL: Notification to the sink implementation about changes in audio format.
int(* audio_set_ipc_params )(struct sof_audio_buffer *buffer, struct sof_ipc_stream_params *params, bool force_update)
 OPTIONAL see sink_set_params comments.
int(* set_alignment_constants )(struct sof_audio_buffer *buffer, const uint32_t byte_align, const uint32_t frame_align_req)
 OPTIONAL see comment for sink_set_alignment_constants.

Field Documentation

◆ audio_set_ipc_params

int(* audio_buffer_ops::audio_set_ipc_params) (struct sof_audio_buffer *buffer, struct sof_ipc_stream_params *params, bool force_update)

OPTIONAL see sink_set_params comments.

◆ free

void(* audio_buffer_ops::free) (struct sof_audio_buffer *buffer)

this method must free all structures allocated by buffer implementation and the buffer itself OBLIGATORY

◆ on_audio_format_set

int(* audio_buffer_ops::on_audio_format_set) (struct sof_audio_buffer *buffer)

OPTIONAL: Notification to the sink implementation about changes in audio format.

Once any of *audio_stream_params elements changes, the implementation of sink may need to perform some extra operations. This callback will be called immediately after any change

Return values
0if success, negative if new parameters are not supported

◆ reset

void(* audio_buffer_ops::reset) (struct sof_audio_buffer *buffer)

clean all buffer data, set buffer positions to initial, leaving config as is the procedure is to be called only when buffer is not in use OPTIONAL

◆ set_alignment_constants

int(* audio_buffer_ops::set_alignment_constants) (struct sof_audio_buffer *buffer, const uint32_t byte_align, const uint32_t frame_align_req)

OPTIONAL see comment for sink_set_alignment_constants.


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