Merge tag 'armsoc-dt' of git://git.kernel.org/pub/scm/linux/kernel/git/soc/soc
[sfrench/cifs-2.6.git] / Documentation / media / uapi / v4l / ext-ctrls-codec.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _mpeg-controls:
11
12 ***********************
13 Codec Control Reference
14 ***********************
15
16 Below all controls within the Codec control class are described. First
17 the generic controls, then controls specific for certain hardware.
18
19 .. note::
20
21    These controls are applicable to all codecs and not just MPEG. The
22    defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG as the controls
23    were originally made for MPEG codecs and later extended to cover all
24    encoding formats.
25
26
27 Generic Codec Controls
28 ======================
29
30
31 .. _mpeg-control-id:
32
33 Codec Control IDs
34 -----------------
35
36 ``V4L2_CID_MPEG_CLASS (class)``
37     The Codec class descriptor. Calling
38     :ref:`VIDIOC_QUERYCTRL` for this control will
39     return a description of this control class. This description can be
40     used as the caption of a Tab page in a GUI, for example.
41
42 .. _v4l2-mpeg-stream-type:
43
44 ``V4L2_CID_MPEG_STREAM_TYPE``
45     (enum)
46
47 enum v4l2_mpeg_stream_type -
48     The MPEG-1, -2 or -4 output stream type. One cannot assume anything
49     here. Each hardware MPEG encoder tends to support different subsets
50     of the available MPEG stream types. This control is specific to
51     multiplexed MPEG streams. The currently defined stream types are:
52
53
54
55 .. flat-table::
56     :header-rows:  0
57     :stub-columns: 0
58
59     * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_PS``
60       - MPEG-2 program stream
61     * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_TS``
62       - MPEG-2 transport stream
63     * - ``V4L2_MPEG_STREAM_TYPE_MPEG1_SS``
64       - MPEG-1 system stream
65     * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_DVD``
66       - MPEG-2 DVD-compatible stream
67     * - ``V4L2_MPEG_STREAM_TYPE_MPEG1_VCD``
68       - MPEG-1 VCD-compatible stream
69     * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD``
70       - MPEG-2 SVCD-compatible stream
71
72
73
74 ``V4L2_CID_MPEG_STREAM_PID_PMT (integer)``
75     Program Map Table Packet ID for the MPEG transport stream (default
76     16)
77
78 ``V4L2_CID_MPEG_STREAM_PID_AUDIO (integer)``
79     Audio Packet ID for the MPEG transport stream (default 256)
80
81 ``V4L2_CID_MPEG_STREAM_PID_VIDEO (integer)``
82     Video Packet ID for the MPEG transport stream (default 260)
83
84 ``V4L2_CID_MPEG_STREAM_PID_PCR (integer)``
85     Packet ID for the MPEG transport stream carrying PCR fields (default
86     259)
87
88 ``V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (integer)``
89     Audio ID for MPEG PES
90
91 ``V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (integer)``
92     Video ID for MPEG PES
93
94 .. _v4l2-mpeg-stream-vbi-fmt:
95
96 ``V4L2_CID_MPEG_STREAM_VBI_FMT``
97     (enum)
98
99 enum v4l2_mpeg_stream_vbi_fmt -
100     Some cards can embed VBI data (e. g. Closed Caption, Teletext) into
101     the MPEG stream. This control selects whether VBI data should be
102     embedded, and if so, what embedding method should be used. The list
103     of possible VBI formats depends on the driver. The currently defined
104     VBI format types are:
105
106
107
108 .. tabularcolumns:: |p{6.6 cm}|p{10.9cm}|
109
110 .. flat-table::
111     :header-rows:  0
112     :stub-columns: 0
113
114     * - ``V4L2_MPEG_STREAM_VBI_FMT_NONE``
115       - No VBI in the MPEG stream
116     * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV``
117       - VBI in private packets, IVTV format (documented in the kernel
118         sources in the file
119         ``Documentation/media/v4l-drivers/cx2341x.rst``)
120
121
122
123 .. _v4l2-mpeg-audio-sampling-freq:
124
125 ``V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ``
126     (enum)
127
128 enum v4l2_mpeg_audio_sampling_freq -
129     MPEG Audio sampling frequency. Possible values are:
130
131
132
133 .. flat-table::
134     :header-rows:  0
135     :stub-columns: 0
136
137     * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100``
138       - 44.1 kHz
139     * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000``
140       - 48 kHz
141     * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000``
142       - 32 kHz
143
144
145
146 .. _v4l2-mpeg-audio-encoding:
147
148 ``V4L2_CID_MPEG_AUDIO_ENCODING``
149     (enum)
150
151 enum v4l2_mpeg_audio_encoding -
152     MPEG Audio encoding. This control is specific to multiplexed MPEG
153     streams. Possible values are:
154
155
156
157 .. flat-table::
158     :header-rows:  0
159     :stub-columns: 0
160
161     * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_1``
162       - MPEG-1/2 Layer I encoding
163     * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_2``
164       - MPEG-1/2 Layer II encoding
165     * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_3``
166       - MPEG-1/2 Layer III encoding
167     * - ``V4L2_MPEG_AUDIO_ENCODING_AAC``
168       - MPEG-2/4 AAC (Advanced Audio Coding)
169     * - ``V4L2_MPEG_AUDIO_ENCODING_AC3``
170       - AC-3 aka ATSC A/52 encoding
171
172
173
174 .. _v4l2-mpeg-audio-l1-bitrate:
175
176 ``V4L2_CID_MPEG_AUDIO_L1_BITRATE``
177     (enum)
178
179 enum v4l2_mpeg_audio_l1_bitrate -
180     MPEG-1/2 Layer I bitrate. Possible values are:
181
182
183
184 .. flat-table::
185     :header-rows:  0
186     :stub-columns: 0
187
188     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_32K``
189       - 32 kbit/s
190     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_64K``
191       - 64 kbit/s
192     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_96K``
193       - 96 kbit/s
194     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_128K``
195       - 128 kbit/s
196     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_160K``
197       - 160 kbit/s
198     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_192K``
199       - 192 kbit/s
200     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_224K``
201       - 224 kbit/s
202     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_256K``
203       - 256 kbit/s
204     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_288K``
205       - 288 kbit/s
206     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_320K``
207       - 320 kbit/s
208     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_352K``
209       - 352 kbit/s
210     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_384K``
211       - 384 kbit/s
212     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_416K``
213       - 416 kbit/s
214     * - ``V4L2_MPEG_AUDIO_L1_BITRATE_448K``
215       - 448 kbit/s
216
217
218
219 .. _v4l2-mpeg-audio-l2-bitrate:
220
221 ``V4L2_CID_MPEG_AUDIO_L2_BITRATE``
222     (enum)
223
224 enum v4l2_mpeg_audio_l2_bitrate -
225     MPEG-1/2 Layer II bitrate. Possible values are:
226
227
228
229 .. flat-table::
230     :header-rows:  0
231     :stub-columns: 0
232
233     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_32K``
234       - 32 kbit/s
235     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_48K``
236       - 48 kbit/s
237     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_56K``
238       - 56 kbit/s
239     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_64K``
240       - 64 kbit/s
241     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_80K``
242       - 80 kbit/s
243     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_96K``
244       - 96 kbit/s
245     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_112K``
246       - 112 kbit/s
247     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_128K``
248       - 128 kbit/s
249     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_160K``
250       - 160 kbit/s
251     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_192K``
252       - 192 kbit/s
253     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_224K``
254       - 224 kbit/s
255     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_256K``
256       - 256 kbit/s
257     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_320K``
258       - 320 kbit/s
259     * - ``V4L2_MPEG_AUDIO_L2_BITRATE_384K``
260       - 384 kbit/s
261
262
263
264 .. _v4l2-mpeg-audio-l3-bitrate:
265
266 ``V4L2_CID_MPEG_AUDIO_L3_BITRATE``
267     (enum)
268
269 enum v4l2_mpeg_audio_l3_bitrate -
270     MPEG-1/2 Layer III bitrate. Possible values are:
271
272
273
274 .. flat-table::
275     :header-rows:  0
276     :stub-columns: 0
277
278     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_32K``
279       - 32 kbit/s
280     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_40K``
281       - 40 kbit/s
282     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_48K``
283       - 48 kbit/s
284     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_56K``
285       - 56 kbit/s
286     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_64K``
287       - 64 kbit/s
288     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_80K``
289       - 80 kbit/s
290     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_96K``
291       - 96 kbit/s
292     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_112K``
293       - 112 kbit/s
294     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_128K``
295       - 128 kbit/s
296     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_160K``
297       - 160 kbit/s
298     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_192K``
299       - 192 kbit/s
300     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_224K``
301       - 224 kbit/s
302     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_256K``
303       - 256 kbit/s
304     * - ``V4L2_MPEG_AUDIO_L3_BITRATE_320K``
305       - 320 kbit/s
306
307
308
309 ``V4L2_CID_MPEG_AUDIO_AAC_BITRATE (integer)``
310     AAC bitrate in bits per second.
311
312 .. _v4l2-mpeg-audio-ac3-bitrate:
313
314 ``V4L2_CID_MPEG_AUDIO_AC3_BITRATE``
315     (enum)
316
317 enum v4l2_mpeg_audio_ac3_bitrate -
318     AC-3 bitrate. Possible values are:
319
320
321
322 .. flat-table::
323     :header-rows:  0
324     :stub-columns: 0
325
326     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_32K``
327       - 32 kbit/s
328     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_40K``
329       - 40 kbit/s
330     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_48K``
331       - 48 kbit/s
332     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_56K``
333       - 56 kbit/s
334     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_64K``
335       - 64 kbit/s
336     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_80K``
337       - 80 kbit/s
338     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_96K``
339       - 96 kbit/s
340     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_112K``
341       - 112 kbit/s
342     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_128K``
343       - 128 kbit/s
344     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_160K``
345       - 160 kbit/s
346     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_192K``
347       - 192 kbit/s
348     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_224K``
349       - 224 kbit/s
350     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_256K``
351       - 256 kbit/s
352     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_320K``
353       - 320 kbit/s
354     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_384K``
355       - 384 kbit/s
356     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_448K``
357       - 448 kbit/s
358     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_512K``
359       - 512 kbit/s
360     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_576K``
361       - 576 kbit/s
362     * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_640K``
363       - 640 kbit/s
364
365
366
367 .. _v4l2-mpeg-audio-mode:
368
369 ``V4L2_CID_MPEG_AUDIO_MODE``
370     (enum)
371
372 enum v4l2_mpeg_audio_mode -
373     MPEG Audio mode. Possible values are:
374
375
376
377 .. flat-table::
378     :header-rows:  0
379     :stub-columns: 0
380
381     * - ``V4L2_MPEG_AUDIO_MODE_STEREO``
382       - Stereo
383     * - ``V4L2_MPEG_AUDIO_MODE_JOINT_STEREO``
384       - Joint Stereo
385     * - ``V4L2_MPEG_AUDIO_MODE_DUAL``
386       - Bilingual
387     * - ``V4L2_MPEG_AUDIO_MODE_MONO``
388       - Mono
389
390
391
392 .. _v4l2-mpeg-audio-mode-extension:
393
394 ``V4L2_CID_MPEG_AUDIO_MODE_EXTENSION``
395     (enum)
396
397 enum v4l2_mpeg_audio_mode_extension -
398     Joint Stereo audio mode extension. In Layer I and II they indicate
399     which subbands are in intensity stereo. All other subbands are coded
400     in stereo. Layer III is not (yet) supported. Possible values are:
401
402
403
404 .. flat-table::
405     :header-rows:  0
406     :stub-columns: 0
407
408     * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4``
409       - Subbands 4-31 in intensity stereo
410     * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8``
411       - Subbands 8-31 in intensity stereo
412     * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12``
413       - Subbands 12-31 in intensity stereo
414     * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16``
415       - Subbands 16-31 in intensity stereo
416
417
418
419 .. _v4l2-mpeg-audio-emphasis:
420
421 ``V4L2_CID_MPEG_AUDIO_EMPHASIS``
422     (enum)
423
424 enum v4l2_mpeg_audio_emphasis -
425     Audio Emphasis. Possible values are:
426
427
428
429 .. flat-table::
430     :header-rows:  0
431     :stub-columns: 0
432
433     * - ``V4L2_MPEG_AUDIO_EMPHASIS_NONE``
434       - None
435     * - ``V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS``
436       - 50/15 microsecond emphasis
437     * - ``V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17``
438       - CCITT J.17
439
440
441
442 .. _v4l2-mpeg-audio-crc:
443
444 ``V4L2_CID_MPEG_AUDIO_CRC``
445     (enum)
446
447 enum v4l2_mpeg_audio_crc -
448     CRC method. Possible values are:
449
450
451
452 .. flat-table::
453     :header-rows:  0
454     :stub-columns: 0
455
456     * - ``V4L2_MPEG_AUDIO_CRC_NONE``
457       - None
458     * - ``V4L2_MPEG_AUDIO_CRC_CRC16``
459       - 16 bit parity check
460
461
462
463 ``V4L2_CID_MPEG_AUDIO_MUTE (boolean)``
464     Mutes the audio when capturing. This is not done by muting audio
465     hardware, which can still produce a slight hiss, but in the encoder
466     itself, guaranteeing a fixed and reproducible audio bitstream. 0 =
467     unmuted, 1 = muted.
468
469 .. _v4l2-mpeg-audio-dec-playback:
470
471 ``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK``
472     (enum)
473
474 enum v4l2_mpeg_audio_dec_playback -
475     Determines how monolingual audio should be played back. Possible
476     values are:
477
478
479
480 .. tabularcolumns:: |p{9.8cm}|p{7.7cm}|
481
482 .. flat-table::
483     :header-rows:  0
484     :stub-columns: 0
485
486     * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO``
487       - Automatically determines the best playback mode.
488     * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO``
489       - Stereo playback.
490     * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_LEFT``
491       - Left channel playback.
492     * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_RIGHT``
493       - Right channel playback.
494     * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_MONO``
495       - Mono playback.
496     * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO``
497       - Stereo playback with swapped left and right channels.
498
499
500
501 .. _v4l2-mpeg-audio-dec-multilingual-playback:
502
503 ``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK``
504     (enum)
505
506 enum v4l2_mpeg_audio_dec_playback -
507     Determines how multilingual audio should be played back.
508
509 .. _v4l2-mpeg-video-encoding:
510
511 ``V4L2_CID_MPEG_VIDEO_ENCODING``
512     (enum)
513
514 enum v4l2_mpeg_video_encoding -
515     MPEG Video encoding method. This control is specific to multiplexed
516     MPEG streams. Possible values are:
517
518
519
520 .. flat-table::
521     :header-rows:  0
522     :stub-columns: 0
523
524     * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_1``
525       - MPEG-1 Video encoding
526     * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_2``
527       - MPEG-2 Video encoding
528     * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC``
529       - MPEG-4 AVC (H.264) Video encoding
530
531
532
533 .. _v4l2-mpeg-video-aspect:
534
535 ``V4L2_CID_MPEG_VIDEO_ASPECT``
536     (enum)
537
538 enum v4l2_mpeg_video_aspect -
539     Video aspect. Possible values are:
540
541
542
543 .. flat-table::
544     :header-rows:  0
545     :stub-columns: 0
546
547     * - ``V4L2_MPEG_VIDEO_ASPECT_1x1``
548     * - ``V4L2_MPEG_VIDEO_ASPECT_4x3``
549     * - ``V4L2_MPEG_VIDEO_ASPECT_16x9``
550     * - ``V4L2_MPEG_VIDEO_ASPECT_221x100``
551
552
553
554 ``V4L2_CID_MPEG_VIDEO_B_FRAMES (integer)``
555     Number of B-Frames (default 2)
556
557 ``V4L2_CID_MPEG_VIDEO_GOP_SIZE (integer)``
558     GOP size (default 12)
559
560 ``V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (boolean)``
561     GOP closure (default 1)
562
563 ``V4L2_CID_MPEG_VIDEO_PULLDOWN (boolean)``
564     Enable 3:2 pulldown (default 0)
565
566 .. _v4l2-mpeg-video-bitrate-mode:
567
568 ``V4L2_CID_MPEG_VIDEO_BITRATE_MODE``
569     (enum)
570
571 enum v4l2_mpeg_video_bitrate_mode -
572     Video bitrate mode. Possible values are:
573
574
575
576 .. flat-table::
577     :header-rows:  0
578     :stub-columns: 0
579
580     * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_VBR``
581       - Variable bitrate
582     * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_CBR``
583       - Constant bitrate
584
585
586
587 ``V4L2_CID_MPEG_VIDEO_BITRATE (integer)``
588     Video bitrate in bits per second.
589
590 ``V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (integer)``
591     Peak video bitrate in bits per second. Must be larger or equal to
592     the average video bitrate. It is ignored if the video bitrate mode
593     is set to constant bitrate.
594
595 ``V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (integer)``
596     For every captured frame, skip this many subsequent frames (default
597     0).
598
599 ``V4L2_CID_MPEG_VIDEO_MUTE (boolean)``
600     "Mutes" the video to a fixed color when capturing. This is useful
601     for testing, to produce a fixed video bitstream. 0 = unmuted, 1 =
602     muted.
603
604 ``V4L2_CID_MPEG_VIDEO_MUTE_YUV (integer)``
605     Sets the "mute" color of the video. The supplied 32-bit integer is
606     interpreted as follows (bit 0 = least significant bit):
607
608
609
610 .. flat-table::
611     :header-rows:  0
612     :stub-columns: 0
613
614     * - Bit 0:7
615       - V chrominance information
616     * - Bit 8:15
617       - U chrominance information
618     * - Bit 16:23
619       - Y luminance information
620     * - Bit 24:31
621       - Must be zero.
622
623
624
625 .. _v4l2-mpeg-video-dec-pts:
626
627 ``V4L2_CID_MPEG_VIDEO_DEC_PTS (integer64)``
628     This read-only control returns the 33-bit video Presentation Time
629     Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the
630     currently displayed frame. This is the same PTS as is used in
631     :ref:`VIDIOC_DECODER_CMD`.
632
633 .. _v4l2-mpeg-video-dec-frame:
634
635 ``V4L2_CID_MPEG_VIDEO_DEC_FRAME (integer64)``
636     This read-only control returns the frame counter of the frame that
637     is currently displayed (decoded). This value is reset to 0 whenever
638     the decoder is started.
639
640 ``V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE (boolean)``
641     If enabled the decoder expects to receive a single slice per buffer,
642     otherwise the decoder expects a single frame in per buffer.
643     Applicable to the decoder, all codecs.
644
645 ``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE (boolean)``
646     Enable writing sample aspect ratio in the Video Usability
647     Information. Applicable to the H264 encoder.
648
649 .. _v4l2-mpeg-video-h264-vui-sar-idc:
650
651 ``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC``
652     (enum)
653
654 enum v4l2_mpeg_video_h264_vui_sar_idc -
655     VUI sample aspect ratio indicator for H.264 encoding. The value is
656     defined in the table E-1 in the standard. Applicable to the H264
657     encoder.
658
659
660
661 .. flat-table::
662     :header-rows:  0
663     :stub-columns: 0
664
665     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED``
666       - Unspecified
667     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1``
668       - 1x1
669     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11``
670       - 12x11
671     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11``
672       - 10x11
673     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11``
674       - 16x11
675     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33``
676       - 40x33
677     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11``
678       - 24x11
679     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11``
680       - 20x11
681     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11``
682       - 32x11
683     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33``
684       - 80x33
685     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11``
686       - 18x11
687     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11``
688       - 15x11
689     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33``
690       - 64x33
691     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99``
692       - 160x99
693     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3``
694       - 4x3
695     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2``
696       - 3x2
697     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1``
698       - 2x1
699     * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED``
700       - Extended SAR
701
702
703
704 ``V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH (integer)``
705     Extended sample aspect ratio width for H.264 VUI encoding.
706     Applicable to the H264 encoder.
707
708 ``V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT (integer)``
709     Extended sample aspect ratio height for H.264 VUI encoding.
710     Applicable to the H264 encoder.
711
712 .. _v4l2-mpeg-video-h264-level:
713
714 ``V4L2_CID_MPEG_VIDEO_H264_LEVEL``
715     (enum)
716
717 enum v4l2_mpeg_video_h264_level -
718     The level information for the H264 video elementary stream.
719     Applicable to the H264 encoder. Possible values are:
720
721
722
723 .. flat-table::
724     :header-rows:  0
725     :stub-columns: 0
726
727     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_0``
728       - Level 1.0
729     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1B``
730       - Level 1B
731     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_1``
732       - Level 1.1
733     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_2``
734       - Level 1.2
735     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_3``
736       - Level 1.3
737     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_0``
738       - Level 2.0
739     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_1``
740       - Level 2.1
741     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_2``
742       - Level 2.2
743     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_0``
744       - Level 3.0
745     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_1``
746       - Level 3.1
747     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_2``
748       - Level 3.2
749     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_0``
750       - Level 4.0
751     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_1``
752       - Level 4.1
753     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_2``
754       - Level 4.2
755     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_0``
756       - Level 5.0
757     * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_1``
758       - Level 5.1
759
760
761
762 .. _v4l2-mpeg-video-mpeg4-level:
763
764 ``V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL``
765     (enum)
766
767 enum v4l2_mpeg_video_mpeg4_level -
768     The level information for the MPEG4 elementary stream. Applicable to
769     the MPEG4 encoder. Possible values are:
770
771
772
773 .. flat-table::
774     :header-rows:  0
775     :stub-columns: 0
776
777     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0``
778       - Level 0
779     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0B``
780       - Level 0b
781     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_1``
782       - Level 1
783     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_2``
784       - Level 2
785     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3``
786       - Level 3
787     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3B``
788       - Level 3b
789     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_4``
790       - Level 4
791     * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_5``
792       - Level 5
793
794
795
796 .. _v4l2-mpeg-video-h264-profile:
797
798 ``V4L2_CID_MPEG_VIDEO_H264_PROFILE``
799     (enum)
800
801 enum v4l2_mpeg_video_h264_profile -
802     The profile information for H264. Applicable to the H264 encoder.
803     Possible values are:
804
805
806
807 .. flat-table::
808     :header-rows:  0
809     :stub-columns: 0
810
811     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE``
812       - Baseline profile
813     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE``
814       - Constrained Baseline profile
815     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MAIN``
816       - Main profile
817     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED``
818       - Extended profile
819     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH``
820       - High profile
821     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10``
822       - High 10 profile
823     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422``
824       - High 422 profile
825     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE``
826       - High 444 Predictive profile
827     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA``
828       - High 10 Intra profile
829     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA``
830       - High 422 Intra profile
831     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA``
832       - High 444 Intra profile
833     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA``
834       - CAVLC 444 Intra profile
835     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE``
836       - Scalable Baseline profile
837     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH``
838       - Scalable High profile
839     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA``
840       - Scalable High Intra profile
841     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH``
842       - Stereo High profile
843     * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH``
844       - Multiview High profile
845
846
847
848 .. _v4l2-mpeg-video-mpeg4-profile:
849
850 ``V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE``
851     (enum)
852
853 enum v4l2_mpeg_video_mpeg4_profile -
854     The profile information for MPEG4. Applicable to the MPEG4 encoder.
855     Possible values are:
856
857
858
859 .. flat-table::
860     :header-rows:  0
861     :stub-columns: 0
862
863     * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE``
864       - Simple profile
865     * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_SIMPLE``
866       - Advanced Simple profile
867     * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_CORE``
868       - Core profile
869     * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE_SCALABLE``
870       - Simple Scalable profile
871     * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_CODING_EFFICIENCY``
872       -
873
874
875
876 ``V4L2_CID_MPEG_VIDEO_MAX_REF_PIC (integer)``
877     The maximum number of reference pictures used for encoding.
878     Applicable to the encoder.
879
880 .. _v4l2-mpeg-video-multi-slice-mode:
881
882 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE``
883     (enum)
884
885 enum v4l2_mpeg_video_multi_slice_mode -
886     Determines how the encoder should handle division of frame into
887     slices. Applicable to the encoder. Possible values are:
888
889
890
891 .. tabularcolumns:: |p{9.6cm}|p{7.9cm}|
892
893 .. flat-table::
894     :header-rows:  0
895     :stub-columns: 0
896
897     * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE``
898       - Single slice per frame.
899     * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB``
900       - Multiple slices with set maximum number of macroblocks per slice.
901     * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``
902       - Multiple slice with set maximum size in bytes per slice.
903
904
905
906 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB (integer)``
907     The maximum number of macroblocks in a slice. Used when
908     ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to
909     ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB``. Applicable to the
910     encoder.
911
912 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES (integer)``
913     The maximum size of a slice in bytes. Used when
914     ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to
915     ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``. Applicable to the
916     encoder.
917
918 .. _v4l2-mpeg-video-h264-loop-filter-mode:
919
920 ``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE``
921     (enum)
922
923 enum v4l2_mpeg_video_h264_loop_filter_mode -
924     Loop filter mode for H264 encoder. Possible values are:
925
926 .. raw:: latex
927
928     \small
929
930 .. tabularcolumns:: |p{13.6cm}|p{3.9cm}|
931
932 .. flat-table::
933     :header-rows:  0
934     :stub-columns: 0
935
936     * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED``
937       - Loop filter is enabled.
938     * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED``
939       - Loop filter is disabled.
940     * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY``
941       - Loop filter is disabled at the slice boundary.
942
943 .. raw:: latex
944
945     \normalsize
946
947
948 ``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA (integer)``
949     Loop filter alpha coefficient, defined in the H264 standard.
950     This value corresponds to the slice_alpha_c0_offset_div2 slice header
951     field, and should be in the range of -6 to +6, inclusive. The actual alpha
952     offset FilterOffsetA is twice this value.
953     Applicable to the H264 encoder.
954
955 ``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA (integer)``
956     Loop filter beta coefficient, defined in the H264 standard.
957     This corresponds to the slice_beta_offset_div2 slice header field, and
958     should be in the range of -6 to +6, inclusive. The actual beta offset
959     FilterOffsetB is twice this value.
960     Applicable to the H264 encoder.
961
962 .. _v4l2-mpeg-video-h264-entropy-mode:
963
964 ``V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE``
965     (enum)
966
967 enum v4l2_mpeg_video_h264_entropy_mode -
968     Entropy coding mode for H264 - CABAC/CAVALC. Applicable to the H264
969     encoder. Possible values are:
970
971
972 .. tabularcolumns:: |p{9.0cm}|p{8.5cm}|
973
974
975 .. flat-table::
976     :header-rows:  0
977     :stub-columns: 0
978
979     * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC``
980       - Use CAVLC entropy coding.
981     * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC``
982       - Use CABAC entropy coding.
983
984
985
986 ``V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM (boolean)``
987     Enable 8X8 transform for H264. Applicable to the H264 encoder.
988
989 ``V4L2_CID_MPEG_VIDEO_H264_CONSTRAINED_INTRA_PREDICTION (boolean)``
990     Enable constrained intra prediction for H264. Applicable to the H264
991     encoder.
992
993 ``V4L2_CID_MPEG_VIDEO_H264_CHROMA_QP_INDEX_OFFSET (integer)``
994     Specify the offset that should be added to the luma quantization
995     parameter to determine the chroma quantization parameter. Applicable
996     to the H264 encoder.
997
998 ``V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB (integer)``
999     Cyclic intra macroblock refresh. This is the number of continuous
1000     macroblocks refreshed every frame. Each frame a successive set of
1001     macroblocks is refreshed until the cycle completes and starts from
1002     the top of the frame. Applicable to H264, H263 and MPEG4 encoder.
1003
1004 ``V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE (boolean)``
1005     Frame level rate control enable. If this control is disabled then
1006     the quantization parameter for each frame type is constant and set
1007     with appropriate controls (e.g.
1008     ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP``). If frame rate control is
1009     enabled then quantization parameter is adjusted to meet the chosen
1010     bitrate. Minimum and maximum value for the quantization parameter
1011     can be set with appropriate controls (e.g.
1012     ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP``). Applicable to encoders.
1013
1014 ``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE (boolean)``
1015     Macroblock level rate control enable. Applicable to the MPEG4 and
1016     H264 encoders.
1017
1018 ``V4L2_CID_MPEG_VIDEO_MPEG4_QPEL (boolean)``
1019     Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4
1020     encoder.
1021
1022 ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP (integer)``
1023     Quantization parameter for an I frame for H263. Valid range: from 1
1024     to 31.
1025
1026 ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP (integer)``
1027     Minimum quantization parameter for H263. Valid range: from 1 to 31.
1028
1029 ``V4L2_CID_MPEG_VIDEO_H263_MAX_QP (integer)``
1030     Maximum quantization parameter for H263. Valid range: from 1 to 31.
1031
1032 ``V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP (integer)``
1033     Quantization parameter for an P frame for H263. Valid range: from 1
1034     to 31.
1035
1036 ``V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP (integer)``
1037     Quantization parameter for an B frame for H263. Valid range: from 1
1038     to 31.
1039
1040 ``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP (integer)``
1041     Quantization parameter for an I frame for H264. Valid range: from 0
1042     to 51.
1043
1044 ``V4L2_CID_MPEG_VIDEO_H264_MIN_QP (integer)``
1045     Minimum quantization parameter for H264. Valid range: from 0 to 51.
1046
1047 ``V4L2_CID_MPEG_VIDEO_H264_MAX_QP (integer)``
1048     Maximum quantization parameter for H264. Valid range: from 0 to 51.
1049
1050 ``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP (integer)``
1051     Quantization parameter for an P frame for H264. Valid range: from 0
1052     to 51.
1053
1054 ``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP (integer)``
1055     Quantization parameter for an B frame for H264. Valid range: from 0
1056     to 51.
1057
1058 ``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MIN_QP (integer)``
1059     Minimum quantization parameter for the H264 I frame to limit I frame
1060     quality to a range. Valid range: from 0 to 51. If
1061     V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter
1062     should be chosen to meet both requirements.
1063
1064 ``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MAX_QP (integer)``
1065     Maximum quantization parameter for the H264 I frame to limit I frame
1066     quality to a range. Valid range: from 0 to 51. If
1067     V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter
1068     should be chosen to meet both requirements.
1069
1070 ``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MIN_QP (integer)``
1071     Minimum quantization parameter for the H264 P frame to limit P frame
1072     quality to a range. Valid range: from 0 to 51. If
1073     V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter
1074     should be chosen to meet both requirements.
1075
1076 ``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MAX_QP (integer)``
1077     Maximum quantization parameter for the H264 P frame to limit P frame
1078     quality to a range. Valid range: from 0 to 51. If
1079     V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter
1080     should be chosen to meet both requirements.
1081
1082 ``V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP (integer)``
1083     Quantization parameter for an I frame for MPEG4. Valid range: from 1
1084     to 31.
1085
1086 ``V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP (integer)``
1087     Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.
1088
1089 ``V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP (integer)``
1090     Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.
1091
1092 ``V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP (integer)``
1093     Quantization parameter for an P frame for MPEG4. Valid range: from 1
1094     to 31.
1095
1096 ``V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP (integer)``
1097     Quantization parameter for an B frame for MPEG4. Valid range: from 1
1098     to 31.
1099
1100 ``V4L2_CID_MPEG_VIDEO_VBV_SIZE (integer)``
1101     The Video Buffer Verifier size in kilobytes, it is used as a
1102     limitation of frame skip. The VBV is defined in the standard as a
1103     mean to verify that the produced stream will be successfully
1104     decoded. The standard describes it as "Part of a hypothetical
1105     decoder that is conceptually connected to the output of the encoder.
1106     Its purpose is to provide a constraint on the variability of the
1107     data rate that an encoder or editing process may produce.".
1108     Applicable to the MPEG1, MPEG2, MPEG4 encoders.
1109
1110 .. _v4l2-mpeg-video-vbv-delay:
1111
1112 ``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)``
1113     Sets the initial delay in milliseconds for VBV buffer control.
1114
1115 .. _v4l2-mpeg-video-hor-search-range:
1116
1117 ``V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE (integer)``
1118     Horizontal search range defines maximum horizontal search area in
1119     pixels to search and match for the present Macroblock (MB) in the
1120     reference picture. This V4L2 control macro is used to set horizontal
1121     search range for motion estimation module in video encoder.
1122
1123 .. _v4l2-mpeg-video-vert-search-range:
1124
1125 ``V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE (integer)``
1126     Vertical search range defines maximum vertical search area in pixels
1127     to search and match for the present Macroblock (MB) in the reference
1128     picture. This V4L2 control macro is used to set vertical search
1129     range for motion estimation module in video encoder.
1130
1131 .. _v4l2-mpeg-video-force-key-frame:
1132
1133 ``V4L2_CID_MPEG_VIDEO_FORCE_KEY_FRAME (button)``
1134     Force a key frame for the next queued buffer. Applicable to
1135     encoders. This is a general, codec-agnostic keyframe control.
1136
1137 ``V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE (integer)``
1138     The Coded Picture Buffer size in kilobytes, it is used as a
1139     limitation of frame skip. The CPB is defined in the H264 standard as
1140     a mean to verify that the produced stream will be successfully
1141     decoded. Applicable to the H264 encoder.
1142
1143 ``V4L2_CID_MPEG_VIDEO_H264_I_PERIOD (integer)``
1144     Period between I-frames in the open GOP for H264. In case of an open
1145     GOP this is the period between two I-frames. The period between IDR
1146     (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE
1147     control. An IDR frame, which stands for Instantaneous Decoding
1148     Refresh is an I-frame after which no prior frames are referenced.
1149     This means that a stream can be restarted from an IDR frame without
1150     the need to store or decode any previous frames. Applicable to the
1151     H264 encoder.
1152
1153 .. _v4l2-mpeg-video-header-mode:
1154
1155 ``V4L2_CID_MPEG_VIDEO_HEADER_MODE``
1156     (enum)
1157
1158 enum v4l2_mpeg_video_header_mode -
1159     Determines whether the header is returned as the first buffer or is
1160     it returned together with the first frame. Applicable to encoders.
1161     Possible values are:
1162
1163 .. raw:: latex
1164
1165     \small
1166
1167 .. tabularcolumns:: |p{10.3cm}|p{7.2cm}|
1168
1169 .. flat-table::
1170     :header-rows:  0
1171     :stub-columns: 0
1172
1173     * - ``V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE``
1174       - The stream header is returned separately in the first buffer.
1175     * - ``V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME``
1176       - The stream header is returned together with the first encoded
1177         frame.
1178
1179 .. raw:: latex
1180
1181     \normalsize
1182
1183
1184 ``V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER (boolean)``
1185     Repeat the video sequence headers. Repeating these headers makes
1186     random access to the video stream easier. Applicable to the MPEG1, 2
1187     and 4 encoder.
1188
1189 ``V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER (boolean)``
1190     Enabled the deblocking post processing filter for MPEG4 decoder.
1191     Applicable to the MPEG4 decoder.
1192
1193 ``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES (integer)``
1194     vop_time_increment_resolution value for MPEG4. Applicable to the
1195     MPEG4 encoder.
1196
1197 ``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC (integer)``
1198     vop_time_increment value for MPEG4. Applicable to the MPEG4
1199     encoder.
1200
1201 ``V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING (boolean)``
1202     Enable generation of frame packing supplemental enhancement
1203     information in the encoded bitstream. The frame packing SEI message
1204     contains the arrangement of L and R planes for 3D viewing.
1205     Applicable to the H264 encoder.
1206
1207 ``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0 (boolean)``
1208     Sets current frame as frame0 in frame packing SEI. Applicable to the
1209     H264 encoder.
1210
1211 .. _v4l2-mpeg-video-h264-sei-fp-arrangement-type:
1212
1213 ``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE``
1214     (enum)
1215
1216 enum v4l2_mpeg_video_h264_sei_fp_arrangement_type -
1217     Frame packing arrangement type for H264 SEI. Applicable to the H264
1218     encoder. Possible values are:
1219
1220 .. raw:: latex
1221
1222     \small
1223
1224 .. tabularcolumns:: |p{12cm}|p{5.5cm}|
1225
1226 .. flat-table::
1227     :header-rows:  0
1228     :stub-columns: 0
1229
1230     * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_CHEKERBOARD``
1231       - Pixels are alternatively from L and R.
1232     * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_COLUMN``
1233       - L and R are interlaced by column.
1234     * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_ROW``
1235       - L and R are interlaced by row.
1236     * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_SIDE_BY_SIDE``
1237       - L is on the left, R on the right.
1238     * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TOP_BOTTOM``
1239       - L is on top, R on bottom.
1240     * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TEMPORAL``
1241       - One view per frame.
1242
1243 .. raw:: latex
1244
1245     \normalsize
1246
1247
1248
1249 ``V4L2_CID_MPEG_VIDEO_H264_FMO (boolean)``
1250     Enables flexible macroblock ordering in the encoded bitstream. It is
1251     a technique used for restructuring the ordering of macroblocks in
1252     pictures. Applicable to the H264 encoder.
1253
1254 .. _v4l2-mpeg-video-h264-fmo-map-type:
1255
1256 ``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE``
1257    (enum)
1258
1259 enum v4l2_mpeg_video_h264_fmo_map_type -
1260     When using FMO, the map type divides the image in different scan
1261     patterns of macroblocks. Applicable to the H264 encoder. Possible
1262     values are:
1263
1264 .. raw:: latex
1265
1266     \small
1267
1268 .. tabularcolumns:: |p{12.5cm}|p{5.0cm}|
1269
1270 .. flat-table::
1271     :header-rows:  0
1272     :stub-columns: 0
1273
1274     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES``
1275       - Slices are interleaved one after other with macroblocks in run
1276         length order.
1277     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_SCATTERED_SLICES``
1278       - Scatters the macroblocks based on a mathematical function known to
1279         both encoder and decoder.
1280     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_FOREGROUND_WITH_LEFT_OVER``
1281       - Macroblocks arranged in rectangular areas or regions of interest.
1282     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_BOX_OUT``
1283       - Slice groups grow in a cyclic way from centre to outwards.
1284     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_RASTER_SCAN``
1285       - Slice groups grow in raster scan pattern from left to right.
1286     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_WIPE_SCAN``
1287       - Slice groups grow in wipe scan pattern from top to bottom.
1288     * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_EXPLICIT``
1289       - User defined map type.
1290
1291 .. raw:: latex
1292
1293     \normalsize
1294
1295
1296
1297 ``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)``
1298     Number of slice groups in FMO. Applicable to the H264 encoder.
1299
1300 .. _v4l2-mpeg-video-h264-fmo-change-direction:
1301
1302 ``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION``
1303     (enum)
1304
1305 enum v4l2_mpeg_video_h264_fmo_change_dir -
1306     Specifies a direction of the slice group change for raster and wipe
1307     maps. Applicable to the H264 encoder. Possible values are:
1308
1309
1310
1311 .. flat-table::
1312     :header-rows:  0
1313     :stub-columns: 0
1314
1315     * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_RIGHT``
1316       - Raster scan or wipe right.
1317     * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_LEFT``
1318       - Reverse raster scan or wipe left.
1319
1320
1321
1322 ``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE (integer)``
1323     Specifies the size of the first slice group for raster and wipe map.
1324     Applicable to the H264 encoder.
1325
1326 ``V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH (integer)``
1327     Specifies the number of consecutive macroblocks for the interleaved
1328     map. Applicable to the H264 encoder.
1329
1330 ``V4L2_CID_MPEG_VIDEO_H264_ASO (boolean)``
1331     Enables arbitrary slice ordering in encoded bitstream. Applicable to
1332     the H264 encoder.
1333
1334 ``V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER (integer)``
1335     Specifies the slice order in ASO. Applicable to the H264 encoder.
1336     The supplied 32-bit integer is interpreted as follows (bit 0 = least
1337     significant bit):
1338
1339
1340
1341 .. flat-table::
1342     :header-rows:  0
1343     :stub-columns: 0
1344
1345     * - Bit 0:15
1346       - Slice ID
1347     * - Bit 16:32
1348       - Slice position or order
1349
1350
1351
1352 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)``
1353     Enables H264 hierarchical coding. Applicable to the H264 encoder.
1354
1355 .. _v4l2-mpeg-video-h264-hierarchical-coding-type:
1356
1357 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE``
1358     (enum)
1359
1360 enum v4l2_mpeg_video_h264_hierarchical_coding_type -
1361     Specifies the hierarchical coding type. Applicable to the H264
1362     encoder. Possible values are:
1363
1364
1365
1366 .. flat-table::
1367     :header-rows:  0
1368     :stub-columns: 0
1369
1370     * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B``
1371       - Hierarchical B coding.
1372     * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P``
1373       - Hierarchical P coding.
1374
1375
1376
1377 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER (integer)``
1378     Specifies the number of hierarchical coding layers. Applicable to
1379     the H264 encoder.
1380
1381 ``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP (integer)``
1382     Specifies a user defined QP for each layer. Applicable to the H264
1383     encoder. The supplied 32-bit integer is interpreted as follows (bit
1384     0 = least significant bit):
1385
1386
1387
1388 .. flat-table::
1389     :header-rows:  0
1390     :stub-columns: 0
1391
1392     * - Bit 0:15
1393       - QP value
1394     * - Bit 16:32
1395       - Layer number
1396
1397
1398
1399 .. _v4l2-mpeg-mpeg2:
1400
1401 ``V4L2_CID_MPEG_VIDEO_MPEG2_SLICE_PARAMS (struct)``
1402     Specifies the slice parameters (as extracted from the bitstream) for the
1403     associated MPEG-2 slice data. This includes the necessary parameters for
1404     configuring a stateless hardware decoding pipeline for MPEG-2.
1405     The bitstream parameters are defined according to :ref:`mpeg2part2`.
1406
1407     .. note::
1408
1409        This compound control is not yet part of the public kernel API and
1410        it is expected to change.
1411
1412 .. c:type:: v4l2_ctrl_mpeg2_slice_params
1413
1414 .. cssclass:: longtable
1415
1416 .. tabularcolumns:: |p{5.8cm}|p{4.8cm}|p{6.6cm}|
1417
1418 .. flat-table:: struct v4l2_ctrl_mpeg2_slice_params
1419     :header-rows:  0
1420     :stub-columns: 0
1421     :widths:       1 1 2
1422
1423     * - __u32
1424       - ``bit_size``
1425       - Size (in bits) of the current slice data.
1426     * - __u32
1427       - ``data_bit_offset``
1428       - Offset (in bits) to the video data in the current slice data.
1429     * - struct :c:type:`v4l2_mpeg2_sequence`
1430       - ``sequence``
1431       - Structure with MPEG-2 sequence metadata, merging relevant fields from
1432         the sequence header and sequence extension parts of the bitstream.
1433     * - struct :c:type:`v4l2_mpeg2_picture`
1434       - ``picture``
1435       - Structure with MPEG-2 picture metadata, merging relevant fields from
1436         the picture header and picture coding extension parts of the bitstream.
1437     * - __u64
1438       - ``backward_ref_ts``
1439       - Timestamp of the V4L2 capture buffer to use as backward reference, used
1440         with B-coded and P-coded frames. The timestamp refers to the
1441         ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the
1442         :c:func:`v4l2_timeval_to_ns()` function to convert the struct
1443         :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64.
1444     * - __u64
1445       - ``forward_ref_ts``
1446       - Timestamp for the V4L2 capture buffer to use as forward reference, used
1447         with B-coded frames. The timestamp refers to the ``timestamp`` field in
1448         struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()`
1449         function to convert the struct :c:type:`timeval` in struct
1450         :c:type:`v4l2_buffer` to a __u64.
1451     * - __u32
1452       - ``quantiser_scale_code``
1453       - Code used to determine the quantization scale to use for the IDCT.
1454
1455 .. c:type:: v4l2_mpeg2_sequence
1456
1457 .. cssclass:: longtable
1458
1459 .. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}|
1460
1461 .. flat-table:: struct v4l2_mpeg2_sequence
1462     :header-rows:  0
1463     :stub-columns: 0
1464     :widths:       1 1 2
1465
1466     * - __u16
1467       - ``horizontal_size``
1468       - The width of the displayable part of the frame's luminance component.
1469     * - __u16
1470       - ``vertical_size``
1471       - The height of the displayable part of the frame's luminance component.
1472     * - __u32
1473       - ``vbv_buffer_size``
1474       - Used to calculate the required size of the video buffering verifier,
1475         defined (in bits) as: 16 * 1024 * vbv_buffer_size.
1476     * - __u16
1477       - ``profile_and_level_indication``
1478       - The current profile and level indication as extracted from the
1479         bitstream.
1480     * - __u8
1481       - ``progressive_sequence``
1482       - Indication that all the frames for the sequence are progressive instead
1483         of interlaced.
1484     * - __u8
1485       - ``chroma_format``
1486       - The chrominance sub-sampling format (1: 4:2:0, 2: 4:2:2, 3: 4:4:4).
1487
1488 .. c:type:: v4l2_mpeg2_picture
1489
1490 .. cssclass:: longtable
1491
1492 .. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}|
1493
1494 .. flat-table:: struct v4l2_mpeg2_picture
1495     :header-rows:  0
1496     :stub-columns: 0
1497     :widths:       1 1 2
1498
1499     * - __u8
1500       - ``picture_coding_type``
1501       - Picture coding type for the frame covered by the current slice
1502         (V4L2_MPEG2_PICTURE_CODING_TYPE_I, V4L2_MPEG2_PICTURE_CODING_TYPE_P or
1503         V4L2_MPEG2_PICTURE_CODING_TYPE_B).
1504     * - __u8
1505       - ``f_code[2][2]``
1506       - Motion vector codes.
1507     * - __u8
1508       - ``intra_dc_precision``
1509       - Precision of Discrete Cosine transform (0: 8 bits precision,
1510         1: 9 bits precision, 2: 10 bits precision, 3: 11 bits precision).
1511     * - __u8
1512       - ``picture_structure``
1513       - Picture structure (1: interlaced top field, 2: interlaced bottom field,
1514         3: progressive frame).
1515     * - __u8
1516       - ``top_field_first``
1517       - If set to 1 and interlaced stream, top field is output first.
1518     * - __u8
1519       - ``frame_pred_frame_dct``
1520       - If set to 1, only frame-DCT and frame prediction are used.
1521     * - __u8
1522       - ``concealment_motion_vectors``
1523       -  If set to 1, motion vectors are coded for intra macroblocks.
1524     * - __u8
1525       - ``q_scale_type``
1526       - This flag affects the inverse quantization process.
1527     * - __u8
1528       - ``intra_vlc_format``
1529       - This flag affects the decoding of transform coefficient data.
1530     * - __u8
1531       - ``alternate_scan``
1532       - This flag affects the decoding of transform coefficient data.
1533     * - __u8
1534       - ``repeat_first_field``
1535       - This flag affects the decoding process of progressive frames.
1536     * - __u16
1537       - ``progressive_frame``
1538       - Indicates whether the current frame is progressive.
1539
1540 ``V4L2_CID_MPEG_VIDEO_MPEG2_QUANTIZATION (struct)``
1541     Specifies quantization matrices (as extracted from the bitstream) for the
1542     associated MPEG-2 slice data.
1543
1544     .. note::
1545
1546        This compound control is not yet part of the public kernel API and
1547        it is expected to change.
1548
1549 .. c:type:: v4l2_ctrl_mpeg2_quantization
1550
1551 .. cssclass:: longtable
1552
1553 .. tabularcolumns:: |p{1.2cm}|p{8.0cm}|p{7.4cm}|
1554
1555 .. raw:: latex
1556
1557     \small
1558
1559 .. flat-table:: struct v4l2_ctrl_mpeg2_quantization
1560     :header-rows:  0
1561     :stub-columns: 0
1562     :widths:       1 1 2
1563
1564     * - __u8
1565       - ``load_intra_quantiser_matrix``
1566       - One bit to indicate whether to load the ``intra_quantiser_matrix`` data.
1567     * - __u8
1568       - ``load_non_intra_quantiser_matrix``
1569       - One bit to indicate whether to load the ``non_intra_quantiser_matrix``
1570         data.
1571     * - __u8
1572       - ``load_chroma_intra_quantiser_matrix``
1573       - One bit to indicate whether to load the
1574         ``chroma_intra_quantiser_matrix`` data, only relevant for non-4:2:0 YUV
1575         formats.
1576     * - __u8
1577       - ``load_chroma_non_intra_quantiser_matrix``
1578       - One bit to indicate whether to load the
1579         ``chroma_non_intra_quantiser_matrix`` data, only relevant for non-4:2:0
1580         YUV formats.
1581     * - __u8
1582       - ``intra_quantiser_matrix[64]``
1583       - The quantization matrix coefficients for intra-coded frames, in zigzag
1584         scanning order. It is relevant for both luma and chroma components,
1585         although it can be superseded by the chroma-specific matrix for
1586         non-4:2:0 YUV formats.
1587     * - __u8
1588       - ``non_intra_quantiser_matrix[64]``
1589       - The quantization matrix coefficients for non-intra-coded frames, in
1590         zigzag scanning order. It is relevant for both luma and chroma
1591         components, although it can be superseded by the chroma-specific matrix
1592         for non-4:2:0 YUV formats.
1593     * - __u8
1594       - ``chroma_intra_quantiser_matrix[64]``
1595       - The quantization matrix coefficients for the chominance component of
1596         intra-coded frames, in zigzag scanning order. Only relevant for
1597         non-4:2:0 YUV formats.
1598     * - __u8
1599       - ``chroma_non_intra_quantiser_matrix[64]``
1600       - The quantization matrix coefficients for the chrominance component of
1601         non-intra-coded frames, in zigzag scanning order. Only relevant for
1602         non-4:2:0 YUV formats.
1603
1604 ``V4L2_CID_FWHT_I_FRAME_QP (integer)``
1605     Quantization parameter for an I frame for FWHT. Valid range: from 1
1606     to 31.
1607
1608 ``V4L2_CID_FWHT_P_FRAME_QP (integer)``
1609     Quantization parameter for a P frame for FWHT. Valid range: from 1
1610     to 31.
1611
1612 .. raw:: latex
1613
1614     \normalsize
1615
1616
1617 MFC 5.1 MPEG Controls
1618 =====================
1619
1620 The following MPEG class controls deal with MPEG decoding and encoding
1621 settings that are specific to the Multi Format Codec 5.1 device present
1622 in the S5P family of SoCs by Samsung.
1623
1624
1625 .. _mfc51-control-id:
1626
1627 MFC 5.1 Control IDs
1628 -------------------
1629
1630 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE (boolean)``
1631     If the display delay is enabled then the decoder is forced to return
1632     a CAPTURE buffer (decoded frame) after processing a certain number
1633     of OUTPUT buffers. The delay can be set through
1634     ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY``. This
1635     feature can be used for example for generating thumbnails of videos.
1636     Applicable to the H264 decoder.
1637
1638 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY (integer)``
1639     Display delay value for H264 decoder. The decoder is forced to
1640     return a decoded frame after the set 'display delay' number of
1641     frames. If this number is low it may result in frames returned out
1642     of display order, in addition the hardware may still be using the
1643     returned buffer as a reference picture for subsequent frames.
1644
1645 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)``
1646     The number of reference pictures used for encoding a P picture.
1647     Applicable to the H264 encoder.
1648
1649 ``V4L2_CID_MPEG_MFC51_VIDEO_PADDING (boolean)``
1650     Padding enable in the encoder - use a color instead of repeating
1651     border pixels. Applicable to encoders.
1652
1653 ``V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV (integer)``
1654     Padding color in the encoder. Applicable to encoders. The supplied
1655     32-bit integer is interpreted as follows (bit 0 = least significant
1656     bit):
1657
1658
1659
1660 .. flat-table::
1661     :header-rows:  0
1662     :stub-columns: 0
1663
1664     * - Bit 0:7
1665       - V chrominance information
1666     * - Bit 8:15
1667       - U chrominance information
1668     * - Bit 16:23
1669       - Y luminance information
1670     * - Bit 24:31
1671       - Must be zero.
1672
1673
1674
1675 ``V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF (integer)``
1676     Reaction coefficient for MFC rate control. Applicable to encoders.
1677
1678     .. note::
1679
1680        #. Valid only when the frame level RC is enabled.
1681
1682        #. For tight CBR, this field must be small (ex. 2 ~ 10). For
1683           VBR, this field must be large (ex. 100 ~ 1000).
1684
1685        #. It is not recommended to use the greater number than
1686           FRAME_RATE * (10^9 / BIT_RATE).
1687
1688 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK (boolean)``
1689     Adaptive rate control for dark region. Valid only when H.264 and
1690     macroblock level RC is enabled
1691     (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1692     encoder.
1693
1694 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH (boolean)``
1695     Adaptive rate control for smooth region. Valid only when H.264 and
1696     macroblock level RC is enabled
1697     (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1698     encoder.
1699
1700 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC (boolean)``
1701     Adaptive rate control for static region. Valid only when H.264 and
1702     macroblock level RC is enabled
1703     (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1704     encoder.
1705
1706 ``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY (boolean)``
1707     Adaptive rate control for activity region. Valid only when H.264 and
1708     macroblock level RC is enabled
1709     (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264
1710     encoder.
1711
1712 .. _v4l2-mpeg-mfc51-video-frame-skip-mode:
1713
1714 ``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE``
1715     (enum)
1716
1717 enum v4l2_mpeg_mfc51_video_frame_skip_mode -
1718     Indicates in what conditions the encoder should skip frames. If
1719     encoding a frame would cause the encoded stream to be larger then a
1720     chosen data limit then the frame will be skipped. Possible values
1721     are:
1722
1723
1724 .. tabularcolumns:: |p{9.2cm}|p{8.3cm}|
1725
1726 .. raw:: latex
1727
1728     \small
1729
1730 .. flat-table::
1731     :header-rows:  0
1732     :stub-columns: 0
1733
1734     * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED``
1735       - Frame skip mode is disabled.
1736     * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT``
1737       - Frame skip mode enabled and buffer limit is set by the chosen
1738         level and is defined by the standard.
1739     * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT``
1740       - Frame skip mode enabled and buffer limit is set by the VBV
1741         (MPEG1/2/4) or CPB (H264) buffer size control.
1742
1743 .. raw:: latex
1744
1745     \normalsize
1746
1747 ``V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT (integer)``
1748     Enable rate-control with fixed target bit. If this setting is
1749     enabled, then the rate control logic of the encoder will calculate
1750     the average bitrate for a GOP and keep it below or equal the set
1751     bitrate target. Otherwise the rate control logic calculates the
1752     overall average bitrate for the stream and keeps it below or equal
1753     to the set bitrate. In the first case the average bitrate for the
1754     whole stream will be smaller then the set bitrate. This is caused
1755     because the average is calculated for smaller number of frames, on
1756     the other hand enabling this setting will ensure that the stream
1757     will meet tight bandwidth constraints. Applicable to encoders.
1758
1759 .. _v4l2-mpeg-mfc51-video-force-frame-type:
1760
1761 ``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE``
1762     (enum)
1763
1764 enum v4l2_mpeg_mfc51_video_force_frame_type -
1765     Force a frame type for the next queued buffer. Applicable to
1766     encoders. Possible values are:
1767
1768 .. tabularcolumns:: |p{9.5cm}|p{8.0cm}|
1769
1770 .. flat-table::
1771     :header-rows:  0
1772     :stub-columns: 0
1773
1774     * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED``
1775       - Forcing a specific frame type disabled.
1776     * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME``
1777       - Force an I-frame.
1778     * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED``
1779       - Force a non-coded frame.
1780
1781
1782 .. _v4l2-mpeg-fwht:
1783
1784 ``V4L2_CID_MPEG_VIDEO_FWHT_PARAMS (struct)``
1785     Specifies the fwht parameters (as extracted from the bitstream) for the
1786     associated FWHT data. This includes the necessary parameters for
1787     configuring a stateless hardware decoding pipeline for FWHT.
1788
1789     .. note::
1790
1791        This compound control is not yet part of the public kernel API and
1792        it is expected to change.
1793
1794 .. c:type:: v4l2_ctrl_fwht_params
1795
1796 .. cssclass:: longtable
1797
1798 .. tabularcolumns:: |p{1.4cm}|p{4.3cm}|p{11.8cm}|
1799
1800 .. flat-table:: struct v4l2_ctrl_fwht_params
1801     :header-rows:  0
1802     :stub-columns: 0
1803     :widths:       1 1 2
1804
1805     * - __u64
1806       - ``backward_ref_ts``
1807       - Timestamp of the V4L2 capture buffer to use as backward reference, used
1808         with P-coded frames. The timestamp refers to the
1809         ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the
1810         :c:func:`v4l2_timeval_to_ns()` function to convert the struct
1811         :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64.
1812     * - __u32
1813       - ``version``
1814       - The version of the codec
1815     * - __u32
1816       - ``width``
1817       - The width of the frame
1818     * - __u32
1819       - ``height``
1820       - The height of the frame
1821     * - __u32
1822       - ``flags``
1823       - The flags of the frame, see :ref:`fwht-flags`.
1824     * - __u32
1825       - ``colorspace``
1826       - The colorspace of the frame, from enum :c:type:`v4l2_colorspace`.
1827     * - __u32
1828       - ``xfer_func``
1829       - The transfer function, from enum :c:type:`v4l2_xfer_func`.
1830     * - __u32
1831       - ``ycbcr_enc``
1832       - The Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`.
1833     * - __u32
1834       - ``quantization``
1835       - The quantization range, from enum :c:type:`v4l2_quantization`.
1836
1837
1838
1839 .. _fwht-flags:
1840
1841 FWHT Flags
1842 ============
1843
1844 .. cssclass:: longtable
1845
1846 .. tabularcolumns:: |p{6.8cm}|p{2.4cm}|p{8.3cm}|
1847
1848 .. flat-table::
1849     :header-rows:  0
1850     :stub-columns: 0
1851     :widths:       3 1 4
1852
1853     * - ``FWHT_FL_IS_INTERLACED``
1854       - 0x00000001
1855       - Set if this is an interlaced format
1856     * - ``FWHT_FL_IS_BOTTOM_FIRST``
1857       - 0x00000002
1858       - Set if this is a bottom-first (NTSC) interlaced format
1859     * - ``FWHT_FL_IS_ALTERNATE``
1860       - 0x00000004
1861       - Set if each 'frame' contains just one field
1862     * - ``FWHT_FL_IS_BOTTOM_FIELD``
1863       - 0x00000008
1864       - If FWHT_FL_IS_ALTERNATE was set, then this is set if this 'frame' is the
1865         bottom field, else it is the top field.
1866     * - ``FWHT_FL_LUMA_IS_UNCOMPRESSED``
1867       - 0x00000010
1868       - Set if the luma plane is uncompressed
1869     * - ``FWHT_FL_CB_IS_UNCOMPRESSED``
1870       - 0x00000020
1871       - Set if the cb plane is uncompressed
1872     * - ``FWHT_FL_CR_IS_UNCOMPRESSED``
1873       - 0x00000040
1874       - Set if the cr plane is uncompressed
1875     * - ``FWHT_FL_CHROMA_FULL_HEIGHT``
1876       - 0x00000080
1877       - Set if the chroma plane has the same height as the luma plane,
1878         else the chroma plane is half the height of the luma plane
1879     * - ``FWHT_FL_CHROMA_FULL_WIDTH``
1880       - 0x00000100
1881       - Set if the chroma plane has the same width as the luma plane,
1882         else the chroma plane is half the width of the luma plane
1883     * - ``FWHT_FL_ALPHA_IS_UNCOMPRESSED``
1884       - 0x00000200
1885       - Set if the alpha plane is uncompressed
1886     * - ``FWHT_FL_I_FRAME``
1887       - 0x00000400
1888       - Set if this is an I-frame
1889     * - ``FWHT_FL_COMPONENTS_NUM_MSK``
1890       - 0x00070000
1891       - A 4-values flag - the number of components - 1
1892     * - ``FWHT_FL_PIXENC_YUV``
1893       - 0x00080000
1894       - Set if the pixel encoding is YUV
1895     * - ``FWHT_FL_PIXENC_RGB``
1896       - 0x00100000
1897       - Set if the pixel encoding is RGB
1898     * - ``FWHT_FL_PIXENC_HSV``
1899       - 0x00180000
1900       - Set if the pixel encoding is HSV
1901
1902
1903 CX2341x MPEG Controls
1904 =====================
1905
1906 The following MPEG class controls deal with MPEG encoding settings that
1907 are specific to the Conexant CX23415 and CX23416 MPEG encoding chips.
1908
1909
1910 .. _cx2341x-control-id:
1911
1912 CX2341x Control IDs
1913 -------------------
1914
1915 .. _v4l2-mpeg-cx2341x-video-spatial-filter-mode:
1916
1917 ``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE``
1918     (enum)
1919
1920 enum v4l2_mpeg_cx2341x_video_spatial_filter_mode -
1921     Sets the Spatial Filter mode (default ``MANUAL``). Possible values
1922     are:
1923
1924
1925
1926 .. flat-table::
1927     :header-rows:  0
1928     :stub-columns: 0
1929
1930     * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL``
1931       - Choose the filter manually
1932     * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO``
1933       - Choose the filter automatically
1934
1935
1936
1937 ``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (integer (0-15))``
1938     The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default
1939     is 0.)
1940
1941 .. _luma-spatial-filter-type:
1942
1943 ``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE``
1944     (enum)
1945
1946 enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type -
1947     Select the algorithm to use for the Luma Spatial Filter (default
1948     ``1D_HOR``). Possible values:
1949
1950 .. tabularcolumns:: |p{14.5cm}|p{3.0cm}|
1951
1952 .. raw:: latex
1953
1954     \small
1955
1956 .. flat-table::
1957     :header-rows:  0
1958     :stub-columns: 0
1959
1960     * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF``
1961       - No filter
1962     * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR``
1963       - One-dimensional horizontal
1964     * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT``
1965       - One-dimensional vertical
1966     * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE``
1967       - Two-dimensional separable
1968     * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE``
1969       - Two-dimensional symmetrical non-separable
1970
1971 .. raw:: latex
1972
1973     \normalsize
1974
1975
1976
1977 .. _chroma-spatial-filter-type:
1978
1979 ``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE``
1980     (enum)
1981
1982 enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type -
1983     Select the algorithm for the Chroma Spatial Filter (default
1984     ``1D_HOR``). Possible values are:
1985
1986
1987 .. tabularcolumns:: |p{14.0cm}|p{3.5cm}|
1988
1989 .. flat-table::
1990     :header-rows:  0
1991     :stub-columns: 0
1992
1993     * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF``
1994       - No filter
1995     * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR``
1996       - One-dimensional horizontal
1997
1998
1999
2000 .. _v4l2-mpeg-cx2341x-video-temporal-filter-mode:
2001
2002 ``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE``
2003     (enum)
2004
2005 enum v4l2_mpeg_cx2341x_video_temporal_filter_mode -
2006     Sets the Temporal Filter mode (default ``MANUAL``). Possible values
2007     are:
2008
2009
2010
2011 .. flat-table::
2012     :header-rows:  0
2013     :stub-columns: 0
2014
2015     * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL``
2016       - Choose the filter manually
2017     * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO``
2018       - Choose the filter automatically
2019
2020
2021
2022 ``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (integer (0-31))``
2023     The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default
2024     is 8 for full-scale capturing and 0 for scaled capturing.)
2025
2026 .. _v4l2-mpeg-cx2341x-video-median-filter-type:
2027
2028 ``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE``
2029     (enum)
2030
2031 enum v4l2_mpeg_cx2341x_video_median_filter_type -
2032     Median Filter Type (default ``OFF``). Possible values are:
2033
2034
2035
2036 .. flat-table::
2037     :header-rows:  0
2038     :stub-columns: 0
2039
2040     * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF``
2041       - No filter
2042     * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR``
2043       - Horizontal filter
2044     * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT``
2045       - Vertical filter
2046     * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT``
2047       - Horizontal and vertical filter
2048     * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG``
2049       - Diagonal filter
2050
2051
2052
2053 ``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (integer (0-255))``
2054     Threshold above which the luminance median filter is enabled
2055     (default 0)
2056
2057 ``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (integer (0-255))``
2058     Threshold below which the luminance median filter is enabled
2059     (default 255)
2060
2061 ``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (integer (0-255))``
2062     Threshold above which the chroma median filter is enabled (default
2063     0)
2064
2065 ``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (integer (0-255))``
2066     Threshold below which the chroma median filter is enabled (default
2067     255)
2068
2069 ``V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (boolean)``
2070     The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into
2071     the stream between every four video frames. The packet size is 2048
2072     bytes, including the packet_start_code_prefix and stream_id
2073     fields. The stream_id is 0xBF (private stream 2). The payload
2074     consists of 0x00 bytes, to be filled in by the application. 0 = do
2075     not insert, 1 = insert packets.
2076
2077
2078 VPX Control Reference
2079 =====================
2080
2081 The VPX controls include controls for encoding parameters of VPx video
2082 codec.
2083
2084
2085 .. _vpx-control-id:
2086
2087 VPX Control IDs
2088 ---------------
2089
2090 .. _v4l2-vpx-num-partitions:
2091
2092 ``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS``
2093     (enum)
2094
2095 enum v4l2_vp8_num_partitions -
2096     The number of token partitions to use in VP8 encoder. Possible
2097     values are:
2098
2099
2100
2101 .. flat-table::
2102     :header-rows:  0
2103     :stub-columns: 0
2104
2105     * - ``V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION``
2106       - 1 coefficient partition
2107     * - ``V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS``
2108       - 2 coefficient partitions
2109     * - ``V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS``
2110       - 4 coefficient partitions
2111     * - ``V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS``
2112       - 8 coefficient partitions
2113
2114
2115
2116 ``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)``
2117     Setting this prevents intra 4x4 mode in the intra mode decision.
2118
2119 .. _v4l2-vpx-num-ref-frames:
2120
2121 ``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES``
2122     (enum)
2123
2124 enum v4l2_vp8_num_ref_frames -
2125     The number of reference pictures for encoding P frames. Possible
2126     values are:
2127
2128 .. tabularcolumns:: |p{7.9cm}|p{9.6cm}|
2129
2130 .. raw:: latex
2131
2132     \small
2133
2134 .. flat-table::
2135     :header-rows:  0
2136     :stub-columns: 0
2137
2138     * - ``V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME``
2139       - Last encoded frame will be searched
2140     * - ``V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME``
2141       - Two frames will be searched among the last encoded frame, the
2142         golden frame and the alternate reference (altref) frame. The
2143         encoder implementation will decide which two are chosen.
2144     * - ``V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME``
2145       - The last encoded frame, the golden frame and the altref frame will
2146         be searched.
2147
2148 .. raw:: latex
2149
2150     \normalsize
2151
2152
2153
2154 ``V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL (integer)``
2155     Indicates the loop filter level. The adjustment of the loop filter
2156     level is done via a delta value against a baseline loop filter
2157     value.
2158
2159 ``V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS (integer)``
2160     This parameter affects the loop filter. Anything above zero weakens
2161     the deblocking effect on the loop filter.
2162
2163 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD (integer)``
2164     Sets the refresh period for the golden frame. The period is defined
2165     in number of frames. For a value of 'n', every nth frame starting
2166     from the first key frame will be taken as a golden frame. For eg.
2167     for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden
2168     frame refresh period is set as 4, the frames 0, 4, 8 etc will be
2169     taken as the golden frames as frame 0 is always a key frame.
2170
2171 .. _v4l2-vpx-golden-frame-sel:
2172
2173 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL``
2174     (enum)
2175
2176 enum v4l2_vp8_golden_frame_sel -
2177     Selects the golden frame for encoding. Possible values are:
2178
2179 .. raw:: latex
2180
2181     \scriptsize
2182
2183 .. tabularcolumns:: |p{9.0cm}|p{8.0cm}|
2184
2185 .. flat-table::
2186     :header-rows:  0
2187     :stub-columns: 0
2188
2189     * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV``
2190       - Use the (n-2)th frame as a golden frame, current frame index being
2191         'n'.
2192     * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD``
2193       - Use the previous specific frame indicated by
2194         ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD`` as a
2195         golden frame.
2196
2197 .. raw:: latex
2198
2199     \normalsize
2200
2201
2202 ``V4L2_CID_MPEG_VIDEO_VPX_MIN_QP (integer)``
2203     Minimum quantization parameter for VP8.
2204
2205 ``V4L2_CID_MPEG_VIDEO_VPX_MAX_QP (integer)``
2206     Maximum quantization parameter for VP8.
2207
2208 ``V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP (integer)``
2209     Quantization parameter for an I frame for VP8.
2210
2211 ``V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP (integer)``
2212     Quantization parameter for a P frame for VP8.
2213
2214 .. _v4l2-mpeg-video-vp8-profile:
2215
2216 ``V4L2_CID_MPEG_VIDEO_VP8_PROFILE``
2217     (enum)
2218
2219 enum v4l2_mpeg_video_vp8_profile -
2220     This control allows selecting the profile for VP8 encoder.
2221     This is also used to enumerate supported profiles by VP8 encoder or decoder.
2222     Possible values are:
2223
2224 .. flat-table::
2225     :header-rows:  0
2226     :stub-columns: 0
2227
2228     * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_0``
2229       - Profile 0
2230     * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_1``
2231       - Profile 1
2232     * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_2``
2233       - Profile 2
2234     * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_3``
2235       - Profile 3
2236
2237 .. _v4l2-mpeg-video-vp9-profile:
2238
2239 ``V4L2_CID_MPEG_VIDEO_VP9_PROFILE``
2240     (enum)
2241
2242 enum v4l2_mpeg_video_vp9_profile -
2243     This control allows selecting the profile for VP9 encoder.
2244     This is also used to enumerate supported profiles by VP9 encoder or decoder.
2245     Possible values are:
2246
2247 .. flat-table::
2248     :header-rows:  0
2249     :stub-columns: 0
2250
2251     * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_0``
2252       - Profile 0
2253     * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_1``
2254       - Profile 1
2255     * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_2``
2256       - Profile 2
2257     * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_3``
2258       - Profile 3
2259
2260
2261 High Efficiency Video Coding (HEVC/H.265) Control Reference
2262 ===========================================================
2263
2264 The HEVC/H.265 controls include controls for encoding parameters of HEVC/H.265
2265 video codec.
2266
2267
2268 .. _hevc-control-id:
2269
2270 HEVC/H.265 Control IDs
2271 ----------------------
2272
2273 ``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP (integer)``
2274     Minimum quantization parameter for HEVC.
2275     Valid range: from 0 to 51.
2276
2277 ``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP (integer)``
2278     Maximum quantization parameter for HEVC.
2279     Valid range: from 0 to 51.
2280
2281 ``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP (integer)``
2282     Quantization parameter for an I frame for HEVC.
2283     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2284     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2285
2286 ``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP (integer)``
2287     Quantization parameter for a P frame for HEVC.
2288     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2289     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2290
2291 ``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP (integer)``
2292     Quantization parameter for a B frame for HEVC.
2293     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2294     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2295
2296 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_QP (boolean)``
2297     HIERARCHICAL_QP allows the host to specify the quantization parameter
2298     values for each temporal layer through HIERARCHICAL_QP_LAYER. This is
2299     valid only if HIERARCHICAL_CODING_LAYER is greater than 1. Setting the
2300     control value to 1 enables setting of the QP values for the layers.
2301
2302 .. _v4l2-hevc-hier-coding-type:
2303
2304 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_TYPE``
2305     (enum)
2306
2307 enum v4l2_mpeg_video_hevc_hier_coding_type -
2308     Selects the hierarchical coding type for encoding. Possible values are:
2309
2310 .. raw:: latex
2311
2312     \footnotesize
2313
2314 .. tabularcolumns:: |p{9.0cm}|p{8.0cm}|
2315
2316 .. flat-table::
2317     :header-rows:  0
2318     :stub-columns: 0
2319
2320     * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B``
2321       - Use the B frame for hierarchical coding.
2322     * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P``
2323       - Use the P frame for hierarchical coding.
2324
2325 .. raw:: latex
2326
2327     \normalsize
2328
2329
2330 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER (integer)``
2331     Selects the hierarchical coding layer. In normal encoding
2332     (non-hierarchial coding), it should be zero. Possible values are [0, 6].
2333     0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING
2334     LAYER 1 and so on.
2335
2336 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_QP (integer)``
2337     Indicates quantization parameter for hierarchical coding layer 0.
2338     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2339     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2340
2341 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_QP (integer)``
2342     Indicates quantization parameter for hierarchical coding layer 1.
2343     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2344     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2345
2346 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_QP (integer)``
2347     Indicates quantization parameter for hierarchical coding layer 2.
2348     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2349     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2350
2351 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_QP (integer)``
2352     Indicates quantization parameter for hierarchical coding layer 3.
2353     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2354     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2355
2356 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_QP (integer)``
2357     Indicates quantization parameter for hierarchical coding layer 4.
2358     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2359     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2360
2361 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_QP (integer)``
2362     Indicates quantization parameter for hierarchical coding layer 5.
2363     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2364     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2365
2366 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_QP (integer)``
2367     Indicates quantization parameter for hierarchical coding layer 6.
2368     Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP,
2369     V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP].
2370
2371 .. _v4l2-hevc-profile:
2372
2373 ``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE``
2374     (enum)
2375
2376 enum v4l2_mpeg_video_hevc_profile -
2377     Select the desired profile for HEVC encoder.
2378
2379 .. raw:: latex
2380
2381     \footnotesize
2382
2383 .. tabularcolumns:: |p{9.0cm}|p{8.0cm}|
2384
2385 .. flat-table::
2386     :header-rows:  0
2387     :stub-columns: 0
2388
2389     * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN``
2390       - Main profile.
2391     * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE``
2392       - Main still picture profile.
2393     * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_10``
2394       - Main 10 profile.
2395
2396 .. raw:: latex
2397
2398     \normalsize
2399
2400
2401 .. _v4l2-hevc-level:
2402
2403 ``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL``
2404     (enum)
2405
2406 enum v4l2_mpeg_video_hevc_level -
2407     Selects the desired level for HEVC encoder.
2408
2409 .. raw:: latex
2410
2411     \footnotesize
2412
2413 .. tabularcolumns:: |p{9.0cm}|p{8.0cm}|
2414
2415 .. flat-table::
2416     :header-rows:  0
2417     :stub-columns: 0
2418
2419     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_1``
2420       - Level 1.0
2421     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2``
2422       - Level 2.0
2423     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1``
2424       - Level 2.1
2425     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3``
2426       - Level 3.0
2427     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1``
2428       - Level 3.1
2429     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4``
2430       - Level 4.0
2431     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1``
2432       - Level 4.1
2433     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5``
2434       - Level 5.0
2435     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1``
2436       - Level 5.1
2437     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2``
2438       - Level 5.2
2439     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6``
2440       - Level 6.0
2441     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1``
2442       - Level 6.1
2443     * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2``
2444       - Level 6.2
2445
2446 .. raw:: latex
2447
2448     \normalsize
2449
2450
2451 ``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION (integer)``
2452     Indicates the number of evenly spaced subintervals, called ticks, within
2453     one second. This is a 16 bit unsigned integer and has a maximum value up to
2454     0xffff and a minimum value of 1.
2455
2456 .. _v4l2-hevc-tier:
2457
2458 ``V4L2_CID_MPEG_VIDEO_HEVC_TIER``
2459     (enum)
2460
2461 enum v4l2_mpeg_video_hevc_tier -
2462     TIER_FLAG specifies tiers information of the HEVC encoded picture. Tier
2463     were made to deal with applications that differ in terms of maximum bit
2464     rate. Setting the flag to 0 selects HEVC tier as Main tier and setting
2465     this flag to 1 indicates High tier. High tier is for applications requiring
2466     high bit rates.
2467
2468 .. raw:: latex
2469
2470     \footnotesize
2471
2472 .. tabularcolumns:: |p{9.0cm}|p{8.0cm}|
2473
2474 .. flat-table::
2475     :header-rows:  0
2476     :stub-columns: 0
2477
2478     * - ``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN``
2479       - Main tier.
2480     * - ``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH``
2481       - High tier.
2482
2483 .. raw:: latex
2484
2485     \normalsize
2486
2487
2488 ``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH (integer)``
2489     Selects HEVC maximum coding unit depth.
2490
2491 .. _v4l2-hevc-loop-filter-mode:
2492
2493 ``V4L2_CID_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE``
2494     (enum)
2495
2496 enum v4l2_mpeg_video_hevc_loop_filter_mode -
2497     Loop filter mode for HEVC encoder. Possible values are:
2498
2499 .. raw:: latex
2500
2501     \footnotesize
2502
2503 .. tabularcolumns:: |p{12.1cm}|p{5.4cm}|
2504
2505 .. flat-table::
2506     :header-rows:  0
2507     :stub-columns: 0
2508
2509     * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED``
2510       - Loop filter is disabled.
2511     * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_ENABLED``
2512       - Loop filter is enabled.
2513     * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY``
2514       - Loop filter is disabled at the slice boundary.
2515
2516 .. raw:: latex
2517
2518     \normalsize
2519
2520
2521 ``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2 (integer)``
2522     Selects HEVC loop filter beta offset. The valid range is [-6, +6].
2523
2524 ``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2 (integer)``
2525     Selects HEVC loop filter tc offset. The valid range is [-6, +6].
2526
2527 .. _v4l2-hevc-refresh-type:
2528
2529 ``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE``
2530     (enum)
2531
2532 enum v4l2_mpeg_video_hevc_hier_refresh_type -
2533     Selects refresh type for HEVC encoder.
2534     Host has to specify the period into
2535     V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD.
2536
2537 .. raw:: latex
2538
2539     \footnotesize
2540
2541 .. tabularcolumns:: |p{8.0cm}|p{9.0cm}|
2542
2543 .. flat-table::
2544     :header-rows:  0
2545     :stub-columns: 0
2546
2547     * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE``
2548       - Use the B frame for hierarchical coding.
2549     * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA``
2550       - Use CRA (Clean Random Access Unit) picture encoding.
2551     * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR``
2552       - Use IDR (Instantaneous Decoding Refresh) picture encoding.
2553
2554 .. raw:: latex
2555
2556     \normalsize
2557
2558
2559 ``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD (integer)``
2560     Selects the refresh period for HEVC encoder.
2561     This specifies the number of I pictures between two CRA/IDR pictures.
2562     This is valid only if REFRESH_TYPE is not 0.
2563
2564 ``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU (boolean)``
2565     Indicates HEVC lossless encoding. Setting it to 0 disables lossless
2566     encoding. Setting it to 1 enables lossless encoding.
2567
2568 ``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED (boolean)``
2569     Indicates constant intra prediction for HEVC encoder. Specifies the
2570     constrained intra prediction in which intra largest coding unit (LCU)
2571     prediction is performed by using residual data and decoded samples of
2572     neighboring intra LCU only. Setting the value to 1 enables constant intra
2573     prediction and setting the value to 0 disables constant intra prediction.
2574
2575 ``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT (boolean)``
2576     Indicates wavefront parallel processing for HEVC encoder. Setting it to 0
2577     disables the feature and setting it to 1 enables the wavefront parallel
2578     processing.
2579
2580 ``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB (boolean)``
2581     Setting the value to 1 enables combination of P and B frame for HEVC
2582     encoder.
2583
2584 ``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID (boolean)``
2585     Indicates temporal identifier for HEVC encoder which is enabled by
2586     setting the value to 1.
2587
2588 ``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING (boolean)``
2589     Indicates bi-linear interpolation is conditionally used in the intra
2590     prediction filtering process in the CVS when set to 1. Indicates bi-linear
2591     interpolation is not used in the CVS when set to 0.
2592
2593 ``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1 (integer)``
2594     Indicates maximum number of merge candidate motion vectors.
2595     Values are from 0 to 4.
2596
2597 ``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION (boolean)``
2598     Indicates temporal motion vector prediction for HEVC encoder. Setting it to
2599     1 enables the prediction. Setting it to 0 disables the prediction.
2600
2601 ``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE (boolean)``
2602     Specifies if HEVC generates a stream with a size of the length field
2603     instead of start code pattern. The size of the length field is configurable
2604     through the V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD control. Setting
2605     the value to 0 disables encoding without startcode pattern. Setting the
2606     value to 1 will enables encoding without startcode pattern.
2607
2608 .. _v4l2-hevc-size-of-length-field:
2609
2610 ``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD``
2611 (enum)
2612
2613 enum v4l2_mpeg_video_hevc_size_of_length_field -
2614     Indicates the size of length field.
2615     This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled.
2616
2617 .. raw:: latex
2618
2619     \footnotesize
2620
2621 .. tabularcolumns:: |p{6.0cm}|p{11.0cm}|
2622
2623 .. flat-table::
2624     :header-rows:  0
2625     :stub-columns: 0
2626
2627     * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0``
2628       - Generate start code pattern (Normal).
2629     * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1``
2630       - Generate size of length field instead of start code pattern and length is 1.
2631     * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2``
2632       - Generate size of length field instead of start code pattern and length is 2.
2633     * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4``
2634       - Generate size of length field instead of start code pattern and length is 4.
2635
2636 .. raw:: latex
2637
2638     \normalsize
2639
2640 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_BR (integer)``
2641     Indicates bit rate for hierarchical coding layer 0 for HEVC encoder.
2642
2643 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_BR (integer)``
2644     Indicates bit rate for hierarchical coding layer 1 for HEVC encoder.
2645
2646 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_BR (integer)``
2647     Indicates bit rate for hierarchical coding layer 2 for HEVC encoder.
2648
2649 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_BR (integer)``
2650     Indicates bit rate for hierarchical coding layer 3 for HEVC encoder.
2651
2652 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_BR (integer)``
2653     Indicates bit rate for hierarchical coding layer 4 for HEVC encoder.
2654
2655 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_BR (integer)``
2656     Indicates bit rate for hierarchical coding layer 5 for HEVC encoder.
2657
2658 ``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_BR (integer)``
2659     Indicates bit rate for hierarchical coding layer 6 for HEVC encoder.
2660
2661 ``V4L2_CID_MPEG_VIDEO_REF_NUMBER_FOR_PFRAMES (integer)``
2662     Selects number of P reference pictures required for HEVC encoder.
2663     P-Frame can use 1 or 2 frames for reference.
2664
2665 ``V4L2_CID_MPEG_VIDEO_PREPEND_SPSPPS_TO_IDR (integer)``
2666     Indicates whether to generate SPS and PPS at every IDR. Setting it to 0
2667     disables generating SPS and PPS at every IDR. Setting it to one enables
2668     generating SPS and PPS at every IDR.