Skip to main content
Header: spf/api/modules/spr_api.h

Structures

time_us_t

Defines the timestamp value. Members
uint32_t
Lower 32 bits of 64-bit time value in microseconds.
uint32_t
Upper 32 bits of 64-bit time value in microseconds.

config_spr_render_mode_t

Contains configuration information for the Render mode. Members
uint32_t
Mode that indicates when to start rendering data.
time_us_t
Render start time in microseconds.

config_spr_render_window_t

Contains configuration information for the render window. Members
time_us_t
Start of the tolerance window for incoming timestamps used to make rendering decisions.
time_us_t
End of the tolerance window for incoming timestamps used to make rendering decisions.

config_spr_render_reference_t

Contains configuration information for the render decision reference. Members
uint32_t
Indicates the choice of render decision reference for incoming data.

config_spr_render_hold_duration_t

Defines the duration of the hold buffer when a render decision is to hold data in the buffer. Members
time_us_t
Maximum size (in microseconds) of the hold buffer.

param_id_spr_delay_path_end_t

Payload of the PARAM_ID_SPR_DELAY_PATH_END parameter. Members
uint32_t
Identifier for the module instance ID at the end of the path used for delay calculations.

param_id_spr_session_time_t

Payload of the PARAM_ID_SPR_SESSION_TIME parameter. Members
time_us_t
Value of the current session time in microseconds.
time_us_t
Value of the absolute time in microseconds when the sample that corresponds to the session time is rendered at the hardware.
time_us_t
Value of the last processed timestamp in microseconds.
uint32_t
Configures additional properties associated with this payload.

param_id_spr_session_time_reset_info_t

Payload of the PARAM_ID_SPR_SESSION_TIME_RESET_INFO parameter. Members
uint32_t
Indicates the configuration for handling session time reset.

param_id_spr_avsync_config_t

Payload of the PARAM_ID_SPR_AVSYNC_CONFIG parameter. Members
uint16_t
Indicates if the AVSync functionality is to be enabled.
uint16_t
Render mask with bitfields to selectively configure fields.
config_spr_render_mode_t
Configuration parameter for the Render mode and start time.
config_spr_render_reference_t
Configuration parameter for the render reference.
config_spr_render_window_t
Configuration parameter for the render window.
config_spr_render_hold_duration_t
Configuration parameter for the size of the render hold buffer.

spr_port_binding_t

Defines a control port-to-output data port mapping. Members
uint32_t
Identifier for the control port of the module.
uint32_t
Identifier for the output port to which a control port is linked.

param_id_spr_ctrl_to_data_port_map_t

Payload of the PARAM_ID_SPR_CTRL_TO_DATA_PORT_MAP parameter. Members
uint32_t
Number of control port IDs attached to the module.

event_id_spr_underrun_t

Payload of the EVENT_ID_SPR_UNDERRUN event. Members
uint32_t
Status of the underrun event being raised by the SPR module.

Type Definitions

time_us_t

config_spr_render_mode_t

config_spr_render_window_t

config_spr_render_reference_t

config_spr_render_hold_duration_t

param_id_spr_delay_path_end_t

param_id_spr_session_time_t

param_id_spr_session_time_reset_info_t

param_id_spr_avsync_config_t

spr_port_binding_t

param_id_spr_ctrl_to_data_port_map_t

event_id_spr_underrun_t

Macros

SPR_RENDER_MODE_IMMEDIATE

Indicates that the render start time is immediate.

SPR_RENDER_MODE_ABSOLUTE_TIME

Indicates that the render start time is at given value of absolute time.

SPR_RENDER_MODE_DELAYED

Indicates that the render start time is at a specified offset from the current absolute time wall clock time.

DEFAULT_RENDER_WINDOW_START_MSW

MSW of the sign-extended default time (-infinity) for the render window start time.

DEFAULT_RENDER_WINDOW_START_LSW

LSW of the sign-extended default time (-infinity) for the render window start time.

DEFAULT_RENDER_WINDOW_END_MSW

MSW of the sign-extended default time (-infinity) for the render window end time.

DEFAULT_RENDER_WINDOW_END_LSW

LSW of the sign extended default time (-infinity) for the render window end time.

SPR_RENDER_REFERENCE_DEFAULT

Indicates that the render decision is based on the rendering rate of the primary device (or the session clock mode) served by the SPF module.

SPR_RENDER_REFERENCE_WALL_CLOCK

Indicates that the render decision is based on the local wall clock reference.

SPR_RENDER_BIT_MASK_RENDER_MODE

Definition of the Render mode bitmask.

SPR_RENDER_SHIFT_RENDER_MODE

Definition of the Render mode shift value.

SPR_RENDER_BIT_MASK_RENDER_REFERENCE

Definition of the render reference bitmask.

SPR_RENDER_SHIFT_RENDER_REFERENCE

Definition of the render reference shift value.

SPR_RENDER_BIT_MASK_RENDER_WINDOW

Definition of the render window bitmask.

SPR_RENDER_SHIFT_RENDER_WINDOW

Definition of the render window shift value.

SPR_RENDER_BIT_MASK_HOLD_DURATION

Definition of the render hold duration.

SPR_RENDER_SHIFT_HOLD_DURATION

Definition of the render hold duration shift value.

SPR_RENDER_BIT_MASK_ALLOW_NON_TIMESTAMP_HONOR_MODE

Indicates Non-time stamp honor mode can be enabled or not.

SPR_RENDER_SHIFT_ALLOW_NONTIMESTAMP_HONOR_MODE

Definition of Non-time stamp honor mode shift value.

PARAM_ID_SPR_DELAY_PATH_END

ID of the parameter that defines end of the delay path.

PARAM_ID_SESSION_TIME_BIT_MASK_IS_TIMESTAMP_VALID

Bitmask for the Timestamp Valid flag in param_id_session_time_t.

PARAM_ID_SESSION_TIME_SHIFT_IS_TIMESTAMP_VALID

Shift value for the Timestamp Valid flag in param_id_session_time_t.

PARAM_ID_SPR_SESSION_TIME

Identifier for the Get parameter used to query the session time.

SPR_SESSION_TIME_RESET_MODE_DEFAULT

Indicates that the SPR operates in the Default Mode where session_time is reset when 1) Flush command is issued 2) Gapless stream switch occurs.

SPR_SESSION_TIME_SKIP_RESET_GAPLESS_SWITCH

Indicates that the SPR operates in the mode where session_time reset is skipped when Gapless stream switch occurs.

PARAM_ID_SPR_SESSION_TIME_RESET_INFO

Identifier for the parameter used to configure the SPR module behavior with respect to resetting session time.

PARAM_ID_SPR_AVSYNC_CONFIG

Identifier for the parameter that configures information required for AV synchronization functionalities in the SPR module, including a data render decision.

PARAM_ID_SPR_CTRL_TO_DATA_PORT_MAP

Identifier for the parameter that defines the control port-to-data port mapping.

UNDERRUN_STATUS_INPUT_NOT_AVAILABLE

Indicates an underrun occurred because input is not available.

UNDERRUN_STATUS_INPUT_HOLD

Indicates an underrun occurred because the input is held after the render decision (AVSync).

UNDERRUN_STATUS_INPUT_DROP

Indicates an underrun occurred because input is dropped after the render decision (AVSync).

EVENT_ID_SPR_UNDERRUN

Identifier for the underrun event raised by the SPR module.

EVENT_ID_SPR_SESSION_TIME_RESET

Identifier for the session time reset event raised by SPR module.

MODULE_ID_SPR

Identifier for the Splitter Renderer module, which is used to split an audio stream into multiple devices.