EdgeAI TIOVX Apps Guide
tiovx_modules.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (c) 2024 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 _TIOVX_MODULES
63 #define _TIOVX_MODULES
64 
65 #include "tiovx_modules_types.h"
66 #include "tiovx_modules_cbs.h"
67 
68 #ifdef __cplusplus
69 extern "C" {
70 #endif
71 
76 vx_status tiovx_modules_initialize_graph(GraphObj *graph);
77 
88 NodeObj* tiovx_modules_add_node(GraphObj *graph, NODE_TYPES node_type, void *cfg);
89 
90 
98 vx_status tiovx_modules_verify_graph(GraphObj *graph);
99 
100 
108 vx_status tiovx_modules_export_graph(GraphObj *graph, char *path, char *prefix);
109 
119 NodeObj* tiovx_modules_get_node_by_name(GraphObj *graph, char *name);
120 
128 void tiovx_modules_print_performance(GraphObj *graph);
129 
138 Buf* tiovx_modules_acquire_buf(BufPool *buf_pool);
139 
146 vx_status tiovx_modules_release_buf(Buf *buf);
147 
154 vx_status tiovx_modules_clean_graph(GraphObj *graph);
155 
162 vx_status tiovx_modules_enqueue_buf(Buf *buf);
163 
172 Buf* tiovx_modules_dequeue_buf(BufPool *buf_pool);
173 
180 vx_status tiovx_modules_schedule_graph(GraphObj *graph);
181 
188 vx_status tiovx_modules_wait_graph(GraphObj *graph);
189 
190 
197 vx_status tiovx_modules_release_node(NodeObj *node);
198 
199 #ifdef __cplusplus
200 }
201 #endif
202 
203 #endif //_TIOVX_MODULES
NODE_TYPES
Enum that lists all available modules.
Definition: tiovx_modules_cbs.h:97
vx_status tiovx_modules_release_node(NodeObj *node)
Function to release a node, to be used only in modules.
Definition: tiovx_modules.c:884
vx_status tiovx_modules_release_buf(Buf *buf)
Release a previously acquired buffer back to its pool.
Definition: tiovx_modules.c:164
Buf * tiovx_modules_acquire_buf(BufPool *buf_pool)
Acquire a free buffer from a buffer pool.
Definition: tiovx_modules.c:145
vx_status tiovx_modules_wait_graph(GraphObj *graph)
Function to wait for graph exec, if mode set to manual.
Definition: tiovx_modules.c:860
vx_status tiovx_modules_clean_graph(GraphObj *graph)
Function to clean the graph at the end of the application.
Definition: tiovx_modules.c:911
void tiovx_modules_print_performance(GraphObj *graph)
Function to print performance of each node in graph.
Definition: tiovx_modules.c:761
vx_status tiovx_modules_export_graph(GraphObj *graph, char *path, char *prefix)
Function to export graph as a dot file.
Definition: tiovx_modules.c:738
vx_status tiovx_modules_enqueue_buf(Buf *buf)
Function to enqueue a buffer to OpenVX graph.
Definition: tiovx_modules.c:793
vx_status tiovx_modules_schedule_graph(GraphObj *graph)
Function to schedule graph, if mode set to manual.
Definition: tiovx_modules.c:850
vx_status tiovx_modules_initialize_graph(GraphObj *graph)
Function to initialize a graph object.
Definition: tiovx_modules.c:74
Buf * tiovx_modules_dequeue_buf(BufPool *buf_pool)
dequeue a buffer from OpenVX graph.
Definition: tiovx_modules.c:823
NodeObj * tiovx_modules_get_node_by_name(GraphObj *graph, char *name)
Function to get access to node object by name.
Definition: tiovx_modules.c:747
NodeObj * tiovx_modules_add_node(GraphObj *graph, NODE_TYPES node_type, void *cfg)
Function to add a new node to graph.
Definition: tiovx_modules.c:96
vx_status tiovx_modules_verify_graph(GraphObj *graph)
Function to be called after adding and connecting all the nodes. This function will created actual Op...
Definition: tiovx_modules.c:678