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

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _V4L2-PIX-FMT-NV16M:
  11 .. _v4l2-pix-fmt-nv61m:
  12
  13 ********************************************************
  14 V4L2_PIX_FMT_NV16M ('NM16'), V4L2_PIX_FMT_NV61M ('NM61')
  15 ********************************************************
  16
  17 V4L2_PIX_FMT_NV61M
  18 Variation of ``V4L2_PIX_FMT_NV16`` and ``V4L2_PIX_FMT_NV61`` with planes
  19 non contiguous in memory.
  20
  21
  22 Description
  23 ===========
  24
  25 This is a multi-planar, two-plane version of the YUV 4:2:2 format. The
  26 three components are separated into two sub-images or planes.
  27 ``V4L2_PIX_FMT_NV16M`` differs from ``V4L2_PIX_FMT_NV16`` in that the
  28 two planes are non-contiguous in memory, i.e. the chroma plane does not
  29 necessarily immediately follow the luma plane. The luminance data
  30 occupies the first plane. The Y plane has one byte per pixel. In the
  31 second plane there is chrominance data with alternating chroma samples.
  32 The CbCr plane is the same width and height, in bytes, as the Y plane.
  33 Each CbCr pair belongs to two pixels. For example,
  34 Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`.
  35 ``V4L2_PIX_FMT_NV61M`` is the same as ``V4L2_PIX_FMT_NV16M`` except the
  36 Cb and Cr bytes are swapped, the CrCb plane starts with a Cr byte.
  37
  38 ``V4L2_PIX_FMT_NV16M`` and ``V4L2_PIX_FMT_NV61M`` are intended to be
  39 used only in drivers and applications that support the multi-planar API,
  40 described in :ref:`planar-apis`.
  41
  42 **Byte Order.**
  43 Each cell is one byte.
  44
  45
  46 .. flat-table::
  47     :header-rows:  0
  48     :stub-columns: 0
  49
  50     * - start0 + 0:
  51       - Y'\ :sub:`00`
  52       - Y'\ :sub:`01`
  53       - Y'\ :sub:`02`
  54       - Y'\ :sub:`03`
  55     * - start0 + 4:
  56       - Y'\ :sub:`10`
  57       - Y'\ :sub:`11`
  58       - Y'\ :sub:`12`
  59       - Y'\ :sub:`13`
  60     * - start0 + 8:
  61       - Y'\ :sub:`20`
  62       - Y'\ :sub:`21`
  63       - Y'\ :sub:`22`
  64       - Y'\ :sub:`23`
  65     * - start0 + 12:
  66       - Y'\ :sub:`30`
  67       - Y'\ :sub:`31`
  68       - Y'\ :sub:`32`
  69       - Y'\ :sub:`33`
  70     * -
  71     * - start1 + 0:
  72       - Cb\ :sub:`00`
  73       - Cr\ :sub:`00`
  74       - Cb\ :sub:`02`
  75       - Cr\ :sub:`02`
  76     * - start1 + 4:
  77       - Cb\ :sub:`10`
  78       - Cr\ :sub:`10`
  79       - Cb\ :sub:`12`
  80       - Cr\ :sub:`12`
  81     * - start1 + 8:
  82       - Cb\ :sub:`20`
  83       - Cr\ :sub:`20`
  84       - Cb\ :sub:`22`
  85       - Cr\ :sub:`22`
  86     * - start1 + 12:
  87       - Cb\ :sub:`30`
  88       - Cr\ :sub:`30`
  89       - Cb\ :sub:`32`
  90       - Cr\ :sub:`32`
  91
  92
  93 **Color Sample Location:**
  94
  95
  96
  97 .. flat-table::
  98     :header-rows:  0
  99     :stub-columns: 0
 100
 101     * -
 102       - 0
 103       -
 104       - 1
 105       - 2
 106       -
 107       - 3
 108     * - 0
 109       - Y
 110       -
 111       - Y
 112       - Y
 113       -
 114       - Y
 115     * -
 116       -
 117       - C
 118       -
 119       -
 120       - C
 121       -
 122     * - 1
 123       - Y
 124       -
 125       - Y
 126       - Y
 127       -
 128       - Y
 129     * -
 130       -
 131       - C
 132       -
 133       -
 134       - C
 135       -
 136     * -
 137     * - 2
 138       - Y
 139       -
 140       - Y
 141       - Y
 142       -
 143       - Y
 144     * -
 145       -
 146       - C
 147       -
 148       -
 149       - C
 150       -
 151     * - 3
 152       - Y
 153       -
 154       - Y
 155       - Y
 156       -
 157       - Y
 158     * -
 159       -
 160       - C
 161       -
 162       -
 163       - C
 164       -