Node APIs

Detailed Description

Internal APIs for node operations.

Data Structures
struct	tivx_node_t
	The internal representation of a node. More...

Functions
vx_status	ownSetNodeImmTarget (vx_node node)
	Set the target for node based on immediate mode target set in context. More...
vx_status	ownSetNodeAttributeValidRectReset (vx_node node, vx_bool is_reset)
	Set the attribute VX_NODE_VALID_RECT_RESET in node. More...
vx_status	ownNodeKernelValidate (vx_node node, vx_meta_format meta[])
	Validate user kernel or target kernel associated with this node.
vx_status	ownNodeKernelInit (vx_node node)
	Init user kernel or target kernel associated with this node.
vx_status	ownNodeKernelInitKernelName (vx_node node)
	Init user kernel or target kernel name associated with this node.
vx_status	ownNodeKernelDeinitKernelName (vx_node node)
	Deinit user kernel or target kernel name associated with this node.
vx_status	ownNodeKernelSchedule (vx_node node, uint32_t pipeline_id)
	Schedule user kernel or target kernel associated with this node for execution.
vx_status	ownNodeKernelDeinit (vx_node node)
	DeInit user kernel or target kernel associated with this node.
vx_status	ownResetNodePerf (vx_node node)
	Reset node performance statistics.
vx_status	ownUpdateNodePerf (vx_node node, uint32_t pipeline_id)
	Called by graph each time after node execution.
uint32_t	ownNodeGetNumParameters (vx_node node)
	Return number of node parameters.
vx_enum	ownNodeGetParameterDir (vx_node node, uint32_t prm_index)
	Get direction of a parameter.
vx_reference	ownNodeGetParameterRef (vx_node node, uint32_t prm_index)
	Get reference associated with a parameters of a parameter.
vx_status	ownNodeAddOutNode (vx_node node, vx_node out_node)
	Associate a output node with a given node.
vx_status	ownNodeReplaceOutNode (vx_node node, vx_node old_out_node, vx_node new_out_node)
	Replace an output node for a given node with a new output node.
vx_status	ownNodeAddInNode (vx_node node, vx_node out_node)
	Associate a input node with a given node.
vx_status	ownNodeReplaceInNode (vx_node node, vx_node old_in_node, vx_node new_in_node)
	Replace an input node for a given node with a new input node.
uint32_t	ownNodeGetNumInNodes (vx_node node)
	Get number of input nodes associated with this node.
uint32_t	ownNodeGetNumOutNodes (vx_node node)
	Get number of output nodes associated with this node.
vx_status	ownNodeCreateUserCallbackCommand (vx_node node, uint32_t pipeline_id)
	Create resources required to call a user callback If user callback is assigned then nothing is done.
vx_action	ownNodeExecuteUserCallback (vx_node node)
	Call user specified callback.
void	ownNodeClearExecuteState (vx_node node, uint32_t pipeline_id)
	clears execute status of the node
vx_status	ownNodeUserKernelExecute (vx_node node, vx_reference prm_ref[])
	Execute user kernel.
vx_bool	ownNodeIsPrmReplicated (vx_node node, uint32_t prm_idx)
	Is prm_idx of node replicated.
void	ownNodeSetParameter (vx_node node, vx_uint32 index, vx_reference value)
	Set parameter at node.
vx_node	ownNodeGetNextNode (vx_node node, vx_uint32 index)
	Get next node at given output index.
vx_node	ownNodeGetNextInNode (vx_node node, vx_uint32 index)
	Get next node at given input index.
vx_bool	ownCheckNodeCompleted (vx_node node, uint32_t pipeline_id)
	Check if node is completed. More...
vx_status	ownNodeRegisterEvent (vx_node node, vx_enum event_type, vx_uint32 app_value)
	Register node completion event.
void	ownNodeCheckAndSendCompletionEvent (const tivx_obj_desc_node_t *node_obj_desc, uint64_t timestamp)
	Send node completion event if enabled.
void	ownNodeCheckAndSendErrorEvent (const tivx_obj_desc_node_t *node_obj_desc, uint64_t timestamp, vx_status status)
	Send node error event if node failed.
vx_status	ownNodeAllocObjDescForPipeline (vx_node node, uint32_t pipeline_depth)
	Alloc additional node obj desc's for pipelining.
void	ownNodeSetObjDescParamDirection (vx_node node)
	Set param direction for 0th node obj desc.
void	ownNodeLinkObjDescForPipeline (vx_node node)
	Update in node id and out node id for node pipeline obj desc's.
void	ownNodeLinkDataRefQueue (vx_node node, uint32_t prm_id, tivx_data_ref_queue data_ref_q)
	Link data ref q to node at parameter index 'prm_id'.
void	ownNodeLinkArrayElement (vx_node node, uint32_t prm_id)
	Link array element to node at parameter index 'prm_id'.
uint32_t	ownNodeGetParameterNumBuf (vx_node node, vx_uint32 index)
	Return number of buffers to alocate at a node,index. More...

Function Documentation

ownSetNodeImmTarget()

vx_status ownSetNodeImmTarget

(

vx_node

node

)

Set the target for node based on immediate mode target set in context.

Parameters

[in]

node

The reference to the node

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS

No errors.

ownSetNodeAttributeValidRectReset()

vx_status ownSetNodeAttributeValidRectReset	(	vx_node	node,
		vx_bool	is_reset
	)

Set the attribute VX_NODE_VALID_RECT_RESET in node.

Parameters

[in]	node	The reference to the node
[in]	is_reset	The value to set for the attribute

Returns

A vx_status_e enumeration.

Return values

VX_SUCCESS

No errors.

ownCheckNodeCompleted()

vx_bool ownCheckNodeCompleted	(	vx_node	node,
		uint32_t	pipeline_id
	)

Check if node is completed.

Does not block for node completion.

ownNodeGetParameterNumBuf()

uint32_t ownNodeGetParameterNumBuf	(	vx_node	node,
		vx_uint32	index
	)

Return number of buffers to alocate at a node,index.

Valid only for output parameters

Returns 0 is user has not made any specific choice or invalid parameter