1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later 2 3.. _codec-controls: 4 5*********************** 6Codec Control Reference 7*********************** 8 9Below all controls within the Codec control class are described. First 10the generic controls, then controls specific for certain hardware. 11 12.. note:: 13 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 17 encoding formats. 18 19 20Generic Codec Controls 21====================== 22 23 24.. _mpeg-control-id: 25 26Codec Control IDs 27----------------- 28 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. 34 35.. _v4l2-mpeg-stream-type: 36 37``V4L2_CID_MPEG_STREAM_TYPE`` 38 (enum) 39 40enum 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: 45 46 47 48.. flat-table:: 49 :header-rows: 0 50 :stub-columns: 0 51 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 64 65 66 67``V4L2_CID_MPEG_STREAM_PID_PMT (integer)`` 68 Program Map Table Packet ID for the MPEG transport stream (default 69 16) 70 71``V4L2_CID_MPEG_STREAM_PID_AUDIO (integer)`` 72 Audio Packet ID for the MPEG transport stream (default 256) 73 74``V4L2_CID_MPEG_STREAM_PID_VIDEO (integer)`` 75 Video Packet ID for the MPEG transport stream (default 260) 76 77``V4L2_CID_MPEG_STREAM_PID_PCR (integer)`` 78 Packet ID for the MPEG transport stream carrying PCR fields (default 79 259) 80 81``V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (integer)`` 82 Audio ID for MPEG PES 83 84``V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (integer)`` 85 Video ID for MPEG PES 86 87.. _v4l2-mpeg-stream-vbi-fmt: 88 89``V4L2_CID_MPEG_STREAM_VBI_FMT`` 90 (enum) 91 92enum 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 97 VBI format types are: 98 99 100 101.. tabularcolumns:: |p{6.6 cm}|p{10.9cm}| 102 103.. flat-table:: 104 :header-rows: 0 105 :stub-columns: 0 106 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 111 sources in the file 112 ``Documentation/userspace-api/media/drivers/cx2341x-uapi.rst``) 113 114 115 116.. _v4l2-mpeg-audio-sampling-freq: 117 118``V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ`` 119 (enum) 120 121enum v4l2_mpeg_audio_sampling_freq - 122 MPEG Audio sampling frequency. Possible values are: 123 124 125 126.. flat-table:: 127 :header-rows: 0 128 :stub-columns: 0 129 130 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100`` 131 - 44.1 kHz 132 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000`` 133 - 48 kHz 134 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000`` 135 - 32 kHz 136 137 138 139.. _v4l2-mpeg-audio-encoding: 140 141``V4L2_CID_MPEG_AUDIO_ENCODING`` 142 (enum) 143 144enum v4l2_mpeg_audio_encoding - 145 MPEG Audio encoding. This control is specific to multiplexed MPEG 146 streams. Possible values are: 147 148 149 150.. flat-table:: 151 :header-rows: 0 152 :stub-columns: 0 153 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 164 165 166 167.. _v4l2-mpeg-audio-l1-bitrate: 168 169``V4L2_CID_MPEG_AUDIO_L1_BITRATE`` 170 (enum) 171 172enum v4l2_mpeg_audio_l1_bitrate - 173 MPEG-1/2 Layer I bitrate. Possible values are: 174 175 176 177.. flat-table:: 178 :header-rows: 0 179 :stub-columns: 0 180 181 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_32K`` 182 - 32 kbit/s 183 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_64K`` 184 - 64 kbit/s 185 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_96K`` 186 - 96 kbit/s 187 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_128K`` 188 - 128 kbit/s 189 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_160K`` 190 - 160 kbit/s 191 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_192K`` 192 - 192 kbit/s 193 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_224K`` 194 - 224 kbit/s 195 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_256K`` 196 - 256 kbit/s 197 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_288K`` 198 - 288 kbit/s 199 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_320K`` 200 - 320 kbit/s 201 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_352K`` 202 - 352 kbit/s 203 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_384K`` 204 - 384 kbit/s 205 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_416K`` 206 - 416 kbit/s 207 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_448K`` 208 - 448 kbit/s 209 210 211 212.. _v4l2-mpeg-audio-l2-bitrate: 213 214``V4L2_CID_MPEG_AUDIO_L2_BITRATE`` 215 (enum) 216 217enum v4l2_mpeg_audio_l2_bitrate - 218 MPEG-1/2 Layer II bitrate. Possible values are: 219 220 221 222.. flat-table:: 223 :header-rows: 0 224 :stub-columns: 0 225 226 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_32K`` 227 - 32 kbit/s 228 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_48K`` 229 - 48 kbit/s 230 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_56K`` 231 - 56 kbit/s 232 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_64K`` 233 - 64 kbit/s 234 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_80K`` 235 - 80 kbit/s 236 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_96K`` 237 - 96 kbit/s 238 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_112K`` 239 - 112 kbit/s 240 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_128K`` 241 - 128 kbit/s 242 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_160K`` 243 - 160 kbit/s 244 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_192K`` 245 - 192 kbit/s 246 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_224K`` 247 - 224 kbit/s 248 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_256K`` 249 - 256 kbit/s 250 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_320K`` 251 - 320 kbit/s 252 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_384K`` 253 - 384 kbit/s 254 255 256 257.. _v4l2-mpeg-audio-l3-bitrate: 258 259``V4L2_CID_MPEG_AUDIO_L3_BITRATE`` 260 (enum) 261 262enum v4l2_mpeg_audio_l3_bitrate - 263 MPEG-1/2 Layer III bitrate. Possible values are: 264 265 266 267.. flat-table:: 268 :header-rows: 0 269 :stub-columns: 0 270 271 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_32K`` 272 - 32 kbit/s 273 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_40K`` 274 - 40 kbit/s 275 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_48K`` 276 - 48 kbit/s 277 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_56K`` 278 - 56 kbit/s 279 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_64K`` 280 - 64 kbit/s 281 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_80K`` 282 - 80 kbit/s 283 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_96K`` 284 - 96 kbit/s 285 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_112K`` 286 - 112 kbit/s 287 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_128K`` 288 - 128 kbit/s 289 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_160K`` 290 - 160 kbit/s 291 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_192K`` 292 - 192 kbit/s 293 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_224K`` 294 - 224 kbit/s 295 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_256K`` 296 - 256 kbit/s 297 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_320K`` 298 - 320 kbit/s 299 300 301 302``V4L2_CID_MPEG_AUDIO_AAC_BITRATE (integer)`` 303 AAC bitrate in bits per second. 304 305.. _v4l2-mpeg-audio-ac3-bitrate: 306 307``V4L2_CID_MPEG_AUDIO_AC3_BITRATE`` 308 (enum) 309 310enum v4l2_mpeg_audio_ac3_bitrate - 311 AC-3 bitrate. Possible values are: 312 313 314 315.. flat-table:: 316 :header-rows: 0 317 :stub-columns: 0 318 319 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_32K`` 320 - 32 kbit/s 321 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_40K`` 322 - 40 kbit/s 323 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_48K`` 324 - 48 kbit/s 325 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_56K`` 326 - 56 kbit/s 327 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_64K`` 328 - 64 kbit/s 329 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_80K`` 330 - 80 kbit/s 331 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_96K`` 332 - 96 kbit/s 333 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_112K`` 334 - 112 kbit/s 335 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_128K`` 336 - 128 kbit/s 337 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_160K`` 338 - 160 kbit/s 339 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_192K`` 340 - 192 kbit/s 341 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_224K`` 342 - 224 kbit/s 343 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_256K`` 344 - 256 kbit/s 345 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_320K`` 346 - 320 kbit/s 347 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_384K`` 348 - 384 kbit/s 349 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_448K`` 350 - 448 kbit/s 351 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_512K`` 352 - 512 kbit/s 353 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_576K`` 354 - 576 kbit/s 355 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_640K`` 356 - 640 kbit/s 357 358 359 360.. _v4l2-mpeg-audio-mode: 361 362``V4L2_CID_MPEG_AUDIO_MODE`` 363 (enum) 364 365enum v4l2_mpeg_audio_mode - 366 MPEG Audio mode. Possible values are: 367 368 369 370.. flat-table:: 371 :header-rows: 0 372 :stub-columns: 0 373 374 * - ``V4L2_MPEG_AUDIO_MODE_STEREO`` 375 - Stereo 376 * - ``V4L2_MPEG_AUDIO_MODE_JOINT_STEREO`` 377 - Joint Stereo 378 * - ``V4L2_MPEG_AUDIO_MODE_DUAL`` 379 - Bilingual 380 * - ``V4L2_MPEG_AUDIO_MODE_MONO`` 381 - Mono 382 383 384 385.. _v4l2-mpeg-audio-mode-extension: 386 387``V4L2_CID_MPEG_AUDIO_MODE_EXTENSION`` 388 (enum) 389 390enum 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: 394 395.. tabularcolumns:: |p{9.1cm}|p{8.4cm}| 396 397.. flat-table:: 398 :header-rows: 0 399 :stub-columns: 0 400 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 409 410 411 412.. _v4l2-mpeg-audio-emphasis: 413 414``V4L2_CID_MPEG_AUDIO_EMPHASIS`` 415 (enum) 416 417enum v4l2_mpeg_audio_emphasis - 418 Audio Emphasis. Possible values are: 419 420 421 422.. flat-table:: 423 :header-rows: 0 424 :stub-columns: 0 425 426 * - ``V4L2_MPEG_AUDIO_EMPHASIS_NONE`` 427 - None 428 * - ``V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS`` 429 - 50/15 microsecond emphasis 430 * - ``V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17`` 431 - CCITT J.17 432 433 434 435.. _v4l2-mpeg-audio-crc: 436 437``V4L2_CID_MPEG_AUDIO_CRC`` 438 (enum) 439 440enum v4l2_mpeg_audio_crc - 441 CRC method. Possible values are: 442 443 444 445.. flat-table:: 446 :header-rows: 0 447 :stub-columns: 0 448 449 * - ``V4L2_MPEG_AUDIO_CRC_NONE`` 450 - None 451 * - ``V4L2_MPEG_AUDIO_CRC_CRC16`` 452 - 16 bit parity check 453 454 455 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 = 460 unmuted, 1 = muted. 461 462.. _v4l2-mpeg-audio-dec-playback: 463 464``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` 465 (enum) 466 467enum v4l2_mpeg_audio_dec_playback - 468 Determines how monolingual audio should be played back. Possible 469 values are: 470 471 472 473.. tabularcolumns:: |p{9.8cm}|p{7.7cm}| 474 475.. flat-table:: 476 :header-rows: 0 477 :stub-columns: 0 478 479 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO`` 480 - Automatically determines the best playback mode. 481 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO`` 482 - Stereo playback. 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`` 488 - Mono playback. 489 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO`` 490 - Stereo playback with swapped left and right channels. 491 492 493 494.. _v4l2-mpeg-audio-dec-multilingual-playback: 495 496``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` 497 (enum) 498 499enum v4l2_mpeg_audio_dec_playback - 500 Determines how multilingual audio should be played back. 501 502.. _v4l2-mpeg-video-encoding: 503 504``V4L2_CID_MPEG_VIDEO_ENCODING`` 505 (enum) 506 507enum v4l2_mpeg_video_encoding - 508 MPEG Video encoding method. This control is specific to multiplexed 509 MPEG streams. Possible values are: 510 511 512 513.. flat-table:: 514 :header-rows: 0 515 :stub-columns: 0 516 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 523 524 525 526.. _v4l2-mpeg-video-aspect: 527 528``V4L2_CID_MPEG_VIDEO_ASPECT`` 529 (enum) 530 531enum v4l2_mpeg_video_aspect - 532 Video aspect. Possible values are: 533 534 535 536.. flat-table:: 537 :header-rows: 0 538 :stub-columns: 0 539 540 * - ``V4L2_MPEG_VIDEO_ASPECT_1x1`` 541 * - ``V4L2_MPEG_VIDEO_ASPECT_4x3`` 542 * - ``V4L2_MPEG_VIDEO_ASPECT_16x9`` 543 * - ``V4L2_MPEG_VIDEO_ASPECT_221x100`` 544 545 546 547``V4L2_CID_MPEG_VIDEO_B_FRAMES (integer)`` 548 Number of B-Frames (default 2) 549 550``V4L2_CID_MPEG_VIDEO_GOP_SIZE (integer)`` 551 GOP size (default 12) 552 553``V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (boolean)`` 554 GOP closure (default 1) 555 556``V4L2_CID_MPEG_VIDEO_PULLDOWN (boolean)`` 557 Enable 3:2 pulldown (default 0) 558 559.. _v4l2-mpeg-video-bitrate-mode: 560 561``V4L2_CID_MPEG_VIDEO_BITRATE_MODE`` 562 (enum) 563 564enum v4l2_mpeg_video_bitrate_mode - 565 Video bitrate mode. Possible values are: 566 567 568 569.. flat-table:: 570 :header-rows: 0 571 :stub-columns: 0 572 573 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_VBR`` 574 - Variable bitrate 575 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_CBR`` 576 - Constant bitrate 577 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_CQ`` 578 - Constant quality 579 580 581 582``V4L2_CID_MPEG_VIDEO_BITRATE (integer)`` 583 Average video bitrate in bits per second. 584 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. 589 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. 597 598 599``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE (enum)`` 600 601enum 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 605 are: 606 607 608.. tabularcolumns:: |p{8.2cm}|p{9.3cm}| 609 610.. raw:: latex 611 612 \small 613 614.. flat-table:: 615 :header-rows: 0 616 :stub-columns: 0 617 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. 627 628.. raw:: latex 629 630 \normalsize 631 632``V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (integer)`` 633 For every captured frame, skip this many subsequent frames (default 634 0). 635 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 = 639 muted. 640 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): 644 645 646 647.. flat-table:: 648 :header-rows: 0 649 :stub-columns: 0 650 651 * - Bit 0:7 652 - V chrominance information 653 * - Bit 8:15 654 - U chrominance information 655 * - Bit 16:23 656 - Y luminance information 657 * - Bit 24:31 658 - Must be zero. 659 660 661 662.. _v4l2-mpeg-video-dec-pts: 663 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`. 669 670.. _v4l2-mpeg-video-dec-frame: 671 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. 676 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. 684 685.. flat-table:: 686 :header-rows: 0 687 :stub-columns: 0 688 689 * - 690 - 8bit format 691 - 10bit format 692 - 12bit format 693 * - Y luminance 694 - Bit 0:7 695 - Bit 0:9 696 - Bit 0:11 697 * - Cb chrominance 698 - Bit 16:23 699 - Bit 16:25 700 - Bit 16:27 701 * - Cr chrominance 702 - Bit 32:39 703 - Bit 32:41 704 - Bit 32:43 705 * - Must be zero 706 - Bit 48:63 707 - Bit 48:63 708 - Bit 48:63 709 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. 714 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. 722 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. 729 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. 734 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. 738 739.. _v4l2-mpeg-video-h264-vui-sar-idc: 740 741``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC`` 742 (enum) 743 744enum 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 747 encoder. 748 749 750 751.. flat-table:: 752 :header-rows: 0 753 :stub-columns: 0 754 755 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED`` 756 - Unspecified 757 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1`` 758 - 1x1 759 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11`` 760 - 12x11 761 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11`` 762 - 10x11 763 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11`` 764 - 16x11 765 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33`` 766 - 40x33 767 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11`` 768 - 24x11 769 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11`` 770 - 20x11 771 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11`` 772 - 32x11 773 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33`` 774 - 80x33 775 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11`` 776 - 18x11 777 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11`` 778 - 15x11 779 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33`` 780 - 64x33 781 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99`` 782 - 160x99 783 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3`` 784 - 4x3 785 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2`` 786 - 3x2 787 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1`` 788 - 2x1 789 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED`` 790 - Extended SAR 791 792 793 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. 797 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. 801 802.. _v4l2-mpeg-video-h264-level: 803 804``V4L2_CID_MPEG_VIDEO_H264_LEVEL`` 805 (enum) 806 807enum v4l2_mpeg_video_h264_level - 808 The level information for the H264 video elementary stream. 809 Applicable to the H264 encoder. Possible values are: 810 811 812 813.. flat-table:: 814 :header-rows: 0 815 :stub-columns: 0 816 817 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_0`` 818 - Level 1.0 819 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1B`` 820 - Level 1B 821 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_1`` 822 - Level 1.1 823 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_2`` 824 - Level 1.2 825 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_3`` 826 - Level 1.3 827 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_0`` 828 - Level 2.0 829 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_1`` 830 - Level 2.1 831 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_2`` 832 - Level 2.2 833 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_0`` 834 - Level 3.0 835 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_1`` 836 - Level 3.1 837 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_2`` 838 - Level 3.2 839 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_0`` 840 - Level 4.0 841 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_1`` 842 - Level 4.1 843 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_2`` 844 - Level 4.2 845 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_0`` 846 - Level 5.0 847 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_1`` 848 - Level 5.1 849 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_2`` 850 - Level 5.2 851 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_0`` 852 - Level 6.0 853 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_1`` 854 - Level 6.1 855 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_2`` 856 - Level 6.2 857 858 859 860.. _v4l2-mpeg-video-mpeg2-level: 861 862``V4L2_CID_MPEG_VIDEO_MPEG2_LEVEL`` 863 (enum) 864 865enum v4l2_mpeg_video_mpeg2_level - 866 The level information for the MPEG2 elementary stream. Applicable to 867 MPEG2 codecs. Possible values are: 868 869 870 871.. flat-table:: 872 :header-rows: 0 873 :stub-columns: 0 874 875 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_LOW`` 876 - Low Level (LL) 877 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_MAIN`` 878 - Main Level (ML) 879 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH_1440`` 880 - High-1440 Level (H-14) 881 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH`` 882 - High Level (HL) 883 884 885 886.. _v4l2-mpeg-video-mpeg4-level: 887 888``V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL`` 889 (enum) 890 891enum v4l2_mpeg_video_mpeg4_level - 892 The level information for the MPEG4 elementary stream. Applicable to 893 the MPEG4 encoder. Possible values are: 894 895 896 897.. flat-table:: 898 :header-rows: 0 899 :stub-columns: 0 900 901 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0`` 902 - Level 0 903 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0B`` 904 - Level 0b 905 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_1`` 906 - Level 1 907 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_2`` 908 - Level 2 909 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3`` 910 - Level 3 911 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3B`` 912 - Level 3b 913 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_4`` 914 - Level 4 915 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_5`` 916 - Level 5 917 918 919 920.. _v4l2-mpeg-video-h264-profile: 921 922``V4L2_CID_MPEG_VIDEO_H264_PROFILE`` 923 (enum) 924 925enum v4l2_mpeg_video_h264_profile - 926 The profile information for H264. Applicable to the H264 encoder. 927 Possible values are: 928 929.. raw:: latex 930 931 \small 932 933.. tabularcolumns:: |p{10.2cm}|p{7.3cm}| 934 935.. flat-table:: 936 :header-rows: 0 937 :stub-columns: 0 938 939 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE`` 940 - Baseline profile 941 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE`` 942 - Constrained Baseline profile 943 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MAIN`` 944 - Main profile 945 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED`` 946 - Extended profile 947 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH`` 948 - High profile 949 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10`` 950 - High 10 profile 951 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422`` 952 - High 422 profile 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 975 976.. raw:: latex 977 978 \normalsize 979 980.. _v4l2-mpeg-video-mpeg2-profile: 981 982``V4L2_CID_MPEG_VIDEO_MPEG2_PROFILE`` 983 (enum) 984 985enum v4l2_mpeg_video_mpeg2_profile - 986 The profile information for MPEG2. Applicable to MPEG2 codecs. 987 Possible values are: 988 989.. raw:: latex 990 991 \small 992 993.. tabularcolumns:: |p{10.2cm}|p{7.3cm}| 994 995.. flat-table:: 996 :header-rows: 0 997 :stub-columns: 0 998 999 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SIMPLE`` 1000 - Simple profile (SP) 1001 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MAIN`` 1002 - Main profile (MP) 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`` 1008 - High profile (HP) 1009 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MULTIVIEW`` 1010 - Multi-view profile (MVP) 1011 1012 1013.. raw:: latex 1014 1015 \normalsize 1016 1017.. _v4l2-mpeg-video-mpeg4-profile: 1018 1019``V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE`` 1020 (enum) 1021 1022enum v4l2_mpeg_video_mpeg4_profile - 1023 The profile information for MPEG4. Applicable to the MPEG4 encoder. 1024 Possible values are: 1025 1026.. raw:: latex 1027 1028 \small 1029 1030.. tabularcolumns:: |p{11.8cm}|p{5.7cm}| 1031 1032.. flat-table:: 1033 :header-rows: 0 1034 :stub-columns: 0 1035 1036 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE`` 1037 - Simple profile 1038 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_SIMPLE`` 1039 - Advanced Simple profile 1040 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_CORE`` 1041 - Core profile 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 1046 1047.. raw:: latex 1048 1049 \normalsize 1050 1051``V4L2_CID_MPEG_VIDEO_MAX_REF_PIC (integer)`` 1052 The maximum number of reference pictures used for encoding. 1053 Applicable to the encoder. 1054 1055.. _v4l2-mpeg-video-multi-slice-mode: 1056 1057``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` 1058 (enum) 1059 1060enum 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: 1063 1064 1065 1066.. tabularcolumns:: |p{9.6cm}|p{7.9cm}| 1067 1068.. flat-table:: 1069 :header-rows: 0 1070 :stub-columns: 0 1071 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. 1078 1079 1080 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 1085 encoder. 1086 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 1091 encoder. 1092 1093.. _v4l2-mpeg-video-h264-loop-filter-mode: 1094 1095``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE`` 1096 (enum) 1097 1098enum v4l2_mpeg_video_h264_loop_filter_mode - 1099 Loop filter mode for H264 encoder. Possible values are: 1100 1101.. raw:: latex 1102 1103 \small 1104 1105.. tabularcolumns:: |p{13.5cm}|p{4.0cm}| 1106 1107.. flat-table:: 1108 :header-rows: 0 1109 :stub-columns: 0 1110 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. 1117 1118.. raw:: latex 1119 1120 \normalsize 1121 1122 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. 1129 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. 1136 1137.. _v4l2-mpeg-video-h264-entropy-mode: 1138 1139``V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE`` 1140 (enum) 1141 1142enum v4l2_mpeg_video_h264_entropy_mode - 1143 Entropy coding mode for H264 - CABAC/CAVALC. Applicable to the H264 1144 encoder. Possible values are: 1145 1146 1147.. tabularcolumns:: |p{9.0cm}|p{8.5cm}| 1148 1149 1150.. flat-table:: 1151 :header-rows: 0 1152 :stub-columns: 0 1153 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. 1158 1159 1160 1161``V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM (boolean)`` 1162 Enable 8X8 transform for H264. Applicable to the H264 encoder. 1163 1164``V4L2_CID_MPEG_VIDEO_H264_CONSTRAINED_INTRA_PREDICTION (boolean)`` 1165 Enable constrained intra prediction for H264. Applicable to the H264 1166 encoder. 1167 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. 1172 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. 1178 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. 1188 1189``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE (boolean)`` 1190 Macroblock level rate control enable. Applicable to the MPEG4 and 1191 H264 encoders. 1192 1193``V4L2_CID_MPEG_VIDEO_MPEG4_QPEL (boolean)`` 1194 Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 1195 encoder. 1196 1197``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP (integer)`` 1198 Quantization parameter for an I frame for H263. Valid range: from 1 1199 to 31. 1200 1201``V4L2_CID_MPEG_VIDEO_H263_MIN_QP (integer)`` 1202 Minimum quantization parameter for H263. Valid range: from 1 to 31. 1203 1204``V4L2_CID_MPEG_VIDEO_H263_MAX_QP (integer)`` 1205 Maximum quantization parameter for H263. Valid range: from 1 to 31. 1206 1207``V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP (integer)`` 1208 Quantization parameter for an P frame for H263. Valid range: from 1 1209 to 31. 1210 1211``V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP (integer)`` 1212 Quantization parameter for an B frame for H263. Valid range: from 1 1213 to 31. 1214 1215``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP (integer)`` 1216 Quantization parameter for an I frame for H264. Valid range: from 0 1217 to 51. 1218 1219``V4L2_CID_MPEG_VIDEO_H264_MIN_QP (integer)`` 1220 Minimum quantization parameter for H264. Valid range: from 0 to 51. 1221 1222``V4L2_CID_MPEG_VIDEO_H264_MAX_QP (integer)`` 1223 Maximum quantization parameter for H264. Valid range: from 0 to 51. 1224 1225``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP (integer)`` 1226 Quantization parameter for an P frame for H264. Valid range: from 0 1227 to 51. 1228 1229``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP (integer)`` 1230 Quantization parameter for an B frame for H264. Valid range: from 0 1231 to 51. 1232 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. 1238 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. 1244 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. 1250 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. 1256 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. 1262 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. 1268 1269``V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP (integer)`` 1270 Quantization parameter for an I frame for MPEG4. Valid range: from 1 1271 to 31. 1272 1273``V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP (integer)`` 1274 Minimum quantization parameter for MPEG4. Valid range: from 1 to 31. 1275 1276``V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP (integer)`` 1277 Maximum quantization parameter for MPEG4. Valid range: from 1 to 31. 1278 1279``V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP (integer)`` 1280 Quantization parameter for an P frame for MPEG4. Valid range: from 1 1281 to 31. 1282 1283``V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP (integer)`` 1284 Quantization parameter for an B frame for MPEG4. Valid range: from 1 1285 to 31. 1286 1287.. _v4l2-mpeg-video-vbv-size: 1288 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. 1298 1299.. _v4l2-mpeg-video-vbv-delay: 1300 1301``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)`` 1302 Sets the initial delay in milliseconds for VBV buffer control. 1303 1304.. _v4l2-mpeg-video-hor-search-range: 1305 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. 1311 1312.. _v4l2-mpeg-video-vert-search-range: 1313 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. 1319 1320.. _v4l2-mpeg-video-force-key-frame: 1321 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. 1325 1326.. _v4l2-mpeg-video-h264-cpb-size: 1327 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. 1333 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 1342 H264 encoder. 1343 1344.. _v4l2-mpeg-video-header-mode: 1345 1346``V4L2_CID_MPEG_VIDEO_HEADER_MODE`` 1347 (enum) 1348 1349enum 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: 1353 1354.. raw:: latex 1355 1356 \small 1357 1358.. tabularcolumns:: |p{10.3cm}|p{7.2cm}| 1359 1360.. flat-table:: 1361 :header-rows: 0 1362 :stub-columns: 0 1363 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 1368 frame. 1369 1370.. raw:: latex 1371 1372 \normalsize 1373 1374 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 1378 and 4 encoder. 1379 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. 1383 1384``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES (integer)`` 1385 vop_time_increment_resolution value for MPEG4. Applicable to the 1386 MPEG4 encoder. 1387 1388``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC (integer)`` 1389 vop_time_increment value for MPEG4. Applicable to the MPEG4 1390 encoder. 1391 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. 1397 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 1400 H264 encoder. 1401 1402.. _v4l2-mpeg-video-h264-sei-fp-arrangement-type: 1403 1404``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE`` 1405 (enum) 1406 1407enum 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: 1410 1411.. raw:: latex 1412 1413 \small 1414 1415.. tabularcolumns:: |p{12cm}|p{5.5cm}| 1416 1417.. flat-table:: 1418 :header-rows: 0 1419 :stub-columns: 0 1420 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. 1433 1434.. raw:: latex 1435 1436 \normalsize 1437 1438 1439 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. 1444 1445.. _v4l2-mpeg-video-h264-fmo-map-type: 1446 1447``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE`` 1448 (enum) 1449 1450enum 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 1453 values are: 1454 1455.. raw:: latex 1456 1457 \small 1458 1459.. tabularcolumns:: |p{12.5cm}|p{5.0cm}| 1460 1461.. flat-table:: 1462 :header-rows: 0 1463 :stub-columns: 0 1464 1465 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES`` 1466 - Slices are interleaved one after other with macroblocks in run 1467 length order. 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. 1481 1482.. raw:: latex 1483 1484 \normalsize 1485 1486 1487 1488``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)`` 1489 Number of slice groups in FMO. Applicable to the H264 encoder. 1490 1491.. _v4l2-mpeg-video-h264-fmo-change-direction: 1492 1493``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION`` 1494 (enum) 1495 1496enum 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: 1499 1500.. tabularcolumns:: |p{9.6cm}|p{7.9cm}| 1501 1502.. flat-table:: 1503 :header-rows: 0 1504 :stub-columns: 0 1505 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. 1510 1511 1512 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. 1516 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. 1520 1521``V4L2_CID_MPEG_VIDEO_H264_ASO (boolean)`` 1522 Enables arbitrary slice ordering in encoded bitstream. Applicable to 1523 the H264 encoder. 1524 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 1528 significant bit): 1529 1530 1531 1532.. flat-table:: 1533 :header-rows: 0 1534 :stub-columns: 0 1535 1536 * - Bit 0:15 1537 - Slice ID 1538 * - Bit 16:32 1539 - Slice position or order 1540 1541 1542 1543``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)`` 1544 Enables H264 hierarchical coding. Applicable to the H264 encoder. 1545 1546.. _v4l2-mpeg-video-h264-hierarchical-coding-type: 1547 1548``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE`` 1549 (enum) 1550 1551enum v4l2_mpeg_video_h264_hierarchical_coding_type - 1552 Specifies the hierarchical coding type. Applicable to the H264 1553 encoder. Possible values are: 1554 1555 1556 1557.. flat-table:: 1558 :header-rows: 0 1559 :stub-columns: 0 1560 1561 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B`` 1562 - Hierarchical B coding. 1563 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P`` 1564 - Hierarchical P coding. 1565 1566 1567 1568``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER (integer)`` 1569 Specifies the number of hierarchical coding layers. Applicable to 1570 the H264 encoder. 1571 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): 1576 1577 1578 1579.. flat-table:: 1580 :header-rows: 0 1581 :stub-columns: 0 1582 1583 * - Bit 0:15 1584 - QP value 1585 * - Bit 16:32 1586 - Layer number 1587 1588``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L0_BR (integer)`` 1589 Indicates bit rate (bps) for hierarchical coding layer 0 for H264 encoder. 1590 1591``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L1_BR (integer)`` 1592 Indicates bit rate (bps) for hierarchical coding layer 1 for H264 encoder. 1593 1594``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L2_BR (integer)`` 1595 Indicates bit rate (bps) for hierarchical coding layer 2 for H264 encoder. 1596 1597``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L3_BR (integer)`` 1598 Indicates bit rate (bps) for hierarchical coding layer 3 for H264 encoder. 1599 1600``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L4_BR (integer)`` 1601 Indicates bit rate (bps) for hierarchical coding layer 4 for H264 encoder. 1602 1603``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L5_BR (integer)`` 1604 Indicates bit rate (bps) for hierarchical coding layer 5 for H264 encoder. 1605 1606``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L6_BR (integer)`` 1607 Indicates bit rate (bps) for hierarchical coding layer 6 for H264 encoder. 1608 1609.. _v4l2-mpeg-mpeg2: 1610 1611``V4L2_CID_MPEG_VIDEO_MPEG2_SLICE_PARAMS (struct)`` 1612 Specifies the slice parameters (as extracted from the bitstream) for the 1613 associated MPEG-2 slice data. This includes the necessary parameters for 1614 configuring a stateless hardware decoding pipeline for MPEG-2. 1615 The bitstream parameters are defined according to :ref:`mpeg2part2`. 1616 1617 .. note:: 1618 1619 This compound control is not yet part of the public kernel API and 1620 it is expected to change. 1621 1622.. c:type:: v4l2_ctrl_mpeg2_slice_params 1623 1624.. tabularcolumns:: |p{5.6cm}|p{4.6cm}|p{7.1cm}| 1625 1626.. cssclass:: longtable 1627 1628.. flat-table:: struct v4l2_ctrl_mpeg2_slice_params 1629 :header-rows: 0 1630 :stub-columns: 0 1631 :widths: 1 1 2 1632 1633 * - __u32 1634 - ``bit_size`` 1635 - Size (in bits) of the current slice data. 1636 * - __u32 1637 - ``data_bit_offset`` 1638 - Offset (in bits) to the video data in the current slice data. 1639 * - struct :c:type:`v4l2_mpeg2_sequence` 1640 - ``sequence`` 1641 - Structure with MPEG-2 sequence metadata, merging relevant fields from 1642 the sequence header and sequence extension parts of the bitstream. 1643 * - struct :c:type:`v4l2_mpeg2_picture` 1644 - ``picture`` 1645 - Structure with MPEG-2 picture metadata, merging relevant fields from 1646 the picture header and picture coding extension parts of the bitstream. 1647 * - __u64 1648 - ``backward_ref_ts`` 1649 - Timestamp of the V4L2 capture buffer to use as backward reference, used 1650 with B-coded and P-coded frames. The timestamp refers to the 1651 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 1652 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 1653 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 1654 * - __u64 1655 - ``forward_ref_ts`` 1656 - Timestamp for the V4L2 capture buffer to use as forward reference, used 1657 with B-coded frames. The timestamp refers to the ``timestamp`` field in 1658 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 1659 function to convert the struct :c:type:`timeval` in struct 1660 :c:type:`v4l2_buffer` to a __u64. 1661 * - __u32 1662 - ``quantiser_scale_code`` 1663 - Code used to determine the quantization scale to use for the IDCT. 1664 1665.. c:type:: v4l2_mpeg2_sequence 1666 1667.. cssclass:: longtable 1668 1669.. tabularcolumns:: |p{1.4cm}|p{6.5cm}|p{9.4cm}| 1670 1671.. flat-table:: struct v4l2_mpeg2_sequence 1672 :header-rows: 0 1673 :stub-columns: 0 1674 :widths: 1 1 2 1675 1676 * - __u16 1677 - ``horizontal_size`` 1678 - The width of the displayable part of the frame's luminance component. 1679 * - __u16 1680 - ``vertical_size`` 1681 - The height of the displayable part of the frame's luminance component. 1682 * - __u32 1683 - ``vbv_buffer_size`` 1684 - Used to calculate the required size of the video buffering verifier, 1685 defined (in bits) as: 16 * 1024 * vbv_buffer_size. 1686 * - __u16 1687 - ``profile_and_level_indication`` 1688 - The current profile and level indication as extracted from the 1689 bitstream. 1690 * - __u8 1691 - ``progressive_sequence`` 1692 - Indication that all the frames for the sequence are progressive instead 1693 of interlaced. 1694 * - __u8 1695 - ``chroma_format`` 1696 - The chrominance sub-sampling format (1: 4:2:0, 2: 4:2:2, 3: 4:4:4). 1697 1698.. c:type:: v4l2_mpeg2_picture 1699 1700.. raw:: latex 1701 1702 \small 1703 1704.. cssclass:: longtable 1705 1706.. tabularcolumns:: |p{1.0cm}|p{5.6cm}|p{10.7cm}| 1707 1708.. flat-table:: struct v4l2_mpeg2_picture 1709 :header-rows: 0 1710 :stub-columns: 0 1711 :widths: 1 1 2 1712 1713 * - __u8 1714 - ``picture_coding_type`` 1715 - Picture coding type for the frame covered by the current slice 1716 (V4L2_MPEG2_PICTURE_CODING_TYPE_I, V4L2_MPEG2_PICTURE_CODING_TYPE_P or 1717 V4L2_MPEG2_PICTURE_CODING_TYPE_B). 1718 * - __u8 1719 - ``f_code[2][2]`` 1720 - Motion vector codes. 1721 * - __u8 1722 - ``intra_dc_precision`` 1723 - Precision of Discrete Cosine transform (0: 8 bits precision, 1724 1: 9 bits precision, 2: 10 bits precision, 3: 11 bits precision). 1725 * - __u8 1726 - ``picture_structure`` 1727 - Picture structure (1: interlaced top field, 2: interlaced bottom field, 1728 3: progressive frame). 1729 * - __u8 1730 - ``top_field_first`` 1731 - If set to 1 and interlaced stream, top field is output first. 1732 * - __u8 1733 - ``frame_pred_frame_dct`` 1734 - If set to 1, only frame-DCT and frame prediction are used. 1735 * - __u8 1736 - ``concealment_motion_vectors`` 1737 - If set to 1, motion vectors are coded for intra macroblocks. 1738 * - __u8 1739 - ``q_scale_type`` 1740 - This flag affects the inverse quantization process. 1741 * - __u8 1742 - ``intra_vlc_format`` 1743 - This flag affects the decoding of transform coefficient data. 1744 * - __u8 1745 - ``alternate_scan`` 1746 - This flag affects the decoding of transform coefficient data. 1747 * - __u8 1748 - ``repeat_first_field`` 1749 - This flag affects the decoding process of progressive frames. 1750 * - __u16 1751 - ``progressive_frame`` 1752 - Indicates whether the current frame is progressive. 1753 1754.. raw:: latex 1755 1756 \normalsize 1757 1758``V4L2_CID_MPEG_VIDEO_MPEG2_QUANTIZATION (struct)`` 1759 Specifies quantization matrices (as extracted from the bitstream) for the 1760 associated MPEG-2 slice data. 1761 1762 .. note:: 1763 1764 This compound control is not yet part of the public kernel API and 1765 it is expected to change. 1766 1767.. c:type:: v4l2_ctrl_mpeg2_quantization 1768 1769.. tabularcolumns:: |p{0.8cm}|p{8.0cm}|p{8.5cm}| 1770 1771.. cssclass:: longtable 1772 1773.. raw:: latex 1774 1775 \small 1776 1777.. flat-table:: struct v4l2_ctrl_mpeg2_quantization 1778 :header-rows: 0 1779 :stub-columns: 0 1780 :widths: 1 1 2 1781 1782 * - __u8 1783 - ``load_intra_quantiser_matrix`` 1784 - One bit to indicate whether to load the ``intra_quantiser_matrix`` data. 1785 * - __u8 1786 - ``load_non_intra_quantiser_matrix`` 1787 - One bit to indicate whether to load the ``non_intra_quantiser_matrix`` 1788 data. 1789 * - __u8 1790 - ``load_chroma_intra_quantiser_matrix`` 1791 - One bit to indicate whether to load the 1792 ``chroma_intra_quantiser_matrix`` data, only relevant for non-4:2:0 YUV 1793 formats. 1794 * - __u8 1795 - ``load_chroma_non_intra_quantiser_matrix`` 1796 - One bit to indicate whether to load the 1797 ``chroma_non_intra_quantiser_matrix`` data, only relevant for non-4:2:0 1798 YUV formats. 1799 * - __u8 1800 - ``intra_quantiser_matrix[64]`` 1801 - The quantization matrix coefficients for intra-coded frames, in zigzag 1802 scanning order. It is relevant for both luma and chroma components, 1803 although it can be superseded by the chroma-specific matrix for 1804 non-4:2:0 YUV formats. 1805 * - __u8 1806 - ``non_intra_quantiser_matrix[64]`` 1807 - The quantization matrix coefficients for non-intra-coded frames, in 1808 zigzag scanning order. It is relevant for both luma and chroma 1809 components, although it can be superseded by the chroma-specific matrix 1810 for non-4:2:0 YUV formats. 1811 * - __u8 1812 - ``chroma_intra_quantiser_matrix[64]`` 1813 - The quantization matrix coefficients for the chominance component of 1814 intra-coded frames, in zigzag scanning order. Only relevant for 1815 non-4:2:0 YUV formats. 1816 * - __u8 1817 - ``chroma_non_intra_quantiser_matrix[64]`` 1818 - The quantization matrix coefficients for the chrominance component of 1819 non-intra-coded frames, in zigzag scanning order. Only relevant for 1820 non-4:2:0 YUV formats. 1821 1822.. raw:: latex 1823 1824 \normalsize 1825 1826``V4L2_CID_FWHT_I_FRAME_QP (integer)`` 1827 Quantization parameter for an I frame for FWHT. Valid range: from 1 1828 to 31. 1829 1830``V4L2_CID_FWHT_P_FRAME_QP (integer)`` 1831 Quantization parameter for a P frame for FWHT. Valid range: from 1 1832 to 31. 1833 1834.. raw:: latex 1835 1836 \normalsize 1837 1838 1839MFC 5.1 MPEG Controls 1840===================== 1841 1842The following MPEG class controls deal with MPEG decoding and encoding 1843settings that are specific to the Multi Format Codec 5.1 device present 1844in the S5P family of SoCs by Samsung. 1845 1846 1847.. _mfc51-control-id: 1848 1849MFC 5.1 Control IDs 1850------------------- 1851 1852``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE (boolean)`` 1853 If the display delay is enabled then the decoder is forced to return 1854 a CAPTURE buffer (decoded frame) after processing a certain number 1855 of OUTPUT buffers. The delay can be set through 1856 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY``. This 1857 feature can be used for example for generating thumbnails of videos. 1858 Applicable to the H264 decoder. 1859 1860 .. note:: 1861 1862 This control is deprecated. Use the standard 1863 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY_ENABLE`` control instead. 1864 1865``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY (integer)`` 1866 Display delay value for H264 decoder. The decoder is forced to 1867 return a decoded frame after the set 'display delay' number of 1868 frames. If this number is low it may result in frames returned out 1869 of display order, in addition the hardware may still be using the 1870 returned buffer as a reference picture for subsequent frames. 1871 1872 .. note:: 1873 1874 This control is deprecated. Use the standard 1875 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY`` control instead. 1876 1877``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)`` 1878 The number of reference pictures used for encoding a P picture. 1879 Applicable to the H264 encoder. 1880 1881``V4L2_CID_MPEG_MFC51_VIDEO_PADDING (boolean)`` 1882 Padding enable in the encoder - use a color instead of repeating 1883 border pixels. Applicable to encoders. 1884 1885``V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV (integer)`` 1886 Padding color in the encoder. Applicable to encoders. The supplied 1887 32-bit integer is interpreted as follows (bit 0 = least significant 1888 bit): 1889 1890 1891 1892.. flat-table:: 1893 :header-rows: 0 1894 :stub-columns: 0 1895 1896 * - Bit 0:7 1897 - V chrominance information 1898 * - Bit 8:15 1899 - U chrominance information 1900 * - Bit 16:23 1901 - Y luminance information 1902 * - Bit 24:31 1903 - Must be zero. 1904 1905 1906 1907``V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF (integer)`` 1908 Reaction coefficient for MFC rate control. Applicable to encoders. 1909 1910 .. note:: 1911 1912 #. Valid only when the frame level RC is enabled. 1913 1914 #. For tight CBR, this field must be small (ex. 2 ~ 10). For 1915 VBR, this field must be large (ex. 100 ~ 1000). 1916 1917 #. It is not recommended to use the greater number than 1918 FRAME_RATE * (10^9 / BIT_RATE). 1919 1920``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK (boolean)`` 1921 Adaptive rate control for dark region. Valid only when H.264 and 1922 macroblock level RC is enabled 1923 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1924 encoder. 1925 1926``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH (boolean)`` 1927 Adaptive rate control for smooth region. Valid only when H.264 and 1928 macroblock level RC is enabled 1929 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1930 encoder. 1931 1932``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC (boolean)`` 1933 Adaptive rate control for static region. Valid only when H.264 and 1934 macroblock level RC is enabled 1935 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1936 encoder. 1937 1938``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY (boolean)`` 1939 Adaptive rate control for activity region. Valid only when H.264 and 1940 macroblock level RC is enabled 1941 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1942 encoder. 1943 1944.. _v4l2-mpeg-mfc51-video-frame-skip-mode: 1945 1946``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE`` 1947 (enum) 1948 1949 .. note:: 1950 1951 This control is deprecated. Use the standard 1952 ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE`` control instead. 1953 1954enum v4l2_mpeg_mfc51_video_frame_skip_mode - 1955 Indicates in what conditions the encoder should skip frames. If 1956 encoding a frame would cause the encoded stream to be larger then a 1957 chosen data limit then the frame will be skipped. Possible values 1958 are: 1959 1960 1961.. tabularcolumns:: |p{9.4cm}|p{8.1cm}| 1962 1963.. raw:: latex 1964 1965 \small 1966 1967.. flat-table:: 1968 :header-rows: 0 1969 :stub-columns: 0 1970 1971 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_DISABLED`` 1972 - Frame skip mode is disabled. 1973 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_LEVEL_LIMIT`` 1974 - Frame skip mode enabled and buffer limit is set by the chosen 1975 level and is defined by the standard. 1976 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_BUF_LIMIT`` 1977 - Frame skip mode enabled and buffer limit is set by the VBV 1978 (MPEG1/2/4) or CPB (H264) buffer size control. 1979 1980.. raw:: latex 1981 1982 \normalsize 1983 1984``V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT (integer)`` 1985 Enable rate-control with fixed target bit. If this setting is 1986 enabled, then the rate control logic of the encoder will calculate 1987 the average bitrate for a GOP and keep it below or equal the set 1988 bitrate target. Otherwise the rate control logic calculates the 1989 overall average bitrate for the stream and keeps it below or equal 1990 to the set bitrate. In the first case the average bitrate for the 1991 whole stream will be smaller then the set bitrate. This is caused 1992 because the average is calculated for smaller number of frames, on 1993 the other hand enabling this setting will ensure that the stream 1994 will meet tight bandwidth constraints. Applicable to encoders. 1995 1996.. _v4l2-mpeg-mfc51-video-force-frame-type: 1997 1998``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE`` 1999 (enum) 2000 2001enum v4l2_mpeg_mfc51_video_force_frame_type - 2002 Force a frame type for the next queued buffer. Applicable to 2003 encoders. Possible values are: 2004 2005.. tabularcolumns:: |p{9.9cm}|p{7.6cm}| 2006 2007.. flat-table:: 2008 :header-rows: 0 2009 :stub-columns: 0 2010 2011 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED`` 2012 - Forcing a specific frame type disabled. 2013 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME`` 2014 - Force an I-frame. 2015 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED`` 2016 - Force a non-coded frame. 2017 2018 2019CX2341x MPEG Controls 2020===================== 2021 2022The following MPEG class controls deal with MPEG encoding settings that 2023are specific to the Conexant CX23415 and CX23416 MPEG encoding chips. 2024 2025 2026.. _cx2341x-control-id: 2027 2028CX2341x Control IDs 2029------------------- 2030 2031.. _v4l2-mpeg-cx2341x-video-spatial-filter-mode: 2032 2033``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE`` 2034 (enum) 2035 2036enum v4l2_mpeg_cx2341x_video_spatial_filter_mode - 2037 Sets the Spatial Filter mode (default ``MANUAL``). Possible values 2038 are: 2039 2040 2041.. tabularcolumns:: |p{11.5cm}|p{6.0cm}| 2042 2043.. flat-table:: 2044 :header-rows: 0 2045 :stub-columns: 0 2046 2047 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL`` 2048 - Choose the filter manually 2049 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO`` 2050 - Choose the filter automatically 2051 2052 2053 2054``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (integer (0-15))`` 2055 The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default 2056 is 0.) 2057 2058.. _luma-spatial-filter-type: 2059 2060``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE`` 2061 (enum) 2062 2063enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type - 2064 Select the algorithm to use for the Luma Spatial Filter (default 2065 ``1D_HOR``). Possible values: 2066 2067.. tabularcolumns:: |p{13.1cm}|p{4.4cm}| 2068 2069.. raw:: latex 2070 2071 \footnotesize 2072 2073.. flat-table:: 2074 :header-rows: 0 2075 :stub-columns: 0 2076 2077 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF`` 2078 - No filter 2079 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR`` 2080 - One-dimensional horizontal 2081 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT`` 2082 - One-dimensional vertical 2083 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE`` 2084 - Two-dimensional separable 2085 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE`` 2086 - Two-dimensional symmetrical non-separable 2087 2088.. raw:: latex 2089 2090 \normalsize 2091 2092.. _chroma-spatial-filter-type: 2093 2094``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE`` 2095 (enum) 2096 2097enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type - 2098 Select the algorithm for the Chroma Spatial Filter (default 2099 ``1D_HOR``). Possible values are: 2100 2101.. raw:: latex 2102 2103 \footnotesize 2104 2105.. tabularcolumns:: |p{11.0cm}|p{6.5cm}| 2106 2107.. flat-table:: 2108 :header-rows: 0 2109 :stub-columns: 0 2110 2111 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF`` 2112 - No filter 2113 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR`` 2114 - One-dimensional horizontal 2115 2116.. raw:: latex 2117 2118 \normalsize 2119 2120.. _v4l2-mpeg-cx2341x-video-temporal-filter-mode: 2121 2122``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE`` 2123 (enum) 2124 2125enum v4l2_mpeg_cx2341x_video_temporal_filter_mode - 2126 Sets the Temporal Filter mode (default ``MANUAL``). Possible values 2127 are: 2128 2129.. raw:: latex 2130 2131 \footnotesize 2132 2133.. flat-table:: 2134 :header-rows: 0 2135 :stub-columns: 0 2136 2137 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL`` 2138 - Choose the filter manually 2139 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO`` 2140 - Choose the filter automatically 2141 2142.. raw:: latex 2143 2144 \normalsize 2145 2146``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (integer (0-31))`` 2147 The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default 2148 is 8 for full-scale capturing and 0 for scaled capturing.) 2149 2150.. _v4l2-mpeg-cx2341x-video-median-filter-type: 2151 2152``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE`` 2153 (enum) 2154 2155enum v4l2_mpeg_cx2341x_video_median_filter_type - 2156 Median Filter Type (default ``OFF``). Possible values are: 2157 2158 2159.. raw:: latex 2160 2161 \small 2162 2163.. tabularcolumns:: |p{11.0cm}|p{6.5cm}| 2164 2165.. flat-table:: 2166 :header-rows: 0 2167 :stub-columns: 0 2168 2169 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF`` 2170 - No filter 2171 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR`` 2172 - Horizontal filter 2173 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT`` 2174 - Vertical filter 2175 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT`` 2176 - Horizontal and vertical filter 2177 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG`` 2178 - Diagonal filter 2179 2180.. raw:: latex 2181 2182 \normalsize 2183 2184``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 2185 Threshold above which the luminance median filter is enabled 2186 (default 0) 2187 2188``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (integer (0-255))`` 2189 Threshold below which the luminance median filter is enabled 2190 (default 255) 2191 2192``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 2193 Threshold above which the chroma median filter is enabled (default 2194 0) 2195 2196``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (integer (0-255))`` 2197 Threshold below which the chroma median filter is enabled (default 2198 255) 2199 2200``V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (boolean)`` 2201 The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into 2202 the stream between every four video frames. The packet size is 2048 2203 bytes, including the packet_start_code_prefix and stream_id 2204 fields. The stream_id is 0xBF (private stream 2). The payload 2205 consists of 0x00 bytes, to be filled in by the application. 0 = do 2206 not insert, 1 = insert packets. 2207 2208 2209VPX Control Reference 2210===================== 2211 2212The VPX controls include controls for encoding parameters of VPx video 2213codec. 2214 2215 2216.. _vpx-control-id: 2217 2218VPX Control IDs 2219--------------- 2220 2221.. _v4l2-vpx-num-partitions: 2222 2223``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS`` 2224 (enum) 2225 2226enum v4l2_vp8_num_partitions - 2227 The number of token partitions to use in VP8 encoder. Possible 2228 values are: 2229 2230 2231 2232.. flat-table:: 2233 :header-rows: 0 2234 :stub-columns: 0 2235 2236 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION`` 2237 - 1 coefficient partition 2238 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS`` 2239 - 2 coefficient partitions 2240 * - ``V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS`` 2241 - 4 coefficient partitions 2242 * - ``V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS`` 2243 - 8 coefficient partitions 2244 2245 2246 2247``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)`` 2248 Setting this prevents intra 4x4 mode in the intra mode decision. 2249 2250.. _v4l2-vpx-num-ref-frames: 2251 2252``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES`` 2253 (enum) 2254 2255enum v4l2_vp8_num_ref_frames - 2256 The number of reference pictures for encoding P frames. Possible 2257 values are: 2258 2259.. tabularcolumns:: |p{7.5cm}|p{7.5cm}| 2260 2261.. raw:: latex 2262 2263 \small 2264 2265.. flat-table:: 2266 :header-rows: 0 2267 :stub-columns: 0 2268 2269 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME`` 2270 - Last encoded frame will be searched 2271 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME`` 2272 - Two frames will be searched among the last encoded frame, the 2273 golden frame and the alternate reference (altref) frame. The 2274 encoder implementation will decide which two are chosen. 2275 * - ``V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME`` 2276 - The last encoded frame, the golden frame and the altref frame will 2277 be searched. 2278 2279.. raw:: latex 2280 2281 \normalsize 2282 2283 2284 2285``V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL (integer)`` 2286 Indicates the loop filter level. The adjustment of the loop filter 2287 level is done via a delta value against a baseline loop filter 2288 value. 2289 2290``V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS (integer)`` 2291 This parameter affects the loop filter. Anything above zero weakens 2292 the deblocking effect on the loop filter. 2293 2294``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD (integer)`` 2295 Sets the refresh period for the golden frame. The period is defined 2296 in number of frames. For a value of 'n', every nth frame starting 2297 from the first key frame will be taken as a golden frame. For eg. 2298 for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden 2299 frame refresh period is set as 4, the frames 0, 4, 8 etc will be 2300 taken as the golden frames as frame 0 is always a key frame. 2301 2302.. _v4l2-vpx-golden-frame-sel: 2303 2304``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL`` 2305 (enum) 2306 2307enum v4l2_vp8_golden_frame_sel - 2308 Selects the golden frame for encoding. Possible values are: 2309 2310.. raw:: latex 2311 2312 \scriptsize 2313 2314.. tabularcolumns:: |p{8.6cm}|p{8.9cm}| 2315 2316.. flat-table:: 2317 :header-rows: 0 2318 :stub-columns: 0 2319 2320 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV`` 2321 - Use the (n-2)th frame as a golden frame, current frame index being 2322 'n'. 2323 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD`` 2324 - Use the previous specific frame indicated by 2325 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD`` as a 2326 golden frame. 2327 2328.. raw:: latex 2329 2330 \normalsize 2331 2332 2333``V4L2_CID_MPEG_VIDEO_VPX_MIN_QP (integer)`` 2334 Minimum quantization parameter for VP8. 2335 2336``V4L2_CID_MPEG_VIDEO_VPX_MAX_QP (integer)`` 2337 Maximum quantization parameter for VP8. 2338 2339``V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP (integer)`` 2340 Quantization parameter for an I frame for VP8. 2341 2342``V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP (integer)`` 2343 Quantization parameter for a P frame for VP8. 2344 2345.. _v4l2-mpeg-video-vp8-profile: 2346 2347``V4L2_CID_MPEG_VIDEO_VP8_PROFILE`` 2348 (enum) 2349 2350enum v4l2_mpeg_video_vp8_profile - 2351 This control allows selecting the profile for VP8 encoder. 2352 This is also used to enumerate supported profiles by VP8 encoder or decoder. 2353 Possible values are: 2354 2355.. flat-table:: 2356 :header-rows: 0 2357 :stub-columns: 0 2358 2359 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_0`` 2360 - Profile 0 2361 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_1`` 2362 - Profile 1 2363 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_2`` 2364 - Profile 2 2365 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_3`` 2366 - Profile 3 2367 2368.. _v4l2-mpeg-video-vp9-profile: 2369 2370``V4L2_CID_MPEG_VIDEO_VP9_PROFILE`` 2371 (enum) 2372 2373enum v4l2_mpeg_video_vp9_profile - 2374 This control allows selecting the profile for VP9 encoder. 2375 This is also used to enumerate supported profiles by VP9 encoder or decoder. 2376 Possible values are: 2377 2378.. flat-table:: 2379 :header-rows: 0 2380 :stub-columns: 0 2381 2382 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_0`` 2383 - Profile 0 2384 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_1`` 2385 - Profile 1 2386 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_2`` 2387 - Profile 2 2388 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_3`` 2389 - Profile 3 2390 2391.. _v4l2-mpeg-video-vp9-level: 2392 2393``V4L2_CID_MPEG_VIDEO_VP9_LEVEL (enum)`` 2394 2395enum v4l2_mpeg_video_vp9_level - 2396 This control allows selecting the level for VP9 encoder. 2397 This is also used to enumerate supported levels by VP9 encoder or decoder. 2398 More information can be found at 2399 `webmproject <https://www.webmproject.org/vp9/levels/>`__. Possible values are: 2400 2401.. flat-table:: 2402 :header-rows: 0 2403 :stub-columns: 0 2404 2405 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_1_0`` 2406 - Level 1 2407 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_1_1`` 2408 - Level 1.1 2409 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_2_0`` 2410 - Level 2 2411 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_2_1`` 2412 - Level 2.1 2413 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_3_0`` 2414 - Level 3 2415 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_3_1`` 2416 - Level 3.1 2417 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_4_0`` 2418 - Level 4 2419 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_4_1`` 2420 - Level 4.1 2421 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_0`` 2422 - Level 5 2423 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_1`` 2424 - Level 5.1 2425 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_2`` 2426 - Level 5.2 2427 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_0`` 2428 - Level 6 2429 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_1`` 2430 - Level 6.1 2431 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_2`` 2432 - Level 6.2 2433 2434 2435High Efficiency Video Coding (HEVC/H.265) Control Reference 2436=========================================================== 2437 2438The HEVC/H.265 controls include controls for encoding parameters of HEVC/H.265 2439video codec. 2440 2441 2442.. _hevc-control-id: 2443 2444HEVC/H.265 Control IDs 2445---------------------- 2446 2447``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP (integer)`` 2448 Minimum quantization parameter for HEVC. 2449 Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2450 2451``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP (integer)`` 2452 Maximum quantization parameter for HEVC. 2453 Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2454 2455``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP (integer)`` 2456 Quantization parameter for an I frame for HEVC. 2457 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2458 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2459 2460``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP (integer)`` 2461 Quantization parameter for a P frame for HEVC. 2462 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2463 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2464 2465``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP (integer)`` 2466 Quantization parameter for a B frame for HEVC. 2467 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2468 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2469 2470``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_MIN_QP (integer)`` 2471 Minimum quantization parameter for the HEVC I frame to limit I frame 2472 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2473 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter 2474 should be chosen to meet both requirements. 2475 2476``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_MAX_QP (integer)`` 2477 Maximum quantization parameter for the HEVC I frame to limit I frame 2478 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2479 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter 2480 should be chosen to meet both requirements. 2481 2482``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_MIN_QP (integer)`` 2483 Minimum quantization parameter for the HEVC P frame to limit P frame 2484 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2485 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter 2486 should be chosen to meet both requirements. 2487 2488``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_MAX_QP (integer)`` 2489 Maximum quantization parameter for the HEVC P frame to limit P frame 2490 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2491 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter 2492 should be chosen to meet both requirements. 2493 2494``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_MIN_QP (integer)`` 2495 Minimum quantization parameter for the HEVC B frame to limit B frame 2496 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2497 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter 2498 should be chosen to meet both requirements. 2499 2500``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_MAX_QP (integer)`` 2501 Maximum quantization parameter for the HEVC B frame to limit B frame 2502 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2503 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter 2504 should be chosen to meet both requirements. 2505 2506``V4L2_CID_MPEG_VIDEO_HEVC_HIER_QP (boolean)`` 2507 HIERARCHICAL_QP allows the host to specify the quantization parameter 2508 values for each temporal layer through HIERARCHICAL_QP_LAYER. This is 2509 valid only if HIERARCHICAL_CODING_LAYER is greater than 1. Setting the 2510 control value to 1 enables setting of the QP values for the layers. 2511 2512.. _v4l2-hevc-hier-coding-type: 2513 2514``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_TYPE`` 2515 (enum) 2516 2517enum v4l2_mpeg_video_hevc_hier_coding_type - 2518 Selects the hierarchical coding type for encoding. Possible values are: 2519 2520.. raw:: latex 2521 2522 \footnotesize 2523 2524.. tabularcolumns:: |p{8.2cm}|p{9.3cm}| 2525 2526.. flat-table:: 2527 :header-rows: 0 2528 :stub-columns: 0 2529 2530 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B`` 2531 - Use the B frame for hierarchical coding. 2532 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P`` 2533 - Use the P frame for hierarchical coding. 2534 2535.. raw:: latex 2536 2537 \normalsize 2538 2539 2540``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER (integer)`` 2541 Selects the hierarchical coding layer. In normal encoding 2542 (non-hierarchial coding), it should be zero. Possible values are [0, 6]. 2543 0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING 2544 LAYER 1 and so on. 2545 2546``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_QP (integer)`` 2547 Indicates quantization parameter for hierarchical coding layer 0. 2548 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2549 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2550 2551``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_QP (integer)`` 2552 Indicates quantization parameter for hierarchical coding layer 1. 2553 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2554 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2555 2556``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_QP (integer)`` 2557 Indicates quantization parameter for hierarchical coding layer 2. 2558 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2559 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2560 2561``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_QP (integer)`` 2562 Indicates quantization parameter for hierarchical coding layer 3. 2563 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2564 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2565 2566``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_QP (integer)`` 2567 Indicates quantization parameter for hierarchical coding layer 4. 2568 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2569 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2570 2571``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_QP (integer)`` 2572 Indicates quantization parameter for hierarchical coding layer 5. 2573 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2574 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2575 2576``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_QP (integer)`` 2577 Indicates quantization parameter for hierarchical coding layer 6. 2578 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2579 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2580 2581.. _v4l2-hevc-profile: 2582 2583``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE`` 2584 (enum) 2585 2586enum v4l2_mpeg_video_hevc_profile - 2587 Select the desired profile for HEVC encoder. 2588 2589.. raw:: latex 2590 2591 \footnotesize 2592 2593.. tabularcolumns:: |p{9.0cm}|p{8.5cm}| 2594 2595.. flat-table:: 2596 :header-rows: 0 2597 :stub-columns: 0 2598 2599 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN`` 2600 - Main profile. 2601 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE`` 2602 - Main still picture profile. 2603 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_10`` 2604 - Main 10 profile. 2605 2606.. raw:: latex 2607 2608 \normalsize 2609 2610 2611.. _v4l2-hevc-level: 2612 2613``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL`` 2614 (enum) 2615 2616enum v4l2_mpeg_video_hevc_level - 2617 Selects the desired level for HEVC encoder. 2618 2619================================== ========= 2620``V4L2_MPEG_VIDEO_HEVC_LEVEL_1`` Level 1.0 2621``V4L2_MPEG_VIDEO_HEVC_LEVEL_2`` Level 2.0 2622``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1`` Level 2.1 2623``V4L2_MPEG_VIDEO_HEVC_LEVEL_3`` Level 3.0 2624``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1`` Level 3.1 2625``V4L2_MPEG_VIDEO_HEVC_LEVEL_4`` Level 4.0 2626``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1`` Level 4.1 2627``V4L2_MPEG_VIDEO_HEVC_LEVEL_5`` Level 5.0 2628``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1`` Level 5.1 2629``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2`` Level 5.2 2630``V4L2_MPEG_VIDEO_HEVC_LEVEL_6`` Level 6.0 2631``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1`` Level 6.1 2632``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2`` Level 6.2 2633================================== ========= 2634 2635``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION (integer)`` 2636 Indicates the number of evenly spaced subintervals, called ticks, within 2637 one second. This is a 16 bit unsigned integer and has a maximum value up to 2638 0xffff and a minimum value of 1. 2639 2640.. _v4l2-hevc-tier: 2641 2642``V4L2_CID_MPEG_VIDEO_HEVC_TIER`` 2643 (enum) 2644 2645enum v4l2_mpeg_video_hevc_tier - 2646 TIER_FLAG specifies tiers information of the HEVC encoded picture. Tier 2647 were made to deal with applications that differ in terms of maximum bit 2648 rate. Setting the flag to 0 selects HEVC tier as Main tier and setting 2649 this flag to 1 indicates High tier. High tier is for applications requiring 2650 high bit rates. 2651 2652================================== ========== 2653``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN`` Main tier. 2654``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH`` High tier. 2655================================== ========== 2656 2657 2658``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH (integer)`` 2659 Selects HEVC maximum coding unit depth. 2660 2661.. _v4l2-hevc-loop-filter-mode: 2662 2663``V4L2_CID_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE`` 2664 (enum) 2665 2666enum v4l2_mpeg_video_hevc_loop_filter_mode - 2667 Loop filter mode for HEVC encoder. Possible values are: 2668 2669.. raw:: latex 2670 2671 \footnotesize 2672 2673.. tabularcolumns:: |p{12.1cm}|p{5.4cm}| 2674 2675.. flat-table:: 2676 :header-rows: 0 2677 :stub-columns: 0 2678 2679 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED`` 2680 - Loop filter is disabled. 2681 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_ENABLED`` 2682 - Loop filter is enabled. 2683 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY`` 2684 - Loop filter is disabled at the slice boundary. 2685 2686.. raw:: latex 2687 2688 \normalsize 2689 2690 2691``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2 (integer)`` 2692 Selects HEVC loop filter beta offset. The valid range is [-6, +6]. 2693 2694``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2 (integer)`` 2695 Selects HEVC loop filter tc offset. The valid range is [-6, +6]. 2696 2697.. _v4l2-hevc-refresh-type: 2698 2699``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE`` 2700 (enum) 2701 2702enum v4l2_mpeg_video_hevc_hier_refresh_type - 2703 Selects refresh type for HEVC encoder. 2704 Host has to specify the period into 2705 V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD. 2706 2707.. raw:: latex 2708 2709 \footnotesize 2710 2711.. tabularcolumns:: |p{6.2cm}|p{11.3cm}| 2712 2713.. flat-table:: 2714 :header-rows: 0 2715 :stub-columns: 0 2716 2717 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE`` 2718 - Use the B frame for hierarchical coding. 2719 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA`` 2720 - Use CRA (Clean Random Access Unit) picture encoding. 2721 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR`` 2722 - Use IDR (Instantaneous Decoding Refresh) picture encoding. 2723 2724.. raw:: latex 2725 2726 \normalsize 2727 2728 2729``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD (integer)`` 2730 Selects the refresh period for HEVC encoder. 2731 This specifies the number of I pictures between two CRA/IDR pictures. 2732 This is valid only if REFRESH_TYPE is not 0. 2733 2734``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU (boolean)`` 2735 Indicates HEVC lossless encoding. Setting it to 0 disables lossless 2736 encoding. Setting it to 1 enables lossless encoding. 2737 2738``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED (boolean)`` 2739 Indicates constant intra prediction for HEVC encoder. Specifies the 2740 constrained intra prediction in which intra largest coding unit (LCU) 2741 prediction is performed by using residual data and decoded samples of 2742 neighboring intra LCU only. Setting the value to 1 enables constant intra 2743 prediction and setting the value to 0 disables constant intra prediction. 2744 2745``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT (boolean)`` 2746 Indicates wavefront parallel processing for HEVC encoder. Setting it to 0 2747 disables the feature and setting it to 1 enables the wavefront parallel 2748 processing. 2749 2750``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB (boolean)`` 2751 Setting the value to 1 enables combination of P and B frame for HEVC 2752 encoder. 2753 2754``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID (boolean)`` 2755 Indicates temporal identifier for HEVC encoder which is enabled by 2756 setting the value to 1. 2757 2758``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING (boolean)`` 2759 Indicates bi-linear interpolation is conditionally used in the intra 2760 prediction filtering process in the CVS when set to 1. Indicates bi-linear 2761 interpolation is not used in the CVS when set to 0. 2762 2763``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1 (integer)`` 2764 Indicates maximum number of merge candidate motion vectors. 2765 Values are from 0 to 4. 2766 2767``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION (boolean)`` 2768 Indicates temporal motion vector prediction for HEVC encoder. Setting it to 2769 1 enables the prediction. Setting it to 0 disables the prediction. 2770 2771``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE (boolean)`` 2772 Specifies if HEVC generates a stream with a size of the length field 2773 instead of start code pattern. The size of the length field is configurable 2774 through the V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD control. Setting 2775 the value to 0 disables encoding without startcode pattern. Setting the 2776 value to 1 will enables encoding without startcode pattern. 2777 2778.. _v4l2-hevc-size-of-length-field: 2779 2780``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD`` 2781(enum) 2782 2783enum v4l2_mpeg_video_hevc_size_of_length_field - 2784 Indicates the size of length field. 2785 This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled. 2786 2787.. raw:: latex 2788 2789 \footnotesize 2790 2791.. tabularcolumns:: |p{5.5cm}|p{12.0cm}| 2792 2793.. flat-table:: 2794 :header-rows: 0 2795 :stub-columns: 0 2796 2797 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0`` 2798 - Generate start code pattern (Normal). 2799 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1`` 2800 - Generate size of length field instead of start code pattern and length is 1. 2801 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2`` 2802 - Generate size of length field instead of start code pattern and length is 2. 2803 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4`` 2804 - Generate size of length field instead of start code pattern and length is 4. 2805 2806.. raw:: latex 2807 2808 \normalsize 2809 2810``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_BR (integer)`` 2811 Indicates bit rate for hierarchical coding layer 0 for HEVC encoder. 2812 2813``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_BR (integer)`` 2814 Indicates bit rate for hierarchical coding layer 1 for HEVC encoder. 2815 2816``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_BR (integer)`` 2817 Indicates bit rate for hierarchical coding layer 2 for HEVC encoder. 2818 2819``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_BR (integer)`` 2820 Indicates bit rate for hierarchical coding layer 3 for HEVC encoder. 2821 2822``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_BR (integer)`` 2823 Indicates bit rate for hierarchical coding layer 4 for HEVC encoder. 2824 2825``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_BR (integer)`` 2826 Indicates bit rate for hierarchical coding layer 5 for HEVC encoder. 2827 2828``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_BR (integer)`` 2829 Indicates bit rate for hierarchical coding layer 6 for HEVC encoder. 2830 2831``V4L2_CID_MPEG_VIDEO_REF_NUMBER_FOR_PFRAMES (integer)`` 2832 Selects number of P reference pictures required for HEVC encoder. 2833 P-Frame can use 1 or 2 frames for reference. 2834 2835``V4L2_CID_MPEG_VIDEO_PREPEND_SPSPPS_TO_IDR (integer)`` 2836 Indicates whether to generate SPS and PPS at every IDR. Setting it to 0 2837 disables generating SPS and PPS at every IDR. Setting it to one enables 2838 generating SPS and PPS at every IDR. 2839 2840.. _v4l2-mpeg-hevc: 2841 2842``V4L2_CID_MPEG_VIDEO_HEVC_SPS (struct)`` 2843 Specifies the Sequence Parameter Set fields (as extracted from the 2844 bitstream) for the associated HEVC slice data. 2845 These bitstream parameters are defined according to :ref:`hevc`. 2846 They are described in section 7.4.3.2 "Sequence parameter set RBSP 2847 semantics" of the specification. 2848 2849.. c:type:: v4l2_ctrl_hevc_sps 2850 2851.. raw:: latex 2852 2853 \small 2854 2855.. tabularcolumns:: |p{1.2cm}|p{9.2cm}|p{6.9cm}| 2856 2857.. cssclass:: longtable 2858 2859.. flat-table:: struct v4l2_ctrl_hevc_sps 2860 :header-rows: 0 2861 :stub-columns: 0 2862 :widths: 1 1 2 2863 2864 * - __u16 2865 - ``pic_width_in_luma_samples`` 2866 - 2867 * - __u16 2868 - ``pic_height_in_luma_samples`` 2869 - 2870 * - __u8 2871 - ``bit_depth_luma_minus8`` 2872 - 2873 * - __u8 2874 - ``bit_depth_chroma_minus8`` 2875 - 2876 * - __u8 2877 - ``log2_max_pic_order_cnt_lsb_minus4`` 2878 - 2879 * - __u8 2880 - ``sps_max_dec_pic_buffering_minus1`` 2881 - 2882 * - __u8 2883 - ``sps_max_num_reorder_pics`` 2884 - 2885 * - __u8 2886 - ``sps_max_latency_increase_plus1`` 2887 - 2888 * - __u8 2889 - ``log2_min_luma_coding_block_size_minus3`` 2890 - 2891 * - __u8 2892 - ``log2_diff_max_min_luma_coding_block_size`` 2893 - 2894 * - __u8 2895 - ``log2_min_luma_transform_block_size_minus2`` 2896 - 2897 * - __u8 2898 - ``log2_diff_max_min_luma_transform_block_size`` 2899 - 2900 * - __u8 2901 - ``max_transform_hierarchy_depth_inter`` 2902 - 2903 * - __u8 2904 - ``max_transform_hierarchy_depth_intra`` 2905 - 2906 * - __u8 2907 - ``pcm_sample_bit_depth_luma_minus1`` 2908 - 2909 * - __u8 2910 - ``pcm_sample_bit_depth_chroma_minus1`` 2911 - 2912 * - __u8 2913 - ``log2_min_pcm_luma_coding_block_size_minus3`` 2914 - 2915 * - __u8 2916 - ``log2_diff_max_min_pcm_luma_coding_block_size`` 2917 - 2918 * - __u8 2919 - ``num_short_term_ref_pic_sets`` 2920 - 2921 * - __u8 2922 - ``num_long_term_ref_pics_sps`` 2923 - 2924 * - __u8 2925 - ``chroma_format_idc`` 2926 - 2927 * - __u64 2928 - ``flags`` 2929 - See :ref:`Sequence Parameter Set Flags <hevc_sps_flags>` 2930 2931.. raw:: latex 2932 2933 \normalsize 2934 2935.. _hevc_sps_flags: 2936 2937``Sequence Parameter Set Flags`` 2938 2939.. raw:: latex 2940 2941 \small 2942 2943.. cssclass:: longtable 2944 2945.. flat-table:: 2946 :header-rows: 0 2947 :stub-columns: 0 2948 :widths: 1 1 2 2949 2950 * - ``V4L2_HEVC_SPS_FLAG_SEPARATE_COLOUR_PLANE`` 2951 - 0x00000001 2952 - 2953 * - ``V4L2_HEVC_SPS_FLAG_SCALING_LIST_ENABLED`` 2954 - 0x00000002 2955 - 2956 * - ``V4L2_HEVC_SPS_FLAG_AMP_ENABLED`` 2957 - 0x00000004 2958 - 2959 * - ``V4L2_HEVC_SPS_FLAG_SAMPLE_ADAPTIVE_OFFSET`` 2960 - 0x00000008 2961 - 2962 * - ``V4L2_HEVC_SPS_FLAG_PCM_ENABLED`` 2963 - 0x00000010 2964 - 2965 * - ``V4L2_HEVC_SPS_FLAG_PCM_LOOP_FILTER_DISABLED`` 2966 - 0x00000020 2967 - 2968 * - ``V4L2_HEVC_SPS_FLAG_LONG_TERM_REF_PICS_PRESENT`` 2969 - 0x00000040 2970 - 2971 * - ``V4L2_HEVC_SPS_FLAG_SPS_TEMPORAL_MVP_ENABLED`` 2972 - 0x00000080 2973 - 2974 * - ``V4L2_HEVC_SPS_FLAG_STRONG_INTRA_SMOOTHING_ENABLED`` 2975 - 0x00000100 2976 - 2977 2978.. raw:: latex 2979 2980 \normalsize 2981 2982``V4L2_CID_MPEG_VIDEO_HEVC_PPS (struct)`` 2983 Specifies the Picture Parameter Set fields (as extracted from the 2984 bitstream) for the associated HEVC slice data. 2985 These bitstream parameters are defined according to :ref:`hevc`. 2986 They are described in section 7.4.3.3 "Picture parameter set RBSP 2987 semantics" of the specification. 2988 2989.. c:type:: v4l2_ctrl_hevc_pps 2990 2991.. tabularcolumns:: |p{1.2cm}|p{8.6cm}|p{7.5cm}| 2992 2993.. cssclass:: longtable 2994 2995.. flat-table:: struct v4l2_ctrl_hevc_pps 2996 :header-rows: 0 2997 :stub-columns: 0 2998 :widths: 1 1 2 2999 3000 * - __u8 3001 - ``num_extra_slice_header_bits`` 3002 - 3003 * - __s8 3004 - ``init_qp_minus26`` 3005 - 3006 * - __u8 3007 - ``diff_cu_qp_delta_depth`` 3008 - 3009 * - __s8 3010 - ``pps_cb_qp_offset`` 3011 - 3012 * - __s8 3013 - ``pps_cr_qp_offset`` 3014 - 3015 * - __u8 3016 - ``num_tile_columns_minus1`` 3017 - 3018 * - __u8 3019 - ``num_tile_rows_minus1`` 3020 - 3021 * - __u8 3022 - ``column_width_minus1[20]`` 3023 - 3024 * - __u8 3025 - ``row_height_minus1[22]`` 3026 - 3027 * - __s8 3028 - ``pps_beta_offset_div2`` 3029 - 3030 * - __s8 3031 - ``pps_tc_offset_div2`` 3032 - 3033 * - __u8 3034 - ``log2_parallel_merge_level_minus2`` 3035 - 3036 * - __u8 3037 - ``padding[4]`` 3038 - Applications and drivers must set this to zero. 3039 * - __u64 3040 - ``flags`` 3041 - See :ref:`Picture Parameter Set Flags <hevc_pps_flags>` 3042 3043.. _hevc_pps_flags: 3044 3045``Picture Parameter Set Flags`` 3046 3047.. raw:: latex 3048 3049 \small 3050 3051.. flat-table:: 3052 :header-rows: 0 3053 :stub-columns: 0 3054 :widths: 1 1 2 3055 3056 * - ``V4L2_HEVC_PPS_FLAG_DEPENDENT_SLICE_SEGMENT`` 3057 - 0x00000001 3058 - 3059 * - ``V4L2_HEVC_PPS_FLAG_OUTPUT_FLAG_PRESENT`` 3060 - 0x00000002 3061 - 3062 * - ``V4L2_HEVC_PPS_FLAG_SIGN_DATA_HIDING_ENABLED`` 3063 - 0x00000004 3064 - 3065 * - ``V4L2_HEVC_PPS_FLAG_CABAC_INIT_PRESENT`` 3066 - 0x00000008 3067 - 3068 * - ``V4L2_HEVC_PPS_FLAG_CONSTRAINED_INTRA_PRED`` 3069 - 0x00000010 3070 - 3071 * - ``V4L2_HEVC_PPS_FLAG_TRANSFORM_SKIP_ENABLED`` 3072 - 0x00000020 3073 - 3074 * - ``V4L2_HEVC_PPS_FLAG_CU_QP_DELTA_ENABLED`` 3075 - 0x00000040 3076 - 3077 * - ``V4L2_HEVC_PPS_FLAG_PPS_SLICE_CHROMA_QP_OFFSETS_PRESENT`` 3078 - 0x00000080 3079 - 3080 * - ``V4L2_HEVC_PPS_FLAG_WEIGHTED_PRED`` 3081 - 0x00000100 3082 - 3083 * - ``V4L2_HEVC_PPS_FLAG_WEIGHTED_BIPRED`` 3084 - 0x00000200 3085 - 3086 * - ``V4L2_HEVC_PPS_FLAG_TRANSQUANT_BYPASS_ENABLED`` 3087 - 0x00000400 3088 - 3089 * - ``V4L2_HEVC_PPS_FLAG_TILES_ENABLED`` 3090 - 0x00000800 3091 - 3092 * - ``V4L2_HEVC_PPS_FLAG_ENTROPY_CODING_SYNC_ENABLED`` 3093 - 0x00001000 3094 - 3095 * - ``V4L2_HEVC_PPS_FLAG_LOOP_FILTER_ACROSS_TILES_ENABLED`` 3096 - 0x00002000 3097 - 3098 * - ``V4L2_HEVC_PPS_FLAG_PPS_LOOP_FILTER_ACROSS_SLICES_ENABLED`` 3099 - 0x00004000 3100 - 3101 * - ``V4L2_HEVC_PPS_FLAG_DEBLOCKING_FILTER_OVERRIDE_ENABLED`` 3102 - 0x00008000 3103 - 3104 * - ``V4L2_HEVC_PPS_FLAG_PPS_DISABLE_DEBLOCKING_FILTER`` 3105 - 0x00010000 3106 - 3107 * - ``V4L2_HEVC_PPS_FLAG_LISTS_MODIFICATION_PRESENT`` 3108 - 0x00020000 3109 - 3110 * - ``V4L2_HEVC_PPS_FLAG_SLICE_SEGMENT_HEADER_EXTENSION_PRESENT`` 3111 - 0x00040000 3112 - 3113 3114.. raw:: latex 3115 3116 \normalsize 3117 3118``V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS (struct)`` 3119 Specifies various slice-specific parameters, especially from the NAL unit 3120 header, general slice segment header and weighted prediction parameter 3121 parts of the bitstream. 3122 These bitstream parameters are defined according to :ref:`hevc`. 3123 They are described in section 7.4.7 "General slice segment header 3124 semantics" of the specification. 3125 3126.. c:type:: v4l2_ctrl_hevc_slice_params 3127 3128.. raw:: latex 3129 3130 \scriptsize 3131 3132.. tabularcolumns:: |p{5.4cm}|p{6.8cm}|p{5.1cm}| 3133 3134.. cssclass:: longtable 3135 3136.. flat-table:: struct v4l2_ctrl_hevc_slice_params 3137 :header-rows: 0 3138 :stub-columns: 0 3139 :widths: 1 1 2 3140 3141 * - __u32 3142 - ``bit_size`` 3143 - Size (in bits) of the current slice data. 3144 * - __u32 3145 - ``data_bit_offset`` 3146 - Offset (in bits) to the video data in the current slice data. 3147 * - __u8 3148 - ``nal_unit_type`` 3149 - 3150 * - __u8 3151 - ``nuh_temporal_id_plus1`` 3152 - 3153 * - __u8 3154 - ``slice_type`` 3155 - 3156 (V4L2_HEVC_SLICE_TYPE_I, V4L2_HEVC_SLICE_TYPE_P or 3157 V4L2_HEVC_SLICE_TYPE_B). 3158 * - __u8 3159 - ``colour_plane_id`` 3160 - 3161 * - __u16 3162 - ``slice_pic_order_cnt`` 3163 - 3164 * - __u8 3165 - ``num_ref_idx_l0_active_minus1`` 3166 - 3167 * - __u8 3168 - ``num_ref_idx_l1_active_minus1`` 3169 - 3170 * - __u8 3171 - ``collocated_ref_idx`` 3172 - 3173 * - __u8 3174 - ``five_minus_max_num_merge_cand`` 3175 - 3176 * - __s8 3177 - ``slice_qp_delta`` 3178 - 3179 * - __s8 3180 - ``slice_cb_qp_offset`` 3181 - 3182 * - __s8 3183 - ``slice_cr_qp_offset`` 3184 - 3185 * - __s8 3186 - ``slice_act_y_qp_offset`` 3187 - 3188 * - __s8 3189 - ``slice_act_cb_qp_offset`` 3190 - 3191 * - __s8 3192 - ``slice_act_cr_qp_offset`` 3193 - 3194 * - __s8 3195 - ``slice_beta_offset_div2`` 3196 - 3197 * - __s8 3198 - ``slice_tc_offset_div2`` 3199 - 3200 * - __u8 3201 - ``pic_struct`` 3202 - 3203 * - __u8 3204 - ``num_active_dpb_entries`` 3205 - The number of entries in ``dpb``. 3206 * - __u8 3207 - ``ref_idx_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3208 - The list of L0 reference elements as indices in the DPB. 3209 * - __u8 3210 - ``ref_idx_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3211 - The list of L1 reference elements as indices in the DPB. 3212 * - __u8 3213 - ``num_rps_poc_st_curr_before`` 3214 - The number of reference pictures in the short-term set that come before 3215 the current frame. 3216 * - __u8 3217 - ``num_rps_poc_st_curr_after`` 3218 - The number of reference pictures in the short-term set that come after 3219 the current frame. 3220 * - __u8 3221 - ``num_rps_poc_lt_curr`` 3222 - The number of reference pictures in the long-term set. 3223 * - __u8 3224 - ``padding[7]`` 3225 - Applications and drivers must set this to zero. 3226 * - struct :c:type:`v4l2_hevc_dpb_entry` 3227 - ``dpb[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3228 - The decoded picture buffer, for meta-data about reference frames. 3229 * - struct :c:type:`v4l2_hevc_pred_weight_table` 3230 - ``pred_weight_table`` 3231 - The prediction weight coefficients for inter-picture prediction. 3232 * - __u64 3233 - ``flags`` 3234 - See :ref:`Slice Parameters Flags <hevc_slice_params_flags>` 3235 3236.. raw:: latex 3237 3238 \normalsize 3239 3240.. _hevc_slice_params_flags: 3241 3242``Slice Parameters Flags`` 3243 3244.. raw:: latex 3245 3246 \scriptsize 3247 3248.. flat-table:: 3249 :header-rows: 0 3250 :stub-columns: 0 3251 :widths: 1 1 2 3252 3253 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_LUMA`` 3254 - 0x00000001 3255 - 3256 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_CHROMA`` 3257 - 0x00000002 3258 - 3259 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_TEMPORAL_MVP_ENABLED`` 3260 - 0x00000004 3261 - 3262 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_MVD_L1_ZERO`` 3263 - 0x00000008 3264 - 3265 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_CABAC_INIT`` 3266 - 0x00000010 3267 - 3268 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_COLLOCATED_FROM_L0`` 3269 - 0x00000020 3270 - 3271 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_USE_INTEGER_MV`` 3272 - 0x00000040 3273 - 3274 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_DEBLOCKING_FILTER_DISABLED`` 3275 - 0x00000080 3276 - 3277 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_LOOP_FILTER_ACROSS_SLICES_ENABLED`` 3278 - 0x00000100 3279 - 3280 3281.. raw:: latex 3282 3283 \normalsize 3284 3285.. c:type:: v4l2_hevc_dpb_entry 3286 3287.. raw:: latex 3288 3289 \small 3290 3291.. tabularcolumns:: |p{1.0cm}|p{4.2cm}|p{12.1cm}| 3292 3293.. flat-table:: struct v4l2_hevc_dpb_entry 3294 :header-rows: 0 3295 :stub-columns: 0 3296 :widths: 1 1 2 3297 3298 * - __u64 3299 - ``timestamp`` 3300 - Timestamp of the V4L2 capture buffer to use as reference, used 3301 with B-coded and P-coded frames. The timestamp refers to the 3302 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 3303 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 3304 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 3305 * - __u8 3306 - ``rps`` 3307 - The reference set for the reference frame 3308 (V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_BEFORE, 3309 V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_AFTER or 3310 V4L2_HEVC_DPB_ENTRY_RPS_LT_CURR) 3311 * - __u8 3312 - ``field_pic`` 3313 - Whether the reference is a field picture or a frame. 3314 * - __u16 3315 - ``pic_order_cnt[2]`` 3316 - The picture order count of the reference. Only the first element of the 3317 array is used for frame pictures, while the first element identifies the 3318 top field and the second the bottom field in field-coded pictures. 3319 * - __u8 3320 - ``padding[2]`` 3321 - Applications and drivers must set this to zero. 3322 3323.. raw:: latex 3324 3325 \normalsize 3326 3327.. c:type:: v4l2_hevc_pred_weight_table 3328 3329.. raw:: latex 3330 3331 \footnotesize 3332 3333.. tabularcolumns:: |p{0.8cm}|p{10.6cm}|p{5.9cm}| 3334 3335.. flat-table:: struct v4l2_hevc_pred_weight_table 3336 :header-rows: 0 3337 :stub-columns: 0 3338 :widths: 1 1 2 3339 3340 * - __u8 3341 - ``luma_log2_weight_denom`` 3342 - 3343 * - __s8 3344 - ``delta_chroma_log2_weight_denom`` 3345 - 3346 * - __s8 3347 - ``delta_luma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3348 - 3349 * - __s8 3350 - ``luma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3351 - 3352 * - __s8 3353 - ``delta_chroma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 3354 - 3355 * - __s8 3356 - ``chroma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 3357 - 3358 * - __s8 3359 - ``delta_luma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3360 - 3361 * - __s8 3362 - ``luma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 3363 - 3364 * - __s8 3365 - ``delta_chroma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 3366 - 3367 * - __s8 3368 - ``chroma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 3369 - 3370 * - __u8 3371 - ``padding[6]`` 3372 - Applications and drivers must set this to zero. 3373 3374.. raw:: latex 3375 3376 \normalsize 3377 3378``V4L2_CID_MPEG_VIDEO_HEVC_DECODE_MODE (enum)`` 3379 Specifies the decoding mode to use. Currently exposes slice-based and 3380 frame-based decoding but new modes might be added later on. 3381 This control is used as a modifier for V4L2_PIX_FMT_HEVC_SLICE 3382 pixel format. Applications that support V4L2_PIX_FMT_HEVC_SLICE 3383 are required to set this control in order to specify the decoding mode 3384 that is expected for the buffer. 3385 Drivers may expose a single or multiple decoding modes, depending 3386 on what they can support. 3387 3388 .. note:: 3389 3390 This menu control is not yet part of the public kernel API and 3391 it is expected to change. 3392 3393.. c:type:: v4l2_mpeg_video_hevc_decode_mode 3394 3395.. raw:: latex 3396 3397 \small 3398 3399.. tabularcolumns:: |p{9.4cm}|p{0.6cm}|p{7.3cm}| 3400 3401.. flat-table:: 3402 :header-rows: 0 3403 :stub-columns: 0 3404 :widths: 1 1 2 3405 3406 * - ``V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_SLICE_BASED`` 3407 - 0 3408 - Decoding is done at the slice granularity. 3409 The OUTPUT buffer must contain a single slice. 3410 * - ``V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_FRAME_BASED`` 3411 - 1 3412 - Decoding is done at the frame granularity. 3413 The OUTPUT buffer must contain all slices needed to decode the 3414 frame. The OUTPUT buffer must also contain both fields. 3415 3416.. raw:: latex 3417 3418 \normalsize 3419 3420``V4L2_CID_MPEG_VIDEO_HEVC_START_CODE (enum)`` 3421 Specifies the HEVC slice start code expected for each slice. 3422 This control is used as a modifier for V4L2_PIX_FMT_HEVC_SLICE 3423 pixel format. Applications that support V4L2_PIX_FMT_HEVC_SLICE 3424 are required to set this control in order to specify the start code 3425 that is expected for the buffer. 3426 Drivers may expose a single or multiple start codes, depending 3427 on what they can support. 3428 3429 .. note:: 3430 3431 This menu control is not yet part of the public kernel API and 3432 it is expected to change. 3433 3434.. c:type:: v4l2_mpeg_video_hevc_start_code 3435 3436.. tabularcolumns:: |p{9.2cm}|p{0.6cm}|p{7.5cm}| 3437 3438.. flat-table:: 3439 :header-rows: 0 3440 :stub-columns: 0 3441 :widths: 1 1 2 3442 3443 * - ``V4L2_MPEG_VIDEO_HEVC_START_CODE_NONE`` 3444 - 0 3445 - Selecting this value specifies that HEVC slices are passed 3446 to the driver without any start code. The bitstream data should be 3447 according to :ref:`hevc` 7.3.1.1 General NAL unit syntax, hence 3448 contains emulation prevention bytes when required. 3449 * - ``V4L2_MPEG_VIDEO_HEVC_START_CODE_ANNEX_B`` 3450 - 1 3451 - Selecting this value specifies that HEVC slices are expected 3452 to be prefixed by Annex B start codes. According to :ref:`hevc` 3453 valid start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001. 3454 3455``V4L2_CID_MPEG_VIDEO_BASELAYER_PRIORITY_ID (integer)`` 3456 Specifies a priority identifier for the NAL unit, which will be applied to 3457 the base layer. By default this value is set to 0 for the base layer, 3458 and the next layer will have the priority ID assigned as 1, 2, 3 and so on. 3459 The video encoder can't decide the priority id to be applied to a layer, 3460 so this has to come from client. 3461 This is applicable to H264 and valid Range is from 0 to 63. 3462 Source Rec. ITU-T H.264 (06/2019); G.7.4.1.1, G.8.8.1. 3463 3464``V4L2_CID_MPEG_VIDEO_LTR_COUNT (integer)`` 3465 Specifies the maximum number of Long Term Reference (LTR) frames at any 3466 given time that the encoder can keep. 3467 This is applicable to the H264 and HEVC encoders. 3468 3469``V4L2_CID_MPEG_VIDEO_FRAME_LTR_INDEX (integer)`` 3470 After setting this control the frame that will be queued next 3471 will be marked as a Long Term Reference (LTR) frame 3472 and given this LTR index which ranges from 0 to LTR_COUNT-1. 3473 This is applicable to the H264 and HEVC encoders. 3474 Source Rec. ITU-T H.264 (06/2019); Table 7.9 3475 3476``V4L2_CID_MPEG_VIDEO_USE_LTR_FRAMES (bitmask)`` 3477 Specifies the Long Term Reference (LTR) frame(s) to be used for 3478 encoding the next frame queued after setting this control. 3479 This provides a bitmask which consists of bits [0, LTR_COUNT-1]. 3480 This is applicable to the H264 and HEVC encoders. 3481