Header: spf/api/modules/sh_mem_pull_push_mode_api.h
Structures
event_cfg_sh_mem_pull_push_mode_watermark_level_t
Payload of the EVENT_ID_SH_MEM_PULL_PUSH_MODE_WATERMARK event.
Members
Watermark level in the circular buffer, in bytes.
event_cfg_sh_mem_pull_push_mode_watermark_t
Immediately following this structure are watermark level structures of type sh_mem_pull_push_mode_watermark_level_t.
Members
Number of watermark levels in the array.
event_sh_mem_pull_push_mode_watermark_level_t
Payload of the EVENT_ID_SH_MEM_PULL_PUSH_MODE_WATERMARK event.
Members
Watermark level in the circular buffer in bytes.
event_sh_mem_push_mode_eos_marker_t
Payload of the event EVENT_ID_SH_MEM_PUSH_MODE_EOS_MARKER, contains the timestamp of the EOS marker.
Members
Index of the sample in the circular buffer at which EOS marker is set.
Lower 32 bits of Timestamp at which push mode module received EOS.
Higher 32 bits of Timestamp at which push mode module received EOS.
sh_mem_pull_push_mode_position_buffer_t
Common structure definition for the shared circular buffer between the SPF and clients.
Members
Counter used to handle interprocessor synchronization issues associated with reading write_index, wall_clock_us_lsw, and wall_clock_us_msw.
Index (in bytes) to the buffer where the SPF is writing (Push mode) or reading (Pull mode).
Upper 32 bits of the 64-bit timestamp, in microseconds.
Upper 32 bits of the 64-bit timestamp, in microseconds.
sh_mem_pull_push_mode_cfg_t
Payload of the PARAM_ID_SH_MEM_PULL_PUSH_MODE_CFG parameter.
Members
Lower 32 bits of the address of the shared circular buffer.
Upper 32 bits of the address of the shared circular buffer.
Number of bytes in the shared circular buffer.
Unique identifier for the shared memory address of shared circular buffer.
Lower 32 bits of the address of the shared position buffer.
Upper 32 bits of the address of the shared position buffer.
Unique identifier for the shared memory address of position buffer.
Bit field to enable/disable additional information to be sent along with the audio data in the buffer.
Sync word for validation.
Parameter ID identifying the type of data that follows.
Actual size of the payload in bytes.
Size of the padded bytes in param payload, to make next header SYNC_WORD 4-byte aligned.
sh_mem_push_mode_timestamp_payload_t
Timestamp parameter payload structure.
Members
Lower 32 bits of the 64-bit timestamp, in microseconds.
Upper 32 bits of the 64-bit timestamp, in microseconds.
Type Definitions
event_cfg_sh_mem_pull_push_mode_watermark_level_t
event_cfg_sh_mem_pull_push_mode_watermark_t
event_sh_mem_pull_push_mode_watermark_level_t
event_sh_mem_push_mode_eos_marker_t
sh_mem_pull_push_mode_position_buffer_t
sh_mem_pull_push_mode_cfg_t
sh_mem_push_mode_timestamp_payload_t
Macros
Enumerates the maximum number of input ports for Pull mode.
SH_MEM_PULL_MODE_MAX_OUTPUT_PORTS
Enumerates the maximum number of output ports for Pull mode.
SH_MEM_PULL_MODE_STACK_SIZE_REQUIREMENT
Enumerates the stack size of the module for Pull mode.
Enumerates the maximum number of input ports for Push mode.
SH_MEM_PUSH_MODE_MAX_OUTPUT_PORTS
Enumerates the maximum number of output ports for Push mode.
SH_MEM_PUSH_MODE_STACK_SIZE_REQUIREMENT
Enumerates the stack size of the module for Push mode.
EVENT_ID_SH_MEM_PULL_PUSH_MODE_WATERMARK
Identifier of the watermark event from the MODULE_ID_SH_MEM_PULL_MODE and MODULE_ID_SH_MEM_PUSH_MODE modules to the client.
EVENT_ID_SH_MEM_PUSH_MODE_EOS_MARKER
Identifier of the EOS marker event from the MODULE_ID_SH_MEM_PUSH_MODE modules to the client.
PARAM_ID_SH_MEM_PULL_PUSH_MODE_CFG
Identifier of the parameter that configures shared memory information for Pull mode and Push mode.
Identifier of the parameter that configures header information for Push mode.
Sync word for header validation.
Header Parameter ID for UTC timestamp.
Header Parameter ID for PCM data.
MODULE_ID_SH_MEM_PULL_MODE
Identifier for the Shared Memory Pull mode module, which writes data to the SPF from the host through a shared circular buffer.
MODULE_ID_SH_MEM_PUSH_MODE
Identifier for the shared memory Push mode module, which reads data from the SPF to the host through a shared circular buffer.
