Vision Apps User Guide
app_sensor_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_SENSOR_MODULE
63 #define _APP_SENSOR_MODULE
64 
75 #include "app_modules.h"
76 
80 #define APP_SENSOR_FEATURE_CFG_UC0 (0)
81 
85 #define APP_SENSOR_FEATURE_CFG_UC1 (1)
86 
90 #define APP_SENSOR_FEATURE_CFG_UC2 (2)
91 
97 typedef struct {
99  IssSensor_CreateParams sensorParams;
100 
102  vx_user_data_object dcc_config;
103 
105  char availableSensorNames[ISS_SENSORS_MAX_SUPPORTED_SENSOR][ISS_SENSORS_MAX_NAME];
106 
108  vx_char sensor_name[ISS_SENSORS_MAX_NAME];
109 
112 
115 
118 
121 
124 
127 
130 
133 
134  uint32_t ch_mask;
135 
137  vx_int32 is_interactive;
138 
140  vx_int32 enable_ldc;
141 
143  vx_int32 sensor_index;
144 
146  vx_int32 usecase_option;
147 
149  vx_int32 image_width;
150 
152  vx_int32 image_height;
153 
156 
157 } SensorObj;
158 
167 vx_status app_querry_sensor(SensorObj *sensorObj);
168 
178 vx_status app_init_sensor(SensorObj *sensorObj, char *objName);
179 
187 void app_deinit_sensor(SensorObj *sensorObj);
188 
189 /* @} */
190 
191 #endif //__APP_SENSOR_MODULE
vx_int32 usecase_option
Definition: app_sensor_module.h:146
vx_user_data_object dcc_config
Definition: app_sensor_module.h:102
uint32_t num_cameras_enabled
Definition: app_sensor_module.h:132
vx_status app_init_sensor(SensorObj *sensorObj, char *objName)
Sensor module init sensor helper function.
uint32_t sensor_dcc_enabled
Definition: app_sensor_module.h:120
uint32_t sensor_gain_control_enabled
Definition: app_sensor_module.h:129
uint32_t sensor_out_format
Definition: app_sensor_module.h:155
vx_int32 sensor_index
Definition: app_sensor_module.h:143
vx_int32 image_width
Definition: app_sensor_module.h:149
uint32_t sensor_features_enabled
Definition: app_sensor_module.h:114
uint32_t ch_mask
Definition: app_sensor_module.h:134
void app_deinit_sensor(SensorObj *sensorObj)
Sensor module deinit sensor helper function.
vx_int32 enable_ldc
Definition: app_sensor_module.h:140
uint8_t num_sensors_found
Definition: app_sensor_module.h:111
IssSensor_CreateParams sensorParams
Definition: app_sensor_module.h:99
uint32_t sensor_exp_control_enabled
Definition: app_sensor_module.h:126
vx_int32 image_height
Definition: app_sensor_module.h:152
Sensor Module Data Structure.
Definition: app_sensor_module.h:97
vx_int32 is_interactive
Definition: app_sensor_module.h:137
vx_status app_querry_sensor(SensorObj *sensorObj)
Sensor module query sensor helper function.
uint32_t sensor_features_supported
Definition: app_sensor_module.h:117
uint32_t sensor_wdr_enabled
Definition: app_sensor_module.h:123