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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _V4L2-PIX-FMT-NV16M:
   4 .. _v4l2-pix-fmt-nv61m:
   5
   6 ********************************************************
   7 V4L2_PIX_FMT_NV16M ('NM16'), V4L2_PIX_FMT_NV61M ('NM61')
   8 ********************************************************
   9
  10 *man V4L2_PIX_FMT_NV16M(2)*
  11
  12 V4L2_PIX_FMT_NV61M
  13 Variation of ``V4L2_PIX_FMT_NV16`` and ``V4L2_PIX_FMT_NV61`` with planes
  14 non contiguous in memory.
  15
  16
  17 Description
  18 ===========
  19
  20 This is a multi-planar, two-plane version of the YUV 4:2:2 format. The
  21 three components are separated into two sub-images or planes.
  22 ``V4L2_PIX_FMT_NV16M`` differs from ``V4L2_PIX_FMT_NV16`` in that the
  23 two planes are non-contiguous in memory, i.e. the chroma plane does not
  24 necessarily immediately follow the luma plane. The luminance data
  25 occupies the first plane. The Y plane has one byte per pixel. In the
  26 second plane there is chrominance data with alternating chroma samples.
  27 The CbCr plane is the same width and height, in bytes, as the Y plane.
  28 Each CbCr pair belongs to two pixels. For example,
  29 Cb\ :sub:`0`/Cr\ :sub:`0` belongs to Y'\ :sub:`00`, Y'\ :sub:`01`.
  30 ``V4L2_PIX_FMT_NV61M`` is the same as ``V4L2_PIX_FMT_NV16M`` except the
  31 Cb and Cr bytes are swapped, the CrCb plane starts with a Cr byte.
  32
  33 ``V4L2_PIX_FMT_NV16M`` and ``V4L2_PIX_FMT_NV61M`` are intended to be
  34 used only in drivers and applications that support the multi-planar API,
  35 described in :ref:`planar-apis`.
  36
  37 **Byte Order.**
  38 Each cell is one byte.
  39
  40
  41
  42 .. tabularcolumns:: |p{5.8cm}|p{2.9cm}|p{2.9cm}|p{2.9cm}|p{3.0cm}|
  43
  44 .. flat-table::
  45     :header-rows:  0
  46     :stub-columns: 0
  47     :widths:       2 1 1 1 1
  48
  49
  50     -  .. row 1
  51
  52        -  start0 + 0:
  53
  54        -  Y'\ :sub:`00`
  55
  56        -  Y'\ :sub:`01`
  57
  58        -  Y'\ :sub:`02`
  59
  60        -  Y'\ :sub:`03`
  61
  62     -  .. row 2
  63
  64        -  start0 + 4:
  65
  66        -  Y'\ :sub:`10`
  67
  68        -  Y'\ :sub:`11`
  69
  70        -  Y'\ :sub:`12`
  71
  72        -  Y'\ :sub:`13`
  73
  74     -  .. row 3
  75
  76        -  start0 + 8:
  77
  78        -  Y'\ :sub:`20`
  79
  80        -  Y'\ :sub:`21`
  81
  82        -  Y'\ :sub:`22`
  83
  84        -  Y'\ :sub:`23`
  85
  86     -  .. row 4
  87
  88        -  start0 + 12:
  89
  90        -  Y'\ :sub:`30`
  91
  92        -  Y'\ :sub:`31`
  93
  94        -  Y'\ :sub:`32`
  95
  96        -  Y'\ :sub:`33`
  97
  98     -  .. row 5
  99
 100        -
 101
 102     -  .. row 6
 103
 104        -  start1 + 0:
 105
 106        -  Cb\ :sub:`00`
 107
 108        -  Cr\ :sub:`00`
 109
 110        -  Cb\ :sub:`02`
 111
 112        -  Cr\ :sub:`02`
 113
 114     -  .. row 7
 115
 116        -  start1 + 4:
 117
 118        -  Cb\ :sub:`10`
 119
 120        -  Cr\ :sub:`10`
 121
 122        -  Cb\ :sub:`12`
 123
 124        -  Cr\ :sub:`12`
 125
 126     -  .. row 8
 127
 128        -  start1 + 8:
 129
 130        -  Cb\ :sub:`20`
 131
 132        -  Cr\ :sub:`20`
 133
 134        -  Cb\ :sub:`22`
 135
 136        -  Cr\ :sub:`22`
 137
 138     -  .. row 9
 139
 140        -  start1 + 12:
 141
 142        -  Cb\ :sub:`30`
 143
 144        -  Cr\ :sub:`30`
 145
 146        -  Cb\ :sub:`32`
 147
 148        -  Cr\ :sub:`32`
 149
 150
 151 **Color Sample Location..**
 152
 153
 154
 155 .. flat-table::
 156     :header-rows:  0
 157     :stub-columns: 0
 158
 159
 160     -  .. row 1
 161
 162        -
 163        -  0
 164
 165        -
 166        -  1
 167
 168        -  2
 169
 170        -
 171        -  3
 172
 173     -  .. row 2
 174
 175        -  0
 176
 177        -  Y
 178
 179        -
 180        -  Y
 181
 182        -  Y
 183
 184        -
 185        -  Y
 186
 187     -  .. row 3
 188
 189        -
 190        -
 191        -  C
 192
 193        -
 194        -
 195        -  C
 196
 197        -
 198
 199     -  .. row 4
 200
 201        -  1
 202
 203        -  Y
 204
 205        -
 206        -  Y
 207
 208        -  Y
 209
 210        -
 211        -  Y
 212
 213     -  .. row 5
 214
 215        -
 216        -
 217        -  C
 218
 219        -
 220        -
 221        -  C
 222
 223        -
 224
 225     -  .. row 6
 226
 227        -
 228
 229     -  .. row 7
 230
 231        -  2
 232
 233        -  Y
 234
 235        -
 236        -  Y
 237
 238        -  Y
 239
 240        -
 241        -  Y
 242
 243     -  .. row 8
 244
 245        -
 246        -
 247        -  C
 248
 249        -
 250        -
 251        -  C
 252
 253        -
 254
 255     -  .. row 9
 256
 257        -  3
 258
 259        -  Y
 260
 261        -
 262        -  Y
 263
 264        -  Y
 265
 266        -
 267        -  Y
 268
 269     -  .. row 10
 270
 271        -
 272        -
 273        -  C
 274
 275        -
 276        -
 277        -  C
 278
 279        -