TIOVX User Guide
hwa_vpac_viss3l.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2022 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 
63 #ifndef HWA_VPAC3L_VISS_H_
64 #define HWA_VPAC3L_VISS_H_
65 
66 #include <VX/vx.h>
67 #include <VX/vx_kernels.h>
68 
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72 
78 #define TIVX_VPAC_VISS_FCP_NUM_INSTANCES (1U)
79 
81 #define TIVX_VPAC_VISS_IR_DISABLE (0U)
82 
83 #define TIVX_VPAC_VISS_IR_ENABLE (1U)
84 
86 #define TIVX_VPAC_VISS_BAYER_DISABLE (0U)
87 
88 #define TIVX_VPAC_VISS_BAYER_ENABLE (1U)
89 
90 /*********************************
91  * VPAC_VISS STRUCTURES
92  *********************************/
93 
99 typedef struct {
102  uint32_t sensor_dcc_id;
103 
107  uint32_t use_case;
108 
111  uint32_t fcp1_config;
112 
117  tivx_vpac_viss_fcp_params_t fcp[TIVX_VPAC_VISS_FCP_NUM_INSTANCES];
118 
121  uint32_t enable_ir_op;
122 
125  uint32_t ir_output;
126 
127  /* PCID has capabilities to generate bayer output and IR output from a
128  single RGBIR frame. This flag enales bayer output. */
129  uint32_t enable_bayer_op;
130 
135  uint32_t output_fcp_mapping[5];
136 
139  uint32_t bypass_cac;
140 
143  uint32_t bypass_dwb;
144 
147  uint32_t bypass_nsf4;
148 
151  uint32_t bypass_glbce;
152 
155  uint32_t bypass_pcid;
156 
171  uint32_t h3a_in;
172 
182  uint32_t h3a_aewb_af_mode;
183 
198  uint32_t enable_ctx;
199 
203  uint32_t channel_id;
205 
206 
207 /*********************************
208  * Function Prototypes
209  *********************************/
210 
342 VX_API_ENTRY vx_node VX_API_CALL tivxVpacVissNode(vx_graph graph,
343  vx_user_data_object configuration,
344  vx_user_data_object ae_awb_result,
345  vx_user_data_object dcc_buf,
346  tivx_raw_image raw,
347  vx_image output0,
348  vx_image output1,
349  vx_image output2,
350  vx_image output3,
351  vx_image output4,
352  vx_user_data_object h3a_output,
353  vx_distribution histogram0,
354  vx_distribution histogram1,
355  vx_distribution raw_histogram);
356 
357 #ifdef __cplusplus
358 }
359 #endif
360 
361 #endif /* HWA_VPAC3L_VISS_H_ */
362 
struct _vx_image * vx_image
struct _vx_distribution * vx_distribution
struct _tivx_raw_image * tivx_raw_image
The Raw Image Object. Raw Image is a strongly-typed container for RAW sensor images.
The Flex Color Processing (FCP) data structure used in the tivx_vpac_viss_params_t structure for prog...
VX_API_ENTRY vx_node VX_API_CALL tivxVpacVissNode(vx_graph graph, vx_user_data_object configuration, vx_user_data_object ae_awb_result, vx_user_data_object dcc_buf, tivx_raw_image raw, vx_image output0, vx_image output1, vx_image output2, vx_image output3, vx_image output4, vx_user_data_object h3a_output, vx_distribution histogram0, vx_distribution histogram1, vx_distribution raw_histogram)
[Graph] Creates a VPAC_VISS Node.
struct _vx_user_data_object * vx_user_data_object
The User Data Object. User Data Object is a strongly-typed container for other data structures...
The configuration data structure used by the TIVX_KERNEL_VISS kernel.
struct _vx_graph * vx_graph
struct _vx_node * vx_node
vx_status(* VX_API_CALL)(vx_reference *ref)
Callback type used to register release callbacks from object derived from references.
Definition: vx_reference.h:56