Documentation/media/uapi/v4l/pixfmt-nv12mt.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _V4L2-PIX-FMT-NV12MT:
   4
   5 ****************************
   6 V4L2_PIX_FMT_NV12MT ('TM12')
   7 ****************************
   8
   9 Formats with ½ horizontal and vertical chroma resolution. This format
  10 has two planes - one for luminance and one for chrominance. Chroma
  11 samples are interleaved. The difference to ``V4L2_PIX_FMT_NV12`` is the
  12 memory layout. Pixels are grouped in macroblocks of 64x32 size. The
  13 order of macroblocks in memory is also not standard.
  14
  15
  16 Description
  17 ===========
  18
  19 This is the two-plane versions of the YUV 4:2:0 format where data is
  20 grouped into 64x32 macroblocks. The three components are separated into
  21 two sub-images or planes. The Y plane has one byte per pixel and pixels
  22 are grouped into 64x32 macroblocks. The CbCr plane has the same width,
  23 in bytes, as the Y plane (and the image), but is half as tall in pixels.
  24 The chroma plane is also grouped into 64x32 macroblocks.
  25
  26 Width of the buffer has to be aligned to the multiple of 128, and height
  27 alignment is 32. Every four adjacent buffers - two horizontally and two
  28 vertically are grouped together and are located in memory in Z or
  29 flipped Z order.
  30
  31 Layout of macroblocks in memory is presented in the following figure.
  32
  33
  34 .. _nv12mt:
  35
  36 .. figure::  pixfmt-nv12mt_files/nv12mt.*
  37     :alt:    nv12mt.png
  38     :align:  center
  39
  40     V4L2_PIX_FMT_NV12MT macroblock Z shape memory layout
  41
  42 The requirement that width is multiple of 128 is implemented because,
  43 the Z shape cannot be cut in half horizontally. In case the vertical
  44 resolution of macroblocks is odd then the last row of macroblocks is
  45 arranged in a linear order.
  46
  47 In case of chroma the layout is identical. Cb and Cr samples are
  48 interleaved. Height of the buffer is aligned to 32.
  49
  50
  51 .. _nv12mt_ex:
  52
  53 .. figure::  pixfmt-nv12mt_files/nv12mt_example.*
  54     :alt:    nv12mt_example.png
  55     :align:  center
  56
  57     Example V4L2_PIX_FMT_NV12MT memory layout of macroblocks
  58
  59 Memory layout of macroblocks of ``V4L2_PIX_FMT_NV12MT`` format in most
  60 extreme case.