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. Setting this control to zero means that 1178 macroblocks will not be refreshed. Note that this control will not 1179 take effect when ``V4L2_CID_MPEG_VIDEO_INTRA_REFRESH_PERIOD`` control 1180 is set to non zero value. 1181 Applicable to H264, H263 and MPEG4 encoder. 1182 1183``V4L2_CID_MPEG_VIDEO_INTRA_REFRESH_PERIOD_TYPE (enum)`` 1184 1185enum v4l2_mpeg_video_intra_refresh_period_type - 1186 Sets the type of intra refresh. The period to refresh 1187 the whole frame is specified by V4L2_CID_MPEG_VIDEO_INTRA_REFRESH_PERIOD. 1188 Note that if this control is not present, then it is undefined what 1189 refresh type is used and it is up to the driver to decide. 1190 Applicable to H264 and HEVC encoders. Possible values are: 1191 1192.. tabularcolumns:: |p{9.6cm}|p{7.9cm}| 1193 1194.. flat-table:: 1195 :header-rows: 0 1196 :stub-columns: 0 1197 1198 * - ``V4L2_MPEG_VIDEO_INTRA_REFRESH_PERIOD_TYPE_RANDOM`` 1199 - The whole frame is completely refreshed randomly 1200 after the specified period. 1201 * - ``V4L2_MPEG_VIDEO_INTRA_REFRESH_PERIOD_TYPE_CYCLIC`` 1202 - The whole frame MBs are completely refreshed in cyclic order 1203 after the specified period. 1204 1205``V4L2_CID_MPEG_VIDEO_INTRA_REFRESH_PERIOD (integer)`` 1206 Intra macroblock refresh period. This sets the period to refresh 1207 the whole frame. In other words, this defines the number of frames 1208 for which the whole frame will be intra-refreshed. An example: 1209 setting period to 1 means that the whole frame will be refreshed, 1210 setting period to 2 means that the half of macroblocks will be 1211 intra-refreshed on frameX and the other half of macroblocks 1212 will be refreshed in frameX + 1 and so on. Setting the period to 1213 zero means no period is specified. 1214 Note that if the client sets this control to non zero value the 1215 ``V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB`` control shall be 1216 ignored. Applicable to H264 and HEVC encoders. 1217 1218``V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE (boolean)`` 1219 Frame level rate control enable. If this control is disabled then 1220 the quantization parameter for each frame type is constant and set 1221 with appropriate controls (e.g. 1222 ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP``). If frame rate control is 1223 enabled then quantization parameter is adjusted to meet the chosen 1224 bitrate. Minimum and maximum value for the quantization parameter 1225 can be set with appropriate controls (e.g. 1226 ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP``). Applicable to encoders. 1227 1228``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE (boolean)`` 1229 Macroblock level rate control enable. Applicable to the MPEG4 and 1230 H264 encoders. 1231 1232``V4L2_CID_MPEG_VIDEO_MPEG4_QPEL (boolean)`` 1233 Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 1234 encoder. 1235 1236``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP (integer)`` 1237 Quantization parameter for an I frame for H263. Valid range: from 1 1238 to 31. 1239 1240``V4L2_CID_MPEG_VIDEO_H263_MIN_QP (integer)`` 1241 Minimum quantization parameter for H263. Valid range: from 1 to 31. 1242 1243``V4L2_CID_MPEG_VIDEO_H263_MAX_QP (integer)`` 1244 Maximum quantization parameter for H263. Valid range: from 1 to 31. 1245 1246``V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP (integer)`` 1247 Quantization parameter for an P frame for H263. Valid range: from 1 1248 to 31. 1249 1250``V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP (integer)`` 1251 Quantization parameter for an B frame for H263. Valid range: from 1 1252 to 31. 1253 1254``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP (integer)`` 1255 Quantization parameter for an I frame for H264. Valid range: from 0 1256 to 51. 1257 1258``V4L2_CID_MPEG_VIDEO_H264_MIN_QP (integer)`` 1259 Minimum quantization parameter for H264. Valid range: from 0 to 51. 1260 1261``V4L2_CID_MPEG_VIDEO_H264_MAX_QP (integer)`` 1262 Maximum quantization parameter for H264. Valid range: from 0 to 51. 1263 1264``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP (integer)`` 1265 Quantization parameter for an P frame for H264. Valid range: from 0 1266 to 51. 1267 1268``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP (integer)`` 1269 Quantization parameter for an B frame for H264. Valid range: from 0 1270 to 51. 1271 1272``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MIN_QP (integer)`` 1273 Minimum quantization parameter for the H264 I frame to limit I frame 1274 quality to a range. Valid range: from 0 to 51. If 1275 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1276 should be chosen to meet both requirements. 1277 1278``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MAX_QP (integer)`` 1279 Maximum quantization parameter for the H264 I frame to limit I frame 1280 quality to a range. Valid range: from 0 to 51. If 1281 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1282 should be chosen to meet both requirements. 1283 1284``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MIN_QP (integer)`` 1285 Minimum quantization parameter for the H264 P frame to limit P frame 1286 quality to a range. Valid range: from 0 to 51. If 1287 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1288 should be chosen to meet both requirements. 1289 1290``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MAX_QP (integer)`` 1291 Maximum quantization parameter for the H264 P frame to limit P frame 1292 quality to a range. Valid range: from 0 to 51. If 1293 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1294 should be chosen to meet both requirements. 1295 1296``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_MIN_QP (integer)`` 1297 Minimum quantization parameter for the H264 B frame to limit B frame 1298 quality to a range. Valid range: from 0 to 51. If 1299 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1300 should be chosen to meet both requirements. 1301 1302``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_MAX_QP (integer)`` 1303 Maximum quantization parameter for the H264 B frame to limit B frame 1304 quality to a range. Valid range: from 0 to 51. If 1305 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1306 should be chosen to meet both requirements. 1307 1308``V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP (integer)`` 1309 Quantization parameter for an I frame for MPEG4. Valid range: from 1 1310 to 31. 1311 1312``V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP (integer)`` 1313 Minimum quantization parameter for MPEG4. Valid range: from 1 to 31. 1314 1315``V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP (integer)`` 1316 Maximum quantization parameter for MPEG4. Valid range: from 1 to 31. 1317 1318``V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP (integer)`` 1319 Quantization parameter for an P frame for MPEG4. Valid range: from 1 1320 to 31. 1321 1322``V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP (integer)`` 1323 Quantization parameter for an B frame for MPEG4. Valid range: from 1 1324 to 31. 1325 1326.. _v4l2-mpeg-video-vbv-size: 1327 1328``V4L2_CID_MPEG_VIDEO_VBV_SIZE (integer)`` 1329 The Video Buffer Verifier size in kilobytes, it is used as a 1330 limitation of frame skip. The VBV is defined in the standard as a 1331 mean to verify that the produced stream will be successfully 1332 decoded. The standard describes it as "Part of a hypothetical 1333 decoder that is conceptually connected to the output of the encoder. 1334 Its purpose is to provide a constraint on the variability of the 1335 data rate that an encoder or editing process may produce.". 1336 Applicable to the MPEG1, MPEG2, MPEG4 encoders. 1337 1338.. _v4l2-mpeg-video-vbv-delay: 1339 1340``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)`` 1341 Sets the initial delay in milliseconds for VBV buffer control. 1342 1343.. _v4l2-mpeg-video-hor-search-range: 1344 1345``V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE (integer)`` 1346 Horizontal search range defines maximum horizontal search area in 1347 pixels to search and match for the present Macroblock (MB) in the 1348 reference picture. This V4L2 control macro is used to set horizontal 1349 search range for motion estimation module in video encoder. 1350 1351.. _v4l2-mpeg-video-vert-search-range: 1352 1353``V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE (integer)`` 1354 Vertical search range defines maximum vertical search area in pixels 1355 to search and match for the present Macroblock (MB) in the reference 1356 picture. This V4L2 control macro is used to set vertical search 1357 range for motion estimation module in video encoder. 1358 1359.. _v4l2-mpeg-video-force-key-frame: 1360 1361``V4L2_CID_MPEG_VIDEO_FORCE_KEY_FRAME (button)`` 1362 Force a key frame for the next queued buffer. Applicable to 1363 encoders. This is a general, codec-agnostic keyframe control. 1364 1365.. _v4l2-mpeg-video-h264-cpb-size: 1366 1367``V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE (integer)`` 1368 The Coded Picture Buffer size in kilobytes, it is used as a 1369 limitation of frame skip. The CPB is defined in the H264 standard as 1370 a mean to verify that the produced stream will be successfully 1371 decoded. Applicable to the H264 encoder. 1372 1373``V4L2_CID_MPEG_VIDEO_H264_I_PERIOD (integer)`` 1374 Period between I-frames in the open GOP for H264. In case of an open 1375 GOP this is the period between two I-frames. The period between IDR 1376 (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE 1377 control. An IDR frame, which stands for Instantaneous Decoding 1378 Refresh is an I-frame after which no prior frames are referenced. 1379 This means that a stream can be restarted from an IDR frame without 1380 the need to store or decode any previous frames. Applicable to the 1381 H264 encoder. 1382 1383.. _v4l2-mpeg-video-header-mode: 1384 1385``V4L2_CID_MPEG_VIDEO_HEADER_MODE`` 1386 (enum) 1387 1388enum v4l2_mpeg_video_header_mode - 1389 Determines whether the header is returned as the first buffer or is 1390 it returned together with the first frame. Applicable to encoders. 1391 Possible values are: 1392 1393.. raw:: latex 1394 1395 \small 1396 1397.. tabularcolumns:: |p{10.3cm}|p{7.2cm}| 1398 1399.. flat-table:: 1400 :header-rows: 0 1401 :stub-columns: 0 1402 1403 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE`` 1404 - The stream header is returned separately in the first buffer. 1405 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME`` 1406 - The stream header is returned together with the first encoded 1407 frame. 1408 1409.. raw:: latex 1410 1411 \normalsize 1412 1413 1414``V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER (boolean)`` 1415 Repeat the video sequence headers. Repeating these headers makes 1416 random access to the video stream easier. Applicable to the MPEG1, 2 1417 and 4 encoder. 1418 1419``V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER (boolean)`` 1420 Enabled the deblocking post processing filter for MPEG4 decoder. 1421 Applicable to the MPEG4 decoder. 1422 1423``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES (integer)`` 1424 vop_time_increment_resolution value for MPEG4. Applicable to the 1425 MPEG4 encoder. 1426 1427``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC (integer)`` 1428 vop_time_increment value for MPEG4. Applicable to the MPEG4 1429 encoder. 1430 1431``V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING (boolean)`` 1432 Enable generation of frame packing supplemental enhancement 1433 information in the encoded bitstream. The frame packing SEI message 1434 contains the arrangement of L and R planes for 3D viewing. 1435 Applicable to the H264 encoder. 1436 1437``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0 (boolean)`` 1438 Sets current frame as frame0 in frame packing SEI. Applicable to the 1439 H264 encoder. 1440 1441.. _v4l2-mpeg-video-h264-sei-fp-arrangement-type: 1442 1443``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE`` 1444 (enum) 1445 1446enum v4l2_mpeg_video_h264_sei_fp_arrangement_type - 1447 Frame packing arrangement type for H264 SEI. Applicable to the H264 1448 encoder. Possible values are: 1449 1450.. raw:: latex 1451 1452 \small 1453 1454.. tabularcolumns:: |p{12cm}|p{5.5cm}| 1455 1456.. flat-table:: 1457 :header-rows: 0 1458 :stub-columns: 0 1459 1460 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_CHEKERBOARD`` 1461 - Pixels are alternatively from L and R. 1462 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_COLUMN`` 1463 - L and R are interlaced by column. 1464 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_ROW`` 1465 - L and R are interlaced by row. 1466 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_SIDE_BY_SIDE`` 1467 - L is on the left, R on the right. 1468 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TOP_BOTTOM`` 1469 - L is on top, R on bottom. 1470 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TEMPORAL`` 1471 - One view per frame. 1472 1473.. raw:: latex 1474 1475 \normalsize 1476 1477 1478 1479``V4L2_CID_MPEG_VIDEO_H264_FMO (boolean)`` 1480 Enables flexible macroblock ordering in the encoded bitstream. It is 1481 a technique used for restructuring the ordering of macroblocks in 1482 pictures. Applicable to the H264 encoder. 1483 1484.. _v4l2-mpeg-video-h264-fmo-map-type: 1485 1486``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE`` 1487 (enum) 1488 1489enum v4l2_mpeg_video_h264_fmo_map_type - 1490 When using FMO, the map type divides the image in different scan 1491 patterns of macroblocks. Applicable to the H264 encoder. Possible 1492 values are: 1493 1494.. raw:: latex 1495 1496 \small 1497 1498.. tabularcolumns:: |p{12.5cm}|p{5.0cm}| 1499 1500.. flat-table:: 1501 :header-rows: 0 1502 :stub-columns: 0 1503 1504 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES`` 1505 - Slices are interleaved one after other with macroblocks in run 1506 length order. 1507 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_SCATTERED_SLICES`` 1508 - Scatters the macroblocks based on a mathematical function known to 1509 both encoder and decoder. 1510 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_FOREGROUND_WITH_LEFT_OVER`` 1511 - Macroblocks arranged in rectangular areas or regions of interest. 1512 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_BOX_OUT`` 1513 - Slice groups grow in a cyclic way from centre to outwards. 1514 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_RASTER_SCAN`` 1515 - Slice groups grow in raster scan pattern from left to right. 1516 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_WIPE_SCAN`` 1517 - Slice groups grow in wipe scan pattern from top to bottom. 1518 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_EXPLICIT`` 1519 - User defined map type. 1520 1521.. raw:: latex 1522 1523 \normalsize 1524 1525 1526 1527``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)`` 1528 Number of slice groups in FMO. Applicable to the H264 encoder. 1529 1530.. _v4l2-mpeg-video-h264-fmo-change-direction: 1531 1532``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION`` 1533 (enum) 1534 1535enum v4l2_mpeg_video_h264_fmo_change_dir - 1536 Specifies a direction of the slice group change for raster and wipe 1537 maps. Applicable to the H264 encoder. Possible values are: 1538 1539.. tabularcolumns:: |p{9.6cm}|p{7.9cm}| 1540 1541.. flat-table:: 1542 :header-rows: 0 1543 :stub-columns: 0 1544 1545 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_RIGHT`` 1546 - Raster scan or wipe right. 1547 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_LEFT`` 1548 - Reverse raster scan or wipe left. 1549 1550 1551 1552``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE (integer)`` 1553 Specifies the size of the first slice group for raster and wipe map. 1554 Applicable to the H264 encoder. 1555 1556``V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH (integer)`` 1557 Specifies the number of consecutive macroblocks for the interleaved 1558 map. Applicable to the H264 encoder. 1559 1560``V4L2_CID_MPEG_VIDEO_H264_ASO (boolean)`` 1561 Enables arbitrary slice ordering in encoded bitstream. Applicable to 1562 the H264 encoder. 1563 1564``V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER (integer)`` 1565 Specifies the slice order in ASO. Applicable to the H264 encoder. 1566 The supplied 32-bit integer is interpreted as follows (bit 0 = least 1567 significant bit): 1568 1569 1570 1571.. flat-table:: 1572 :header-rows: 0 1573 :stub-columns: 0 1574 1575 * - Bit 0:15 1576 - Slice ID 1577 * - Bit 16:32 1578 - Slice position or order 1579 1580 1581 1582``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)`` 1583 Enables H264 hierarchical coding. Applicable to the H264 encoder. 1584 1585.. _v4l2-mpeg-video-h264-hierarchical-coding-type: 1586 1587``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE`` 1588 (enum) 1589 1590enum v4l2_mpeg_video_h264_hierarchical_coding_type - 1591 Specifies the hierarchical coding type. Applicable to the H264 1592 encoder. Possible values are: 1593 1594 1595 1596.. flat-table:: 1597 :header-rows: 0 1598 :stub-columns: 0 1599 1600 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B`` 1601 - Hierarchical B coding. 1602 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P`` 1603 - Hierarchical P coding. 1604 1605 1606 1607``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER (integer)`` 1608 Specifies the number of hierarchical coding layers. Applicable to 1609 the H264 encoder. 1610 1611``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP (integer)`` 1612 Specifies a user defined QP for each layer. Applicable to the H264 1613 encoder. The supplied 32-bit integer is interpreted as follows (bit 1614 0 = least significant bit): 1615 1616 1617 1618.. flat-table:: 1619 :header-rows: 0 1620 :stub-columns: 0 1621 1622 * - Bit 0:15 1623 - QP value 1624 * - Bit 16:32 1625 - Layer number 1626 1627``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L0_BR (integer)`` 1628 Indicates bit rate (bps) for hierarchical coding layer 0 for H264 encoder. 1629 1630``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L1_BR (integer)`` 1631 Indicates bit rate (bps) for hierarchical coding layer 1 for H264 encoder. 1632 1633``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L2_BR (integer)`` 1634 Indicates bit rate (bps) for hierarchical coding layer 2 for H264 encoder. 1635 1636``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L3_BR (integer)`` 1637 Indicates bit rate (bps) for hierarchical coding layer 3 for H264 encoder. 1638 1639``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L4_BR (integer)`` 1640 Indicates bit rate (bps) for hierarchical coding layer 4 for H264 encoder. 1641 1642``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L5_BR (integer)`` 1643 Indicates bit rate (bps) for hierarchical coding layer 5 for H264 encoder. 1644 1645``V4L2_CID_MPEG_VIDEO_H264_HIER_CODING_L6_BR (integer)`` 1646 Indicates bit rate (bps) for hierarchical coding layer 6 for H264 encoder. 1647 1648``V4L2_CID_FWHT_I_FRAME_QP (integer)`` 1649 Quantization parameter for an I frame for FWHT. Valid range: from 1 1650 to 31. 1651 1652``V4L2_CID_FWHT_P_FRAME_QP (integer)`` 1653 Quantization parameter for a P frame for FWHT. Valid range: from 1 1654 to 31. 1655 1656.. raw:: latex 1657 1658 \normalsize 1659 1660 1661MFC 5.1 MPEG Controls 1662===================== 1663 1664The following MPEG class controls deal with MPEG decoding and encoding 1665settings that are specific to the Multi Format Codec 5.1 device present 1666in the S5P family of SoCs by Samsung. 1667 1668 1669.. _mfc51-control-id: 1670 1671MFC 5.1 Control IDs 1672------------------- 1673 1674``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE (boolean)`` 1675 If the display delay is enabled then the decoder is forced to return 1676 a CAPTURE buffer (decoded frame) after processing a certain number 1677 of OUTPUT buffers. The delay can be set through 1678 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY``. This 1679 feature can be used for example for generating thumbnails of videos. 1680 Applicable to the H264 decoder. 1681 1682 .. note:: 1683 1684 This control is deprecated. Use the standard 1685 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY_ENABLE`` control instead. 1686 1687``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY (integer)`` 1688 Display delay value for H264 decoder. The decoder is forced to 1689 return a decoded frame after the set 'display delay' number of 1690 frames. If this number is low it may result in frames returned out 1691 of display order, in addition the hardware may still be using the 1692 returned buffer as a reference picture for subsequent frames. 1693 1694 .. note:: 1695 1696 This control is deprecated. Use the standard 1697 ``V4L2_CID_MPEG_VIDEO_DEC_DISPLAY_DELAY`` control instead. 1698 1699``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)`` 1700 The number of reference pictures used for encoding a P picture. 1701 Applicable to the H264 encoder. 1702 1703``V4L2_CID_MPEG_MFC51_VIDEO_PADDING (boolean)`` 1704 Padding enable in the encoder - use a color instead of repeating 1705 border pixels. Applicable to encoders. 1706 1707``V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV (integer)`` 1708 Padding color in the encoder. Applicable to encoders. The supplied 1709 32-bit integer is interpreted as follows (bit 0 = least significant 1710 bit): 1711 1712 1713 1714.. flat-table:: 1715 :header-rows: 0 1716 :stub-columns: 0 1717 1718 * - Bit 0:7 1719 - V chrominance information 1720 * - Bit 8:15 1721 - U chrominance information 1722 * - Bit 16:23 1723 - Y luminance information 1724 * - Bit 24:31 1725 - Must be zero. 1726 1727 1728 1729``V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF (integer)`` 1730 Reaction coefficient for MFC rate control. Applicable to encoders. 1731 1732 .. note:: 1733 1734 #. Valid only when the frame level RC is enabled. 1735 1736 #. For tight CBR, this field must be small (ex. 2 ~ 10). For 1737 VBR, this field must be large (ex. 100 ~ 1000). 1738 1739 #. It is not recommended to use the greater number than 1740 FRAME_RATE * (10^9 / BIT_RATE). 1741 1742``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK (boolean)`` 1743 Adaptive rate control for dark region. Valid only when H.264 and 1744 macroblock level RC is enabled 1745 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1746 encoder. 1747 1748``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH (boolean)`` 1749 Adaptive rate control for smooth region. Valid only when H.264 and 1750 macroblock level RC is enabled 1751 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1752 encoder. 1753 1754``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC (boolean)`` 1755 Adaptive rate control for static region. Valid only when H.264 and 1756 macroblock level RC is enabled 1757 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1758 encoder. 1759 1760``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY (boolean)`` 1761 Adaptive rate control for activity region. Valid only when H.264 and 1762 macroblock level RC is enabled 1763 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 1764 encoder. 1765 1766.. _v4l2-mpeg-mfc51-video-frame-skip-mode: 1767 1768``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE`` 1769 (enum) 1770 1771 .. note:: 1772 1773 This control is deprecated. Use the standard 1774 ``V4L2_CID_MPEG_VIDEO_FRAME_SKIP_MODE`` control instead. 1775 1776enum v4l2_mpeg_mfc51_video_frame_skip_mode - 1777 Indicates in what conditions the encoder should skip frames. If 1778 encoding a frame would cause the encoded stream to be larger then a 1779 chosen data limit then the frame will be skipped. Possible values 1780 are: 1781 1782 1783.. tabularcolumns:: |p{9.4cm}|p{8.1cm}| 1784 1785.. raw:: latex 1786 1787 \small 1788 1789.. flat-table:: 1790 :header-rows: 0 1791 :stub-columns: 0 1792 1793 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_DISABLED`` 1794 - Frame skip mode is disabled. 1795 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_LEVEL_LIMIT`` 1796 - Frame skip mode enabled and buffer limit is set by the chosen 1797 level and is defined by the standard. 1798 * - ``V4L2_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE_BUF_LIMIT`` 1799 - Frame skip mode enabled and buffer limit is set by the VBV 1800 (MPEG1/2/4) or CPB (H264) buffer size control. 1801 1802.. raw:: latex 1803 1804 \normalsize 1805 1806``V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT (integer)`` 1807 Enable rate-control with fixed target bit. If this setting is 1808 enabled, then the rate control logic of the encoder will calculate 1809 the average bitrate for a GOP and keep it below or equal the set 1810 bitrate target. Otherwise the rate control logic calculates the 1811 overall average bitrate for the stream and keeps it below or equal 1812 to the set bitrate. In the first case the average bitrate for the 1813 whole stream will be smaller then the set bitrate. This is caused 1814 because the average is calculated for smaller number of frames, on 1815 the other hand enabling this setting will ensure that the stream 1816 will meet tight bandwidth constraints. Applicable to encoders. 1817 1818.. _v4l2-mpeg-mfc51-video-force-frame-type: 1819 1820``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE`` 1821 (enum) 1822 1823enum v4l2_mpeg_mfc51_video_force_frame_type - 1824 Force a frame type for the next queued buffer. Applicable to 1825 encoders. Possible values are: 1826 1827.. tabularcolumns:: |p{9.9cm}|p{7.6cm}| 1828 1829.. flat-table:: 1830 :header-rows: 0 1831 :stub-columns: 0 1832 1833 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED`` 1834 - Forcing a specific frame type disabled. 1835 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME`` 1836 - Force an I-frame. 1837 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED`` 1838 - Force a non-coded frame. 1839 1840 1841CX2341x MPEG Controls 1842===================== 1843 1844The following MPEG class controls deal with MPEG encoding settings that 1845are specific to the Conexant CX23415 and CX23416 MPEG encoding chips. 1846 1847 1848.. _cx2341x-control-id: 1849 1850CX2341x Control IDs 1851------------------- 1852 1853.. _v4l2-mpeg-cx2341x-video-spatial-filter-mode: 1854 1855``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE`` 1856 (enum) 1857 1858enum v4l2_mpeg_cx2341x_video_spatial_filter_mode - 1859 Sets the Spatial Filter mode (default ``MANUAL``). Possible values 1860 are: 1861 1862 1863.. tabularcolumns:: |p{11.5cm}|p{6.0cm}| 1864 1865.. flat-table:: 1866 :header-rows: 0 1867 :stub-columns: 0 1868 1869 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL`` 1870 - Choose the filter manually 1871 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO`` 1872 - Choose the filter automatically 1873 1874 1875 1876``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (integer (0-15))`` 1877 The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default 1878 is 0.) 1879 1880.. _luma-spatial-filter-type: 1881 1882``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE`` 1883 (enum) 1884 1885enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type - 1886 Select the algorithm to use for the Luma Spatial Filter (default 1887 ``1D_HOR``). Possible values: 1888 1889.. tabularcolumns:: |p{13.1cm}|p{4.4cm}| 1890 1891.. raw:: latex 1892 1893 \footnotesize 1894 1895.. flat-table:: 1896 :header-rows: 0 1897 :stub-columns: 0 1898 1899 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF`` 1900 - No filter 1901 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR`` 1902 - One-dimensional horizontal 1903 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT`` 1904 - One-dimensional vertical 1905 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE`` 1906 - Two-dimensional separable 1907 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE`` 1908 - Two-dimensional symmetrical non-separable 1909 1910.. raw:: latex 1911 1912 \normalsize 1913 1914.. _chroma-spatial-filter-type: 1915 1916``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE`` 1917 (enum) 1918 1919enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type - 1920 Select the algorithm for the Chroma Spatial Filter (default 1921 ``1D_HOR``). Possible values are: 1922 1923.. raw:: latex 1924 1925 \footnotesize 1926 1927.. tabularcolumns:: |p{11.0cm}|p{6.5cm}| 1928 1929.. flat-table:: 1930 :header-rows: 0 1931 :stub-columns: 0 1932 1933 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF`` 1934 - No filter 1935 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR`` 1936 - One-dimensional horizontal 1937 1938.. raw:: latex 1939 1940 \normalsize 1941 1942.. _v4l2-mpeg-cx2341x-video-temporal-filter-mode: 1943 1944``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE`` 1945 (enum) 1946 1947enum v4l2_mpeg_cx2341x_video_temporal_filter_mode - 1948 Sets the Temporal Filter mode (default ``MANUAL``). Possible values 1949 are: 1950 1951.. raw:: latex 1952 1953 \footnotesize 1954 1955.. flat-table:: 1956 :header-rows: 0 1957 :stub-columns: 0 1958 1959 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL`` 1960 - Choose the filter manually 1961 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO`` 1962 - Choose the filter automatically 1963 1964.. raw:: latex 1965 1966 \normalsize 1967 1968``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (integer (0-31))`` 1969 The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default 1970 is 8 for full-scale capturing and 0 for scaled capturing.) 1971 1972.. _v4l2-mpeg-cx2341x-video-median-filter-type: 1973 1974``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE`` 1975 (enum) 1976 1977enum v4l2_mpeg_cx2341x_video_median_filter_type - 1978 Median Filter Type (default ``OFF``). Possible values are: 1979 1980 1981.. raw:: latex 1982 1983 \small 1984 1985.. tabularcolumns:: |p{11.0cm}|p{6.5cm}| 1986 1987.. flat-table:: 1988 :header-rows: 0 1989 :stub-columns: 0 1990 1991 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF`` 1992 - No filter 1993 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR`` 1994 - Horizontal filter 1995 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT`` 1996 - Vertical filter 1997 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT`` 1998 - Horizontal and vertical filter 1999 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG`` 2000 - Diagonal filter 2001 2002.. raw:: latex 2003 2004 \normalsize 2005 2006``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 2007 Threshold above which the luminance median filter is enabled 2008 (default 0) 2009 2010``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (integer (0-255))`` 2011 Threshold below which the luminance median filter is enabled 2012 (default 255) 2013 2014``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 2015 Threshold above which the chroma median filter is enabled (default 2016 0) 2017 2018``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (integer (0-255))`` 2019 Threshold below which the chroma median filter is enabled (default 2020 255) 2021 2022``V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (boolean)`` 2023 The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into 2024 the stream between every four video frames. The packet size is 2048 2025 bytes, including the packet_start_code_prefix and stream_id 2026 fields. The stream_id is 0xBF (private stream 2). The payload 2027 consists of 0x00 bytes, to be filled in by the application. 0 = do 2028 not insert, 1 = insert packets. 2029 2030 2031VPX Control Reference 2032===================== 2033 2034The VPX controls include controls for encoding parameters of VPx video 2035codec. 2036 2037 2038.. _vpx-control-id: 2039 2040VPX Control IDs 2041--------------- 2042 2043.. _v4l2-vpx-num-partitions: 2044 2045``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS`` 2046 (enum) 2047 2048enum v4l2_vp8_num_partitions - 2049 The number of token partitions to use in VP8 encoder. Possible 2050 values are: 2051 2052 2053 2054.. flat-table:: 2055 :header-rows: 0 2056 :stub-columns: 0 2057 2058 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION`` 2059 - 1 coefficient partition 2060 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS`` 2061 - 2 coefficient partitions 2062 * - ``V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS`` 2063 - 4 coefficient partitions 2064 * - ``V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS`` 2065 - 8 coefficient partitions 2066 2067 2068 2069``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)`` 2070 Setting this prevents intra 4x4 mode in the intra mode decision. 2071 2072.. _v4l2-vpx-num-ref-frames: 2073 2074``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES`` 2075 (enum) 2076 2077enum v4l2_vp8_num_ref_frames - 2078 The number of reference pictures for encoding P frames. Possible 2079 values are: 2080 2081.. tabularcolumns:: |p{7.5cm}|p{7.5cm}| 2082 2083.. raw:: latex 2084 2085 \small 2086 2087.. flat-table:: 2088 :header-rows: 0 2089 :stub-columns: 0 2090 2091 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME`` 2092 - Last encoded frame will be searched 2093 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME`` 2094 - Two frames will be searched among the last encoded frame, the 2095 golden frame and the alternate reference (altref) frame. The 2096 encoder implementation will decide which two are chosen. 2097 * - ``V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME`` 2098 - The last encoded frame, the golden frame and the altref frame will 2099 be searched. 2100 2101.. raw:: latex 2102 2103 \normalsize 2104 2105 2106 2107``V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL (integer)`` 2108 Indicates the loop filter level. The adjustment of the loop filter 2109 level is done via a delta value against a baseline loop filter 2110 value. 2111 2112``V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS (integer)`` 2113 This parameter affects the loop filter. Anything above zero weakens 2114 the deblocking effect on the loop filter. 2115 2116``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD (integer)`` 2117 Sets the refresh period for the golden frame. The period is defined 2118 in number of frames. For a value of 'n', every nth frame starting 2119 from the first key frame will be taken as a golden frame. For eg. 2120 for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden 2121 frame refresh period is set as 4, the frames 0, 4, 8 etc will be 2122 taken as the golden frames as frame 0 is always a key frame. 2123 2124.. _v4l2-vpx-golden-frame-sel: 2125 2126``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL`` 2127 (enum) 2128 2129enum v4l2_vp8_golden_frame_sel - 2130 Selects the golden frame for encoding. Possible values are: 2131 2132.. raw:: latex 2133 2134 \scriptsize 2135 2136.. tabularcolumns:: |p{8.6cm}|p{8.9cm}| 2137 2138.. flat-table:: 2139 :header-rows: 0 2140 :stub-columns: 0 2141 2142 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV`` 2143 - Use the (n-2)th frame as a golden frame, current frame index being 2144 'n'. 2145 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD`` 2146 - Use the previous specific frame indicated by 2147 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD`` as a 2148 golden frame. 2149 2150.. raw:: latex 2151 2152 \normalsize 2153 2154 2155``V4L2_CID_MPEG_VIDEO_VPX_MIN_QP (integer)`` 2156 Minimum quantization parameter for VP8. 2157 2158``V4L2_CID_MPEG_VIDEO_VPX_MAX_QP (integer)`` 2159 Maximum quantization parameter for VP8. 2160 2161``V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP (integer)`` 2162 Quantization parameter for an I frame for VP8. 2163 2164``V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP (integer)`` 2165 Quantization parameter for a P frame for VP8. 2166 2167.. _v4l2-mpeg-video-vp8-profile: 2168 2169``V4L2_CID_MPEG_VIDEO_VP8_PROFILE`` 2170 (enum) 2171 2172enum v4l2_mpeg_video_vp8_profile - 2173 This control allows selecting the profile for VP8 encoder. 2174 This is also used to enumerate supported profiles by VP8 encoder or decoder. 2175 Possible values are: 2176 2177.. flat-table:: 2178 :header-rows: 0 2179 :stub-columns: 0 2180 2181 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_0`` 2182 - Profile 0 2183 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_1`` 2184 - Profile 1 2185 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_2`` 2186 - Profile 2 2187 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_3`` 2188 - Profile 3 2189 2190.. _v4l2-mpeg-video-vp9-profile: 2191 2192``V4L2_CID_MPEG_VIDEO_VP9_PROFILE`` 2193 (enum) 2194 2195enum v4l2_mpeg_video_vp9_profile - 2196 This control allows selecting the profile for VP9 encoder. 2197 This is also used to enumerate supported profiles by VP9 encoder or decoder. 2198 Possible values are: 2199 2200.. flat-table:: 2201 :header-rows: 0 2202 :stub-columns: 0 2203 2204 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_0`` 2205 - Profile 0 2206 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_1`` 2207 - Profile 1 2208 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_2`` 2209 - Profile 2 2210 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_3`` 2211 - Profile 3 2212 2213.. _v4l2-mpeg-video-vp9-level: 2214 2215``V4L2_CID_MPEG_VIDEO_VP9_LEVEL (enum)`` 2216 2217enum v4l2_mpeg_video_vp9_level - 2218 This control allows selecting the level for VP9 encoder. 2219 This is also used to enumerate supported levels by VP9 encoder or decoder. 2220 More information can be found at 2221 `webmproject <https://www.webmproject.org/vp9/levels/>`__. Possible values are: 2222 2223.. flat-table:: 2224 :header-rows: 0 2225 :stub-columns: 0 2226 2227 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_1_0`` 2228 - Level 1 2229 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_1_1`` 2230 - Level 1.1 2231 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_2_0`` 2232 - Level 2 2233 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_2_1`` 2234 - Level 2.1 2235 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_3_0`` 2236 - Level 3 2237 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_3_1`` 2238 - Level 3.1 2239 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_4_0`` 2240 - Level 4 2241 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_4_1`` 2242 - Level 4.1 2243 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_0`` 2244 - Level 5 2245 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_1`` 2246 - Level 5.1 2247 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_5_2`` 2248 - Level 5.2 2249 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_0`` 2250 - Level 6 2251 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_1`` 2252 - Level 6.1 2253 * - ``V4L2_MPEG_VIDEO_VP9_LEVEL_6_2`` 2254 - Level 6.2 2255 2256 2257High Efficiency Video Coding (HEVC/H.265) Control Reference 2258=========================================================== 2259 2260The HEVC/H.265 controls include controls for encoding parameters of HEVC/H.265 2261video codec. 2262 2263 2264.. _hevc-control-id: 2265 2266HEVC/H.265 Control IDs 2267---------------------- 2268 2269``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP (integer)`` 2270 Minimum quantization parameter for HEVC. 2271 Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2272 2273``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP (integer)`` 2274 Maximum quantization parameter for HEVC. 2275 Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2276 2277``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP (integer)`` 2278 Quantization parameter for an I frame for HEVC. 2279 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2280 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2281 2282``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP (integer)`` 2283 Quantization parameter for a P frame for HEVC. 2284 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2285 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2286 2287``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP (integer)`` 2288 Quantization parameter for a B frame for HEVC. 2289 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2290 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2291 2292``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_MIN_QP (integer)`` 2293 Minimum quantization parameter for the HEVC I frame to limit I frame 2294 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2295 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter 2296 should be chosen to meet both requirements. 2297 2298``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_MAX_QP (integer)`` 2299 Maximum quantization parameter for the HEVC I frame to limit I frame 2300 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2301 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter 2302 should be chosen to meet both requirements. 2303 2304``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_MIN_QP (integer)`` 2305 Minimum quantization parameter for the HEVC P frame to limit P frame 2306 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2307 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter 2308 should be chosen to meet both requirements. 2309 2310``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_MAX_QP (integer)`` 2311 Maximum quantization parameter for the HEVC P frame to limit P frame 2312 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2313 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter 2314 should be chosen to meet both requirements. 2315 2316``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_MIN_QP (integer)`` 2317 Minimum quantization parameter for the HEVC B frame to limit B frame 2318 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2319 If V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP is also set, the quantization parameter 2320 should be chosen to meet both requirements. 2321 2322``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_MAX_QP (integer)`` 2323 Maximum quantization parameter for the HEVC B frame to limit B frame 2324 quality to a range. Valid range: from 0 to 51 for 8 bit and from 0 to 63 for 10 bit. 2325 If V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP is also set, the quantization parameter 2326 should be chosen to meet both requirements. 2327 2328``V4L2_CID_MPEG_VIDEO_HEVC_HIER_QP (boolean)`` 2329 HIERARCHICAL_QP allows the host to specify the quantization parameter 2330 values for each temporal layer through HIERARCHICAL_QP_LAYER. This is 2331 valid only if HIERARCHICAL_CODING_LAYER is greater than 1. Setting the 2332 control value to 1 enables setting of the QP values for the layers. 2333 2334.. _v4l2-hevc-hier-coding-type: 2335 2336``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_TYPE`` 2337 (enum) 2338 2339enum v4l2_mpeg_video_hevc_hier_coding_type - 2340 Selects the hierarchical coding type for encoding. Possible values are: 2341 2342.. raw:: latex 2343 2344 \footnotesize 2345 2346.. tabularcolumns:: |p{8.2cm}|p{9.3cm}| 2347 2348.. flat-table:: 2349 :header-rows: 0 2350 :stub-columns: 0 2351 2352 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B`` 2353 - Use the B frame for hierarchical coding. 2354 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P`` 2355 - Use the P frame for hierarchical coding. 2356 2357.. raw:: latex 2358 2359 \normalsize 2360 2361 2362``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER (integer)`` 2363 Selects the hierarchical coding layer. In normal encoding 2364 (non-hierarchial coding), it should be zero. Possible values are [0, 6]. 2365 0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING 2366 LAYER 1 and so on. 2367 2368``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_QP (integer)`` 2369 Indicates quantization parameter for hierarchical coding layer 0. 2370 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2371 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2372 2373``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_QP (integer)`` 2374 Indicates quantization parameter for hierarchical coding layer 1. 2375 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2376 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2377 2378``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_QP (integer)`` 2379 Indicates quantization parameter for hierarchical coding layer 2. 2380 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2381 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2382 2383``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_QP (integer)`` 2384 Indicates quantization parameter for hierarchical coding layer 3. 2385 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2386 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2387 2388``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_QP (integer)`` 2389 Indicates quantization parameter for hierarchical coding layer 4. 2390 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2391 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2392 2393``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_QP (integer)`` 2394 Indicates quantization parameter for hierarchical coding layer 5. 2395 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2396 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2397 2398``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_QP (integer)`` 2399 Indicates quantization parameter for hierarchical coding layer 6. 2400 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 2401 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 2402 2403.. _v4l2-hevc-profile: 2404 2405``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE`` 2406 (enum) 2407 2408enum v4l2_mpeg_video_hevc_profile - 2409 Select the desired profile for HEVC encoder. 2410 2411.. raw:: latex 2412 2413 \footnotesize 2414 2415.. tabularcolumns:: |p{9.0cm}|p{8.5cm}| 2416 2417.. flat-table:: 2418 :header-rows: 0 2419 :stub-columns: 0 2420 2421 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN`` 2422 - Main profile. 2423 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE`` 2424 - Main still picture profile. 2425 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_10`` 2426 - Main 10 profile. 2427 2428.. raw:: latex 2429 2430 \normalsize 2431 2432 2433.. _v4l2-hevc-level: 2434 2435``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL`` 2436 (enum) 2437 2438enum v4l2_mpeg_video_hevc_level - 2439 Selects the desired level for HEVC encoder. 2440 2441================================== ========= 2442``V4L2_MPEG_VIDEO_HEVC_LEVEL_1`` Level 1.0 2443``V4L2_MPEG_VIDEO_HEVC_LEVEL_2`` Level 2.0 2444``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1`` Level 2.1 2445``V4L2_MPEG_VIDEO_HEVC_LEVEL_3`` Level 3.0 2446``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1`` Level 3.1 2447``V4L2_MPEG_VIDEO_HEVC_LEVEL_4`` Level 4.0 2448``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1`` Level 4.1 2449``V4L2_MPEG_VIDEO_HEVC_LEVEL_5`` Level 5.0 2450``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1`` Level 5.1 2451``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2`` Level 5.2 2452``V4L2_MPEG_VIDEO_HEVC_LEVEL_6`` Level 6.0 2453``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1`` Level 6.1 2454``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2`` Level 6.2 2455================================== ========= 2456 2457``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION (integer)`` 2458 Indicates the number of evenly spaced subintervals, called ticks, within 2459 one second. This is a 16 bit unsigned integer and has a maximum value up to 2460 0xffff and a minimum value of 1. 2461 2462.. _v4l2-hevc-tier: 2463 2464``V4L2_CID_MPEG_VIDEO_HEVC_TIER`` 2465 (enum) 2466 2467enum v4l2_mpeg_video_hevc_tier - 2468 TIER_FLAG specifies tiers information of the HEVC encoded picture. Tier 2469 were made to deal with applications that differ in terms of maximum bit 2470 rate. Setting the flag to 0 selects HEVC tier as Main tier and setting 2471 this flag to 1 indicates High tier. High tier is for applications requiring 2472 high bit rates. 2473 2474================================== ========== 2475``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN`` Main tier. 2476``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH`` High tier. 2477================================== ========== 2478 2479 2480``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH (integer)`` 2481 Selects HEVC maximum coding unit depth. 2482 2483.. _v4l2-hevc-loop-filter-mode: 2484 2485``V4L2_CID_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE`` 2486 (enum) 2487 2488enum v4l2_mpeg_video_hevc_loop_filter_mode - 2489 Loop filter mode for HEVC encoder. Possible values are: 2490 2491.. raw:: latex 2492 2493 \footnotesize 2494 2495.. tabularcolumns:: |p{12.1cm}|p{5.4cm}| 2496 2497.. flat-table:: 2498 :header-rows: 0 2499 :stub-columns: 0 2500 2501 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED`` 2502 - Loop filter is disabled. 2503 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_ENABLED`` 2504 - Loop filter is enabled. 2505 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY`` 2506 - Loop filter is disabled at the slice boundary. 2507 2508.. raw:: latex 2509 2510 \normalsize 2511 2512 2513``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2 (integer)`` 2514 Selects HEVC loop filter beta offset. The valid range is [-6, +6]. 2515 2516``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2 (integer)`` 2517 Selects HEVC loop filter tc offset. The valid range is [-6, +6]. 2518 2519.. _v4l2-hevc-refresh-type: 2520 2521``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE`` 2522 (enum) 2523 2524enum v4l2_mpeg_video_hevc_hier_refresh_type - 2525 Selects refresh type for HEVC encoder. 2526 Host has to specify the period into 2527 V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD. 2528 2529.. raw:: latex 2530 2531 \footnotesize 2532 2533.. tabularcolumns:: |p{6.2cm}|p{11.3cm}| 2534 2535.. flat-table:: 2536 :header-rows: 0 2537 :stub-columns: 0 2538 2539 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE`` 2540 - Use the B frame for hierarchical coding. 2541 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA`` 2542 - Use CRA (Clean Random Access Unit) picture encoding. 2543 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR`` 2544 - Use IDR (Instantaneous Decoding Refresh) picture encoding. 2545 2546.. raw:: latex 2547 2548 \normalsize 2549 2550 2551``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD (integer)`` 2552 Selects the refresh period for HEVC encoder. 2553 This specifies the number of I pictures between two CRA/IDR pictures. 2554 This is valid only if REFRESH_TYPE is not 0. 2555 2556``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU (boolean)`` 2557 Indicates HEVC lossless encoding. Setting it to 0 disables lossless 2558 encoding. Setting it to 1 enables lossless encoding. 2559 2560``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED (boolean)`` 2561 Indicates constant intra prediction for HEVC encoder. Specifies the 2562 constrained intra prediction in which intra largest coding unit (LCU) 2563 prediction is performed by using residual data and decoded samples of 2564 neighboring intra LCU only. Setting the value to 1 enables constant intra 2565 prediction and setting the value to 0 disables constant intra prediction. 2566 2567``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT (boolean)`` 2568 Indicates wavefront parallel processing for HEVC encoder. Setting it to 0 2569 disables the feature and setting it to 1 enables the wavefront parallel 2570 processing. 2571 2572``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB (boolean)`` 2573 Setting the value to 1 enables combination of P and B frame for HEVC 2574 encoder. 2575 2576``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID (boolean)`` 2577 Indicates temporal identifier for HEVC encoder which is enabled by 2578 setting the value to 1. 2579 2580``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING (boolean)`` 2581 Indicates bi-linear interpolation is conditionally used in the intra 2582 prediction filtering process in the CVS when set to 1. Indicates bi-linear 2583 interpolation is not used in the CVS when set to 0. 2584 2585``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1 (integer)`` 2586 Indicates maximum number of merge candidate motion vectors. 2587 Values are from 0 to 4. 2588 2589``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION (boolean)`` 2590 Indicates temporal motion vector prediction for HEVC encoder. Setting it to 2591 1 enables the prediction. Setting it to 0 disables the prediction. 2592 2593``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE (boolean)`` 2594 Specifies if HEVC generates a stream with a size of the length field 2595 instead of start code pattern. The size of the length field is configurable 2596 through the V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD control. Setting 2597 the value to 0 disables encoding without startcode pattern. Setting the 2598 value to 1 will enables encoding without startcode pattern. 2599 2600.. _v4l2-hevc-size-of-length-field: 2601 2602``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD`` 2603(enum) 2604 2605enum v4l2_mpeg_video_hevc_size_of_length_field - 2606 Indicates the size of length field. 2607 This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled. 2608 2609.. raw:: latex 2610 2611 \footnotesize 2612 2613.. tabularcolumns:: |p{5.5cm}|p{12.0cm}| 2614 2615.. flat-table:: 2616 :header-rows: 0 2617 :stub-columns: 0 2618 2619 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0`` 2620 - Generate start code pattern (Normal). 2621 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1`` 2622 - Generate size of length field instead of start code pattern and length is 1. 2623 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2`` 2624 - Generate size of length field instead of start code pattern and length is 2. 2625 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4`` 2626 - Generate size of length field instead of start code pattern and length is 4. 2627 2628.. raw:: latex 2629 2630 \normalsize 2631 2632``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_BR (integer)`` 2633 Indicates bit rate for hierarchical coding layer 0 for HEVC encoder. 2634 2635``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_BR (integer)`` 2636 Indicates bit rate for hierarchical coding layer 1 for HEVC encoder. 2637 2638``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_BR (integer)`` 2639 Indicates bit rate for hierarchical coding layer 2 for HEVC encoder. 2640 2641``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_BR (integer)`` 2642 Indicates bit rate for hierarchical coding layer 3 for HEVC encoder. 2643 2644``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_BR (integer)`` 2645 Indicates bit rate for hierarchical coding layer 4 for HEVC encoder. 2646 2647``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_BR (integer)`` 2648 Indicates bit rate for hierarchical coding layer 5 for HEVC encoder. 2649 2650``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_BR (integer)`` 2651 Indicates bit rate for hierarchical coding layer 6 for HEVC encoder. 2652 2653``V4L2_CID_MPEG_VIDEO_REF_NUMBER_FOR_PFRAMES (integer)`` 2654 Selects number of P reference pictures required for HEVC encoder. 2655 P-Frame can use 1 or 2 frames for reference. 2656 2657``V4L2_CID_MPEG_VIDEO_PREPEND_SPSPPS_TO_IDR (integer)`` 2658 Indicates whether to generate SPS and PPS at every IDR. Setting it to 0 2659 disables generating SPS and PPS at every IDR. Setting it to one enables 2660 generating SPS and PPS at every IDR. 2661