io.humble.video

Class PixelFormat

java.lang.Object

io.humble.ferry.RefCounted

io.humble.video.PixelFormat

public class PixelFormat
extends RefCounted

Picture formats and various static member functions for getting
meta data about them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PixelFormat.Type Pixel format. Note: PIX_FMT_RGB32 is handled in an endian-specific manner.

Method Summary

Modifier and Type	Method and Description
PixelFormat	copyReference() Create a new PixelFormat 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.
static int	getBufferSizeNeeded(int width, int height, PixelFormat.Type pix_fmt) Find the buffer size that would be necessary to store an image with the given qualities.
static PixelFormatDescriptor	getDescriptor(PixelFormat.Type pix_fmt)
static PixelFormat.Type	getFormat(String name) Return the pixel format corresponding to name. If there is no pixel format with name name, then looks for a pixel format with the name corresponding to the native endian format of name. For example in a little-endian system, first looks for "gray16", then for "gray16le". Finally if no pixel format has been found, returns AV_PIX_FMT_NONE.
static String	getFormatName(PixelFormat.Type pix_fmt) Return the short name for a pixel format, NULL in case pix_fmt is unknown.
static PixelFormatDescriptor	getInstalledFormatDescriptor(int i) Returns the 'i'th pixel format descriptor that is known to humble video
static int	getNumInstalledFormats() Returns the total number of pixel format descriptors known to humble video.
static int	getNumPlanes(PixelFormat.Type pix_fmt)
int	hashCode() Get a hashable value for this object.
static PixelFormat.Type	swapEndianness(PixelFormat.Type pix_fmt) Utility function to swap the endianness of a pixel format. pix_fmt the pixel format

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 PixelFormat copyReference()

Create a new PixelFormat 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.

getFormat

public static PixelFormat.Type getFormat(String name)

Return the pixel format corresponding to name.

If there is no pixel format with name name, then looks for a
pixel format with the name corresponding to the native endian
format of name.
For example in a little-endian system, first looks for "gray16",
then for "gray16le".

Finally if no pixel format has been found, returns AV_PIX_FMT_NONE.

getFormatName

public static String getFormatName(PixelFormat.Type pix_fmt)

Return the short name for a pixel format, NULL in case pix_fmt is
unknown.

getDescriptor

public static PixelFormatDescriptor getDescriptor(PixelFormat.Type pix_fmt)

Returns:

a pixel format descriptor for provided pixel format or NULL if
this pixel format is unknown.

getNumInstalledFormats

public static int getNumInstalledFormats()

Returns the total number of pixel format descriptors known to humble video.

getInstalledFormatDescriptor

public static PixelFormatDescriptor getInstalledFormatDescriptor(int i)

Returns the 'i'th pixel format descriptor that is known to humble video

Parameters:

i - The i'th pixel format descriptor in the list of installed descriptors.

getNumPlanes

public static int getNumPlanes(PixelFormat.Type pix_fmt)

Returns:

number of planes in pix_fmt, a negative ERROR if pix_fmt is not a
valid pixel format.

swapEndianness

public static PixelFormat.Type swapEndianness(PixelFormat.Type pix_fmt)

Utility function to swap the endianness of a pixel format.

pix_fmt the pixel format

Returns:

pixel format with swapped endianness if it exists,
otherwise AV_PIX_FMT_NONE

getBufferSizeNeeded

public static int getBufferSizeNeeded(int width,
                                      int height,
                                      PixelFormat.Type pix_fmt)

Find the buffer size that would be necessary to store an image
with the given qualities.