NVIDIA DeepStream SDK API Reference
9.1 Release
sources/includes/nvds_yml_parser.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2022-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
33 #ifndef _NVGSTDS_YAML_PARSER_H_
34 #define _NVGSTDS_YAML_PARSER_H_
35 
36 #include <gst/gst.h>
37 
38 #ifdef __cplusplus
39 extern "C"
40 {
41 #endif
42 
46 typedef enum NvDsYamlParserStatus
47 {
49  NVDS_YAML_PARSER_SUCCESS,
51  NVDS_YAML_PARSER_DISABLED,
53  NVDS_YAML_PARSER_ERROR
54 } NvDsYamlParserStatus;
55 
59 typedef struct NvDsYamlCodecStatus
60 {
62  guint codec_type;
64  gboolean enable;
65 } NvDsYamlCodecStatus;
69 typedef enum
70 {
72  NVDS_GIE_PLUGIN_INFER = 0,
74  NVDS_GIE_PLUGIN_INFER_SERVER,
75 } NvDsGieType;
76 
86 NvDsYamlParserStatus
87 nvds_parse_file_source (GstElement * element, gchar * cfg_file_path,
88  const char *group);
89 
90 
100 NvDsYamlParserStatus
101 nvds_parse_uridecodebin (GstElement * element, gchar * cfg_file_path,
102  const char *group);
103 
104 
114 NvDsYamlParserStatus
115 nvds_parse_rtsp_source (GstElement * element, gchar * cfg_file_path,
116  const char *group);
117 
118 
128 NvDsYamlParserStatus
129 nvds_parse_nvarguscamerasrc (GstElement * element, gchar * cfg_file_path,
130  const char *group);
131 
141 NvDsYamlParserStatus
142 nvds_parse_v4l2src (GstElement * element, gchar * cfg_file_path,
143  const char *group);
144 
154 NvDsYamlParserStatus
155 nvds_parse_multifilesrc (GstElement * element, gchar * cfg_file_path,
156  const char *group);
157 
167 NvDsYamlParserStatus
168 nvds_parse_alsasrc (GstElement * element, gchar * cfg_file_path,
169  const char *group);
170 
171 
183 NvDsYamlParserStatus
184 nvds_parse_source_list (GList ** src_list, gchar * cfg_file_path,
185  const char *group);
186 
196 NvDsYamlParserStatus
197 nvds_parse_streammux (GstElement * element, gchar * cfg_file_path,
198  const char *group);
199 
209 NvDsYamlParserStatus
210 nvds_parse_tracker (GstElement * element, gchar * cfg_file_path,
211  const char *group);
212 
222 NvDsYamlParserStatus
223 nvds_parse_osd (GstElement * element, gchar * cfg_file_path,
224  const char *group);
225 
235 NvDsYamlParserStatus
236 nvds_parse_tiler (GstElement * element, gchar * cfg_file_path,
237  const char *group);
238 
248 NvDsYamlParserStatus
249 nvds_parse_msgbroker (GstElement * element, gchar * cfg_file_path,
250  const char *group);
251 
261 NvDsYamlParserStatus
262 nvds_parse_msgconv (GstElement * element, gchar * cfg_file_path,
263  const char *group);
264 
274 NvDsYamlParserStatus
275 nvds_parse_gie (GstElement * element, gchar * cfg_file_path,
276  const char *group);
277 
288 NvDsYamlParserStatus
289 nvds_parse_gie_type (NvDsGieType * gie_type, gchar * cfg_file_path,
290  const char *group);
291 
301 NvDsYamlParserStatus
302 nvds_parse_egl_sink (GstElement * element, gchar * cfg_file_path,
303  const char *group);
304 
314 NvDsYamlParserStatus
315 nvds_parse_3d_sink (GstElement * element, gchar * cfg_file_path,
316  const char *group);
317 
327 NvDsYamlParserStatus
328 nvds_parse_file_sink (GstElement * element, gchar * cfg_file_path,
329  const char *group);
330 
340 NvDsYamlParserStatus
341 nvds_parse_fake_sink (GstElement * element, gchar * cfg_file_path,
342  const char *group);
343 
352 NvDsYamlParserStatus
353 nvds_parse_codec_status (gchar * cfg_file_path, const char *group,
354  NvDsYamlCodecStatus * codec_status);
355 
365 NvDsYamlParserStatus
366 nvds_parse_nvv4l2h264enc (GstElement * element, gchar * cfg_file_path,
367  const char *group);
368 
369 
379 NvDsYamlParserStatus
380 nvds_parse_nvv4l2h265enc (GstElement * element, gchar * cfg_file_path,
381  const char *group);
382 
392 NvDsYamlParserStatus
393 nvds_parse_multiurisrcbin (GstElement * element, gchar * cfg_file_path,
394  const char *group);
395 
405 NvDsYamlParserStatus
406 nvds_parse_nvxfer(GstElement *element, gchar *cfg_file_path, const char* group);
407 
408 
418 NvDsYamlParserStatus
419 nvds_parse_nvxfer_position (gchar *cfg_file_path, const char* group, guint* position);
420 
430 NvDsYamlParserStatus
431 nvds_parse_nvdsanalytics(GstElement *element, gchar *cfg_file_path, const char* group);
432 
441 gboolean
442 check_enable_status (gchar * cfg_file_path, const char* group);
443 
444 #ifdef __cplusplus
445 }
446 #endif
447 
448 #endif /* _NVGSTDS_YAML_PARSER_H_ */
449 
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: sources/includes/nvds_yml_parser.h:64
NVDS_GIE_PLUGIN_INFER_SERVER
@ NVDS_GIE_PLUGIN_INFER_SERVER
Inference using nvinferserver GIE.
Definition: sources/includes/nvds_yml_parser.h:74
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.
check_enable_status
gboolean check_enable_status(gchar *cfg_file_path, const char *group)
Function definition to check if the rest server is enabled in the YAML config 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: sources/includes/nvds_yml_parser.h:49
NvDsYamlCodecStatus
Enum for codec type for the API call on a encoder.
Definition: sources/includes/nvds_yml_parser.h:59
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: sources/includes/nvds_yml_parser.h:69
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: sources/includes/nvds_yml_parser.h:46
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: sources/includes/nvds_yml_parser.h:51
nvds_parse_nvdsanalytics
NvDsYamlParserStatus nvds_parse_nvdsanalytics(GstElement *element, gchar *cfg_file_path, const char *group)
Set properties of a nvdsanalytics element from values specified in a YAML configuration file.
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: sources/includes/nvds_yml_parser.h:53
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: sources/includes/nvds_yml_parser.h:62
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: sources/includes/nvds_yml_parser.h:72