Vision Apps User Guide
app_capture_module.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2020 Texas Instruments Incorporated
4  *
5  * All rights reserved not granted herein.
6  *
7  * Limited License.
8  *
9  * Texas Instruments Incorporated grants a world-wide, royalty-free, non-exclusive
10  * license under copyrights and patents it now or hereafter owns or controls to make,
11  * have made, use, import, offer to sell and sell ("Utilize") this software subject to the
12  * terms herein. With respect to the foregoing patent license, such license is granted
13  * solely to the extent that any such patent is necessary to Utilize the software alone.
14  * The patent license shall not apply to any combinations which include this software,
15  * other than combinations with devices manufactured by or for TI ("TI Devices").
16  * No hardware patent is licensed hereunder.
17  *
18  * Redistributions must preserve existing copyright notices and reproduce this license
19  * (including the above copyright notice and the disclaimer and (if applicable) source
20  * code license limitations below) in the documentation and/or other materials provided
21  * with the distribution
22  *
23  * Redistribution and use in binary form, without modification, are permitted provided
24  * that the following conditions are met:
25  *
26  * * No reverse engineering, decompilation, or disassembly of this software is
27  * permitted with respect to any software provided in binary form.
28  *
29  * * any redistribution and use are licensed by TI for use only with TI Devices.
30  *
31  * * Nothing shall obligate TI to provide you with source code for the software
32  * licensed and provided to you in object code.
33  *
34  * If software source code is provided to you, modification and redistribution of the
35  * source code are permitted provided that the following conditions are met:
36  *
37  * * any redistribution and use of the source code, including any resulting derivative
38  * works, are licensed by TI for use only with TI Devices.
39  *
40  * * any redistribution and use of any object code compiled from the source code
41  * and any resulting derivative works, are licensed by TI for use only with TI Devices.
42  *
43  * Neither the name of Texas Instruments Incorporated nor the names of its suppliers
44  *
45  * may be used to endorse or promote products derived from this software without
46  * specific prior written permission.
47  *
48  * DISCLAIMER.
49  *
50  * THIS SOFTWARE IS PROVIDED BY TI AND TI'S LICENSORS "AS IS" AND ANY EXPRESS
51  * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
52  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
53  * IN NO EVENT SHALL TI AND TI'S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT,
54  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
55  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
57  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
58  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
59  * OF THE POSSIBILITY OF SUCH DAMAGE.
60  *
61  */
62 #ifndef _APP_CAPTURE_MODULE
63 #define _APP_CAPTURE_MODULE
64 
75 #include "app_modules.h"
76 #include "app_sensor_module.h"
77 #include <TI/video_io_capture.h>
78 
82 #define NUM_CAPT_CHANNELS (4u)
83 
89 typedef struct {
91  vx_node node;
92 
94  vx_user_data_object config;
95 
97  tivx_capture_params_t params;
98 
100  vx_object_array raw_image_arr[APP_MODULES_MAX_BUFQ_DEPTH];
101 
104 
107 
109  vx_int32 test_mode;
110 
112  vx_node write_node;
113 
115  vx_array file_path;
116 
118  vx_array file_prefix;
119 
121  vx_user_data_object write_cmd;
122 
124  vx_char output_file_path[TIVX_FILEIO_FILE_PATH_LENGTH];
125 
128 
130  tivx_raw_image error_frame_raw_image;
131 
134 
136  vx_uint32 capture_format;
137 }CaptureObj;
138 
152 vx_status app_init_capture(vx_context context, CaptureObj *captureObj, SensorObj *sensorObj, char *objName, int32_t bufq_depth);
153 
154 
163 void app_deinit_capture(CaptureObj *captureObj, vx_int32 bufq_depth);
164 
165 
173 void app_delete_capture(CaptureObj *captureObj);
174 
175 
185 vx_status app_create_graph_capture(vx_graph graph, CaptureObj *captureObj);
186 
195 vx_status app_create_graph_capture_write_output(vx_graph graph, CaptureObj *captureObj);
196 
207 vx_status app_send_cmd_capture_write_node(CaptureObj *captureObj, vx_uint32 start_frame, vx_uint32 num_frames, vx_uint32 num_skip);
208 
209 
218 vx_status app_send_error_frame(CaptureObj *captureObj);
219 
230 tivx_raw_image read_error_image_raw(vx_context context, IssSensor_Info *sensorInfo, char file_path[], vx_int32 *bytes_read);
231 
232 /* @} */
233 
234 #endif
vx_int32 test_mode
Definition: app_capture_module.h:109
vx_int32 graph_parameter_index
Definition: app_capture_module.h:103
vx_uint8 enable_error_detection
Definition: app_capture_module.h:133
void app_delete_capture(CaptureObj *captureObj)
Capture module delete helper function.
#define APP_MODULES_MAX_OBJ_NAME_SIZE
Definition: app_modules.h:88
vx_node write_node
Definition: app_capture_module.h:112
vx_status app_init_capture(vx_context context, CaptureObj *captureObj, SensorObj *sensorObj, char *objName, int32_t bufq_depth)
Capture module init helper function.
tivx_capture_params_t params
Definition: app_capture_module.h:97
vx_array file_prefix
Definition: app_capture_module.h:118
#define APP_MODULES_MAX_BUFQ_DEPTH
Definition: app_modules.h:89
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.
#define TIVX_FILEIO_FILE_PATH_LENGTH
Definition: tivx_fileio_kernels.h:58
Sensor Module Data Structure.
Definition: app_sensor_module.h:97
vx_status app_create_graph_capture(vx_graph graph, CaptureObj *captureObj)
Capture module create helper function.
vx_node node
Definition: app_capture_module.h:91
void app_deinit_capture(CaptureObj *captureObj, vx_int32 bufq_depth)
Capture module deinit helper function.
vx_uint32 capture_format
Definition: app_capture_module.h:136
Capture Module Data Structure.
Definition: app_capture_module.h:89
vx_user_data_object config
Definition: app_capture_module.h:94
vx_int32 en_out_capture_write
Definition: app_capture_module.h:106
vx_status app_create_graph_capture_write_output(vx_graph graph, CaptureObj *captureObj)
Capture module write output helper function.
vx_array file_path
Definition: app_capture_module.h:115
vx_user_data_object write_cmd
Definition: app_capture_module.h:121
tivx_raw_image error_frame_raw_image
Definition: app_capture_module.h:130
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.
vx_status app_send_error_frame(CaptureObj *captureObj)
Capture module write output helper function.