xref: /linux/Documentation/userspace-api/media/v4l/pixfmt-compressed.rst (revision 02680c23d7b3febe45ea3d4f9818c2b2dc89020a)
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2
3******************
4Compressed Formats
5******************
6
7
8.. _compressed-formats:
9
10.. raw:: latex
11
12    \small
13
14.. tabularcolumns:: |p{5.8cm}|p{1.2cm}|p{10.3cm}|
15
16.. cssclass:: longtable
17
18.. flat-table:: Compressed Image Formats
19    :header-rows:  1
20    :stub-columns: 0
21    :widths:       3 1 4
22
23    * - Identifier
24      - Code
25      - Details
26    * .. _V4L2-PIX-FMT-JPEG:
27
28      - ``V4L2_PIX_FMT_JPEG``
29      - 'JPEG'
30      - TBD. See also :ref:`VIDIOC_G_JPEGCOMP <VIDIOC_G_JPEGCOMP>`,
31	:ref:`VIDIOC_S_JPEGCOMP <VIDIOC_G_JPEGCOMP>`.
32    * .. _V4L2-PIX-FMT-MPEG:
33
34      - ``V4L2_PIX_FMT_MPEG``
35      - 'MPEG'
36      - MPEG multiplexed stream. The actual format is determined by
37	extended control ``V4L2_CID_MPEG_STREAM_TYPE``, see
38	:ref:`mpeg-control-id`.
39    * .. _V4L2-PIX-FMT-H264:
40
41      - ``V4L2_PIX_FMT_H264``
42      - 'H264'
43      - H264 Access Unit.
44	The decoder expects one Access Unit per buffer.
45	The encoder generates one Access Unit per buffer.
46	If :ref:`VIDIOC_ENUM_FMT` reports ``V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM``
47	then the decoder has no requirements since it can parse all the
48	information from the raw bytestream.
49    * .. _V4L2-PIX-FMT-H264-NO-SC:
50
51      - ``V4L2_PIX_FMT_H264_NO_SC``
52      - 'AVC1'
53      - H264 video elementary stream without start codes.
54    * .. _V4L2-PIX-FMT-H264-MVC:
55
56      - ``V4L2_PIX_FMT_H264_MVC``
57      - 'M264'
58      - H264 MVC video elementary stream.
59    * .. _V4L2-PIX-FMT-H264-SLICE:
60
61      - ``V4L2_PIX_FMT_H264_SLICE``
62      - 'S264'
63      - H264 parsed slice data, including slice headers, either with or
64	without the start code, as extracted from the H264 bitstream.
65	This format is adapted for stateless video decoders that implement an
66	H264 pipeline with the :ref:`stateless_decoder`.
67	This pixelformat has two modifiers that must be set at least once
68	through the ``V4L2_CID_STATELESS_H264_DECODE_MODE``
69        and ``V4L2_CID_STATELESS_H264_START_CODE`` controls.
70	In addition, metadata associated with the frame to decode are
71	required to be passed through the ``V4L2_CID_STATELESS_H264_SPS``,
72	``V4L2_CID_STATELESS_H264_PPS``,
73	``V4L2_CID_STATELESS_H264_SCALING_MATRIX``,
74	``V4L2_CID_STATELESS_H264_SLICE_PARAMS`` and
75	``V4L2_CID_STATELESS_H264_DECODE_PARAMS`` controls.  See the
76	:ref:`associated Codec Control IDs <v4l2-codec-stateless-h264>`.
77        Exactly one output and one capture buffer must be provided for use
78	with this pixel format. The output buffer must contain the
79	appropriate number of macroblocks to decode a full
80	corresponding frame to the matching capture buffer.
81
82	The syntax for this format is documented in :ref:`h264`, section
83	7.3.2.8 "Slice layer without partitioning RBSP syntax" and the following
84	sections.
85
86    * .. _V4L2-PIX-FMT-H263:
87
88      - ``V4L2_PIX_FMT_H263``
89      - 'H263'
90      - H263 video elementary stream.
91    * .. _V4L2-PIX-FMT-MPEG1:
92
93      - ``V4L2_PIX_FMT_MPEG1``
94      - 'MPG1'
95      - MPEG1 Picture. Each buffer starts with a Picture header, followed
96	by other headers as needed and ending with the Picture data.
97	If :ref:`VIDIOC_ENUM_FMT` reports ``V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM``
98	then the decoder has no requirements since it can parse all the
99	information from the raw bytestream.
100    * .. _V4L2-PIX-FMT-MPEG2:
101
102      - ``V4L2_PIX_FMT_MPEG2``
103      - 'MPG2'
104      - MPEG2 Picture. Each buffer starts with a Picture header, followed
105	by other headers as needed and ending with the Picture data.
106	If :ref:`VIDIOC_ENUM_FMT` reports ``V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM``
107	then the decoder has no requirements since it can parse all the
108	information from the raw bytestream.
109    * .. _V4L2-PIX-FMT-MPEG2-SLICE:
110
111      - ``V4L2_PIX_FMT_MPEG2_SLICE``
112      - 'MG2S'
113      - MPEG-2 parsed slice data, as extracted from the MPEG-2 bitstream.
114	This format is adapted for stateless video decoders that implement a
115	MPEG-2 pipeline (using the :ref:`mem2mem` and :ref:`media-request-api`).
116	Metadata associated with the frame to decode is required to be passed
117	through the ``V4L2_CID_MPEG_VIDEO_MPEG2_SLICE_PARAMS`` control and
118	quantization matrices can optionally be specified through the
119	``V4L2_CID_MPEG_VIDEO_MPEG2_QUANTIZATION`` control.
120	See the :ref:`associated Codec Control IDs <v4l2-mpeg-mpeg2>`.
121	Exactly one output and one capture buffer must be provided for use with
122	this pixel format. The output buffer must contain the appropriate number
123	of macroblocks to decode a full corresponding frame to the matching
124	capture buffer.
125    * .. _V4L2-PIX-FMT-MPEG4:
126
127      - ``V4L2_PIX_FMT_MPEG4``
128      - 'MPG4'
129      - MPEG4 video elementary stream.
130    * .. _V4L2-PIX-FMT-XVID:
131
132      - ``V4L2_PIX_FMT_XVID``
133      - 'XVID'
134      - Xvid video elementary stream.
135    * .. _V4L2-PIX-FMT-VC1-ANNEX-G:
136
137      - ``V4L2_PIX_FMT_VC1_ANNEX_G``
138      - 'VC1G'
139      - VC1, SMPTE 421M Annex G compliant stream.
140    * .. _V4L2-PIX-FMT-VC1-ANNEX-L:
141
142      - ``V4L2_PIX_FMT_VC1_ANNEX_L``
143      - 'VC1L'
144      - VC1, SMPTE 421M Annex L compliant stream.
145    * .. _V4L2-PIX-FMT-VP8:
146
147      - ``V4L2_PIX_FMT_VP8``
148      - 'VP80'
149      - VP8 compressed video frame. The encoder generates one
150	compressed frame per buffer, and the decoder requires one
151	compressed frame per buffer.
152    * .. _V4L2-PIX-FMT-VP8-FRAME:
153
154      - ``V4L2_PIX_FMT_VP8_FRAME``
155      - 'VP8F'
156      - VP8 parsed frame, including the frame header, as extracted from the container.
157	This format is adapted for stateless video decoders that implement an
158	VP8 pipeline with the :ref:`stateless_decoder`.
159	Metadata associated with the frame to decode is required to be passed
160	through the ``V4L2_CID_STATELESS_VP8_FRAME`` control.
161	See the :ref:`associated Codec Control IDs <v4l2-codec-stateless-vp8>`.
162	Exactly one output and one capture buffer must be provided for use with
163	this pixel format. The output buffer must contain the appropriate number
164	of macroblocks to decode a full corresponding frame to the matching
165	capture buffer.
166
167    * .. _V4L2-PIX-FMT-VP9:
168
169      - ``V4L2_PIX_FMT_VP9``
170      - 'VP90'
171      - VP9 compressed video frame. The encoder generates one
172	compressed frame per buffer, and the decoder requires one
173	compressed frame per buffer.
174    * .. _V4L2-PIX-FMT-HEVC:
175
176      - ``V4L2_PIX_FMT_HEVC``
177      - 'HEVC'
178      - HEVC/H.265 Access Unit.
179	The decoder expects one Access Unit per buffer.
180	The encoder generates one Access Unit per buffer.
181	If :ref:`VIDIOC_ENUM_FMT` reports ``V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM``
182	then the decoder has no	requirements since it can parse all the
183	information from the raw bytestream.
184    * .. _V4L2-PIX-FMT-HEVC-SLICE:
185
186      - ``V4L2_PIX_FMT_HEVC_SLICE``
187      - 'S265'
188      - HEVC parsed slice data, as extracted from the HEVC bitstream.
189	This format is adapted for stateless video decoders that implement a
190	HEVC pipeline (using the :ref:`mem2mem` and :ref:`media-request-api`).
191	This pixelformat has two modifiers that must be set at least once
192	through the ``V4L2_CID_MPEG_VIDEO_HEVC_DECODE_MODE``
193        and ``V4L2_CID_MPEG_VIDEO_HEVC_START_CODE`` controls.
194	Metadata associated with the frame to decode is required to be passed
195	through the following controls:
196        ``V4L2_CID_MPEG_VIDEO_HEVC_SPS``,
197        ``V4L2_CID_MPEG_VIDEO_HEVC_PPS``, and
198        ``V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS``.
199	See the :ref:`associated Codec Control IDs <v4l2-mpeg-hevc>`.
200	Buffers associated with this pixel format must contain the appropriate
201	number of macroblocks to decode a full corresponding frame.
202
203	.. note::
204
205	   This format is not yet part of the public kernel API and it
206	   is expected to change.
207    * .. _V4L2-PIX-FMT-FWHT:
208
209      - ``V4L2_PIX_FMT_FWHT``
210      - 'FWHT'
211      - Video elementary stream using a codec based on the Fast Walsh Hadamard
212        Transform. This codec is implemented by the vicodec ('Virtual Codec')
213	driver. See the codec-fwht.h header for more details.
214	:ref:`VIDIOC_ENUM_FMT` reports ``V4L2_FMT_FLAG_CONTINUOUS_BYTESTREAM``
215	since the decoder can parse all the information from the raw bytestream.
216    * .. _V4L2-PIX-FMT-FWHT-STATELESS:
217
218      - ``V4L2_PIX_FMT_FWHT_STATELESS``
219      - 'SFWH'
220      - Same format as V4L2_PIX_FMT_FWHT but requires stateless codec implementation.
221        Metadata associated with the frame to decode is required to be passed
222        through the ``V4L2_CID_STATELESS_FWHT_PARAMS`` control.
223	See the :ref:`associated Codec Control ID <codec-stateless-fwht>`.
224
225.. raw:: latex
226
227    \normalsize
228