TIVX Example Kernels

Introduction

This section documents the kernels which are targted to be examples of writing different kernels.

Files
file	tivx_sample_kernels.h
	The list of supported kernels in this kernel extension.

Data Structures
struct	tivx_pcie_tx_params_t
	PCIe TX Node parameters. More...
struct	tivx_pcie_rx_params_t
	PCIe RX Node parameters. More...
struct	tivx_opengl_mosaic_params_t
	OpenGL Mosaic Node parameters. More...

Functions
void	tivxSampleLoadKernels (vx_context context)
	Used for the Application to load the sample kernels into the context. More...
void	tivxSampleUnLoadKernels (vx_context context)
	Used for the Application to unload the sample kernels from the context. More...
void	tivxSamplePrintPerformance (vx_perf_t performance, uint32_t numPixels, const char *testName)
	Used to print the performance of the kernels. More...
VX_API_ENTRY vx_node VX_API_CALL	tivxOpenglMosaicNode (vx_graph graph, vx_user_data_object configuration, vx_object_array input, vx_image output)
	[Graph] Creates a OPENGL_MOSAIC Node. More...
VX_API_ENTRY vx_node VX_API_CALL	tivxPcieTxNode (vx_graph graph, vx_user_data_object configuration, vx_image input)
	[Graph] Creates a PCIE_TX Node. More...
VX_API_ENTRY vx_node VX_API_CALL	tivxPcieRxNode (vx_graph graph, vx_user_data_object configuration, vx_object_array output)
	[Graph] Creates a PCIE_RX Node. More...

Macros
#define	TIVX_MODULE_NAME_SAMPLE   "sample"
	Name for OpenVX Extension kernel module: sample. More...
#define	TIVX_KERNEL_OPENGL_MOSAIC_NAME   "com.ti.sample.opengl_mosaic"
	The list of kernels supported in sample module. More...
#define	TIVX_KERNEL_PCIE_TX_NAME   "com.ti.sample.pcie_tx"
	pcie_tx kernel name More...
#define	TIVX_KERNEL_PCIE_RX_NAME   "com.ti.sample.pcie_rx"
	pcie_rx kernel name More...
#define	TIVX_KERNEL_PCIE_TX_MAX_CHANNELS   (1U)
	Maximum channels supported by an instance of PCIe TX kernel. More...
#define	TIVX_PCIE_RX_MIN_PIPEUP_BUFS   (3U)
	Minimum pipe-up buffers needed for an instance of PCIe RX kernel. More...
#define	TIVX_KERNEL_PCIE_RX_MAX_CHANNELS   (1U)
	Maximum channels supported by an instance of PCIe RX kernel. More...
#define	TIVX_KERNEL_OPENGL_MOSAIC_TYPE_1x1   (0)
	The configuration data structure used by the TIVX_KERNEL_OPENGL_MOSAIC kernel. More...
#define	TIVX_KERNEL_OPENGL_MOSAIC_TYPE_2x2   (1)

Macro Definition Documentation

TIVX_MODULE_NAME_SAMPLE

#define TIVX_MODULE_NAME_SAMPLE   "sample"

Name for OpenVX Extension kernel module: sample.

TIVX_KERNEL_OPENGL_MOSAIC_NAME

#define TIVX_KERNEL_OPENGL_MOSAIC_NAME   "com.ti.sample.opengl_mosaic"

The list of kernels supported in sample module.

Each kernel listed here can be used with the vxGetKernelByName call. When programming the parameters, use

• VX_INPUT for [in]
• VX_OUTPUT for [out]
• VX_BIDIRECTIONAL for [in,out]

When programming the parameters, use

• VX_TYPE_IMAGE for a vx_image in the size field of vxGetParameterByIndex or vxSetParameterByIndex
• VX_TYPE_ARRAY for a vx_array in the size field of vxGetParameterByIndex or vxSetParameterByIndex
• or other appropriate types in vx_type_e.

opengl_mosaic kernel name

TIVX_KERNEL_PCIE_TX_NAME

#define TIVX_KERNEL_PCIE_TX_NAME   "com.ti.sample.pcie_tx"

pcie_tx kernel name

TIVX_KERNEL_PCIE_RX_NAME

#define TIVX_KERNEL_PCIE_RX_NAME   "com.ti.sample.pcie_rx"

pcie_rx kernel name

TIVX_KERNEL_PCIE_TX_MAX_CHANNELS

#define TIVX_KERNEL_PCIE_TX_MAX_CHANNELS   (1U)

Maximum channels supported by an instance of PCIe TX kernel.

TIVX_PCIE_RX_MIN_PIPEUP_BUFS

#define TIVX_PCIE_RX_MIN_PIPEUP_BUFS   (3U)

Minimum pipe-up buffers needed for an instance of PCIe RX kernel.

TIVX_KERNEL_PCIE_RX_MAX_CHANNELS

#define TIVX_KERNEL_PCIE_RX_MAX_CHANNELS   (1U)

Maximum channels supported by an instance of PCIe RX kernel.

TIVX_KERNEL_OPENGL_MOSAIC_TYPE_1x1

#define TIVX_KERNEL_OPENGL_MOSAIC_TYPE_1x1   (0)

The configuration data structure used by the TIVX_KERNEL_OPENGL_MOSAIC kernel.

< Mosaic/Render Type - 1x1 (single window) mosaic Mosaic/Render Type - 2x2 (4 window) mosaic

TIVX_KERNEL_OPENGL_MOSAIC_TYPE_2x2

#define TIVX_KERNEL_OPENGL_MOSAIC_TYPE_2x2   (1)

Function Documentation

tivxSampleLoadKernels()

void tivxSampleLoadKernels

(

vx_context

context

)

Used for the Application to load the sample kernels into the context.

tivxSampleUnLoadKernels()

void tivxSampleUnLoadKernels

(

vx_context

context

)

Used for the Application to unload the sample kernels from the context.

tivxSamplePrintPerformance()

void tivxSamplePrintPerformance	(	vx_perf_t	performance,
		uint32_t	numPixels,
		const char *	testName
	)

Used to print the performance of the kernels.

tivxOpenglMosaicNode()

VX_API_ENTRY vx_node VX_API_CALL tivxOpenglMosaicNode	(	vx_graph	graph,
		vx_user_data_object	configuration,
		vx_object_array	input,
		vx_image	output
	)

[Graph] Creates a OPENGL_MOSAIC Node.

Parameters

[in]	graph	The reference to the graph.
[in]	configuration
[in]	input
[out]	output

See also

TIVX_KERNEL_OPENGL_MOSAIC_NAME

Returns

vx_node.

Return values

vx_node

A node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus

tivxPcieTxNode()

VX_API_ENTRY vx_node VX_API_CALL tivxPcieTxNode	(	vx_graph	graph,
		vx_user_data_object	configuration,
		vx_image	input
	)

[Graph] Creates a PCIE_TX Node.

Parameters

[in]	graph	The reference to the graph.
[in]	configuration
[in]	input

See also

TIVX_KERNEL_PCIE_TX_NAME

Returns

vx_node.

Return values

vx_node

A node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus

tivxPcieRxNode()

VX_API_ENTRY vx_node VX_API_CALL tivxPcieRxNode	(	vx_graph	graph,
		vx_user_data_object	configuration,
		vx_object_array	output
	)

[Graph] Creates a PCIE_RX Node.

Parameters

[in]	graph	The reference to the graph.
[in]	configuration
[out]	output

See also

TIVX_KERNEL_PCIE_RX_NAME

Returns

vx_node.

Return values

vx_node

A node reference. Any possible errors preventing a successful creation should be checked using vxGetStatus