Documentation/userspace-api/media/v4l/pixfmt-reserved.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   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     * - Identifier
  30       - Code
  31       - Details
  32     * .. _V4L2-PIX-FMT-DV:
  33
  34       - ``V4L2_PIX_FMT_DV``
  35       - 'dvsd'
  36       - unknown
  37     * .. _V4L2-PIX-FMT-ET61X251:
  38
  39       - ``V4L2_PIX_FMT_ET61X251``
  40       - 'E625'
  41       - Compressed format of the ET61X251 driver.
  42     * .. _V4L2-PIX-FMT-HI240:
  43
  44       - ``V4L2_PIX_FMT_HI240``
  45       - 'HI24'
  46       - 8 bit RGB format used by the BTTV driver.
  47     * .. _V4L2-PIX-FMT-HM12:
  48
  49       - ``V4L2_PIX_FMT_HM12``
  50       - 'HM12'
  51       - YUV 4:2:0 format used by the IVTV driver.
  52
  53         The format is documented in the kernel sources in the file
  54         ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``
  55     * .. _V4L2-PIX-FMT-CPIA1:
  56
  57       - ``V4L2_PIX_FMT_CPIA1``
  58       - 'CPIA'
  59       - YUV format used by the gspca cpia1 driver.
  60     * .. _V4L2-PIX-FMT-JPGL:
  61
  62       - ``V4L2_PIX_FMT_JPGL``
  63       - 'JPGL'
  64       - JPEG-Light format (Pegasus Lossless JPEG) used in Divio webcams NW
  65         80x.
  66     * .. _V4L2-PIX-FMT-SPCA501:
  67
  68       - ``V4L2_PIX_FMT_SPCA501``
  69       - 'S501'
  70       - YUYV per line used by the gspca driver.
  71     * .. _V4L2-PIX-FMT-SPCA505:
  72
  73       - ``V4L2_PIX_FMT_SPCA505``
  74       - 'S505'
  75       - YYUV per line used by the gspca driver.
  76     * .. _V4L2-PIX-FMT-SPCA508:
  77
  78       - ``V4L2_PIX_FMT_SPCA508``
  79       - 'S508'
  80       - YUVY per line used by the gspca driver.
  81     * .. _V4L2-PIX-FMT-SPCA561:
  82
  83       - ``V4L2_PIX_FMT_SPCA561``
  84       - 'S561'
  85       - Compressed GBRG Bayer format used by the gspca driver.
  86     * .. _V4L2-PIX-FMT-PAC207:
  87
  88       - ``V4L2_PIX_FMT_PAC207``
  89       - 'P207'
  90       - Compressed BGGR Bayer format used by the gspca driver.
  91     * .. _V4L2-PIX-FMT-MR97310A:
  92
  93       - ``V4L2_PIX_FMT_MR97310A``
  94       - 'M310'
  95       - Compressed BGGR Bayer format used by the gspca driver.
  96     * .. _V4L2-PIX-FMT-JL2005BCD:
  97
  98       - ``V4L2_PIX_FMT_JL2005BCD``
  99       - 'JL20'
 100       - JPEG compressed RGGB Bayer format used by the gspca driver.
 101     * .. _V4L2-PIX-FMT-OV511:
 102
 103       - ``V4L2_PIX_FMT_OV511``
 104       - 'O511'
 105       - OV511 JPEG format used by the gspca driver.
 106     * .. _V4L2-PIX-FMT-OV518:
 107
 108       - ``V4L2_PIX_FMT_OV518``
 109       - 'O518'
 110       - OV518 JPEG format used by the gspca driver.
 111     * .. _V4L2-PIX-FMT-PJPG:
 112
 113       - ``V4L2_PIX_FMT_PJPG``
 114       - 'PJPG'
 115       - Pixart 73xx JPEG format used by the gspca driver.
 116     * .. _V4L2-PIX-FMT-SE401:
 117
 118       - ``V4L2_PIX_FMT_SE401``
 119       - 'S401'
 120       - Compressed RGB format used by the gspca se401 driver
 121     * .. _V4L2-PIX-FMT-SQ905C:
 122
 123       - ``V4L2_PIX_FMT_SQ905C``
 124       - '905C'
 125       - Compressed RGGB bayer format used by the gspca driver.
 126     * .. _V4L2-PIX-FMT-MJPEG:
 127
 128       - ``V4L2_PIX_FMT_MJPEG``
 129       - 'MJPG'
 130       - Compressed format used by the Zoran driver
 131     * .. _V4L2-PIX-FMT-PWC1:
 132
 133       - ``V4L2_PIX_FMT_PWC1``
 134       - 'PWC1'
 135       - Compressed format of the PWC driver.
 136     * .. _V4L2-PIX-FMT-PWC2:
 137
 138       - ``V4L2_PIX_FMT_PWC2``
 139       - 'PWC2'
 140       - Compressed format of the PWC driver.
 141     * .. _V4L2-PIX-FMT-SN9C10X:
 142
 143       - ``V4L2_PIX_FMT_SN9C10X``
 144       - 'S910'
 145       - Compressed format of the SN9C102 driver.
 146     * .. _V4L2-PIX-FMT-SN9C20X-I420:
 147
 148       - ``V4L2_PIX_FMT_SN9C20X_I420``
 149       - 'S920'
 150       - YUV 4:2:0 format of the gspca sn9c20x driver.
 151     * .. _V4L2-PIX-FMT-SN9C2028:
 152
 153       - ``V4L2_PIX_FMT_SN9C2028``
 154       - 'SONX'
 155       - Compressed GBRG bayer format of the gspca sn9c2028 driver.
 156     * .. _V4L2-PIX-FMT-STV0680:
 157
 158       - ``V4L2_PIX_FMT_STV0680``
 159       - 'S680'
 160       - Bayer format of the gspca stv0680 driver.
 161     * .. _V4L2-PIX-FMT-WNVA:
 162
 163       - ``V4L2_PIX_FMT_WNVA``
 164       - 'WNVA'
 165       - Used by the Winnov Videum driver,
 166         `http://www.thedirks.org/winnov/ <http://www.thedirks.org/winnov/>`__
 167     * .. _V4L2-PIX-FMT-TM6000:
 168
 169       - ``V4L2_PIX_FMT_TM6000``
 170       - 'TM60'
 171       - Used by Trident tm6000
 172     * .. _V4L2-PIX-FMT-CIT-YYVYUY:
 173
 174       - ``V4L2_PIX_FMT_CIT_YYVYUY``
 175       - 'CITV'
 176       - Used by xirlink CIT, found at IBM webcams.
 177
 178         Uses one line of Y then 1 line of VYUY
 179     * .. _V4L2-PIX-FMT-KONICA420:
 180
 181       - ``V4L2_PIX_FMT_KONICA420``
 182       - 'KONI'
 183       - Used by Konica webcams.
 184
 185         YUV420 planar in blocks of 256 pixels.
 186     * .. _V4L2-PIX-FMT-YYUV:
 187
 188       - ``V4L2_PIX_FMT_YYUV``
 189       - 'YYUV'
 190       - unknown
 191     * .. _V4L2-PIX-FMT-Y4:
 192
 193       - ``V4L2_PIX_FMT_Y4``
 194       - 'Y04 '
 195       - Old 4-bit greyscale format. Only the most significant 4 bits of
 196         each byte are used, the other bits are set to 0.
 197     * .. _V4L2-PIX-FMT-Y6:
 198
 199       - ``V4L2_PIX_FMT_Y6``
 200       - 'Y06 '
 201       - Old 6-bit greyscale format. Only the most significant 6 bits of
 202         each byte are used, the other bits are set to 0.
 203     * .. _V4L2-PIX-FMT-S5C-UYVY-JPG:
 204
 205       - ``V4L2_PIX_FMT_S5C_UYVY_JPG``
 206       - 'S5CI'
 207       - Two-planar format used by Samsung S5C73MX cameras. The first plane
 208         contains interleaved JPEG and UYVY image data, followed by meta
 209         data in form of an array of offsets to the UYVY data blocks. The
 210         actual pointer array follows immediately the interleaved JPEG/UYVY
 211         data, the number of entries in this array equals the height of the
 212         UYVY image. Each entry is a 4-byte unsigned integer in big endian
 213         order and it's an offset to a single pixel line of the UYVY image.
 214         The first plane can start either with JPEG or UYVY data chunk. The
 215         size of a single UYVY block equals the UYVY image's width
 216         multiplied by 2. The size of a JPEG chunk depends on the image and
 217         can vary with each line.
 218
 219         The second plane, at an offset of 4084 bytes, contains a 4-byte
 220         offset to the pointer array in the first plane. This offset is
 221         followed by a 4-byte value indicating size of the pointer array.
 222         All numbers in the second plane are also in big endian order.
 223         Remaining data in the second plane is undefined. The information
 224         in the second plane allows to easily find location of the pointer
 225         array, which can be different for each frame. The size of the
 226         pointer array is constant for given UYVY image height.
 227
 228         In order to extract UYVY and JPEG frames an application can
 229         initially set a data pointer to the start of first plane and then
 230         add an offset from the first entry of the pointers table. Such a
 231         pointer indicates start of an UYVY image pixel line. Whole UYVY
 232         line can be copied to a separate buffer. These steps should be
 233         repeated for each line, i.e. the number of entries in the pointer
 234         array. Anything what's in between the UYVY lines is JPEG data and
 235         should be concatenated to form the JPEG stream.
 236     * .. _V4L2-PIX-FMT-MT21C:
 237
 238       - ``V4L2_PIX_FMT_MT21C``
 239       - 'MT21'
 240       - Compressed two-planar YVU420 format used by Mediatek MT8173.
 241         The compression is lossless.
 242         It is an opaque intermediate format and the MDP hardware must be
 243         used to convert ``V4L2_PIX_FMT_MT21C`` to ``V4L2_PIX_FMT_NV12M``,
 244         ``V4L2_PIX_FMT_YUV420M`` or ``V4L2_PIX_FMT_YVU420``.
 245     * .. _V4L2-PIX-FMT-SUNXI-TILED-NV12:
 246
 247       - ``V4L2_PIX_FMT_SUNXI_TILED_NV12``
 248       - 'ST12'
 249       - Two-planar NV12-based format used by the video engine found on Allwinner
 250         (codenamed sunxi) platforms, with 32x32 tiles for the luminance plane
 251         and 32x64 tiles for the chrominance plane. The data in each tile is
 252         stored in linear order, within the tile bounds. Each tile follows the
 253         previous one linearly in memory (from left to right, top to bottom).
 254
 255         The associated buffer dimensions are aligned to match an integer number
 256         of tiles, resulting in 32-aligned resolutions for the luminance plane
 257         and 16-aligned resolutions for the chrominance plane (with 2x2
 258         subsampling).