io.humble.video

Class PixelFormatDescriptor

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.PixelFormatDescriptor

public class PixelFormatDescriptor
extends RefCounted

Descriptor that unambiguously describes how the bits of a pixel are
stored in the up to 4 data planes of an image. It also stores the
subsampling factors and number of components.

Note: This is separate of the colorspace (RGB, YCbCr, YPbPr, JPEG-style YUV
and all the YUV variants) AVPixFmtDescriptor just stores how values
are stored not what these values represent.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PixelFormatDescriptor.Flag

Method Summary

Modifier and Type	Method and Description
PixelFormatDescriptor	copyReference() Create a new PixelFormatDescriptor object that is actually referring to the exact same underlying native object.
boolean	equals(Object obj) Compares two values, returning true if the underlying objects in native code are the same object.
int	getBitsPerPixel() Return the number of bits per pixel used by the pixel format described by pixdesc.
PixelComponentDescriptor	getComponentDescriptor(int component) Parameters that describe how pixels are packed. If the format has 2 or 4 components, then alpha is last. If the format has 1 or 2 components, then luma is 0. If the format has 3 or 4 components, if the RGB flag is set then 0 is red, 1 is green and 2 is blue; otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V.
boolean	getFlag(PixelFormatDescriptor.Flag flag) Is the given flag set on this format?
short	getFlags() Get the flags for this Pixel Format.
PixelFormat.Type	getFormat()
short	getLog2ChromaHeight() Amount to shift the luma height right to find the chroma height. For YV12 this is 1 for example. chroma_height= -((-luma_height) >> log2_chroma_h) The note above is needed to ensure rounding up. This value only refers to the chroma components.
short	getLog2ChromaWidth() Amount to shift the luma width right to find the chroma width. For YV12 this is 1 for example. chroma_width = -((-luma_width) >> log2_chroma_w) The note above is needed to ensure rounding up. This value only refers to the chroma components.
String	getName() Get the name of this pixel descriptor
short	getNumComponents() The number of components each pixel has, (1-4)
int	getPaddedBitsPerPixel() Return the number of bits per pixel for the pixel format described by pixdesc, including any padding or unused bits.
int	hashCode() Get a hashable value for this object.

Methods inherited from class io.humble.ferry.RefCounted

delete, getCurrentRefCount

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

copyReference

public PixelFormatDescriptor copyReference()

Create a new PixelFormatDescriptor object that is actually referring to the exact same underlying native object.

Overrides:

copyReference in class RefCounted

Returns:

the new Java object.

equals

public boolean equals(Object obj)

Compares two values, returning true if the underlying objects in native code are the same object. That means you can have two different Java objects, but when you do a comparison, you'll find out they are the EXACT same object.

Overrides:

equals in class Object

Returns:

True if the underlying native object is the same. False otherwise.

hashCode

public int hashCode()

Get a hashable value for this object.

Overrides:

hashCode in class Object

Returns:

the hashable value.

getName

public String getName()

Get the name of this pixel descriptor

getNumComponents

public short getNumComponents()

The number of components each pixel has, (1-4)

getLog2ChromaWidth

public short getLog2ChromaWidth()

Amount to shift the luma width right to find the chroma width.
For YV12 this is 1 for example.
chroma_width = -((-luma_width) >> log2_chroma_w)
The note above is needed to ensure rounding up.
This value only refers to the chroma components.

getLog2ChromaHeight

public short getLog2ChromaHeight()

Amount to shift the luma height right to find the chroma height.
For YV12 this is 1 for example.
chroma_height= -((-luma_height) >> log2_chroma_h)
The note above is needed to ensure rounding up.
This value only refers to the chroma components.

getFlags

public short getFlags()

Get the flags for this Pixel Format. This is a bitmask of the PixelFormatDescriptor.Flag enum values.

getFlag

public boolean getFlag(PixelFormatDescriptor.Flag flag)

Is the given flag set on this format?

getBitsPerPixel

public int getBitsPerPixel()

Return the number of bits per pixel used by the pixel format
described by pixdesc. Note that this is not the same as the number
of bits per sample.

The returned number of bits refers to the number of bits actually
used for storing the pixel information, that is padding bits are
not counted.

getPaddedBitsPerPixel

public int getPaddedBitsPerPixel()

Return the number of bits per pixel for the pixel format
described by pixdesc, including any padding or unused bits.

getComponentDescriptor

public PixelComponentDescriptor getComponentDescriptor(int component)

Parameters that describe how pixels are packed.
If the format has 2 or 4 components, then alpha is last.
If the format has 1 or 2 components, then luma is 0.
If the format has 3 or 4 components,
if the RGB flag is set then 0 is red, 1 is green and 2 is blue;
otherwise 0 is luma, 1 is chroma-U and 2 is chroma-V.

getFormat

public PixelFormat.Type getFormat()

Returns:

an PixelFormat id described by desc, or PixelFormat.Type.PIX_FMT_NONE if desc
is not a valid pointer to a pixel format descriptor.