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

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _pixfmt-reserved:
   4
   5 ***************************
   6 Reserved Format Identifiers
   7 ***************************
   8
   9 These formats are not defined by this specification, they are just
  10 listed for reference and to avoid naming conflicts. If you want to
  11 register your own format, send an e-mail to the linux-media mailing list
  12 `https://linuxtv.org/lists.php <https://linuxtv.org/lists.php>`__
  13 for inclusion in the ``videodev2.h`` file. If you want to share your
  14 format with other developers add a link to your documentation and send a
  15 copy to the linux-media mailing list for inclusion in this section. If
  16 you think your format should be listed in a standard format section
  17 please make a proposal on the linux-media mailing list.
  18
  19
  20 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
  21
  22 .. _reserved-formats:
  23
  24 .. flat-table:: Reserved Image Formats
  25     :header-rows:  1
  26     :stub-columns: 0
  27     :widths:       3 1 4
  28
  29
  30     -  .. row 1
  31
  32        -  Identifier
  33
  34        -  Code
  35
  36        -  Details
  37
  38     -  .. _V4L2-PIX-FMT-DV:
  39
  40        -  ``V4L2_PIX_FMT_DV``
  41
  42        -  'dvsd'
  43
  44        -  unknown
  45
  46     -  .. _V4L2-PIX-FMT-ET61X251:
  47
  48        -  ``V4L2_PIX_FMT_ET61X251``
  49
  50        -  'E625'
  51
  52        -  Compressed format of the ET61X251 driver.
  53
  54     -  .. _V4L2-PIX-FMT-HI240:
  55
  56        -  ``V4L2_PIX_FMT_HI240``
  57
  58        -  'HI24'
  59
  60        -  8 bit RGB format used by the BTTV driver.
  61
  62     -  .. _V4L2-PIX-FMT-HM12:
  63
  64        -  ``V4L2_PIX_FMT_HM12``
  65
  66        -  'HM12'
  67
  68        -  YUV 4:2:0 format used by the IVTV driver,
  69           `http://www.ivtvdriver.org/ <http://www.ivtvdriver.org/>`__
  70
  71           The format is documented in the kernel sources in the file
  72           ``Documentation/video4linux/cx2341x/README.hm12``
  73
  74     -  .. _V4L2-PIX-FMT-CPIA1:
  75
  76        -  ``V4L2_PIX_FMT_CPIA1``
  77
  78        -  'CPIA'
  79
  80        -  YUV format used by the gspca cpia1 driver.
  81
  82     -  .. _V4L2-PIX-FMT-JPGL:
  83
  84        -  ``V4L2_PIX_FMT_JPGL``
  85
  86        -  'JPGL'
  87
  88        -  JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
  89           80x.
  90
  91     -  .. _V4L2-PIX-FMT-SPCA501:
  92
  93        -  ``V4L2_PIX_FMT_SPCA501``
  94
  95        -  'S501'
  96
  97        -  YUYV per line used by the gspca driver.
  98
  99     -  .. _V4L2-PIX-FMT-SPCA505:
 100
 101        -  ``V4L2_PIX_FMT_SPCA505``
 102
 103        -  'S505'
 104
 105        -  YYUV per line used by the gspca driver.
 106
 107     -  .. _V4L2-PIX-FMT-SPCA508:
 108
 109        -  ``V4L2_PIX_FMT_SPCA508``
 110
 111        -  'S508'
 112
 113        -  YUVY per line used by the gspca driver.
 114
 115     -  .. _V4L2-PIX-FMT-SPCA561:
 116
 117        -  ``V4L2_PIX_FMT_SPCA561``
 118
 119        -  'S561'
 120
 121        -  Compressed GBRG Bayer format used by the gspca driver.
 122
 123     -  .. _V4L2-PIX-FMT-PAC207:
 124
 125        -  ``V4L2_PIX_FMT_PAC207``
 126
 127        -  'P207'
 128
 129        -  Compressed BGGR Bayer format used by the gspca driver.
 130
 131     -  .. _V4L2-PIX-FMT-MR97310A:
 132
 133        -  ``V4L2_PIX_FMT_MR97310A``
 134
 135        -  'M310'
 136
 137        -  Compressed BGGR Bayer format used by the gspca driver.
 138
 139     -  .. _V4L2-PIX-FMT-JL2005BCD:
 140
 141        -  ``V4L2_PIX_FMT_JL2005BCD``
 142
 143        -  'JL20'
 144
 145        -  JPEG compressed RGGB Bayer format used by the gspca driver.
 146
 147     -  .. _V4L2-PIX-FMT-OV511:
 148
 149        -  ``V4L2_PIX_FMT_OV511``
 150
 151        -  'O511'
 152
 153        -  OV511 JPEG format used by the gspca driver.
 154
 155     -  .. _V4L2-PIX-FMT-OV518:
 156
 157        -  ``V4L2_PIX_FMT_OV518``
 158
 159        -  'O518'
 160
 161        -  OV518 JPEG format used by the gspca driver.
 162
 163     -  .. _V4L2-PIX-FMT-PJPG:
 164
 165        -  ``V4L2_PIX_FMT_PJPG``
 166
 167        -  'PJPG'
 168
 169        -  Pixart 73xx JPEG format used by the gspca driver.
 170
 171     -  .. _V4L2-PIX-FMT-SE401:
 172
 173        -  ``V4L2_PIX_FMT_SE401``
 174
 175        -  'S401'
 176
 177        -  Compressed RGB format used by the gspca se401 driver
 178
 179     -  .. _V4L2-PIX-FMT-SQ905C:
 180
 181        -  ``V4L2_PIX_FMT_SQ905C``
 182
 183        -  '905C'
 184
 185        -  Compressed RGGB bayer format used by the gspca driver.
 186
 187     -  .. _V4L2-PIX-FMT-MJPEG:
 188
 189        -  ``V4L2_PIX_FMT_MJPEG``
 190
 191        -  'MJPG'
 192
 193        -  Compressed format used by the Zoran driver
 194
 195     -  .. _V4L2-PIX-FMT-PWC1:
 196
 197        -  ``V4L2_PIX_FMT_PWC1``
 198
 199        -  'PWC1'
 200
 201        -  Compressed format of the PWC driver.
 202
 203     -  .. _V4L2-PIX-FMT-PWC2:
 204
 205        -  ``V4L2_PIX_FMT_PWC2``
 206
 207        -  'PWC2'
 208
 209        -  Compressed format of the PWC driver.
 210
 211     -  .. _V4L2-PIX-FMT-SN9C10X:
 212
 213        -  ``V4L2_PIX_FMT_SN9C10X``
 214
 215        -  'S910'
 216
 217        -  Compressed format of the SN9C102 driver.
 218
 219     -  .. _V4L2-PIX-FMT-SN9C20X-I420:
 220
 221        -  ``V4L2_PIX_FMT_SN9C20X_I420``
 222
 223        -  'S920'
 224
 225        -  YUV 4:2:0 format of the gspca sn9c20x driver.
 226
 227     -  .. _V4L2-PIX-FMT-SN9C2028:
 228
 229        -  ``V4L2_PIX_FMT_SN9C2028``
 230
 231        -  'SONX'
 232
 233        -  Compressed GBRG bayer format of the gspca sn9c2028 driver.
 234
 235     -  .. _V4L2-PIX-FMT-STV0680:
 236
 237        -  ``V4L2_PIX_FMT_STV0680``
 238
 239        -  'S680'
 240
 241        -  Bayer format of the gspca stv0680 driver.
 242
 243     -  .. _V4L2-PIX-FMT-WNVA:
 244
 245        -  ``V4L2_PIX_FMT_WNVA``
 246
 247        -  'WNVA'
 248
 249        -  Used by the Winnov Videum driver,
 250           `http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
 251
 252     -  .. _V4L2-PIX-FMT-TM6000:
 253
 254        -  ``V4L2_PIX_FMT_TM6000``
 255
 256        -  'TM60'
 257
 258        -  Used by Trident tm6000
 259
 260     -  .. _V4L2-PIX-FMT-CIT-YYVYUY:
 261
 262        -  ``V4L2_PIX_FMT_CIT_YYVYUY``
 263
 264        -  'CITV'
 265
 266        -  Used by xirlink CIT, found at IBM webcams.
 267
 268           Uses one line of Y then 1 line of VYUY
 269
 270     -  .. _V4L2-PIX-FMT-KONICA420:
 271
 272        -  ``V4L2_PIX_FMT_KONICA420``
 273
 274        -  'KONI'
 275
 276        -  Used by Konica webcams.
 277
 278           YUV420 planar in blocks of 256 pixels.
 279
 280     -  .. _V4L2-PIX-FMT-YYUV:
 281
 282        -  ``V4L2_PIX_FMT_YYUV``
 283
 284        -  'YYUV'
 285
 286        -  unknown
 287
 288     -  .. _V4L2-PIX-FMT-Y4:
 289
 290        -  ``V4L2_PIX_FMT_Y4``
 291
 292        -  'Y04 '
 293
 294        -  Old 4-bit greyscale format. Only the most significant 4 bits of
 295           each byte are used, the other bits are set to 0.
 296
 297     -  .. _V4L2-PIX-FMT-Y6:
 298
 299        -  ``V4L2_PIX_FMT_Y6``
 300
 301        -  'Y06 '
 302
 303        -  Old 6-bit greyscale format. Only the most significant 6 bits of
 304           each byte are used, the other bits are set to 0.
 305
 306     -  .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
 307
 308        -  ``V4L2_PIX_FMT_S5C_UYVY_JPG``
 309
 310        -  'S5CI'
 311
 312        -  Two-planar format used by Samsung S5C73MX cameras. The first plane
 313           contains interleaved JPEG and UYVY image data, followed by meta
 314           data in form of an array of offsets to the UYVY data blocks. The
 315           actual pointer array follows immediately the interleaved JPEG/UYVY
 316           data, the number of entries in this array equals the height of the
 317           UYVY image. Each entry is a 4-byte unsigned integer in big endian
 318           order and it's an offset to a single pixel line of the UYVY image.
 319           The first plane can start either with JPEG or UYVY data chunk. The
 320           size of a single UYVY block equals the UYVY image's width
 321           multiplied by 2. The size of a JPEG chunk depends on the image and
 322           can vary with each line.
 323
 324           The second plane, at an offset of 4084 bytes, contains a 4-byte
 325           offset to the pointer array in the first plane. This offset is
 326           followed by a 4-byte value indicating size of the pointer array.
 327           All numbers in the second plane are also in big endian order.
 328           Remaining data in the second plane is undefined. The information
 329           in the second plane allows to easily find location of the pointer
 330           array, which can be different for each frame. The size of the
 331           pointer array is constant for given UYVY image height.
 332
 333           In order to extract UYVY and JPEG frames an application can
 334           initially set a data pointer to the start of first plane and then
 335           add an offset from the first entry of the pointers table. Such a
 336           pointer indicates start of an UYVY image pixel line. Whole UYVY
 337           line can be copied to a separate buffer. These steps should be
 338           repeated for each line, i.e. the number of entries in the pointer
 339           array. Anything what's in between the UYVY lines is JPEG data and
 340           should be concatenated to form the JPEG stream.
 341
 342
 343
 344 .. tabularcolumns:: |p{6.6cm}|p{2.2cm}|p{8.7cm}|
 345
 346 .. _format-flags:
 347
 348 .. flat-table:: Format Flags
 349     :header-rows:  0
 350     :stub-columns: 0
 351     :widths:       3 1 4
 352
 353
 354     -  .. row 1
 355
 356        -  ``V4L2_PIX_FMT_FLAG_PREMUL_ALPHA``
 357
 358        -  0x00000001
 359
 360        -  The color values are premultiplied by the alpha channel value. For
 361           example, if a light blue pixel with 50% transparency was described
 362           by RGBA values (128, 192, 255, 128), the same pixel described with
 363           premultiplied colors would be described by RGBA values (64, 96,
 364           128, 128)