media-pp 0.1.8

A small, GStreamer-flavored media pipeline library built on FFmpeg.
Documentation 
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

use ffmpeg_next as ffmpeg;

/// A complete uncompressed-audio format description.
///
/// Unlike a `(sample_rate, channels)` tuple, this also carries the sample
/// representation, so it can be passed directly from a hardware endpoint
/// such as `WasapiCaptureSource`/`WasapiRenderer` to an
/// [`crate::elements::AudioResampler`]/[`crate::elements::SwAudioEncoder`]
/// without guessing either one. Kept directly under `elements` rather than
/// under any one of those (same reasoning as
/// [`crate::elements::RtspTransport`]/[`crate::elements::VideoFormat`]'s own
/// placement): it crosses source/filter/sink, not owned by any single one.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct AudioFormat {
    /// In-memory representation and planar/packed layout of each sample.
    pub sample_format: ffmpeg::format::Sample,
    /// Number of samples per channel per second, in hertz.
    pub sample_rate: u32,
    /// Number of interleaved or planar audio channels.
    pub channels: u16,
}

impl AudioFormat {
    /// Creates an audio format from its sample representation, rate, and channel count.
    pub fn new(sample_format: ffmpeg::format::Sample, sample_rate: u32, channels: u16) -> Self {
        Self {
            sample_format,
            sample_rate,
            channels,
        }
    }

    /// Returns the configured channel count.
    pub fn channels(self) -> u16 {
        self.channels
    }

    /// Returns FFmpeg's default channel layout for [`Self::channels`].
    pub fn channel_layout(self) -> ffmpeg::ChannelLayout {
        ffmpeg::ChannelLayout::default(i32::from(self.channels))
    }
}