tivx_data_ref_queue.h File Reference

Implementation of Data Reference Queue Object APIs. More...

Go to the source code of this file.

Data Structures
struct	tivx_data_ref_queue_t
	Data Ref Queue internal state. More...
struct	tivx_data_ref_queue_create_params_t
	Parameters used to create a data ref queue. More...

Typedefs
typedef struct _tivx_data_ref_queue *	tivx_data_ref_queue
	Data Ref Queue Object.

Functions
tivx_data_ref_queue	tivxDataRefQueueCreate (vx_graph graph, const tivx_data_ref_queue_create_params_t *prms)
	Create data reference queue.
vx_status	ownDataRefQueueRelease (tivx_data_ref_queue *ref)
	Release data reference queue.
uint16_t	ownDataRefQueueGetObjDescId (tivx_data_ref_queue ref, uint32_t pipeline_id)
	return object descriptor ID of specific pipeline ID
vx_status	ownDataRefQueueEnqueueReadyRef (tivx_data_ref_queue data_ref_q, vx_reference ref)
	Enqueue 'ref' into 'READY' queue. More...
vx_status	ownDataRefQueueDequeueDoneRef (tivx_data_ref_queue data_ref_q, vx_reference *ref)
	Dequeue 'ref' from 'DONE' queue. More...
vx_status	ownDataRefQueueWaitDoneRef (tivx_data_ref_queue data_ref_q, vx_uint32 timeout)
	Wait for 'DONE' queue to be non-empty. More...
vx_status	ownDataRefQueueGetDoneQueueCount (tivx_data_ref_queue data_ref_q, vx_uint32 *count)
	Return number of elements in 'DONE' queue.
vx_status	ownDataRefQueueGetReadyQueueCount (tivx_data_ref_queue data_ref_q, vx_uint32 *count)
	Return number of elements in 'READY' queue.
vx_status	ownDataRefQueueSendRefConsumedEvent (tivx_data_ref_queue ref, uint64_t timestamp)
	Send 'ref consumed event' if event send is enabled.
vx_status	ownDataRefQueueLinkDelayDataRefQueues (tivx_data_ref_queue delay_data_ref_q_list[], vx_bool auto_age_delay_slot[], uint32_t delay_slots)
	Link data ref queues that participate in a delay in a circular manner.

Detailed Description

Implementation of Data Reference Queue Object APIs.

Definition in file tivx_data_ref_queue.h.

Function Documentation

ownDataRefQueueEnqueueReadyRef()

vx_status ownDataRefQueueEnqueueReadyRef	(	tivx_data_ref_queue	data_ref_q,
		vx_reference	ref
	)

Enqueue 'ref' into 'READY' queue.

if queue is full, VX_FAILURE is returned.

NOTE, this is a non-blocking API.

ownDataRefQueueDequeueDoneRef()

vx_status ownDataRefQueueDequeueDoneRef	(	tivx_data_ref_queue	data_ref_q,
		vx_reference *	ref
	)

Dequeue 'ref' from 'DONE' queue.

if queue is empty VX_FAILURE is returned and 'ref' is set to NULL

NOTE, this is a non-blocking API.

ownDataRefQueueWaitDoneRef()

vx_status ownDataRefQueueWaitDoneRef	(	tivx_data_ref_queue	data_ref_q,
		vx_uint32	timeout
	)

Wait for 'DONE' queue to be non-empty.

if 'timeout' units of time elaspes then VX_FAILURE is returned

NOTE, this is a blocking API and block for 'timeout' units of time