gstreamer_audio/
audio_format.rs

1// Take a look at the license at the top of the repository in the LICENSE file.
2
3use std::str;
4
5use crate::ffi;
6use glib::translate::{from_glib, IntoGlib};
7use std::sync::LazyLock;
8
9#[cfg(feature = "v1_18")]
10pub static AUDIO_FORMATS_ALL: LazyLock<Box<[crate::AudioFormat]>> = LazyLock::new(|| unsafe {
11    let mut len: u32 = 0;
12    let mut res = Vec::with_capacity(len as usize);
13    let formats = ffi::gst_audio_formats_raw(&mut len);
14    for i in 0..len {
15        let format = formats.offset(i as isize);
16        res.push(from_glib(*format));
17    }
18    res.into_boxed_slice()
19});
20
21#[cfg(not(feature = "v1_18"))]
22pub static AUDIO_FORMATS_ALL: LazyLock<Box<[crate::AudioFormat]>> = LazyLock::new(|| {
23    #[cfg(target_endian = "little")]
24    {
25        Box::new([
26            crate::AudioFormat::F64le,
27            crate::AudioFormat::F64be,
28            crate::AudioFormat::F32le,
29            crate::AudioFormat::F32be,
30            crate::AudioFormat::S32le,
31            crate::AudioFormat::S32be,
32            crate::AudioFormat::U32le,
33            crate::AudioFormat::U32be,
34            crate::AudioFormat::S2432le,
35            crate::AudioFormat::S2432be,
36            crate::AudioFormat::U2432le,
37            crate::AudioFormat::U2432be,
38            crate::AudioFormat::S24le,
39            crate::AudioFormat::S24be,
40            crate::AudioFormat::U24le,
41            crate::AudioFormat::U24be,
42            crate::AudioFormat::S20le,
43            crate::AudioFormat::S20be,
44            crate::AudioFormat::U20le,
45            crate::AudioFormat::U20be,
46            crate::AudioFormat::S18le,
47            crate::AudioFormat::S18be,
48            crate::AudioFormat::U18le,
49            crate::AudioFormat::U18be,
50            crate::AudioFormat::S16le,
51            crate::AudioFormat::S16be,
52            crate::AudioFormat::U16le,
53            crate::AudioFormat::U16be,
54            crate::AudioFormat::S8,
55            crate::AudioFormat::U8,
56        ])
57    }
58    #[cfg(target_endian = "big")]
59    {
60        Box::new([
61            crate::AudioFormat::F64be,
62            crate::AudioFormat::F64le,
63            crate::AudioFormat::F32be,
64            crate::AudioFormat::F32le,
65            crate::AudioFormat::S32be,
66            crate::AudioFormat::S32le,
67            crate::AudioFormat::U32be,
68            crate::AudioFormat::U32le,
69            crate::AudioFormat::S2432be,
70            crate::AudioFormat::S2432le,
71            crate::AudioFormat::U2432be,
72            crate::AudioFormat::U2432le,
73            crate::AudioFormat::S24be,
74            crate::AudioFormat::S24le,
75            crate::AudioFormat::U24be,
76            crate::AudioFormat::U24le,
77            crate::AudioFormat::S20be,
78            crate::AudioFormat::S20le,
79            crate::AudioFormat::U20be,
80            crate::AudioFormat::U20le,
81            crate::AudioFormat::S18be,
82            crate::AudioFormat::S18le,
83            crate::AudioFormat::U18be,
84            crate::AudioFormat::U18le,
85            crate::AudioFormat::S16be,
86            crate::AudioFormat::S16le,
87            crate::AudioFormat::U16be,
88            crate::AudioFormat::U16le,
89            crate::AudioFormat::S8,
90            crate::AudioFormat::U8,
91        ])
92    }
93});
94
95impl crate::AudioFormat {
96    #[doc(alias = "gst_audio_format_build_integer")]
97    pub fn build_integer(
98        sign: bool,
99        endianness: crate::AudioEndianness,
100        width: i32,
101        depth: i32,
102    ) -> Self {
103        assert_initialized_main_thread!();
104
105        unsafe {
106            from_glib(ffi::gst_audio_format_build_integer(
107                sign.into_glib(),
108                endianness.into_glib(),
109                width,
110                depth,
111            ))
112        }
113    }
114
115    #[doc(alias = "gst_audio_format_to_string")]
116    pub fn to_str<'a>(self) -> &'a glib::GStr {
117        if self == Self::Unknown {
118            return glib::gstr!("UNKNOWN");
119        }
120        unsafe {
121            glib::GStr::from_ptr(
122                ffi::gst_audio_format_to_string(self.into_glib())
123                    .as_ref()
124                    .expect("gst_audio_format_to_string returned NULL"),
125            )
126        }
127    }
128
129    pub fn iter_raw() -> AudioFormatIterator {
130        AudioFormatIterator::default()
131    }
132}
133
134impl str::FromStr for crate::AudioFormat {
135    type Err = glib::BoolError;
136
137    fn from_str(s: &str) -> Result<Self, Self::Err> {
138        skip_assert_initialized!();
139
140        let fmt = Self::from_string(s);
141        if fmt == Self::Unknown {
142            Err(glib::bool_error!(
143                "Failed to parse audio format from string"
144            ))
145        } else {
146            Ok(fmt)
147        }
148    }
149}
150
151impl PartialOrd for crate::AudioFormat {
152    #[inline]
153    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
154        Some(self.cmp(other))
155    }
156}
157
158impl Ord for crate::AudioFormat {
159    #[inline]
160    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
161        crate::AudioFormatInfo::from_format(*self).cmp(&crate::AudioFormatInfo::from_format(*other))
162    }
163}
164
165pub const AUDIO_FORMAT_UNKNOWN: crate::AudioFormat = crate::AudioFormat::Unknown;
166pub const AUDIO_FORMAT_ENCODED: crate::AudioFormat = crate::AudioFormat::Encoded;
167pub const AUDIO_FORMAT_S8: crate::AudioFormat = crate::AudioFormat::S8;
168pub const AUDIO_FORMAT_U8: crate::AudioFormat = crate::AudioFormat::U8;
169
170#[cfg(target_endian = "big")]
171pub const AUDIO_FORMAT_S16: crate::AudioFormat = crate::AudioFormat::S16be;
172#[cfg(target_endian = "big")]
173pub const AUDIO_FORMAT_U16: crate::AudioFormat = crate::AudioFormat::U16be;
174#[cfg(target_endian = "big")]
175pub const AUDIO_FORMAT_S2432: crate::AudioFormat = crate::AudioFormat::S2432be;
176#[cfg(target_endian = "big")]
177pub const AUDIO_FORMAT_U2432: crate::AudioFormat = crate::AudioFormat::U2432be;
178#[cfg(target_endian = "big")]
179pub const AUDIO_FORMAT_S32: crate::AudioFormat = crate::AudioFormat::S32be;
180#[cfg(target_endian = "big")]
181pub const AUDIO_FORMAT_U32: crate::AudioFormat = crate::AudioFormat::U32be;
182#[cfg(target_endian = "big")]
183pub const AUDIO_FORMAT_S24: crate::AudioFormat = crate::AudioFormat::S24be;
184#[cfg(target_endian = "big")]
185pub const AUDIO_FORMAT_U24: crate::AudioFormat = crate::AudioFormat::U24be;
186#[cfg(target_endian = "big")]
187pub const AUDIO_FORMAT_S20: crate::AudioFormat = crate::AudioFormat::S20be;
188#[cfg(target_endian = "big")]
189pub const AUDIO_FORMAT_U20: crate::AudioFormat = crate::AudioFormat::U20be;
190#[cfg(target_endian = "big")]
191pub const AUDIO_FORMAT_S18: crate::AudioFormat = crate::AudioFormat::S18be;
192#[cfg(target_endian = "big")]
193pub const AUDIO_FORMAT_U18: crate::AudioFormat = crate::AudioFormat::U18be;
194#[cfg(target_endian = "big")]
195pub const AUDIO_FORMAT_F32: crate::AudioFormat = crate::AudioFormat::F32be;
196#[cfg(target_endian = "big")]
197pub const AUDIO_FORMAT_F64: crate::AudioFormat = crate::AudioFormat::F64be;
198
199#[cfg(target_endian = "little")]
200pub const AUDIO_FORMAT_S16: crate::AudioFormat = crate::AudioFormat::S16le;
201#[cfg(target_endian = "little")]
202pub const AUDIO_FORMAT_U16: crate::AudioFormat = crate::AudioFormat::U16le;
203#[cfg(target_endian = "little")]
204pub const AUDIO_FORMAT_S2432: crate::AudioFormat = crate::AudioFormat::S2432le;
205#[cfg(target_endian = "little")]
206pub const AUDIO_FORMAT_U2432: crate::AudioFormat = crate::AudioFormat::U2432le;
207#[cfg(target_endian = "little")]
208pub const AUDIO_FORMAT_S32: crate::AudioFormat = crate::AudioFormat::S32le;
209#[cfg(target_endian = "little")]
210pub const AUDIO_FORMAT_U32: crate::AudioFormat = crate::AudioFormat::U32le;
211#[cfg(target_endian = "little")]
212pub const AUDIO_FORMAT_S24: crate::AudioFormat = crate::AudioFormat::S24le;
213#[cfg(target_endian = "little")]
214pub const AUDIO_FORMAT_U24: crate::AudioFormat = crate::AudioFormat::U24le;
215#[cfg(target_endian = "little")]
216pub const AUDIO_FORMAT_S20: crate::AudioFormat = crate::AudioFormat::S20le;
217#[cfg(target_endian = "little")]
218pub const AUDIO_FORMAT_U20: crate::AudioFormat = crate::AudioFormat::U20le;
219#[cfg(target_endian = "little")]
220pub const AUDIO_FORMAT_S18: crate::AudioFormat = crate::AudioFormat::S18le;
221#[cfg(target_endian = "little")]
222pub const AUDIO_FORMAT_U18: crate::AudioFormat = crate::AudioFormat::U18le;
223#[cfg(target_endian = "little")]
224pub const AUDIO_FORMAT_F32: crate::AudioFormat = crate::AudioFormat::F32le;
225#[cfg(target_endian = "little")]
226pub const AUDIO_FORMAT_F64: crate::AudioFormat = crate::AudioFormat::F64le;
227
228#[must_use = "iterators are lazy and do nothing unless consumed"]
229pub struct AudioFormatIterator {
230    idx: usize,
231    len: usize,
232}
233
234impl Default for AudioFormatIterator {
235    fn default() -> Self {
236        Self {
237            idx: 0,
238            len: AUDIO_FORMATS_ALL.len(),
239        }
240    }
241}
242
243impl Iterator for AudioFormatIterator {
244    type Item = crate::AudioFormat;
245
246    fn next(&mut self) -> Option<Self::Item> {
247        if self.idx >= self.len {
248            None
249        } else {
250            let fmt = AUDIO_FORMATS_ALL[self.idx];
251            self.idx += 1;
252            Some(fmt)
253        }
254    }
255
256    fn size_hint(&self) -> (usize, Option<usize>) {
257        let remaining = self.len - self.idx;
258
259        (remaining, Some(remaining))
260    }
261
262    fn count(self) -> usize {
263        self.len - self.idx
264    }
265
266    fn nth(&mut self, n: usize) -> Option<Self::Item> {
267        let (end, overflow) = self.idx.overflowing_add(n);
268        if end >= self.len || overflow {
269            self.idx = self.len;
270            None
271        } else {
272            self.idx = end + 1;
273            Some(AUDIO_FORMATS_ALL[end])
274        }
275    }
276
277    fn last(self) -> Option<Self::Item> {
278        if self.idx == self.len {
279            None
280        } else {
281            Some(AUDIO_FORMATS_ALL[self.len - 1])
282        }
283    }
284}
285
286impl ExactSizeIterator for AudioFormatIterator {}
287
288impl std::iter::FusedIterator for AudioFormatIterator {}
289
290impl DoubleEndedIterator for AudioFormatIterator {
291    fn next_back(&mut self) -> Option<Self::Item> {
292        if self.idx >= self.len {
293            None
294        } else {
295            self.len -= 1;
296            let fmt = AUDIO_FORMATS_ALL[self.len];
297            Some(fmt)
298        }
299    }
300
301    fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
302        let (end, overflow) = self.len.overflowing_sub(n);
303        if end <= self.idx || overflow {
304            self.idx = self.len;
305            None
306        } else {
307            self.len = end - 1;
308            let fmt = AUDIO_FORMATS_ALL[self.len];
309            Some(fmt)
310        }
311    }
312}
313pub trait AudioFormatIteratorExt {
314    fn into_audio_caps(
315        self,
316        layout: crate::AudioLayout,
317    ) -> Option<crate::AudioCapsBuilder<gst::caps::NoFeature>>;
318}
319
320impl<T> AudioFormatIteratorExt for T
321where
322    T: Iterator<Item = crate::AudioFormat>,
323{
324    fn into_audio_caps(
325        self,
326        layout: crate::AudioLayout,
327    ) -> Option<crate::AudioCapsBuilder<gst::caps::NoFeature>> {
328        let formats: Vec<crate::AudioFormat> = self.collect();
329        if !formats.is_empty() {
330            Some(crate::functions::audio_make_raw_caps(&formats, layout))
331        } else {
332            None
333        }
334    }
335}
336
337pub trait AudioFormatIteratorExtRef {
338    fn into_audio_caps(
339        self,
340        layout: crate::AudioLayout,
341    ) -> Option<crate::AudioCapsBuilder<gst::caps::NoFeature>>;
342}
343
344impl<'a, T> AudioFormatIteratorExtRef for T
345where
346    T: Iterator<Item = &'a crate::AudioFormat>,
347{
348    fn into_audio_caps(
349        self,
350        layout: crate::AudioLayout,
351    ) -> Option<crate::AudioCapsBuilder<gst::caps::NoFeature>> {
352        let formats: Vec<crate::AudioFormat> = self.copied().collect();
353        if !formats.is_empty() {
354            Some(crate::functions::audio_make_raw_caps(&formats, layout))
355        } else {
356            None
357        }
358    }
359}
360
361#[cfg(test)]
362mod tests {
363    use itertools::Itertools;
364
365    #[test]
366    fn test_display() {
367        gst::init().unwrap();
368
369        assert_eq!(format!("{}", crate::AudioFormat::S16be), "S16BE");
370        assert_eq!(format!("{:?}", crate::AudioFormat::S16be), "S16be");
371    }
372
373    #[test]
374    fn iter() {
375        use super::*;
376        gst::init().unwrap();
377
378        assert!(crate::AudioFormat::iter_raw().count() > 0);
379        assert_eq!(
380            crate::AudioFormat::iter_raw().count(),
381            crate::AudioFormat::iter_raw().len()
382        );
383
384        let mut i = crate::AudioFormat::iter_raw();
385        let mut count = 0;
386        loop {
387            if i.next().is_none() {
388                break;
389            }
390            count += 1;
391            if i.next_back().is_none() {
392                break;
393            }
394            count += 1;
395        }
396        assert_eq!(count, crate::AudioFormat::iter_raw().len());
397
398        assert!(crate::AudioFormat::iter_raw().any(|f| f == crate::AudioFormat::F64be));
399        assert!(!crate::AudioFormat::iter_raw().any(|f| f == crate::AudioFormat::Encoded));
400
401        let caps = crate::AudioFormat::iter_raw().into_audio_caps(crate::AudioLayout::Interleaved);
402        assert!(caps.is_some());
403
404        let caps = crate::AudioFormat::iter_raw()
405            .filter(|f| crate::AudioFormatInfo::from_format(*f).is_little_endian())
406            .into_audio_caps(crate::AudioLayout::Interleaved);
407        assert!(caps.is_some());
408
409        let caps = crate::AudioFormat::iter_raw()
410            .skip(1000)
411            .into_audio_caps(crate::AudioLayout::Interleaved);
412        assert!(caps.is_none());
413
414        let caps = [crate::AudioFormat::S16le, crate::AudioFormat::S16be]
415            .iter()
416            .into_audio_caps(crate::AudioLayout::Interleaved)
417            .unwrap()
418            .build();
419        assert_eq!(caps.to_string(), "audio/x-raw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved, format=(string){ S16LE, S16BE }");
420    }
421
422    #[test]
423    fn sort() {
424        gst::init().unwrap();
425
426        assert!(
427            crate::AudioFormatInfo::from_format(crate::AudioFormat::F64be)
428                > crate::AudioFormatInfo::from_format(crate::AudioFormat::U8)
429        );
430        assert!(crate::AudioFormat::S20be > crate::AudioFormat::S18be);
431
432        let sorted: Vec<crate::AudioFormat> =
433            crate::AudioFormat::iter_raw().sorted().rev().collect();
434        // FIXME: use is_sorted_by() once API is in stable
435        assert_eq!(
436            sorted,
437            crate::AudioFormat::iter_raw().collect::<Vec<crate::AudioFormat>>()
438        );
439    }
440}
gstreamer_audio/audio_format.rs

gstreamer_audio/
audio_format.rs
