sources/apps/sample_apps/deepstream-app/deepstream_app.h File Reference

Go to the source code of this file.

Data Structures
struct	NvDsInstanceBin
struct	NvDsPipeline
struct	NvDsConfig
struct	NvDsInstanceData
struct	_AppCtx

Typedefs
typedef struct _AppCtx	AppCtx
typedef void(*	bbox_generated_callback) (AppCtx *appCtx, GstBuffer *buf, NvDsBatchMeta *batch_meta, guint index)
typedef gboolean(*	overlay_graphics_callback) (AppCtx *appCtx, GstBuffer *buf, NvDsBatchMeta *batch_meta, guint index)

Functions
gboolean	create_pipeline (AppCtx *appCtx, bbox_generated_callback bbox_generated_post_analytics_cb, bbox_generated_callback all_bbox_generated_cb, perf_callback perf_cb, overlay_graphics_callback overlay_graphics_cb)
	Create DS Anyalytics Pipeline per the appCtx configurations. More...
gboolean	pause_pipeline (AppCtx *appCtx)
gboolean	resume_pipeline (AppCtx *appCtx)
gboolean	seek_pipeline (AppCtx *appCtx, glong milliseconds, gboolean seek_is_relative)
void	toggle_show_bbox_text (AppCtx *appCtx)
void	destroy_pipeline (AppCtx *appCtx)
void	restart_pipeline (AppCtx *appCtx)
gboolean	parse_config_file (NvDsConfig *config, gchar *cfg_file_path)
	Function to read properties from configuration file. More...
gboolean	parse_config_file_yaml (NvDsConfig *config, gchar *cfg_file_path)
	Function to read properties from YML configuration file. More...
gboolean	msgapi_init_early (AppCtx *appCtx, const gchar *cfg_file_path)
	Generic msgapi helper functions for error propagation These work with ANY DeepStream app (test1-5, custom apps, etc.) More...
void	msgapi_report_error_and_cleanup (AppCtx *appCtx, const gchar *error_message)
	msgapi_report_error_and_cleanup: Generic error reporting function called before application exit. More...
NvDsSensorInfo *	get_sensor_info (AppCtx *appCtx, guint source_id)
	Function to procure the NvDsSensorInfo for the source_id that was added using the nvmultiurisrcbin REST API. More...

Typedef Documentation

AppCtx

typedef struct _AppCtx AppCtx

Definition at line 49 of file sources/apps/sample_apps/deepstream-app/deepstream_app.h.

bbox_generated_callback

typedef void(* bbox_generated_callback) (AppCtx *appCtx, GstBuffer *buf, NvDsBatchMeta *batch_meta, guint index)

Definition at line 51 of file sources/apps/sample_apps/deepstream-app/deepstream_app.h.

overlay_graphics_callback

typedef gboolean(* overlay_graphics_callback) (AppCtx *appCtx, GstBuffer *buf, NvDsBatchMeta *batch_meta, guint index)

Definition at line 53 of file sources/apps/sample_apps/deepstream-app/deepstream_app.h.

Function Documentation

create_pipeline()

gboolean create_pipeline	(	AppCtx *	appCtx,
		bbox_generated_callback	bbox_generated_post_analytics_cb,
		bbox_generated_callback	all_bbox_generated_cb,
		perf_callback	perf_cb,
		overlay_graphics_callback	overlay_graphics_cb
	)

Create DS Anyalytics Pipeline per the appCtx configurations.

Parameters

appCtx	[IN/OUT] The application context providing the config info and where the pipeline resources are maintained
bbox_generated_post_analytics_cb	[IN] This callback shall be triggered after analytics (PGIE, Tracker or the last SGIE appearing in the pipeline) More info: create_common_elements()
all_bbox_generated_cb	[IN]
perf_cb	[IN]
overlay_graphics_cb	[IN]

destroy_pipeline()

void destroy_pipeline

(

AppCtx *

appCtx

)

get_sensor_info()

NvDsSensorInfo* get_sensor_info	(	AppCtx *	appCtx,
		guint	source_id
	)

Function to procure the NvDsSensorInfo for the source_id that was added using the nvmultiurisrcbin REST API.

Parameters

[in]	appCtx	[IN/OUT] The application context providing the config info and where the pipeline resources are maintained
[in]	source_id	[IN] The unique source_id found in NvDsFrameMeta

Returns

[transfer-floating] The NvDsSensorInfo for the source_id that was added using the nvmultiurisrcbin REST API. Please note that the returned pointer will be valid only until the stream is removed.

msgapi_init_early()

gboolean msgapi_init_early	(	AppCtx *	appCtx,
		const gchar *	cfg_file_path
	)

Generic msgapi helper functions for error propagation These work with ANY DeepStream app (test1-5, custom apps, etc.)

msgapi_init_early: Pre-parse msgapi settings and initialize msgapi BEFORE full config parsing. This enables error reporting even if config parsing fails.

Parameters

[in]	appCtx	Application context
[in]	cfg_file_path	Configuration file path

Returns

TRUE if msgapi initialized successfully, FALSE otherwise

msgapi_report_error_and_cleanup()

void msgapi_report_error_and_cleanup	(	AppCtx *	appCtx,
		const gchar *	error_message
	)

msgapi_report_error_and_cleanup: Generic error reporting function called before application exit.

Sends error to message broker (if initialized) and cleans up resources. Call this from the done: label when return_value == -1

Parameters

[in]	appCtx	Application context
[in]	error_message	Error description (or NULL for generic message)

parse_config_file()

gboolean parse_config_file	(	NvDsConfig *	config,
		gchar *	cfg_file_path
	)

Function to read properties from configuration file.

Parameters

[in]	config	pointer to NvDsConfig
[in]	cfg_file_path	path of configuration file.

Returns

true if parsed successfully.

parse_config_file_yaml()

gboolean parse_config_file_yaml	(	NvDsConfig *	config,
		gchar *	cfg_file_path
	)

Function to read properties from YML configuration file.

Parameters

[in]	config	pointer to NvDsConfig
[in]	cfg_file_path	path of configuration file.

Returns

true if parsed successfully.

pause_pipeline()

gboolean pause_pipeline

(

AppCtx *

appCtx

)

restart_pipeline()

void restart_pipeline

(

AppCtx *

appCtx

)

resume_pipeline()

gboolean resume_pipeline

(

AppCtx *

appCtx

)

seek_pipeline()

gboolean seek_pipeline	(	AppCtx *	appCtx,
		glong	milliseconds,
		gboolean	seek_is_relative
	)

toggle_show_bbox_text()

void toggle_show_bbox_text

(

AppCtx *

appCtx

)