Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
public class

ImageFormat

extends Object
java.lang.Object
   ↳ android.graphics.ImageFormat

Summary

Constants
int JPEG Encoded formats.
int NV16 YCbCr format, used for video.
int NV21 YCrCb format used for images, which uses the NV21 encoding format.
int RGB_565 RGB format used for pictures encoded as RGB_565.
int UNKNOWN
int YUV_420_888

Multi-plane Android YUV format

This format is a generic YCbCr format, capable of describing any 4:2:0 chroma-subsampled planar or semiplanar buffer (but not fully interleaved), with 8 bits per color sample.

int YUY2 YCbCr format used for images, which uses YUYV (YUY2) encoding format.
int YV12

Android YUV format.

Public Constructors
ImageFormat ()
Public Methods
static int getBitsPerPixel (int format)
Use this function to retrieve the number of bits per pixel of an ImageFormat.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final int JPEG

Added in API level 8

Encoded formats. These are not necessarily supported by the hardware.

Constant Value: 256 (0x00000100)

public static final int NV16

Added in API level 8

YCbCr format, used for video. Whether this format is supported by the camera hardware can be determined by getSupportedPreviewFormats() .

Constant Value: 16 (0x00000010)

public static final int NV21

Added in API level 8

YCrCb format used for images, which uses the NV21 encoding format. This is the default format for camera preview images, when not otherwise set with setPreviewFormat(int) .

Constant Value: 17 (0x00000011)

public static final int RGB_565

Added in API level 8

RGB format used for pictures encoded as RGB_565. See setPictureFormat(int) .

Constant Value: 4 (0x00000004)

public static final int UNKNOWN

Added in API level 8

Constant Value: 0 (0x00000000)

public static final int YUV_420_888

Multi-plane Android YUV format

This format is a generic YCbCr format, capable of describing any 4:2:0 chroma-subsampled planar or semiplanar buffer (but not fully interleaved), with 8 bits per color sample.

Images in this format are always represented by three separate buffers of data, one for each color plane. Additional information always accompanies the buffers, describing the row stride and the pixel stride for each plane.

The order of planes in the array returned by Image#getPlanes() is guaranteed such that plane #0 is always Y, plane #1 is always U (Cb), and plane #2 is always V (Cr).

The Y-plane is guaranteed not to be interleaved with the U/V planes (in particular, pixel stride is always 1 in yPlane.getPixelStride() ).

The U/V planes are guaranteed to have the same row stride and pixel stride (in particular, uPlane.getRowStride() == vPlane.getRowStride() and uPlane.getPixelStride() == vPlane.getPixelStride() ; ).

See Also
Constant Value: 35 (0x00000023)

public static final int YUY2

Added in API level 8

YCbCr format used for images, which uses YUYV (YUY2) encoding format. This is an alternative format for camera preview images. Whether this format is supported by the camera hardware can be determined by getSupportedPreviewFormats() .

Constant Value: 20 (0x00000014)

public static final int YV12

Added in API level 9

Android YUV format.

This format is exposed to software decoders and applications.

YV12 is a 4:2:0 YCrCb planar format comprised of a WxH Y plane followed by (W/2) x (H/2) Cr and Cb planes.

This format assumes

  • an even width
  • an even height
  • a horizontal stride multiple of 16 pixels
  • a vertical stride equal to the height

         y_size = stride * height
 c_stride = ALIGN(stride/2, 16)
 c_size = c_stride * height/2
 size = y_size + c_size * 2
 cr_offset = y_size
 cb_offset = y_size + c_size
        

This format is guaranteed to be supported for camera preview images since API level 12; for earlier API versions, check getSupportedPreviewFormats() .

Note that for camera preview callback use (see setPreviewCallback(Camera.PreviewCallback) ), the stride value is the smallest possible; that is, it is equal to:

          stride = ALIGN(width, 16)
         

Constant Value: 842094169 (0x32315659)

Public Constructors

public ImageFormat ()

Added in API level 8

Public Methods

public static int getBitsPerPixel (int format)

Added in API level 8

Use this function to retrieve the number of bits per pixel of an ImageFormat.

Returns
  • the number of bits per pixel of the given format or -1 if the format doesn't exist or is not supported.