gstreamer_base/

functions.rs

// Take a look at the license at the top of the repository in the LICENSE file.

use std::mem;

pub use crate::auto::functions::*;
use crate::ffi;
use glib::{prelude::*, translate::*};

/// Tries to find what type of data is contained in the given `data`, the
/// assumption being that the data represents the beginning of the stream or
/// file.
///
/// All available typefinders will be called on the data in order of rank. If
/// a typefinding function returns a probability of [`gst::TypeFindProbability::Maximum`][crate::gst::TypeFindProbability::Maximum],
/// typefinding is stopped immediately and the found caps will be returned
/// right away. Otherwise, all available typefind functions will the tried,
/// and the caps with the highest probability will be returned, or [`None`] if
/// the content of `data` could not be identified.
///
/// Free-function: gst_caps_unref
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `data`
/// * a pointer with data to typefind
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] corresponding to the data,
///  or [`None`] if no type could be found. The caller should free the caps
///  returned with `gst_caps_unref()`.
///
/// ## `prob`
/// location to store the probability of the found
///  caps, or [`None`]
#[doc(alias = "gst_type_find_helper_for_data")]
pub fn type_find_helper_for_data(
    obj: Option<&impl IsA<gst::Object>>,
    data: impl AsRef<[u8]>,
) -> Result<(gst::Caps, gst::TypeFindProbability), glib::error::BoolError> {
    assert_initialized_main_thread!();
    unsafe {
        let mut prob = mem::MaybeUninit::uninit();
        let data = data.as_ref();
        let (ptr, len) = (data.as_ptr(), data.len());
        let ret = ffi::gst_type_find_helper_for_data(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            mut_override(ptr),
            len,
            prob.as_mut_ptr(),
        );
        if ret.is_null() {
            Err(glib::bool_error!("No type could be found"))
        } else {
            Ok((from_glib_full(ret), from_glib(prob.assume_init())))
        }
    }
}

/// Tries to find what type of data is contained in the given `data`, the
/// assumption being that the data represents the beginning of the stream or
/// file.
///
/// All available typefinders will be called on the data in order of rank. If
/// a typefinding function returns a probability of [`gst::TypeFindProbability::Maximum`][crate::gst::TypeFindProbability::Maximum],
/// typefinding is stopped immediately and the found caps will be returned
/// right away. Otherwise, all available typefind functions will the tried,
/// and the caps with the highest probability will be returned, or [`None`] if
/// the content of `data` could not be identified.
///
/// When `extension` is not [`None`], this function will first try the typefind
/// functions for the given extension, which might speed up the typefinding
/// in many cases.
///
/// Free-function: gst_caps_unref
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `data`
/// * a pointer with data to typefind
/// ## `extension`
/// extension of the media, or [`None`]
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] corresponding to the data,
///  or [`None`] if no type could be found. The caller should free the caps
///  returned with `gst_caps_unref()`.
///
/// ## `prob`
/// location to store the probability of the found
///  caps, or [`None`]
#[cfg(feature = "v1_16")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_16")))]
#[doc(alias = "gst_type_find_helper_for_data_with_extension")]
pub fn type_find_helper_for_data_with_extension(
    obj: Option<&impl IsA<gst::Object>>,
    data: impl AsRef<[u8]>,
    extension: Option<&str>,
) -> Result<(gst::Caps, gst::TypeFindProbability), glib::error::BoolError> {
    assert_initialized_main_thread!();
    unsafe {
        let mut prob = mem::MaybeUninit::uninit();
        let data = data.as_ref();
        let (ptr, len) = (data.as_ptr(), data.len());
        let ret = ffi::gst_type_find_helper_for_data_with_extension(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            mut_override(ptr),
            len,
            extension.to_glib_none().0,
            prob.as_mut_ptr(),
        );
        if ret.is_null() {
            Err(glib::bool_error!("No type could be found"))
        } else {
            Ok((from_glib_full(ret), from_glib(prob.assume_init())))
        }
    }
}

/// Tries to find what type of data is contained in the given [`gst::Buffer`][crate::gst::Buffer], the
/// assumption being that the buffer represents the beginning of the stream or
/// file.
///
/// All available typefinders will be called on the data in order of rank. If
/// a typefinding function returns a probability of [`gst::TypeFindProbability::Maximum`][crate::gst::TypeFindProbability::Maximum],
/// typefinding is stopped immediately and the found caps will be returned
/// right away. Otherwise, all available typefind functions will the tried,
/// and the caps with the highest probability will be returned, or [`None`] if
/// the content of the buffer could not be identified.
///
/// Free-function: gst_caps_unref
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `buf`
/// a [`gst::Buffer`][crate::gst::Buffer] with data to typefind
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] corresponding to the data,
///  or [`None`] if no type could be found. The caller should free the caps
///  returned with `gst_caps_unref()`.
///
/// ## `prob`
/// location to store the probability of the found
///  caps, or [`None`]
#[doc(alias = "gst_type_find_helper_for_buffer")]
pub fn type_find_helper_for_buffer<P: IsA<gst::Object>>(
    obj: Option<&P>,
    buf: &gst::BufferRef,
) -> Result<(gst::Caps, gst::TypeFindProbability), glib::error::BoolError> {
    skip_assert_initialized!();
    unsafe {
        let mut prob = mem::MaybeUninit::uninit();
        let ret = ffi::gst_type_find_helper_for_buffer(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            mut_override(buf.as_ptr()),
            prob.as_mut_ptr(),
        );
        if ret.is_null() {
            Err(glib::bool_error!("No type could be found"))
        } else {
            Ok((from_glib_full(ret), from_glib(prob.assume_init())))
        }
    }
}

/// Tries to find what type of data is contained in the given [`gst::Buffer`][crate::gst::Buffer], the
/// assumption being that the buffer represents the beginning of the stream or
/// file.
///
/// All available typefinders will be called on the data in order of rank. If
/// a typefinding function returns a probability of [`gst::TypeFindProbability::Maximum`][crate::gst::TypeFindProbability::Maximum],
/// typefinding is stopped immediately and the found caps will be returned
/// right away. Otherwise, all available typefind functions will the tried,
/// and the caps with the highest probability will be returned, or [`None`] if
/// the content of the buffer could not be identified.
///
/// When `extension` is not [`None`], this function will first try the typefind
/// functions for the given extension, which might speed up the typefinding
/// in many cases.
///
/// Free-function: gst_caps_unref
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `buf`
/// a [`gst::Buffer`][crate::gst::Buffer] with data to typefind
/// ## `extension`
/// extension of the media, or [`None`]
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] corresponding to the data,
///  or [`None`] if no type could be found. The caller should free the caps
///  returned with `gst_caps_unref()`.
///
/// ## `prob`
/// location to store the probability of the found
///  caps, or [`None`]
#[cfg(feature = "v1_16")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_16")))]
#[doc(alias = "gst_type_find_helper_for_buffer_with_extension")]
pub fn type_find_helper_for_buffer_with_extension<P: IsA<gst::Object>>(
    obj: Option<&P>,
    buf: &gst::BufferRef,
    extension: Option<&str>,
) -> Result<(gst::Caps, gst::TypeFindProbability), glib::error::BoolError> {
    skip_assert_initialized!();
    unsafe {
        let mut prob = mem::MaybeUninit::uninit();
        let ret = ffi::gst_type_find_helper_for_buffer_with_extension(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            mut_override(buf.as_ptr()),
            extension.to_glib_none().0,
            prob.as_mut_ptr(),
        );
        if ret.is_null() {
            Err(glib::bool_error!("No type could be found"))
        } else {
            Ok((from_glib_full(ret), from_glib(prob.assume_init())))
        }
    }
}

/// Tries to find if type of media contained in the given [`gst::Buffer`][crate::gst::Buffer], matches
/// `caps` specified, assumption being that the buffer represents the beginning
/// of the stream or file.
///
/// Tries to find what type of data is contained in the given `data`, the
/// assumption being that the data represents the beginning of the stream or
/// file.
///
/// Only the typefinder matching the given caps will be called, if found. The
/// caps with the highest probability will be returned, or [`None`] if the content
/// of the `data` could not be identified.
///
/// Free-function: gst_caps_unref
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `buf`
/// a [`gst::Buffer`][crate::gst::Buffer] with data to typefind
/// ## `caps`
/// caps of the media
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] corresponding to the data,
///  or [`None`] if no type could be found. The caller should free the caps
///  returned with `gst_caps_unref()`.
///
/// ## `prob`
/// location to store the probability of the found
///  caps, or [`None`]
#[cfg(feature = "v1_22")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_22")))]
#[doc(alias = "gst_type_find_helper_for_buffer_with_caps")]
pub fn type_find_helper_for_buffer_with_caps(
    obj: Option<&impl IsA<gst::Object>>,
    buf: &gst::BufferRef,
    caps: &gst::CapsRef,
) -> (Option<gst::Caps>, gst::TypeFindProbability) {
    skip_assert_initialized!();
    unsafe {
        let mut prob = mem::MaybeUninit::uninit();
        let ret = from_glib_full(ffi::gst_type_find_helper_for_buffer_with_caps(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            mut_override(buf.as_ptr()),
            mut_override(caps.as_ptr()),
            prob.as_mut_ptr(),
        ));
        (ret, from_glib(prob.assume_init()))
    }
}

/// Tries to find if type of media contained in the given `data`, matches the
/// `caps` specified, assumption being that the data represents the beginning
/// of the stream or file.
///
/// Only the typefinder matching the given caps will be called, if found. The
/// caps with the highest probability will be returned, or [`None`] if the content
/// of the `data` could not be identified.
///
/// Free-function: gst_caps_unref
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `data`
/// a pointer with data to typefind
/// ## `caps`
/// caps of the media
///
/// # Returns
///
/// the [`gst::Caps`][crate::gst::Caps] corresponding to the data,
///  or [`None`] if no type could be found. The caller should free the caps
///  returned with `gst_caps_unref()`.
///
/// ## `prob`
/// location to store the probability of the found
///  caps, or [`None`]
#[cfg(feature = "v1_22")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_22")))]
#[doc(alias = "gst_type_find_helper_for_data_with_caps")]
pub fn type_find_helper_for_data_with_caps(
    obj: Option<&impl IsA<gst::Object>>,
    data: &[u8],
    caps: &gst::CapsRef,
) -> (Option<gst::Caps>, gst::TypeFindProbability) {
    skip_assert_initialized!();
    let size = data.len() as _;
    unsafe {
        let mut prob = mem::MaybeUninit::uninit();
        let ret = from_glib_full(ffi::gst_type_find_helper_for_data_with_caps(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            data.to_glib_none().0,
            size,
            mut_override(caps.as_ptr()),
            prob.as_mut_ptr(),
        ));
        (ret, from_glib(prob.assume_init()))
    }
}

/// Tries to find the best `GstTypeFindFactory` associated with `caps`.
///
/// The typefinder that can handle `caps` will be returned.
///
/// Free-function: g_list_free
/// ## `obj`
/// object doing the typefinding, or [`None`] (used for logging)
/// ## `caps`
/// caps of the media
///
/// # Returns
///
/// the list of `GstTypeFindFactory`
///  corresponding to `caps`, or [`None`] if no typefinder could be
///  found. Caller should free the returned list with `g_list_free()`
///  and list elements with `gst_object_unref()`.
#[cfg(feature = "v1_22")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_22")))]
#[doc(alias = "gst_type_find_list_factories_for_caps")]
pub fn type_find_list_factories_for_caps(
    obj: Option<&impl IsA<gst::Object>>,
    caps: &gst::CapsRef,
) -> glib::List<gst::TypeFindFactory> {
    skip_assert_initialized!();
    unsafe {
        glib::collections::List::from_glib_full(ffi::gst_type_find_list_factories_for_caps(
            obj.map(|p| p.as_ref()).to_glib_none().0,
            mut_override(caps.as_ptr()),
        ))
    }
}