NVIDIA DeepStream SDK API Reference

9.1 Release
sources/includes/gst-nvquery.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: Copyright (c) 2018-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 
26 #ifndef __GST_NVQUERY_H__
27 #define __GST_NVQUERY_H__
28 
29 #include <gst/gst.h>
30 #include <gst/base/gstbasetransform.h>
31 
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35 
49 GstQuery * gst_nvquery_batch_size_new (void);
50 
58 gboolean gst_nvquery_is_batch_size (GstQuery * query);
59 
68 void gst_nvquery_batch_size_set (GstQuery * query, guint batch_size);
69 
79 gboolean gst_nvquery_batch_size_parse (GstQuery * query, guint * batch_size);
80 
87 GstQuery * gst_nvquery_numStreams_size_new (void);
88 
96 gboolean gst_nvquery_is_numStreams_size (GstQuery * query);
97 
107 void gst_nvquery_numStreams_size_set (GstQuery * query, guint numStreams_size);
108 
118 gboolean gst_nvquery_numStreams_size_parse (GstQuery * query, guint * numStreams_size);
119 
128 GstQuery * gst_nvquery_preprocess_poolsize_new (guint gieid);
129 
137 gboolean gst_nvquery_is_preprocess_poolsize (GstQuery * query);
138 
148 void gst_nvquery_preprocess_poolsize_set (GstQuery * query, guint preprocess_poolsize);
149 
159 gboolean gst_nvquery_preprocess_poolsize_parse (GstQuery * query, guint * preprocess_poolsize);
160 
170 gboolean gst_nvquery_preprocess_poolsize_gieid_parse (GstQuery * query, guint *gieId);
171 
179 gboolean gst_nvquery_is_update_caps (GstQuery * query);
180 
192 void gst_nvquery_parse_update_caps (GstQuery *query, guint *stream_index, const GValue *frame_rate);
193 
202 gboolean gst_nvquery_update_caps_peer_query (GstPad *srcpad, GstStructure *str);
203 
213 GstQuery * gst_nvquery_text_embedding_new (const gchar *text_input, const gchar *model);
214 
222 gboolean gst_nvquery_is_text_embedding (GstQuery * query);
223 
234 void gst_nvquery_text_embedding_set (GstQuery * query, const gchar *id,
235  guint64 created, const gchar *model,
236  const GValue *data);
237 
249 gboolean gst_nvquery_text_embedding_parse (GstQuery * query, const gchar **id,
250  guint64 *created, const gchar **model,
251  const GValue **data);
252 
262 gboolean gst_nvquery_text_embedding_parse_request (GstQuery * query,
263  const gchar **text_input,
264  const gchar **model);
265 
280 GstQuery * gst_nvquery_image_embedding_new (const gchar *image_path,
281  const gchar *model,
282  gboolean has_bbox,
283  gdouble bbox_left,
284  gdouble bbox_top,
285  gdouble bbox_width,
286  gdouble bbox_height);
287 
295 gboolean gst_nvquery_is_image_embedding (GstQuery * query);
296 
307 void gst_nvquery_image_embedding_set (GstQuery * query, const gchar *id,
308  guint64 created, const gchar *model,
309  const GValue *data);
310 
322 gboolean gst_nvquery_image_embedding_parse (GstQuery * query, const gchar **id,
323  guint64 *created, const gchar **model,
324  const GValue **data);
325 
340 gboolean gst_nvquery_image_embedding_parse_request (GstQuery * query,
341  const gchar **image_path,
342  const gchar **model,
343  gboolean *has_bbox,
344  gdouble *bbox_left,
345  gdouble *bbox_top,
346  gdouble *bbox_width,
347  gdouble *bbox_height);
348 
351 #ifdef __cplusplus
352 }
353 #endif
354 
355 #endif
gst_nvquery_parse_update_caps
void gst_nvquery_parse_update_caps(GstQuery *query, guint *stream_index, const GValue *frame_rate)
Parses the update_caps query.
gst_nvquery_numStreams_size_new
GstQuery * gst_nvquery_numStreams_size_new(void)
Creates a number of streams query, used by elements to query upstream the number of input sources.
gst_nvquery_image_embedding_new
GstQuery * gst_nvquery_image_embedding_new(const gchar *image_path, const gchar *model, gboolean has_bbox, gdouble bbox_left, gdouble bbox_top, gdouble bbox_width, gdouble bbox_height)
Creates a new image embedding query, which can be used to request image embedding generation from the...
gst_nvquery_numStreams_size_parse
gboolean gst_nvquery_numStreams_size_parse(GstQuery *query, guint *numStreams_size)
Parses the number of streams from a number of streams query.
gst_nvquery_preprocess_poolsize_new
GstQuery * gst_nvquery_preprocess_poolsize_new(guint gieid)
Creates a preprocess poolsize query, used by elements to query preprocess element for the size of buf...
gst_nvquery_preprocess_poolsize_set
void gst_nvquery_preprocess_poolsize_set(GstQuery *query, guint preprocess_poolsize)
Sets the preprocess poolsize as a reponse to query.
gst_nvquery_batch_size_parse
gboolean gst_nvquery_batch_size_parse(GstQuery *query, guint *batch_size)
Parses batch size from a batch size query.
gst_nvquery_is_numStreams_size
gboolean gst_nvquery_is_numStreams_size(GstQuery *query)
Determines whether a query is a number-of-streams query.
gst_nvquery_is_batch_size
gboolean gst_nvquery_is_batch_size(GstQuery *query)
Determines whether a query is a batch size query.
gst_nvquery_text_embedding_new
GstQuery * gst_nvquery_text_embedding_new(const gchar *text_input, const gchar *model)
Creates a new text embedding query, which can be used to request text embedding information from the ...
gst_nvquery_image_embedding_parse
gboolean gst_nvquery_image_embedding_parse(GstQuery *query, const gchar **id, guint64 *created, const gchar **model, const GValue **data)
Parses the image embedding response from an image embedding query.
gst_nvquery_is_text_embedding
gboolean gst_nvquery_is_text_embedding(GstQuery *query)
Determines whether a query is a text embedding query.
gst_nvquery_batch_size_new
GstQuery * gst_nvquery_batch_size_new(void)
Creates a new batch-size query, which can be used by elements to query the number of buffers in upstr...
gst_nvquery_image_embedding_set
void gst_nvquery_image_embedding_set(GstQuery *query, const gchar *id, guint64 created, const gchar *model, const GValue *data)
Sets the image embedding response data, used by elements responding to the image embedding query.
gst_nvquery_batch_size_set
void gst_nvquery_batch_size_set(GstQuery *query, guint batch_size)
Sets the batch size, used by the elements responding to the batch size query.
gst_nvquery_preprocess_poolsize_parse
gboolean gst_nvquery_preprocess_poolsize_parse(GstQuery *query, guint *preprocess_poolsize)
Parses the preprocess poolsize from a preprocess poolsize query.
gst_nvquery_is_preprocess_poolsize
gboolean gst_nvquery_is_preprocess_poolsize(GstQuery *query)
Determines whether a query is a preprocess poolsize query.
GValue
struct _GValue GValue
Definition: service-maker/includes/object.hpp:38
gst_nvquery_text_embedding_parse
gboolean gst_nvquery_text_embedding_parse(GstQuery *query, const gchar **id, guint64 *created, const gchar **model, const GValue **data)
Parses the text embedding response from a text embedding query.
gst_nvquery_numStreams_size_set
void gst_nvquery_numStreams_size_set(GstQuery *query, guint numStreams_size)
Sets the number of input sources.
gst_nvquery_is_update_caps
gboolean gst_nvquery_is_update_caps(GstQuery *query)
Checks if a query is update_caps query.
gst_nvquery_image_embedding_parse_request
gboolean gst_nvquery_image_embedding_parse_request(GstQuery *query, const gchar **image_path, const gchar **model, gboolean *has_bbox, gdouble *bbox_left, gdouble *bbox_top, gdouble *bbox_width, gdouble *bbox_height)
Parses the image embedding request parameters from an image embedding query.
gst_nvquery_is_image_embedding
gboolean gst_nvquery_is_image_embedding(GstQuery *query)
Determines whether a query is an image embedding query.
gst_nvquery_text_embedding_set
void gst_nvquery_text_embedding_set(GstQuery *query, const gchar *id, guint64 created, const gchar *model, const GValue *data)
Sets the text embedding response data, used by elements responding to the text embedding query.
gst_nvquery_preprocess_poolsize_gieid_parse
gboolean gst_nvquery_preprocess_poolsize_gieid_parse(GstQuery *query, guint *gieId)
Parses the preprocess gie id from a preprocess poolsize query.
gst_nvquery_update_caps_peer_query
gboolean gst_nvquery_update_caps_peer_query(GstPad *srcpad, GstStructure *str)
Heterogeneous batching query for new streammux.
gst_nvquery_text_embedding_parse_request
gboolean gst_nvquery_text_embedding_parse_request(GstQuery *query, const gchar **text_input, const gchar **model)
Parses the text embedding request parameters from a text embedding query.