TIOVX User Guide

Detailed Description

TI attribute extensions for OpenVX objects.

Enumerations

enum  tivx_graph_attribute_extensions_e { TIVX_GRAPH_STREAM_EXECUTIONS = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_GRAPH) + 0x0 }
 TI attribute extensions for the graph object. More...
 
enum  tivx_node_attribute_extensions_e {
  TIVX_NODE_TARGET_STRING = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_NODE) + 0x0,
  TIVX_NODE_TIMEOUT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_NODE) + 0x1,
  TIVX_NODE_IS_TIMED_OUT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_NODE) + 0x2
}
 TI attribute extensions for the node object. More...
 
enum  tivx_reference_attribute_extensions_e {
  TIVX_REFERENCE_TIMESTAMP = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_REFERENCE) + 0x0,
  TIVX_REFERENCE_INVALID = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_REFERENCE) + 0x1,
  TIVX_REFERENCE_BUFFER_IS_ALLOCATED = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_REFERENCE) + 0x2
}
 TI attribute extensions for the reference object. More...
 
enum  tivx_kernel_attribute_extensions_e { TIVX_KERNEL_TIMEOUT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_KERNEL) + 0x0 }
 TI attribute extensions for the kernel object. More...
 
enum  tivx_context_attribute_extensions_e {
  TIVX_CONTEXT_NUM_USER_KERNEL_ID = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_CONTEXT) + 0x0,
  TIVX_CONTEXT_NUM_USER_LIBRARY_ID = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_CONTEXT) + 0x1
}
 TI attribute extensions for the context object. More...
 
enum  tivx_image_attribute_extensions_e {
  TIVX_IMAGE_IMAGEPATCH_ADDRESSING = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_IMAGE) + 0x0,
  TIVX_IMAGE_STRIDE_Y_ALIGNMENT = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_IMAGE) + 0x1
}
 TI attribute extensions for the image object. More...
 
enum  tivx_tensor_attribute_extensions_e { TIVX_TENSOR_STRIDES = VX_ATTRIBUTE_BASE(VX_ID_TI, (vx_enum)VX_TYPE_TENSOR) + 0x0 }
 TI attribute extensions for the tensor object. More...
 

Enumeration Type Documentation

◆ tivx_graph_attribute_extensions_e

TI attribute extensions for the graph object.

Enumerator
TIVX_GRAPH_STREAM_EXECUTIONS 

Returns the graph stream executions. Read-only. Use a vx_uint32 parameter.

Definition at line 194 of file tivx.h.

◆ tivx_node_attribute_extensions_e

TI attribute extensions for the node object.

Enumerator
TIVX_NODE_TARGET_STRING 

Returns the target string corresponding to the node.

TIVX_NODE_TIMEOUT 

Set/Query the node level timeout parameter. Read-Write. Can be written at initialization as well as at runtime. This timeout attribute affects the operation of the node CREATE and DELETE target kernel functions. Use a vx_uint32 parameter. Refer to TIVX_DEFAULT_KERNEL_TIMEOUT for details on the default value used for this attribute.

TIVX_NODE_IS_TIMED_OUT 

Query the node to see if it has timed out. Read-Only. Can be read at initialization as well as at runtime. Use a vx_bool parameter. Refer to TIVX_DEFAULT_KERNEL_TIMEOUT for more details about node timeouts.

Definition at line 205 of file tivx.h.

◆ tivx_reference_attribute_extensions_e

TI attribute extensions for the reference object.

Enumerator
TIVX_REFERENCE_TIMESTAMP 

Returns the timestamp in micro-seconds corresponding to the given reference.

TIVX_REFERENCE_INVALID 

Returns a boolean indicating whether or not a reference is invalid.

TIVX_REFERENCE_BUFFER_IS_ALLOCATED 

Query the reference to see if the associated buffer has been allocated. Note that this is only applicable in the case that the buffer has been allocated by the framework. It does update if the buffer has been imported to or exported from the vx_reference. Read-Only. Can be read at initialization as well as at runtime. Use a vx_bool parameter.

Definition at line 234 of file tivx.h.

◆ tivx_kernel_attribute_extensions_e

TI attribute extensions for the kernel object.

Enumerator
TIVX_KERNEL_TIMEOUT 

Set/Query the kernel level timeout parameter. Read-Write. Can be written at initialization as well as at runtime. Use a vx_uint32 parameter. Refer to TIVX_DEFAULT_KERNEL_TIMEOUT for details on the default value used for this attribute.

Definition at line 256 of file tivx.h.

◆ tivx_context_attribute_extensions_e

TI attribute extensions for the context object.

Enumerator
TIVX_CONTEXT_NUM_USER_KERNEL_ID 

Query the context number of user kernel ID's. Read-Only. Can be read at initialization as well as at runtime. Use a vx_uint32 parameter. By default, this value is set to 0.

TIVX_CONTEXT_NUM_USER_LIBRARY_ID 

Query the context number of user library ID's. Read-Only. Can be read at initialization as well as at runtime. Use a vx_uint32 parameter. By default, this value is set to 0.

Definition at line 272 of file tivx.h.

◆ tivx_image_attribute_extensions_e

TI attribute extensions for the image object.

Enumerator
TIVX_IMAGE_IMAGEPATCH_ADDRESSING 

Query the imagepatch addressing structure from a vx_image. Read-Only. Can be read at initialization as well as at runtime. Use a vx_imagepatch_addressing_t[TIVX_IMAGE_MAX_PLANES] parameter.

TIVX_IMAGE_STRIDE_Y_ALIGNMENT 

Parameter allowing an application to query or set the stride Y alignment of a vx_image. By default, this value will be set to TIVX_DEFAULT_STRIDE_Y_ALIGN. Care must be taken to understand the requirements of the hardware which is consuming or producing the vx_image. Hardware which is being used via an OpenVX node has verification time errors thrown if the alignment is not in accordance with the requirements of the hardware, but alignment requirements of other hardware which is outside the scope of TIOVX (i.e., codecs) must be understood by the application developer and taken into consideration when creating the image consumed by that hardware. (For instance, the default value was originally chosen since this is a requirement of codec used on TI Jacinto devices) Read-Write. Can be read at any time, but only written to prior to the allocation of the buffer. Cannot be applied to subimages or images with subimages. If attempting to modify as a part of an object array, the exemplar itself shall be set rather than the elements of the object array Use a vx_uint32 parameter.

Definition at line 294 of file tivx.h.

◆ tivx_tensor_attribute_extensions_e

TI attribute extensions for the tensor object.

Enumerator
TIVX_TENSOR_STRIDES 

Query the strides from a vx_tensor object. Read-Only. Can be read at initialization as well as at runtime. Use an array of vx_size * VX_TENSOR_NUMBER_OF_DIMS parameter.

Definition at line 326 of file tivx.h.