1.. Permission is granted to copy, distribute and/or modify this 2.. document under the terms of the GNU Free Documentation License, 3.. Version 1.1 or any later version published by the Free Software 4.. Foundation, with no Invariant Sections, no Front-Cover Texts 5.. and no Back-Cover Texts. A copy of the license is included at 6.. Documentation/media/uapi/fdl-appendix.rst. 7.. 8.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections 9 10.. _mpeg-controls: 11 12*********************** 13Codec Control Reference 14*********************** 15 16Below all controls within the Codec control class are described. First 17the generic controls, then controls specific for certain hardware. 18 19.. note:: 20 21 These controls are applicable to all codecs and not just MPEG. The 22 defines are prefixed with V4L2_CID_MPEG/V4L2_MPEG as the controls 23 were originally made for MPEG codecs and later extended to cover all 24 encoding formats. 25 26 27Generic Codec Controls 28====================== 29 30 31.. _mpeg-control-id: 32 33Codec Control IDs 34----------------- 35 36``V4L2_CID_MPEG_CLASS (class)`` 37 The Codec class descriptor. Calling 38 :ref:`VIDIOC_QUERYCTRL` for this control will 39 return a description of this control class. This description can be 40 used as the caption of a Tab page in a GUI, for example. 41 42.. _v4l2-mpeg-stream-type: 43 44``V4L2_CID_MPEG_STREAM_TYPE`` 45 (enum) 46 47enum v4l2_mpeg_stream_type - 48 The MPEG-1, -2 or -4 output stream type. One cannot assume anything 49 here. Each hardware MPEG encoder tends to support different subsets 50 of the available MPEG stream types. This control is specific to 51 multiplexed MPEG streams. The currently defined stream types are: 52 53 54 55.. flat-table:: 56 :header-rows: 0 57 :stub-columns: 0 58 59 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_PS`` 60 - MPEG-2 program stream 61 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_TS`` 62 - MPEG-2 transport stream 63 * - ``V4L2_MPEG_STREAM_TYPE_MPEG1_SS`` 64 - MPEG-1 system stream 65 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_DVD`` 66 - MPEG-2 DVD-compatible stream 67 * - ``V4L2_MPEG_STREAM_TYPE_MPEG1_VCD`` 68 - MPEG-1 VCD-compatible stream 69 * - ``V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD`` 70 - MPEG-2 SVCD-compatible stream 71 72 73 74``V4L2_CID_MPEG_STREAM_PID_PMT (integer)`` 75 Program Map Table Packet ID for the MPEG transport stream (default 76 16) 77 78``V4L2_CID_MPEG_STREAM_PID_AUDIO (integer)`` 79 Audio Packet ID for the MPEG transport stream (default 256) 80 81``V4L2_CID_MPEG_STREAM_PID_VIDEO (integer)`` 82 Video Packet ID for the MPEG transport stream (default 260) 83 84``V4L2_CID_MPEG_STREAM_PID_PCR (integer)`` 85 Packet ID for the MPEG transport stream carrying PCR fields (default 86 259) 87 88``V4L2_CID_MPEG_STREAM_PES_ID_AUDIO (integer)`` 89 Audio ID for MPEG PES 90 91``V4L2_CID_MPEG_STREAM_PES_ID_VIDEO (integer)`` 92 Video ID for MPEG PES 93 94.. _v4l2-mpeg-stream-vbi-fmt: 95 96``V4L2_CID_MPEG_STREAM_VBI_FMT`` 97 (enum) 98 99enum v4l2_mpeg_stream_vbi_fmt - 100 Some cards can embed VBI data (e. g. Closed Caption, Teletext) into 101 the MPEG stream. This control selects whether VBI data should be 102 embedded, and if so, what embedding method should be used. The list 103 of possible VBI formats depends on the driver. The currently defined 104 VBI format types are: 105 106 107 108.. tabularcolumns:: |p{6.6 cm}|p{10.9cm}| 109 110.. flat-table:: 111 :header-rows: 0 112 :stub-columns: 0 113 114 * - ``V4L2_MPEG_STREAM_VBI_FMT_NONE`` 115 - No VBI in the MPEG stream 116 * - ``V4L2_MPEG_STREAM_VBI_FMT_IVTV`` 117 - VBI in private packets, IVTV format (documented in the kernel 118 sources in the file 119 ``Documentation/media/v4l-drivers/cx2341x.rst``) 120 121 122 123.. _v4l2-mpeg-audio-sampling-freq: 124 125``V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ`` 126 (enum) 127 128enum v4l2_mpeg_audio_sampling_freq - 129 MPEG Audio sampling frequency. Possible values are: 130 131 132 133.. flat-table:: 134 :header-rows: 0 135 :stub-columns: 0 136 137 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100`` 138 - 44.1 kHz 139 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000`` 140 - 48 kHz 141 * - ``V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000`` 142 - 32 kHz 143 144 145 146.. _v4l2-mpeg-audio-encoding: 147 148``V4L2_CID_MPEG_AUDIO_ENCODING`` 149 (enum) 150 151enum v4l2_mpeg_audio_encoding - 152 MPEG Audio encoding. This control is specific to multiplexed MPEG 153 streams. Possible values are: 154 155 156 157.. flat-table:: 158 :header-rows: 0 159 :stub-columns: 0 160 161 * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_1`` 162 - MPEG-1/2 Layer I encoding 163 * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_2`` 164 - MPEG-1/2 Layer II encoding 165 * - ``V4L2_MPEG_AUDIO_ENCODING_LAYER_3`` 166 - MPEG-1/2 Layer III encoding 167 * - ``V4L2_MPEG_AUDIO_ENCODING_AAC`` 168 - MPEG-2/4 AAC (Advanced Audio Coding) 169 * - ``V4L2_MPEG_AUDIO_ENCODING_AC3`` 170 - AC-3 aka ATSC A/52 encoding 171 172 173 174.. _v4l2-mpeg-audio-l1-bitrate: 175 176``V4L2_CID_MPEG_AUDIO_L1_BITRATE`` 177 (enum) 178 179enum v4l2_mpeg_audio_l1_bitrate - 180 MPEG-1/2 Layer I bitrate. Possible values are: 181 182 183 184.. flat-table:: 185 :header-rows: 0 186 :stub-columns: 0 187 188 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_32K`` 189 - 32 kbit/s 190 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_64K`` 191 - 64 kbit/s 192 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_96K`` 193 - 96 kbit/s 194 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_128K`` 195 - 128 kbit/s 196 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_160K`` 197 - 160 kbit/s 198 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_192K`` 199 - 192 kbit/s 200 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_224K`` 201 - 224 kbit/s 202 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_256K`` 203 - 256 kbit/s 204 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_288K`` 205 - 288 kbit/s 206 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_320K`` 207 - 320 kbit/s 208 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_352K`` 209 - 352 kbit/s 210 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_384K`` 211 - 384 kbit/s 212 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_416K`` 213 - 416 kbit/s 214 * - ``V4L2_MPEG_AUDIO_L1_BITRATE_448K`` 215 - 448 kbit/s 216 217 218 219.. _v4l2-mpeg-audio-l2-bitrate: 220 221``V4L2_CID_MPEG_AUDIO_L2_BITRATE`` 222 (enum) 223 224enum v4l2_mpeg_audio_l2_bitrate - 225 MPEG-1/2 Layer II bitrate. Possible values are: 226 227 228 229.. flat-table:: 230 :header-rows: 0 231 :stub-columns: 0 232 233 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_32K`` 234 - 32 kbit/s 235 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_48K`` 236 - 48 kbit/s 237 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_56K`` 238 - 56 kbit/s 239 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_64K`` 240 - 64 kbit/s 241 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_80K`` 242 - 80 kbit/s 243 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_96K`` 244 - 96 kbit/s 245 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_112K`` 246 - 112 kbit/s 247 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_128K`` 248 - 128 kbit/s 249 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_160K`` 250 - 160 kbit/s 251 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_192K`` 252 - 192 kbit/s 253 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_224K`` 254 - 224 kbit/s 255 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_256K`` 256 - 256 kbit/s 257 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_320K`` 258 - 320 kbit/s 259 * - ``V4L2_MPEG_AUDIO_L2_BITRATE_384K`` 260 - 384 kbit/s 261 262 263 264.. _v4l2-mpeg-audio-l3-bitrate: 265 266``V4L2_CID_MPEG_AUDIO_L3_BITRATE`` 267 (enum) 268 269enum v4l2_mpeg_audio_l3_bitrate - 270 MPEG-1/2 Layer III bitrate. Possible values are: 271 272 273 274.. flat-table:: 275 :header-rows: 0 276 :stub-columns: 0 277 278 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_32K`` 279 - 32 kbit/s 280 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_40K`` 281 - 40 kbit/s 282 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_48K`` 283 - 48 kbit/s 284 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_56K`` 285 - 56 kbit/s 286 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_64K`` 287 - 64 kbit/s 288 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_80K`` 289 - 80 kbit/s 290 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_96K`` 291 - 96 kbit/s 292 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_112K`` 293 - 112 kbit/s 294 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_128K`` 295 - 128 kbit/s 296 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_160K`` 297 - 160 kbit/s 298 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_192K`` 299 - 192 kbit/s 300 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_224K`` 301 - 224 kbit/s 302 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_256K`` 303 - 256 kbit/s 304 * - ``V4L2_MPEG_AUDIO_L3_BITRATE_320K`` 305 - 320 kbit/s 306 307 308 309``V4L2_CID_MPEG_AUDIO_AAC_BITRATE (integer)`` 310 AAC bitrate in bits per second. 311 312.. _v4l2-mpeg-audio-ac3-bitrate: 313 314``V4L2_CID_MPEG_AUDIO_AC3_BITRATE`` 315 (enum) 316 317enum v4l2_mpeg_audio_ac3_bitrate - 318 AC-3 bitrate. Possible values are: 319 320 321 322.. flat-table:: 323 :header-rows: 0 324 :stub-columns: 0 325 326 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_32K`` 327 - 32 kbit/s 328 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_40K`` 329 - 40 kbit/s 330 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_48K`` 331 - 48 kbit/s 332 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_56K`` 333 - 56 kbit/s 334 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_64K`` 335 - 64 kbit/s 336 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_80K`` 337 - 80 kbit/s 338 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_96K`` 339 - 96 kbit/s 340 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_112K`` 341 - 112 kbit/s 342 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_128K`` 343 - 128 kbit/s 344 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_160K`` 345 - 160 kbit/s 346 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_192K`` 347 - 192 kbit/s 348 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_224K`` 349 - 224 kbit/s 350 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_256K`` 351 - 256 kbit/s 352 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_320K`` 353 - 320 kbit/s 354 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_384K`` 355 - 384 kbit/s 356 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_448K`` 357 - 448 kbit/s 358 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_512K`` 359 - 512 kbit/s 360 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_576K`` 361 - 576 kbit/s 362 * - ``V4L2_MPEG_AUDIO_AC3_BITRATE_640K`` 363 - 640 kbit/s 364 365 366 367.. _v4l2-mpeg-audio-mode: 368 369``V4L2_CID_MPEG_AUDIO_MODE`` 370 (enum) 371 372enum v4l2_mpeg_audio_mode - 373 MPEG Audio mode. Possible values are: 374 375 376 377.. flat-table:: 378 :header-rows: 0 379 :stub-columns: 0 380 381 * - ``V4L2_MPEG_AUDIO_MODE_STEREO`` 382 - Stereo 383 * - ``V4L2_MPEG_AUDIO_MODE_JOINT_STEREO`` 384 - Joint Stereo 385 * - ``V4L2_MPEG_AUDIO_MODE_DUAL`` 386 - Bilingual 387 * - ``V4L2_MPEG_AUDIO_MODE_MONO`` 388 - Mono 389 390 391 392.. _v4l2-mpeg-audio-mode-extension: 393 394``V4L2_CID_MPEG_AUDIO_MODE_EXTENSION`` 395 (enum) 396 397enum v4l2_mpeg_audio_mode_extension - 398 Joint Stereo audio mode extension. In Layer I and II they indicate 399 which subbands are in intensity stereo. All other subbands are coded 400 in stereo. Layer III is not (yet) supported. Possible values are: 401 402 403 404.. flat-table:: 405 :header-rows: 0 406 :stub-columns: 0 407 408 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4`` 409 - Subbands 4-31 in intensity stereo 410 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8`` 411 - Subbands 8-31 in intensity stereo 412 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12`` 413 - Subbands 12-31 in intensity stereo 414 * - ``V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16`` 415 - Subbands 16-31 in intensity stereo 416 417 418 419.. _v4l2-mpeg-audio-emphasis: 420 421``V4L2_CID_MPEG_AUDIO_EMPHASIS`` 422 (enum) 423 424enum v4l2_mpeg_audio_emphasis - 425 Audio Emphasis. Possible values are: 426 427 428 429.. flat-table:: 430 :header-rows: 0 431 :stub-columns: 0 432 433 * - ``V4L2_MPEG_AUDIO_EMPHASIS_NONE`` 434 - None 435 * - ``V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS`` 436 - 50/15 microsecond emphasis 437 * - ``V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17`` 438 - CCITT J.17 439 440 441 442.. _v4l2-mpeg-audio-crc: 443 444``V4L2_CID_MPEG_AUDIO_CRC`` 445 (enum) 446 447enum v4l2_mpeg_audio_crc - 448 CRC method. Possible values are: 449 450 451 452.. flat-table:: 453 :header-rows: 0 454 :stub-columns: 0 455 456 * - ``V4L2_MPEG_AUDIO_CRC_NONE`` 457 - None 458 * - ``V4L2_MPEG_AUDIO_CRC_CRC16`` 459 - 16 bit parity check 460 461 462 463``V4L2_CID_MPEG_AUDIO_MUTE (boolean)`` 464 Mutes the audio when capturing. This is not done by muting audio 465 hardware, which can still produce a slight hiss, but in the encoder 466 itself, guaranteeing a fixed and reproducible audio bitstream. 0 = 467 unmuted, 1 = muted. 468 469.. _v4l2-mpeg-audio-dec-playback: 470 471``V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK`` 472 (enum) 473 474enum v4l2_mpeg_audio_dec_playback - 475 Determines how monolingual audio should be played back. Possible 476 values are: 477 478 479 480.. tabularcolumns:: |p{9.8cm}|p{7.7cm}| 481 482.. flat-table:: 483 :header-rows: 0 484 :stub-columns: 0 485 486 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO`` 487 - Automatically determines the best playback mode. 488 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO`` 489 - Stereo playback. 490 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_LEFT`` 491 - Left channel playback. 492 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_RIGHT`` 493 - Right channel playback. 494 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_MONO`` 495 - Mono playback. 496 * - ``V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO`` 497 - Stereo playback with swapped left and right channels. 498 499 500 501.. _v4l2-mpeg-audio-dec-multilingual-playback: 502 503``V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK`` 504 (enum) 505 506enum v4l2_mpeg_audio_dec_playback - 507 Determines how multilingual audio should be played back. 508 509.. _v4l2-mpeg-video-encoding: 510 511``V4L2_CID_MPEG_VIDEO_ENCODING`` 512 (enum) 513 514enum v4l2_mpeg_video_encoding - 515 MPEG Video encoding method. This control is specific to multiplexed 516 MPEG streams. Possible values are: 517 518 519 520.. flat-table:: 521 :header-rows: 0 522 :stub-columns: 0 523 524 * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_1`` 525 - MPEG-1 Video encoding 526 * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_2`` 527 - MPEG-2 Video encoding 528 * - ``V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC`` 529 - MPEG-4 AVC (H.264) Video encoding 530 531 532 533.. _v4l2-mpeg-video-aspect: 534 535``V4L2_CID_MPEG_VIDEO_ASPECT`` 536 (enum) 537 538enum v4l2_mpeg_video_aspect - 539 Video aspect. Possible values are: 540 541 542 543.. flat-table:: 544 :header-rows: 0 545 :stub-columns: 0 546 547 * - ``V4L2_MPEG_VIDEO_ASPECT_1x1`` 548 * - ``V4L2_MPEG_VIDEO_ASPECT_4x3`` 549 * - ``V4L2_MPEG_VIDEO_ASPECT_16x9`` 550 * - ``V4L2_MPEG_VIDEO_ASPECT_221x100`` 551 552 553 554``V4L2_CID_MPEG_VIDEO_B_FRAMES (integer)`` 555 Number of B-Frames (default 2) 556 557``V4L2_CID_MPEG_VIDEO_GOP_SIZE (integer)`` 558 GOP size (default 12) 559 560``V4L2_CID_MPEG_VIDEO_GOP_CLOSURE (boolean)`` 561 GOP closure (default 1) 562 563``V4L2_CID_MPEG_VIDEO_PULLDOWN (boolean)`` 564 Enable 3:2 pulldown (default 0) 565 566.. _v4l2-mpeg-video-bitrate-mode: 567 568``V4L2_CID_MPEG_VIDEO_BITRATE_MODE`` 569 (enum) 570 571enum v4l2_mpeg_video_bitrate_mode - 572 Video bitrate mode. Possible values are: 573 574 575 576.. flat-table:: 577 :header-rows: 0 578 :stub-columns: 0 579 580 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_VBR`` 581 - Variable bitrate 582 * - ``V4L2_MPEG_VIDEO_BITRATE_MODE_CBR`` 583 - Constant bitrate 584 585 586 587``V4L2_CID_MPEG_VIDEO_BITRATE (integer)`` 588 Video bitrate in bits per second. 589 590``V4L2_CID_MPEG_VIDEO_BITRATE_PEAK (integer)`` 591 Peak video bitrate in bits per second. Must be larger or equal to 592 the average video bitrate. It is ignored if the video bitrate mode 593 is set to constant bitrate. 594 595``V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION (integer)`` 596 For every captured frame, skip this many subsequent frames (default 597 0). 598 599``V4L2_CID_MPEG_VIDEO_MUTE (boolean)`` 600 "Mutes" the video to a fixed color when capturing. This is useful 601 for testing, to produce a fixed video bitstream. 0 = unmuted, 1 = 602 muted. 603 604``V4L2_CID_MPEG_VIDEO_MUTE_YUV (integer)`` 605 Sets the "mute" color of the video. The supplied 32-bit integer is 606 interpreted as follows (bit 0 = least significant bit): 607 608 609 610.. flat-table:: 611 :header-rows: 0 612 :stub-columns: 0 613 614 * - Bit 0:7 615 - V chrominance information 616 * - Bit 8:15 617 - U chrominance information 618 * - Bit 16:23 619 - Y luminance information 620 * - Bit 24:31 621 - Must be zero. 622 623 624 625.. _v4l2-mpeg-video-dec-pts: 626 627``V4L2_CID_MPEG_VIDEO_DEC_PTS (integer64)`` 628 This read-only control returns the 33-bit video Presentation Time 629 Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of the 630 currently displayed frame. This is the same PTS as is used in 631 :ref:`VIDIOC_DECODER_CMD`. 632 633.. _v4l2-mpeg-video-dec-frame: 634 635``V4L2_CID_MPEG_VIDEO_DEC_FRAME (integer64)`` 636 This read-only control returns the frame counter of the frame that 637 is currently displayed (decoded). This value is reset to 0 whenever 638 the decoder is started. 639 640``V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE (boolean)`` 641 If enabled the decoder expects to receive a single slice per buffer, 642 otherwise the decoder expects a single frame in per buffer. 643 Applicable to the decoder, all codecs. 644 645``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE (boolean)`` 646 Enable writing sample aspect ratio in the Video Usability 647 Information. Applicable to the H264 encoder. 648 649.. _v4l2-mpeg-video-h264-vui-sar-idc: 650 651``V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC`` 652 (enum) 653 654enum v4l2_mpeg_video_h264_vui_sar_idc - 655 VUI sample aspect ratio indicator for H.264 encoding. The value is 656 defined in the table E-1 in the standard. Applicable to the H264 657 encoder. 658 659 660 661.. flat-table:: 662 :header-rows: 0 663 :stub-columns: 0 664 665 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED`` 666 - Unspecified 667 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1`` 668 - 1x1 669 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11`` 670 - 12x11 671 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11`` 672 - 10x11 673 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11`` 674 - 16x11 675 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33`` 676 - 40x33 677 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11`` 678 - 24x11 679 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11`` 680 - 20x11 681 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11`` 682 - 32x11 683 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33`` 684 - 80x33 685 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11`` 686 - 18x11 687 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11`` 688 - 15x11 689 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33`` 690 - 64x33 691 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99`` 692 - 160x99 693 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3`` 694 - 4x3 695 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2`` 696 - 3x2 697 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1`` 698 - 2x1 699 * - ``V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED`` 700 - Extended SAR 701 702 703 704``V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH (integer)`` 705 Extended sample aspect ratio width for H.264 VUI encoding. 706 Applicable to the H264 encoder. 707 708``V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT (integer)`` 709 Extended sample aspect ratio height for H.264 VUI encoding. 710 Applicable to the H264 encoder. 711 712.. _v4l2-mpeg-video-h264-level: 713 714``V4L2_CID_MPEG_VIDEO_H264_LEVEL`` 715 (enum) 716 717enum v4l2_mpeg_video_h264_level - 718 The level information for the H264 video elementary stream. 719 Applicable to the H264 encoder. Possible values are: 720 721 722 723.. flat-table:: 724 :header-rows: 0 725 :stub-columns: 0 726 727 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_0`` 728 - Level 1.0 729 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1B`` 730 - Level 1B 731 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_1`` 732 - Level 1.1 733 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_2`` 734 - Level 1.2 735 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_1_3`` 736 - Level 1.3 737 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_0`` 738 - Level 2.0 739 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_1`` 740 - Level 2.1 741 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_2_2`` 742 - Level 2.2 743 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_0`` 744 - Level 3.0 745 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_1`` 746 - Level 3.1 747 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_3_2`` 748 - Level 3.2 749 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_0`` 750 - Level 4.0 751 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_1`` 752 - Level 4.1 753 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_4_2`` 754 - Level 4.2 755 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_0`` 756 - Level 5.0 757 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_1`` 758 - Level 5.1 759 760 761 762.. _v4l2-mpeg-video-mpeg2-level: 763 764``V4L2_CID_MPEG_VIDEO_MPEG2_LEVEL`` 765 (enum) 766 767enum v4l2_mpeg_video_mpeg2_level - 768 The level information for the MPEG2 elementary stream. Applicable to 769 MPEG2 codecs. Possible values are: 770 771 772 773.. flat-table:: 774 :header-rows: 0 775 :stub-columns: 0 776 777 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_LOW`` 778 - Low Level (LL) 779 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_MAIN`` 780 - Main Level (ML) 781 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH_1440`` 782 - High-1440 Level (H-14) 783 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH`` 784 - High Level (HL) 785 786 787 788.. _v4l2-mpeg-video-mpeg4-level: 789 790``V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL`` 791 (enum) 792 793enum v4l2_mpeg_video_mpeg4_level - 794 The level information for the MPEG4 elementary stream. Applicable to 795 the MPEG4 encoder. Possible values are: 796 797 798 799.. flat-table:: 800 :header-rows: 0 801 :stub-columns: 0 802 803 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0`` 804 - Level 0 805 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0B`` 806 - Level 0b 807 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_1`` 808 - Level 1 809 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_2`` 810 - Level 2 811 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3`` 812 - Level 3 813 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3B`` 814 - Level 3b 815 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_4`` 816 - Level 4 817 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_5`` 818 - Level 5 819 820 821 822.. _v4l2-mpeg-video-h264-profile: 823 824``V4L2_CID_MPEG_VIDEO_H264_PROFILE`` 825 (enum) 826 827enum v4l2_mpeg_video_h264_profile - 828 The profile information for H264. Applicable to the H264 encoder. 829 Possible values are: 830 831 832 833.. flat-table:: 834 :header-rows: 0 835 :stub-columns: 0 836 837 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE`` 838 - Baseline profile 839 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE`` 840 - Constrained Baseline profile 841 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MAIN`` 842 - Main profile 843 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED`` 844 - Extended profile 845 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH`` 846 - High profile 847 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10`` 848 - High 10 profile 849 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422`` 850 - High 422 profile 851 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE`` 852 - High 444 Predictive profile 853 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA`` 854 - High 10 Intra profile 855 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA`` 856 - High 422 Intra profile 857 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA`` 858 - High 444 Intra profile 859 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA`` 860 - CAVLC 444 Intra profile 861 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE`` 862 - Scalable Baseline profile 863 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH`` 864 - Scalable High profile 865 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA`` 866 - Scalable High Intra profile 867 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH`` 868 - Stereo High profile 869 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH`` 870 - Multiview High profile 871 872 873 874.. _v4l2-mpeg-video-mpeg2-profile: 875 876``V4L2_CID_MPEG_VIDEO_MPEG2_PROFILE`` 877 (enum) 878 879enum v4l2_mpeg_video_mpeg2_profile - 880 The profile information for MPEG2. Applicable to MPEG2 codecs. 881 Possible values are: 882 883 884 885.. flat-table:: 886 :header-rows: 0 887 :stub-columns: 0 888 889 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SIMPLE`` 890 - Simple profile (SP) 891 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MAIN`` 892 - Main profile (MP) 893 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SNR_SCALABLE`` 894 - SNR Scalable profile (SNR) 895 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SPATIALLY_SCALABLE`` 896 - Spatially Scalable profile (Spt) 897 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_HIGH`` 898 - High profile (HP) 899 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MULTIVIEW`` 900 - Multi-view profile (MVP) 901 902 903 904.. _v4l2-mpeg-video-mpeg4-profile: 905 906``V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE`` 907 (enum) 908 909enum v4l2_mpeg_video_mpeg4_profile - 910 The profile information for MPEG4. Applicable to the MPEG4 encoder. 911 Possible values are: 912 913 914 915.. flat-table:: 916 :header-rows: 0 917 :stub-columns: 0 918 919 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE`` 920 - Simple profile 921 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_SIMPLE`` 922 - Advanced Simple profile 923 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_CORE`` 924 - Core profile 925 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE_SCALABLE`` 926 - Simple Scalable profile 927 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_CODING_EFFICIENCY`` 928 - 929 930 931 932``V4L2_CID_MPEG_VIDEO_MAX_REF_PIC (integer)`` 933 The maximum number of reference pictures used for encoding. 934 Applicable to the encoder. 935 936.. _v4l2-mpeg-video-multi-slice-mode: 937 938``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` 939 (enum) 940 941enum v4l2_mpeg_video_multi_slice_mode - 942 Determines how the encoder should handle division of frame into 943 slices. Applicable to the encoder. Possible values are: 944 945 946 947.. tabularcolumns:: |p{9.6cm}|p{7.9cm}| 948 949.. flat-table:: 950 :header-rows: 0 951 :stub-columns: 0 952 953 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE`` 954 - Single slice per frame. 955 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB`` 956 - Multiple slices with set maximum number of macroblocks per slice. 957 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES`` 958 - Multiple slice with set maximum size in bytes per slice. 959 960 961 962``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB (integer)`` 963 The maximum number of macroblocks in a slice. Used when 964 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to 965 ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB``. Applicable to the 966 encoder. 967 968``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES (integer)`` 969 The maximum size of a slice in bytes. Used when 970 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to 971 ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``. Applicable to the 972 encoder. 973 974.. _v4l2-mpeg-video-h264-loop-filter-mode: 975 976``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE`` 977 (enum) 978 979enum v4l2_mpeg_video_h264_loop_filter_mode - 980 Loop filter mode for H264 encoder. Possible values are: 981 982.. raw:: latex 983 984 \small 985 986.. tabularcolumns:: |p{13.6cm}|p{3.9cm}| 987 988.. flat-table:: 989 :header-rows: 0 990 :stub-columns: 0 991 992 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED`` 993 - Loop filter is enabled. 994 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED`` 995 - Loop filter is disabled. 996 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY`` 997 - Loop filter is disabled at the slice boundary. 998 999.. raw:: latex 1000 1001 \normalsize 1002 1003 1004``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA (integer)`` 1005 Loop filter alpha coefficient, defined in the H264 standard. 1006 This value corresponds to the slice_alpha_c0_offset_div2 slice header 1007 field, and should be in the range of -6 to +6, inclusive. The actual alpha 1008 offset FilterOffsetA is twice this value. 1009 Applicable to the H264 encoder. 1010 1011``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA (integer)`` 1012 Loop filter beta coefficient, defined in the H264 standard. 1013 This corresponds to the slice_beta_offset_div2 slice header field, and 1014 should be in the range of -6 to +6, inclusive. The actual beta offset 1015 FilterOffsetB is twice this value. 1016 Applicable to the H264 encoder. 1017 1018.. _v4l2-mpeg-video-h264-entropy-mode: 1019 1020``V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE`` 1021 (enum) 1022 1023enum v4l2_mpeg_video_h264_entropy_mode - 1024 Entropy coding mode for H264 - CABAC/CAVALC. Applicable to the H264 1025 encoder. Possible values are: 1026 1027 1028.. tabularcolumns:: |p{9.0cm}|p{8.5cm}| 1029 1030 1031.. flat-table:: 1032 :header-rows: 0 1033 :stub-columns: 0 1034 1035 * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC`` 1036 - Use CAVLC entropy coding. 1037 * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC`` 1038 - Use CABAC entropy coding. 1039 1040 1041 1042``V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM (boolean)`` 1043 Enable 8X8 transform for H264. Applicable to the H264 encoder. 1044 1045``V4L2_CID_MPEG_VIDEO_H264_CONSTRAINED_INTRA_PREDICTION (boolean)`` 1046 Enable constrained intra prediction for H264. Applicable to the H264 1047 encoder. 1048 1049``V4L2_CID_MPEG_VIDEO_H264_CHROMA_QP_INDEX_OFFSET (integer)`` 1050 Specify the offset that should be added to the luma quantization 1051 parameter to determine the chroma quantization parameter. Applicable 1052 to the H264 encoder. 1053 1054``V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB (integer)`` 1055 Cyclic intra macroblock refresh. This is the number of continuous 1056 macroblocks refreshed every frame. Each frame a successive set of 1057 macroblocks is refreshed until the cycle completes and starts from 1058 the top of the frame. Applicable to H264, H263 and MPEG4 encoder. 1059 1060``V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE (boolean)`` 1061 Frame level rate control enable. If this control is disabled then 1062 the quantization parameter for each frame type is constant and set 1063 with appropriate controls (e.g. 1064 ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP``). If frame rate control is 1065 enabled then quantization parameter is adjusted to meet the chosen 1066 bitrate. Minimum and maximum value for the quantization parameter 1067 can be set with appropriate controls (e.g. 1068 ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP``). Applicable to encoders. 1069 1070``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE (boolean)`` 1071 Macroblock level rate control enable. Applicable to the MPEG4 and 1072 H264 encoders. 1073 1074``V4L2_CID_MPEG_VIDEO_MPEG4_QPEL (boolean)`` 1075 Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 1076 encoder. 1077 1078``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP (integer)`` 1079 Quantization parameter for an I frame for H263. Valid range: from 1 1080 to 31. 1081 1082``V4L2_CID_MPEG_VIDEO_H263_MIN_QP (integer)`` 1083 Minimum quantization parameter for H263. Valid range: from 1 to 31. 1084 1085``V4L2_CID_MPEG_VIDEO_H263_MAX_QP (integer)`` 1086 Maximum quantization parameter for H263. Valid range: from 1 to 31. 1087 1088``V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP (integer)`` 1089 Quantization parameter for an P frame for H263. Valid range: from 1 1090 to 31. 1091 1092``V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP (integer)`` 1093 Quantization parameter for an B frame for H263. Valid range: from 1 1094 to 31. 1095 1096``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP (integer)`` 1097 Quantization parameter for an I frame for H264. Valid range: from 0 1098 to 51. 1099 1100``V4L2_CID_MPEG_VIDEO_H264_MIN_QP (integer)`` 1101 Minimum quantization parameter for H264. Valid range: from 0 to 51. 1102 1103``V4L2_CID_MPEG_VIDEO_H264_MAX_QP (integer)`` 1104 Maximum quantization parameter for H264. Valid range: from 0 to 51. 1105 1106``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP (integer)`` 1107 Quantization parameter for an P frame for H264. Valid range: from 0 1108 to 51. 1109 1110``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP (integer)`` 1111 Quantization parameter for an B frame for H264. Valid range: from 0 1112 to 51. 1113 1114``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MIN_QP (integer)`` 1115 Minimum quantization parameter for the H264 I frame to limit I frame 1116 quality to a range. Valid range: from 0 to 51. If 1117 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1118 should be chosen to meet both requirements. 1119 1120``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MAX_QP (integer)`` 1121 Maximum quantization parameter for the H264 I frame to limit I frame 1122 quality to a range. Valid range: from 0 to 51. If 1123 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1124 should be chosen to meet both requirements. 1125 1126``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MIN_QP (integer)`` 1127 Minimum quantization parameter for the H264 P frame to limit P frame 1128 quality to a range. Valid range: from 0 to 51. If 1129 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1130 should be chosen to meet both requirements. 1131 1132``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MAX_QP (integer)`` 1133 Maximum quantization parameter for the H264 P frame to limit P frame 1134 quality to a range. Valid range: from 0 to 51. If 1135 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1136 should be chosen to meet both requirements. 1137 1138``V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP (integer)`` 1139 Quantization parameter for an I frame for MPEG4. Valid range: from 1 1140 to 31. 1141 1142``V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP (integer)`` 1143 Minimum quantization parameter for MPEG4. Valid range: from 1 to 31. 1144 1145``V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP (integer)`` 1146 Maximum quantization parameter for MPEG4. Valid range: from 1 to 31. 1147 1148``V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP (integer)`` 1149 Quantization parameter for an P frame for MPEG4. Valid range: from 1 1150 to 31. 1151 1152``V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP (integer)`` 1153 Quantization parameter for an B frame for MPEG4. Valid range: from 1 1154 to 31. 1155 1156``V4L2_CID_MPEG_VIDEO_VBV_SIZE (integer)`` 1157 The Video Buffer Verifier size in kilobytes, it is used as a 1158 limitation of frame skip. The VBV is defined in the standard as a 1159 mean to verify that the produced stream will be successfully 1160 decoded. The standard describes it as "Part of a hypothetical 1161 decoder that is conceptually connected to the output of the encoder. 1162 Its purpose is to provide a constraint on the variability of the 1163 data rate that an encoder or editing process may produce.". 1164 Applicable to the MPEG1, MPEG2, MPEG4 encoders. 1165 1166.. _v4l2-mpeg-video-vbv-delay: 1167 1168``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)`` 1169 Sets the initial delay in milliseconds for VBV buffer control. 1170 1171.. _v4l2-mpeg-video-hor-search-range: 1172 1173``V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE (integer)`` 1174 Horizontal search range defines maximum horizontal search area in 1175 pixels to search and match for the present Macroblock (MB) in the 1176 reference picture. This V4L2 control macro is used to set horizontal 1177 search range for motion estimation module in video encoder. 1178 1179.. _v4l2-mpeg-video-vert-search-range: 1180 1181``V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE (integer)`` 1182 Vertical search range defines maximum vertical search area in pixels 1183 to search and match for the present Macroblock (MB) in the reference 1184 picture. This V4L2 control macro is used to set vertical search 1185 range for motion estimation module in video encoder. 1186 1187.. _v4l2-mpeg-video-force-key-frame: 1188 1189``V4L2_CID_MPEG_VIDEO_FORCE_KEY_FRAME (button)`` 1190 Force a key frame for the next queued buffer. Applicable to 1191 encoders. This is a general, codec-agnostic keyframe control. 1192 1193``V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE (integer)`` 1194 The Coded Picture Buffer size in kilobytes, it is used as a 1195 limitation of frame skip. The CPB is defined in the H264 standard as 1196 a mean to verify that the produced stream will be successfully 1197 decoded. Applicable to the H264 encoder. 1198 1199``V4L2_CID_MPEG_VIDEO_H264_I_PERIOD (integer)`` 1200 Period between I-frames in the open GOP for H264. In case of an open 1201 GOP this is the period between two I-frames. The period between IDR 1202 (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE 1203 control. An IDR frame, which stands for Instantaneous Decoding 1204 Refresh is an I-frame after which no prior frames are referenced. 1205 This means that a stream can be restarted from an IDR frame without 1206 the need to store or decode any previous frames. Applicable to the 1207 H264 encoder. 1208 1209.. _v4l2-mpeg-video-header-mode: 1210 1211``V4L2_CID_MPEG_VIDEO_HEADER_MODE`` 1212 (enum) 1213 1214enum v4l2_mpeg_video_header_mode - 1215 Determines whether the header is returned as the first buffer or is 1216 it returned together with the first frame. Applicable to encoders. 1217 Possible values are: 1218 1219.. raw:: latex 1220 1221 \small 1222 1223.. tabularcolumns:: |p{10.3cm}|p{7.2cm}| 1224 1225.. flat-table:: 1226 :header-rows: 0 1227 :stub-columns: 0 1228 1229 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE`` 1230 - The stream header is returned separately in the first buffer. 1231 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME`` 1232 - The stream header is returned together with the first encoded 1233 frame. 1234 1235.. raw:: latex 1236 1237 \normalsize 1238 1239 1240``V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER (boolean)`` 1241 Repeat the video sequence headers. Repeating these headers makes 1242 random access to the video stream easier. Applicable to the MPEG1, 2 1243 and 4 encoder. 1244 1245``V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER (boolean)`` 1246 Enabled the deblocking post processing filter for MPEG4 decoder. 1247 Applicable to the MPEG4 decoder. 1248 1249``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES (integer)`` 1250 vop_time_increment_resolution value for MPEG4. Applicable to the 1251 MPEG4 encoder. 1252 1253``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC (integer)`` 1254 vop_time_increment value for MPEG4. Applicable to the MPEG4 1255 encoder. 1256 1257``V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING (boolean)`` 1258 Enable generation of frame packing supplemental enhancement 1259 information in the encoded bitstream. The frame packing SEI message 1260 contains the arrangement of L and R planes for 3D viewing. 1261 Applicable to the H264 encoder. 1262 1263``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0 (boolean)`` 1264 Sets current frame as frame0 in frame packing SEI. Applicable to the 1265 H264 encoder. 1266 1267.. _v4l2-mpeg-video-h264-sei-fp-arrangement-type: 1268 1269``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE`` 1270 (enum) 1271 1272enum v4l2_mpeg_video_h264_sei_fp_arrangement_type - 1273 Frame packing arrangement type for H264 SEI. Applicable to the H264 1274 encoder. Possible values are: 1275 1276.. raw:: latex 1277 1278 \small 1279 1280.. tabularcolumns:: |p{12cm}|p{5.5cm}| 1281 1282.. flat-table:: 1283 :header-rows: 0 1284 :stub-columns: 0 1285 1286 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_CHEKERBOARD`` 1287 - Pixels are alternatively from L and R. 1288 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_COLUMN`` 1289 - L and R are interlaced by column. 1290 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_ROW`` 1291 - L and R are interlaced by row. 1292 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_SIDE_BY_SIDE`` 1293 - L is on the left, R on the right. 1294 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TOP_BOTTOM`` 1295 - L is on top, R on bottom. 1296 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TEMPORAL`` 1297 - One view per frame. 1298 1299.. raw:: latex 1300 1301 \normalsize 1302 1303 1304 1305``V4L2_CID_MPEG_VIDEO_H264_FMO (boolean)`` 1306 Enables flexible macroblock ordering in the encoded bitstream. It is 1307 a technique used for restructuring the ordering of macroblocks in 1308 pictures. Applicable to the H264 encoder. 1309 1310.. _v4l2-mpeg-video-h264-fmo-map-type: 1311 1312``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE`` 1313 (enum) 1314 1315enum v4l2_mpeg_video_h264_fmo_map_type - 1316 When using FMO, the map type divides the image in different scan 1317 patterns of macroblocks. Applicable to the H264 encoder. Possible 1318 values are: 1319 1320.. raw:: latex 1321 1322 \small 1323 1324.. tabularcolumns:: |p{12.5cm}|p{5.0cm}| 1325 1326.. flat-table:: 1327 :header-rows: 0 1328 :stub-columns: 0 1329 1330 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES`` 1331 - Slices are interleaved one after other with macroblocks in run 1332 length order. 1333 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_SCATTERED_SLICES`` 1334 - Scatters the macroblocks based on a mathematical function known to 1335 both encoder and decoder. 1336 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_FOREGROUND_WITH_LEFT_OVER`` 1337 - Macroblocks arranged in rectangular areas or regions of interest. 1338 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_BOX_OUT`` 1339 - Slice groups grow in a cyclic way from centre to outwards. 1340 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_RASTER_SCAN`` 1341 - Slice groups grow in raster scan pattern from left to right. 1342 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_WIPE_SCAN`` 1343 - Slice groups grow in wipe scan pattern from top to bottom. 1344 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_EXPLICIT`` 1345 - User defined map type. 1346 1347.. raw:: latex 1348 1349 \normalsize 1350 1351 1352 1353``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)`` 1354 Number of slice groups in FMO. Applicable to the H264 encoder. 1355 1356.. _v4l2-mpeg-video-h264-fmo-change-direction: 1357 1358``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION`` 1359 (enum) 1360 1361enum v4l2_mpeg_video_h264_fmo_change_dir - 1362 Specifies a direction of the slice group change for raster and wipe 1363 maps. Applicable to the H264 encoder. Possible values are: 1364 1365 1366 1367.. flat-table:: 1368 :header-rows: 0 1369 :stub-columns: 0 1370 1371 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_RIGHT`` 1372 - Raster scan or wipe right. 1373 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_LEFT`` 1374 - Reverse raster scan or wipe left. 1375 1376 1377 1378``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE (integer)`` 1379 Specifies the size of the first slice group for raster and wipe map. 1380 Applicable to the H264 encoder. 1381 1382``V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH (integer)`` 1383 Specifies the number of consecutive macroblocks for the interleaved 1384 map. Applicable to the H264 encoder. 1385 1386``V4L2_CID_MPEG_VIDEO_H264_ASO (boolean)`` 1387 Enables arbitrary slice ordering in encoded bitstream. Applicable to 1388 the H264 encoder. 1389 1390``V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER (integer)`` 1391 Specifies the slice order in ASO. Applicable to the H264 encoder. 1392 The supplied 32-bit integer is interpreted as follows (bit 0 = least 1393 significant bit): 1394 1395 1396 1397.. flat-table:: 1398 :header-rows: 0 1399 :stub-columns: 0 1400 1401 * - Bit 0:15 1402 - Slice ID 1403 * - Bit 16:32 1404 - Slice position or order 1405 1406 1407 1408``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)`` 1409 Enables H264 hierarchical coding. Applicable to the H264 encoder. 1410 1411.. _v4l2-mpeg-video-h264-hierarchical-coding-type: 1412 1413``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE`` 1414 (enum) 1415 1416enum v4l2_mpeg_video_h264_hierarchical_coding_type - 1417 Specifies the hierarchical coding type. Applicable to the H264 1418 encoder. Possible values are: 1419 1420 1421 1422.. flat-table:: 1423 :header-rows: 0 1424 :stub-columns: 0 1425 1426 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B`` 1427 - Hierarchical B coding. 1428 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P`` 1429 - Hierarchical P coding. 1430 1431 1432 1433``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER (integer)`` 1434 Specifies the number of hierarchical coding layers. Applicable to 1435 the H264 encoder. 1436 1437``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP (integer)`` 1438 Specifies a user defined QP for each layer. Applicable to the H264 1439 encoder. The supplied 32-bit integer is interpreted as follows (bit 1440 0 = least significant bit): 1441 1442 1443 1444.. flat-table:: 1445 :header-rows: 0 1446 :stub-columns: 0 1447 1448 * - Bit 0:15 1449 - QP value 1450 * - Bit 16:32 1451 - Layer number 1452 1453 1454.. _v4l2-mpeg-h264: 1455 1456``V4L2_CID_MPEG_VIDEO_H264_SPS (struct)`` 1457 Specifies the sequence parameter set (as extracted from the 1458 bitstream) for the associated H264 slice data. This includes the 1459 necessary parameters for configuring a stateless hardware decoding 1460 pipeline for H264. The bitstream parameters are defined according 1461 to :ref:`h264`, section 7.4.2.1.1 "Sequence Parameter Set Data 1462 Semantics". For further documentation, refer to the above 1463 specification, unless there is an explicit comment stating 1464 otherwise. 1465 1466 .. note:: 1467 1468 This compound control is not yet part of the public kernel API and 1469 it is expected to change. 1470 1471.. c:type:: v4l2_ctrl_h264_sps 1472 1473.. cssclass:: longtable 1474 1475.. flat-table:: struct v4l2_ctrl_h264_sps 1476 :header-rows: 0 1477 :stub-columns: 0 1478 :widths: 1 1 2 1479 1480 * - __u8 1481 - ``profile_idc`` 1482 - 1483 * - __u8 1484 - ``constraint_set_flags`` 1485 - See :ref:`Sequence Parameter Set Constraints Set Flags <h264_sps_constraints_set_flags>` 1486 * - __u8 1487 - ``level_idc`` 1488 - 1489 * - __u8 1490 - ``seq_parameter_set_id`` 1491 - 1492 * - __u8 1493 - ``chroma_format_idc`` 1494 - 1495 * - __u8 1496 - ``bit_depth_luma_minus8`` 1497 - 1498 * - __u8 1499 - ``bit_depth_chroma_minus8`` 1500 - 1501 * - __u8 1502 - ``log2_max_frame_num_minus4`` 1503 - 1504 * - __u8 1505 - ``pic_order_cnt_type`` 1506 - 1507 * - __u8 1508 - ``log2_max_pic_order_cnt_lsb_minus4`` 1509 - 1510 * - __u8 1511 - ``max_num_ref_frames`` 1512 - 1513 * - __u8 1514 - ``num_ref_frames_in_pic_order_cnt_cycle`` 1515 - 1516 * - __s32 1517 - ``offset_for_ref_frame[255]`` 1518 - 1519 * - __s32 1520 - ``offset_for_non_ref_pic`` 1521 - 1522 * - __s32 1523 - ``offset_for_top_to_bottom_field`` 1524 - 1525 * - __u16 1526 - ``pic_width_in_mbs_minus1`` 1527 - 1528 * - __u16 1529 - ``pic_height_in_map_units_minus1`` 1530 - 1531 * - __u32 1532 - ``flags`` 1533 - See :ref:`Sequence Parameter Set Flags <h264_sps_flags>` 1534 1535.. _h264_sps_constraints_set_flags: 1536 1537``Sequence Parameter Set Constraints Set Flags`` 1538 1539.. cssclass:: longtable 1540 1541.. flat-table:: 1542 :header-rows: 0 1543 :stub-columns: 0 1544 :widths: 1 1 2 1545 1546 * - ``V4L2_H264_SPS_CONSTRAINT_SET0_FLAG`` 1547 - 0x00000001 1548 - 1549 * - ``V4L2_H264_SPS_CONSTRAINT_SET1_FLAG`` 1550 - 0x00000002 1551 - 1552 * - ``V4L2_H264_SPS_CONSTRAINT_SET2_FLAG`` 1553 - 0x00000004 1554 - 1555 * - ``V4L2_H264_SPS_CONSTRAINT_SET3_FLAG`` 1556 - 0x00000008 1557 - 1558 * - ``V4L2_H264_SPS_CONSTRAINT_SET4_FLAG`` 1559 - 0x00000010 1560 - 1561 * - ``V4L2_H264_SPS_CONSTRAINT_SET5_FLAG`` 1562 - 0x00000020 1563 - 1564 1565.. _h264_sps_flags: 1566 1567``Sequence Parameter Set Flags`` 1568 1569.. cssclass:: longtable 1570 1571.. flat-table:: 1572 :header-rows: 0 1573 :stub-columns: 0 1574 :widths: 1 1 2 1575 1576 * - ``V4L2_H264_SPS_FLAG_SEPARATE_COLOUR_PLANE`` 1577 - 0x00000001 1578 - 1579 * - ``V4L2_H264_SPS_FLAG_QPPRIME_Y_ZERO_TRANSFORM_BYPASS`` 1580 - 0x00000002 1581 - 1582 * - ``V4L2_H264_SPS_FLAG_DELTA_PIC_ORDER_ALWAYS_ZERO`` 1583 - 0x00000004 1584 - 1585 * - ``V4L2_H264_SPS_FLAG_GAPS_IN_FRAME_NUM_VALUE_ALLOWED`` 1586 - 0x00000008 1587 - 1588 * - ``V4L2_H264_SPS_FLAG_FRAME_MBS_ONLY`` 1589 - 0x00000010 1590 - 1591 * - ``V4L2_H264_SPS_FLAG_MB_ADAPTIVE_FRAME_FIELD`` 1592 - 0x00000020 1593 - 1594 * - ``V4L2_H264_SPS_FLAG_DIRECT_8X8_INFERENCE`` 1595 - 0x00000040 1596 - 1597 1598``V4L2_CID_MPEG_VIDEO_H264_PPS (struct)`` 1599 Specifies the picture parameter set (as extracted from the 1600 bitstream) for the associated H264 slice data. This includes the 1601 necessary parameters for configuring a stateless hardware decoding 1602 pipeline for H264. The bitstream parameters are defined according 1603 to :ref:`h264`, section 7.4.2.2 "Picture Parameter Set RBSP 1604 Semantics". For further documentation, refer to the above 1605 specification, unless there is an explicit comment stating 1606 otherwise. 1607 1608 .. note:: 1609 1610 This compound control is not yet part of the public kernel API and 1611 it is expected to change. 1612 1613.. c:type:: v4l2_ctrl_h264_pps 1614 1615.. cssclass:: longtable 1616 1617.. flat-table:: struct v4l2_ctrl_h264_pps 1618 :header-rows: 0 1619 :stub-columns: 0 1620 :widths: 1 1 2 1621 1622 * - __u8 1623 - ``pic_parameter_set_id`` 1624 - 1625 * - __u8 1626 - ``seq_parameter_set_id`` 1627 - 1628 * - __u8 1629 - ``num_slice_groups_minus1`` 1630 - 1631 * - __u8 1632 - ``num_ref_idx_l0_default_active_minus1`` 1633 - 1634 * - __u8 1635 - ``num_ref_idx_l1_default_active_minus1`` 1636 - 1637 * - __u8 1638 - ``weighted_bipred_idc`` 1639 - 1640 * - __s8 1641 - ``pic_init_qp_minus26`` 1642 - 1643 * - __s8 1644 - ``pic_init_qs_minus26`` 1645 - 1646 * - __s8 1647 - ``chroma_qp_index_offset`` 1648 - 1649 * - __s8 1650 - ``second_chroma_qp_index_offset`` 1651 - 1652 * - __u16 1653 - ``flags`` 1654 - See :ref:`Picture Parameter Set Flags <h264_pps_flags>` 1655 1656.. _h264_pps_flags: 1657 1658``Picture Parameter Set Flags`` 1659 1660.. cssclass:: longtable 1661 1662.. flat-table:: 1663 :header-rows: 0 1664 :stub-columns: 0 1665 :widths: 1 1 2 1666 1667 * - ``V4L2_H264_PPS_FLAG_ENTROPY_CODING_MODE`` 1668 - 0x00000001 1669 - 1670 * - ``V4L2_H264_PPS_FLAG_BOTTOM_FIELD_PIC_ORDER_IN_FRAME_PRESENT`` 1671 - 0x00000002 1672 - 1673 * - ``V4L2_H264_PPS_FLAG_WEIGHTED_PRED`` 1674 - 0x00000004 1675 - 1676 * - ``V4L2_H264_PPS_FLAG_DEBLOCKING_FILTER_CONTROL_PRESENT`` 1677 - 0x00000008 1678 - 1679 * - ``V4L2_H264_PPS_FLAG_CONSTRAINED_INTRA_PRED`` 1680 - 0x00000010 1681 - 1682 * - ``V4L2_H264_PPS_FLAG_REDUNDANT_PIC_CNT_PRESENT`` 1683 - 0x00000020 1684 - 1685 * - ``V4L2_H264_PPS_FLAG_TRANSFORM_8X8_MODE`` 1686 - 0x00000040 1687 - 1688 * - ``V4L2_H264_PPS_FLAG_PIC_SCALING_MATRIX_PRESENT`` 1689 - 0x00000080 1690 - 1691 1692``V4L2_CID_MPEG_VIDEO_H264_SCALING_MATRIX (struct)`` 1693 Specifies the scaling matrix (as extracted from the bitstream) for 1694 the associated H264 slice data. The bitstream parameters are 1695 defined according to :ref:`h264`, section 7.4.2.1.1.1 "Scaling 1696 List Semantics". For further documentation, refer to the above 1697 specification, unless there is an explicit comment stating 1698 otherwise. 1699 1700 .. note:: 1701 1702 This compound control is not yet part of the public kernel API and 1703 it is expected to change. 1704 1705.. c:type:: v4l2_ctrl_h264_scaling_matrix 1706 1707.. cssclass:: longtable 1708 1709.. flat-table:: struct v4l2_ctrl_h264_scaling_matrix 1710 :header-rows: 0 1711 :stub-columns: 0 1712 :widths: 1 1 2 1713 1714 * - __u8 1715 - ``scaling_list_4x4[6][16]`` 1716 - 1717 * - __u8 1718 - ``scaling_list_8x8[6][64]`` 1719 - 1720 1721``V4L2_CID_MPEG_VIDEO_H264_SLICE_PARAMS (struct)`` 1722 Specifies the slice parameters (as extracted from the bitstream) 1723 for the associated H264 slice data. This includes the necessary 1724 parameters for configuring a stateless hardware decoding pipeline 1725 for H264. The bitstream parameters are defined according to 1726 :ref:`h264`, section 7.4.3 "Slice Header Semantics". For further 1727 documentation, refer to the above specification, unless there is 1728 an explicit comment stating otherwise. 1729 1730 .. note:: 1731 1732 This compound control is not yet part of the public kernel API 1733 and it is expected to change. 1734 1735 This structure is expected to be passed as an array, with one 1736 entry for each slice included in the bitstream buffer. 1737 1738.. c:type:: v4l2_ctrl_h264_slice_params 1739 1740.. cssclass:: longtable 1741 1742.. flat-table:: struct v4l2_ctrl_h264_slice_params 1743 :header-rows: 0 1744 :stub-columns: 0 1745 :widths: 1 1 2 1746 1747 * - __u32 1748 - ``size`` 1749 - 1750 * - __u32 1751 - ``start_byte_offset`` 1752 Offset (in bytes) from the beginning of the OUTPUT buffer to the start 1753 of the slice. If the slice starts with a start code, then this is the 1754 offset to such start code. When operating in slice-based decoding mode 1755 (see :c:type:`v4l2_mpeg_video_h264_decode_mode`), this field should 1756 be set to 0. When operating in frame-based decoding mode, this field 1757 should be 0 for the first slice. 1758 * - __u32 1759 - ``header_bit_size`` 1760 - 1761 * - __u16 1762 - ``first_mb_in_slice`` 1763 - 1764 * - __u8 1765 - ``slice_type`` 1766 - 1767 * - __u8 1768 - ``pic_parameter_set_id`` 1769 - 1770 * - __u8 1771 - ``colour_plane_id`` 1772 - 1773 * - __u8 1774 - ``redundant_pic_cnt`` 1775 - 1776 * - __u16 1777 - ``frame_num`` 1778 - 1779 * - __u16 1780 - ``idr_pic_id`` 1781 - 1782 * - __u16 1783 - ``pic_order_cnt_lsb`` 1784 - 1785 * - __s32 1786 - ``delta_pic_order_cnt_bottom`` 1787 - 1788 * - __s32 1789 - ``delta_pic_order_cnt0`` 1790 - 1791 * - __s32 1792 - ``delta_pic_order_cnt1`` 1793 - 1794 * - struct :c:type:`v4l2_h264_pred_weight_table` 1795 - ``pred_weight_table`` 1796 - 1797 * - __u32 1798 - ``dec_ref_pic_marking_bit_size`` 1799 - 1800 * - __u32 1801 - ``pic_order_cnt_bit_size`` 1802 - 1803 * - __u8 1804 - ``cabac_init_idc`` 1805 - 1806 * - __s8 1807 - ``slice_qp_delta`` 1808 - 1809 * - __s8 1810 - ``slice_qs_delta`` 1811 - 1812 * - __u8 1813 - ``disable_deblocking_filter_idc`` 1814 - 1815 * - __s8 1816 - ``slice_alpha_c0_offset_div2`` 1817 - 1818 * - __s8 1819 - ``slice_beta_offset_div2`` 1820 - 1821 * - __u8 1822 - ``num_ref_idx_l0_active_minus1`` 1823 - 1824 * - __u8 1825 - ``num_ref_idx_l1_active_minus1`` 1826 - 1827 * - __u32 1828 - ``slice_group_change_cycle`` 1829 - 1830 * - __u8 1831 - ``ref_pic_list0[32]`` 1832 - Reference picture list after applying the per-slice modifications 1833 * - __u8 1834 - ``ref_pic_list1[32]`` 1835 - Reference picture list after applying the per-slice modifications 1836 * - __u32 1837 - ``flags`` 1838 - See :ref:`Slice Parameter Flags <h264_slice_flags>` 1839 1840.. _h264_slice_flags: 1841 1842``Slice Parameter Set Flags`` 1843 1844.. cssclass:: longtable 1845 1846.. flat-table:: 1847 :header-rows: 0 1848 :stub-columns: 0 1849 :widths: 1 1 2 1850 1851 * - ``V4L2_H264_SLICE_FLAG_FIELD_PIC`` 1852 - 0x00000001 1853 - 1854 * - ``V4L2_H264_SLICE_FLAG_BOTTOM_FIELD`` 1855 - 0x00000002 1856 - 1857 * - ``V4L2_H264_SLICE_FLAG_DIRECT_SPATIAL_MV_PRED`` 1858 - 0x00000004 1859 - 1860 * - ``V4L2_H264_SLICE_FLAG_SP_FOR_SWITCH`` 1861 - 0x00000008 1862 - 1863 1864``Prediction Weight Table`` 1865 1866 The bitstream parameters are defined according to :ref:`h264`, 1867 section 7.4.3.2 "Prediction Weight Table Semantics". For further 1868 documentation, refer to the above specification, unless there is 1869 an explicit comment stating otherwise. 1870 1871.. c:type:: v4l2_h264_pred_weight_table 1872 1873.. cssclass:: longtable 1874 1875.. flat-table:: struct v4l2_h264_pred_weight_table 1876 :header-rows: 0 1877 :stub-columns: 0 1878 :widths: 1 1 2 1879 1880 * - __u16 1881 - ``luma_log2_weight_denom`` 1882 - 1883 * - __u16 1884 - ``chroma_log2_weight_denom`` 1885 - 1886 * - struct :c:type:`v4l2_h264_weight_factors` 1887 - ``weight_factors[2]`` 1888 - The weight factors at index 0 are the weight factors for the reference 1889 list 0, the one at index 1 for the reference list 1. 1890 1891.. c:type:: v4l2_h264_weight_factors 1892 1893.. cssclass:: longtable 1894 1895.. flat-table:: struct v4l2_h264_weight_factors 1896 :header-rows: 0 1897 :stub-columns: 0 1898 :widths: 1 1 2 1899 1900 * - __s16 1901 - ``luma_weight[32]`` 1902 - 1903 * - __s16 1904 - ``luma_offset[32]`` 1905 - 1906 * - __s16 1907 - ``chroma_weight[32][2]`` 1908 - 1909 * - __s16 1910 - ``chroma_offset[32][2]`` 1911 - 1912 1913``V4L2_CID_MPEG_VIDEO_H264_DECODE_PARAMS (struct)`` 1914 Specifies the decode parameters (as extracted from the bitstream) 1915 for the associated H264 slice data. This includes the necessary 1916 parameters for configuring a stateless hardware decoding pipeline 1917 for H264. The bitstream parameters are defined according to 1918 :ref:`h264`. For further documentation, refer to the above 1919 specification, unless there is an explicit comment stating 1920 otherwise. 1921 1922 .. note:: 1923 1924 This compound control is not yet part of the public kernel API and 1925 it is expected to change. 1926 1927.. c:type:: v4l2_ctrl_h264_decode_params 1928 1929.. cssclass:: longtable 1930 1931.. flat-table:: struct v4l2_ctrl_h264_decode_params 1932 :header-rows: 0 1933 :stub-columns: 0 1934 :widths: 1 1 2 1935 1936 * - struct :c:type:`v4l2_h264_dpb_entry` 1937 - ``dpb[16]`` 1938 - 1939 * - __u16 1940 - ``num_slices`` 1941 - Number of slices needed to decode the current frame/field. When 1942 operating in slice-based decoding mode (see 1943 :c:type:`v4l2_mpeg_video_h264_decode_mode`), this field 1944 should always be set to one. 1945 * - __u16 1946 - ``nal_ref_idc`` 1947 - NAL reference ID value coming from the NAL Unit header 1948 * - __s32 1949 - ``top_field_order_cnt`` 1950 - Picture Order Count for the coded top field 1951 * - __s32 1952 - ``bottom_field_order_cnt`` 1953 - Picture Order Count for the coded bottom field 1954 * - __u32 1955 - ``flags`` 1956 - See :ref:`Decode Parameters Flags <h264_decode_params_flags>` 1957 1958.. _h264_decode_params_flags: 1959 1960``Decode Parameters Flags`` 1961 1962.. cssclass:: longtable 1963 1964.. flat-table:: 1965 :header-rows: 0 1966 :stub-columns: 0 1967 :widths: 1 1 2 1968 1969 * - ``V4L2_H264_DECODE_PARAM_FLAG_IDR_PIC`` 1970 - 0x00000001 1971 - That picture is an IDR picture 1972 1973.. c:type:: v4l2_h264_dpb_entry 1974 1975.. cssclass:: longtable 1976 1977.. flat-table:: struct v4l2_h264_dpb_entry 1978 :header-rows: 0 1979 :stub-columns: 0 1980 :widths: 1 1 2 1981 1982 * - __u64 1983 - ``reference_ts`` 1984 - Timestamp of the V4L2 capture buffer to use as reference, used 1985 with B-coded and P-coded frames. The timestamp refers to the 1986 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 1987 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 1988 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 1989 * - __u16 1990 - ``frame_num`` 1991 - 1992 * - __u16 1993 - ``pic_num`` 1994 - 1995 * - __s32 1996 - ``top_field_order_cnt`` 1997 - 1998 * - __s32 1999 - ``bottom_field_order_cnt`` 2000 - 2001 * - __u32 2002 - ``flags`` 2003 - See :ref:`DPB Entry Flags <h264_dpb_flags>` 2004 2005.. _h264_dpb_flags: 2006 2007``DPB Entries Flags`` 2008 2009.. cssclass:: longtable 2010 2011.. flat-table:: 2012 :header-rows: 0 2013 :stub-columns: 0 2014 :widths: 1 1 2 2015 2016 * - ``V4L2_H264_DPB_ENTRY_FLAG_VALID`` 2017 - 0x00000001 2018 - The DPB entry is valid and should be considered 2019 * - ``V4L2_H264_DPB_ENTRY_FLAG_ACTIVE`` 2020 - 0x00000002 2021 - The DPB entry is currently being used as a reference frame 2022 * - ``V4L2_H264_DPB_ENTRY_FLAG_LONG_TERM`` 2023 - 0x00000004 2024 - The DPB entry is a long term reference frame 2025 2026``V4L2_CID_MPEG_VIDEO_H264_DECODE_MODE (enum)`` 2027 Specifies the decoding mode to use. Currently exposes slice-based and 2028 frame-based decoding but new modes might be added later on. 2029 This control is used as a modifier for V4L2_PIX_FMT_H264_SLICE 2030 pixel format. Applications that support V4L2_PIX_FMT_H264_SLICE 2031 are required to set this control in order to specify the decoding mode 2032 that is expected for the buffer. 2033 Drivers may expose a single or multiple decoding modes, depending 2034 on what they can support. 2035 2036 .. note:: 2037 2038 This menu control is not yet part of the public kernel API and 2039 it is expected to change. 2040 2041.. c:type:: v4l2_mpeg_video_h264_decode_mode 2042 2043.. cssclass:: longtable 2044 2045.. flat-table:: 2046 :header-rows: 0 2047 :stub-columns: 0 2048 :widths: 1 1 2 2049 2050 * - ``V4L2_MPEG_VIDEO_H264_DECODE_MODE_SLICE_BASED`` 2051 - 0 2052 - Decoding is done at the slice granularity. 2053 In this mode, ``num_slices`` field in struct 2054 :c:type:`v4l2_ctrl_h264_decode_params` should be set to 1, 2055 and ``start_byte_offset`` in struct 2056 :c:type:`v4l2_ctrl_h264_slice_params` should be set to 0. 2057 The OUTPUT buffer must contain a single slice. 2058 * - ``V4L2_MPEG_VIDEO_H264_DECODE_MODE_FRAME_BASED`` 2059 - 1 2060 - Decoding is done at the frame granularity. 2061 In this mode, ``num_slices`` field in struct 2062 :c:type:`v4l2_ctrl_h264_decode_params` should be set to the number 2063 of slices in the frame, and ``start_byte_offset`` in struct 2064 :c:type:`v4l2_ctrl_h264_slice_params` should be set accordingly 2065 for each slice. For the first slice, ``start_byte_offset`` should 2066 be zero. 2067 The OUTPUT buffer must contain all slices needed to decode the 2068 frame. The OUTPUT buffer must also contain both fields. 2069 2070``V4L2_CID_MPEG_VIDEO_H264_START_CODE (enum)`` 2071 Specifies the H264 slice start code expected for each slice. 2072 This control is used as a modifier for V4L2_PIX_FMT_H264_SLICE 2073 pixel format. Applications that support V4L2_PIX_FMT_H264_SLICE 2074 are required to set this control in order to specify the start code 2075 that is expected for the buffer. 2076 Drivers may expose a single or multiple start codes, depending 2077 on what they can support. 2078 2079 .. note:: 2080 2081 This menu control is not yet part of the public kernel API and 2082 it is expected to change. 2083 2084.. c:type:: v4l2_mpeg_video_h264_start_code 2085 2086.. cssclass:: longtable 2087 2088.. flat-table:: 2089 :header-rows: 0 2090 :stub-columns: 0 2091 :widths: 1 1 2 2092 2093 * - ``V4L2_MPEG_VIDEO_H264_START_CODE_NONE`` 2094 - 0 2095 - Selecting this value specifies that H264 slices are passed 2096 to the driver without any start code. 2097 * - ``V4L2_MPEG_VIDEO_H264_START_CODE_ANNEX_B`` 2098 - 1 2099 - Selecting this value specifies that H264 slices are expected 2100 to be prefixed by Annex B start codes. According to :ref:`h264` 2101 valid start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001. 2102 2103.. _v4l2-mpeg-mpeg2: 2104 2105``V4L2_CID_MPEG_VIDEO_MPEG2_SLICE_PARAMS (struct)`` 2106 Specifies the slice parameters (as extracted from the bitstream) for the 2107 associated MPEG-2 slice data. This includes the necessary parameters for 2108 configuring a stateless hardware decoding pipeline for MPEG-2. 2109 The bitstream parameters are defined according to :ref:`mpeg2part2`. 2110 2111 .. note:: 2112 2113 This compound control is not yet part of the public kernel API and 2114 it is expected to change. 2115 2116.. c:type:: v4l2_ctrl_mpeg2_slice_params 2117 2118.. cssclass:: longtable 2119 2120.. tabularcolumns:: |p{5.8cm}|p{4.8cm}|p{6.6cm}| 2121 2122.. flat-table:: struct v4l2_ctrl_mpeg2_slice_params 2123 :header-rows: 0 2124 :stub-columns: 0 2125 :widths: 1 1 2 2126 2127 * - __u32 2128 - ``bit_size`` 2129 - Size (in bits) of the current slice data. 2130 * - __u32 2131 - ``data_bit_offset`` 2132 - Offset (in bits) to the video data in the current slice data. 2133 * - struct :c:type:`v4l2_mpeg2_sequence` 2134 - ``sequence`` 2135 - Structure with MPEG-2 sequence metadata, merging relevant fields from 2136 the sequence header and sequence extension parts of the bitstream. 2137 * - struct :c:type:`v4l2_mpeg2_picture` 2138 - ``picture`` 2139 - Structure with MPEG-2 picture metadata, merging relevant fields from 2140 the picture header and picture coding extension parts of the bitstream. 2141 * - __u64 2142 - ``backward_ref_ts`` 2143 - Timestamp of the V4L2 capture buffer to use as backward reference, used 2144 with B-coded and P-coded frames. The timestamp refers to the 2145 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 2146 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 2147 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 2148 * - __u64 2149 - ``forward_ref_ts`` 2150 - Timestamp for the V4L2 capture buffer to use as forward reference, used 2151 with B-coded frames. The timestamp refers to the ``timestamp`` field in 2152 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2153 function to convert the struct :c:type:`timeval` in struct 2154 :c:type:`v4l2_buffer` to a __u64. 2155 * - __u32 2156 - ``quantiser_scale_code`` 2157 - Code used to determine the quantization scale to use for the IDCT. 2158 2159.. c:type:: v4l2_mpeg2_sequence 2160 2161.. cssclass:: longtable 2162 2163.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2164 2165.. flat-table:: struct v4l2_mpeg2_sequence 2166 :header-rows: 0 2167 :stub-columns: 0 2168 :widths: 1 1 2 2169 2170 * - __u16 2171 - ``horizontal_size`` 2172 - The width of the displayable part of the frame's luminance component. 2173 * - __u16 2174 - ``vertical_size`` 2175 - The height of the displayable part of the frame's luminance component. 2176 * - __u32 2177 - ``vbv_buffer_size`` 2178 - Used to calculate the required size of the video buffering verifier, 2179 defined (in bits) as: 16 * 1024 * vbv_buffer_size. 2180 * - __u16 2181 - ``profile_and_level_indication`` 2182 - The current profile and level indication as extracted from the 2183 bitstream. 2184 * - __u8 2185 - ``progressive_sequence`` 2186 - Indication that all the frames for the sequence are progressive instead 2187 of interlaced. 2188 * - __u8 2189 - ``chroma_format`` 2190 - The chrominance sub-sampling format (1: 4:2:0, 2: 4:2:2, 3: 4:4:4). 2191 2192.. c:type:: v4l2_mpeg2_picture 2193 2194.. cssclass:: longtable 2195 2196.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2197 2198.. flat-table:: struct v4l2_mpeg2_picture 2199 :header-rows: 0 2200 :stub-columns: 0 2201 :widths: 1 1 2 2202 2203 * - __u8 2204 - ``picture_coding_type`` 2205 - Picture coding type for the frame covered by the current slice 2206 (V4L2_MPEG2_PICTURE_CODING_TYPE_I, V4L2_MPEG2_PICTURE_CODING_TYPE_P or 2207 V4L2_MPEG2_PICTURE_CODING_TYPE_B). 2208 * - __u8 2209 - ``f_code[2][2]`` 2210 - Motion vector codes. 2211 * - __u8 2212 - ``intra_dc_precision`` 2213 - Precision of Discrete Cosine transform (0: 8 bits precision, 2214 1: 9 bits precision, 2: 10 bits precision, 3: 11 bits precision). 2215 * - __u8 2216 - ``picture_structure`` 2217 - Picture structure (1: interlaced top field, 2: interlaced bottom field, 2218 3: progressive frame). 2219 * - __u8 2220 - ``top_field_first`` 2221 - If set to 1 and interlaced stream, top field is output first. 2222 * - __u8 2223 - ``frame_pred_frame_dct`` 2224 - If set to 1, only frame-DCT and frame prediction are used. 2225 * - __u8 2226 - ``concealment_motion_vectors`` 2227 - If set to 1, motion vectors are coded for intra macroblocks. 2228 * - __u8 2229 - ``q_scale_type`` 2230 - This flag affects the inverse quantization process. 2231 * - __u8 2232 - ``intra_vlc_format`` 2233 - This flag affects the decoding of transform coefficient data. 2234 * - __u8 2235 - ``alternate_scan`` 2236 - This flag affects the decoding of transform coefficient data. 2237 * - __u8 2238 - ``repeat_first_field`` 2239 - This flag affects the decoding process of progressive frames. 2240 * - __u16 2241 - ``progressive_frame`` 2242 - Indicates whether the current frame is progressive. 2243 2244``V4L2_CID_MPEG_VIDEO_MPEG2_QUANTIZATION (struct)`` 2245 Specifies quantization matrices (as extracted from the bitstream) for the 2246 associated MPEG-2 slice data. 2247 2248 .. note:: 2249 2250 This compound control is not yet part of the public kernel API and 2251 it is expected to change. 2252 2253.. c:type:: v4l2_ctrl_mpeg2_quantization 2254 2255.. cssclass:: longtable 2256 2257.. tabularcolumns:: |p{1.2cm}|p{8.0cm}|p{7.4cm}| 2258 2259.. raw:: latex 2260 2261 \small 2262 2263.. flat-table:: struct v4l2_ctrl_mpeg2_quantization 2264 :header-rows: 0 2265 :stub-columns: 0 2266 :widths: 1 1 2 2267 2268 * - __u8 2269 - ``load_intra_quantiser_matrix`` 2270 - One bit to indicate whether to load the ``intra_quantiser_matrix`` data. 2271 * - __u8 2272 - ``load_non_intra_quantiser_matrix`` 2273 - One bit to indicate whether to load the ``non_intra_quantiser_matrix`` 2274 data. 2275 * - __u8 2276 - ``load_chroma_intra_quantiser_matrix`` 2277 - One bit to indicate whether to load the 2278 ``chroma_intra_quantiser_matrix`` data, only relevant for non-4:2:0 YUV 2279 formats. 2280 * - __u8 2281 - ``load_chroma_non_intra_quantiser_matrix`` 2282 - One bit to indicate whether to load the 2283 ``chroma_non_intra_quantiser_matrix`` data, only relevant for non-4:2:0 2284 YUV formats. 2285 * - __u8 2286 - ``intra_quantiser_matrix[64]`` 2287 - The quantization matrix coefficients for intra-coded frames, in zigzag 2288 scanning order. It is relevant for both luma and chroma components, 2289 although it can be superseded by the chroma-specific matrix for 2290 non-4:2:0 YUV formats. 2291 * - __u8 2292 - ``non_intra_quantiser_matrix[64]`` 2293 - The quantization matrix coefficients for non-intra-coded frames, in 2294 zigzag scanning order. It is relevant for both luma and chroma 2295 components, although it can be superseded by the chroma-specific matrix 2296 for non-4:2:0 YUV formats. 2297 * - __u8 2298 - ``chroma_intra_quantiser_matrix[64]`` 2299 - The quantization matrix coefficients for the chominance component of 2300 intra-coded frames, in zigzag scanning order. Only relevant for 2301 non-4:2:0 YUV formats. 2302 * - __u8 2303 - ``chroma_non_intra_quantiser_matrix[64]`` 2304 - The quantization matrix coefficients for the chrominance component of 2305 non-intra-coded frames, in zigzag scanning order. Only relevant for 2306 non-4:2:0 YUV formats. 2307 2308``V4L2_CID_FWHT_I_FRAME_QP (integer)`` 2309 Quantization parameter for an I frame for FWHT. Valid range: from 1 2310 to 31. 2311 2312``V4L2_CID_FWHT_P_FRAME_QP (integer)`` 2313 Quantization parameter for a P frame for FWHT. Valid range: from 1 2314 to 31. 2315 2316.. _v4l2-mpeg-vp8: 2317 2318``V4L2_CID_MPEG_VIDEO_VP8_FRAME_HEADER (struct)`` 2319 Specifies the frame parameters for the associated VP8 parsed frame data. 2320 This includes the necessary parameters for 2321 configuring a stateless hardware decoding pipeline for VP8. 2322 The bitstream parameters are defined according to :ref:`vp8`. 2323 2324 .. note:: 2325 2326 This compound control is not yet part of the public kernel API and 2327 it is expected to change. 2328 2329.. c:type:: v4l2_ctrl_vp8_frame_header 2330 2331.. cssclass:: longtable 2332 2333.. tabularcolumns:: |p{5.8cm}|p{4.8cm}|p{6.6cm}| 2334 2335.. flat-table:: struct v4l2_ctrl_vp8_frame_header 2336 :header-rows: 0 2337 :stub-columns: 0 2338 :widths: 1 1 2 2339 2340 * - struct :c:type:`v4l2_vp8_segment_header` 2341 - ``segment_header`` 2342 - Structure with segment-based adjustments metadata. 2343 * - struct :c:type:`v4l2_vp8_loopfilter_header` 2344 - ``loopfilter_header`` 2345 - Structure with loop filter level adjustments metadata. 2346 * - struct :c:type:`v4l2_vp8_quantization_header` 2347 - ``quant_header`` 2348 - Structure with VP8 dequantization indices metadata. 2349 * - struct :c:type:`v4l2_vp8_entropy_header` 2350 - ``entropy_header`` 2351 - Structure with VP8 entropy coder probabilities metadata. 2352 * - struct :c:type:`v4l2_vp8_entropy_coder_state` 2353 - ``coder_state`` 2354 - Structure with VP8 entropy coder state. 2355 * - __u16 2356 - ``width`` 2357 - The width of the frame. Must be set for all frames. 2358 * - __u16 2359 - ``height`` 2360 - The height of the frame. Must be set for all frames. 2361 * - __u8 2362 - ``horizontal_scale`` 2363 - Horizontal scaling factor. 2364 * - __u8 2365 - ``vertical_scaling factor`` 2366 - Vertical scale. 2367 * - __u8 2368 - ``version`` 2369 - Bitstream version. 2370 * - __u8 2371 - ``prob_skip_false`` 2372 - Indicates the probability that the macroblock is not skipped. 2373 * - __u8 2374 - ``prob_intra`` 2375 - Indicates the probability that a macroblock is intra-predicted. 2376 * - __u8 2377 - ``prob_last`` 2378 - Indicates the probability that the last reference frame is used 2379 for inter-prediction 2380 * - __u8 2381 - ``prob_gf`` 2382 - Indicates the probability that the golden reference frame is used 2383 for inter-prediction 2384 * - __u8 2385 - ``num_dct_parts`` 2386 - Number of DCT coefficients partitions. Must be one of: 1, 2, 4, or 8. 2387 * - __u32 2388 - ``first_part_size`` 2389 - Size of the first partition, i.e. the control partition. 2390 * - __u32 2391 - ``first_part_header_bits`` 2392 - Size in bits of the first partition header portion. 2393 * - __u32 2394 - ``dct_part_sizes[8]`` 2395 - DCT coefficients sizes. 2396 * - __u64 2397 - ``last_frame_ts`` 2398 - Timestamp for the V4L2 capture buffer to use as last reference frame, used 2399 with inter-coded frames. The timestamp refers to the ``timestamp`` field in 2400 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2401 function to convert the struct :c:type:`timeval` in struct 2402 :c:type:`v4l2_buffer` to a __u64. 2403 * - __u64 2404 - ``golden_frame_ts`` 2405 - Timestamp for the V4L2 capture buffer to use as last reference frame, used 2406 with inter-coded frames. The timestamp refers to the ``timestamp`` field in 2407 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2408 function to convert the struct :c:type:`timeval` in struct 2409 :c:type:`v4l2_buffer` to a __u64. 2410 * - __u64 2411 - ``alt_frame_ts`` 2412 - Timestamp for the V4L2 capture buffer to use as alternate reference frame, used 2413 with inter-coded frames. The timestamp refers to the ``timestamp`` field in 2414 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2415 function to convert the struct :c:type:`timeval` in struct 2416 :c:type:`v4l2_buffer` to a __u64. 2417 * - __u64 2418 - ``flags`` 2419 - See :ref:`Frame Header Flags <vp8_frame_header_flags>` 2420 2421.. _vp8_frame_header_flags: 2422 2423``Frame Header Flags`` 2424 2425.. cssclass:: longtable 2426 2427.. flat-table:: 2428 :header-rows: 0 2429 :stub-columns: 0 2430 :widths: 1 1 2 2431 2432 * - ``V4L2_VP8_FRAME_HEADER_FLAG_KEY_FRAME`` 2433 - 0x01 2434 - Indicates if the frame is a key frame. 2435 * - ``V4L2_VP8_FRAME_HEADER_FLAG_EXPERIMENTAL`` 2436 - 0x02 2437 - Experimental bitstream. 2438 * - ``V4L2_VP8_FRAME_HEADER_FLAG_SHOW_FRAME`` 2439 - 0x04 2440 - Show frame flag, indicates if the frame is for display. 2441 * - ``V4L2_VP8_FRAME_HEADER_FLAG_MB_NO_SKIP_COEFF`` 2442 - 0x08 2443 - Enable/disable skipping of macroblocks with no non-zero coefficients. 2444 * - ``V4L2_VP8_FRAME_HEADER_FLAG_SIGN_BIAS_GOLDEN`` 2445 - 0x10 2446 - Sign of motion vectors when the golden frame is referenced. 2447 * - ``V4L2_VP8_FRAME_HEADER_FLAG_SIGN_BIAS_ALT`` 2448 - 0x20 2449 - Sign of motion vectors when the alt frame is referenced. 2450 2451.. c:type:: v4l2_vp8_entropy_coder_state 2452 2453.. cssclass:: longtable 2454 2455.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2456 2457.. flat-table:: struct v4l2_vp8_entropy_coder_state 2458 :header-rows: 0 2459 :stub-columns: 0 2460 :widths: 1 1 2 2461 2462 * - __u8 2463 - ``range`` 2464 - 2465 * - __u8 2466 - ``value`` 2467 - 2468 * - __u8 2469 - ``bit_count`` 2470 - 2471 * - __u8 2472 - ``padding`` 2473 - Applications and drivers must set this to zero. 2474 2475.. c:type:: v4l2_vp8_segment_header 2476 2477.. cssclass:: longtable 2478 2479.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2480 2481.. flat-table:: struct v4l2_vp8_segment_header 2482 :header-rows: 0 2483 :stub-columns: 0 2484 :widths: 1 1 2 2485 2486 * - __s8 2487 - ``quant_update[4]`` 2488 - Signed quantizer value update. 2489 * - __s8 2490 - ``lf_update[4]`` 2491 - Signed loop filter level value update. 2492 * - __u8 2493 - ``segment_probs[3]`` 2494 - Segment probabilities. 2495 * - __u8 2496 - ``padding`` 2497 - Applications and drivers must set this to zero. 2498 * - __u32 2499 - ``flags`` 2500 - See :ref:`Segment Header Flags <vp8_segment_header_flags>` 2501 2502.. _vp8_segment_header_flags: 2503 2504``Segment Header Flags`` 2505 2506.. cssclass:: longtable 2507 2508.. flat-table:: 2509 :header-rows: 0 2510 :stub-columns: 0 2511 :widths: 1 1 2 2512 2513 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_ENABLED`` 2514 - 0x01 2515 - Enable/disable segment-based adjustments. 2516 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_UPDATE_MAP`` 2517 - 0x02 2518 - Indicates if the macroblock segmentation map is updated in this frame. 2519 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_UPDATE_FEATURE_DATA`` 2520 - 0x04 2521 - Indicates if the segment feature data is updated in this frame. 2522 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_DELTA_VALUE_MODE`` 2523 - 0x08 2524 - If is set, the segment feature data mode is delta-value. 2525 If cleared, it's absolute-value. 2526 2527.. c:type:: v4l2_vp8_loopfilter_header 2528 2529.. cssclass:: longtable 2530 2531.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2532 2533.. flat-table:: struct v4l2_vp8_loopfilter_header 2534 :header-rows: 0 2535 :stub-columns: 0 2536 :widths: 1 1 2 2537 2538 * - __s8 2539 - ``ref_frm_delta[4]`` 2540 - Reference adjustment (signed) delta value. 2541 * - __s8 2542 - ``mb_mode_delta[4]`` 2543 - Macroblock prediction mode adjustment (signed) delta value. 2544 * - __u8 2545 - ``sharpness_level`` 2546 - Sharpness level 2547 * - __u8 2548 - ``level`` 2549 - Filter level 2550 * - __u16 2551 - ``padding`` 2552 - Applications and drivers must set this to zero. 2553 * - __u32 2554 - ``flags`` 2555 - See :ref:`Loopfilter Header Flags <vp8_loopfilter_header_flags>` 2556 2557.. _vp8_loopfilter_header_flags: 2558 2559``Loopfilter Header Flags`` 2560 2561.. cssclass:: longtable 2562 2563.. flat-table:: 2564 :header-rows: 0 2565 :stub-columns: 0 2566 :widths: 1 1 2 2567 2568 * - ``V4L2_VP8_LF_HEADER_ADJ_ENABLE`` 2569 - 0x01 2570 - Enable/disable macroblock-level loop filter adjustment. 2571 * - ``V4L2_VP8_LF_HEADER_DELTA_UPDATE`` 2572 - 0x02 2573 - Indicates if the delta values used in an adjustment are updated. 2574 * - ``V4L2_VP8_LF_FILTER_TYPE_SIMPLE`` 2575 - 0x04 2576 - If set, indicates the filter type is simple. 2577 If cleared, the filter type is normal. 2578 2579.. c:type:: v4l2_vp8_quantization_header 2580 2581.. cssclass:: longtable 2582 2583.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2584 2585.. flat-table:: struct v4l2_vp8_quantization_header 2586 :header-rows: 0 2587 :stub-columns: 0 2588 :widths: 1 1 2 2589 2590 * - __u8 2591 - ``y_ac_qi`` 2592 - Luma AC coefficient table index. 2593 * - __s8 2594 - ``y_dc_delta`` 2595 - Luma DC delta vaue. 2596 * - __s8 2597 - ``y2_dc_delta`` 2598 - Y2 block DC delta value. 2599 * - __s8 2600 - ``y2_ac_delta`` 2601 - Y2 block AC delta value. 2602 * - __s8 2603 - ``uv_dc_delta`` 2604 - Chroma DC delta value. 2605 * - __s8 2606 - ``uv_ac_delta`` 2607 - Chroma AC delta value. 2608 * - __u16 2609 - ``padding`` 2610 - Applications and drivers must set this to zero. 2611 2612.. c:type:: v4l2_vp8_entropy_header 2613 2614.. cssclass:: longtable 2615 2616.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2617 2618.. flat-table:: struct v4l2_vp8_entropy_header 2619 :header-rows: 0 2620 :stub-columns: 0 2621 :widths: 1 1 2 2622 2623 * - __u8 2624 - ``coeff_probs[4][8][3][11]`` 2625 - Coefficient update probabilities. 2626 * - __u8 2627 - ``y_mode_probs[4]`` 2628 - Luma mode update probabilities. 2629 * - __u8 2630 - ``uv_mode_probs[3]`` 2631 - Chroma mode update probabilities. 2632 * - __u8 2633 - ``mv_probs[2][19]`` 2634 - MV decoding update probabilities. 2635 * - __u8 2636 - ``padding[3]`` 2637 - Applications and drivers must set this to zero. 2638 2639.. raw:: latex 2640 2641 \normalsize 2642 2643 2644MFC 5.1 MPEG Controls 2645===================== 2646 2647The following MPEG class controls deal with MPEG decoding and encoding 2648settings that are specific to the Multi Format Codec 5.1 device present 2649in the S5P family of SoCs by Samsung. 2650 2651 2652.. _mfc51-control-id: 2653 2654MFC 5.1 Control IDs 2655------------------- 2656 2657``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE (boolean)`` 2658 If the display delay is enabled then the decoder is forced to return 2659 a CAPTURE buffer (decoded frame) after processing a certain number 2660 of OUTPUT buffers. The delay can be set through 2661 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY``. This 2662 feature can be used for example for generating thumbnails of videos. 2663 Applicable to the H264 decoder. 2664 2665``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY (integer)`` 2666 Display delay value for H264 decoder. The decoder is forced to 2667 return a decoded frame after the set 'display delay' number of 2668 frames. If this number is low it may result in frames returned out 2669 of display order, in addition the hardware may still be using the 2670 returned buffer as a reference picture for subsequent frames. 2671 2672``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)`` 2673 The number of reference pictures used for encoding a P picture. 2674 Applicable to the H264 encoder. 2675 2676``V4L2_CID_MPEG_MFC51_VIDEO_PADDING (boolean)`` 2677 Padding enable in the encoder - use a color instead of repeating 2678 border pixels. Applicable to encoders. 2679 2680``V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV (integer)`` 2681 Padding color in the encoder. Applicable to encoders. The supplied 2682 32-bit integer is interpreted as follows (bit 0 = least significant 2683 bit): 2684 2685 2686 2687.. flat-table:: 2688 :header-rows: 0 2689 :stub-columns: 0 2690 2691 * - Bit 0:7 2692 - V chrominance information 2693 * - Bit 8:15 2694 - U chrominance information 2695 * - Bit 16:23 2696 - Y luminance information 2697 * - Bit 24:31 2698 - Must be zero. 2699 2700 2701 2702``V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF (integer)`` 2703 Reaction coefficient for MFC rate control. Applicable to encoders. 2704 2705 .. note:: 2706 2707 #. Valid only when the frame level RC is enabled. 2708 2709 #. For tight CBR, this field must be small (ex. 2 ~ 10). For 2710 VBR, this field must be large (ex. 100 ~ 1000). 2711 2712 #. It is not recommended to use the greater number than 2713 FRAME_RATE * (10^9 / BIT_RATE). 2714 2715``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK (boolean)`` 2716 Adaptive rate control for dark region. Valid only when H.264 and 2717 macroblock level RC is enabled 2718 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2719 encoder. 2720 2721``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH (boolean)`` 2722 Adaptive rate control for smooth region. Valid only when H.264 and 2723 macroblock level RC is enabled 2724 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2725 encoder. 2726 2727``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC (boolean)`` 2728 Adaptive rate control for static region. Valid only when H.264 and 2729 macroblock level RC is enabled 2730 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2731 encoder. 2732 2733``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY (boolean)`` 2734 Adaptive rate control for activity region. Valid only when H.264 and 2735 macroblock level RC is enabled 2736 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2737 encoder. 2738 2739.. _v4l2-mpeg-mfc51-video-frame-skip-mode: 2740 2741``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE`` 2742 (enum) 2743 2744enum v4l2_mpeg_mfc51_video_frame_skip_mode - 2745 Indicates in what conditions the encoder should skip frames. If 2746 encoding a frame would cause the encoded stream to be larger then a 2747 chosen data limit then the frame will be skipped. Possible values 2748 are: 2749 2750 2751.. tabularcolumns:: |p{9.2cm}|p{8.3cm}| 2752 2753.. raw:: latex 2754 2755 \small 2756 2757.. flat-table:: 2758 :header-rows: 0 2759 :stub-columns: 0 2760 2761 * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED`` 2762 - Frame skip mode is disabled. 2763 * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT`` 2764 - Frame skip mode enabled and buffer limit is set by the chosen 2765 level and is defined by the standard. 2766 * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT`` 2767 - Frame skip mode enabled and buffer limit is set by the VBV 2768 (MPEG1/2/4) or CPB (H264) buffer size control. 2769 2770.. raw:: latex 2771 2772 \normalsize 2773 2774``V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT (integer)`` 2775 Enable rate-control with fixed target bit. If this setting is 2776 enabled, then the rate control logic of the encoder will calculate 2777 the average bitrate for a GOP and keep it below or equal the set 2778 bitrate target. Otherwise the rate control logic calculates the 2779 overall average bitrate for the stream and keeps it below or equal 2780 to the set bitrate. In the first case the average bitrate for the 2781 whole stream will be smaller then the set bitrate. This is caused 2782 because the average is calculated for smaller number of frames, on 2783 the other hand enabling this setting will ensure that the stream 2784 will meet tight bandwidth constraints. Applicable to encoders. 2785 2786.. _v4l2-mpeg-mfc51-video-force-frame-type: 2787 2788``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE`` 2789 (enum) 2790 2791enum v4l2_mpeg_mfc51_video_force_frame_type - 2792 Force a frame type for the next queued buffer. Applicable to 2793 encoders. Possible values are: 2794 2795.. tabularcolumns:: |p{9.5cm}|p{8.0cm}| 2796 2797.. flat-table:: 2798 :header-rows: 0 2799 :stub-columns: 0 2800 2801 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED`` 2802 - Forcing a specific frame type disabled. 2803 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME`` 2804 - Force an I-frame. 2805 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED`` 2806 - Force a non-coded frame. 2807 2808 2809.. _v4l2-mpeg-fwht: 2810 2811``V4L2_CID_MPEG_VIDEO_FWHT_PARAMS (struct)`` 2812 Specifies the fwht parameters (as extracted from the bitstream) for the 2813 associated FWHT data. This includes the necessary parameters for 2814 configuring a stateless hardware decoding pipeline for FWHT. 2815 2816 .. note:: 2817 2818 This compound control is not yet part of the public kernel API and 2819 it is expected to change. 2820 2821.. c:type:: v4l2_ctrl_fwht_params 2822 2823.. cssclass:: longtable 2824 2825.. tabularcolumns:: |p{1.4cm}|p{4.3cm}|p{11.8cm}| 2826 2827.. flat-table:: struct v4l2_ctrl_fwht_params 2828 :header-rows: 0 2829 :stub-columns: 0 2830 :widths: 1 1 2 2831 2832 * - __u64 2833 - ``backward_ref_ts`` 2834 - Timestamp of the V4L2 capture buffer to use as backward reference, used 2835 with P-coded frames. The timestamp refers to the 2836 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 2837 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 2838 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 2839 * - __u32 2840 - ``version`` 2841 - The version of the codec 2842 * - __u32 2843 - ``width`` 2844 - The width of the frame 2845 * - __u32 2846 - ``height`` 2847 - The height of the frame 2848 * - __u32 2849 - ``flags`` 2850 - The flags of the frame, see :ref:`fwht-flags`. 2851 * - __u32 2852 - ``colorspace`` 2853 - The colorspace of the frame, from enum :c:type:`v4l2_colorspace`. 2854 * - __u32 2855 - ``xfer_func`` 2856 - The transfer function, from enum :c:type:`v4l2_xfer_func`. 2857 * - __u32 2858 - ``ycbcr_enc`` 2859 - The Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`. 2860 * - __u32 2861 - ``quantization`` 2862 - The quantization range, from enum :c:type:`v4l2_quantization`. 2863 2864 2865 2866.. _fwht-flags: 2867 2868FWHT Flags 2869============ 2870 2871.. cssclass:: longtable 2872 2873.. tabularcolumns:: |p{6.8cm}|p{2.4cm}|p{8.3cm}| 2874 2875.. flat-table:: 2876 :header-rows: 0 2877 :stub-columns: 0 2878 :widths: 3 1 4 2879 2880 * - ``FWHT_FL_IS_INTERLACED`` 2881 - 0x00000001 2882 - Set if this is an interlaced format 2883 * - ``FWHT_FL_IS_BOTTOM_FIRST`` 2884 - 0x00000002 2885 - Set if this is a bottom-first (NTSC) interlaced format 2886 * - ``FWHT_FL_IS_ALTERNATE`` 2887 - 0x00000004 2888 - Set if each 'frame' contains just one field 2889 * - ``FWHT_FL_IS_BOTTOM_FIELD`` 2890 - 0x00000008 2891 - If FWHT_FL_IS_ALTERNATE was set, then this is set if this 'frame' is the 2892 bottom field, else it is the top field. 2893 * - ``FWHT_FL_LUMA_IS_UNCOMPRESSED`` 2894 - 0x00000010 2895 - Set if the luma plane is uncompressed 2896 * - ``FWHT_FL_CB_IS_UNCOMPRESSED`` 2897 - 0x00000020 2898 - Set if the cb plane is uncompressed 2899 * - ``FWHT_FL_CR_IS_UNCOMPRESSED`` 2900 - 0x00000040 2901 - Set if the cr plane is uncompressed 2902 * - ``FWHT_FL_CHROMA_FULL_HEIGHT`` 2903 - 0x00000080 2904 - Set if the chroma plane has the same height as the luma plane, 2905 else the chroma plane is half the height of the luma plane 2906 * - ``FWHT_FL_CHROMA_FULL_WIDTH`` 2907 - 0x00000100 2908 - Set if the chroma plane has the same width as the luma plane, 2909 else the chroma plane is half the width of the luma plane 2910 * - ``FWHT_FL_ALPHA_IS_UNCOMPRESSED`` 2911 - 0x00000200 2912 - Set if the alpha plane is uncompressed 2913 * - ``FWHT_FL_I_FRAME`` 2914 - 0x00000400 2915 - Set if this is an I-frame 2916 * - ``FWHT_FL_COMPONENTS_NUM_MSK`` 2917 - 0x00070000 2918 - A 4-values flag - the number of components - 1 2919 * - ``FWHT_FL_PIXENC_YUV`` 2920 - 0x00080000 2921 - Set if the pixel encoding is YUV 2922 * - ``FWHT_FL_PIXENC_RGB`` 2923 - 0x00100000 2924 - Set if the pixel encoding is RGB 2925 * - ``FWHT_FL_PIXENC_HSV`` 2926 - 0x00180000 2927 - Set if the pixel encoding is HSV 2928 2929 2930CX2341x MPEG Controls 2931===================== 2932 2933The following MPEG class controls deal with MPEG encoding settings that 2934are specific to the Conexant CX23415 and CX23416 MPEG encoding chips. 2935 2936 2937.. _cx2341x-control-id: 2938 2939CX2341x Control IDs 2940------------------- 2941 2942.. _v4l2-mpeg-cx2341x-video-spatial-filter-mode: 2943 2944``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE`` 2945 (enum) 2946 2947enum v4l2_mpeg_cx2341x_video_spatial_filter_mode - 2948 Sets the Spatial Filter mode (default ``MANUAL``). Possible values 2949 are: 2950 2951 2952 2953.. flat-table:: 2954 :header-rows: 0 2955 :stub-columns: 0 2956 2957 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL`` 2958 - Choose the filter manually 2959 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO`` 2960 - Choose the filter automatically 2961 2962 2963 2964``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (integer (0-15))`` 2965 The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default 2966 is 0.) 2967 2968.. _luma-spatial-filter-type: 2969 2970``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE`` 2971 (enum) 2972 2973enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type - 2974 Select the algorithm to use for the Luma Spatial Filter (default 2975 ``1D_HOR``). Possible values: 2976 2977.. tabularcolumns:: |p{14.5cm}|p{3.0cm}| 2978 2979.. raw:: latex 2980 2981 \small 2982 2983.. flat-table:: 2984 :header-rows: 0 2985 :stub-columns: 0 2986 2987 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF`` 2988 - No filter 2989 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR`` 2990 - One-dimensional horizontal 2991 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT`` 2992 - One-dimensional vertical 2993 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE`` 2994 - Two-dimensional separable 2995 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE`` 2996 - Two-dimensional symmetrical non-separable 2997 2998.. raw:: latex 2999 3000 \normalsize 3001 3002 3003 3004.. _chroma-spatial-filter-type: 3005 3006``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE`` 3007 (enum) 3008 3009enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type - 3010 Select the algorithm for the Chroma Spatial Filter (default 3011 ``1D_HOR``). Possible values are: 3012 3013 3014.. tabularcolumns:: |p{14.0cm}|p{3.5cm}| 3015 3016.. flat-table:: 3017 :header-rows: 0 3018 :stub-columns: 0 3019 3020 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF`` 3021 - No filter 3022 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR`` 3023 - One-dimensional horizontal 3024 3025 3026 3027.. _v4l2-mpeg-cx2341x-video-temporal-filter-mode: 3028 3029``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE`` 3030 (enum) 3031 3032enum v4l2_mpeg_cx2341x_video_temporal_filter_mode - 3033 Sets the Temporal Filter mode (default ``MANUAL``). Possible values 3034 are: 3035 3036 3037 3038.. flat-table:: 3039 :header-rows: 0 3040 :stub-columns: 0 3041 3042 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL`` 3043 - Choose the filter manually 3044 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO`` 3045 - Choose the filter automatically 3046 3047 3048 3049``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (integer (0-31))`` 3050 The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default 3051 is 8 for full-scale capturing and 0 for scaled capturing.) 3052 3053.. _v4l2-mpeg-cx2341x-video-median-filter-type: 3054 3055``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE`` 3056 (enum) 3057 3058enum v4l2_mpeg_cx2341x_video_median_filter_type - 3059 Median Filter Type (default ``OFF``). Possible values are: 3060 3061 3062 3063.. flat-table:: 3064 :header-rows: 0 3065 :stub-columns: 0 3066 3067 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF`` 3068 - No filter 3069 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR`` 3070 - Horizontal filter 3071 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT`` 3072 - Vertical filter 3073 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT`` 3074 - Horizontal and vertical filter 3075 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG`` 3076 - Diagonal filter 3077 3078 3079 3080``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 3081 Threshold above which the luminance median filter is enabled 3082 (default 0) 3083 3084``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (integer (0-255))`` 3085 Threshold below which the luminance median filter is enabled 3086 (default 255) 3087 3088``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 3089 Threshold above which the chroma median filter is enabled (default 3090 0) 3091 3092``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (integer (0-255))`` 3093 Threshold below which the chroma median filter is enabled (default 3094 255) 3095 3096``V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (boolean)`` 3097 The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into 3098 the stream between every four video frames. The packet size is 2048 3099 bytes, including the packet_start_code_prefix and stream_id 3100 fields. The stream_id is 0xBF (private stream 2). The payload 3101 consists of 0x00 bytes, to be filled in by the application. 0 = do 3102 not insert, 1 = insert packets. 3103 3104 3105VPX Control Reference 3106===================== 3107 3108The VPX controls include controls for encoding parameters of VPx video 3109codec. 3110 3111 3112.. _vpx-control-id: 3113 3114VPX Control IDs 3115--------------- 3116 3117.. _v4l2-vpx-num-partitions: 3118 3119``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS`` 3120 (enum) 3121 3122enum v4l2_vp8_num_partitions - 3123 The number of token partitions to use in VP8 encoder. Possible 3124 values are: 3125 3126 3127 3128.. flat-table:: 3129 :header-rows: 0 3130 :stub-columns: 0 3131 3132 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION`` 3133 - 1 coefficient partition 3134 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS`` 3135 - 2 coefficient partitions 3136 * - ``V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS`` 3137 - 4 coefficient partitions 3138 * - ``V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS`` 3139 - 8 coefficient partitions 3140 3141 3142 3143``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)`` 3144 Setting this prevents intra 4x4 mode in the intra mode decision. 3145 3146.. _v4l2-vpx-num-ref-frames: 3147 3148``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES`` 3149 (enum) 3150 3151enum v4l2_vp8_num_ref_frames - 3152 The number of reference pictures for encoding P frames. Possible 3153 values are: 3154 3155.. tabularcolumns:: |p{7.9cm}|p{9.6cm}| 3156 3157.. raw:: latex 3158 3159 \small 3160 3161.. flat-table:: 3162 :header-rows: 0 3163 :stub-columns: 0 3164 3165 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME`` 3166 - Last encoded frame will be searched 3167 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME`` 3168 - Two frames will be searched among the last encoded frame, the 3169 golden frame and the alternate reference (altref) frame. The 3170 encoder implementation will decide which two are chosen. 3171 * - ``V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME`` 3172 - The last encoded frame, the golden frame and the altref frame will 3173 be searched. 3174 3175.. raw:: latex 3176 3177 \normalsize 3178 3179 3180 3181``V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL (integer)`` 3182 Indicates the loop filter level. The adjustment of the loop filter 3183 level is done via a delta value against a baseline loop filter 3184 value. 3185 3186``V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS (integer)`` 3187 This parameter affects the loop filter. Anything above zero weakens 3188 the deblocking effect on the loop filter. 3189 3190``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD (integer)`` 3191 Sets the refresh period for the golden frame. The period is defined 3192 in number of frames. For a value of 'n', every nth frame starting 3193 from the first key frame will be taken as a golden frame. For eg. 3194 for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden 3195 frame refresh period is set as 4, the frames 0, 4, 8 etc will be 3196 taken as the golden frames as frame 0 is always a key frame. 3197 3198.. _v4l2-vpx-golden-frame-sel: 3199 3200``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL`` 3201 (enum) 3202 3203enum v4l2_vp8_golden_frame_sel - 3204 Selects the golden frame for encoding. Possible values are: 3205 3206.. raw:: latex 3207 3208 \scriptsize 3209 3210.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3211 3212.. flat-table:: 3213 :header-rows: 0 3214 :stub-columns: 0 3215 3216 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV`` 3217 - Use the (n-2)th frame as a golden frame, current frame index being 3218 'n'. 3219 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD`` 3220 - Use the previous specific frame indicated by 3221 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD`` as a 3222 golden frame. 3223 3224.. raw:: latex 3225 3226 \normalsize 3227 3228 3229``V4L2_CID_MPEG_VIDEO_VPX_MIN_QP (integer)`` 3230 Minimum quantization parameter for VP8. 3231 3232``V4L2_CID_MPEG_VIDEO_VPX_MAX_QP (integer)`` 3233 Maximum quantization parameter for VP8. 3234 3235``V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP (integer)`` 3236 Quantization parameter for an I frame for VP8. 3237 3238``V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP (integer)`` 3239 Quantization parameter for a P frame for VP8. 3240 3241.. _v4l2-mpeg-video-vp8-profile: 3242 3243``V4L2_CID_MPEG_VIDEO_VP8_PROFILE`` 3244 (enum) 3245 3246enum v4l2_mpeg_video_vp8_profile - 3247 This control allows selecting the profile for VP8 encoder. 3248 This is also used to enumerate supported profiles by VP8 encoder or decoder. 3249 Possible values are: 3250 3251.. flat-table:: 3252 :header-rows: 0 3253 :stub-columns: 0 3254 3255 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_0`` 3256 - Profile 0 3257 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_1`` 3258 - Profile 1 3259 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_2`` 3260 - Profile 2 3261 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_3`` 3262 - Profile 3 3263 3264.. _v4l2-mpeg-video-vp9-profile: 3265 3266``V4L2_CID_MPEG_VIDEO_VP9_PROFILE`` 3267 (enum) 3268 3269enum v4l2_mpeg_video_vp9_profile - 3270 This control allows selecting the profile for VP9 encoder. 3271 This is also used to enumerate supported profiles by VP9 encoder or decoder. 3272 Possible values are: 3273 3274.. flat-table:: 3275 :header-rows: 0 3276 :stub-columns: 0 3277 3278 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_0`` 3279 - Profile 0 3280 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_1`` 3281 - Profile 1 3282 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_2`` 3283 - Profile 2 3284 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_3`` 3285 - Profile 3 3286 3287 3288High Efficiency Video Coding (HEVC/H.265) Control Reference 3289=========================================================== 3290 3291The HEVC/H.265 controls include controls for encoding parameters of HEVC/H.265 3292video codec. 3293 3294 3295.. _hevc-control-id: 3296 3297HEVC/H.265 Control IDs 3298---------------------- 3299 3300``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP (integer)`` 3301 Minimum quantization parameter for HEVC. 3302 Valid range: from 0 to 51. 3303 3304``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP (integer)`` 3305 Maximum quantization parameter for HEVC. 3306 Valid range: from 0 to 51. 3307 3308``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP (integer)`` 3309 Quantization parameter for an I frame for HEVC. 3310 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3311 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3312 3313``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP (integer)`` 3314 Quantization parameter for a P frame for HEVC. 3315 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3316 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3317 3318``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP (integer)`` 3319 Quantization parameter for a B frame for HEVC. 3320 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3321 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3322 3323``V4L2_CID_MPEG_VIDEO_HEVC_HIER_QP (boolean)`` 3324 HIERARCHICAL_QP allows the host to specify the quantization parameter 3325 values for each temporal layer through HIERARCHICAL_QP_LAYER. This is 3326 valid only if HIERARCHICAL_CODING_LAYER is greater than 1. Setting the 3327 control value to 1 enables setting of the QP values for the layers. 3328 3329.. _v4l2-hevc-hier-coding-type: 3330 3331``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_TYPE`` 3332 (enum) 3333 3334enum v4l2_mpeg_video_hevc_hier_coding_type - 3335 Selects the hierarchical coding type for encoding. Possible values are: 3336 3337.. raw:: latex 3338 3339 \footnotesize 3340 3341.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3342 3343.. flat-table:: 3344 :header-rows: 0 3345 :stub-columns: 0 3346 3347 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B`` 3348 - Use the B frame for hierarchical coding. 3349 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P`` 3350 - Use the P frame for hierarchical coding. 3351 3352.. raw:: latex 3353 3354 \normalsize 3355 3356 3357``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER (integer)`` 3358 Selects the hierarchical coding layer. In normal encoding 3359 (non-hierarchial coding), it should be zero. Possible values are [0, 6]. 3360 0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING 3361 LAYER 1 and so on. 3362 3363``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_QP (integer)`` 3364 Indicates quantization parameter for hierarchical coding layer 0. 3365 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3366 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3367 3368``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_QP (integer)`` 3369 Indicates quantization parameter for hierarchical coding layer 1. 3370 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3371 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3372 3373``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_QP (integer)`` 3374 Indicates quantization parameter for hierarchical coding layer 2. 3375 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3376 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3377 3378``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_QP (integer)`` 3379 Indicates quantization parameter for hierarchical coding layer 3. 3380 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3381 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3382 3383``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_QP (integer)`` 3384 Indicates quantization parameter for hierarchical coding layer 4. 3385 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3386 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3387 3388``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_QP (integer)`` 3389 Indicates quantization parameter for hierarchical coding layer 5. 3390 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3391 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3392 3393``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_QP (integer)`` 3394 Indicates quantization parameter for hierarchical coding layer 6. 3395 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3396 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3397 3398.. _v4l2-hevc-profile: 3399 3400``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE`` 3401 (enum) 3402 3403enum v4l2_mpeg_video_hevc_profile - 3404 Select the desired profile for HEVC encoder. 3405 3406.. raw:: latex 3407 3408 \footnotesize 3409 3410.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3411 3412.. flat-table:: 3413 :header-rows: 0 3414 :stub-columns: 0 3415 3416 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN`` 3417 - Main profile. 3418 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE`` 3419 - Main still picture profile. 3420 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_10`` 3421 - Main 10 profile. 3422 3423.. raw:: latex 3424 3425 \normalsize 3426 3427 3428.. _v4l2-hevc-level: 3429 3430``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL`` 3431 (enum) 3432 3433enum v4l2_mpeg_video_hevc_level - 3434 Selects the desired level for HEVC encoder. 3435 3436.. raw:: latex 3437 3438 \footnotesize 3439 3440.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3441 3442.. flat-table:: 3443 :header-rows: 0 3444 :stub-columns: 0 3445 3446 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_1`` 3447 - Level 1.0 3448 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2`` 3449 - Level 2.0 3450 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1`` 3451 - Level 2.1 3452 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3`` 3453 - Level 3.0 3454 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1`` 3455 - Level 3.1 3456 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4`` 3457 - Level 4.0 3458 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1`` 3459 - Level 4.1 3460 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5`` 3461 - Level 5.0 3462 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1`` 3463 - Level 5.1 3464 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2`` 3465 - Level 5.2 3466 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6`` 3467 - Level 6.0 3468 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1`` 3469 - Level 6.1 3470 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2`` 3471 - Level 6.2 3472 3473.. raw:: latex 3474 3475 \normalsize 3476 3477 3478``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION (integer)`` 3479 Indicates the number of evenly spaced subintervals, called ticks, within 3480 one second. This is a 16 bit unsigned integer and has a maximum value up to 3481 0xffff and a minimum value of 1. 3482 3483.. _v4l2-hevc-tier: 3484 3485``V4L2_CID_MPEG_VIDEO_HEVC_TIER`` 3486 (enum) 3487 3488enum v4l2_mpeg_video_hevc_tier - 3489 TIER_FLAG specifies tiers information of the HEVC encoded picture. Tier 3490 were made to deal with applications that differ in terms of maximum bit 3491 rate. Setting the flag to 0 selects HEVC tier as Main tier and setting 3492 this flag to 1 indicates High tier. High tier is for applications requiring 3493 high bit rates. 3494 3495.. raw:: latex 3496 3497 \footnotesize 3498 3499.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3500 3501.. flat-table:: 3502 :header-rows: 0 3503 :stub-columns: 0 3504 3505 * - ``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN`` 3506 - Main tier. 3507 * - ``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH`` 3508 - High tier. 3509 3510.. raw:: latex 3511 3512 \normalsize 3513 3514 3515``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH (integer)`` 3516 Selects HEVC maximum coding unit depth. 3517 3518.. _v4l2-hevc-loop-filter-mode: 3519 3520``V4L2_CID_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE`` 3521 (enum) 3522 3523enum v4l2_mpeg_video_hevc_loop_filter_mode - 3524 Loop filter mode for HEVC encoder. Possible values are: 3525 3526.. raw:: latex 3527 3528 \footnotesize 3529 3530.. tabularcolumns:: |p{12.1cm}|p{5.4cm}| 3531 3532.. flat-table:: 3533 :header-rows: 0 3534 :stub-columns: 0 3535 3536 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED`` 3537 - Loop filter is disabled. 3538 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_ENABLED`` 3539 - Loop filter is enabled. 3540 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY`` 3541 - Loop filter is disabled at the slice boundary. 3542 3543.. raw:: latex 3544 3545 \normalsize 3546 3547 3548``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2 (integer)`` 3549 Selects HEVC loop filter beta offset. The valid range is [-6, +6]. 3550 3551``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2 (integer)`` 3552 Selects HEVC loop filter tc offset. The valid range is [-6, +6]. 3553 3554.. _v4l2-hevc-refresh-type: 3555 3556``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE`` 3557 (enum) 3558 3559enum v4l2_mpeg_video_hevc_hier_refresh_type - 3560 Selects refresh type for HEVC encoder. 3561 Host has to specify the period into 3562 V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD. 3563 3564.. raw:: latex 3565 3566 \footnotesize 3567 3568.. tabularcolumns:: |p{8.0cm}|p{9.0cm}| 3569 3570.. flat-table:: 3571 :header-rows: 0 3572 :stub-columns: 0 3573 3574 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE`` 3575 - Use the B frame for hierarchical coding. 3576 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA`` 3577 - Use CRA (Clean Random Access Unit) picture encoding. 3578 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR`` 3579 - Use IDR (Instantaneous Decoding Refresh) picture encoding. 3580 3581.. raw:: latex 3582 3583 \normalsize 3584 3585 3586``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD (integer)`` 3587 Selects the refresh period for HEVC encoder. 3588 This specifies the number of I pictures between two CRA/IDR pictures. 3589 This is valid only if REFRESH_TYPE is not 0. 3590 3591``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU (boolean)`` 3592 Indicates HEVC lossless encoding. Setting it to 0 disables lossless 3593 encoding. Setting it to 1 enables lossless encoding. 3594 3595``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED (boolean)`` 3596 Indicates constant intra prediction for HEVC encoder. Specifies the 3597 constrained intra prediction in which intra largest coding unit (LCU) 3598 prediction is performed by using residual data and decoded samples of 3599 neighboring intra LCU only. Setting the value to 1 enables constant intra 3600 prediction and setting the value to 0 disables constant intra prediction. 3601 3602``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT (boolean)`` 3603 Indicates wavefront parallel processing for HEVC encoder. Setting it to 0 3604 disables the feature and setting it to 1 enables the wavefront parallel 3605 processing. 3606 3607``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB (boolean)`` 3608 Setting the value to 1 enables combination of P and B frame for HEVC 3609 encoder. 3610 3611``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID (boolean)`` 3612 Indicates temporal identifier for HEVC encoder which is enabled by 3613 setting the value to 1. 3614 3615``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING (boolean)`` 3616 Indicates bi-linear interpolation is conditionally used in the intra 3617 prediction filtering process in the CVS when set to 1. Indicates bi-linear 3618 interpolation is not used in the CVS when set to 0. 3619 3620``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1 (integer)`` 3621 Indicates maximum number of merge candidate motion vectors. 3622 Values are from 0 to 4. 3623 3624``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION (boolean)`` 3625 Indicates temporal motion vector prediction for HEVC encoder. Setting it to 3626 1 enables the prediction. Setting it to 0 disables the prediction. 3627 3628``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE (boolean)`` 3629 Specifies if HEVC generates a stream with a size of the length field 3630 instead of start code pattern. The size of the length field is configurable 3631 through the V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD control. Setting 3632 the value to 0 disables encoding without startcode pattern. Setting the 3633 value to 1 will enables encoding without startcode pattern. 3634 3635.. _v4l2-hevc-size-of-length-field: 3636 3637``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD`` 3638(enum) 3639 3640enum v4l2_mpeg_video_hevc_size_of_length_field - 3641 Indicates the size of length field. 3642 This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled. 3643 3644.. raw:: latex 3645 3646 \footnotesize 3647 3648.. tabularcolumns:: |p{6.0cm}|p{11.0cm}| 3649 3650.. flat-table:: 3651 :header-rows: 0 3652 :stub-columns: 0 3653 3654 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0`` 3655 - Generate start code pattern (Normal). 3656 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1`` 3657 - Generate size of length field instead of start code pattern and length is 1. 3658 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2`` 3659 - Generate size of length field instead of start code pattern and length is 2. 3660 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4`` 3661 - Generate size of length field instead of start code pattern and length is 4. 3662 3663.. raw:: latex 3664 3665 \normalsize 3666 3667``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_BR (integer)`` 3668 Indicates bit rate for hierarchical coding layer 0 for HEVC encoder. 3669 3670``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_BR (integer)`` 3671 Indicates bit rate for hierarchical coding layer 1 for HEVC encoder. 3672 3673``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_BR (integer)`` 3674 Indicates bit rate for hierarchical coding layer 2 for HEVC encoder. 3675 3676``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_BR (integer)`` 3677 Indicates bit rate for hierarchical coding layer 3 for HEVC encoder. 3678 3679``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_BR (integer)`` 3680 Indicates bit rate for hierarchical coding layer 4 for HEVC encoder. 3681 3682``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_BR (integer)`` 3683 Indicates bit rate for hierarchical coding layer 5 for HEVC encoder. 3684 3685``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_BR (integer)`` 3686 Indicates bit rate for hierarchical coding layer 6 for HEVC encoder. 3687 3688``V4L2_CID_MPEG_VIDEO_REF_NUMBER_FOR_PFRAMES (integer)`` 3689 Selects number of P reference pictures required for HEVC encoder. 3690 P-Frame can use 1 or 2 frames for reference. 3691 3692``V4L2_CID_MPEG_VIDEO_PREPEND_SPSPPS_TO_IDR (integer)`` 3693 Indicates whether to generate SPS and PPS at every IDR. Setting it to 0 3694 disables generating SPS and PPS at every IDR. Setting it to one enables 3695 generating SPS and PPS at every IDR. 3696