pub enum YuvPixelLayout {
    Y_U_V444 = 0,
    Y_U_V422 = 1,
    Y_U_V420 = 2,
    Y_UV420 = 100,
    YUYV422 = 200,
    Y400 = 300,
}
Expand description

Supported chroma subsampling input formats.

We use YUV/YCbCr/YPbPr interchangeably and usually just call it YUV.

According to this source:

  • YUV is an analog signal
  • YCbCr is scaled and offsetted version of YUV, used in digital signals (we denote this as “limited range YUV”)
  • YPbPr is the physical component cabel to transmit YCbCr Actual use in the wild seems to be all over the place. For instance OpenCV uses YCbCr when talking about the full range and YUV when talking about limited range. Source:

RGB <-> YCrCb JPEG […] Y, Cr, and Cb cover the whole value range. RGB <-> YUV with subsampling […] with resulting values Y [16, 235], U and V [16, 240] centered at 128.

For more on YUV ranges see YuvRange.

Naming schema:

  • every time a plane starts add a _
  • end with 4xy for 4:x:y subsampling.

This picture gives a great overview of how to interpret the 4:x:y naming scheme for subsampling: https://en.wikipedia.org/wiki/Chroma_subsampling#Sampling_systems_and_ratios/

Keep indices in sync with yuv_converter.wgsl

Variants§

§

Y_U_V444 = 0

4:4:4 no chroma downsampling with 3 separate planes. Also known as I444

Expects single channel data texture format.

           width
         __________
         |         |
height   |    Y    |
         |         |
         |_________|
         |         |
height   |    U    |
         |         |
         |_________|
         |         |
height   |    V    |
         |         |
         |_________|
§

Y_U_V422 = 1

4:2:2 subsampling with 3 separate planes. Also known as I422

Expects single channel data texture format.

Each data texture row in U & V section contains two rows of U/V respectively, since there’s a total of (width/2) * (height/2) U & V samples

           width
         __________
         |         |
height   |    Y    |
         |         |
         |_________|
height/2 |    U    |
         |_________|
height/2 |    V    |
         |_________|
§

Y_U_V420 = 2

4:2:0 subsampling with 3 separate planes. Also known as I420

Expects single channel data texture format.

Each data texture row in U & V section contains two rows of U/V respectively, since there’s a total of (width/2) * height U & V samples

           width
         __________
         |         |
height   |    Y    |
         |         |
         |_________|
height/4 |___◌̲U____|
height/4 |___◌̲V____|
§

Y_UV420 = 100

4:2:0 subsampling with a separate Y plane, followed by a UV plane. Also known as NV12 (although NV12 usually also implies the limited range).

Expects single channel data texture format.

First comes entire image in Y in one plane, followed by a plane with interleaved lines ordered as U0, V0, U1, V1, etc.

         width
         __________
         |         |
height   |    Y    |
         |         |
         |_________|
height/2 | U,V,U,… |
         |_________|
§

YUYV422 = 200

YUV 4:2:2 subsampling, single plane.

Expects single channel data texture format.

The order of the channels is Y0, U0, Y1, V0, all in the same plane.

            width * 2
       __________________
       |                 |
height | Y0, U0, Y1, V0… |
       |_________________|
§

Y400 = 300

4:0:0, single plane of chroma only. Also known as I400

Expects single channel data texture format.

Note that we still convert this to RGBA, for convenience.

            width
         __________
         |         |
height   |    Y    |
         |         |
         |_________|

Implementations§

source§

impl YuvPixelLayout

source

pub fn data_texture_width_height( &self, [decoded_width, decoded_height]: [u32; 2] ) -> [u32; 2]

Given the dimensions of the output picture, what are the expected dimensions of the input data texture.

source

pub fn data_texture_format(&self) -> TextureFormat

What format the input data texture is expected to be in.

source

pub fn num_data_buffer_bytes(&self, decoded_width: [u32; 2]) -> usize

Size of the buffer needed to create the data texture, i.e. the raw input data.

Trait Implementations§

source§

impl Clone for YuvPixelLayout

source§

fn clone(&self) -> YuvPixelLayout

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 YuvPixelLayout

source§

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

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

impl Display for YuvPixelLayout

source§

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

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

impl Copy for YuvPixelLayout

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

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

source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

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

§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
source§

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

§

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> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

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

§

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>,

§

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,