Struct ChannelLayout

Source
pub struct ChannelLayout { /* private fields */ }

Implementations§

Source§

impl ChannelLayout

Source

pub const FRONT_LEFT: Self

Source

pub const FRONT_RIGHT: Self

Source

pub const FRONT_CENTER: Self

Source

pub const LOW_FREQUENCY: Self

Source

pub const BACK_LEFT: Self

Source

pub const BACK_RIGHT: Self

Source

pub const FRONT_LEFT_OF_CENTER: Self

Source

pub const FRONT_RIGHT_OF_CENTER: Self

Source

pub const BACK_CENTER: Self

Source

pub const SIDE_LEFT: Self

Source

pub const SIDE_RIGHT: Self

Source

pub const TOP_CENTER: Self

Source

pub const TOP_FRONT_LEFT: Self

Source

pub const TOP_FRONT_CENTER: Self

Source

pub const TOP_FRONT_RIGHT: Self

Source

pub const TOP_BACK_LEFT: Self

Source

pub const TOP_BACK_CENTER: Self

Source

pub const TOP_BACK_RIGHT: Self

Source

pub const STEREO_LEFT: Self

Source

pub const STEREO_RIGHT: Self

Source

pub const WIDE_LEFT: Self

Source

pub const WIDE_RIGHT: Self

Source

pub const SURROUND_DIRECT_LEFT: Self

Source

pub const SURROUND_DIRECT_RIGHT: Self

Source

pub const LOW_FREQUENCY_2: Self

Source

pub const NATIVE: Self

Source

pub const MONO: Self

Source

pub const STEREO: Self

Source

pub const _2POINT1: Self

Source

pub const _2_1: Self

Source

pub const SURROUND: Self

Source

pub const _3POINT1: Self

Source

pub const _4POINT0: Self

Source

pub const _4POINT1: Self

Source

pub const _2_2: Self

Source

pub const QUAD: Self

Source

pub const _5POINT0: Self

Source

pub const _5POINT1: Self

Source

pub const _5POINT0_BACK: Self

Source

pub const _5POINT1_BACK: Self

Source

pub const _6POINT0: Self

Source

pub const _6POINT0_FRONT: Self

Source

pub const HEXAGONAL: Self

Source

pub const _6POINT1: Self

Source

pub const _6POINT1_BACK: Self

Source

pub const _6POINT1_FRONT: Self

Source

pub const _7POINT0: Self

Source

pub const _7POINT0_FRONT: Self

Source

pub const _7POINT1: Self

Source

pub const _7POINT1_WIDE: Self

Source

pub const _7POINT1_WIDE_BACK: Self

Source

pub const OCTAGONAL: Self

Source

pub const HEXADECAGONAL: Self

Source

pub const STEREO_DOWNMIX: Self

Source

pub const fn empty() -> Self

Returns an empty set of flags.

Source

pub const fn all() -> Self

Returns the set containing all flags.

Source

pub const fn bits(&self) -> c_ulonglong

Returns the raw value of the flags currently stored.

Examples found in repository?
examples/transcode-audio.rs (line 20)
8fn filter(
9    spec: &str,
10    decoder: &codec::decoder::Audio,
11    encoder: &codec::encoder::Audio,
12) -> Result<filter::Graph, ffmpeg_rs::Error> {
13    let mut filter = filter::Graph::new();
14
15    let args = format!(
16        "time_base={}:sample_rate={}:sample_fmt={}:channel_layout=0x{:x}",
17        decoder.time_base(),
18        decoder.rate(),
19        decoder.format().name(),
20        decoder.channel_layout().bits()
21    );
22
23    filter.add(&filter::find("abuffer").unwrap(), "in", &args)?;
24    filter.add(&filter::find("abuffersink").unwrap(), "out", "")?;
25
26    {
27        let mut out = filter.get("out").unwrap();
28
29        out.set_sample_format(encoder.format());
30        out.set_channel_layout(encoder.channel_layout());
31        out.set_sample_rate(encoder.rate());
32    }
33
34    filter.output("in", 0)?.input("out", 0)?.parse(spec)?;
35    filter.validate()?;
36
37    println!("{}", filter.dump());
38
39    if let Some(codec) = encoder.codec() {
40        if !codec
41            .capabilities()
42            .contains(ffmpeg_rs::codec::capabilities::Capabilities::VARIABLE_FRAME_SIZE)
43        {
44            filter
45                .get("out")
46                .unwrap()
47                .sink()
48                .set_frame_size(encoder.frame_size());
49        }
50    }
51
52    Ok(filter)
53}
Source

pub const fn from_bits(bits: c_ulonglong) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

Source

pub const fn from_bits_truncate(bits: c_ulonglong) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

Source

pub const unsafe fn from_bits_unchecked(bits: c_ulonglong) -> Self

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

§Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

Source

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

Source

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

Source

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

Source

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

Source

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

Source

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

Source

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

Source

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

Source

pub const fn intersection(self, other: Self) -> Self

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

Source

pub const fn union(self, other: Self) -> Self

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

Source

pub const fn difference(self, other: Self) -> Self

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

Source

pub const fn symmetric_difference(self, other: Self) -> Self

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

Source

pub const fn complement(self) -> Self

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Source§

impl ChannelLayout

Source

pub fn channels(&self) -> i32

Examples found in repository?
examples/transcode-audio.rs (line 92)
64fn transcoder<P: AsRef<Path>>(
65    ictx: &mut format::context::Input,
66    octx: &mut format::context::Output,
67    path: &P,
68    filter_spec: &str,
69) -> Result<Transcoder, ffmpeg_rs::Error> {
70    let input = ictx
71        .streams()
72        .best(media::Type::Audio)
73        .expect("could not find best audio stream");
74    let context = ffmpeg_rs::codec::context::Context::from_parameters(input.parameters())?;
75    let mut decoder = context.decoder().audio()?;
76    let codec = ffmpeg_rs::encoder::find(octx.format().codec(path, media::Type::Audio))
77        .expect("failed to find encoder")
78        .audio()?;
79    let global = octx
80        .format()
81        .flags()
82        .contains(ffmpeg_rs::format::flag::Flags::GLOBAL_HEADER);
83
84    decoder.set_parameters(input.parameters())?;
85
86    let mut output = octx.add_stream(codec)?;
87    let context = ffmpeg_rs::codec::context::Context::from_parameters(output.parameters())?;
88    let mut encoder = context.encoder().audio()?;
89
90    let channel_layout = codec
91        .channel_layouts()
92        .map(|cls| cls.best(decoder.channel_layout().channels()))
93        .unwrap_or(ffmpeg_rs::channel_layout::ChannelLayout::STEREO);
94
95    if global {
96        encoder.set_flags(ffmpeg_rs::codec::flag::Flags::GLOBAL_HEADER);
97    }
98
99    encoder.set_rate(decoder.rate() as i32);
100    encoder.set_channel_layout(channel_layout);
101    encoder.set_channels(channel_layout.channels());
102    encoder.set_format(
103        codec
104            .formats()
105            .expect("unknown supported formats")
106            .next()
107            .unwrap(),
108    );
109    encoder.set_bit_rate(decoder.bit_rate());
110    encoder.set_max_bit_rate(decoder.max_bit_rate());
111
112    encoder.set_time_base((1, decoder.rate() as i32));
113    output.set_time_base((1, decoder.rate() as i32));
114
115    let encoder = encoder.open_as(codec)?;
116    output.set_parameters(&encoder);
117
118    let filter = filter(filter_spec, &decoder, &encoder)?;
119
120    let in_time_base = decoder.time_base();
121    let out_time_base = output.time_base();
122
123    Ok(Transcoder {
124        stream: input.index(),
125        filter,
126        decoder,
127        encoder,
128        in_time_base,
129        out_time_base,
130    })
131}
Source

pub fn default(number: i32) -> ChannelLayout

Trait Implementations§

Source§

impl Binary for ChannelLayout

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl BitAnd for ChannelLayout

Source§

fn bitand(self, other: Self) -> Self

Returns the intersection between the two sets of flags.

Source§

type Output = ChannelLayout

The resulting type after applying the & operator.
Source§

impl BitAndAssign for ChannelLayout

Source§

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

Source§

impl BitOr for ChannelLayout

Source§

fn bitor(self, other: ChannelLayout) -> Self

Returns the union of the two sets of flags.

Source§

type Output = ChannelLayout

The resulting type after applying the | operator.
Source§

impl BitOrAssign for ChannelLayout

Source§

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

Source§

impl BitXor for ChannelLayout

Source§

fn bitxor(self, other: Self) -> Self

Returns the left flags, but with all the right flags toggled.

Source§

type Output = ChannelLayout

The resulting type after applying the ^ operator.
Source§

impl BitXorAssign for ChannelLayout

Source§

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

Source§

impl Clone for ChannelLayout

Source§

fn clone(&self) -> ChannelLayout

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ChannelLayout

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Extend<ChannelLayout> for ChannelLayout

Source§

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl FromIterator<ChannelLayout> for ChannelLayout

Source§

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator. Read more
Source§

impl Hash for ChannelLayout

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl LowerHex for ChannelLayout

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Not for ChannelLayout

Source§

fn not(self) -> Self

Returns the complement of this set of flags.

Source§

type Output = ChannelLayout

The resulting type after applying the ! operator.
Source§

impl Octal for ChannelLayout

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Ord for ChannelLayout

Source§

fn cmp(&self, other: &ChannelLayout) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for ChannelLayout

Source§

fn eq(&self, other: &ChannelLayout) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for ChannelLayout

Source§

fn partial_cmp(&self, other: &ChannelLayout) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Sub for ChannelLayout

Source§

fn sub(self, other: Self) -> Self

Returns the set difference of the two sets of flags.

Source§

type Output = ChannelLayout

The resulting type after applying the - operator.
Source§

impl SubAssign for ChannelLayout

Source§

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

Source§

impl UpperHex for ChannelLayout

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Copy for ChannelLayout

Source§

impl Eq for ChannelLayout

Source§

impl StructuralPartialEq for ChannelLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.