gstreamer_analytics/auto/

model_info.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::{TensorDimOrder, ffi};
use glib::translate::*;

glib::wrapper! {
    /// The [`ModelInfo`][crate::ModelInfo] is an object storing artifical neural network
    /// model metadata describing the input and output tensors. These information's
    /// are required by inference elements.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct ModelInfo(Boxed<ffi::GstAnalyticsModelInfo>);

    match fn {
        copy => |ptr| glib::gobject_ffi::g_boxed_copy(ffi::gst_analytics_modelinfo_get_type(), ptr as *mut _) as *mut ffi::GstAnalyticsModelInfo,
        free => |ptr| glib::gobject_ffi::g_boxed_free(ffi::gst_analytics_modelinfo_get_type(), ptr as *mut _),
        type_ => || ffi::gst_analytics_modelinfo_get_type(),
    }
}

impl ModelInfo {
    /// Retrieve the dimension ordering for a given tensor.
    ///
    /// The dimension ordering specifies how multi-dimensional tensor data is
    /// laid out in memory:
    /// - Row-major (C/NumPy style): Last dimension changes fastest in memory
    /// - Column-major (Fortran style): First dimension changes fastest in memory
    ///
    /// If not specified in the modelinfo, defaults to row-major.
    /// ## `tensor_name`
    /// The name of the tensor
    ///
    /// # Returns
    ///
    /// The dimension order as [`TensorDimOrder`][crate::TensorDimOrder]
    #[doc(alias = "gst_analytics_modelinfo_get_dims_order")]
    #[doc(alias = "get_dims_order")]
    pub fn dims_order(&self, tensor_name: &str) -> TensorDimOrder {
        unsafe {
            from_glib(ffi::gst_analytics_modelinfo_get_dims_order(
                mut_override(self.to_glib_none().0),
                tensor_name.to_glib_none().0,
            ))
        }
    }

    /// Get the group ID that groups related tensors together (e.g., all outputs
    /// from the same model).
    ///
    /// The group ID is stored in the modelinfo section and is global for all
    /// tensors in the model.
    ///
    /// # Returns
    ///
    /// The group ID string, or [`None`] if not found.
    ///  The caller must free this with `g_free()` when done.
    #[doc(alias = "gst_analytics_modelinfo_get_group_id")]
    #[doc(alias = "get_group_id")]
    pub fn group_id(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::gst_analytics_modelinfo_get_group_id(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Get the tensor ID from the modelinfo for the specified tensor name.
    ///
    /// The tensor ID is ideally registered in the [Tensor ID Registry](https://github.com/collabora/tensor-id-registry/blob/main/tensor-id-register.md).
    /// ## `tensor_name`
    /// The name of the tensor
    ///
    /// # Returns
    ///
    /// The tensor ID string, or [`None`] if not found.
    ///  The caller must free this with `g_free()` when done.
    #[doc(alias = "gst_analytics_modelinfo_get_id")]
    #[doc(alias = "get_id")]
    pub fn id(&self, tensor_name: &str) -> Option<glib::GString> {
        unsafe {
            from_glib_full(ffi::gst_analytics_modelinfo_get_id(
                mut_override(self.to_glib_none().0),
                tensor_name.to_glib_none().0,
            ))
        }
    }

    /// Get the group ID as a GQuark for efficient string comparison and storage.
    ///
    /// Using GQuark is more efficient than string comparison when you need to
    /// compare multiple group IDs.
    ///
    /// # Returns
    ///
    /// The GQuark of the group ID, or 0 if not found
    #[doc(alias = "gst_analytics_modelinfo_get_quark_group_id")]
    #[doc(alias = "get_quark_group_id")]
    pub fn quark_group_id(&self) -> glib::Quark {
        unsafe {
            from_glib(ffi::gst_analytics_modelinfo_get_quark_group_id(
                mut_override(self.to_glib_none().0),
            ))
        }
    }

    /// Get the tensor ID as a GQuark for efficient string comparison and storage.
    ///
    /// Using GQuark is more efficient than string comparison when you need to
    /// compare multiple IDs.
    /// ## `tensor_name`
    /// The name of the tensor
    ///
    /// # Returns
    ///
    /// The GQuark of the tensor ID, or 0 if not found
    #[doc(alias = "gst_analytics_modelinfo_get_quark_id")]
    #[doc(alias = "get_quark_id")]
    pub fn quark_id(&self, tensor_name: &str) -> glib::Quark {
        unsafe {
            from_glib(ffi::gst_analytics_modelinfo_get_quark_id(
                mut_override(self.to_glib_none().0),
                tensor_name.to_glib_none().0,
            ))
        }
    }

    /// Retrieve the version string of the modelinfo file format.
    ///
    /// The version is in the format "Major.Minor" and is stored in the
    /// [modelinfo] section of the modelinfo file.
    ///
    /// # Returns
    ///
    /// The version string (e.g., "1.0").
    ///  The caller must free this with `g_free()` when done.
    ///  Defaults to "1.0" if not specified.
    #[doc(alias = "gst_analytics_modelinfo_get_version")]
    #[doc(alias = "get_version")]
    pub fn version(&self) -> glib::GString {
        unsafe {
            from_glib_full(ffi::gst_analytics_modelinfo_get_version(mut_override(
                self.to_glib_none().0,
            )))
        }
    }

    /// Load a modelinfo file associated with the given model file.
    ///
    /// This function attempts to load a `.modelinfo` file in the following order:
    /// 1. `{model_filename}.modelinfo`
    /// 2. `{model_filename_without_extension}.modelinfo`
    ///
    /// The modelinfo file contains metadata for the model's input and output tensors,
    /// including normalization ranges, dimension ordering, tensor IDs, etc.
    ///
    /// The loaded modelinfo must be freed with `gst_analytics_modelinfo_free()`
    /// when no longer needed.
    /// ## `model_filename`
    /// Path to the model file (e.g., "model.onnx", "model.tflite")
    ///
    /// # Returns
    ///
    /// A new [`ModelInfo`][crate::ModelInfo] instance,
    ///  or [`None`] if the modelinfo file could not be found or loaded.
    #[doc(alias = "gst_analytics_modelinfo_load")]
    pub fn load(model_filename: impl AsRef<std::path::Path>) -> Option<ModelInfo> {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gst_analytics_modelinfo_load(
                model_filename.as_ref().to_glib_none().0,
            ))
        }
    }
}

unsafe impl Send for ModelInfo {}
unsafe impl Sync for ModelInfo {}