1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
5 ***********************
6 Codec Control Reference
7 ***********************
9 Below all controls within the Codec control class are described. First
10 the generic controls, then controls specific for certain hardware.
14 These controls are applicable to all codecs and not just MPEG. The
15 defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG as the controls
16 were originally made for MPEG codecs and later extended to cover all
20 Generic Codec Controls
21 ======================
29 ``V4L2_CID_CODEC_CLASS (class)``
30 The Codec class descriptor. Calling
31 :ref:`VIDIOC_QUERYCTRL` for this control will
32 return a description of this control class. This description can be
33 used as the caption of a Tab page in a GUI, for example.
35 .. _v4l2-mpeg-stream-type:
37 ``V4L2_CID_MPEG_STREAM_TYPE``
40 enum v4l2_mpeg_stream_type -
41 The MPEG-1, -2 or -4 output stream type. One cannot assume anything
42 here. Each hardware MPEG encoder tends to support different subsets
43 of the available MPEG stream types. This control is specific to
44 multiplexed MPEG streams. The currently defined stream types are:
52 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_PS``
53 - MPEG-2 program stream
54 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_TS``
55 - MPEG-2 transport stream
56 * - ``V4L2_MPEG_STREAM_TYPE_MPEG1_SS``
57 - MPEG-1 system stream
58 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_DVD``
59 - MPEG-2 DVD-compatible stream
60 * - ``V4L2_MPEG_STREAM_TYPE_MPEG1_VCD``
61 - MPEG-1 VCD-compatible stream
62 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD``
63 - MPEG-2 SVCD-compatible stream
67 ``V4L2_CID_MPEG_STREAM_PID_PMT (integer)``
68 Program Map Table Packet ID for the MPEG transport stream (default
71 ``V4L2_CID_MPEG_STREAM_PID_AUDIO (integer)``
72 Audio Packet ID for the MPEG transport stream (default 256)
74 ``V4L2_CID_MPEG_STREAM_PID_VIDEO (integer)``
75 Video Packet ID for the MPEG transport stream (default 260)
77 ``V4L2_CID_MPEG_STREAM_PID_PCR (integer)``
78 Packet ID for the MPEG transport stream carrying PCR fields (default
81 ``V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (integer)``
84 ``V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (integer)``
87 .. _v4l2-mpeg-stream-vbi-fmt:
89 ``V4L2_CID_MPEG_STREAM_VBI_FMT``
92 enum v4l2_mpeg_stream_vbi_fmt -
93 Some cards can embed VBI data (e. g. Closed Caption, Teletext) into
94 the MPEG stream. This control selects whether VBI data should be
95 embedded, and if so, what embedding method should be used. The list
96 of possible VBI formats depends on the driver. The currently defined
101 .. tabularcolumns:: |p{6.6 cm}|p{10.9cm}|
107 * - ``V4L2_MPEG_STREAM_VBI_FMT_NONE``
108 - No VBI in the MPEG stream
109 * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV``
110 - VBI in private packets, IVTV format (documented in the kernel
112 ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``)
116 .. _v4l2-mpeg-audio-sampling-freq:
118 ``V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ``
121 enum v4l2_mpeg_audio_sampling_freq -
122 MPEG Audio sampling frequency. Possible values are:
130 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100``
132 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000``
134 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000``
139 .. _v4l2-mpeg-audio-encoding:
141 ``V4L2_CID_MPEG_AUDIO_ENCODING``
144 enum v4l2_mpeg_audio_encoding -
145 MPEG Audio encoding. This control is specific to multiplexed MPEG
146 streams. Possible values are:
154 * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_1``
155 - MPEG-1/2 Layer I encoding
156 * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_2``
157 - MPEG-1/2 Layer II encoding
158 * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_3``
159 - MPEG-1/2 Layer III encoding
160 * - ``V4L2_MPEG_AUDIO_ENCODING_AAC``
161 - MPEG-2/4 AAC (Advanced Audio Coding)
162 * - ``V4L2_MPEG_AUDIO_ENCODING_AC3``
163 - AC-3 aka ATSC A/52 encoding
167 .. _v4l2-mpeg-audio-l1-bitrate:
169 ``V4L2_CID_MPEG_AUDIO_L1_BITRATE``
172 enum v4l2_mpeg_audio_l1_bitrate -
173 MPEG-1/2 Layer I bitrate. Possible values are:
181 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_32K``
183 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_64K``
185 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_96K``
187 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_128K``
189 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_160K``
191 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_192K``
193 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_224K``
195 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_256K``
197 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_288K``
199 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_320K``
201 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_352K``
203 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_384K``
205 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_416K``
207 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_448K``
212 .. _v4l2-mpeg-audio-l2-bitrate:
214 ``V4L2_CID_MPEG_AUDIO_L2_BITRATE``
217 enum v4l2_mpeg_audio_l2_bitrate -
218 MPEG-1/2 Layer II bitrate. Possible values are:
226 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_32K``
228 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_48K``
230 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_56K``
232 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_64K``
234 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_80K``
236 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_96K``
238 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_112K``
240 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_128K``
242 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_160K``
244 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_192K``
246 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_224K``
248 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_256K``
250 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_320K``
252 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_384K``
257 .. _v4l2-mpeg-audio-l3-bitrate:
259 ``V4L2_CID_MPEG_AUDIO_L3_BITRATE``
262 enum v4l2_mpeg_audio_l3_bitrate -
263 MPEG-1/2 Layer III bitrate. Possible values are:
271 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_32K``
273 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_40K``
275 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_48K``
277 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_56K``
279 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_64K``
281 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_80K``
283 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_96K``
285 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_112K``
287 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_128K``
289 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_160K``
291 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_192K``
293 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_224K``
295 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_256K``
297 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_320K``
302 ``V4L2_CID_MPEG_AUDIO_AAC_BITRATE (integer)``
303 AAC bitrate in bits per second.
305 .. _v4l2-mpeg-audio-ac3-bitrate:
307 ``V4L2_CID_MPEG_AUDIO_AC3_BITRATE``
310 enum v4l2_mpeg_audio_ac3_bitrate -
311 AC-3 bitrate. Possible values are:
319 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_32K``
321 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_40K``
323 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_48K``
325 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_56K``
327 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_64K``
329 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_80K``
331 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_96K``
333 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_112K``
335 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_128K``
337 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_160K``
339 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_192K``
341 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_224K``
343 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_256K``
345 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_320K``
347 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_384K``
349 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_448K``
351 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_512K``
353 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_576K``
355 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_640K``
360 .. _v4l2-mpeg-audio-mode:
362 ``V4L2_CID_MPEG_AUDIO_MODE``
365 enum v4l2_mpeg_audio_mode -
366 MPEG Audio mode. Possible values are:
374 * - ``V4L2_MPEG_AUDIO_MODE_STEREO``
376 * - ``V4L2_MPEG_AUDIO_MODE_JOINT_STEREO``
378 * - ``V4L2_MPEG_AUDIO_MODE_DUAL``
380 * - ``V4L2_MPEG_AUDIO_MODE_MONO``
385 .. _v4l2-mpeg-audio-mode-extension:
387 ``V4L2_CID_MPEG_AUDIO_MODE_EXTENSION``
390 enum v4l2_mpeg_audio_mode_extension -
391 Joint Stereo audio mode extension. In Layer I and II they indicate
392 which subbands are in intensity stereo. All other subbands are coded
393 in stereo. Layer III is not (yet) supported. Possible values are:
395 .. tabularcolumns:: |p{9.1cm}|p{8.4cm}|
401 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4``
402 - Subbands 4-31 in intensity stereo
403 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8``
404 - Subbands 8-31 in intensity stereo
405 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12``
406 - Subbands 12-31 in intensity stereo
407 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16``
408 - Subbands 16-31 in intensity stereo
412 .. _v4l2-mpeg-audio-emphasis:
414 ``V4L2_CID_MPEG_AUDIO_EMPHASIS``
417 enum v4l2_mpeg_audio_emphasis -
418 Audio Emphasis. Possible values are:
426 * - ``V4L2_MPEG_AUDIO_EMPHASIS_NONE``
428 * - ``V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS``
429 - 50/15 microsecond emphasis
430 * - ``V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17``
435 .. _v4l2-mpeg-audio-crc:
437 ``V4L2_CID_MPEG_AUDIO_CRC``
440 enum v4l2_mpeg_audio_crc -
441 CRC method. Possible values are:
449 * - ``V4L2_MPEG_AUDIO_CRC_NONE``
451 * - ``V4L2_MPEG_AUDIO_CRC_CRC16``
452 - 16 bit parity check
456 ``V4L2_CID_MPEG_AUDIO_MUTE (boolean)``
457 Mutes the audio when capturing. This is not done by muting audio
458 hardware, which can still produce a slight hiss, but in the encoder
459 itself, guaranteeing a fixed and reproducible audio bitstream. 0 =
462 .. _v4l2-mpeg-audio-dec-playback:
464 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK``
467 enum v4l2_mpeg_audio_dec_playback -
468 Determines how monolingual audio should be played back. Possible
473 .. tabularcolumns:: |p{9.8cm}|p{7.7cm}|
479 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO``
480 - Automatically determines the best playback mode.
481 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO``
483 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_LEFT``
484 - Left channel playback.
485 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_RIGHT``
486 - Right channel playback.
487 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_MONO``
489 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO``
490 - Stereo playback with swapped left and right channels.
494 .. _v4l2-mpeg-audio-dec-multilingual-playback:
496 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK``
499 enum v4l2_mpeg_audio_dec_playback -
500 Determines how multilingual audio should be played back.
502 .. _v4l2-mpeg-video-encoding:
504 ``V4L2_CID_MPEG_VIDEO_ENCODING``
507 enum v4l2_mpeg_video_encoding -
508 MPEG Video encoding method. This control is specific to multiplexed
509 MPEG streams. Possible values are:
517 * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_1``
518 - MPEG-1 Video encoding
519 * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_2``
520 - MPEG-2 Video encoding
521 * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC``
522 - MPEG-4 AVC (H.264) Video encoding
526 .. _v4l2-mpeg-video-aspect:
528 ``V4L2_CID_MPEG_VIDEO_ASPECT``
531 enum v4l2_mpeg_video_aspect -
532 Video aspect. Possible values are:
540 * - ``V4L2_MPEG_VIDEO_ASPECT_1x1``
541 * - ``V4L2_MPEG_VIDEO_ASPECT_4x3``
542 * - ``V4L2_MPEG_VIDEO_ASPECT_16x9``
543 * - ``V4L2_MPEG_VIDEO_ASPECT_221x100``
547 ``V4L2_CID_MPEG_VIDEO_B_FRAMES (integer)``
548 Number of B-Frames (default 2)
550 ``V4L2_CID_MPEG_VIDEO_GOP_SIZE (integer)``
551 GOP size (default 12)
553 ``V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (boolean)``
554 GOP closure (default 1)
556 ``V4L2_CID_MPEG_VIDEO_PULLDOWN (boolean)``
557 Enable 3:2 pulldown (default 0)
559 .. _v4l2-mpeg-video-bitrate-mode:
561 ``V4L2_CID_MPEG_VIDEO_BITRATE_MODE``
564 enum v4l2_mpeg_video_bitrate_mode -
565 Video bitrate mode. Possible values are:
573 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_VBR``
575 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_CBR``
577 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_CQ``
582 ``V4L2_CID_MPEG_VIDEO_BITRATE (integer)``
583 Average video bitrate in bits per second.
585 ``V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (integer)``
586 Peak video bitrate in bits per second. Must be larger or equal to
587 the average video bitrate. It is ignored if the video bitrate mode
588 is set to constant bitrate.
590 ``V4L2_CID_MPEG_VIDEO_CONSTANT_QUALITY (integer)``
591 Constant quality level control. This control is applicable when
592 ``V4L2_CID_MPEG_VIDEO_BITRATE_MODE`` value is
593 ``V4L2_MPEG_VIDEO_BITRATE_MODE_CQ``. Valid range is 1 to 100
594 where 1 indicates lowest quality and 100 indicates highest quality.
595 Encoder will decide the appropriate quantization parameter and
596 bitrate to produce requested frame quality.
599 ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE (enum)``
601 enum v4l2_mpeg_video_frame_skip_mode -
602 Indicates in what conditions the encoder should skip frames. If
603 encoding a frame would cause the encoded stream to be larger then a
604 chosen data limit then the frame will be skipped. Possible values
608 .. tabularcolumns:: |p{8.2cm}|p{9.3cm}|
618 * - ``V4L2_MPEG_VIDEO_FRAME_SKIP_MODE_DISABLED``
619 - Frame skip mode is disabled.
620 * - ``V4L2_MPEG_VIDEO_FRAME_SKIP_MODE_LEVEL_LIMIT``
621 - Frame skip mode enabled and buffer limit is set by the chosen
622 level and is defined by the standard.
623 * - ``V4L2_MPEG_VIDEO_FRAME_SKIP_MODE_BUF_LIMIT``
624 - Frame skip mode enabled and buffer limit is set by the
625 :ref:`VBV (MPEG1/2/4) <v4l2-mpeg-video-vbv-size>` or
626 :ref:`CPB (H264) buffer size <v4l2-mpeg-video-h264-cpb-size>` control.
632 ``V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (integer)``
633 For every captured frame, skip this many subsequent frames (default
636 ``V4L2_CID_MPEG_VIDEO_MUTE (boolean)``
637 "Mutes" the video to a fixed color when capturing. This is useful
638 for testing, to produce a fixed video bitstream. 0 = unmuted, 1 =
641 ``V4L2_CID_MPEG_VIDEO_MUTE_YUV (integer)``
642 Sets the "mute" color of the video. The supplied 32-bit integer is
643 interpreted as follows (bit 0 = least significant bit):
652 - V chrominance information
654 - U chrominance information
656 - Y luminance information
662 .. _v4l2-mpeg-video-dec-pts:
664 ``V4L2_CID_MPEG_VIDEO_DEC_PTS (integer64)``
665 This read-only control returns the 33-bit video Presentation Time
666 Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the
667 currently displayed frame. This is the same PTS as is used in
668 :ref:`VIDIOC_DECODER_CMD`.
670 .. _v4l2-mpeg-video-dec-frame:
672 ``V4L2_CID_MPEG_VIDEO_DEC_FRAME (integer64)``
673 This read-only control returns the frame counter of the frame that
674 is currently displayed (decoded). This value is reset to 0 whenever
675 the decoder is started.
677 ``V4L2_CID_MPEG_VIDEO_DEC_CONCEAL_COLOR (integer64)``
678 This control sets the conceal color in YUV color space. It describes
679 the client preference of the error conceal color in case of an error
680 where the reference frame is missing. The decoder should fill the
681 reference buffer with the preferred color and use it for future
682 decoding. The control is using 16 bits per channel.
683 Applicable to decoders.
710 ``V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE (boolean)``
711 If enabled the decoder expects to receive a single slice per buffer,
712 otherwise the decoder expects a single frame in per buffer.
713 Applicable to the decoder, all codecs.
715 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY_ENABLE (boolean)``
716 If the display delay is enabled then the decoder is forced to return
717 a CAPTURE buffer (decoded frame) after processing a certain number
718 of OUTPUT buffers. The delay can be set through
719 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY``. This
720 feature can be used for example for generating thumbnails of videos.
721 Applicable to the decoder.
723 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY (integer)``
724 Display delay value for decoder. The decoder is forced to
725 return a decoded frame after the set 'display delay' number of
726 frames. If this number is low it may result in frames returned out
727 of display order, in addition the hardware may still be using the
728 returned buffer as a reference picture for subsequent frames.
730 ``V4L2_CID_MPEG_VIDEO_AU_DELIMITER (boolean)``
731 If enabled then, AUD (Access Unit Delimiter) NALUs will be generated.
732 That could be useful to find the start of a frame without having to
733 fully parse each NALU. Applicable to the H264 and HEVC encoders.
735 ``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE (boolean)``
736 Enable writing sample aspect ratio in the Video Usability
737 Information. Applicable to the H264 encoder.
739 .. _v4l2-mpeg-video-h264-vui-sar-idc:
741 ``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC``
744 enum v4l2_mpeg_video_h264_vui_sar_idc -
745 VUI sample aspect ratio indicator for H.264 encoding. The value is
746 defined in the table E-1 in the standard. Applicable to the H264
755 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED``
757 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1``
759 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11``
761 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11``
763 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11``
765 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33``
767 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11``
769 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11``
771 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11``
773 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33``
775 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11``
777 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11``
779 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33``
781 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99``
783 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3``
785 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2``
787 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1``
789 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED``
794 ``V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH (integer)``
795 Extended sample aspect ratio width for H.264 VUI encoding.
796 Applicable to the H264 encoder.
798 ``V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT (integer)``
799 Extended sample aspect ratio height for H.264 VUI encoding.
800 Applicable to the H264 encoder.
802 .. _v4l2-mpeg-video-h264-level:
804 ``V4L2_CID_MPEG_VIDEO_H264_LEVEL``
807 enum v4l2_mpeg_video_h264_level -
808 The level information for the H264 video elementary stream.
809 Applicable to the H264 encoder. Possible values are:
817 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_0``
819 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1B``
821 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_1``
823 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_2``
825 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_3``
827 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_0``
829 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_1``
831 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_2``
833 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_0``
835 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_1``
837 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_2``
839 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_0``
841 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_1``
843 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_2``
845 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_0``
847 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_1``
849 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_2``
851 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_0``
853 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_1``
855 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_2``
860 .. _v4l2-mpeg-video-mpeg2-level:
862 ``V4L2_CID_MPEG_VIDEO_MPEG2_LEVEL``
865 enum v4l2_mpeg_video_mpeg2_level -
866 The level information for the MPEG2 elementary stream. Applicable to
867 MPEG2 codecs. Possible values are:
875 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_LOW``
877 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_MAIN``
879 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH_1440``
880 - High-1440 Level (H-14)
881 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH``
886 .. _v4l2-mpeg-video-mpeg4-level:
888 ``V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL``
891 enum v4l2_mpeg_video_mpeg4_level -
892 The level information for the MPEG4 elementary stream. Applicable to
893 the MPEG4 encoder. Possible values are:
901 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0``
903 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0B``
905 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_1``
907 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_2``
909 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3``
911 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3B``
913 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_4``
915 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_5``
920 .. _v4l2-mpeg-video-h264-profile:
922 ``V4L2_CID_MPEG_VIDEO_H264_PROFILE``
925 enum v4l2_mpeg_video_h264_profile -
926 The profile information for H264. Applicable to the H264 encoder.
933 .. tabularcolumns:: |p{10.2cm}|p{7.3cm}|
939 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE``
941 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE``
942 - Constrained Baseline profile
943 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MAIN``
945 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED``
947 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH``
949 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10``
951 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422``
953 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE``
954 - High 444 Predictive profile
955 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA``
956 - High 10 Intra profile
957 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA``
958 - High 422 Intra profile
959 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA``
960 - High 444 Intra profile
961 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA``
962 - CAVLC 444 Intra profile
963 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE``
964 - Scalable Baseline profile
965 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH``
966 - Scalable High profile
967 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA``
968 - Scalable High Intra profile
969 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH``
970 - Stereo High profile
971 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH``
972 - Multiview High profile
973 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_HIGH``
974 - Constrained High profile
980 .. _v4l2-mpeg-video-mpeg2-profile:
982 ``V4L2_CID_MPEG_VIDEO_MPEG2_PROFILE``
985 enum v4l2_mpeg_video_mpeg2_profile -
986 The profile information for MPEG2. Applicable to MPEG2 codecs.
993 .. tabularcolumns:: |p{10.2cm}|p{7.3cm}|
999 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SIMPLE``
1000 - Simple profile (SP)
1001 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MAIN``
1003 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SNR_SCALABLE``
1004 - SNR Scalable profile (SNR)
1005 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SPATIALLY_SCALABLE``
1006 - Spatially Scalable profile (Spt)
1007 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_HIGH``
1009 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MULTIVIEW``
1010 - Multi-view profile (MVP)
1017 .. _v4l2-mpeg-video-mpeg4-profile:
1019 ``V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE``
1022 enum v4l2_mpeg_video_mpeg4_profile -
1023 The profile information for MPEG4. Applicable to the MPEG4 encoder.
1024 Possible values are:
1030 .. tabularcolumns:: |p{11.8cm}|p{5.7cm}|
1036 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE``
1038 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_SIMPLE``
1039 - Advanced Simple profile
1040 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_CORE``
1042 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE_SCALABLE``
1043 - Simple Scalable profile
1044 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_CODING_EFFICIENCY``
1045 - Advanced Coding Efficiency profile
1051 ``V4L2_CID_MPEG_VIDEO_MAX_REF_PIC (integer)``
1052 The maximum number of reference pictures used for encoding.
1053 Applicable to the encoder.
1055 .. _v4l2-mpeg-video-multi-slice-mode:
1057 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE``
1060 enum v4l2_mpeg_video_multi_slice_mode -
1061 Determines how the encoder should handle division of frame into
1062 slices. Applicable to the encoder. Possible values are:
1066 .. tabularcolumns:: |p{9.6cm}|p{7.9cm}|
1072 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE``
1073 - Single slice per frame.
1074 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB``
1075 - Multiple slices with set maximum number of macroblocks per slice.
1076 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``
1077 - Multiple slice with set maximum size in bytes per slice.
1081 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB (integer)``
1082 The maximum number of macroblocks in a slice. Used when
1083 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to
1084 ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB``. Applicable to the
1087 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES (integer)``
1088 The maximum size of a slice in bytes. Used when
1089 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to
1090 ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``. Applicable to the
1093 .. _v4l2-mpeg-video-h264-loop-filter-mode:
1095 ``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE``
1098 enum v4l2_mpeg_video_h264_loop_filter_mode -
1099 Loop filter mode for H264 encoder. Possible values are:
1105 .. tabularcolumns:: |p{13.5cm}|p{4.0cm}|
1111 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED``
1112 - Loop filter is enabled.
1113 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED``
1114 - Loop filter is disabled.
1115 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY``
1116 - Loop filter is disabled at the slice boundary.
1123 ``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA (integer)``
1124 Loop filter alpha coefficient, defined in the H264 standard.
1125 This value corresponds to the slice_alpha_c0_offset_div2 slice header
1126 field, and should be in the range of -6 to +6, inclusive. The actual alpha
1127 offset FilterOffsetA is twice this value.
1128 Applicable to the H264 encoder.
1130 ``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA (integer)``
1131 Loop filter beta coefficient, defined in the H264 standard.
1132 This corresponds to the slice_beta_offset_div2 slice header field, and
1133 should be in the range of -6 to +6, inclusive. The actual beta offset
1134 FilterOffsetB is twice this value.
1135 Applicable to the H264 encoder.
1137 .. _v4l2-mpeg-video-h264-entropy-mode:
1139 ``V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE``
1142 enum v4l2_mpeg_video_h264_entropy_mode -
1143 Entropy coding mode for H264 - CABAC/CAVALC. Applicable to the H264
1144 encoder. Possible values are:
1147 .. tabularcolumns:: |p{9.0cm}|p{8.5cm}|
1154 * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC``
1155 - Use CAVLC entropy coding.
1156 * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC``
1157 - Use CABAC entropy coding.
1161 ``V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM (boolean)``
1162 Enable 8X8 transform for H264. Applicable to the H264 encoder.
1164 ``V4L2_CID_MPEG_VIDEO_H264_CONSTRAINED_INTRA_PREDICTION (boolean)``
1165 Enable constrained intra prediction for H264. Applicable to the H264
1168 ``V4L2_CID_MPEG_VIDEO_H264_CHROMA_QP_INDEX_OFFSET (integer)``
1169 Specify the offset that should be added to the luma quantization
1170 parameter to determine the chroma quantization parameter. Applicable
1171 to the H264 encoder.
1173 ``V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB (integer)``
1174 Cyclic intra macroblock refresh. This is the number of continuous
1175 macroblocks refreshed every frame. Each frame a successive set of
1176 macroblocks is refreshed until the cycle completes and starts from
1177 the top of the frame. Applicable to H264, H263 and MPEG4 encoder.
1179 ``V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE (boolean)``
1180 Frame level rate control enable. If this control is disabled then
1181 the quantization parameter for each frame type is constant and set
1182 with appropriate controls (e.g.
1183 ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP``). If frame rate control is
1184 enabled then quantization parameter is adjusted to meet the chosen
1185 bitrate. Minimum and maximum value for the quantization parameter
1186 can be set with appropriate controls (e.g.
1187 ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP``). Applicable to encoders.
1189 ``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE (boolean)``
1190 Macroblock level rate control enable. Applicable to the MPEG4 and
1193 ``V4L2_CID_MPEG_VIDEO_MPEG4_QPEL (boolean)``
1194 Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4
1197 ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP (integer)``
1198 Quantization parameter for an I frame for H263. Valid range: from 1
1201 ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP (integer)``
1202 Minimum quantization parameter for H263. Valid range: from 1 to 31.
1204 ``V4L2_CID_MPEG_VIDEO_H263_MAX_QP (integer)``
1205 Maximum quantization parameter for H263. Valid range: from 1 to 31.
1207 ``V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP (integer)``
1208 Quantization parameter for an P frame for H263. Valid range: from 1
1211 ``V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP (integer)``
1212 Quantization parameter for an B frame for H263. Valid range: from 1
1215 ``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP (integer)``
1216 Quantization parameter for an I frame for H264. Valid range: from 0
1219 ``V4L2_CID_MPEG_VIDEO_H264_MIN_QP (integer)``
1220 Minimum quantization parameter for H264. Valid range: from 0 to 51.
1222 ``V4L2_CID_MPEG_VIDEO_H264_MAX_QP (integer)``
1223 Maximum quantization parameter for H264. Valid range: from 0 to 51.
1225 ``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP (integer)``
1226 Quantization parameter for an P frame for H264. Valid range: from 0
1229 ``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP (integer)``
1230 Quantization parameter for an B frame for H264. Valid range: from 0
1233 ``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MIN_QP (integer)``
1234 Minimum quantization parameter for the H264 I frame to limit I frame
1235 quality to a range. Valid range: from 0 to 51. If
1236 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter
1237 should be chosen to meet both requirements.
1239 ``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MAX_QP (integer)``
1240 Maximum quantization parameter for the H264 I frame to limit I frame
1241 quality to a range. Valid range: from 0 to 51. If
1242 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter
1243 should be chosen to meet both requirements.
1245 ``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MIN_QP (integer)``
1246 Minimum quantization parameter for the H264 P frame to limit P frame
1247 quality to a range. Valid range: from 0 to 51. If
1248 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter
1249 should be chosen to meet both requirements.
1251 ``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MAX_QP (integer)``
1252 Maximum quantization parameter for the H264 P frame to limit P frame
1253 quality to a range. Valid range: from 0 to 51. If
1254 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter
1255 should be chosen to meet both requirements.
1257 ``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_MIN_QP (integer)``
1258 Minimum quantization parameter for the H264 B frame to limit B frame
1259 quality to a range. Valid range: from 0 to 51. If
1260 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter
1261 should be chosen to meet both requirements.
1263 ``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_MAX_QP (integer)``
1264 Maximum quantization parameter for the H264 B frame to limit B frame
1265 quality to a range. Valid range: from 0 to 51. If
1266 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter
1267 should be chosen to meet both requirements.
1269 ``V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP (integer)``
1270 Quantization parameter for an I frame for MPEG4. Valid range: from 1
1273 ``V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP (integer)``
1274 Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.
1276 ``V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP (integer)``
1277 Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.
1279 ``V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP (integer)``
1280 Quantization parameter for an P frame for MPEG4. Valid range: from 1
1283 ``V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP (integer)``
1284 Quantization parameter for an B frame for MPEG4. Valid range: from 1
1287 .. _v4l2-mpeg-video-vbv-size:
1289 ``V4L2_CID_MPEG_VIDEO_VBV_SIZE (integer)``
1290 The Video Buffer Verifier size in kilobytes, it is used as a
1291 limitation of frame skip. The VBV is defined in the standard as a
1292 mean to verify that the produced stream will be successfully
1293 decoded. The standard describes it as "Part of a hypothetical
1294 decoder that is conceptually connected to the output of the encoder.
1295 Its purpose is to provide a constraint on the variability of the
1296 data rate that an encoder or editing process may produce.".
1297 Applicable to the MPEG1, MPEG2, MPEG4 encoders.
1299 .. _v4l2-mpeg-video-vbv-delay:
1301 ``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)``
1302 Sets the initial delay in milliseconds for VBV buffer control.
1304 .. _v4l2-mpeg-video-hor-search-range:
1306 ``V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE (integer)``
1307 Horizontal search range defines maximum horizontal search area in
1308 pixels to search and match for the present Macroblock (MB) in the
1309 reference picture. This V4L2 control macro is used to set horizontal
1310 search range for motion estimation module in video encoder.
1312 .. _v4l2-mpeg-video-vert-search-range:
1314 ``V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE (integer)``
1315 Vertical search range defines maximum vertical search area in pixels
1316 to search and match for the present Macroblock (MB) in the reference
1317 picture. This V4L2 control macro is used to set vertical search
1318 range for motion estimation module in video encoder.
1320 .. _v4l2-mpeg-video-force-key-frame:
1322 ``V4L2_CID_MPEG_VIDEO_FORCE_KEY_FRAME (button)``
1323 Force a key frame for the next queued buffer. Applicable to
1324 encoders. This is a general, codec-agnostic keyframe control.
1326 .. _v4l2-mpeg-video-h264-cpb-size:
1328 ``V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE (integer)``
1329 The Coded Picture Buffer size in kilobytes, it is used as a
1330 limitation of frame skip. The CPB is defined in the H264 standard as
1331 a mean to verify that the produced stream will be successfully
1332 decoded. Applicable to the H264 encoder.
1334 ``V4L2_CID_MPEG_VIDEO_H264_I_PERIOD (integer)``
1335 Period between I-frames in the open GOP for H264. In case of an open
1336 GOP this is the period between two I-frames. The period between IDR
1337 (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE
1338 control. An IDR frame, which stands for Instantaneous Decoding
1339 Refresh is an I-frame after which no prior frames are referenced.
1340 This means that a stream can be restarted from an IDR frame without
1341 the need to store or decode any previous frames. Applicable to the
1344 .. _v4l2-mpeg-video-header-mode:
1346 ``V4L2_CID_MPEG_VIDEO_HEADER_MODE``
1349 enum v4l2_mpeg_video_header_mode -
1350 Determines whether the header is returned as the first buffer or is
1351 it returned together with the first frame. Applicable to encoders.
1352 Possible values are:
1358 .. tabularcolumns:: |p{10.3cm}|p{7.2cm}|
1364 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE``
1365 - The stream header is returned separately in the first buffer.
1366 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME``
1367 - The stream header is returned together with the first encoded
1375 ``V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER (boolean)``
1376 Repeat the video sequence headers. Repeating these headers makes
1377 random access to the video stream easier. Applicable to the MPEG1, 2
1380 ``V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER (boolean)``
1381 Enabled the deblocking post processing filter for MPEG4 decoder.
1382 Applicable to the MPEG4 decoder.
1384 ``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES (integer)``
1385 vop_time_increment_resolution value for MPEG4. Applicable to the
1388 ``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC (integer)``
1389 vop_time_increment value for MPEG4. Applicable to the MPEG4
1392 ``V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING (boolean)``
1393 Enable generation of frame packing supplemental enhancement
1394 information in the encoded bitstream. The frame packing SEI message
1395 contains the arrangement of L and R planes for 3D viewing.
1396 Applicable to the H264 encoder.
1398 ``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0 (boolean)``
1399 Sets current frame as frame0 in frame packing SEI. Applicable to the
1402 .. _v4l2-mpeg-video-h264-sei-fp-arrangement-type:
1404 ``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE``
1407 enum v4l2_mpeg_video_h264_sei_fp_arrangement_type -
1408 Frame packing arrangement type for H264 SEI. Applicable to the H264
1409 encoder. Possible values are:
1415 .. tabularcolumns:: |p{12cm}|p{5.5cm}|
1421 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_CHEKERBOARD``
1422 - Pixels are alternatively from L and R.
1423 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_COLUMN``
1424 - L and R are interlaced by column.
1425 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_ROW``
1426 - L and R are interlaced by row.
1427 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_SIDE_BY_SIDE``
1428 - L is on the left, R on the right.
1429 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TOP_BOTTOM``
1430 - L is on top, R on bottom.
1431 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TEMPORAL``
1432 - One view per frame.
1440 ``V4L2_CID_MPEG_VIDEO_H264_FMO (boolean)``
1441 Enables flexible macroblock ordering in the encoded bitstream. It is
1442 a technique used for restructuring the ordering of macroblocks in
1443 pictures. Applicable to the H264 encoder.
1445 .. _v4l2-mpeg-video-h264-fmo-map-type:
1447 ``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE``
1450 enum v4l2_mpeg_video_h264_fmo_map_type -
1451 When using FMO, the map type divides the image in different scan
1452 patterns of macroblocks. Applicable to the H264 encoder. Possible
1459 .. tabularcolumns:: |p{12.5cm}|p{5.0cm}|
1465 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES``
1466 - Slices are interleaved one after other with macroblocks in run
1468 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_SCATTERED_SLICES``
1469 - Scatters the macroblocks based on a mathematical function known to
1470 both encoder and decoder.
1471 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_FOREGROUND_WITH_LEFT_OVER``
1472 - Macroblocks arranged in rectangular areas or regions of interest.
1473 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_BOX_OUT``
1474 - Slice groups grow in a cyclic way from centre to outwards.
1475 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_RASTER_SCAN``
1476 - Slice groups grow in raster scan pattern from left to right.
1477 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_WIPE_SCAN``
1478 - Slice groups grow in wipe scan pattern from top to bottom.
1479 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_EXPLICIT``
1480 - User defined map type.
1488 ``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)``
1489 Number of slice groups in FMO. Applicable to the H264 encoder.
1491 .. _v4l2-mpeg-video-h264-fmo-change-direction:
1493 ``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION``
1496 enum v4l2_mpeg_video_h264_fmo_change_dir -
1497 Specifies a direction of the slice group change for raster and wipe
1498 maps. Applicable to the H264 encoder. Possible values are:
1500 .. tabularcolumns:: |p{9.6cm}|p{7.9cm}|
1506 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_RIGHT``
1507 - Raster scan or wipe right.
1508 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_LEFT``
1509 - Reverse raster scan or wipe left.
1513 ``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE (integer)``
1514 Specifies the size of the first slice group for raster and wipe map.
1515 Applicable to the H264 encoder.
1517 ``V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH (integer)``
1518 Specifies the number of consecutive macroblocks for the interleaved
1519 map. Applicable to the H264 encoder.
1521 ``V4L2_CID_MPEG_VIDEO_H264_ASO (boolean)``
1522 Enables arbitrary slice ordering in encoded bitstream. Applicable to
1525 ``V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER (integer)``
1526 Specifies the slice order in ASO. Applicable to the H264 encoder.
1527 The supplied 32-bit integer is interpreted as follows (bit 0 = least
1539 - Slice position or order
1543 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)``
1544 Enables H264 hierarchical coding. Applicable to the H264 encoder.
1546 .. _v4l2-mpeg-video-h264-hierarchical-coding-type:
1548 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE``
1551 enum v4l2_mpeg_video_h264_hierarchical_coding_type -
1552 Specifies the hierarchical coding type. Applicable to the H264
1553 encoder. Possible values are:
1561 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B``
1562 - Hierarchical B coding.
1563 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P``
1564 - Hierarchical P coding.
1568 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER (integer)``
1569 Specifies the number of hierarchical coding layers. Applicable to
1572 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP (integer)``
1573 Specifies a user defined QP for each layer. Applicable to the H264
1574 encoder. The supplied 32-bit integer is interpreted as follows (bit
1575 0 = least significant bit):
1588 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L0_BR (integer)``
1589 Indicates bit rate (bps) for hierarchical coding layer 0 for H264 encoder.
1591 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L1_BR (integer)``
1592 Indicates bit rate (bps) for hierarchical coding layer 1 for H264 encoder.
1594 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L2_BR (integer)``
1595 Indicates bit rate (bps) for hierarchical coding layer 2 for H264 encoder.
1597 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L3_BR (integer)``
1598 Indicates bit rate (bps) for hierarchical coding layer 3 for H264 encoder.
1600 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L4_BR (integer)``
1601 Indicates bit rate (bps) for hierarchical coding layer 4 for H264 encoder.
1603 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L5_BR (integer)``
1604 Indicates bit rate (bps) for hierarchical coding layer 5 for H264 encoder.
1606 ``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L6_BR (integer)``
1607 Indicates bit rate (bps) for hierarchical coding layer 6 for H264 encoder.
1609 ``V4L2_CID_FWHT_I_FRAME_QP (integer)``
1610 Quantization parameter for an I frame for FWHT. Valid range: from 1
1613 ``V4L2_CID_FWHT_P_FRAME_QP (integer)``
1614 Quantization parameter for a P frame for FWHT. Valid range: from 1
1622 MFC 5.1 MPEG Controls
1623 =====================
1625 The following MPEG class controls deal with MPEG decoding and encoding
1626 settings that are specific to the Multi Format Codec 5.1 device present
1627 in the S5P family of SoCs by Samsung.
1630 .. _mfc51-control-id:
1635 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE (boolean)``
1636 If the display delay is enabled then the decoder is forced to return
1637 a CAPTURE buffer (decoded frame) after processing a certain number
1638 of OUTPUT buffers. The delay can be set through
1639 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY``. This
1640 feature can be used for example for generating thumbnails of videos.
1641 Applicable to the H264 decoder.
1645 This control is deprecated. Use the standard
1646 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY_ENABLE`` control instead.
1648 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY (integer)``
1649 Display delay value for H264 decoder. The decoder is forced to
1650 return a decoded frame after the set 'display delay' number of
1651 frames. If this number is low it may result in frames returned out
1652 of display order, in addition the hardware may still be using the
1653 returned buffer as a reference picture for subsequent frames.
1657 This control is deprecated. Use the standard
1658 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY`` control instead.
1660 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)``
1661 The number of reference pictures used for encoding a P picture.
1662 Applicable to the H264 encoder.
1664 ``V4L2_CID_MPEG_MFC51_VIDEO_PADDING (boolean)``
1665 Padding enable in the encoder - use a color instead of repeating
1666 border pixels. Applicable to encoders.
1668 ``V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV (integer)``
1669 Padding color in the encoder. Applicable to encoders. The supplied
1670 32-bit integer is interpreted as follows (bit 0 = least significant
1680 - V chrominance information
1682 - U chrominance information
1684 - Y luminance information
1690 ``V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF (integer)``
1691 Reaction coefficient for MFC rate control. Applicable to encoders.
1695 #. Valid only when the frame level RC is enabled.
1697 #. For tight CBR, this field must be small (ex. 2 ~ 10). For
1698 VBR, this field must be large (ex. 100 ~ 1000).
1700 #. It is not recommended to use the greater number than
1701 FRAME_RATE * (10^9 / BIT_RATE).
1703 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK (boolean)``
1704 Adaptive rate control for dark region. Valid only when H.264 and
1705 macroblock level RC is enabled
1706 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1709 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH (boolean)``
1710 Adaptive rate control for smooth region. Valid only when H.264 and
1711 macroblock level RC is enabled
1712 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1715 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC (boolean)``
1716 Adaptive rate control for static region. Valid only when H.264 and
1717 macroblock level RC is enabled
1718 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1721 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY (boolean)``
1722 Adaptive rate control for activity region. Valid only when H.264 and
1723 macroblock level RC is enabled
1724 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1727 .. _v4l2-mpeg-mfc51-video-frame-skip-mode:
1729 ``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE``
1734 This control is deprecated. Use the standard
1735 ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE`` control instead.
1737 enum v4l2_mpeg_mfc51_video_frame_skip_mode -
1738 Indicates in what conditions the encoder should skip frames. If
1739 encoding a frame would cause the encoded stream to be larger then a
1740 chosen data limit then the frame will be skipped. Possible values
1744 .. tabularcolumns:: |p{9.4cm}|p{8.1cm}|
1754 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_DISABLED``
1755 - Frame skip mode is disabled.
1756 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_LEVEL_LIMIT``
1757 - Frame skip mode enabled and buffer limit is set by the chosen
1758 level and is defined by the standard.
1759 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_BUF_LIMIT``
1760 - Frame skip mode enabled and buffer limit is set by the VBV
1761 (MPEG1/2/4) or CPB (H264) buffer size control.
1767 ``V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT (integer)``
1768 Enable rate-control with fixed target bit. If this setting is
1769 enabled, then the rate control logic of the encoder will calculate
1770 the average bitrate for a GOP and keep it below or equal the set
1771 bitrate target. Otherwise the rate control logic calculates the
1772 overall average bitrate for the stream and keeps it below or equal
1773 to the set bitrate. In the first case the average bitrate for the
1774 whole stream will be smaller then the set bitrate. This is caused
1775 because the average is calculated for smaller number of frames, on
1776 the other hand enabling this setting will ensure that the stream
1777 will meet tight bandwidth constraints. Applicable to encoders.
1779 .. _v4l2-mpeg-mfc51-video-force-frame-type:
1781 ``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE``
1784 enum v4l2_mpeg_mfc51_video_force_frame_type -
1785 Force a frame type for the next queued buffer. Applicable to
1786 encoders. Possible values are:
1788 .. tabularcolumns:: |p{9.9cm}|p{7.6cm}|
1794 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED``
1795 - Forcing a specific frame type disabled.
1796 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME``
1798 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED``
1799 - Force a non-coded frame.
1802 CX2341x MPEG Controls
1803 =====================
1805 The following MPEG class controls deal with MPEG encoding settings that
1806 are specific to the Conexant CX23415 and CX23416 MPEG encoding chips.
1809 .. _cx2341x-control-id:
1814 .. _v4l2-mpeg-cx2341x-video-spatial-filter-mode:
1816 ``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE``
1819 enum v4l2_mpeg_cx2341x_video_spatial_filter_mode -
1820 Sets the Spatial Filter mode (default ``MANUAL``). Possible values
1824 .. tabularcolumns:: |p{11.5cm}|p{6.0cm}|
1830 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL``
1831 - Choose the filter manually
1832 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO``
1833 - Choose the filter automatically
1837 ``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (integer (0-15))``
1838 The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default
1841 .. _luma-spatial-filter-type:
1843 ``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE``
1846 enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type -
1847 Select the algorithm to use for the Luma Spatial Filter (default
1848 ``1D_HOR``). Possible values:
1850 .. tabularcolumns:: |p{13.1cm}|p{4.4cm}|
1860 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF``
1862 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR``
1863 - One-dimensional horizontal
1864 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT``
1865 - One-dimensional vertical
1866 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE``
1867 - Two-dimensional separable
1868 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE``
1869 - Two-dimensional symmetrical non-separable
1875 .. _chroma-spatial-filter-type:
1877 ``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE``
1880 enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type -
1881 Select the algorithm for the Chroma Spatial Filter (default
1882 ``1D_HOR``). Possible values are:
1888 .. tabularcolumns:: |p{11.0cm}|p{6.5cm}|
1894 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF``
1896 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR``
1897 - One-dimensional horizontal
1903 .. _v4l2-mpeg-cx2341x-video-temporal-filter-mode:
1905 ``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE``
1908 enum v4l2_mpeg_cx2341x_video_temporal_filter_mode -
1909 Sets the Temporal Filter mode (default ``MANUAL``). Possible values
1920 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL``
1921 - Choose the filter manually
1922 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO``
1923 - Choose the filter automatically
1929 ``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (integer (0-31))``
1930 The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default
1931 is 8 for full-scale capturing and 0 for scaled capturing.)
1933 .. _v4l2-mpeg-cx2341x-video-median-filter-type:
1935 ``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE``
1938 enum v4l2_mpeg_cx2341x_video_median_filter_type -
1939 Median Filter Type (default ``OFF``). Possible values are:
1946 .. tabularcolumns:: |p{11.0cm}|p{6.5cm}|
1952 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF``
1954 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR``
1956 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT``
1958 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT``
1959 - Horizontal and vertical filter
1960 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG``
1967 ``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (integer (0-255))``
1968 Threshold above which the luminance median filter is enabled
1971 ``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (integer (0-255))``
1972 Threshold below which the luminance median filter is enabled
1975 ``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (integer (0-255))``
1976 Threshold above which the chroma median filter is enabled (default
1979 ``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (integer (0-255))``
1980 Threshold below which the chroma median filter is enabled (default
1983 ``V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (boolean)``
1984 The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into
1985 the stream between every four video frames. The packet size is 2048
1986 bytes, including the packet_start_code_prefix and stream_id
1987 fields. The stream_id is 0xBF (private stream 2). The payload
1988 consists of 0x00 bytes, to be filled in by the application. 0 = do
1989 not insert, 1 = insert packets.
1992 VPX Control Reference
1993 =====================
1995 The VPX controls include controls for encoding parameters of VPx video
2004 .. _v4l2-vpx-num-partitions:
2006 ``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS``
2009 enum v4l2_vp8_num_partitions -
2010 The number of token partitions to use in VP8 encoder. Possible
2019 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION``
2020 - 1 coefficient partition
2021 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS``
2022 - 2 coefficient partitions
2023 * - ``V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS``
2024 - 4 coefficient partitions
2025 * - ``V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS``
2026 - 8 coefficient partitions
2030 ``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)``
2031 Setting this prevents intra 4x4 mode in the intra mode decision.
2033 .. _v4l2-vpx-num-ref-frames:
2035 ``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES``
2038 enum v4l2_vp8_num_ref_frames -
2039 The number of reference pictures for encoding P frames. Possible
2042 .. tabularcolumns:: |p{7.5cm}|p{7.5cm}|
2052 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME``
2053 - Last encoded frame will be searched
2054 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME``
2055 - Two frames will be searched among the last encoded frame, the
2056 golden frame and the alternate reference (altref) frame. The
2057 encoder implementation will decide which two are chosen.
2058 * - ``V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME``
2059 - The last encoded frame, the golden frame and the altref frame will
2068 ``V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL (integer)``
2069 Indicates the loop filter level. The adjustment of the loop filter
2070 level is done via a delta value against a baseline loop filter
2073 ``V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS (integer)``
2074 This parameter affects the loop filter. Anything above zero weakens
2075 the deblocking effect on the loop filter.
2077 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD (integer)``
2078 Sets the refresh period for the golden frame. The period is defined
2079 in number of frames. For a value of 'n', every nth frame starting
2080 from the first key frame will be taken as a golden frame. For eg.
2081 for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden
2082 frame refresh period is set as 4, the frames 0, 4, 8 etc will be
2083 taken as the golden frames as frame 0 is always a key frame.
2085 .. _v4l2-vpx-golden-frame-sel:
2087 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL``
2090 enum v4l2_vp8_golden_frame_sel -
2091 Selects the golden frame for encoding. Possible values are:
2097 .. tabularcolumns:: |p{8.6cm}|p{8.9cm}|
2103 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV``
2104 - Use the (n-2)th frame as a golden frame, current frame index being
2106 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD``
2107 - Use the previous specific frame indicated by
2108 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD`` as a
2116 ``V4L2_CID_MPEG_VIDEO_VPX_MIN_QP (integer)``
2117 Minimum quantization parameter for VP8.
2119 ``V4L2_CID_MPEG_VIDEO_VPX_MAX_QP (integer)``
2120 Maximum quantization parameter for VP8.
2122 ``V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP (integer)``
2123 Quantization parameter for an I frame for VP8.
2125 ``V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP (integer)``
2126 Quantization parameter for a P frame for VP8.
2128 .. _v4l2-mpeg-video-vp8-profile:
2130 ``V4L2_CID_MPEG_VIDEO_VP8_PROFILE``
2133 enum v4l2_mpeg_video_vp8_profile -
2134 This control allows selecting the profile for VP8 encoder.
2135 This is also used to enumerate supported profiles by VP8 encoder or decoder.
2136 Possible values are:
2142 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_0``
2144 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_1``
2146 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_2``
2148 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_3``
2151 .. _v4l2-mpeg-video-vp9-profile:
2153 ``V4L2_CID_MPEG_VIDEO_VP9_PROFILE``
2156 enum v4l2_mpeg_video_vp9_profile -
2157 This control allows selecting the profile for VP9 encoder.
2158 This is also used to enumerate supported profiles by VP9 encoder or decoder.
2159 Possible values are:
2165 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_0``
2167 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_1``
2169 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_2``
2171 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_3``
2174 .. _v4l2-mpeg-video-vp9-level:
2176 ``V4L2_CID_MPEG_VIDEO_VP9_LEVEL (enum)``
2178 enum v4l2_mpeg_video_vp9_level -
2179 This control allows selecting the level for VP9 encoder.
2180 This is also used to enumerate supported levels by VP9 encoder or decoder.
2181 More information can be found at
2182 `webmproject <https://www.webmproject.org/vp9/levels/>`__. Possible values are:
2188 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_1_0``
2190 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_1_1``
2192 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_2_0``
2194 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_2_1``
2196 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_3_0``
2198 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_3_1``
2200 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_4_0``
2202 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_4_1``
2204 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_0``
2206 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_1``
2208 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_2``
2210 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_0``
2212 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_1``
2214 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_2``
2218 High Efficiency Video Coding (HEVC/H.265) Control Reference
2219 ===========================================================
2221 The HEVC/H.265 controls include controls for encoding parameters of HEVC/H.265
2225 .. _hevc-control-id:
2227 HEVC/H.265 Control IDs
2228 ----------------------
2230 ``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP (integer)``
2231 Minimum quantization parameter for HEVC.
2232 Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2234 ``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP (integer)``
2235 Maximum quantization parameter for HEVC.
2236 Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2238 ``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP (integer)``
2239 Quantization parameter for an I frame for HEVC.
2240 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2241 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2243 ``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP (integer)``
2244 Quantization parameter for a P frame for HEVC.
2245 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2246 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2248 ``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP (integer)``
2249 Quantization parameter for a B frame for HEVC.
2250 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2251 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2253 ``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_MIN_QP (integer)``
2254 Minimum quantization parameter for the HEVC I frame to limit I frame
2255 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2256 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter
2257 should be chosen to meet both requirements.
2259 ``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_MAX_QP (integer)``
2260 Maximum quantization parameter for the HEVC I frame to limit I frame
2261 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2262 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter
2263 should be chosen to meet both requirements.
2265 ``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_MIN_QP (integer)``
2266 Minimum quantization parameter for the HEVC P frame to limit P frame
2267 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2268 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter
2269 should be chosen to meet both requirements.
2271 ``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_MAX_QP (integer)``
2272 Maximum quantization parameter for the HEVC P frame to limit P frame
2273 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2274 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter
2275 should be chosen to meet both requirements.
2277 ``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_MIN_QP (integer)``
2278 Minimum quantization parameter for the HEVC B frame to limit B frame
2279 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2280 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter
2281 should be chosen to meet both requirements.
2283 ``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_MAX_QP (integer)``
2284 Maximum quantization parameter for the HEVC B frame to limit B frame
2285 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit.
2286 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter
2287 should be chosen to meet both requirements.
2289 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_QP (boolean)``
2290 HIERARCHICAL_QP allows the host to specify the quantization parameter
2291 values for each temporal layer through HIERARCHICAL_QP_LAYER. This is
2292 valid only if HIERARCHICAL_CODING_LAYER is greater than 1. Setting the
2293 control value to 1 enables setting of the QP values for the layers.
2295 .. _v4l2-hevc-hier-coding-type:
2297 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_TYPE``
2300 enum v4l2_mpeg_video_hevc_hier_coding_type -
2301 Selects the hierarchical coding type for encoding. Possible values are:
2307 .. tabularcolumns:: |p{8.2cm}|p{9.3cm}|
2313 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B``
2314 - Use the B frame for hierarchical coding.
2315 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P``
2316 - Use the P frame for hierarchical coding.
2323 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER (integer)``
2324 Selects the hierarchical coding layer. In normal encoding
2325 (non-hierarchial coding), it should be zero. Possible values are [0, 6].
2326 0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING
2329 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_QP (integer)``
2330 Indicates quantization parameter for hierarchical coding layer 0.
2331 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2332 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2334 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_QP (integer)``
2335 Indicates quantization parameter for hierarchical coding layer 1.
2336 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2337 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2339 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_QP (integer)``
2340 Indicates quantization parameter for hierarchical coding layer 2.
2341 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2342 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2344 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_QP (integer)``
2345 Indicates quantization parameter for hierarchical coding layer 3.
2346 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2347 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2349 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_QP (integer)``
2350 Indicates quantization parameter for hierarchical coding layer 4.
2351 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2352 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2354 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_QP (integer)``
2355 Indicates quantization parameter for hierarchical coding layer 5.
2356 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2357 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2359 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_QP (integer)``
2360 Indicates quantization parameter for hierarchical coding layer 6.
2361 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2362 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2364 .. _v4l2-hevc-profile:
2366 ``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE``
2369 enum v4l2_mpeg_video_hevc_profile -
2370 Select the desired profile for HEVC encoder.
2376 .. tabularcolumns:: |p{9.0cm}|p{8.5cm}|
2382 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN``
2384 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE``
2385 - Main still picture profile.
2386 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_10``
2394 .. _v4l2-hevc-level:
2396 ``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL``
2399 enum v4l2_mpeg_video_hevc_level -
2400 Selects the desired level for HEVC encoder.
2402 ================================== =========
2403 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_1`` Level 1.0
2404 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2`` Level 2.0
2405 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1`` Level 2.1
2406 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3`` Level 3.0
2407 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1`` Level 3.1
2408 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4`` Level 4.0
2409 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1`` Level 4.1
2410 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5`` Level 5.0
2411 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1`` Level 5.1
2412 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2`` Level 5.2
2413 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6`` Level 6.0
2414 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1`` Level 6.1
2415 ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2`` Level 6.2
2416 ================================== =========
2418 ``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION (integer)``
2419 Indicates the number of evenly spaced subintervals, called ticks, within
2420 one second. This is a 16 bit unsigned integer and has a maximum value up to
2421 0xffff and a minimum value of 1.
2425 ``V4L2_CID_MPEG_VIDEO_HEVC_TIER``
2428 enum v4l2_mpeg_video_hevc_tier -
2429 TIER_FLAG specifies tiers information of the HEVC encoded picture. Tier
2430 were made to deal with applications that differ in terms of maximum bit
2431 rate. Setting the flag to 0 selects HEVC tier as Main tier and setting
2432 this flag to 1 indicates High tier. High tier is for applications requiring
2435 ================================== ==========
2436 ``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN`` Main tier.
2437 ``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH`` High tier.
2438 ================================== ==========
2441 ``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH (integer)``
2442 Selects HEVC maximum coding unit depth.
2444 .. _v4l2-hevc-loop-filter-mode:
2446 ``V4L2_CID_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE``
2449 enum v4l2_mpeg_video_hevc_loop_filter_mode -
2450 Loop filter mode for HEVC encoder. Possible values are:
2456 .. tabularcolumns:: |p{12.1cm}|p{5.4cm}|
2462 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED``
2463 - Loop filter is disabled.
2464 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_ENABLED``
2465 - Loop filter is enabled.
2466 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY``
2467 - Loop filter is disabled at the slice boundary.
2474 ``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2 (integer)``
2475 Selects HEVC loop filter beta offset. The valid range is [-6, +6].
2477 ``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2 (integer)``
2478 Selects HEVC loop filter tc offset. The valid range is [-6, +6].
2480 .. _v4l2-hevc-refresh-type:
2482 ``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE``
2485 enum v4l2_mpeg_video_hevc_hier_refresh_type -
2486 Selects refresh type for HEVC encoder.
2487 Host has to specify the period into
2488 V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD.
2494 .. tabularcolumns:: |p{6.2cm}|p{11.3cm}|
2500 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE``
2501 - Use the B frame for hierarchical coding.
2502 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA``
2503 - Use CRA (Clean Random Access Unit) picture encoding.
2504 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR``
2505 - Use IDR (Instantaneous Decoding Refresh) picture encoding.
2512 ``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD (integer)``
2513 Selects the refresh period for HEVC encoder.
2514 This specifies the number of I pictures between two CRA/IDR pictures.
2515 This is valid only if REFRESH_TYPE is not 0.
2517 ``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU (boolean)``
2518 Indicates HEVC lossless encoding. Setting it to 0 disables lossless
2519 encoding. Setting it to 1 enables lossless encoding.
2521 ``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED (boolean)``
2522 Indicates constant intra prediction for HEVC encoder. Specifies the
2523 constrained intra prediction in which intra largest coding unit (LCU)
2524 prediction is performed by using residual data and decoded samples of
2525 neighboring intra LCU only. Setting the value to 1 enables constant intra
2526 prediction and setting the value to 0 disables constant intra prediction.
2528 ``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT (boolean)``
2529 Indicates wavefront parallel processing for HEVC encoder. Setting it to 0
2530 disables the feature and setting it to 1 enables the wavefront parallel
2533 ``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB (boolean)``
2534 Setting the value to 1 enables combination of P and B frame for HEVC
2537 ``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID (boolean)``
2538 Indicates temporal identifier for HEVC encoder which is enabled by
2539 setting the value to 1.
2541 ``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING (boolean)``
2542 Indicates bi-linear interpolation is conditionally used in the intra
2543 prediction filtering process in the CVS when set to 1. Indicates bi-linear
2544 interpolation is not used in the CVS when set to 0.
2546 ``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1 (integer)``
2547 Indicates maximum number of merge candidate motion vectors.
2548 Values are from 0 to 4.
2550 ``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION (boolean)``
2551 Indicates temporal motion vector prediction for HEVC encoder. Setting it to
2552 1 enables the prediction. Setting it to 0 disables the prediction.
2554 ``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE (boolean)``
2555 Specifies if HEVC generates a stream with a size of the length field
2556 instead of start code pattern. The size of the length field is configurable
2557 through the V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD control. Setting
2558 the value to 0 disables encoding without startcode pattern. Setting the
2559 value to 1 will enables encoding without startcode pattern.
2561 .. _v4l2-hevc-size-of-length-field:
2563 ``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD``
2566 enum v4l2_mpeg_video_hevc_size_of_length_field -
2567 Indicates the size of length field.
2568 This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled.
2574 .. tabularcolumns:: |p{5.5cm}|p{12.0cm}|
2580 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0``
2581 - Generate start code pattern (Normal).
2582 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1``
2583 - Generate size of length field instead of start code pattern and length is 1.
2584 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2``
2585 - Generate size of length field instead of start code pattern and length is 2.
2586 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4``
2587 - Generate size of length field instead of start code pattern and length is 4.
2593 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_BR (integer)``
2594 Indicates bit rate for hierarchical coding layer 0 for HEVC encoder.
2596 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_BR (integer)``
2597 Indicates bit rate for hierarchical coding layer 1 for HEVC encoder.
2599 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_BR (integer)``
2600 Indicates bit rate for hierarchical coding layer 2 for HEVC encoder.
2602 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_BR (integer)``
2603 Indicates bit rate for hierarchical coding layer 3 for HEVC encoder.
2605 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_BR (integer)``
2606 Indicates bit rate for hierarchical coding layer 4 for HEVC encoder.
2608 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_BR (integer)``
2609 Indicates bit rate for hierarchical coding layer 5 for HEVC encoder.
2611 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_BR (integer)``
2612 Indicates bit rate for hierarchical coding layer 6 for HEVC encoder.
2614 ``V4L2_CID_MPEG_VIDEO_REF_NUMBER_FOR_PFRAMES (integer)``
2615 Selects number of P reference pictures required for HEVC encoder.
2616 P-Frame can use 1 or 2 frames for reference.
2618 ``V4L2_CID_MPEG_VIDEO_PREPEND_SPSPPS_TO_IDR (integer)``
2619 Indicates whether to generate SPS and PPS at every IDR. Setting it to 0
2620 disables generating SPS and PPS at every IDR. Setting it to one enables
2621 generating SPS and PPS at every IDR.
2625 ``V4L2_CID_MPEG_VIDEO_HEVC_SPS (struct)``
2626 Specifies the Sequence Parameter Set fields (as extracted from the
2627 bitstream) for the associated HEVC slice data.
2628 These bitstream parameters are defined according to :ref:`hevc`.
2629 They are described in section 7.4.3.2 "Sequence parameter set RBSP
2630 semantics" of the specification.
2632 .. c:type:: v4l2_ctrl_hevc_sps
2638 .. tabularcolumns:: |p{1.2cm}|p{9.2cm}|p{6.9cm}|
2640 .. cssclass:: longtable
2642 .. flat-table:: struct v4l2_ctrl_hevc_sps
2648 - ``pic_width_in_luma_samples``
2651 - ``pic_height_in_luma_samples``
2654 - ``bit_depth_luma_minus8``
2657 - ``bit_depth_chroma_minus8``
2660 - ``log2_max_pic_order_cnt_lsb_minus4``
2663 - ``sps_max_dec_pic_buffering_minus1``
2666 - ``sps_max_num_reorder_pics``
2669 - ``sps_max_latency_increase_plus1``
2672 - ``log2_min_luma_coding_block_size_minus3``
2675 - ``log2_diff_max_min_luma_coding_block_size``
2678 - ``log2_min_luma_transform_block_size_minus2``
2681 - ``log2_diff_max_min_luma_transform_block_size``
2684 - ``max_transform_hierarchy_depth_inter``
2687 - ``max_transform_hierarchy_depth_intra``
2690 - ``pcm_sample_bit_depth_luma_minus1``
2693 - ``pcm_sample_bit_depth_chroma_minus1``
2696 - ``log2_min_pcm_luma_coding_block_size_minus3``
2699 - ``log2_diff_max_min_pcm_luma_coding_block_size``
2702 - ``num_short_term_ref_pic_sets``
2705 - ``num_long_term_ref_pics_sps``
2708 - ``chroma_format_idc``
2711 - ``sps_max_sub_layers_minus1``
2715 - See :ref:`Sequence Parameter Set Flags <hevc_sps_flags>`
2723 ``Sequence Parameter Set Flags``
2729 .. cssclass:: longtable
2736 * - ``V4L2_HEVC_SPS_FLAG_SEPARATE_COLOUR_PLANE``
2739 * - ``V4L2_HEVC_SPS_FLAG_SCALING_LIST_ENABLED``
2742 * - ``V4L2_HEVC_SPS_FLAG_AMP_ENABLED``
2745 * - ``V4L2_HEVC_SPS_FLAG_SAMPLE_ADAPTIVE_OFFSET``
2748 * - ``V4L2_HEVC_SPS_FLAG_PCM_ENABLED``
2751 * - ``V4L2_HEVC_SPS_FLAG_PCM_LOOP_FILTER_DISABLED``
2754 * - ``V4L2_HEVC_SPS_FLAG_LONG_TERM_REF_PICS_PRESENT``
2757 * - ``V4L2_HEVC_SPS_FLAG_SPS_TEMPORAL_MVP_ENABLED``
2760 * - ``V4L2_HEVC_SPS_FLAG_STRONG_INTRA_SMOOTHING_ENABLED``
2768 ``V4L2_CID_MPEG_VIDEO_HEVC_PPS (struct)``
2769 Specifies the Picture Parameter Set fields (as extracted from the
2770 bitstream) for the associated HEVC slice data.
2771 These bitstream parameters are defined according to :ref:`hevc`.
2772 They are described in section 7.4.3.3 "Picture parameter set RBSP
2773 semantics" of the specification.
2775 .. c:type:: v4l2_ctrl_hevc_pps
2777 .. tabularcolumns:: |p{1.2cm}|p{8.6cm}|p{7.5cm}|
2779 .. cssclass:: longtable
2781 .. flat-table:: struct v4l2_ctrl_hevc_pps
2787 - ``num_extra_slice_header_bits``
2790 - ``num_ref_idx_l0_default_active_minus1``
2791 - Specifies the inferred value of num_ref_idx_l0_active_minus1
2793 - ``num_ref_idx_l1_default_active_minus1``
2794 - Specifies the inferred value of num_ref_idx_l1_active_minus1
2796 - ``init_qp_minus26``
2799 - ``diff_cu_qp_delta_depth``
2802 - ``pps_cb_qp_offset``
2805 - ``pps_cr_qp_offset``
2808 - ``num_tile_columns_minus1``
2811 - ``num_tile_rows_minus1``
2814 - ``column_width_minus1[20]``
2817 - ``row_height_minus1[22]``
2820 - ``pps_beta_offset_div2``
2823 - ``pps_tc_offset_div2``
2826 - ``log2_parallel_merge_level_minus2``
2830 - Applications and drivers must set this to zero.
2833 - See :ref:`Picture Parameter Set Flags <hevc_pps_flags>`
2837 ``Picture Parameter Set Flags``
2848 * - ``V4L2_HEVC_PPS_FLAG_DEPENDENT_SLICE_SEGMENT_ENABLED``
2851 * - ``V4L2_HEVC_PPS_FLAG_OUTPUT_FLAG_PRESENT``
2854 * - ``V4L2_HEVC_PPS_FLAG_SIGN_DATA_HIDING_ENABLED``
2857 * - ``V4L2_HEVC_PPS_FLAG_CABAC_INIT_PRESENT``
2860 * - ``V4L2_HEVC_PPS_FLAG_CONSTRAINED_INTRA_PRED``
2863 * - ``V4L2_HEVC_PPS_FLAG_TRANSFORM_SKIP_ENABLED``
2866 * - ``V4L2_HEVC_PPS_FLAG_CU_QP_DELTA_ENABLED``
2869 * - ``V4L2_HEVC_PPS_FLAG_PPS_SLICE_CHROMA_QP_OFFSETS_PRESENT``
2872 * - ``V4L2_HEVC_PPS_FLAG_WEIGHTED_PRED``
2875 * - ``V4L2_HEVC_PPS_FLAG_WEIGHTED_BIPRED``
2878 * - ``V4L2_HEVC_PPS_FLAG_TRANSQUANT_BYPASS_ENABLED``
2881 * - ``V4L2_HEVC_PPS_FLAG_TILES_ENABLED``
2884 * - ``V4L2_HEVC_PPS_FLAG_ENTROPY_CODING_SYNC_ENABLED``
2887 * - ``V4L2_HEVC_PPS_FLAG_LOOP_FILTER_ACROSS_TILES_ENABLED``
2890 * - ``V4L2_HEVC_PPS_FLAG_PPS_LOOP_FILTER_ACROSS_SLICES_ENABLED``
2893 * - ``V4L2_HEVC_PPS_FLAG_DEBLOCKING_FILTER_OVERRIDE_ENABLED``
2896 * - ``V4L2_HEVC_PPS_FLAG_PPS_DISABLE_DEBLOCKING_FILTER``
2899 * - ``V4L2_HEVC_PPS_FLAG_LISTS_MODIFICATION_PRESENT``
2902 * - ``V4L2_HEVC_PPS_FLAG_SLICE_SEGMENT_HEADER_EXTENSION_PRESENT``
2905 * - ``V4L2_HEVC_PPS_FLAG_DEBLOCKING_FILTER_CONTROL_PRESENT``
2907 - Specifies the presence of deblocking filter control syntax elements in
2909 * - ``V4L2_HEVC_PPS_FLAG_UNIFORM_SPACING``
2911 - Specifies that tile column boundaries and likewise tile row boundaries
2912 are distributed uniformly across the picture
2918 ``V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS (struct)``
2919 Specifies various slice-specific parameters, especially from the NAL unit
2920 header, general slice segment header and weighted prediction parameter
2921 parts of the bitstream.
2922 These bitstream parameters are defined according to :ref:`hevc`.
2923 They are described in section 7.4.7 "General slice segment header
2924 semantics" of the specification.
2926 .. c:type:: v4l2_ctrl_hevc_slice_params
2932 .. tabularcolumns:: |p{5.4cm}|p{6.8cm}|p{5.1cm}|
2934 .. cssclass:: longtable
2936 .. flat-table:: struct v4l2_ctrl_hevc_slice_params
2943 - Size (in bits) of the current slice data.
2945 - ``data_bit_offset``
2946 - Offset (in bits) to the video data in the current slice data.
2951 - ``nuh_temporal_id_plus1``
2956 (V4L2_HEVC_SLICE_TYPE_I, V4L2_HEVC_SLICE_TYPE_P or
2957 V4L2_HEVC_SLICE_TYPE_B).
2959 - ``colour_plane_id``
2962 - ``slice_pic_order_cnt``
2965 - ``num_ref_idx_l0_active_minus1``
2968 - ``num_ref_idx_l1_active_minus1``
2971 - ``collocated_ref_idx``
2974 - ``five_minus_max_num_merge_cand``
2977 - ``slice_qp_delta``
2980 - ``slice_cb_qp_offset``
2983 - ``slice_cr_qp_offset``
2986 - ``slice_act_y_qp_offset``
2989 - ``slice_act_cb_qp_offset``
2992 - ``slice_act_cr_qp_offset``
2995 - ``slice_beta_offset_div2``
2998 - ``slice_tc_offset_div2``
3004 - ``ref_idx_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3005 - The list of L0 reference elements as indices in the DPB.
3007 - ``ref_idx_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3008 - The list of L1 reference elements as indices in the DPB.
3011 - Applications and drivers must set this to zero.
3012 * - struct :c:type:`v4l2_hevc_pred_weight_table`
3013 - ``pred_weight_table``
3014 - The prediction weight coefficients for inter-picture prediction.
3017 - See :ref:`Slice Parameters Flags <hevc_slice_params_flags>`
3023 .. _hevc_slice_params_flags:
3025 ``Slice Parameters Flags``
3036 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_LUMA``
3039 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_CHROMA``
3042 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_TEMPORAL_MVP_ENABLED``
3045 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_MVD_L1_ZERO``
3048 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_CABAC_INIT``
3051 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_COLLOCATED_FROM_L0``
3054 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_USE_INTEGER_MV``
3057 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_DEBLOCKING_FILTER_DISABLED``
3060 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_LOOP_FILTER_ACROSS_SLICES_ENABLED``
3063 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_DEPENDENT_SLICE_SEGMENT``
3071 .. c:type:: v4l2_hevc_dpb_entry
3077 .. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{12.1cm}|
3079 .. flat-table:: struct v4l2_hevc_dpb_entry
3086 - Timestamp of the V4L2 capture buffer to use as reference, used
3087 with B-coded and P-coded frames. The timestamp refers to the
3088 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the
3089 :c:func:`v4l2_timeval_to_ns()` function to convert the struct
3090 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64.
3093 - The reference set for the reference frame
3094 (V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_BEFORE,
3095 V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_AFTER or
3096 V4L2_HEVC_DPB_ENTRY_RPS_LT_CURR)
3099 - Whether the reference is a field picture or a frame.
3101 - ``pic_order_cnt[2]``
3102 - The picture order count of the reference. Only the first element of the
3103 array is used for frame pictures, while the first element identifies the
3104 top field and the second the bottom field in field-coded pictures.
3107 - Applications and drivers must set this to zero.
3113 .. c:type:: v4l2_hevc_pred_weight_table
3119 .. tabularcolumns:: |p{0.8cm}|p{10.6cm}|p{5.9cm}|
3121 .. flat-table:: struct v4l2_hevc_pred_weight_table
3127 - ``luma_log2_weight_denom``
3130 - ``delta_chroma_log2_weight_denom``
3133 - ``delta_luma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3136 - ``luma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3139 - ``delta_chroma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]``
3142 - ``chroma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]``
3145 - ``delta_luma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3148 - ``luma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3151 - ``delta_chroma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]``
3154 - ``chroma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]``
3158 - Applications and drivers must set this to zero.
3164 ``V4L2_CID_MPEG_VIDEO_HEVC_DECODE_MODE (enum)``
3165 Specifies the decoding mode to use. Currently exposes slice-based and
3166 frame-based decoding but new modes might be added later on.
3167 This control is used as a modifier for V4L2_PIX_FMT_HEVC_SLICE
3168 pixel format. Applications that support V4L2_PIX_FMT_HEVC_SLICE
3169 are required to set this control in order to specify the decoding mode
3170 that is expected for the buffer.
3171 Drivers may expose a single or multiple decoding modes, depending
3172 on what they can support.
3176 This menu control is not yet part of the public kernel API and
3177 it is expected to change.
3179 .. c:type:: v4l2_mpeg_video_hevc_decode_mode
3185 .. tabularcolumns:: |p{9.4cm}|p{0.6cm}|p{7.3cm}|
3192 * - ``V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_SLICE_BASED``
3194 - Decoding is done at the slice granularity.
3195 The OUTPUT buffer must contain a single slice.
3196 * - ``V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_FRAME_BASED``
3198 - Decoding is done at the frame granularity.
3199 The OUTPUT buffer must contain all slices needed to decode the
3200 frame. The OUTPUT buffer must also contain both fields.
3206 ``V4L2_CID_MPEG_VIDEO_HEVC_START_CODE (enum)``
3207 Specifies the HEVC slice start code expected for each slice.
3208 This control is used as a modifier for V4L2_PIX_FMT_HEVC_SLICE
3209 pixel format. Applications that support V4L2_PIX_FMT_HEVC_SLICE
3210 are required to set this control in order to specify the start code
3211 that is expected for the buffer.
3212 Drivers may expose a single or multiple start codes, depending
3213 on what they can support.
3217 This menu control is not yet part of the public kernel API and
3218 it is expected to change.
3220 .. c:type:: v4l2_mpeg_video_hevc_start_code
3222 .. tabularcolumns:: |p{9.2cm}|p{0.6cm}|p{7.5cm}|
3229 * - ``V4L2_MPEG_VIDEO_HEVC_START_CODE_NONE``
3231 - Selecting this value specifies that HEVC slices are passed
3232 to the driver without any start code. The bitstream data should be
3233 according to :ref:`hevc` 7.3.1.1 General NAL unit syntax, hence
3234 contains emulation prevention bytes when required.
3235 * - ``V4L2_MPEG_VIDEO_HEVC_START_CODE_ANNEX_B``
3237 - Selecting this value specifies that HEVC slices are expected
3238 to be prefixed by Annex B start codes. According to :ref:`hevc`
3239 valid start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001.
3241 ``V4L2_CID_MPEG_VIDEO_BASELAYER_PRIORITY_ID (integer)``
3242 Specifies a priority identifier for the NAL unit, which will be applied to
3243 the base layer. By default this value is set to 0 for the base layer,
3244 and the next layer will have the priority ID assigned as 1, 2, 3 and so on.
3245 The video encoder can't decide the priority id to be applied to a layer,
3246 so this has to come from client.
3247 This is applicable to H264 and valid Range is from 0 to 63.
3248 Source Rec. ITU-T H.264 (06/2019); G.7.4.1.1, G.8.8.1.
3250 ``V4L2_CID_MPEG_VIDEO_LTR_COUNT (integer)``
3251 Specifies the maximum number of Long Term Reference (LTR) frames at any
3252 given time that the encoder can keep.
3253 This is applicable to the H264 and HEVC encoders.
3255 ``V4L2_CID_MPEG_VIDEO_FRAME_LTR_INDEX (integer)``
3256 After setting this control the frame that will be queued next
3257 will be marked as a Long Term Reference (LTR) frame
3258 and given this LTR index which ranges from 0 to LTR_COUNT-1.
3259 This is applicable to the H264 and HEVC encoders.
3260 Source Rec. ITU-T H.264 (06/2019); Table 7.9
3262 ``V4L2_CID_MPEG_VIDEO_USE_LTR_FRAMES (bitmask)``
3263 Specifies the Long Term Reference (LTR) frame(s) to be used for
3264 encoding the next frame queued after setting this control.
3265 This provides a bitmask which consists of bits [0, LTR_COUNT-1].
3266 This is applicable to the H264 and HEVC encoders.
3268 ``V4L2_CID_MPEG_VIDEO_HEVC_DECODE_PARAMS (struct)``
3269 Specifies various decode parameters, especially the references picture order
3270 count (POC) for all the lists (short, long, before, current, after) and the
3271 number of entries for each of them.
3272 These parameters are defined according to :ref:`hevc`.
3273 They are described in section 8.3 "Slice decoding process" of the
3276 .. c:type:: v4l2_ctrl_hevc_decode_params
3278 .. cssclass:: longtable
3280 .. flat-table:: struct v4l2_ctrl_hevc_decode_params
3286 - ``pic_order_cnt_val``
3287 - PicOrderCntVal as described in section 8.3.1 "Decoding process
3288 for picture order count" of the specification.
3290 - ``num_active_dpb_entries``
3291 - The number of entries in ``dpb``.
3292 * - struct :c:type:`v4l2_hevc_dpb_entry`
3293 - ``dpb[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3294 - The decoded picture buffer, for meta-data about reference frames.
3296 - ``num_poc_st_curr_before``
3297 - The number of reference pictures in the short-term set that come before
3300 - ``num_poc_st_curr_after``
3301 - The number of reference pictures in the short-term set that come after
3304 - ``num_poc_lt_curr``
3305 - The number of reference pictures in the long-term set.
3307 - ``poc_st_curr_before[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3308 - PocStCurrBefore as described in section 8.3.2 "Decoding process for reference
3311 - ``poc_st_curr_after[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3312 - PocStCurrAfter as described in section 8.3.2 "Decoding process for reference
3315 - ``poc_lt_curr[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]``
3316 - PocLtCurr as described in section 8.3.2 "Decoding process for reference
3320 - See :ref:`Decode Parameters Flags <hevc_decode_params_flags>`
3322 .. _hevc_decode_params_flags:
3324 ``Decode Parameters Flags``
3326 .. cssclass:: longtable
3333 * - ``V4L2_HEVC_DECODE_PARAM_FLAG_IRAP_PIC``
3336 * - ``V4L2_HEVC_DECODE_PARAM_FLAG_IDR_PIC``
3339 * - ``V4L2_HEVC_DECODE_PARAM_FLAG_NO_OUTPUT_OF_PRIOR``