Information about how video data is formatted in an IVideoPicture object. More...

#include <IPixelFormat.h>

Inheritance diagram for com::avpkit::core::IPixelFormat:

Collaboration diagram for com::avpkit::core::IPixelFormat:

Public Types
enum	Type { NONE = -1 , YUV420P , YUYV422 , RGB24 , BGR24 , YUV422P , YUV444P , YUV410P , YUV411P , GRAY8 , MONOWHITE , MONOBLACK , PAL8 , YUVJ420P , YUVJ422P , YUVJ444P , UYVY422 , UYYVYY411 , BGR8 , BGR4 , BGR4_BYTE , RGB8 , RGB4 , RGB4_BYTE , NV12 , NV21 , ARGB , RGBA , ABGR , BGRA , GRAY16BE , GRAY16LE , YUV440P , YUVJ440P , YUVA420P , RGB48BE , RGB48LE , RGB565BE , RGB565LE , RGB555BE , RGB555LE , BGR565BE , BGR565LE , BGR555BE , BGR555LE , VAAPI , YUV420P16LE , YUV420P16BE , YUV422P16LE , YUV422P16BE , YUV444P16LE , YUV444P16BE , DXVA2_VLD , RGB444LE , RGB444BE , BGR444LE , BGR444BE , YA8 , Y400A = YA8 , GRAY8A = YA8 , BGR48BE , BGR48LE , YUV420P9BE , YUV420P9LE , YUV420P10BE , YUV420P10LE , YUV422P10BE , YUV422P10LE , YUV444P9BE , YUV444P9LE , YUV444P10BE , YUV444P10LE , YUV422P9BE , YUV422P9LE , GBRP , GBR24P = GBRP , GBRP9BE , GBRP9LE , GBRP10BE , GBRP10LE , GBRP16BE , GBRP16LE , YUVA422P , YUVA444P , YUVA420P9BE , YUVA420P9LE , YUVA422P9BE , YUVA422P9LE , YUVA444P9BE , YUVA444P9LE , YUVA420P10BE , YUVA420P10LE , YUVA422P10BE , YUVA422P10LE , YUVA444P10BE , YUVA444P10LE , YUVA420P16BE , YUVA420P16LE , YUVA422P16BE , YUVA422P16LE , YUVA444P16BE , YUVA444P16LE , VDPAU , XYZ12LE , XYZ12BE , NV16 , NV20LE , NV20BE , RGBA64BE , RGBA64LE , BGRA64BE , BGRA64LE , YVYU422 , YA16BE , YA16LE , GBRAP , GBRAP16BE , GBRAP16LE , QSV , MMAL , D3D11VA_VLD , CUDA , FMT_0RGB , RGB0 , FMT_0BGR , BGR0 , YUV420P12BE , YUV420P12LE , YUV420P14BE , YUV420P14LE , YUV422P12BE , YUV422P12LE , YUV422P14BE , YUV422P14LE , YUV444P12BE , YUV444P12LE , YUV444P14BE , YUV444P14LE , GBRP12BE , GBRP12LE , GBRP14BE , GBRP14LE , YUVJ411P , BAYER_BGGR8 , BAYER_RGGB8 , BAYER_GBRG8 , BAYER_GRBG8 , BAYER_BGGR16LE , BAYER_BGGR16BE , BAYER_RGGB16LE , BAYER_RGGB16BE , BAYER_GBRG16LE , BAYER_GBRG16BE , BAYER_GRBG16LE , BAYER_GRBG16BE , XVMC , YUV440P10LE , YUV440P10BE , YUV440P12LE , YUV440P12BE , AYUV64LE , AYUV64BE , VIDEOTOOLBOX , P010LE , P010BE , MEDIACODEC , GBRAP12BE , GBRAP12LE , GBRAP10BE , GBRAP10LE , GRAY12BE , GRAY12LE , GRAY10BE , GRAY10LE , P016LE , P016BE , D3D11 , GRAY9BE , GRAY9LE , GBRPF32BE , GBRPF32LE , GBRAPF32BE , GBRAPF32LE , DRM_PRIME , OPENCL , GRAY14BE , GRAY14LE , GRAYF32BE , GRAYF32LE , YUVA422P12BE , YUVA422P12LE , YUVA444P12BE , YUVA444P12LE , NV24 , NV42 , VULKAN , Y210BE , Y210LE , NB }
	Pixel format. More...

enum	YUVColorComponent { YUV_Y =0 , YUV_U =1 , YUV_V =2 }

typedef enum com::avpkit::core::IPixelFormat::Type	Type
	Pixel format. More...

Static Public Member Functions
static unsigned char	getYUV420PPixel (IVideoPicture *frame, int x, int y, YUVColorComponent c)
	Returns the byte for the coordinates at x and y for the color component c. More...

static void	setYUV420PPixel (IVideoPicture *frame, int x, int y, YUVColorComponent c, unsigned char value)
	Sets the value of the color component c at the coordinates x and y in the given frame. More...

static int	getYUV420PPixelOffset (IVideoPicture *frame, int x, int y, YUVColorComponent c)
	For a given x and y in a frame, and a given color components, this method tells you how far into the actual data you'd have to go to find the byte that represents that color/coordinate combination. More...

Additional Inherited Members
Public Member Functions inherited from com::avpkit::ferry::RefCounted
virtual int32_t	acquire ()
	Internal Only. More...

virtual int32_t	release ()
	Internal Only. More...

virtual RefCounted *	copyReference ()
	Create a new Java object that refers to the same native object. More...

virtual int32_t	getCurrentRefCount ()
	Return the current reference count on this object. More...

void	setJavaAllocator (void *allocator)
	This method is public but not part of the standard API. More...

void *	getJavaAllocator ()
	This method is public but not part of the standard API. More...

Protected Member Functions inherited from com::avpkit::ferry::RefCounted
virtual void	destroy ()
	This method is called by RefCounted objects when their Ref Count reaches zero and they are about to be destroyed.

Protected Attributes inherited from com::avpkit::ferry::RefCounted
AtomicInteger *	mRefCount
	This is the internal reference count, represented as an AtomicInteger to make sure it is thread safe.

void *	mAllocator
	Not part of public API.

Detailed Description

Information about how video data is formatted in an IVideoPicture object.

This specifies the color space and how many bits pixel data takes. It also includes some utility methods for dealing with Type#YUV420P data; the most common type of encoding used in video files I've run across.

Definition at line 45 of file IPixelFormat.h.

Member Typedef Documentation

◆ Type

typedef enum com::avpkit::core::IPixelFormat::Type com::avpkit::core::IPixelFormat::Type

Pixel format.

Notes:

RGB32 is handled in an endian-specific manner. A RGBA color is put together as: (A << 24) | (R << 16) | (G << 8) | B This is stored as BGRA on little endian CPU architectures and ARGB on big endian CPUs.

When the pixel format is palettized RGB (PAL8), the palettized image data is stored in AVFrame.data[0]. The palette is transported in AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is formatted the same as in RGB32 described above (i.e., it is also endian-specific). Note also that the individual RGB palette components stored in AVFrame.data[1] should be in the range 0..255. This is important as many custom PAL8 video codecs that were designed to run on the IBM VGA graphics adapter use 6-bit palette components.

Member Enumeration Documentation

◆ Type

enum com::avpkit::core::IPixelFormat::Type

Pixel format.

Notes:

RGB32 is handled in an endian-specific manner. A RGBA color is put together as: (A << 24) | (R << 16) | (G << 8) | B This is stored as BGRA on little endian CPU architectures and ARGB on big endian CPUs.

When the pixel format is palettized RGB (PAL8), the palettized image data is stored in AVFrame.data[0]. The palette is transported in AVFrame.data[1] and, is 1024 bytes long (256 4-byte entries) and is formatted the same as in RGB32 described above (i.e., it is also endian-specific). Note also that the individual RGB palette components stored in AVFrame.data[1] should be in the range 0..255. This is important as many custom PAL8 video codecs that were designed to run on the IBM VGA graphics adapter use 6-bit palette components.

Enumerator
YUV420P	planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)
YUYV422	packed YUV 4:2:2, 16bpp, Y0 Cb Y1 Cr
RGB24	packed RGB 8:8:8, 24bpp, RGBRGB...
BGR24	packed RGB 8:8:8, 24bpp, BGRBGR...
YUV422P	planar YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
YUV444P	planar YUV 4:4:4, 24bpp, (1 Cr & Cb sample per 1x1 Y samples)
YUV410P	planar YUV 4:1:0, 9bpp, (1 Cr & Cb sample per 4x4 Y samples)
YUV411P	planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples)
GRAY8	Y , 8bpp.
MONOWHITE	Y , 1bpp, 0 is white, 1 is black, in each byte pixels are ordered from the msb to the lsb.
MONOBLACK	Y , 1bpp, 0 is black, 1 is white, in each byte pixels are ordered from the msb to the lsb.
PAL8	8 bits with RGB32 palette
YUVJ420P	planar YUV 4:2:0, 12bpp, full scale (JPEG), deprecated in favor of YUV420P and setting color_range
YUVJ422P	planar YUV 4:2:2, 16bpp, full scale (JPEG), deprecated in favor of YUV422P and setting color_range
YUVJ444P	planar YUV 4:4:4, 24bpp, full scale (JPEG), deprecated in favor of YUV444P and setting color_range
UYVY422	packed YUV 4:2:2, 16bpp, Cb Y0 Cr Y1
UYYVYY411	packed YUV 4:1:1, 12bpp, Cb Y0 Y1 Cr Y2 Y3
BGR8	packed RGB 3:3:2, 8bpp, (msb)2B 3G 3R(lsb)
BGR4	packed RGB 1:2:1 bitstream, 4bpp, (msb)1B 2G 1R(lsb), a byte contains two pixels, the first pixel in the byte is the one composed by the 4 msb bits
BGR4_BYTE	packed RGB 1:2:1, 8bpp, (msb)1B 2G 1R(lsb)
RGB8	packed RGB 3:3:2, 8bpp, (msb)2R 3G 3B(lsb)
RGB4	packed RGB 1:2:1 bitstream, 4bpp, (msb)1R 2G 1B(lsb), a byte contains two pixels, the first pixel in the byte is the one composed by the 4 msb bits
RGB4_BYTE	packed RGB 1:2:1, 8bpp, (msb)1R 2G 1B(lsb)
NV12	planar YUV 4:2:0, 12bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (first byte U and the following byte V)
NV21	as above, but U and V bytes are swapped
ARGB	packed ARGB 8:8:8:8, 32bpp, ARGBARGB...
RGBA	packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
ABGR	packed ABGR 8:8:8:8, 32bpp, ABGRABGR...
BGRA	packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
GRAY16BE	Y , 16bpp, big-endian.
GRAY16LE	Y , 16bpp, little-endian.
YUV440P	planar YUV 4:4:0 (1 Cr & Cb sample per 1x2 Y samples)
YUVJ440P	planar YUV 4:4:0 full scale (JPEG), deprecated in favor of YUV440P and setting color_range
YUVA420P	planar YUV 4:2:0, 20bpp, (1 Cr & Cb sample per 2x2 Y & A samples)
RGB48BE	packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, the 2-byte value for each R/G/B component is stored as big-endian
RGB48LE	packed RGB 16:16:16, 48bpp, 16R, 16G, 16B, the 2-byte value for each R/G/B component is stored as little-endian
RGB565BE	packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), big-endian
RGB565LE	packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian
RGB555BE	packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), big-endian , X=unused/undefined
RGB555LE	packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined
BGR565BE	packed BGR 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), big-endian
BGR565LE	packed BGR 5:6:5, 16bpp, (msb) 5B 6G 5R(lsb), little-endian
BGR555BE	packed BGR 5:5:5, 16bpp, (msb)1X 5B 5G 5R(lsb), big-endian , X=unused/undefined
BGR555LE	packed BGR 5:5:5, 16bpp, (msb)1X 5B 5G 5R(lsb), little-endian, X=unused/undefined
VAAPI	Hardware acceleration through VA-API, data[3] contains a VASurfaceID.
YUV420P16LE	planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian
YUV420P16BE	planar YUV 4:2:0, 24bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian
YUV422P16LE	planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian
YUV422P16BE	planar YUV 4:2:2, 32bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian
YUV444P16LE	planar YUV 4:4:4, 48bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian
YUV444P16BE	planar YUV 4:4:4, 48bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian
DXVA2_VLD	HW decoding through DXVA2, Picture.data[3] contains a LPDIRECT3DSURFACE9 pointer.
RGB444LE	packed RGB 4:4:4, 16bpp, (msb)4X 4R 4G 4B(lsb), little-endian, X=unused/undefined
RGB444BE	packed RGB 4:4:4, 16bpp, (msb)4X 4R 4G 4B(lsb), big-endian, X=unused/undefined
BGR444LE	packed BGR 4:4:4, 16bpp, (msb)4X 4B 4G 4R(lsb), little-endian, X=unused/undefined
BGR444BE	packed BGR 4:4:4, 16bpp, (msb)4X 4B 4G 4R(lsb), big-endian, X=unused/undefined
YA8	8 bits gray, 8 bits alpha
Y400A	alias for YA8
GRAY8A	alias for YA8
BGR48BE	packed RGB 16:16:16, 48bpp, 16B, 16G, 16R, the 2-byte value for each R/G/B component is stored as big-endian
BGR48LE	packed RGB 16:16:16, 48bpp, 16B, 16G, 16R, the 2-byte value for each R/G/B component is stored as little-endian
YUV420P9BE	The following 12 formats have the disadvantage of needing 1 format for each bit depth. Notice that each 9/10 bits sample is stored in 16 bits with extra padding. If you want to support multiple bit depths, then using YUV420P16* with the bpp stored separately is better. planar YUV 4:2:0, 13.5bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian
YUV420P9LE	planar YUV 4:2:0, 13.5bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian
YUV420P10BE	planar YUV 4:2:0, 15bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian
YUV420P10LE	planar YUV 4:2:0, 15bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian
YUV422P10BE	planar YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian
YUV422P10LE	planar YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian
YUV444P9BE	planar YUV 4:4:4, 27bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian
YUV444P9LE	planar YUV 4:4:4, 27bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian
YUV444P10BE	planar YUV 4:4:4, 30bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian
YUV444P10LE	planar YUV 4:4:4, 30bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian
YUV422P9BE	planar YUV 4:2:2, 18bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian
YUV422P9LE	planar YUV 4:2:2, 18bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian
GBRP	planar GBR 4:4:4 24bpp
GBRP9BE	planar GBR 4:4:4 27bpp, big-endian
GBRP9LE	planar GBR 4:4:4 27bpp, little-endian
GBRP10BE	planar GBR 4:4:4 30bpp, big-endian
GBRP10LE	planar GBR 4:4:4 30bpp, little-endian
GBRP16BE	planar GBR 4:4:4 48bpp, big-endian
GBRP16LE	planar GBR 4:4:4 48bpp, little-endian
YUVA422P	planar YUV 4:2:2 24bpp, (1 Cr & Cb sample per 2x1 Y & A samples)
YUVA444P	planar YUV 4:4:4 32bpp, (1 Cr & Cb sample per 1x1 Y & A samples)
YUVA420P9BE	planar YUV 4:2:0 22.5bpp, (1 Cr & Cb sample per 2x2 Y & A samples), big-endian
YUVA420P9LE	planar YUV 4:2:0 22.5bpp, (1 Cr & Cb sample per 2x2 Y & A samples), little-endian
YUVA422P9BE	planar YUV 4:2:2 27bpp, (1 Cr & Cb sample per 2x1 Y & A samples), big-endian
YUVA422P9LE	planar YUV 4:2:2 27bpp, (1 Cr & Cb sample per 2x1 Y & A samples), little-endian
YUVA444P9BE	planar YUV 4:4:4 36bpp, (1 Cr & Cb sample per 1x1 Y & A samples), big-endian
YUVA444P9LE	planar YUV 4:4:4 36bpp, (1 Cr & Cb sample per 1x1 Y & A samples), little-endian
YUVA420P10BE	planar YUV 4:2:0 25bpp, (1 Cr & Cb sample per 2x2 Y & A samples, big-endian)
YUVA420P10LE	planar YUV 4:2:0 25bpp, (1 Cr & Cb sample per 2x2 Y & A samples, little-endian)
YUVA422P10BE	planar YUV 4:2:2 30bpp, (1 Cr & Cb sample per 2x1 Y & A samples, big-endian)
YUVA422P10LE	planar YUV 4:2:2 30bpp, (1 Cr & Cb sample per 2x1 Y & A samples, little-endian)
YUVA444P10BE	planar YUV 4:4:4 40bpp, (1 Cr & Cb sample per 1x1 Y & A samples, big-endian)
YUVA444P10LE	planar YUV 4:4:4 40bpp, (1 Cr & Cb sample per 1x1 Y & A samples, little-endian)
YUVA420P16BE	planar YUV 4:2:0 40bpp, (1 Cr & Cb sample per 2x2 Y & A samples, big-endian)
YUVA420P16LE	planar YUV 4:2:0 40bpp, (1 Cr & Cb sample per 2x2 Y & A samples, little-endian)
YUVA422P16BE	planar YUV 4:2:2 48bpp, (1 Cr & Cb sample per 2x1 Y & A samples, big-endian)
YUVA422P16LE	planar YUV 4:2:2 48bpp, (1 Cr & Cb sample per 2x1 Y & A samples, little-endian)
YUVA444P16BE	planar YUV 4:4:4 64bpp, (1 Cr & Cb sample per 1x1 Y & A samples, big-endian)
YUVA444P16LE	planar YUV 4:4:4 64bpp, (1 Cr & Cb sample per 1x1 Y & A samples, little-endian)
VDPAU	HW acceleration through VDPAU, Picture.data[3] contains a VdpVideoSurface.
XYZ12LE	packed XYZ 4:4:4, 36 bpp, (msb) 12X, 12Y, 12Z (lsb), the 2-byte value for each X/Y/Z is stored as little-endian, the 4 lower bits are set to 0
XYZ12BE	packed XYZ 4:4:4, 36 bpp, (msb) 12X, 12Y, 12Z (lsb), the 2-byte value for each X/Y/Z is stored as big-endian, the 4 lower bits are set to 0
NV16	interleaved chroma YUV 4:2:2, 16bpp, (1 Cr & Cb sample per 2x1 Y samples)
NV20LE	interleaved chroma YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian
NV20BE	interleaved chroma YUV 4:2:2, 20bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian
RGBA64BE	packed RGBA 16:16:16:16, 64bpp, 16R, 16G, 16B, 16A, the 2-byte value for each R/G/B/A component is stored as big-endian
RGBA64LE	packed RGBA 16:16:16:16, 64bpp, 16R, 16G, 16B, 16A, the 2-byte value for each R/G/B/A component is stored as little-endian
BGRA64BE	packed RGBA 16:16:16:16, 64bpp, 16B, 16G, 16R, 16A, the 2-byte value for each R/G/B/A component is stored as big-endian
BGRA64LE	packed RGBA 16:16:16:16, 64bpp, 16B, 16G, 16R, 16A, the 2-byte value for each R/G/B/A component is stored as little-endian
YVYU422	packed YUV 4:2:2, 16bpp, Y0 Cr Y1 Cb
YA16BE	16 bits gray, 16 bits alpha (big-endian)
YA16LE	16 bits gray, 16 bits alpha (little-endian)
GBRAP	planar GBRA 4:4:4:4 32bpp
GBRAP16BE	planar GBRA 4:4:4:4 64bpp, big-endian
GBRAP16LE	planar GBRA 4:4:4:4 64bpp, little-endian
QSV	HW acceleration through QSV, data[3] contains a pointer to the mfxFrameSurface1 structure.
MMAL	HW acceleration though MMAL, data[3] contains a pointer to the MMAL_BUFFER_HEADER_T structure.
D3D11VA_VLD	HW decoding through Direct3D11 via old API, Picture.data[3] contains a ID3D11VideoDecoderOutputView pointer.
CUDA	HW acceleration through CUDA. data[i] contain CUdeviceptr pointers exactly as for system memory frames.
FMT_0RGB	packed RGB 8:8:8, 32bpp, XRGBXRGB... X=unused/undefined
RGB0	packed RGB 8:8:8, 32bpp, RGBXRGBX... X=unused/undefined
FMT_0BGR	packed BGR 8:8:8, 32bpp, XBGRXBGR... X=unused/undefined
BGR0	packed BGR 8:8:8, 32bpp, BGRXBGRX... X=unused/undefined
YUV420P12BE	planar YUV 4:2:0,18bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian
YUV420P12LE	planar YUV 4:2:0,18bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian
YUV420P14BE	planar YUV 4:2:0,21bpp, (1 Cr & Cb sample per 2x2 Y samples), big-endian
YUV420P14LE	planar YUV 4:2:0,21bpp, (1 Cr & Cb sample per 2x2 Y samples), little-endian
YUV422P12BE	planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian
YUV422P12LE	planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian
YUV422P14BE	planar YUV 4:2:2,28bpp, (1 Cr & Cb sample per 2x1 Y samples), big-endian
YUV422P14LE	planar YUV 4:2:2,28bpp, (1 Cr & Cb sample per 2x1 Y samples), little-endian
YUV444P12BE	planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian
YUV444P12LE	planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian
YUV444P14BE	planar YUV 4:4:4,42bpp, (1 Cr & Cb sample per 1x1 Y samples), big-endian
YUV444P14LE	planar YUV 4:4:4,42bpp, (1 Cr & Cb sample per 1x1 Y samples), little-endian
GBRP12BE	planar GBR 4:4:4 36bpp, big-endian
GBRP12LE	planar GBR 4:4:4 36bpp, little-endian
GBRP14BE	planar GBR 4:4:4 42bpp, big-endian
GBRP14LE	planar GBR 4:4:4 42bpp, little-endian
YUVJ411P	planar YUV 4:1:1, 12bpp, (1 Cr & Cb sample per 4x1 Y samples) full scale (JPEG), deprecated in favor of YUV411P and setting color_range
BAYER_BGGR8	bayer, BGBG..(odd line), GRGR..(even line), 8-bit samples
BAYER_RGGB8	bayer, RGRG..(odd line), GBGB..(even line), 8-bit samples
BAYER_GBRG8	bayer, GBGB..(odd line), RGRG..(even line), 8-bit samples
BAYER_GRBG8	bayer, GRGR..(odd line), BGBG..(even line), 8-bit samples
BAYER_BGGR16LE	bayer, BGBG..(odd line), GRGR..(even line), 16-bit samples, little-endian
BAYER_BGGR16BE	bayer, BGBG..(odd line), GRGR..(even line), 16-bit samples, big-endian
BAYER_RGGB16LE	bayer, RGRG..(odd line), GBGB..(even line), 16-bit samples, little-endian
BAYER_RGGB16BE	bayer, RGRG..(odd line), GBGB..(even line), 16-bit samples, big-endian
BAYER_GBRG16LE	bayer, GBGB..(odd line), RGRG..(even line), 16-bit samples, little-endian
BAYER_GBRG16BE	bayer, GBGB..(odd line), RGRG..(even line), 16-bit samples, big-endian
BAYER_GRBG16LE	bayer, GRGR..(odd line), BGBG..(even line), 16-bit samples, little-endian
BAYER_GRBG16BE	bayer, GRGR..(odd line), BGBG..(even line), 16-bit samples, big-endian
XVMC	XVideo Motion Acceleration via common packet passing.
YUV440P10LE	planar YUV 4:4:0,20bpp, (1 Cr & Cb sample per 1x2 Y samples), little-endian
YUV440P10BE	planar YUV 4:4:0,20bpp, (1 Cr & Cb sample per 1x2 Y samples), big-endian
YUV440P12LE	planar YUV 4:4:0,24bpp, (1 Cr & Cb sample per 1x2 Y samples), little-endian
YUV440P12BE	planar YUV 4:4:0,24bpp, (1 Cr & Cb sample per 1x2 Y samples), big-endian
AYUV64LE	packed AYUV 4:4:4,64bpp (1 Cr & Cb sample per 1x1 Y & A samples), little-endian
AYUV64BE	packed AYUV 4:4:4,64bpp (1 Cr & Cb sample per 1x1 Y & A samples), big-endian
VIDEOTOOLBOX	hardware decoding through Videotoolbox
P010LE	like NV12, with 10bpp per component, data in the high bits, zeros in the low bits, little-endian
P010BE	like NV12, with 10bpp per component, data in the high bits, zeros in the low bits, big-endian
MEDIACODEC	HW decoding through Android MediaCodec
GBRAP12BE	planar GBR 4:4:4:4 48bpp, big-endian
GBRAP12LE	planar GBR 4:4:4:4 48bpp, little-endian
GBRAP10BE	planar GBR 4:4:4:4 40bpp, big-endian
GBRAP10LE	planar GBR 4:4:4:4 40bpp, little-endian
GRAY12BE	Y , 12bpp, big-endian.
GRAY12LE	Y , 12bpp, little-endian.
GRAY10BE	Y , 10bpp, big-endian.
GRAY10LE	Y , 10bpp, little-endian.
P016LE	like NV12, with 16bpp per component, little-endian
P016BE	like NV12, with 16bpp per component, big-endian
D3D11	Hardware surfaces for Direct3D11. This is preferred over the legacy D3D11VA_VLD. The new D3D11 hwaccel API and filtering support D3D11 only. data[0] contains a ID3D11Texture2D pointer, and data[1] contains the texture array index of the frame as intptr_t if the ID3D11Texture2D is an array texture (or always 0 if it's a normal texture).
GRAY9BE	Y , 9bpp, big-endian.
GRAY9LE	Y , 9bpp, little-endian.
GBRPF32BE	IEEE-754 single precision planar GBR 4:4:4, 96bpp, big-endian.
GBRPF32LE	IEEE-754 single precision planar GBR 4:4:4, 96bpp, little-endian.
GBRAPF32BE	IEEE-754 single precision planar GBRA 4:4:4:4, 128bpp, big-endian.
GBRAPF32LE	IEEE-754 single precision planar GBRA 4:4:4:4, 128bpp, little-endian.
DRM_PRIME	DRM-managed buffers exposed through PRIME buffer sharing. data[0] points to an AVDRMFrameDescriptor.
OPENCL	Hardware surfaces for OpenCL. data[i] contain 2D image objects (typed in C as cl_mem, used in OpenCL as image2d_t) for each plane of the surface.
GRAY14BE	Y , 14bpp, big-endian.
GRAY14LE	Y , 14bpp, little-endian.
GRAYF32BE	IEEE-754 single precision Y, 32bpp, big-endian.
GRAYF32LE	IEEE-754 single precision Y, 32bpp, little-endian.
YUVA422P12BE	planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), 12b alpha, big-endian
YUVA422P12LE	planar YUV 4:2:2,24bpp, (1 Cr & Cb sample per 2x1 Y samples), 12b alpha, little-endian
YUVA444P12BE	planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), 12b alpha, big-endian
YUVA444P12LE	planar YUV 4:4:4,36bpp, (1 Cr & Cb sample per 1x1 Y samples), 12b alpha, little-endian
NV24	planar YUV 4:4:4, 24bpp, 1 plane for Y and 1 plane for the UV components, which are interleaved (first byte U and the following byte V)
NV42	as above, but U and V bytes are swapped
VULKAN	Vulkan hardware images. data[0] points to an AVVkFrame
Y210BE	packed YUV 4:2:2 like YUYV422, 20bpp, data in the high bits, big-endian
Y210LE	packed YUV 4:2:2 like YUYV422, 20bpp, data in the high bits, little-endian
NB	number of pixel formats, DO NOT USE THIS if you want to link with shared libav* because the number of formats might differ between versions

Definition at line 65 of file IPixelFormat.h.

                       {
         NONE = -1,
         YUV420P,   
         YUYV422,   
         RGB24,     
         BGR24,     
         YUV422P,   
         YUV444P,   
         YUV410P,   
         YUV411P,   
         GRAY8,     
         MONOWHITE, 
         MONOBLACK, 
         PAL8,      
         YUVJ420P,  
         YUVJ422P,  
         YUVJ444P,  
         UYVY422,   
         UYYVYY411, 
         BGR8,      
         BGR4,      
         BGR4_BYTE, 
         RGB8,      
         RGB4,      
         RGB4_BYTE, 
         NV12,      
         NV21,      
  
         ARGB,      
         RGBA,      
         ABGR,      
         BGRA,      
  
         GRAY16BE,  
         GRAY16LE,  
         YUV440P,   
         YUVJ440P,  
         YUVA420P,  
         RGB48BE,   
         RGB48LE,   
  
         RGB565BE,  
         RGB565LE,  
         RGB555BE,  
         RGB555LE,  
  
         BGR565BE,  
         BGR565LE,  
         BGR555BE,  
         BGR555LE,  
  
     #if FF_API_VAAPI
         VAAPI_MOCO, 
         VAAPI_IDCT, 
         VAAPI_VLD,  
         VAAPI = VAAPI_VLD,
     #else
         VAAPI,
     #endif
  
         YUV420P16LE,  
         YUV420P16BE,  
         YUV422P16LE,  
         YUV422P16BE,  
         YUV444P16LE,  
         YUV444P16BE,  
         DXVA2_VLD,    
  
         RGB444LE,  
         RGB444BE,  
         BGR444LE,  
         BGR444BE,  
         YA8,       
  
         Y400A = YA8, 
         GRAY8A= YA8, 
  
         BGR48BE,   
         BGR48LE,   
  
         YUV420P9BE, 
         YUV420P9LE, 
         YUV420P10BE,
         YUV420P10LE,
         YUV422P10BE,
         YUV422P10LE,
         YUV444P9BE, 
         YUV444P9LE, 
         YUV444P10BE,
         YUV444P10LE,
         YUV422P9BE, 
         YUV422P9LE, 
         GBRP,      
         GBR24P = GBRP, // alias for #GBRP
         GBRP9BE,   
         GBRP9LE,   
         GBRP10BE,  
         GBRP10LE,  
         GBRP16BE,  
         GBRP16LE,  
         YUVA422P,  
         YUVA444P,  
         YUVA420P9BE,  
         YUVA420P9LE,  
         YUVA422P9BE,  
         YUVA422P9LE,  
         YUVA444P9BE,  
         YUVA444P9LE,  
         YUVA420P10BE, 
         YUVA420P10LE, 
         YUVA422P10BE, 
         YUVA422P10LE, 
         YUVA444P10BE, 
         YUVA444P10LE, 
         YUVA420P16BE, 
         YUVA420P16LE, 
         YUVA422P16BE, 
         YUVA422P16LE, 
         YUVA444P16BE, 
         YUVA444P16LE, 
  
         VDPAU,     
  
         XYZ12LE,      
         XYZ12BE,      
         NV16,         
         NV20LE,       
         NV20BE,       
  
         RGBA64BE,     
         RGBA64LE,     
         BGRA64BE,     
         BGRA64LE,     
  
         YVYU422,   
  
         YA16BE,       
         YA16LE,       
  
         GBRAP,        
         GBRAP16BE,    
         GBRAP16LE,    
         QSV,
         MMAL,
  
         D3D11VA_VLD,  
  
         CUDA,
  
         FMT_0RGB,        
         RGB0,        
         FMT_0BGR,        
         BGR0,        
  
         YUV420P12BE, 
         YUV420P12LE, 
         YUV420P14BE, 
         YUV420P14LE, 
         YUV422P12BE, 
         YUV422P12LE, 
         YUV422P14BE, 
         YUV422P14LE, 
         YUV444P12BE, 
         YUV444P12LE, 
         YUV444P14BE, 
         YUV444P14LE, 
         GBRP12BE,    
         GBRP12LE,    
         GBRP14BE,    
         GBRP14LE,    
         YUVJ411P,    
  
         BAYER_BGGR8,    
         BAYER_RGGB8,    
         BAYER_GBRG8,    
         BAYER_GRBG8,    
         BAYER_BGGR16LE, 
         BAYER_BGGR16BE, 
         BAYER_RGGB16LE, 
         BAYER_RGGB16BE, 
         BAYER_GBRG16LE, 
         BAYER_GBRG16BE, 
         BAYER_GRBG16LE, 
         BAYER_GRBG16BE, 
  
         XVMC,
  
         YUV440P10LE, 
         YUV440P10BE, 
         YUV440P12LE, 
         YUV440P12BE, 
         AYUV64LE,    
         AYUV64BE,    
  
         VIDEOTOOLBOX, 
  
         P010LE, 
         P010BE, 
  
         MEDIACODEC, 
  
         GBRAP12BE,  
         GBRAP12LE,  
  
         GBRAP10BE,  
         GBRAP10LE,  
  
         GRAY12BE,   
         GRAY12LE,   
         GRAY10BE,   
         GRAY10LE,   
  
         P016LE, 
         P016BE, 
  
         D3D11,
  
         GRAY9BE,   
         GRAY9LE,   
  
         GBRPF32BE,  
         GBRPF32LE,  
         GBRAPF32BE, 
         GBRAPF32LE, 
  
         DRM_PRIME,
         OPENCL,
  
         GRAY14BE,   
         GRAY14LE,   
  
         GRAYF32BE,  
         GRAYF32LE,  
  
         YUVA422P12BE, 
         YUVA422P12LE, 
         YUVA444P12BE, 
         YUVA444P12LE, 
  
         NV24,      
         NV42,      
  
         VULKAN,
  
         Y210BE,    
         Y210LE,    
  
         NB         
     } Type;

Member Function Documentation

◆ getYUV420PPixel()

unsigned char com::avpkit::core::IPixelFormat::getYUV420PPixel	(	IVideoPicture *	frame,
		int	x,
		int	y,
		YUVColorComponent	c
	)

static

Returns the byte for the coordinates at x and y for the color component c.

Parameters

frame	The frame to get the byte from
x	X coordinate in pixels, where 0 is the left hand edge of the image.
y	Y coordinate in pixels, where 0 is the top edge of the image.
c	YUVColor component

Exceptions

std::exception frame is null, the coordinates are invalid, or if the pixel format is not YUV420P

Returns: the pixel byte for that x, y, c combination

Definition at line 46 of file IPixelFormat.cpp.

   {
     unsigned char result = 0;
     
     int offset = getYUV420PPixelOffset(frame, x, y, c);
     RefPointer<IBuffer> buffer = frame->getData();
     unsigned char * bytes = (unsigned char*)buffer->getBytes(0, offset+1);
     
     if (!bytes)
       throw std::runtime_error("could not find bytes in frame");
     result = bytes[offset];
     return result;
   }

References com::avpkit::core::IMediaData::getData().

◆ getYUV420PPixelOffset()

int com::avpkit::core::IPixelFormat::getYUV420PPixelOffset	(	IVideoPicture *	frame,
		int	x,
		int	y,
		YUVColorComponent	c
	)

static

For a given x and y in a frame, and a given color components, this method tells you how far into the actual data you'd have to go to find the byte that represents that color/coordinate combination.

Parameters

frame	The frame to get the byte from
x	X coordinate in pixels, where 0 is the left hand edge of the image.
y	Y coordinate in pixels, where 0 is the top edge of the image.
c	YUVColor component

Exceptions

std::exception frame is null, the coordinates are invalid, or if the pixel format is not YUV420P

Returns: the offset in bytes, starting from the start of the frame data, where the data for this pixel resides.

Definition at line 76 of file IPixelFormat.cpp.

   {
     if (!frame)
       throw std::runtime_error("no frame");
     
     int width = frame->getWidth();
     if (x < 0 || x >= width)
       throw std::runtime_error("x value invalid for input frame");
     
     int height = frame->getHeight();
     if (y < 0 || y >= height)
       throw std::runtime_error("y value invalid for input frame");
     
     if (frame->getPixelType() != YUV420P)
       throw std::runtime_error("pixel type of input frame is incorrect");
  
     int offset = PixelFormat::getFastYUV420PPixelOffset(frame->getWidth(), frame->getHeight(), x, y, c);
     VS_LOG_TRACE("w: %d; h: %d; x: %d; y: %d; c: %d; offset: %d",
         frame->getWidth(), frame->getHeight(), x, y, c, offset);
     return offset;
     
   }

References com::avpkit::core::IVideoPicture::getHeight(), com::avpkit::core::IVideoPicture::getPixelType(), and com::avpkit::core::IVideoPicture::getWidth().

◆ setYUV420PPixel()

void com::avpkit::core::IPixelFormat::setYUV420PPixel	(	IVideoPicture *	frame,
		int	x,
		int	y,
		YUVColorComponent	c,
		unsigned char	value
	)

static

Sets the value of the color component c at the coordinates x and y in the given frame.

Parameters

frame	The frame to set the byte in
x	X coordinate in pixels, where 0 is the left hand edge of the image.
y	Y coordinate in pixels, where 0 is the top edge of the image.
c	YUVColor component to set
value	The new value of that pixel color component

Exceptions

std::exception frame is null, the coordinates are invalid, or if the pixel format is not YUV420P

Definition at line 61 of file IPixelFormat.cpp.

   {
     int offset = getYUV420PPixelOffset(frame, x, y, c);
     RefPointer<IBuffer> buffer = frame->getData();
     unsigned char * bytes = (unsigned char*)buffer->getBytes(0, offset+1);
     
     if (!bytes)
     {
       VS_LOG_DEBUG("Could not find buffer of length: %d", offset+1);
       throw std::runtime_error("could not find bytes in frame");
     }
     bytes[offset] = value;
   }

References com::avpkit::core::IMediaData::getData().

The documentation for this class was generated from the following files:

csrc/com/avpkit/core/IPixelFormat.h
csrc/com/avpkit/core/IPixelFormat.cpp

Public Types

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Type

Member Enumeration Documentation

◆ Type

Member Function Documentation

◆ getYUV420PPixel()

◆ getYUV420PPixelOffset()

◆ setYUV420PPixel()