NVIDIA DeepStream SDK API Reference
7.0 Release
nvds_yml_parser.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
4  *
5  * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
6  * property and proprietary rights in and to this material, related
7  * documentation and any modifications thereto. Any use, reproduction,
8  * disclosure or distribution of this material and related documentation
9  * without an express license agreement from NVIDIA CORPORATION or
10  * its affiliates is strictly prohibited.
11  */
12 
28 #ifndef _NVGSTDS_YAML_PARSER_H_
29 #define _NVGSTDS_YAML_PARSER_H_
30 
31 #include <gst/gst.h>
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
41 typedef enum NvDsYamlParserStatus
42 {
44  NVDS_YAML_PARSER_SUCCESS,
46  NVDS_YAML_PARSER_DISABLED,
48  NVDS_YAML_PARSER_ERROR
49 } NvDsYamlParserStatus;
50 
54 typedef struct NvDsYamlCodecStatus
55 {
57  guint codec_type;
59  gboolean enable;
60 } NvDsYamlCodecStatus;
64 typedef enum
65 {
67  NVDS_GIE_PLUGIN_INFER = 0,
69  NVDS_GIE_PLUGIN_INFER_SERVER,
70 } NvDsGieType;
71 
81 NvDsYamlParserStatus
82 nvds_parse_file_source (GstElement * element, gchar * cfg_file_path,
83  const char *group);
84 
85 
95 NvDsYamlParserStatus
96 nvds_parse_uridecodebin (GstElement * element, gchar * cfg_file_path,
97  const char *group);
98 
99 
109 NvDsYamlParserStatus
110 nvds_parse_rtsp_source (GstElement * element, gchar * cfg_file_path,
111  const char *group);
112 
113 
123 NvDsYamlParserStatus
124 nvds_parse_nvarguscamerasrc (GstElement * element, gchar * cfg_file_path,
125  const char *group);
126 
136 NvDsYamlParserStatus
137 nvds_parse_v4l2src (GstElement * element, gchar * cfg_file_path,
138  const char *group);
139 
149 NvDsYamlParserStatus
150 nvds_parse_multifilesrc (GstElement * element, gchar * cfg_file_path,
151  const char *group);
152 
162 NvDsYamlParserStatus
163 nvds_parse_alsasrc (GstElement * element, gchar * cfg_file_path,
164  const char *group);
165 
166 
178 NvDsYamlParserStatus
179 nvds_parse_source_list (GList ** src_list, gchar * cfg_file_path,
180  const char *group);
181 
191 NvDsYamlParserStatus
192 nvds_parse_streammux (GstElement * element, gchar * cfg_file_path,
193  const char *group);
194 
204 NvDsYamlParserStatus
205 nvds_parse_tracker (GstElement * element, gchar * cfg_file_path,
206  const char *group);
207 
217 NvDsYamlParserStatus
218 nvds_parse_osd (GstElement * element, gchar * cfg_file_path,
219  const char *group);
220 
230 NvDsYamlParserStatus
231 nvds_parse_tiler (GstElement * element, gchar * cfg_file_path,
232  const char *group);
233 
243 NvDsYamlParserStatus
244 nvds_parse_msgbroker (GstElement * element, gchar * cfg_file_path,
245  const char *group);
246 
256 NvDsYamlParserStatus
257 nvds_parse_msgconv (GstElement * element, gchar * cfg_file_path,
258  const char *group);
259 
269 NvDsYamlParserStatus
270 nvds_parse_gie (GstElement * element, gchar * cfg_file_path,
271  const char *group);
272 
283 NvDsYamlParserStatus
284 nvds_parse_gie_type (NvDsGieType * gie_type, gchar * cfg_file_path,
285  const char *group);
286 
296 NvDsYamlParserStatus
297 nvds_parse_egl_sink (GstElement * element, gchar * cfg_file_path,
298  const char *group);
299 
309 NvDsYamlParserStatus
310 nvds_parse_3d_sink (GstElement * element, gchar * cfg_file_path,
311  const char *group);
312 
322 NvDsYamlParserStatus
323 nvds_parse_file_sink (GstElement * element, gchar * cfg_file_path,
324  const char *group);
325 
335 NvDsYamlParserStatus
336 nvds_parse_fake_sink (GstElement * element, gchar * cfg_file_path,
337  const char *group);
338 
347 NvDsYamlParserStatus
348 nvds_parse_codec_status (gchar * cfg_file_path, const char *group,
349  NvDsYamlCodecStatus * codec_status);
350 
360 NvDsYamlParserStatus
361 nvds_parse_nvv4l2h264enc (GstElement * element, gchar * cfg_file_path,
362  const char *group);
363 
364 
374 NvDsYamlParserStatus
375 nvds_parse_nvv4l2h265enc (GstElement * element, gchar * cfg_file_path,
376  const char *group);
377 
387 NvDsYamlParserStatus
388 nvds_parse_multiurisrcbin (GstElement * element, gchar * cfg_file_path,
389  const char *group);
390 
400 NvDsYamlParserStatus
401 nvds_parse_nvxfer(GstElement *element, gchar *cfg_file_path, const char* group);
402 
403 
413 NvDsYamlParserStatus
414 nvds_parse_nvxfer_position (gchar *cfg_file_path, const char* group, guint* position);
415 
416 #ifdef __cplusplus
417 }
418 #endif
419 
420 #endif /* _NVGSTDS_YAML_PARSER_H_ */
421 
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:59
NVDS_GIE_PLUGIN_INFER_SERVER
@ NVDS_GIE_PLUGIN_INFER_SERVER
Inference using nvinferserver GIE.
Definition: nvds_yml_parser.h:69
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:44
NvDsYamlCodecStatus
Enum for codec type for the API call on a encoder.
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:41
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:46
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:48
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:57
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