sources/gst-plugins/gst-nvmodelmux/gstnvmodelmux.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: Apache-2.0
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __GST_NVMODELMUX_H__
#define __GST_NVMODELMUX_H__
 
#include <gst/gst.h>
#include "gstnvmodelmux_priv.h"   /* ModelMuxConfig, ModelMuxBin, bin API */
 
G_BEGIN_DECLS
 
#define GST_TYPE_NVMODELMUX (gst_modelmux_get_type ())
#define GST_NVMODELMUX(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_NVMODELMUX, GstNvModelMux))
#define GST_NVMODELMUX_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_NVMODELMUX, GstNvModelMuxClass))
#define GST_IS_NVMODELMUX(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_NVMODELMUX))
#define GST_IS_NVMODELMUX_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_NVMODELMUX))
 
typedef struct _GstNvModelMux GstNvModelMux;
typedef struct _GstNvModelMuxClass GstNvModelMuxClass;
 
/* GObject property ids. Public (in the header, nvinfer convention) so the config
 * parser can consult is_prop_set[] -- an explicitly-set property OVERRIDES the
 * config-file value. Keep PROP_LAST last: it sizes is_prop_set[]. */
enum
{
  PROP_0,
  PROP_ENABLE,
  PROP_CONFIG_FILE_PATH,
  PROP_BATCH_SIZE,
  PROP_PER_MODEL_BATCH_SIZE,
  PROP_UNIFIED_BATCH,
  PROP_PRIMARY_MODEL,
  PROP_SHADOW_MODEL,
  PROP_COMPACT_IDLE_MODELS_ACROSS_POOLS,
  PROP_MODEL_SHARDING,
  PROP_PROCESS_MODE,
  PROP_LAST
};
 
struct _GstNvModelMux
{
  GstBin parent;        
  ModelMuxBin *modelmux_bin;
 
  ModelMuxSgieBin *modelmux_sgie_bin;
 
  GstElement *passthru;
 
  ModelMuxRevShared *rev_shared;
 
  GstPad *sinkpad;
  GstPad *srcpad;
 
  gboolean built;
 
  gboolean initial_default_load_started;
 
  gulong sink_event_probe_id;
  gulong sink_probe_id;
  gulong sink_status_query_id;
  gulong sink_control_query_id;
 
  GMutex api_control_lock;
 
  GMutex source_state_lock;
  GHashTable *source_attach_state;
  GHashTable *requested_binding_info;
  guint64 batch_idx;
 
  GstBus *bus;
  gulong bus_sync_id;
  GList *pending_reroutes;
  guint pending_poll_id;
 
 
  ModelMuxConfig config;
  gboolean  is_prop_set[PROP_LAST];
 
  gboolean enable;
  gchar *config_file_path;
  guint batch_size;
  guint per_model_batch_size;
  gboolean unified_batch;
 
  gint process_mode;
  gboolean compact_idle_models_across_pools;
  gboolean model_sharding;
  gchar *primary_model;
  gchar *shadow_model;
};
 
struct _GstNvModelMuxClass
{
  GstBinClass parent_class;
};
 
GType gst_modelmux_get_type (void);
 
/* Parse the config-file into self->config, then reconcile with the GObject properties:
 * an EXPLICITLY-set property (self->is_prop_set[PROP_*]) overrides the file value; an
 * unset property is FILLED from the file (so a read-back reflects the effective config).
 * Returns FALSE if the path is missing/empty or the file cannot be parsed. Takes the
 * element (nvinfer convention) so it can update both self->config and the property
 * fields in one place. Defined in gstnvmodelmux_config.c. */
gboolean gst_modelmux_parse_config_file (GstNvModelMux * self, const gchar * cfg_file);
 
/* --- peer-stage traversal (gstnvmodelmux.c) ---
 * Visit every OTHER nvmodelmux in this element's pipeline. This is how EVERY
 * cross-stage question is answered -- config-time name/id conflicts, and at runtime
 * the model-plane and GET-plane fan-out -- because pads describe the DATA topology
 * and stages are not necessarily wired in series (deepstream-app hangs sibling
 * secondaries off one tee, so a forwarded query reaches only the first). Walking the
 * pipeline finds them however they are wired. @fn returns FALSE to stop early. */
typedef gboolean (*ModelMuxPeerStageFunc) (GstNvModelMux * self,
                                           GstNvModelMux * peer, gpointer udata);
G_GNUC_INTERNAL void modelmux_foreach_peer_stage (GstNvModelMux * self,
                                                  ModelMuxPeerStageFunc fn,
                                                  gpointer udata);
 
/* Deliver @q to @peer's own query probe and return TRUE if it answered.
 * The copy handed over is MARKED, so the peer answers for itself and does not fan
 * out again -- one level of delegation, no cycles however many stages there are.
 * @q itself is never modified; the caller reads the answer from @out. */
G_GNUC_INTERNAL gboolean modelmux_stage_ask_peer (GstNvModelMux * peer, GstQuery * q,
                                                  GstQuery ** out);
/* TRUE when this query is one a peer stage handed us: answer for THIS stage only. */
G_GNUC_INTERNAL gboolean modelmux_stage_query_is_delegated (GstQuery * q);
 
/* --- native-REST control plane (gstnvmodelmux_control.c) ---
 * Make the element self-contained: subscribe to the pipeline bus so the
 * nvmultiurisrcbin native-REST messages (stream/add|remove, model/load|unload|
 * update) are parsed and executed INTERNALLY -- the host app needs no glue.
 * Attached when the inference bin is built; detached on teardown. */
void gst_modelmux_control_attach (GstNvModelMux * self);
void gst_modelmux_control_detach (GstNvModelMux * self);
/* Wire the control plane's bin-invoked callbacks (OTA rollback follow-up)
 * into a freshly-built bin, before it is published to self->modelmux_bin. */
void gst_modelmux_control_wire_ota_rollback (GstNvModelMux * self, ModelMuxBin * mm);
/* Per-stream model-selection metadata parser (gstnvmodelmux_control_metadata.c;
 * called by the control plane). Declared here -- the one header BOTH files
 * include -- so the definition sees a prototype (tmake: -Werror=missing-prototypes). */
G_GNUC_INTERNAL void modelmux_control_parse_model_metadata (GstNvModelMux * self,
    const gchar * json, gchar ** primary_model_name, gchar ** primary_model_version,
    gint * primary_model_gpu, gchar ** shadow_model_name, gchar ** shadow_model_version,
    gint * shadow_model_gpu);
 
G_END_DECLS
 
#endif /* __GST_NVMODELMUX_H__ */