NVIDIA DeepStream SDK API Reference

8.0 Release
deepstream_config_file_parser.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-2025 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 
13 #ifndef __NVGSTDS_CONFIG_PARSER_H__
14 #define __NVGSTDS_CONFIG_PARSER_H__
15 
16 #include <gst/gst.h>
17 
18 #ifdef __cplusplus
19 extern "C"
20 {
21 #endif
22 
23 #include "deepstream_config.h"
24 #include "deepstream_sources.h"
25 #include "deepstream_preprocess.h"
26 #include "deepstream_primary_gie.h"
29 #include "deepstream_gie.h"
30 #include "deepstream_sinks.h"
31 #include "deepstream_osd.h"
32 #include "deepstream_segvisual.h"
33 #include "deepstream_sources.h"
34 #include "deepstream_dsanalytics.h"
35 #include "deepstream_dsexample.h"
36 #include "deepstream_streammux.h"
37 #include "deepstream_tracker.h"
38 #include "deepstream_dewarper.h"
39 #include "deepstream_c2d_msg.h"
40 #include "deepstream_image_save.h"
41 
42 #define CONFIG_GROUP_SOURCE_LIST "source-list"
43 #define CONFIG_GROUP_SOURCE_LIST_NUM_SOURCE_BINS "num-source-bins"
44 #define CONFIG_GROUP_SOURCE_LIST_URI_LIST "list"
45 
46 #define CONFIG_GROUP_SOURCE_LIST_SENSOR_ID_LIST "sensor-id-list"
47 #define CONFIG_GROUP_SOURCE_LIST_SENSOR_NAME_LIST "sensor-name-list"
48 
50 #define CONFIG_GROUP_SOURCE_LIST_USE_NVMULTIURISRCBIN "use-nvmultiurisrcbin"
51 #define CONFIG_GROUP_SOURCE_LIST_DUMMY_PAYLOAD "dummy-payload"
52 #define CONFIG_GROUP_SOURCE_LIST_CUSTOM_TS_TO_RFC "custom-ts-to-rfc"
53 #define CONFIG_GROUP_SOURCE_LIST_BATCHED_SENSOR_NAME "batched-sensor-name"
54 #define CONFIG_GROUP_SOURCE_LIST_STREAM_NAME_DISPLAY "stream-name-display"
55 #define CONFIG_GROUP_SOURCE_LIST_MAX_BATCH_SIZE "max-batch-size"
56 #define CONFIG_GROUP_SOURCE_LIST_HTTP_IP "http-ip"
57 #define CONFIG_GROUP_SOURCE_LIST_HTTP_PORT "http-port"
58 #define CONFIG_GROUP_SOURCE_EXTRACT_SEI_TYPE5_DATA "extract-sei-type5-data"
59 #define CONFIG_GROUP_SOURCE_SEI_UUID "sei-uuid"
60 #define CONFIG_GROUP_SOURCE_LIST_LOW_LATENCY_MODE "low-latency-mode"
61 
62 #define CONFIG_GROUP_SOURCE_ALL "source-attr-all"
63 
64 #define CONFIG_GROUP_SOURCE "source"
65 #define CONFIG_GROUP_OSD "osd"
66 #define CONFIG_GROUP_SEGVISUAL "segvisual"
67 #define CONFIG_GROUP_PREPROCESS "pre-process"
68 #define CONFIG_GROUP_SECONDARY_PREPROCESS "secondary-pre-process"
69 #define CONFIG_GROUP_PRIMARY_GIE "primary-gie"
70 #define CONFIG_GROUP_SECONDARY_GIE "secondary-gie"
71 #define CONFIG_GROUP_TRACKER "tracker"
72 #define CONFIG_GROUP_SINK "sink"
73 #define CONFIG_GROUP_TILED_DISPLAY "tiled-display"
74 #define CONFIG_GROUP_DSANALYTICS "nvds-analytics"
75 #define CONFIG_GROUP_DSEXAMPLE "ds-example"
76 #define CONFIG_GROUP_STREAMMUX "streammux"
77 #define CONFIG_GROUP_DEWARPER "dewarper"
78 #define CONFIG_GROUP_MSG_CONVERTER "message-converter"
79 #define CONFIG_GROUP_MSG_CONSUMER "message-consumer"
80 #define CONFIG_GROUP_IMG_SAVE "img-save"
81 #define CONFIG_GROUP_AUDIO_TRANSFORM "audio-transform"
82 #define CONFIG_GROUP_AUDIO_CLASSIFIER "audio-classifier"
83 
84 #define CONFIG_GROUP_SOURCE_GPU_ID "gpu-id"
85 #define CONFIG_GROUP_SOURCE_TYPE "type"
86 #define CONFIG_GROUP_SOURCE_CUDA_MEM_TYPE "nvbuf-memory-type"
87 #define CONFIG_GROUP_SOURCE_CAMERA_WIDTH "camera-width"
88 #define CONFIG_GROUP_SOURCE_CAMERA_HEIGHT "camera-height"
89 #define CONFIG_GROUP_SOURCE_CAMERA_FPS_N "camera-fps-n"
90 #define CONFIG_GROUP_SOURCE_CAMERA_FPS_D "camera-fps-d"
91 #define CONFIG_GROUP_SOURCE_CAMERA_CSI_SID "camera-csi-sensor-id"
92 #define CONFIG_GROUP_SOURCE_CAMERA_V4L2_DEVNODE "camera-v4l2-dev-node"
93 #define CONFIG_GROUP_SOURCE_URI "uri"
94 #define CONFIG_GROUP_SOURCE_LIVE_SOURCE "live-source"
95 #define CONFIG_GROUP_SOURCE_FILE_LOOP "file-loop"
96 #define CONFIG_GROUP_SOURCE_LATENCY "latency"
97 #define CONFIG_GROUP_SOURCE_NUM_SOURCES "num-sources"
98 #define CONFIG_GROUP_SOURCE_INTRA_DECODE "intra-decode-enable"
99 #define CONFIG_GROUP_SOURCE_DEC_SKIP_FRAMES "dec-skip-frames"
100 #define CONFIG_GROUP_SOURCE_NUM_DECODE_SURFACES "num-decode-surfaces"
101 #define CONFIG_GROUP_SOURCE_NUM_EXTRA_SURFACES "num-extra-surfaces"
102 #define CONFIG_GROUP_SOURCE_DROP_FRAME_INTERVAL "drop-frame-interval"
103 #define CONFIG_GROUP_SOURCE_DROP_ON_LATENCY "drop-on-latency"
104 #define CONFIG_GROUP_SOURCE_CAMERA_ID "camera-id"
105 #define CONFIG_GROUP_SOURCE_ID "source-id"
106 #define CONFIG_GROUP_SOURCE_SELECT_RTP_PROTOCOL "select-rtp-protocol"
107 #define CONFIG_GROUP_SOURCE_LEAKY "leaky"
108 #define CONFIG_GROUP_SOURCE_MAX_SIZE_BUFFERS "max-size-buffers"
109 #define CONFIG_GROUP_SOURCE_RTSP_RECONNECT_INTERVAL_SEC "rtsp-reconnect-interval-sec"
110 #define CONFIG_GROUP_SOURCE_RTSP_RECONNECT_ATTEMPTS "rtsp-reconnect-attempts"
111 #define CONFIG_GROUP_SOURCE_RTSP_INIT_RECONNECT_INTERVAL_SEC "init-rtsp-reconnect-interval-sec"
112 #define CONFIG_GROUP_SOURCE_RTSP_BUFFER_MODE "buffer-mode"
113 #define CONFIG_GROUP_SOURCE_SMART_RECORD_ENABLE "smart-record"
114 #define CONFIG_GROUP_SOURCE_SMART_RECORD_DIRPATH "smart-rec-dir-path"
115 #define CONFIG_GROUP_SOURCE_SMART_RECORD_FILE_PREFIX "smart-rec-file-prefix"
116 #define CONFIG_GROUP_SOURCE_SMART_RECORD_CACHE_SIZE_LEGACY "smart-rec-video-cache"
117 #define CONFIG_GROUP_SOURCE_SMART_RECORD_CACHE_SIZE "smart-rec-cache"
118 #define CONFIG_GROUP_SOURCE_SMART_RECORD_CONTAINER "smart-rec-container"
119 #define CONFIG_GROUP_SOURCE_SMART_RECORD_START_TIME "smart-rec-start-time"
120 #define CONFIG_GROUP_SOURCE_SMART_RECORD_DEFAULT_DURATION "smart-rec-default-duration"
121 #define CONFIG_GROUP_SOURCE_SMART_RECORD_DURATION "smart-rec-duration"
122 #define CONFIG_GROUP_SOURCE_SMART_RECORD_INTERVAL "smart-rec-interval"
123 
132 gboolean
134 
145 gboolean
146 parse_dewarper (NvDsDewarperConfig * config, GKeyFile * key_file, gchar *cfg_file_path, gchar * group);
147 
158 gboolean
159 parse_source (NvDsSourceConfig * config, GKeyFile * key_file,
160  gchar * group, gchar * cfg_file_path);
161 
170 gboolean parse_segvisual (NvDsSegVisualConfig * config, GKeyFile * key_file);
171 
180 gboolean parse_osd (NvDsOSDConfig * config, GKeyFile * key_file);
181 
193 gboolean
194 parse_preprocess (NvDsPreProcessConfig * config, GKeyFile * key_file,
195  gchar * group, gchar * cfg_file_path);
196 
208 gboolean
209 parse_gie (NvDsGieConfig * config, GKeyFile * key_file, gchar * group,
210  gchar * cfg_file_path);
211 
221 gboolean
222 parse_tracker (NvDsTrackerConfig * config, GKeyFile * key_file, gchar * cfg_file_path);
223 
233 gboolean
234 parse_sink (NvDsSinkSubBinConfig * config, GKeyFile * key_file, gchar * group, gchar * cfg_file_path);
235 
244 gboolean
245 parse_tiled_display (NvDsTiledDisplayConfig * config, GKeyFile * key_file);
246 
255 gboolean
256 parse_dsanalytics (NvDsDsAnalyticsConfig * config, GKeyFile * key_file, gchar* cfg_file_path);
257 
266 gboolean
267 parse_dsexample (NvDsDsExampleConfig * config, GKeyFile * key_file);
268 
278 gboolean
279 parse_streammux (NvDsStreammuxConfig * config, GKeyFile * key_file, gchar * cfg_file_path);
280 
291 gboolean
292 parse_msgconv (NvDsSinkMsgConvBrokerConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path);
293 
304 gboolean
305 parse_msgconsumer (NvDsMsgConsumerConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path);
306 
317 gboolean
318 parse_image_save (NvDsImageSave *config, GKeyFile *key_file,
319  gchar *group, gchar *cfg_file_path);
320 
328 gchar *
329 get_absolute_file_path (gchar *cfg_file_path, gchar * file_path);
330 
331 #ifdef __cplusplus
332 }
333 #endif
334 
335 #endif
parse_segvisual
gboolean parse_segvisual(NvDsSegVisualConfig *config, GKeyFile *key_file)
Function to read properties of NvSegVisual element from configuration file.
parse_dewarper
gboolean parse_dewarper(NvDsDewarperConfig *config, GKeyFile *key_file, gchar *cfg_file_path, gchar *group)
Function to read properties of source element from configuration file.
deepstream_tracker.h
deepstream_streammux.h
NvDsPreProcessConfig
Definition: deepstream_preprocess.h:23
deepstream_dsexample.h
deepstream_dewarper.h
parse_tiled_display
gboolean parse_tiled_display(NvDsTiledDisplayConfig *config, GKeyFile *key_file)
Function to read properties of tiler element from configuration file.
parse_tracker
gboolean parse_tracker(NvDsTrackerConfig *config, GKeyFile *key_file, gchar *cfg_file_path)
Function to read properties of tracker element from configuration file.
NvDsSinkSubBinConfig
Definition: deepstream_sinks.h:131
parse_dsanalytics
gboolean parse_dsanalytics(NvDsDsAnalyticsConfig *config, GKeyFile *key_file, gchar *cfg_file_path)
Function to read properties of dsanalytics element from configuration file.
NvDsImageSave
Definition: deepstream_image_save.h:21
NvDsSegVisualConfig
Definition: deepstream_segvisual.h:33
deepstream_image_save.h
NvDsDsExampleConfig
Definition: deepstream_dsexample.h:23
deepstream_config.h
NvDsSinkMsgConvBrokerConfig
Definition: deepstream_sinks.h:105
parse_preprocess
gboolean parse_preprocess(NvDsPreProcessConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of nvdspreprocess element from configuration file.
parse_labels_file
gboolean parse_labels_file(NvDsGieConfig *config)
Function to parse class label file.
parse_source
gboolean parse_source(NvDsSourceConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of source element from configuration file.
deepstream_sinks.h
parse_image_save
gboolean parse_image_save(NvDsImageSave *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of image save from configuration file.
parse_gie
gboolean parse_gie(NvDsGieConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of infer element from configuration file.
deepstream_primary_gie.h
NvDsDsAnalyticsConfig
Definition: deepstream_dsanalytics.h:23
parse_msgconv
gboolean parse_msgconv(NvDsSinkMsgConvBrokerConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of message converter element from configuration file.
deepstream_osd.h
NvDsSourceConfig
Definition: deepstream_sources.h:38
deepstream_audio_classifier.h
deepstream_c2d_msg.h
NvDsTiledDisplayConfig
Definition: deepstream_tiled_display.h:44
parse_msgconsumer
gboolean parse_msgconsumer(NvDsMsgConsumerConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of message consumer element from configuration file.
deepstream_gie.h
deepstream_sources.h
NvDsStreammuxConfig
Definition: deepstream_streammux.h:23
parse_sink
gboolean parse_sink(NvDsSinkSubBinConfig *config, GKeyFile *key_file, gchar *group, gchar *cfg_file_path)
Function to read properties of sink element from configuration file.
NvDsGieConfig
Definition: deepstream_gie.h:34
parse_streammux
gboolean parse_streammux(NvDsStreammuxConfig *config, GKeyFile *key_file, gchar *cfg_file_path)
Function to read properties of streammux element from configuration file.
deepstream_preprocess.h
parse_dsexample
gboolean parse_dsexample(NvDsDsExampleConfig *config, GKeyFile *key_file)
Function to read properties of dsexample element from configuration file.
get_absolute_file_path
gchar * get_absolute_file_path(gchar *cfg_file_path, gchar *file_path)
Utility function to convert relative path in configuration file with absolute path.
deepstream_segvisual.h
parse_osd
gboolean parse_osd(NvDsOSDConfig *config, GKeyFile *key_file)
Function to read properties of OSD element from configuration file.
NvDsTrackerConfig
Definition: deepstream_tracker.h:25
NvDsMsgConsumerConfig
Definition: deepstream_c2d_msg.h:36
deepstream_dsanalytics.h
deepstream_tiled_display.h
NvDsOSDConfig
Definition: deepstream_osd.h:35
NvDsDewarperConfig
Definition: deepstream_dewarper.h:35