NVIDIA DeepStream SDK API Reference
6.3 Release
nvds_yml_parser.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2022-2023, 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
53 {
55  NVDS_YAML_PARSER_SUCCESS,
57  NVDS_YAML_PARSER_DISABLED,
59  NVDS_YAML_PARSER_ERROR
60 } NvDsYamlParserStatus;
61 
65 typedef struct NvDsYamlCodecStatus
66 {
68  guint codec_type;
70  gboolean enable;
71 } NvDsYamlCodecStatus;
75 typedef enum
76 {
78  NVDS_GIE_PLUGIN_INFER = 0,
80  NVDS_GIE_PLUGIN_INFER_SERVER,
81 } NvDsGieType;
82 
92 NvDsYamlParserStatus
93 nvds_parse_file_source (GstElement * element, gchar * cfg_file_path,
94  const char *group);
95 
96 
106 NvDsYamlParserStatus
107 nvds_parse_uridecodebin (GstElement * element, gchar * cfg_file_path,
108  const char *group);
109 
110 
120 NvDsYamlParserStatus
121 nvds_parse_rtsp_source (GstElement * element, gchar * cfg_file_path,
122  const char *group);
123 
124 
134 NvDsYamlParserStatus
135 nvds_parse_nvarguscamerasrc (GstElement * element, gchar * cfg_file_path,
136  const char *group);
137 
147 NvDsYamlParserStatus
148 nvds_parse_v4l2src (GstElement * element, gchar * cfg_file_path,
149  const char *group);
150 
160 NvDsYamlParserStatus
161 nvds_parse_multifilesrc (GstElement * element, gchar * cfg_file_path,
162  const char *group);
163 
173 NvDsYamlParserStatus
174 nvds_parse_alsasrc (GstElement * element, gchar * cfg_file_path,
175  const char *group);
176 
177 
189 NvDsYamlParserStatus
190 nvds_parse_source_list (GList ** src_list, gchar * cfg_file_path,
191  const char *group);
192 
202 NvDsYamlParserStatus
203 nvds_parse_streammux (GstElement * element, gchar * cfg_file_path,
204  const char *group);
205 
215 NvDsYamlParserStatus
216 nvds_parse_tracker (GstElement * element, gchar * cfg_file_path,
217  const char *group);
218 
228 NvDsYamlParserStatus
229 nvds_parse_osd (GstElement * element, gchar * cfg_file_path,
230  const char *group);
231 
241 NvDsYamlParserStatus
242 nvds_parse_tiler (GstElement * element, gchar * cfg_file_path,
243  const char *group);
244 
254 NvDsYamlParserStatus
255 nvds_parse_msgbroker (GstElement * element, gchar * cfg_file_path,
256  const char *group);
257 
267 NvDsYamlParserStatus
268 nvds_parse_msgconv (GstElement * element, gchar * cfg_file_path,
269  const char *group);
270 
280 NvDsYamlParserStatus
281 nvds_parse_gie (GstElement * element, gchar * cfg_file_path,
282  const char *group);
283 
294 NvDsYamlParserStatus
295 nvds_parse_gie_type (NvDsGieType * gie_type, gchar * cfg_file_path,
296  const char *group);
297 
307 NvDsYamlParserStatus
308 nvds_parse_egl_sink (GstElement * element, gchar * cfg_file_path,
309  const char *group);
310 
320 NvDsYamlParserStatus
321 nvds_parse_3d_sink (GstElement * element, gchar * cfg_file_path,
322  const char *group);
323 
333 NvDsYamlParserStatus
334 nvds_parse_file_sink (GstElement * element, gchar * cfg_file_path,
335  const char *group);
336 
346 NvDsYamlParserStatus
347 nvds_parse_fake_sink (GstElement * element, gchar * cfg_file_path,
348  const char *group);
349 
358 NvDsYamlParserStatus
359 nvds_parse_codec_status (gchar * cfg_file_path, const char *group,
360  NvDsYamlCodecStatus * codec_status);
361 
371 NvDsYamlParserStatus
372 nvds_parse_nvv4l2h264enc (GstElement * element, gchar * cfg_file_path,
373  const char *group);
374 
375 
385 NvDsYamlParserStatus
386 nvds_parse_nvv4l2h265enc (GstElement * element, gchar * cfg_file_path,
387  const char *group);
388 
398 NvDsYamlParserStatus
399 nvds_parse_multiurisrcbin (GstElement * element, gchar * cfg_file_path,
400  const char *group);
401 
411 NvDsYamlParserStatus
412 nvds_parse_nvxfer(GstElement *element, gchar *cfg_file_path, const char* group);
413 
414 
424 NvDsYamlParserStatus
425 nvds_parse_nvxfer_position (gchar *cfg_file_path, const char* group, guint* position);
426 
427 #ifdef __cplusplus
428 }
429 #endif
430 
431 #endif /* _NVGSTDS_YAML_PARSER_H_ */
432 
nvds_parse_nvv4l2h265enc
NvDsYamlParserStatus nvds_parse_nvv4l2h265enc(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvv4l2h265enc element from values specified in a YAML configuration file.
NvDsYamlCodecStatus
struct NvDsYamlCodecStatus NvDsYamlCodecStatus
Enum for codec type for the API call on a encoder.
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_nvxfer_position
NvDsYamlParserStatus nvds_parse_nvxfer_position(gchar *cfg_file_path, const char *group, guint *position)
Parses nvdsxfer plugin position 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.
NvDsYamlCodecStatus::enable
gboolean enable
Enable status.
Definition: nvds_yml_parser.h:70
NVDS_GIE_PLUGIN_INFER_SERVER
@ NVDS_GIE_PLUGIN_INFER_SERVER
Inference using nvinferserver GIE.
Definition: nvds_yml_parser.h:80
nvds_parse_codec_status
NvDsYamlParserStatus nvds_parse_codec_status(gchar *cfg_file_path, const char *group, NvDsYamlCodecStatus *codec_status)
Parses codec type and enable status values specified in a YAML configuration file.
nvds_parse_nvv4l2h264enc
NvDsYamlParserStatus nvds_parse_nvv4l2h264enc(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvv4l2h264enc element from values specified in a YAML configuration file.
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:55
NvDsYamlCodecStatus
Enum for codec type for the API call on a encoder.
Definition: nvds_yml_parser.h:65
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:75
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:57
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_multiurisrcbin
NvDsYamlParserStatus nvds_parse_multiurisrcbin(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvmultiurisrcbin 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_nvxfer
NvDsYamlParserStatus nvds_parse_nvxfer(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvdsxfer 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:59
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.
NvDsYamlCodecStatus::codec_type
guint codec_type
Type codec=1 h264, codec=2 h265.
Definition: nvds_yml_parser.h:68
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:78