NVIDIA DeepStream SDK API Reference

6.2 Release
nvds_yml_parser.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 
39 #ifndef _NVGSTDS_YAML_PARSER_H_
40 #define _NVGSTDS_YAML_PARSER_H_
41 
42 #ifdef __cplusplus
43 extern "C"
44 {
45 #endif
46 
47 #include <gst/gst.h>
48 
52 typedef enum NvDsYamlParserStatus {
60 
64 typedef enum
65 {
70 } NvDsGieType;
71 
72 
73 
84 nvds_parse_file_source(GstElement *element, gchar *cfg_file_path, const char* group);
85 
86 
97 nvds_parse_uridecodebin(GstElement *element, gchar *cfg_file_path, const char* group);
98 
99 
110 nvds_parse_rtsp_source(GstElement *element, gchar *cfg_file_path, const char* group);
111 
112 
123 nvds_parse_nvarguscamerasrc(GstElement *element, gchar *cfg_file_path, const char* group);
124 
135 nvds_parse_v4l2src(GstElement *element, gchar *cfg_file_path, const char* group);
136 
147 nvds_parse_multifilesrc(GstElement *element, gchar *cfg_file_path, const char* group);
148 
159 nvds_parse_alsasrc(GstElement *element, gchar *cfg_file_path, const char* group);
160 
161 
174 nvds_parse_source_list(GList ** src_list, gchar *cfg_file_path, const char* group);
175 
186 nvds_parse_streammux(GstElement *element, gchar *cfg_file_path, const char* group);
187 
198 nvds_parse_tracker(GstElement *element, gchar *cfg_file_path, const char* group);
199 
210 nvds_parse_osd(GstElement *element, gchar *cfg_file_path, const char* group);
211 
222 nvds_parse_tiler(GstElement *element, gchar *cfg_file_path, const char* group);
223 
234 nvds_parse_msgbroker(GstElement *element, gchar *cfg_file_path, const char* group);
235 
246 nvds_parse_msgconv(GstElement *element, gchar *cfg_file_path, const char* group);
247 
258 nvds_parse_gie(GstElement *element, gchar *cfg_file_path, const char* group);
259 
271 nvds_parse_gie_type (NvDsGieType* gie_type, gchar* cfg_file_path, const char* group);
272 
283 nvds_parse_egl_sink(GstElement *element, gchar *cfg_file_path, const char* group);
284 
295 nvds_parse_3d_sink(GstElement *element, gchar *cfg_file_path, const char* group);
296 
307 nvds_parse_file_sink(GstElement *element, gchar *cfg_file_path, const char* group);
308 
319 nvds_parse_fake_sink(GstElement *element, gchar *cfg_file_path, const char* group);
320 
321 
322 #ifdef __cplusplus
323 }
324 #endif
325 
326 #endif /* _NVGSTDS_YAML_PARSER_H_ */
327 
nvds_parse_rtsp_source
NvDsYamlParserStatus nvds_parse_rtsp_source(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a rtspsrc element from values specified in a YAML configuration file.
nvds_parse_egl_sink
NvDsYamlParserStatus nvds_parse_egl_sink(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nveglglessink element from values specified in a YAML configuration file.
nvds_parse_tracker
NvDsYamlParserStatus nvds_parse_tracker(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvtracker element from values specified in a YAML configuration file.
nvds_parse_tiler
NvDsYamlParserStatus nvds_parse_tiler(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvtiler element from values specified in a YAML configuration file.
nvds_parse_alsasrc
NvDsYamlParserStatus nvds_parse_alsasrc(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a alsasrc element from values specified in a YAML configuration file.
NVDS_GIE_PLUGIN_INFER_SERVER
@ NVDS_GIE_PLUGIN_INFER_SERVER
Inference using nvinferserver GIE.
Definition: nvds_yml_parser.h:69
nvds_parse_osd
NvDsYamlParserStatus nvds_parse_osd(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvdsosd element from values specified in a YAML configuration file.
nvds_parse_msgconv
NvDsYamlParserStatus nvds_parse_msgconv(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvmsgconv element from values specified in a YAML configuration file.
nvds_parse_fake_sink
NvDsYamlParserStatus nvds_parse_fake_sink(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a fakesink element from values specified in a YAML configuration file.
NVDS_YAML_PARSER_SUCCESS
@ NVDS_YAML_PARSER_SUCCESS
Properties were set correctly.
Definition: nvds_yml_parser.h:54
nvds_parse_msgbroker
NvDsYamlParserStatus nvds_parse_msgbroker(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvmsgbroker element from values specified in a YAML configuration file.
NvDsGieType
NvDsGieType
Enum for specifying the inference plugin type.
Definition: nvds_yml_parser.h:64
nvds_parse_gie
NvDsYamlParserStatus nvds_parse_gie(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvinfer element from values specified in a YAML configuration file.
NvDsYamlParserStatus
NvDsYamlParserStatus
Enum for Yaml parsing status for the API call on a GstElement.
Definition: nvds_yml_parser.h:52
nvds_parse_uridecodebin
NvDsYamlParserStatus nvds_parse_uridecodebin(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a uridecodebin element from values specified in a YAML configuration file.
NVDS_YAML_PARSER_DISABLED
@ NVDS_YAML_PARSER_DISABLED
Property group was disabled, properties were not set.
Definition: nvds_yml_parser.h:56
nvds_parse_file_sink
NvDsYamlParserStatus nvds_parse_file_sink(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a filesink element from values specified in a YAML configuration file.
nvds_parse_nvarguscamerasrc
NvDsYamlParserStatus nvds_parse_nvarguscamerasrc(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvarguscamerasrc element from values specified in a YAML configuration file.
nvds_parse_gie_type
NvDsYamlParserStatus nvds_parse_gie_type(NvDsGieType *gie_type, gchar *cfg_file_path, const char *group)
Get the GIE type, nvinfer or invinferserver, from the YAML configuration file.
nvds_parse_file_source
NvDsYamlParserStatus nvds_parse_file_source(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a filesrc element from values specified in a YAML configuration file.
nvds_parse_source_list
NvDsYamlParserStatus nvds_parse_source_list(GList **src_list, gchar *cfg_file_path, const char *group)
Parse semicolon separated uri(s) in the source-list group and store it in a GList.
nvds_parse_streammux
NvDsYamlParserStatus nvds_parse_streammux(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvstreammux element from values specified in a YAML configuration file.
NVDS_YAML_PARSER_ERROR
@ NVDS_YAML_PARSER_ERROR
Encountered an error while setting properties.
Definition: nvds_yml_parser.h:58
nvds_parse_v4l2src
NvDsYamlParserStatus nvds_parse_v4l2src(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a v4l2src element from values specified in a YAML configuration file.
nvds_parse_multifilesrc
NvDsYamlParserStatus nvds_parse_multifilesrc(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a multifilesrc element from values specified in a YAML configuration file.
nvds_parse_3d_sink
NvDsYamlParserStatus nvds_parse_3d_sink(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nv3dsink element from values specified in a YAML configuration file.
NVDS_GIE_PLUGIN_INFER
@ NVDS_GIE_PLUGIN_INFER
Inference using nvinfer GIE.
Definition: nvds_yml_parser.h:67