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