gstreamer-analytics 0.25.2

Rust bindings for GStreamer Analytics library
Documentation
// Copyright (C) 2025 Sebastian Dröge <sebastian@centricular.com>
//
// This Source Code Form is subject to the terms of the Mozilla Public License, v2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at
// <https://mozilla.org/MPL/2.0/>.
//
// SPDX-License-Identifier: MPL-2.0

use crate::ffi;
use glib::translate::*;
use gst::prelude::*;

use std::{fmt, slice, sync::LazyLock};

#[doc(alias = "GST_CAPS_FEATURE_META_GST_ANALYTICS_BATCH_META")]
pub const CAPS_FEATURE_META_ANALYTICS_BATCH_META: &glib::GStr = unsafe {
    glib::GStr::from_utf8_with_nul_unchecked(ffi::GST_CAPS_FEATURE_META_GST_ANALYTICS_BATCH_META)
};
pub static CAPS_FEATURES_META_ANALYTICS_BATCH_META: LazyLock<gst::CapsFeatures> =
    LazyLock::new(|| gst::CapsFeatures::new([CAPS_FEATURE_META_ANALYTICS_BATCH_META]));

#[repr(transparent)]
#[doc(alias = "GstAnalyticsBatchMeta")]
pub struct AnalyticsBatchMeta(ffi::GstAnalyticsBatchMeta);

unsafe impl Send for AnalyticsBatchMeta {}
unsafe impl Sync for AnalyticsBatchMeta {}

impl AnalyticsBatchMeta {
    #[doc(alias = "gst_buffer_add_analytics_batch_meta")]
    pub fn add<'a>(
        buffer: &'a mut gst::BufferRef,
    ) -> gst::MetaRefMut<'a, Self, gst::meta::Standalone> {
        skip_assert_initialized!();

        unsafe {
            let meta = ffi::gst_buffer_add_analytics_batch_meta(buffer.as_mut_ptr());

            Self::from_mut_ptr(buffer, meta)
        }
    }

    pub fn streams(&self) -> &[AnalyticsBatchStream] {
        unsafe {
            if self.0.streams.is_null() {
                &[]
            } else {
                slice::from_raw_parts(self.0.streams as *const _, self.0.n_streams)
            }
        }
    }

    pub fn streams_mut(&mut self) -> &mut [AnalyticsBatchStream] {
        unsafe {
            if self.0.streams.is_null() {
                &mut []
            } else {
                slice::from_raw_parts_mut(self.0.streams as *mut _, self.0.n_streams)
            }
        }
    }
}

unsafe impl gst::MetaAPI for AnalyticsBatchMeta {
    type GstType = ffi::GstAnalyticsBatchMeta;

    #[doc(alias = "gst_analytics_batch_meta_api_get_type")]
    #[inline]
    fn meta_api() -> glib::Type {
        unsafe { from_glib(ffi::gst_analytics_batch_meta_api_get_type()) }
    }
}

impl fmt::Debug for AnalyticsBatchMeta {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("AnalyticsBatchMeta")
            .field("streams", &self.streams())
            .finish()
    }
}

#[repr(transparent)]
#[doc(alias = "GstAnalyticsBatchStream")]
pub struct AnalyticsBatchStream(ffi::GstAnalyticsBatchStream);

impl AnalyticsBatchStream {
    pub fn index(&self) -> u32 {
        self.0.index
    }

    pub fn sticky_events(&self) -> &[gst::Event] {
        unsafe {
            if self.0.sticky_events.is_null() {
                &[]
            } else {
                slice::from_raw_parts(self.0.sticky_events as *const _, self.0.n_sticky_events)
            }
        }
    }

    pub fn sticky_events_mut(&mut self) -> &mut [gst::Event] {
        unsafe {
            if self.0.sticky_events.is_null() {
                &mut []
            } else {
                slice::from_raw_parts_mut(self.0.sticky_events as *mut _, self.0.n_sticky_events)
            }
        }
    }

    pub fn objects(&self) -> &[gst::MiniObject] {
        unsafe {
            if self.0.objects.is_null() {
                &[]
            } else {
                slice::from_raw_parts(self.0.objects as *const _, self.0.n_objects)
            }
        }
    }

    pub fn objects_mut(&mut self) -> &mut [gst::MiniObject] {
        unsafe {
            if self.0.objects.is_null() {
                &mut []
            } else {
                slice::from_raw_parts_mut(self.0.objects as *mut _, self.0.n_objects)
            }
        }
    }

    #[doc(alias = "gst_analytics_batch_stream_get_caps")]
    pub fn caps(&self) -> Option<gst::Caps> {
        unsafe {
            from_glib_none(ffi::gst_analytics_batch_stream_get_caps(mut_override(
                &self.0,
            )))
        }
    }

    #[doc(alias = "gst_analytics_batch_stream_get_segment")]
    pub fn segment(&self) -> Option<gst::Segment> {
        unsafe {
            from_glib_none(ffi::gst_analytics_batch_stream_get_segment(mut_override(
                &self.0,
            )))
        }
    }

    #[doc(alias = "gst_analytics_batch_stream_get_stream_id")]
    pub fn stream_id(&self) -> Option<&glib::GStr> {
        unsafe {
            let res = ffi::gst_analytics_batch_stream_get_stream_id(mut_override(&self.0));

            if res.is_null() {
                None
            } else {
                Some(glib::GStr::from_ptr(res))
            }
        }
    }
}

impl fmt::Debug for AnalyticsBatchStream {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("AnalyticsBatchStream")
            .field("index", &self.index())
            .field("objects", &self.objects())
            .finish()
    }
}