1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

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

use glib::prelude::*;
use glib::translate::*;
use std::mem;

/// 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<P: IsA<gst::Object>, R: AsRef<[u8]>>(
    obj: Option<&P>,
    data: R,
) -> 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(any(feature = "v1_16", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_16")))]
#[doc(alias = "gst_type_find_helper_for_data_with_extension")]
pub fn type_find_helper_for_data_with_extension<P: IsA<gst::Object>, R: AsRef<[u8]>>(
    obj: Option<&P>,
    data: R,
    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::Buffer,
) -> Result<(gst::Caps, gst::TypeFindProbability), glib::error::BoolError> {
    assert_initialized_main_thread!();
    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,
            buf.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.
///
/// 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(any(feature = "v1_16", feature = "dox"))]
#[cfg_attr(feature = "dox", 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::Buffer,
    extension: Option<&str>,
) -> Result<(gst::Caps, gst::TypeFindProbability), glib::error::BoolError> {
    assert_initialized_main_thread!();
    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,
            buf.to_glib_none().0,
            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())))
        }
    }
}