Header: spf/api/modules/wr_sh_mem_ep_api.h
Structures
data_cmd_wr_sh_mem_ep_data_buffer_t
Members
Lower 32 bits of the address of the buffer containing the data.
Upper 32 bits of the address of the buffer containing the data.
Unique identifier for the shared memory address.
Number of valid bytes available in the buffer for processing.
Lower 32 bits of the 64-bit timestamp in microseconds of the first buffer sample.
Upper 32 bits of the 64-bit timestamp in microseconds of the first buffer sample.
data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t
Members
Lower 32 bits of the address of the buffer being returned.
Upper 32 bits of the address of the buffer being returned.
Unique identifier for the shared memory address.
Status message (error code) that indicates whether the referenced buffer has been successfully consumed.
data_cmd_wr_sh_mem_ep_data_buffer_v2_t
Members
Lower 32 bits of the address of the buffer containing the data.
Upper 32 bits of the address of the buffer containing the data.
Unique identifier for the shared memory corresponding to data buffer address.
Number of valid bytes available in the buffer for processing.
Lower 32 bits of the 64-bit timestamp in microseconds of the first data buffer sample.
Upper 32 bits of the 64-bit timestamp in microseconds of the first data buffer sample.
Lower 32 bits of the address of the buffer containing the metadata.
Upper 32 bits of the address of the buffer containing the metadata.
Unique identifier for the shared memory corresponding to metadata buffer address.
Number of valid bytes available in the metadata buffer for processing.
data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t
Members
Lower 32 bits of the address of the data buffer being returned.
Upper 32 bits of the address of the data buffer being returned.
Unique identifier for the shared memory corresponding to data buffer address.
Status message (error code) that indicates whether the referenced data buffer has been successfully consumed.
Lower 32 bits of the address of the metadata buffer being returned.
Upper 32 bits of the address of the metadata buffer being returned.
Unique identifier for the shared memory corresponding to metadata buffer address.
Status message (error code) that indicates whether the referenced metadata buffer has been successfully consumed.
data_cmd_wr_sh_mem_ep_eos_t
Members
Policy used to raise DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED WR_SH_MEM_EP_EOS_POLICY_LAST WR_SH_MEM_EP_EOS_POLICY_EACH.
data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t
Members
module instance id from which the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED is being raised Invalid (0) when dropped.
Render status - 1 - Rendered.
Type Definitions
data_cmd_wr_sh_mem_ep_data_buffer_t
Structure for DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER.
data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_t
data_cmd_wr_sh_mem_ep_data_buffer_v2_t
Structure for DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2.
data_cmd_rsp_wr_sh_mem_ep_data_buffer_done_v2_t
data_cmd_wr_sh_mem_ep_eos_t
Structure for DATA_CMD_WR_SH_MEM_EP_EOS.
data_cmd_rsp_wr_sh_mem_ep_eos_rendered_t
Structure for DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED.
Macros
DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER
WR_SH_MEM_EP_BIT_MASK_TIMESTAMP_VALID_FLAG
Definition of a timestamp valid flag bitmask.
WR_SH_MEM_EP_SHIFT_TIMESTAMP_VALID_FLAG
Definition of a timestamp valid flag shift value.
WR_SH_MEM_EP_BIT_MASK_LAST_BUFFER_FLAG
Definition of the last buffer flag bitmask.
WR_SH_MEM_EP_SHIFT_LAST_BUFFER_FLAG
Definition of the last buffer flag shift value.
WR_SH_MEM_EP_BIT_MASK_TS_CONTINUE_FLAG
Definition of the shift value for the timestamp continue flag.
WR_SH_MEM_EP_SHIFT_TS_CONTINUE_FLAG
Definition of the shift value for the timestamp continue flag.
WR_SH_MEM_EP_BIT_MASK_EOF_FLAG
Definition of an End of Frame (EOF) flag bitmask.
WR_SH_MEM_EP_SHIFT_EOF_FLAG
Definition of an EOF flag shift value.
DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE
Indicates that the referenced buffer has been fully consumed and is again available to the client.
DATA_CMD_WR_SH_MEM_EP_DATA_BUFFER_V2
Data command to write a buffer and associated metadata to the shared memory end point module.
DATA_CMD_RSP_WR_SH_MEM_EP_DATA_BUFFER_DONE_V2
Indicates that the referenced write buffer has been fully consumed and is again available to the client.
Indicates an update to the media format, which applies to future buffers written to this stream.
DATA_CMD_WR_SH_MEM_EP_EOS
Communicates an EoS marker, which indicates that the last buffer in a stream was delivered.
WR_SH_MEM_EP_EOS_POLICY_LAST
EoS policy according to which last of the final end point raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED OR the last container which drops/renders the EoS raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED event.
WR_SH_MEM_EP_EOS_POLICY_EACH
EoS policy according to which each of the final EP raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED OR the each container which drop the EoS raises the DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED event.
DATA_CMD_RSP_WR_SH_MEM_EP_EOS_RENDERED
Indicates that DATA_CMD_WR_SH_MEM_EP_EOS has been received by the final end-point.
WR_SH_MEM_EP_EOS_RENDER_STATUS_RENDERED
Render status of EoS, where EoS message is rendered on final end device.
WR_SH_MEM_EP_EOS_RENDER_STATUS_DROPPED
Render status of EoS, where EoS message is dropped before it reached the final end device.
PORT_ID_WR_SHARED_MEM_EP_OUTPUT
Output port ID of the Write Shared Memory EP.
Input port ID of the Write Shared Memory EP This Port is connected only in OFFLOAD(MDF) use-cases.
MODULE_ID_WR_SHARED_MEM_EP
ID of the Write Shared Memory End-Point Module.
