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