NVIDIA DeepStream SDK API Reference

9.2 Release
includes/gst-nvdscustommessage.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 __GST_NVDSCUSTOMMESSAGE_H__
34 #define __GST_NVDSCUSTOMMESSAGE_H__
35 
36 #include <gst/gst.h>
37 #include "gst-nvdscommonconfig.h"
38 #include "deepstream_perf.h"
39 G_BEGIN_DECLS
50  GstMessage * gst_nvmessage_new_stream_add (GstObject * obj,
51  NvDsSensorInfo * sensor_info);
52 
60 gboolean gst_nvmessage_is_stream_add (GstMessage * message);
61 
77 gboolean gst_nvmessage_parse_stream_add (GstMessage * message,
78  NvDsSensorInfo * sensor_info);
79 
91  NvDsSensorInfo * sensor_info);
92 
100 gboolean gst_nvmessage_is_stream_remove (GstMessage * message);
101 
117 gboolean gst_nvmessage_parse_stream_remove (GstMessage * message,
118  NvDsSensorInfo * sensor_info);
119 
136 gboolean gst_nvmessage_parse_fps_stream_add (GstMessage * message,
137  NvDsFPSSensorInfo * sensor_info);
138 
155 gboolean gst_nvmessage_parse_fps_stream_remove (GstMessage * message,
156  NvDsFPSSensorInfo * sensor_info);
157 
158 /* ---- model plane (native REST /api/v1/model/load|unload|update) ---- */
159 
172 GstMessage * gst_nvmessage_new_model_load (GstObject * obj,
173  NvDsModelInfo * model_info);
174 
182 gboolean gst_nvmessage_is_model_load (GstMessage * message);
183 
196 gboolean gst_nvmessage_parse_model_load (GstMessage * message,
197  NvDsModelInfo * model_info);
198 
208 GstMessage * gst_nvmessage_new_model_unload (GstObject * obj,
209  NvDsModelInfo * model_info);
210 
218 gboolean gst_nvmessage_is_model_unload (GstMessage * message);
219 
232 gboolean gst_nvmessage_parse_model_unload (GstMessage * message,
233  NvDsModelInfo * model_info);
234 
235 /* ---- model-plane COMPLETION event (nvmodelmux -> app bus) ---- */
236 
251 GstMessage * gst_nvmessage_new_model_event (GstObject * obj,
252  NvDsModelEventInfo * info);
253 
261 gboolean gst_nvmessage_is_model_event (GstMessage * message);
262 
275 gboolean gst_nvmessage_parse_model_event (GstMessage * message,
276  NvDsModelEventInfo * info);
277 
278 /* ---- model status (native REST GET /api/v1/model/status) ---- */
279 
289 GstQuery * gst_nvquery_model_status_new (void);
290 
306 GstQuery * gst_nvquery_model_status_new_filtered (const gchar * model_name,
307  const gchar * model_version, const gchar * stream_name, gint source_id);
308 
322 gboolean gst_nvquery_model_status_parse_request (GstQuery * query,
323  const gchar ** model_name, const gchar ** model_version,
324  const gchar ** stream_name, gint * source_id);
325 
333 gboolean gst_nvquery_is_model_status (GstQuery * query);
334 
341 void gst_nvquery_model_status_set_response (GstQuery * query, const gchar * json);
342 
352 gboolean gst_nvquery_model_status_parse_response (GstQuery * query,
353  const gchar ** json);
354 
355 /* ---- stream route (native REST GET /api/v1/stream/route) ---- */
356 
363 GstQuery * gst_nvquery_stream_route_new (void);
364 
377 GstQuery * gst_nvquery_stream_route_new_filtered (const gchar * camera_id);
378 
392 gboolean gst_nvquery_stream_route_parse_request (GstQuery * query,
393  const gchar ** camera_id, gboolean * filtered);
394 
402 gboolean gst_nvquery_is_stream_route (GstQuery * query);
403 
410 void gst_nvquery_stream_route_set_response (GstQuery * query, const gchar * json);
411 
421 gboolean gst_nvquery_stream_route_parse_response (GstQuery * query,
422  const gchar ** json);
423 
424 /* ---- generic control op: SYNCHRONOUS admission query ---- */
425 
438 GstQuery * gst_nvquery_control_new (const gchar * op, const gchar * value_json);
439 
447 gboolean gst_nvquery_is_control (GstQuery * query);
448 
460 gboolean gst_nvquery_control_parse_request (GstQuery * query, const gchar ** op,
461  const gchar ** value_json);
462 
472 void gst_nvquery_control_set_response (GstQuery * query, gint http_code,
473  const gchar * err_code, const gchar * reason, const gchar * hint);
474 
489 gboolean gst_nvquery_control_parse_response (GstQuery * query, gint * http_code,
490  const gchar ** err_code, const gchar ** reason, const gchar ** hint);
491 
492 /* ---- model/update: IN-PLACE checkpoint transition ---- */
493 
505 GstMessage * gst_nvmessage_new_model_update (GstObject * obj,
506  NvDsModelInfo * model_info);
507 
515 gboolean gst_nvmessage_is_model_update (GstMessage * message);
516 
529 gboolean gst_nvmessage_parse_model_update (GstMessage * message,
530  NvDsModelInfo * model_info);
531 
532 /* ---- stream plane (native REST /api/v1/stream/route) ---- */
533 
546 GstMessage * gst_nvmessage_new_stream_route (GstObject * obj,
547  NvDsRouteInfo * route_info);
548 
556 gboolean gst_nvmessage_is_stream_route (GstMessage * message);
557 
570 gboolean gst_nvmessage_parse_stream_route (GstMessage * message,
571  NvDsRouteInfo * route_info);
572 
583  gboolean force_eos);
584 
585 
594 gboolean
595 gst_nvmessage_parse_force_pipeline_eos (GstMessage * message,
596  gboolean * force_eos);
597 
598 
606 gboolean gst_nvmessage_is_force_pipeline_eos (GstMessage * message);
607 
619  NvDsRtspAttemptsInfo *rtsp_info);
620 
629 gboolean
631  NvDsRtspAttemptsInfo *rtsp_info);
632 
640 gboolean gst_nvmessage_is_reconnect_attempt_exceeded (GstMessage * message);
641 
644 G_END_DECLS
645 #endif
gst_nvmessage_is_model_event
gboolean gst_nvmessage_is_model_event(GstMessage *message)
Determines whether a message is a model-event message.
gst_nvmessage_parse_stream_add
gboolean gst_nvmessage_parse_stream_add(GstMessage *message, NvDsSensorInfo *sensor_info)
Parses the stream ID from a stream ADD message.
gst_nvmessage_parse_fps_stream_remove
gboolean gst_nvmessage_parse_fps_stream_remove(GstMessage *message, NvDsFPSSensorInfo *sensor_info)
Parses the stream ID from a stream REMOVE message.
gst_nvmessage_parse_reconnect_attempt_exceeded
gboolean gst_nvmessage_parse_reconnect_attempt_exceeded(GstMessage *message, NvDsRtspAttemptsInfo *rtsp_info)
Parses the NvDsRtspAttemptsInfo from a attempt-exceeded message.
gst_nvmessage_new_model_event
GstMessage * gst_nvmessage_new_model_event(GstObject *obj, NvDsModelEventInfo *info)
Creates a new model-event message - denoting an asynchronous model-plane operation that has actually ...
gst_nvquery_stream_route_parse_response
gboolean gst_nvquery_stream_route_parse_response(GstQuery *query, const gchar **json)
Parses the JSON routing response from a stream-route query.
gst_nvquery_is_control
gboolean gst_nvquery_is_control(GstQuery *query)
Determines whether a query is a control-op admission query.
gst_nvquery_stream_route_new
GstQuery * gst_nvquery_stream_route_new(void)
Creates a new stream-route query - the read side of the routing plane, which the REST server sends do...
gst_nvmessage_parse_stream_remove
gboolean gst_nvmessage_parse_stream_remove(GstMessage *message, NvDsSensorInfo *sensor_info)
Parses the stream ID from a stream REMOVE message.
gst_nvquery_stream_route_new_filtered
GstQuery * gst_nvquery_stream_route_new_filtered(const gchar *camera_id)
Creates a stream-route query carrying an optional point lookup.
gst_nvquery_control_parse_request
gboolean gst_nvquery_control_parse_request(GstQuery *query, const gchar **op, const gchar **value_json)
Parses the op and value JSON from a control-op admission query.
_NvDsModelEventInfo
Definition: includes/gst-nvdscommonconfig.h:105
json
nlohmann::json json
Definition: sources/gst-plugins/gst-nvdsvideotemplate/ds-sparse4d/preprocess/calibration_parser.h:32
gst_nvmessage_is_model_unload
gboolean gst_nvmessage_is_model_unload(GstMessage *message)
Determines whether a message is a model-UNLOAD message.
gst_nvquery_stream_route_parse_request
gboolean gst_nvquery_stream_route_parse_request(GstQuery *query, const gchar **camera_id, gboolean *filtered)
Parses the request filter from a stream-route query.
gst_nvmessage_is_model_update
gboolean gst_nvmessage_is_model_update(GstMessage *message)
Determines whether a message is a model-update message.
gst_nvquery_model_status_set_response
void gst_nvquery_model_status_set_response(GstQuery *query, const gchar *json)
Sets the JSON status response on a model-status query.
gst_nvquery_model_status_parse_response
gboolean gst_nvquery_model_status_parse_response(GstQuery *query, const gchar **json)
Parses the JSON status response from a model-status query.
gst_nvmessage_parse_fps_stream_add
gboolean gst_nvmessage_parse_fps_stream_add(GstMessage *message, NvDsFPSSensorInfo *sensor_info)
Parses the stream ID from a stream ADD message.
gst_nvmessage_parse_force_pipeline_eos
gboolean gst_nvmessage_parse_force_pipeline_eos(GstMessage *message, gboolean *force_eos)
Parses the force_eos from a force eos message.
_NvDsRtspAttemptsInfo
Definition: includes/gst-nvdscommonconfig.h:115
gst_nvquery_model_status_new
GstQuery * gst_nvquery_model_status_new(void)
Creates a new empty (unfiltered) model-status query, to be sent downstream via peer_query.
NvDsFPSSensorInfo
Definition: sources/apps/common/includes/deepstream_perf.h:30
gst_nvmessage_is_stream_remove
gboolean gst_nvmessage_is_stream_remove(GstMessage *message)
Determines whether a message is a stream REMOVE message.
gst-nvdscommonconfig.h
gst_nvmessage_parse_model_update
gboolean gst_nvmessage_parse_model_update(GstMessage *message, NvDsModelInfo *model_info)
Parses the model info from a model-update message.
gst_nvmessage_new_stream_remove
GstMessage * gst_nvmessage_new_stream_remove(GstObject *obj, NvDsSensorInfo *sensor_info)
Creates a new Stream REMOVE message - denoting a new stream getting removed from nvmultiurisrcbin.
gst_nvmessage_parse_model_event
gboolean gst_nvmessage_parse_model_event(GstMessage *message, NvDsModelEventInfo *info)
Parses the event info from a model-event message.
gst_nvquery_control_parse_response
gboolean gst_nvquery_control_parse_response(GstQuery *query, gint *http_code, const gchar **err_code, const gchar **reason, const gchar **hint)
Parses the admission verdict from a control-op admission query.
gst_nvmessage_new_model_unload
GstMessage * gst_nvmessage_new_model_unload(GstObject *obj, NvDsModelInfo *model_info)
Creates a new model-UNLOAD message - denoting a model getting unloaded from nvmodelmux.
gst_nvquery_is_model_status
gboolean gst_nvquery_is_model_status(GstQuery *query)
Determines whether a query is a model-status query.
gst_nvquery_control_set_response
void gst_nvquery_control_set_response(GstQuery *query, gint http_code, const gchar *err_code, const gchar *reason, const gchar *hint)
Writes the admission verdict on a control-op admission query.
gst_nvmessage_reconnect_attempt_exceeded
GstMessage * gst_nvmessage_reconnect_attempt_exceeded(GstObject *obj, NvDsRtspAttemptsInfo *rtsp_info)
Creates a new attempt-exceeded message - denoting a reconnection attempt is exceeded for a rtsp uri.
_NvDsRouteInfo
Definition: includes/gst-nvdscommonconfig.h:149
gst_nvquery_model_status_parse_request
gboolean gst_nvquery_model_status_parse_request(GstQuery *query, const gchar **model_name, const gchar **model_version, const gchar **stream_name, gint *source_id)
Parses the request filter from a model-status query.
gst_nvmessage_new_stream_route
GstMessage * gst_nvmessage_new_stream_route(GstObject *obj, NvDsRouteInfo *route_info)
Creates a new stream-route message - the write side of the routing plane.
gst_nvquery_is_stream_route
gboolean gst_nvquery_is_stream_route(GstQuery *query)
Determines whether a query is a stream-route query.
gst_nvmessage_force_pipeline_eos
GstMessage * gst_nvmessage_force_pipeline_eos(GstObject *obj, gboolean force_eos)
Sends custom message to force-eos on the pipeline.
gst_nvquery_control_new
GstQuery * gst_nvquery_control_new(const gchar *op, const gchar *value_json)
Creates a new control-op admission query.
_NvDsSensorInfo
Definition: includes/gst-nvdscommonconfig.h:88
gst_nvquery_stream_route_set_response
void gst_nvquery_stream_route_set_response(GstQuery *query, const gchar *json)
Sets the JSON routing response on a stream-route query.
gst_nvquery_model_status_new_filtered
GstQuery * gst_nvquery_model_status_new_filtered(const gchar *model_name, const gchar *model_version, const gchar *stream_name, gint source_id)
Creates a model-status query carrying an optional request filter.
gst_nvmessage_parse_model_unload
gboolean gst_nvmessage_parse_model_unload(GstMessage *message, NvDsModelInfo *model_info)
Parses the model info from a model-UNLOAD message.
gst_nvmessage_parse_stream_route
gboolean gst_nvmessage_parse_stream_route(GstMessage *message, NvDsRouteInfo *route_info)
Parses the route info from a stream-route message.
GstObject
struct _GstObject GstObject
Definition: service-maker/includes/object.hpp:39
gst_nvmessage_new_model_update
GstMessage * gst_nvmessage_new_model_update(GstObject *obj, NvDsModelInfo *model_info)
Creates a new model-update message - denoting an in-place checkpoint transition on the model plane.
gst_nvmessage_is_stream_add
gboolean gst_nvmessage_is_stream_add(GstMessage *message)
Determines whether a message is a stream ADD message.
gst_nvmessage_is_stream_route
gboolean gst_nvmessage_is_stream_route(GstMessage *message)
Determines whether a message is a stream-route message.
gst_nvmessage_parse_model_load
gboolean gst_nvmessage_parse_model_load(GstMessage *message, NvDsModelInfo *model_info)
Parses the model info from a model-LOAD message.
gst_nvmessage_new_stream_add
G_BEGIN_DECLS GstMessage * gst_nvmessage_new_stream_add(GstObject *obj, NvDsSensorInfo *sensor_info)
Creates a new Stream ADD message - denoting a new stream getting added to nvmultiurisrcbin.
gst_nvmessage_is_force_pipeline_eos
gboolean gst_nvmessage_is_force_pipeline_eos(GstMessage *message)
Determines whether a message is a force pipeline eos message.
_NvDsModelInfo
Definition: includes/gst-nvdscommonconfig.h:135
gst_nvmessage_is_reconnect_attempt_exceeded
gboolean gst_nvmessage_is_reconnect_attempt_exceeded(GstMessage *message)
Determines whether a message is a attempt-exceeded message.
gst_nvmessage_new_model_load
GstMessage * gst_nvmessage_new_model_load(GstObject *obj, NvDsModelInfo *model_info)
Creates a new model-LOAD message - denoting a model getting loaded into nvmodelmux.
gst_nvmessage_is_model_load
gboolean gst_nvmessage_is_model_load(GstMessage *message)
Determines whether a message is a model-LOAD message.