gstreamer_tag/auto/

functions.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::{TagLicenseFlags, ffi};
use glib::translate::*;

/// Looks up the GStreamer tag for a ID3v2 tag.
/// ## `id3_tag`
/// ID3v2 tag to convert to GStreamer tag
///
/// # Returns
///
/// The corresponding GStreamer tag or NULL if none exists.
#[doc(alias = "gst_tag_from_id3_tag")]
pub fn tag_from_id3_tag(id3_tag: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_from_id3_tag(id3_tag.to_glib_none().0)) }
}

/// Looks up the GStreamer tag for an ID3v2 user tag (e.g. description in
/// TXXX frame or owner in UFID frame).
/// ## `type_`
/// the type of ID3v2 user tag (e.g. "TXXX" or "UDIF")
/// ## `id3_user_tag`
/// ID3v2 user tag to convert to GStreamer tag
///
/// # Returns
///
/// The corresponding GStreamer tag or NULL if none exists.
#[doc(alias = "gst_tag_from_id3_user_tag")]
pub fn tag_from_id3_user_tag(type_: &str, id3_user_tag: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe {
        from_glib_none(ffi::gst_tag_from_id3_user_tag(
            type_.to_glib_none().0,
            id3_user_tag.to_glib_none().0,
        ))
    }
}

/// Looks up the GStreamer tag for a vorbiscomment tag.
/// ## `vorbis_tag`
/// vorbiscomment tag to convert to GStreamer tag
///
/// # Returns
///
/// The corresponding GStreamer tag or NULL if none exists.
#[doc(alias = "gst_tag_from_vorbis_tag")]
pub fn tag_from_vorbis_tag(vorbis_tag: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_from_vorbis_tag(vorbis_tag.to_glib_none().0)) }
}

/// Get the description of a license, which is a translated description
/// of the license's main features.
/// ## `license_ref`
/// a license reference string in form of a URI,
///  e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"
///
/// # Returns
///
/// the description of the license, or NULL if the license is unknown
///  or a description is not available.
#[doc(alias = "gst_tag_get_license_description")]
pub fn tag_get_license_description(license_ref: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe {
        from_glib_none(ffi::gst_tag_get_license_description(
            license_ref.to_glib_none().0,
        ))
    }
}

/// Get the flags of a license, which describe most of the features of
/// a license in their most general form.
/// ## `license_ref`
/// a license reference string in form of a URI,
///  e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"
///
/// # Returns
///
/// the flags of the license, or 0 if the license is unknown
#[doc(alias = "gst_tag_get_license_flags")]
pub fn tag_get_license_flags(license_ref: &str) -> TagLicenseFlags {
    assert_initialized_main_thread!();
    unsafe { from_glib(ffi::gst_tag_get_license_flags(license_ref.to_glib_none().0)) }
}

/// Get the jurisdiction code of a license. This is usually a two-letter
/// ISO 3166-1 alpha-2 code, but there is also the special case of Scotland,
/// for which no code exists and which is thus represented as "scotland".
///
/// Known jurisdictions: ar, at, au, be, bg, br, ca, ch, cl, cn, co, de,
/// dk, es, fi, fr, hr, hu, il, in, it, jp, kr, mk, mt, mx, my, nl, pe, pl,
/// pt, scotland, se, si, tw, uk, us, za.
/// ## `license_ref`
/// a license reference string in form of a URI,
///  e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"
///
/// # Returns
///
/// the jurisdiction code of the license, or NULL if the license is
///  unknown or is not specific to a particular jurisdiction.
#[doc(alias = "gst_tag_get_license_jurisdiction")]
pub fn tag_get_license_jurisdiction(license_ref: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe {
        from_glib_none(ffi::gst_tag_get_license_jurisdiction(
            license_ref.to_glib_none().0,
        ))
    }
}

/// Get the nick name of a license, which is a short (untranslated) string
/// such as e.g. "CC BY-NC-ND 2.0 UK".
/// ## `license_ref`
/// a license reference string in form of a URI,
///  e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"
///
/// # Returns
///
/// the nick name of the license, or NULL if the license is unknown
#[doc(alias = "gst_tag_get_license_nick")]
pub fn tag_get_license_nick(license_ref: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_get_license_nick(license_ref.to_glib_none().0)) }
}

/// Get the title of a license, which is a short translated description
/// of the license's features (generally not very pretty though).
/// ## `license_ref`
/// a license reference string in form of a URI,
///  e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"
///
/// # Returns
///
/// the title of the license, or NULL if the license is unknown or
///  no title is available.
#[doc(alias = "gst_tag_get_license_title")]
pub fn tag_get_license_title(license_ref: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_get_license_title(license_ref.to_glib_none().0)) }
}

/// Get the version of a license.
/// ## `license_ref`
/// a license reference string in form of a URI,
///  e.g. "http://creativecommons.org/licenses/by-nc-nd/2.0/"
///
/// # Returns
///
/// the version of the license, or NULL if the license is not known or
///  has no version
#[doc(alias = "gst_tag_get_license_version")]
pub fn tag_get_license_version(license_ref: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe {
        from_glib_none(ffi::gst_tag_get_license_version(
            license_ref.to_glib_none().0,
        ))
    }
}

/// Returns a list of known license references (in form of URIs). This is
/// useful for UIs to build a list of available licenses for tagging purposes
/// (e.g. to tag an audio track appropriately in a video or audio editor, or
/// an image in a camera application).
///
/// # Returns
///
/// NULL-terminated array of license strings. Free
///  with `g_strfreev()` when no longer needed.
#[doc(alias = "gst_tag_get_licenses")]
pub fn tag_get_licenses() -> Vec<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { FromGlibPtrContainer::from_glib_full(ffi::gst_tag_get_licenses()) }
}

/// Gets the number of ID3v1 genres that can be identified. Winamp genres are
/// included.
///
/// # Returns
///
/// the number of ID3v1 genres that can be identified
#[doc(alias = "gst_tag_id3_genre_count")]
pub fn tag_id3_genre_count() -> u32 {
    assert_initialized_main_thread!();
    unsafe { ffi::gst_tag_id3_genre_count() }
}

/// Gets the ID3v1 genre name for a given ID.
/// ## `id`
/// ID of genre to query
///
/// # Returns
///
/// the genre or NULL if no genre is associated with that ID.
#[doc(alias = "gst_tag_id3_genre_get")]
pub fn tag_id3_genre_get(id: u32) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_id3_genre_get(id)) }
}

/// Convenience function to parse a GST_TAG_EXTENDED_COMMENT string and
/// separate it into its components.
///
/// If successful, `key`, `lang` and/or `value` will be set to newly allocated
/// strings that you need to free with `g_free()` when done. `key` and `lang`
/// may also be set to NULL by this function if there is no key or no language
/// code in the extended comment string.
/// ## `ext_comment`
/// an extended comment string, see `GST_TAG_EXTENDED_COMMENT`
/// ## `fail_if_no_key`
/// whether to fail if strings are not in key=value form
///
/// # Returns
///
/// TRUE if the string could be parsed, otherwise FALSE
///
/// ## `key`
///
///  return location for the comment description key, or NULL
///
/// ## `lang`
///
///  return location for the comment ISO-639 language code, or NULL
///
/// ## `value`
/// return location for the actual comment string, or NULL
#[doc(alias = "gst_tag_parse_extended_comment")]
pub fn tag_parse_extended_comment(
    ext_comment: &str,
    fail_if_no_key: bool,
) -> Option<(Option<glib::GString>, Option<glib::GString>, glib::GString)> {
    assert_initialized_main_thread!();
    unsafe {
        let mut key = std::ptr::null_mut();
        let mut lang = std::ptr::null_mut();
        let mut value = std::ptr::null_mut();
        let ret = from_glib(ffi::gst_tag_parse_extended_comment(
            ext_comment.to_glib_none().0,
            &mut key,
            &mut lang,
            &mut value,
            fail_if_no_key.into_glib(),
        ));
        if ret {
            Some((
                from_glib_full(key),
                from_glib_full(lang),
                from_glib_full(value),
            ))
        } else {
            None
        }
    }
}

/// Looks up the ID3v2 tag for a GStreamer tag.
/// ## `gst_tag`
/// GStreamer tag to convert to vorbiscomment tag
///
/// # Returns
///
/// The corresponding ID3v2 tag or NULL if none exists.
#[doc(alias = "gst_tag_to_id3_tag")]
pub fn tag_to_id3_tag(gst_tag: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_to_id3_tag(gst_tag.to_glib_none().0)) }
}

/// Looks up the vorbiscomment tag for a GStreamer tag.
/// ## `gst_tag`
/// GStreamer tag to convert to vorbiscomment tag
///
/// # Returns
///
/// The corresponding vorbiscomment tag or NULL if none exists.
#[doc(alias = "gst_tag_to_vorbis_tag")]
pub fn tag_to_vorbis_tag(gst_tag: &str) -> Option<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { from_glib_none(ffi::gst_tag_to_vorbis_tag(gst_tag.to_glib_none().0)) }
}

/// Gets the list of supported schemas in the xmp lib
///
/// # Returns
///
/// a [`None`] terminated array of strings with the
///  schema names
#[doc(alias = "gst_tag_xmp_list_schemas")]
pub fn tag_xmp_list_schemas() -> Vec<glib::GString> {
    assert_initialized_main_thread!();
    unsafe { FromGlibPtrContainer::from_glib_none(ffi::gst_tag_xmp_list_schemas()) }
}