Vision Apps User Guide

Introduction

This section contains module APIs for the TIOVX Capture node tivxHwaCapture.

Data Structures

struct  CaptureObj
 Capture Module Data Structure. More...
 

Functions

vx_status app_init_capture (vx_context context, CaptureObj *captureObj, SensorObj *sensorObj, char *objName, int32_t bufq_depth)
 Capture module init helper function. More...
 
void app_deinit_capture (CaptureObj *captureObj, vx_int32 bufq_depth)
 Capture module deinit helper function. More...
 
void app_delete_capture (CaptureObj *captureObj)
 Capture module delete helper function. More...
 
vx_status app_create_graph_capture (vx_graph graph, CaptureObj *captureObj)
 Capture module create helper function. More...
 
vx_status app_create_graph_capture_write_output (vx_graph graph, CaptureObj *captureObj)
 Capture module write output helper function. More...
 
vx_status app_send_cmd_capture_write_node (CaptureObj *captureObj, vx_uint32 start_frame, vx_uint32 num_frames, vx_uint32 num_skip)
 Capture module write output helper function. More...
 
vx_status app_send_error_frame (CaptureObj *captureObj)
 Capture module write output helper function. More...
 
tivx_raw_image read_error_image_raw (vx_context context, IssSensor_Info *sensorInfo, char file_path[], vx_int32 *bytes_read)
 Capture module write output helper function. More...
 

Macros

#define NUM_CAPT_CHANNELS   (4u)
 Number of capture channels that are used by this module. Can be modified as needed. More...
 

Macro Definition Documentation

◆ NUM_CAPT_CHANNELS

#define NUM_CAPT_CHANNELS   (4u)

Number of capture channels that are used by this module. Can be modified as needed.

Function Documentation

◆ app_init_capture()

vx_status app_init_capture ( vx_context  context,
CaptureObj captureObj,
SensorObj sensorObj,
char *  objName,
int32_t  bufq_depth 
)

Capture module init helper function.

This capture init helper function will create all the data objects required to create the capture node

Parameters
[in]contextOpenVX context which must be created using vxCreateContext
[out]captureObjCapture Module object which gets populated with capture node data objects
[in]sensorObjSensor Module object used to initialize capture data object parameters; must be initialized prior to passing to this function
[in]objNameString of the name of this object
[in]bufq_depthCapture output buffer queue depth

◆ app_deinit_capture()

void app_deinit_capture ( CaptureObj captureObj,
vx_int32  bufq_depth 
)

Capture module deinit helper function.

This capture deinit helper function will release all the data objects created during the app_init_capture call

Parameters
[in,out]captureObjCapture Module object which contains capture node data objects which are released in this function
[in]bufq_depthCapture output buffer queue depth

◆ app_delete_capture()

void app_delete_capture ( CaptureObj captureObj)

Capture module delete helper function.

This capture delete helper function will delete the capture node and write node that is created during the app_create_graph_capture call

Parameters
[in,out]captureObjCapture Module object which contains capture node objects which are released in this function

◆ app_create_graph_capture()

vx_status app_create_graph_capture ( vx_graph  graph,
CaptureObj captureObj 
)

Capture module create helper function.

This capture create helper function will create the node using all the data objects created during the app_init_capture call. Internally calls app_create_graph_capture_write_output if en_out_capture_write is set

Parameters
[in]graphOpenVX graph that has been created using vxCreateGraph and where the capture node is created
[in,out]captureObjCapture Module object which contains capture node and write node which are created in this function

◆ app_create_graph_capture_write_output()

vx_status app_create_graph_capture_write_output ( vx_graph  graph,
CaptureObj captureObj 
)

Capture module write output helper function.

This capture create helper function will create the node for writing the capture output

Parameters
[in]graphOpenVX graph
[in,out]captureObjCapture Module object which contains capture node and write node which are created in this function

◆ app_send_cmd_capture_write_node()

vx_status app_send_cmd_capture_write_node ( CaptureObj captureObj,
vx_uint32  start_frame,
vx_uint32  num_frames,
vx_uint32  num_skip 
)

Capture module write output helper function.

This capture create helper function will create the node for writing the capture output

Parameters
[in]captureObjCapture Module object which contains the write node used in this function
[in]start_frameStarting frame to write
[in]num_framesTotal number of frames to write
[in]num_skipNumber of capture frames to skip writing

◆ app_send_error_frame()

vx_status app_send_error_frame ( CaptureObj captureObj)

Capture module write output helper function.

This capture helper function send the blank frame to the capture node over a control command. This frame is used as the output for when a camera is disconnected

Parameters
[in]captureObjCapture Module object which contains the error frame object for using as blank frame

◆ read_error_image_raw()

tivx_raw_image read_error_image_raw ( vx_context  context,
IssSensor_Info *  sensorInfo,
char  file_path[],
vx_int32 *  bytes_read 
)

Capture module write output helper function.

This capture helper function takes a raw_image that is unpopulated and populates it with the provided path

Parameters
[in]contextOpenVX context which must be created using vxCreateContext
[in]sensorInfoCapture sensor information
[in]file_pathPath to image
[out]bytes_readNumber of bytes read from file