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/userspace-api/media/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/userspace-api/media/drivers/cx2341x-uapi.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 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_5_2`` 760 - Level 5.2 761 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_0`` 762 - Level 6.0 763 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_1`` 764 - Level 6.1 765 * - ``V4L2_MPEG_VIDEO_H264_LEVEL_6_2`` 766 - Level 6.2 767 768 769 770.. _v4l2-mpeg-video-mpeg2-level: 771 772``V4L2_CID_MPEG_VIDEO_MPEG2_LEVEL`` 773 (enum) 774 775enum v4l2_mpeg_video_mpeg2_level - 776 The level information for the MPEG2 elementary stream. Applicable to 777 MPEG2 codecs. Possible values are: 778 779 780 781.. flat-table:: 782 :header-rows: 0 783 :stub-columns: 0 784 785 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_LOW`` 786 - Low Level (LL) 787 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_MAIN`` 788 - Main Level (ML) 789 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH_1440`` 790 - High-1440 Level (H-14) 791 * - ``V4L2_MPEG_VIDEO_MPEG2_LEVEL_HIGH`` 792 - High Level (HL) 793 794 795 796.. _v4l2-mpeg-video-mpeg4-level: 797 798``V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL`` 799 (enum) 800 801enum v4l2_mpeg_video_mpeg4_level - 802 The level information for the MPEG4 elementary stream. Applicable to 803 the MPEG4 encoder. Possible values are: 804 805 806 807.. flat-table:: 808 :header-rows: 0 809 :stub-columns: 0 810 811 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0`` 812 - Level 0 813 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_0B`` 814 - Level 0b 815 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_1`` 816 - Level 1 817 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_2`` 818 - Level 2 819 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3`` 820 - Level 3 821 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_3B`` 822 - Level 3b 823 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_4`` 824 - Level 4 825 * - ``V4L2_MPEG_VIDEO_MPEG4_LEVEL_5`` 826 - Level 5 827 828 829 830.. _v4l2-mpeg-video-h264-profile: 831 832``V4L2_CID_MPEG_VIDEO_H264_PROFILE`` 833 (enum) 834 835enum v4l2_mpeg_video_h264_profile - 836 The profile information for H264. Applicable to the H264 encoder. 837 Possible values are: 838 839 840 841.. flat-table:: 842 :header-rows: 0 843 :stub-columns: 0 844 845 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE`` 846 - Baseline profile 847 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE`` 848 - Constrained Baseline profile 849 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MAIN`` 850 - Main profile 851 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED`` 852 - Extended profile 853 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH`` 854 - High profile 855 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10`` 856 - High 10 profile 857 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422`` 858 - High 422 profile 859 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE`` 860 - High 444 Predictive profile 861 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA`` 862 - High 10 Intra profile 863 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA`` 864 - High 422 Intra profile 865 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA`` 866 - High 444 Intra profile 867 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA`` 868 - CAVLC 444 Intra profile 869 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE`` 870 - Scalable Baseline profile 871 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH`` 872 - Scalable High profile 873 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA`` 874 - Scalable High Intra profile 875 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH`` 876 - Stereo High profile 877 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH`` 878 - Multiview High profile 879 * - ``V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_HIGH`` 880 - Constrained High profile 881 882 883 884.. _v4l2-mpeg-video-mpeg2-profile: 885 886``V4L2_CID_MPEG_VIDEO_MPEG2_PROFILE`` 887 (enum) 888 889enum v4l2_mpeg_video_mpeg2_profile - 890 The profile information for MPEG2. Applicable to MPEG2 codecs. 891 Possible values are: 892 893 894 895.. flat-table:: 896 :header-rows: 0 897 :stub-columns: 0 898 899 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SIMPLE`` 900 - Simple profile (SP) 901 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MAIN`` 902 - Main profile (MP) 903 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SNR_SCALABLE`` 904 - SNR Scalable profile (SNR) 905 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_SPATIALLY_SCALABLE`` 906 - Spatially Scalable profile (Spt) 907 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_HIGH`` 908 - High profile (HP) 909 * - ``V4L2_MPEG_VIDEO_MPEG2_PROFILE_MULTIVIEW`` 910 - Multi-view profile (MVP) 911 912 913 914.. _v4l2-mpeg-video-mpeg4-profile: 915 916``V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE`` 917 (enum) 918 919enum v4l2_mpeg_video_mpeg4_profile - 920 The profile information for MPEG4. Applicable to the MPEG4 encoder. 921 Possible values are: 922 923 924 925.. flat-table:: 926 :header-rows: 0 927 :stub-columns: 0 928 929 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE`` 930 - Simple profile 931 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_SIMPLE`` 932 - Advanced Simple profile 933 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_CORE`` 934 - Core profile 935 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_SIMPLE_SCALABLE`` 936 - Simple Scalable profile 937 * - ``V4L2_MPEG_VIDEO_MPEG4_PROFILE_ADVANCED_CODING_EFFICIENCY`` 938 - 939 940 941 942``V4L2_CID_MPEG_VIDEO_MAX_REF_PIC (integer)`` 943 The maximum number of reference pictures used for encoding. 944 Applicable to the encoder. 945 946.. _v4l2-mpeg-video-multi-slice-mode: 947 948``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` 949 (enum) 950 951enum v4l2_mpeg_video_multi_slice_mode - 952 Determines how the encoder should handle division of frame into 953 slices. Applicable to the encoder. Possible values are: 954 955 956 957.. tabularcolumns:: |p{9.6cm}|p{7.9cm}| 958 959.. flat-table:: 960 :header-rows: 0 961 :stub-columns: 0 962 963 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE`` 964 - Single slice per frame. 965 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB`` 966 - Multiple slices with set maximum number of macroblocks per slice. 967 * - ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES`` 968 - Multiple slice with set maximum size in bytes per slice. 969 970 971 972``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB (integer)`` 973 The maximum number of macroblocks in a slice. Used when 974 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to 975 ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB``. Applicable to the 976 encoder. 977 978``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES (integer)`` 979 The maximum size of a slice in bytes. Used when 980 ``V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE`` is set to 981 ``V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES``. Applicable to the 982 encoder. 983 984.. _v4l2-mpeg-video-h264-loop-filter-mode: 985 986``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE`` 987 (enum) 988 989enum v4l2_mpeg_video_h264_loop_filter_mode - 990 Loop filter mode for H264 encoder. Possible values are: 991 992.. raw:: latex 993 994 \small 995 996.. tabularcolumns:: |p{13.6cm}|p{3.9cm}| 997 998.. flat-table:: 999 :header-rows: 0 1000 :stub-columns: 0 1001 1002 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED`` 1003 - Loop filter is enabled. 1004 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED`` 1005 - Loop filter is disabled. 1006 * - ``V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY`` 1007 - Loop filter is disabled at the slice boundary. 1008 1009.. raw:: latex 1010 1011 \normalsize 1012 1013 1014``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA (integer)`` 1015 Loop filter alpha coefficient, defined in the H264 standard. 1016 This value corresponds to the slice_alpha_c0_offset_div2 slice header 1017 field, and should be in the range of -6 to +6, inclusive. The actual alpha 1018 offset FilterOffsetA is twice this value. 1019 Applicable to the H264 encoder. 1020 1021``V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA (integer)`` 1022 Loop filter beta coefficient, defined in the H264 standard. 1023 This corresponds to the slice_beta_offset_div2 slice header field, and 1024 should be in the range of -6 to +6, inclusive. The actual beta offset 1025 FilterOffsetB is twice this value. 1026 Applicable to the H264 encoder. 1027 1028.. _v4l2-mpeg-video-h264-entropy-mode: 1029 1030``V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE`` 1031 (enum) 1032 1033enum v4l2_mpeg_video_h264_entropy_mode - 1034 Entropy coding mode for H264 - CABAC/CAVALC. Applicable to the H264 1035 encoder. Possible values are: 1036 1037 1038.. tabularcolumns:: |p{9.0cm}|p{8.5cm}| 1039 1040 1041.. flat-table:: 1042 :header-rows: 0 1043 :stub-columns: 0 1044 1045 * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC`` 1046 - Use CAVLC entropy coding. 1047 * - ``V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC`` 1048 - Use CABAC entropy coding. 1049 1050 1051 1052``V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM (boolean)`` 1053 Enable 8X8 transform for H264. Applicable to the H264 encoder. 1054 1055``V4L2_CID_MPEG_VIDEO_H264_CONSTRAINED_INTRA_PREDICTION (boolean)`` 1056 Enable constrained intra prediction for H264. Applicable to the H264 1057 encoder. 1058 1059``V4L2_CID_MPEG_VIDEO_H264_CHROMA_QP_INDEX_OFFSET (integer)`` 1060 Specify the offset that should be added to the luma quantization 1061 parameter to determine the chroma quantization parameter. Applicable 1062 to the H264 encoder. 1063 1064``V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB (integer)`` 1065 Cyclic intra macroblock refresh. This is the number of continuous 1066 macroblocks refreshed every frame. Each frame a successive set of 1067 macroblocks is refreshed until the cycle completes and starts from 1068 the top of the frame. Applicable to H264, H263 and MPEG4 encoder. 1069 1070``V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE (boolean)`` 1071 Frame level rate control enable. If this control is disabled then 1072 the quantization parameter for each frame type is constant and set 1073 with appropriate controls (e.g. 1074 ``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP``). If frame rate control is 1075 enabled then quantization parameter is adjusted to meet the chosen 1076 bitrate. Minimum and maximum value for the quantization parameter 1077 can be set with appropriate controls (e.g. 1078 ``V4L2_CID_MPEG_VIDEO_H263_MIN_QP``). Applicable to encoders. 1079 1080``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE (boolean)`` 1081 Macroblock level rate control enable. Applicable to the MPEG4 and 1082 H264 encoders. 1083 1084``V4L2_CID_MPEG_VIDEO_MPEG4_QPEL (boolean)`` 1085 Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 1086 encoder. 1087 1088``V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP (integer)`` 1089 Quantization parameter for an I frame for H263. Valid range: from 1 1090 to 31. 1091 1092``V4L2_CID_MPEG_VIDEO_H263_MIN_QP (integer)`` 1093 Minimum quantization parameter for H263. Valid range: from 1 to 31. 1094 1095``V4L2_CID_MPEG_VIDEO_H263_MAX_QP (integer)`` 1096 Maximum quantization parameter for H263. Valid range: from 1 to 31. 1097 1098``V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP (integer)`` 1099 Quantization parameter for an P frame for H263. Valid range: from 1 1100 to 31. 1101 1102``V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP (integer)`` 1103 Quantization parameter for an B frame for H263. Valid range: from 1 1104 to 31. 1105 1106``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP (integer)`` 1107 Quantization parameter for an I frame for H264. Valid range: from 0 1108 to 51. 1109 1110``V4L2_CID_MPEG_VIDEO_H264_MIN_QP (integer)`` 1111 Minimum quantization parameter for H264. Valid range: from 0 to 51. 1112 1113``V4L2_CID_MPEG_VIDEO_H264_MAX_QP (integer)`` 1114 Maximum quantization parameter for H264. Valid range: from 0 to 51. 1115 1116``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP (integer)`` 1117 Quantization parameter for an P frame for H264. Valid range: from 0 1118 to 51. 1119 1120``V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP (integer)`` 1121 Quantization parameter for an B frame for H264. Valid range: from 0 1122 to 51. 1123 1124``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MIN_QP (integer)`` 1125 Minimum quantization parameter for the H264 I frame to limit I frame 1126 quality to a range. Valid range: from 0 to 51. If 1127 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1128 should be chosen to meet both requirements. 1129 1130``V4L2_CID_MPEG_VIDEO_H264_I_FRAME_MAX_QP (integer)`` 1131 Maximum quantization parameter for the H264 I frame to limit I frame 1132 quality to a range. Valid range: from 0 to 51. If 1133 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1134 should be chosen to meet both requirements. 1135 1136``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MIN_QP (integer)`` 1137 Minimum quantization parameter for the H264 P frame to limit P frame 1138 quality to a range. Valid range: from 0 to 51. If 1139 V4L2_CID_MPEG_VIDEO_H264_MIN_QP is also set, the quantization parameter 1140 should be chosen to meet both requirements. 1141 1142``V4L2_CID_MPEG_VIDEO_H264_P_FRAME_MAX_QP (integer)`` 1143 Maximum quantization parameter for the H264 P frame to limit P frame 1144 quality to a range. Valid range: from 0 to 51. If 1145 V4L2_CID_MPEG_VIDEO_H264_MAX_QP is also set, the quantization parameter 1146 should be chosen to meet both requirements. 1147 1148``V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP (integer)`` 1149 Quantization parameter for an I frame for MPEG4. Valid range: from 1 1150 to 31. 1151 1152``V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP (integer)`` 1153 Minimum quantization parameter for MPEG4. Valid range: from 1 to 31. 1154 1155``V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP (integer)`` 1156 Maximum quantization parameter for MPEG4. Valid range: from 1 to 31. 1157 1158``V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP (integer)`` 1159 Quantization parameter for an P frame for MPEG4. Valid range: from 1 1160 to 31. 1161 1162``V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP (integer)`` 1163 Quantization parameter for an B frame for MPEG4. Valid range: from 1 1164 to 31. 1165 1166``V4L2_CID_MPEG_VIDEO_VBV_SIZE (integer)`` 1167 The Video Buffer Verifier size in kilobytes, it is used as a 1168 limitation of frame skip. The VBV is defined in the standard as a 1169 mean to verify that the produced stream will be successfully 1170 decoded. The standard describes it as "Part of a hypothetical 1171 decoder that is conceptually connected to the output of the encoder. 1172 Its purpose is to provide a constraint on the variability of the 1173 data rate that an encoder or editing process may produce.". 1174 Applicable to the MPEG1, MPEG2, MPEG4 encoders. 1175 1176.. _v4l2-mpeg-video-vbv-delay: 1177 1178``V4L2_CID_MPEG_VIDEO_VBV_DELAY (integer)`` 1179 Sets the initial delay in milliseconds for VBV buffer control. 1180 1181.. _v4l2-mpeg-video-hor-search-range: 1182 1183``V4L2_CID_MPEG_VIDEO_MV_H_SEARCH_RANGE (integer)`` 1184 Horizontal search range defines maximum horizontal search area in 1185 pixels to search and match for the present Macroblock (MB) in the 1186 reference picture. This V4L2 control macro is used to set horizontal 1187 search range for motion estimation module in video encoder. 1188 1189.. _v4l2-mpeg-video-vert-search-range: 1190 1191``V4L2_CID_MPEG_VIDEO_MV_V_SEARCH_RANGE (integer)`` 1192 Vertical search range defines maximum vertical search area in pixels 1193 to search and match for the present Macroblock (MB) in the reference 1194 picture. This V4L2 control macro is used to set vertical search 1195 range for motion estimation module in video encoder. 1196 1197.. _v4l2-mpeg-video-force-key-frame: 1198 1199``V4L2_CID_MPEG_VIDEO_FORCE_KEY_FRAME (button)`` 1200 Force a key frame for the next queued buffer. Applicable to 1201 encoders. This is a general, codec-agnostic keyframe control. 1202 1203``V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE (integer)`` 1204 The Coded Picture Buffer size in kilobytes, it is used as a 1205 limitation of frame skip. The CPB is defined in the H264 standard as 1206 a mean to verify that the produced stream will be successfully 1207 decoded. Applicable to the H264 encoder. 1208 1209``V4L2_CID_MPEG_VIDEO_H264_I_PERIOD (integer)`` 1210 Period between I-frames in the open GOP for H264. In case of an open 1211 GOP this is the period between two I-frames. The period between IDR 1212 (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE 1213 control. An IDR frame, which stands for Instantaneous Decoding 1214 Refresh is an I-frame after which no prior frames are referenced. 1215 This means that a stream can be restarted from an IDR frame without 1216 the need to store or decode any previous frames. Applicable to the 1217 H264 encoder. 1218 1219.. _v4l2-mpeg-video-header-mode: 1220 1221``V4L2_CID_MPEG_VIDEO_HEADER_MODE`` 1222 (enum) 1223 1224enum v4l2_mpeg_video_header_mode - 1225 Determines whether the header is returned as the first buffer or is 1226 it returned together with the first frame. Applicable to encoders. 1227 Possible values are: 1228 1229.. raw:: latex 1230 1231 \small 1232 1233.. tabularcolumns:: |p{10.3cm}|p{7.2cm}| 1234 1235.. flat-table:: 1236 :header-rows: 0 1237 :stub-columns: 0 1238 1239 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE`` 1240 - The stream header is returned separately in the first buffer. 1241 * - ``V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME`` 1242 - The stream header is returned together with the first encoded 1243 frame. 1244 1245.. raw:: latex 1246 1247 \normalsize 1248 1249 1250``V4L2_CID_MPEG_VIDEO_REPEAT_SEQ_HEADER (boolean)`` 1251 Repeat the video sequence headers. Repeating these headers makes 1252 random access to the video stream easier. Applicable to the MPEG1, 2 1253 and 4 encoder. 1254 1255``V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER (boolean)`` 1256 Enabled the deblocking post processing filter for MPEG4 decoder. 1257 Applicable to the MPEG4 decoder. 1258 1259``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES (integer)`` 1260 vop_time_increment_resolution value for MPEG4. Applicable to the 1261 MPEG4 encoder. 1262 1263``V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC (integer)`` 1264 vop_time_increment value for MPEG4. Applicable to the MPEG4 1265 encoder. 1266 1267``V4L2_CID_MPEG_VIDEO_H264_SEI_FRAME_PACKING (boolean)`` 1268 Enable generation of frame packing supplemental enhancement 1269 information in the encoded bitstream. The frame packing SEI message 1270 contains the arrangement of L and R planes for 3D viewing. 1271 Applicable to the H264 encoder. 1272 1273``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_CURRENT_FRAME_0 (boolean)`` 1274 Sets current frame as frame0 in frame packing SEI. Applicable to the 1275 H264 encoder. 1276 1277.. _v4l2-mpeg-video-h264-sei-fp-arrangement-type: 1278 1279``V4L2_CID_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE`` 1280 (enum) 1281 1282enum v4l2_mpeg_video_h264_sei_fp_arrangement_type - 1283 Frame packing arrangement type for H264 SEI. Applicable to the H264 1284 encoder. Possible values are: 1285 1286.. raw:: latex 1287 1288 \small 1289 1290.. tabularcolumns:: |p{12cm}|p{5.5cm}| 1291 1292.. flat-table:: 1293 :header-rows: 0 1294 :stub-columns: 0 1295 1296 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_CHEKERBOARD`` 1297 - Pixels are alternatively from L and R. 1298 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_COLUMN`` 1299 - L and R are interlaced by column. 1300 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_ROW`` 1301 - L and R are interlaced by row. 1302 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_SIDE_BY_SIDE`` 1303 - L is on the left, R on the right. 1304 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TOP_BOTTOM`` 1305 - L is on top, R on bottom. 1306 * - ``V4L2_MPEG_VIDEO_H264_SEI_FP_ARRANGEMENT_TYPE_TEMPORAL`` 1307 - One view per frame. 1308 1309.. raw:: latex 1310 1311 \normalsize 1312 1313 1314 1315``V4L2_CID_MPEG_VIDEO_H264_FMO (boolean)`` 1316 Enables flexible macroblock ordering in the encoded bitstream. It is 1317 a technique used for restructuring the ordering of macroblocks in 1318 pictures. Applicable to the H264 encoder. 1319 1320.. _v4l2-mpeg-video-h264-fmo-map-type: 1321 1322``V4L2_CID_MPEG_VIDEO_H264_FMO_MAP_TYPE`` 1323 (enum) 1324 1325enum v4l2_mpeg_video_h264_fmo_map_type - 1326 When using FMO, the map type divides the image in different scan 1327 patterns of macroblocks. Applicable to the H264 encoder. Possible 1328 values are: 1329 1330.. raw:: latex 1331 1332 \small 1333 1334.. tabularcolumns:: |p{12.5cm}|p{5.0cm}| 1335 1336.. flat-table:: 1337 :header-rows: 0 1338 :stub-columns: 0 1339 1340 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_INTERLEAVED_SLICES`` 1341 - Slices are interleaved one after other with macroblocks in run 1342 length order. 1343 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_SCATTERED_SLICES`` 1344 - Scatters the macroblocks based on a mathematical function known to 1345 both encoder and decoder. 1346 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_FOREGROUND_WITH_LEFT_OVER`` 1347 - Macroblocks arranged in rectangular areas or regions of interest. 1348 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_BOX_OUT`` 1349 - Slice groups grow in a cyclic way from centre to outwards. 1350 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_RASTER_SCAN`` 1351 - Slice groups grow in raster scan pattern from left to right. 1352 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_WIPE_SCAN`` 1353 - Slice groups grow in wipe scan pattern from top to bottom. 1354 * - ``V4L2_MPEG_VIDEO_H264_FMO_MAP_TYPE_EXPLICIT`` 1355 - User defined map type. 1356 1357.. raw:: latex 1358 1359 \normalsize 1360 1361 1362 1363``V4L2_CID_MPEG_VIDEO_H264_FMO_SLICE_GROUP (integer)`` 1364 Number of slice groups in FMO. Applicable to the H264 encoder. 1365 1366.. _v4l2-mpeg-video-h264-fmo-change-direction: 1367 1368``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_DIRECTION`` 1369 (enum) 1370 1371enum v4l2_mpeg_video_h264_fmo_change_dir - 1372 Specifies a direction of the slice group change for raster and wipe 1373 maps. Applicable to the H264 encoder. Possible values are: 1374 1375 1376 1377.. flat-table:: 1378 :header-rows: 0 1379 :stub-columns: 0 1380 1381 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_RIGHT`` 1382 - Raster scan or wipe right. 1383 * - ``V4L2_MPEG_VIDEO_H264_FMO_CHANGE_DIR_LEFT`` 1384 - Reverse raster scan or wipe left. 1385 1386 1387 1388``V4L2_CID_MPEG_VIDEO_H264_FMO_CHANGE_RATE (integer)`` 1389 Specifies the size of the first slice group for raster and wipe map. 1390 Applicable to the H264 encoder. 1391 1392``V4L2_CID_MPEG_VIDEO_H264_FMO_RUN_LENGTH (integer)`` 1393 Specifies the number of consecutive macroblocks for the interleaved 1394 map. Applicable to the H264 encoder. 1395 1396``V4L2_CID_MPEG_VIDEO_H264_ASO (boolean)`` 1397 Enables arbitrary slice ordering in encoded bitstream. Applicable to 1398 the H264 encoder. 1399 1400``V4L2_CID_MPEG_VIDEO_H264_ASO_SLICE_ORDER (integer)`` 1401 Specifies the slice order in ASO. Applicable to the H264 encoder. 1402 The supplied 32-bit integer is interpreted as follows (bit 0 = least 1403 significant bit): 1404 1405 1406 1407.. flat-table:: 1408 :header-rows: 0 1409 :stub-columns: 0 1410 1411 * - Bit 0:15 1412 - Slice ID 1413 * - Bit 16:32 1414 - Slice position or order 1415 1416 1417 1418``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING (boolean)`` 1419 Enables H264 hierarchical coding. Applicable to the H264 encoder. 1420 1421.. _v4l2-mpeg-video-h264-hierarchical-coding-type: 1422 1423``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_TYPE`` 1424 (enum) 1425 1426enum v4l2_mpeg_video_h264_hierarchical_coding_type - 1427 Specifies the hierarchical coding type. Applicable to the H264 1428 encoder. Possible values are: 1429 1430 1431 1432.. flat-table:: 1433 :header-rows: 0 1434 :stub-columns: 0 1435 1436 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_B`` 1437 - Hierarchical B coding. 1438 * - ``V4L2_MPEG_VIDEO_H264_HIERARCHICAL_CODING_P`` 1439 - Hierarchical P coding. 1440 1441 1442 1443``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER (integer)`` 1444 Specifies the number of hierarchical coding layers. Applicable to 1445 the H264 encoder. 1446 1447``V4L2_CID_MPEG_VIDEO_H264_HIERARCHICAL_CODING_LAYER_QP (integer)`` 1448 Specifies a user defined QP for each layer. Applicable to the H264 1449 encoder. The supplied 32-bit integer is interpreted as follows (bit 1450 0 = least significant bit): 1451 1452 1453 1454.. flat-table:: 1455 :header-rows: 0 1456 :stub-columns: 0 1457 1458 * - Bit 0:15 1459 - QP value 1460 * - Bit 16:32 1461 - Layer number 1462 1463 1464.. _v4l2-mpeg-h264: 1465 1466``V4L2_CID_MPEG_VIDEO_H264_SPS (struct)`` 1467 Specifies the sequence parameter set (as extracted from the 1468 bitstream) for the associated H264 slice data. This includes the 1469 necessary parameters for configuring a stateless hardware decoding 1470 pipeline for H264. The bitstream parameters are defined according 1471 to :ref:`h264`, section 7.4.2.1.1 "Sequence Parameter Set Data 1472 Semantics". For further documentation, refer to the above 1473 specification, unless there is an explicit comment stating 1474 otherwise. 1475 1476 .. note:: 1477 1478 This compound control is not yet part of the public kernel API and 1479 it is expected to change. 1480 1481.. c:type:: v4l2_ctrl_h264_sps 1482 1483.. cssclass:: longtable 1484 1485.. flat-table:: struct v4l2_ctrl_h264_sps 1486 :header-rows: 0 1487 :stub-columns: 0 1488 :widths: 1 1 2 1489 1490 * - __u8 1491 - ``profile_idc`` 1492 - 1493 * - __u8 1494 - ``constraint_set_flags`` 1495 - See :ref:`Sequence Parameter Set Constraints Set Flags <h264_sps_constraints_set_flags>` 1496 * - __u8 1497 - ``level_idc`` 1498 - 1499 * - __u8 1500 - ``seq_parameter_set_id`` 1501 - 1502 * - __u8 1503 - ``chroma_format_idc`` 1504 - 1505 * - __u8 1506 - ``bit_depth_luma_minus8`` 1507 - 1508 * - __u8 1509 - ``bit_depth_chroma_minus8`` 1510 - 1511 * - __u8 1512 - ``log2_max_frame_num_minus4`` 1513 - 1514 * - __u8 1515 - ``pic_order_cnt_type`` 1516 - 1517 * - __u8 1518 - ``log2_max_pic_order_cnt_lsb_minus4`` 1519 - 1520 * - __u8 1521 - ``max_num_ref_frames`` 1522 - 1523 * - __u8 1524 - ``num_ref_frames_in_pic_order_cnt_cycle`` 1525 - 1526 * - __s32 1527 - ``offset_for_ref_frame[255]`` 1528 - 1529 * - __s32 1530 - ``offset_for_non_ref_pic`` 1531 - 1532 * - __s32 1533 - ``offset_for_top_to_bottom_field`` 1534 - 1535 * - __u16 1536 - ``pic_width_in_mbs_minus1`` 1537 - 1538 * - __u16 1539 - ``pic_height_in_map_units_minus1`` 1540 - 1541 * - __u32 1542 - ``flags`` 1543 - See :ref:`Sequence Parameter Set Flags <h264_sps_flags>` 1544 1545.. _h264_sps_constraints_set_flags: 1546 1547``Sequence Parameter Set Constraints Set Flags`` 1548 1549.. cssclass:: longtable 1550 1551.. flat-table:: 1552 :header-rows: 0 1553 :stub-columns: 0 1554 :widths: 1 1 2 1555 1556 * - ``V4L2_H264_SPS_CONSTRAINT_SET0_FLAG`` 1557 - 0x00000001 1558 - 1559 * - ``V4L2_H264_SPS_CONSTRAINT_SET1_FLAG`` 1560 - 0x00000002 1561 - 1562 * - ``V4L2_H264_SPS_CONSTRAINT_SET2_FLAG`` 1563 - 0x00000004 1564 - 1565 * - ``V4L2_H264_SPS_CONSTRAINT_SET3_FLAG`` 1566 - 0x00000008 1567 - 1568 * - ``V4L2_H264_SPS_CONSTRAINT_SET4_FLAG`` 1569 - 0x00000010 1570 - 1571 * - ``V4L2_H264_SPS_CONSTRAINT_SET5_FLAG`` 1572 - 0x00000020 1573 - 1574 1575.. _h264_sps_flags: 1576 1577``Sequence Parameter Set Flags`` 1578 1579.. cssclass:: longtable 1580 1581.. flat-table:: 1582 :header-rows: 0 1583 :stub-columns: 0 1584 :widths: 1 1 2 1585 1586 * - ``V4L2_H264_SPS_FLAG_SEPARATE_COLOUR_PLANE`` 1587 - 0x00000001 1588 - 1589 * - ``V4L2_H264_SPS_FLAG_QPPRIME_Y_ZERO_TRANSFORM_BYPASS`` 1590 - 0x00000002 1591 - 1592 * - ``V4L2_H264_SPS_FLAG_DELTA_PIC_ORDER_ALWAYS_ZERO`` 1593 - 0x00000004 1594 - 1595 * - ``V4L2_H264_SPS_FLAG_GAPS_IN_FRAME_NUM_VALUE_ALLOWED`` 1596 - 0x00000008 1597 - 1598 * - ``V4L2_H264_SPS_FLAG_FRAME_MBS_ONLY`` 1599 - 0x00000010 1600 - 1601 * - ``V4L2_H264_SPS_FLAG_MB_ADAPTIVE_FRAME_FIELD`` 1602 - 0x00000020 1603 - 1604 * - ``V4L2_H264_SPS_FLAG_DIRECT_8X8_INFERENCE`` 1605 - 0x00000040 1606 - 1607 1608``V4L2_CID_MPEG_VIDEO_H264_PPS (struct)`` 1609 Specifies the picture parameter set (as extracted from the 1610 bitstream) for the associated H264 slice data. This includes the 1611 necessary parameters for configuring a stateless hardware decoding 1612 pipeline for H264. The bitstream parameters are defined according 1613 to :ref:`h264`, section 7.4.2.2 "Picture Parameter Set RBSP 1614 Semantics". For further documentation, refer to the above 1615 specification, unless there is an explicit comment stating 1616 otherwise. 1617 1618 .. note:: 1619 1620 This compound control is not yet part of the public kernel API and 1621 it is expected to change. 1622 1623.. c:type:: v4l2_ctrl_h264_pps 1624 1625.. cssclass:: longtable 1626 1627.. flat-table:: struct v4l2_ctrl_h264_pps 1628 :header-rows: 0 1629 :stub-columns: 0 1630 :widths: 1 1 2 1631 1632 * - __u8 1633 - ``pic_parameter_set_id`` 1634 - 1635 * - __u8 1636 - ``seq_parameter_set_id`` 1637 - 1638 * - __u8 1639 - ``num_slice_groups_minus1`` 1640 - 1641 * - __u8 1642 - ``num_ref_idx_l0_default_active_minus1`` 1643 - 1644 * - __u8 1645 - ``num_ref_idx_l1_default_active_minus1`` 1646 - 1647 * - __u8 1648 - ``weighted_bipred_idc`` 1649 - 1650 * - __s8 1651 - ``pic_init_qp_minus26`` 1652 - 1653 * - __s8 1654 - ``pic_init_qs_minus26`` 1655 - 1656 * - __s8 1657 - ``chroma_qp_index_offset`` 1658 - 1659 * - __s8 1660 - ``second_chroma_qp_index_offset`` 1661 - 1662 * - __u16 1663 - ``flags`` 1664 - See :ref:`Picture Parameter Set Flags <h264_pps_flags>` 1665 1666.. _h264_pps_flags: 1667 1668``Picture Parameter Set Flags`` 1669 1670.. cssclass:: longtable 1671 1672.. flat-table:: 1673 :header-rows: 0 1674 :stub-columns: 0 1675 :widths: 1 1 2 1676 1677 * - ``V4L2_H264_PPS_FLAG_ENTROPY_CODING_MODE`` 1678 - 0x00000001 1679 - 1680 * - ``V4L2_H264_PPS_FLAG_BOTTOM_FIELD_PIC_ORDER_IN_FRAME_PRESENT`` 1681 - 0x00000002 1682 - 1683 * - ``V4L2_H264_PPS_FLAG_WEIGHTED_PRED`` 1684 - 0x00000004 1685 - 1686 * - ``V4L2_H264_PPS_FLAG_DEBLOCKING_FILTER_CONTROL_PRESENT`` 1687 - 0x00000008 1688 - 1689 * - ``V4L2_H264_PPS_FLAG_CONSTRAINED_INTRA_PRED`` 1690 - 0x00000010 1691 - 1692 * - ``V4L2_H264_PPS_FLAG_REDUNDANT_PIC_CNT_PRESENT`` 1693 - 0x00000020 1694 - 1695 * - ``V4L2_H264_PPS_FLAG_TRANSFORM_8X8_MODE`` 1696 - 0x00000040 1697 - 1698 * - ``V4L2_H264_PPS_FLAG_PIC_SCALING_MATRIX_PRESENT`` 1699 - 0x00000080 1700 - 1701 1702``V4L2_CID_MPEG_VIDEO_H264_SCALING_MATRIX (struct)`` 1703 Specifies the scaling matrix (as extracted from the bitstream) for 1704 the associated H264 slice data. The bitstream parameters are 1705 defined according to :ref:`h264`, section 7.4.2.1.1.1 "Scaling 1706 List Semantics". For further documentation, refer to the above 1707 specification, unless there is an explicit comment stating 1708 otherwise. 1709 1710 .. note:: 1711 1712 This compound control is not yet part of the public kernel API and 1713 it is expected to change. 1714 1715.. c:type:: v4l2_ctrl_h264_scaling_matrix 1716 1717.. cssclass:: longtable 1718 1719.. flat-table:: struct v4l2_ctrl_h264_scaling_matrix 1720 :header-rows: 0 1721 :stub-columns: 0 1722 :widths: 1 1 2 1723 1724 * - __u8 1725 - ``scaling_list_4x4[6][16]`` 1726 - Scaling matrix after applying the inverse scanning process. 1727 Expected list order is Intra Y, Intra Cb, Intra Cr, Inter Y, 1728 Inter Cb, Inter Cr. 1729 * - __u8 1730 - ``scaling_list_8x8[6][64]`` 1731 - Scaling matrix after applying the inverse scanning process. 1732 Expected list order is Intra Y, Inter Y, Intra Cb, Inter Cb, 1733 Intra Cr, Inter Cr. 1734 1735``V4L2_CID_MPEG_VIDEO_H264_SLICE_PARAMS (struct)`` 1736 Specifies the slice parameters (as extracted from the bitstream) 1737 for the associated H264 slice data. This includes the necessary 1738 parameters for configuring a stateless hardware decoding pipeline 1739 for H264. The bitstream parameters are defined according to 1740 :ref:`h264`, section 7.4.3 "Slice Header Semantics". For further 1741 documentation, refer to the above specification, unless there is 1742 an explicit comment stating otherwise. 1743 1744 .. note:: 1745 1746 This compound control is not yet part of the public kernel API 1747 and it is expected to change. 1748 1749 This structure is expected to be passed as an array, with one 1750 entry for each slice included in the bitstream buffer. 1751 1752.. c:type:: v4l2_ctrl_h264_slice_params 1753 1754.. cssclass:: longtable 1755 1756.. flat-table:: struct v4l2_ctrl_h264_slice_params 1757 :header-rows: 0 1758 :stub-columns: 0 1759 :widths: 1 1 2 1760 1761 * - __u32 1762 - ``size`` 1763 - 1764 * - __u32 1765 - ``start_byte_offset`` 1766 Offset (in bytes) from the beginning of the OUTPUT buffer to the start 1767 of the slice. If the slice starts with a start code, then this is the 1768 offset to such start code. When operating in slice-based decoding mode 1769 (see :c:type:`v4l2_mpeg_video_h264_decode_mode`), this field should 1770 be set to 0. When operating in frame-based decoding mode, this field 1771 should be 0 for the first slice. 1772 * - __u32 1773 - ``header_bit_size`` 1774 - 1775 * - __u16 1776 - ``first_mb_in_slice`` 1777 - 1778 * - __u8 1779 - ``slice_type`` 1780 - 1781 * - __u8 1782 - ``pic_parameter_set_id`` 1783 - 1784 * - __u8 1785 - ``colour_plane_id`` 1786 - 1787 * - __u8 1788 - ``redundant_pic_cnt`` 1789 - 1790 * - __u16 1791 - ``frame_num`` 1792 - 1793 * - __u16 1794 - ``idr_pic_id`` 1795 - 1796 * - __u16 1797 - ``pic_order_cnt_lsb`` 1798 - 1799 * - __s32 1800 - ``delta_pic_order_cnt_bottom`` 1801 - 1802 * - __s32 1803 - ``delta_pic_order_cnt0`` 1804 - 1805 * - __s32 1806 - ``delta_pic_order_cnt1`` 1807 - 1808 * - struct :c:type:`v4l2_h264_pred_weight_table` 1809 - ``pred_weight_table`` 1810 - 1811 * - __u32 1812 - ``dec_ref_pic_marking_bit_size`` 1813 - Size in bits of the dec_ref_pic_marking() syntax element. 1814 * - __u32 1815 - ``pic_order_cnt_bit_size`` 1816 - 1817 * - __u8 1818 - ``cabac_init_idc`` 1819 - 1820 * - __s8 1821 - ``slice_qp_delta`` 1822 - 1823 * - __s8 1824 - ``slice_qs_delta`` 1825 - 1826 * - __u8 1827 - ``disable_deblocking_filter_idc`` 1828 - 1829 * - __s8 1830 - ``slice_alpha_c0_offset_div2`` 1831 - 1832 * - __s8 1833 - ``slice_beta_offset_div2`` 1834 - 1835 * - __u8 1836 - ``num_ref_idx_l0_active_minus1`` 1837 - If num_ref_idx_active_override_flag is not set, this field must be 1838 set to the value of num_ref_idx_l0_default_active_minus1. 1839 * - __u8 1840 - ``num_ref_idx_l1_active_minus1`` 1841 - If num_ref_idx_active_override_flag is not set, this field must be 1842 set to the value of num_ref_idx_l1_default_active_minus1. 1843 * - __u32 1844 - ``slice_group_change_cycle`` 1845 - 1846 * - __u8 1847 - ``ref_pic_list0[32]`` 1848 - Reference picture list after applying the per-slice modifications 1849 * - __u8 1850 - ``ref_pic_list1[32]`` 1851 - Reference picture list after applying the per-slice modifications 1852 * - __u32 1853 - ``flags`` 1854 - See :ref:`Slice Parameter Flags <h264_slice_flags>` 1855 1856.. _h264_slice_flags: 1857 1858``Slice Parameter Set Flags`` 1859 1860.. cssclass:: longtable 1861 1862.. flat-table:: 1863 :header-rows: 0 1864 :stub-columns: 0 1865 :widths: 1 1 2 1866 1867 * - ``V4L2_H264_SLICE_FLAG_FIELD_PIC`` 1868 - 0x00000001 1869 - 1870 * - ``V4L2_H264_SLICE_FLAG_BOTTOM_FIELD`` 1871 - 0x00000002 1872 - 1873 * - ``V4L2_H264_SLICE_FLAG_DIRECT_SPATIAL_MV_PRED`` 1874 - 0x00000004 1875 - 1876 * - ``V4L2_H264_SLICE_FLAG_SP_FOR_SWITCH`` 1877 - 0x00000008 1878 - 1879 1880``Prediction Weight Table`` 1881 1882 The bitstream parameters are defined according to :ref:`h264`, 1883 section 7.4.3.2 "Prediction Weight Table Semantics". For further 1884 documentation, refer to the above specification, unless there is 1885 an explicit comment stating otherwise. 1886 1887.. c:type:: v4l2_h264_pred_weight_table 1888 1889.. cssclass:: longtable 1890 1891.. flat-table:: struct v4l2_h264_pred_weight_table 1892 :header-rows: 0 1893 :stub-columns: 0 1894 :widths: 1 1 2 1895 1896 * - __u16 1897 - ``luma_log2_weight_denom`` 1898 - 1899 * - __u16 1900 - ``chroma_log2_weight_denom`` 1901 - 1902 * - struct :c:type:`v4l2_h264_weight_factors` 1903 - ``weight_factors[2]`` 1904 - The weight factors at index 0 are the weight factors for the reference 1905 list 0, the one at index 1 for the reference list 1. 1906 1907.. c:type:: v4l2_h264_weight_factors 1908 1909.. cssclass:: longtable 1910 1911.. flat-table:: struct v4l2_h264_weight_factors 1912 :header-rows: 0 1913 :stub-columns: 0 1914 :widths: 1 1 2 1915 1916 * - __s16 1917 - ``luma_weight[32]`` 1918 - 1919 * - __s16 1920 - ``luma_offset[32]`` 1921 - 1922 * - __s16 1923 - ``chroma_weight[32][2]`` 1924 - 1925 * - __s16 1926 - ``chroma_offset[32][2]`` 1927 - 1928 1929``V4L2_CID_MPEG_VIDEO_H264_DECODE_PARAMS (struct)`` 1930 Specifies the decode parameters (as extracted from the bitstream) 1931 for the associated H264 slice data. This includes the necessary 1932 parameters for configuring a stateless hardware decoding pipeline 1933 for H264. The bitstream parameters are defined according to 1934 :ref:`h264`. For further documentation, refer to the above 1935 specification, unless there is an explicit comment stating 1936 otherwise. 1937 1938 .. note:: 1939 1940 This compound control is not yet part of the public kernel API and 1941 it is expected to change. 1942 1943.. c:type:: v4l2_ctrl_h264_decode_params 1944 1945.. cssclass:: longtable 1946 1947.. flat-table:: struct v4l2_ctrl_h264_decode_params 1948 :header-rows: 0 1949 :stub-columns: 0 1950 :widths: 1 1 2 1951 1952 * - struct :c:type:`v4l2_h264_dpb_entry` 1953 - ``dpb[16]`` 1954 - 1955 * - __u16 1956 - ``num_slices`` 1957 - Number of slices needed to decode the current frame/field. When 1958 operating in slice-based decoding mode (see 1959 :c:type:`v4l2_mpeg_video_h264_decode_mode`), this field 1960 should always be set to one. 1961 * - __u16 1962 - ``nal_ref_idc`` 1963 - NAL reference ID value coming from the NAL Unit header 1964 * - __s32 1965 - ``top_field_order_cnt`` 1966 - Picture Order Count for the coded top field 1967 * - __s32 1968 - ``bottom_field_order_cnt`` 1969 - Picture Order Count for the coded bottom field 1970 * - __u32 1971 - ``flags`` 1972 - See :ref:`Decode Parameters Flags <h264_decode_params_flags>` 1973 1974.. _h264_decode_params_flags: 1975 1976``Decode Parameters Flags`` 1977 1978.. cssclass:: longtable 1979 1980.. flat-table:: 1981 :header-rows: 0 1982 :stub-columns: 0 1983 :widths: 1 1 2 1984 1985 * - ``V4L2_H264_DECODE_PARAM_FLAG_IDR_PIC`` 1986 - 0x00000001 1987 - That picture is an IDR picture 1988 1989.. c:type:: v4l2_h264_dpb_entry 1990 1991.. cssclass:: longtable 1992 1993.. flat-table:: struct v4l2_h264_dpb_entry 1994 :header-rows: 0 1995 :stub-columns: 0 1996 :widths: 1 1 2 1997 1998 * - __u64 1999 - ``reference_ts`` 2000 - Timestamp of the V4L2 capture buffer to use as reference, used 2001 with B-coded and P-coded frames. The timestamp refers to the 2002 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 2003 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 2004 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 2005 * - __u16 2006 - ``frame_num`` 2007 - 2008 * - __u16 2009 - ``pic_num`` 2010 - 2011 * - __s32 2012 - ``top_field_order_cnt`` 2013 - 2014 * - __s32 2015 - ``bottom_field_order_cnt`` 2016 - 2017 * - __u32 2018 - ``flags`` 2019 - See :ref:`DPB Entry Flags <h264_dpb_flags>` 2020 2021.. _h264_dpb_flags: 2022 2023``DPB Entries Flags`` 2024 2025.. cssclass:: longtable 2026 2027.. flat-table:: 2028 :header-rows: 0 2029 :stub-columns: 0 2030 :widths: 1 1 2 2031 2032 * - ``V4L2_H264_DPB_ENTRY_FLAG_VALID`` 2033 - 0x00000001 2034 - The DPB entry is valid and should be considered 2035 * - ``V4L2_H264_DPB_ENTRY_FLAG_ACTIVE`` 2036 - 0x00000002 2037 - The DPB entry is currently being used as a reference frame 2038 * - ``V4L2_H264_DPB_ENTRY_FLAG_LONG_TERM`` 2039 - 0x00000004 2040 - The DPB entry is a long term reference frame 2041 * - ``V4L2_H264_DPB_ENTRY_FLAG_FIELD`` 2042 - 0x00000008 2043 - The DPB entry is a field reference, which means only one of the field 2044 will be used when decoding the new frame/field. When not set the DPB 2045 entry is a frame reference (both fields will be used). Note that this 2046 flag does not say anything about the number of fields contained in the 2047 reference frame, it just describes the one used to decode the new 2048 field/frame 2049 * - ``V4L2_H264_DPB_ENTRY_FLAG_BOTTOM_FIELD`` 2050 - 0x00000010 2051 - The DPB entry is a bottom field reference (only the bottom field of the 2052 reference frame is needed to decode the new frame/field). Only valid if 2053 V4L2_H264_DPB_ENTRY_FLAG_FIELD is set. When 2054 V4L2_H264_DPB_ENTRY_FLAG_FIELD is set but 2055 V4L2_H264_DPB_ENTRY_FLAG_BOTTOM_FIELD is not, that means the 2056 DPB entry is a top field reference 2057 2058``V4L2_CID_MPEG_VIDEO_H264_DECODE_MODE (enum)`` 2059 Specifies the decoding mode to use. Currently exposes slice-based and 2060 frame-based decoding but new modes might be added later on. 2061 This control is used as a modifier for V4L2_PIX_FMT_H264_SLICE 2062 pixel format. Applications that support V4L2_PIX_FMT_H264_SLICE 2063 are required to set this control in order to specify the decoding mode 2064 that is expected for the buffer. 2065 Drivers may expose a single or multiple decoding modes, depending 2066 on what they can support. 2067 2068 .. note:: 2069 2070 This menu control is not yet part of the public kernel API and 2071 it is expected to change. 2072 2073.. c:type:: v4l2_mpeg_video_h264_decode_mode 2074 2075.. cssclass:: longtable 2076 2077.. flat-table:: 2078 :header-rows: 0 2079 :stub-columns: 0 2080 :widths: 1 1 2 2081 2082 * - ``V4L2_MPEG_VIDEO_H264_DECODE_MODE_SLICE_BASED`` 2083 - 0 2084 - Decoding is done at the slice granularity. 2085 In this mode, ``num_slices`` field in struct 2086 :c:type:`v4l2_ctrl_h264_decode_params` should be set to 1, 2087 and ``start_byte_offset`` in struct 2088 :c:type:`v4l2_ctrl_h264_slice_params` should be set to 0. 2089 The OUTPUT buffer must contain a single slice. 2090 * - ``V4L2_MPEG_VIDEO_H264_DECODE_MODE_FRAME_BASED`` 2091 - 1 2092 - Decoding is done at the frame granularity. 2093 In this mode, ``num_slices`` field in struct 2094 :c:type:`v4l2_ctrl_h264_decode_params` should be set to the number 2095 of slices in the frame, and ``start_byte_offset`` in struct 2096 :c:type:`v4l2_ctrl_h264_slice_params` should be set accordingly 2097 for each slice. For the first slice, ``start_byte_offset`` should 2098 be zero. 2099 The OUTPUT buffer must contain all slices needed to decode the 2100 frame. The OUTPUT buffer must also contain both fields. 2101 2102``V4L2_CID_MPEG_VIDEO_H264_START_CODE (enum)`` 2103 Specifies the H264 slice start code expected for each slice. 2104 This control is used as a modifier for V4L2_PIX_FMT_H264_SLICE 2105 pixel format. Applications that support V4L2_PIX_FMT_H264_SLICE 2106 are required to set this control in order to specify the start code 2107 that is expected for the buffer. 2108 Drivers may expose a single or multiple start codes, depending 2109 on what they can support. 2110 2111 .. note:: 2112 2113 This menu control is not yet part of the public kernel API and 2114 it is expected to change. 2115 2116.. c:type:: v4l2_mpeg_video_h264_start_code 2117 2118.. cssclass:: longtable 2119 2120.. flat-table:: 2121 :header-rows: 0 2122 :stub-columns: 0 2123 :widths: 1 1 2 2124 2125 * - ``V4L2_MPEG_VIDEO_H264_START_CODE_NONE`` 2126 - 0 2127 - Selecting this value specifies that H264 slices are passed 2128 to the driver without any start code. 2129 * - ``V4L2_MPEG_VIDEO_H264_START_CODE_ANNEX_B`` 2130 - 1 2131 - Selecting this value specifies that H264 slices are expected 2132 to be prefixed by Annex B start codes. According to :ref:`h264` 2133 valid start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001. 2134 2135.. _v4l2-mpeg-mpeg2: 2136 2137``V4L2_CID_MPEG_VIDEO_MPEG2_SLICE_PARAMS (struct)`` 2138 Specifies the slice parameters (as extracted from the bitstream) for the 2139 associated MPEG-2 slice data. This includes the necessary parameters for 2140 configuring a stateless hardware decoding pipeline for MPEG-2. 2141 The bitstream parameters are defined according to :ref:`mpeg2part2`. 2142 2143 .. note:: 2144 2145 This compound control is not yet part of the public kernel API and 2146 it is expected to change. 2147 2148.. c:type:: v4l2_ctrl_mpeg2_slice_params 2149 2150.. cssclass:: longtable 2151 2152.. tabularcolumns:: |p{5.8cm}|p{4.8cm}|p{6.6cm}| 2153 2154.. flat-table:: struct v4l2_ctrl_mpeg2_slice_params 2155 :header-rows: 0 2156 :stub-columns: 0 2157 :widths: 1 1 2 2158 2159 * - __u32 2160 - ``bit_size`` 2161 - Size (in bits) of the current slice data. 2162 * - __u32 2163 - ``data_bit_offset`` 2164 - Offset (in bits) to the video data in the current slice data. 2165 * - struct :c:type:`v4l2_mpeg2_sequence` 2166 - ``sequence`` 2167 - Structure with MPEG-2 sequence metadata, merging relevant fields from 2168 the sequence header and sequence extension parts of the bitstream. 2169 * - struct :c:type:`v4l2_mpeg2_picture` 2170 - ``picture`` 2171 - Structure with MPEG-2 picture metadata, merging relevant fields from 2172 the picture header and picture coding extension parts of the bitstream. 2173 * - __u64 2174 - ``backward_ref_ts`` 2175 - Timestamp of the V4L2 capture buffer to use as backward reference, used 2176 with B-coded and P-coded frames. The timestamp refers to the 2177 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 2178 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 2179 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 2180 * - __u64 2181 - ``forward_ref_ts`` 2182 - Timestamp for the V4L2 capture buffer to use as forward reference, used 2183 with B-coded frames. The timestamp refers to the ``timestamp`` field in 2184 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2185 function to convert the struct :c:type:`timeval` in struct 2186 :c:type:`v4l2_buffer` to a __u64. 2187 * - __u32 2188 - ``quantiser_scale_code`` 2189 - Code used to determine the quantization scale to use for the IDCT. 2190 2191.. c:type:: v4l2_mpeg2_sequence 2192 2193.. cssclass:: longtable 2194 2195.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2196 2197.. flat-table:: struct v4l2_mpeg2_sequence 2198 :header-rows: 0 2199 :stub-columns: 0 2200 :widths: 1 1 2 2201 2202 * - __u16 2203 - ``horizontal_size`` 2204 - The width of the displayable part of the frame's luminance component. 2205 * - __u16 2206 - ``vertical_size`` 2207 - The height of the displayable part of the frame's luminance component. 2208 * - __u32 2209 - ``vbv_buffer_size`` 2210 - Used to calculate the required size of the video buffering verifier, 2211 defined (in bits) as: 16 * 1024 * vbv_buffer_size. 2212 * - __u16 2213 - ``profile_and_level_indication`` 2214 - The current profile and level indication as extracted from the 2215 bitstream. 2216 * - __u8 2217 - ``progressive_sequence`` 2218 - Indication that all the frames for the sequence are progressive instead 2219 of interlaced. 2220 * - __u8 2221 - ``chroma_format`` 2222 - The chrominance sub-sampling format (1: 4:2:0, 2: 4:2:2, 3: 4:4:4). 2223 2224.. c:type:: v4l2_mpeg2_picture 2225 2226.. cssclass:: longtable 2227 2228.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2229 2230.. flat-table:: struct v4l2_mpeg2_picture 2231 :header-rows: 0 2232 :stub-columns: 0 2233 :widths: 1 1 2 2234 2235 * - __u8 2236 - ``picture_coding_type`` 2237 - Picture coding type for the frame covered by the current slice 2238 (V4L2_MPEG2_PICTURE_CODING_TYPE_I, V4L2_MPEG2_PICTURE_CODING_TYPE_P or 2239 V4L2_MPEG2_PICTURE_CODING_TYPE_B). 2240 * - __u8 2241 - ``f_code[2][2]`` 2242 - Motion vector codes. 2243 * - __u8 2244 - ``intra_dc_precision`` 2245 - Precision of Discrete Cosine transform (0: 8 bits precision, 2246 1: 9 bits precision, 2: 10 bits precision, 3: 11 bits precision). 2247 * - __u8 2248 - ``picture_structure`` 2249 - Picture structure (1: interlaced top field, 2: interlaced bottom field, 2250 3: progressive frame). 2251 * - __u8 2252 - ``top_field_first`` 2253 - If set to 1 and interlaced stream, top field is output first. 2254 * - __u8 2255 - ``frame_pred_frame_dct`` 2256 - If set to 1, only frame-DCT and frame prediction are used. 2257 * - __u8 2258 - ``concealment_motion_vectors`` 2259 - If set to 1, motion vectors are coded for intra macroblocks. 2260 * - __u8 2261 - ``q_scale_type`` 2262 - This flag affects the inverse quantization process. 2263 * - __u8 2264 - ``intra_vlc_format`` 2265 - This flag affects the decoding of transform coefficient data. 2266 * - __u8 2267 - ``alternate_scan`` 2268 - This flag affects the decoding of transform coefficient data. 2269 * - __u8 2270 - ``repeat_first_field`` 2271 - This flag affects the decoding process of progressive frames. 2272 * - __u16 2273 - ``progressive_frame`` 2274 - Indicates whether the current frame is progressive. 2275 2276``V4L2_CID_MPEG_VIDEO_MPEG2_QUANTIZATION (struct)`` 2277 Specifies quantization matrices (as extracted from the bitstream) for the 2278 associated MPEG-2 slice data. 2279 2280 .. note:: 2281 2282 This compound control is not yet part of the public kernel API and 2283 it is expected to change. 2284 2285.. c:type:: v4l2_ctrl_mpeg2_quantization 2286 2287.. cssclass:: longtable 2288 2289.. tabularcolumns:: |p{1.2cm}|p{8.0cm}|p{7.4cm}| 2290 2291.. raw:: latex 2292 2293 \small 2294 2295.. flat-table:: struct v4l2_ctrl_mpeg2_quantization 2296 :header-rows: 0 2297 :stub-columns: 0 2298 :widths: 1 1 2 2299 2300 * - __u8 2301 - ``load_intra_quantiser_matrix`` 2302 - One bit to indicate whether to load the ``intra_quantiser_matrix`` data. 2303 * - __u8 2304 - ``load_non_intra_quantiser_matrix`` 2305 - One bit to indicate whether to load the ``non_intra_quantiser_matrix`` 2306 data. 2307 * - __u8 2308 - ``load_chroma_intra_quantiser_matrix`` 2309 - One bit to indicate whether to load the 2310 ``chroma_intra_quantiser_matrix`` data, only relevant for non-4:2:0 YUV 2311 formats. 2312 * - __u8 2313 - ``load_chroma_non_intra_quantiser_matrix`` 2314 - One bit to indicate whether to load the 2315 ``chroma_non_intra_quantiser_matrix`` data, only relevant for non-4:2:0 2316 YUV formats. 2317 * - __u8 2318 - ``intra_quantiser_matrix[64]`` 2319 - The quantization matrix coefficients for intra-coded frames, in zigzag 2320 scanning order. It is relevant for both luma and chroma components, 2321 although it can be superseded by the chroma-specific matrix for 2322 non-4:2:0 YUV formats. 2323 * - __u8 2324 - ``non_intra_quantiser_matrix[64]`` 2325 - The quantization matrix coefficients for non-intra-coded frames, in 2326 zigzag scanning order. It is relevant for both luma and chroma 2327 components, although it can be superseded by the chroma-specific matrix 2328 for non-4:2:0 YUV formats. 2329 * - __u8 2330 - ``chroma_intra_quantiser_matrix[64]`` 2331 - The quantization matrix coefficients for the chominance component of 2332 intra-coded frames, in zigzag scanning order. Only relevant for 2333 non-4:2:0 YUV formats. 2334 * - __u8 2335 - ``chroma_non_intra_quantiser_matrix[64]`` 2336 - The quantization matrix coefficients for the chrominance component of 2337 non-intra-coded frames, in zigzag scanning order. Only relevant for 2338 non-4:2:0 YUV formats. 2339 2340``V4L2_CID_FWHT_I_FRAME_QP (integer)`` 2341 Quantization parameter for an I frame for FWHT. Valid range: from 1 2342 to 31. 2343 2344``V4L2_CID_FWHT_P_FRAME_QP (integer)`` 2345 Quantization parameter for a P frame for FWHT. Valid range: from 1 2346 to 31. 2347 2348.. _v4l2-mpeg-vp8: 2349 2350``V4L2_CID_MPEG_VIDEO_VP8_FRAME_HEADER (struct)`` 2351 Specifies the frame parameters for the associated VP8 parsed frame data. 2352 This includes the necessary parameters for 2353 configuring a stateless hardware decoding pipeline for VP8. 2354 The bitstream parameters are defined according to :ref:`vp8`. 2355 2356 .. note:: 2357 2358 This compound control is not yet part of the public kernel API and 2359 it is expected to change. 2360 2361.. c:type:: v4l2_ctrl_vp8_frame_header 2362 2363.. cssclass:: longtable 2364 2365.. tabularcolumns:: |p{5.8cm}|p{4.8cm}|p{6.6cm}| 2366 2367.. flat-table:: struct v4l2_ctrl_vp8_frame_header 2368 :header-rows: 0 2369 :stub-columns: 0 2370 :widths: 1 1 2 2371 2372 * - struct :c:type:`v4l2_vp8_segment_header` 2373 - ``segment_header`` 2374 - Structure with segment-based adjustments metadata. 2375 * - struct :c:type:`v4l2_vp8_loopfilter_header` 2376 - ``loopfilter_header`` 2377 - Structure with loop filter level adjustments metadata. 2378 * - struct :c:type:`v4l2_vp8_quantization_header` 2379 - ``quant_header`` 2380 - Structure with VP8 dequantization indices metadata. 2381 * - struct :c:type:`v4l2_vp8_entropy_header` 2382 - ``entropy_header`` 2383 - Structure with VP8 entropy coder probabilities metadata. 2384 * - struct :c:type:`v4l2_vp8_entropy_coder_state` 2385 - ``coder_state`` 2386 - Structure with VP8 entropy coder state. 2387 * - __u16 2388 - ``width`` 2389 - The width of the frame. Must be set for all frames. 2390 * - __u16 2391 - ``height`` 2392 - The height of the frame. Must be set for all frames. 2393 * - __u8 2394 - ``horizontal_scale`` 2395 - Horizontal scaling factor. 2396 * - __u8 2397 - ``vertical_scaling factor`` 2398 - Vertical scale. 2399 * - __u8 2400 - ``version`` 2401 - Bitstream version. 2402 * - __u8 2403 - ``prob_skip_false`` 2404 - Indicates the probability that the macroblock is not skipped. 2405 * - __u8 2406 - ``prob_intra`` 2407 - Indicates the probability that a macroblock is intra-predicted. 2408 * - __u8 2409 - ``prob_last`` 2410 - Indicates the probability that the last reference frame is used 2411 for inter-prediction 2412 * - __u8 2413 - ``prob_gf`` 2414 - Indicates the probability that the golden reference frame is used 2415 for inter-prediction 2416 * - __u8 2417 - ``num_dct_parts`` 2418 - Number of DCT coefficients partitions. Must be one of: 1, 2, 4, or 8. 2419 * - __u32 2420 - ``first_part_size`` 2421 - Size of the first partition, i.e. the control partition. 2422 * - __u32 2423 - ``first_part_header_bits`` 2424 - Size in bits of the first partition header portion. 2425 * - __u32 2426 - ``dct_part_sizes[8]`` 2427 - DCT coefficients sizes. 2428 * - __u64 2429 - ``last_frame_ts`` 2430 - Timestamp for the V4L2 capture buffer to use as last reference frame, used 2431 with inter-coded frames. The timestamp refers to the ``timestamp`` field in 2432 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2433 function to convert the struct :c:type:`timeval` in struct 2434 :c:type:`v4l2_buffer` to a __u64. 2435 * - __u64 2436 - ``golden_frame_ts`` 2437 - Timestamp for the V4L2 capture buffer to use as last reference frame, used 2438 with inter-coded frames. The timestamp refers to the ``timestamp`` field in 2439 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2440 function to convert the struct :c:type:`timeval` in struct 2441 :c:type:`v4l2_buffer` to a __u64. 2442 * - __u64 2443 - ``alt_frame_ts`` 2444 - Timestamp for the V4L2 capture buffer to use as alternate reference frame, used 2445 with inter-coded frames. The timestamp refers to the ``timestamp`` field in 2446 struct :c:type:`v4l2_buffer`. Use the :c:func:`v4l2_timeval_to_ns()` 2447 function to convert the struct :c:type:`timeval` in struct 2448 :c:type:`v4l2_buffer` to a __u64. 2449 * - __u64 2450 - ``flags`` 2451 - See :ref:`Frame Header Flags <vp8_frame_header_flags>` 2452 2453.. _vp8_frame_header_flags: 2454 2455``Frame Header Flags`` 2456 2457.. cssclass:: longtable 2458 2459.. flat-table:: 2460 :header-rows: 0 2461 :stub-columns: 0 2462 :widths: 1 1 2 2463 2464 * - ``V4L2_VP8_FRAME_HEADER_FLAG_KEY_FRAME`` 2465 - 0x01 2466 - Indicates if the frame is a key frame. 2467 * - ``V4L2_VP8_FRAME_HEADER_FLAG_EXPERIMENTAL`` 2468 - 0x02 2469 - Experimental bitstream. 2470 * - ``V4L2_VP8_FRAME_HEADER_FLAG_SHOW_FRAME`` 2471 - 0x04 2472 - Show frame flag, indicates if the frame is for display. 2473 * - ``V4L2_VP8_FRAME_HEADER_FLAG_MB_NO_SKIP_COEFF`` 2474 - 0x08 2475 - Enable/disable skipping of macroblocks with no non-zero coefficients. 2476 * - ``V4L2_VP8_FRAME_HEADER_FLAG_SIGN_BIAS_GOLDEN`` 2477 - 0x10 2478 - Sign of motion vectors when the golden frame is referenced. 2479 * - ``V4L2_VP8_FRAME_HEADER_FLAG_SIGN_BIAS_ALT`` 2480 - 0x20 2481 - Sign of motion vectors when the alt frame is referenced. 2482 2483.. c:type:: v4l2_vp8_entropy_coder_state 2484 2485.. cssclass:: longtable 2486 2487.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2488 2489.. flat-table:: struct v4l2_vp8_entropy_coder_state 2490 :header-rows: 0 2491 :stub-columns: 0 2492 :widths: 1 1 2 2493 2494 * - __u8 2495 - ``range`` 2496 - 2497 * - __u8 2498 - ``value`` 2499 - 2500 * - __u8 2501 - ``bit_count`` 2502 - 2503 * - __u8 2504 - ``padding`` 2505 - Applications and drivers must set this to zero. 2506 2507.. c:type:: v4l2_vp8_segment_header 2508 2509.. cssclass:: longtable 2510 2511.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2512 2513.. flat-table:: struct v4l2_vp8_segment_header 2514 :header-rows: 0 2515 :stub-columns: 0 2516 :widths: 1 1 2 2517 2518 * - __s8 2519 - ``quant_update[4]`` 2520 - Signed quantizer value update. 2521 * - __s8 2522 - ``lf_update[4]`` 2523 - Signed loop filter level value update. 2524 * - __u8 2525 - ``segment_probs[3]`` 2526 - Segment probabilities. 2527 * - __u8 2528 - ``padding`` 2529 - Applications and drivers must set this to zero. 2530 * - __u32 2531 - ``flags`` 2532 - See :ref:`Segment Header Flags <vp8_segment_header_flags>` 2533 2534.. _vp8_segment_header_flags: 2535 2536``Segment Header Flags`` 2537 2538.. cssclass:: longtable 2539 2540.. flat-table:: 2541 :header-rows: 0 2542 :stub-columns: 0 2543 :widths: 1 1 2 2544 2545 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_ENABLED`` 2546 - 0x01 2547 - Enable/disable segment-based adjustments. 2548 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_UPDATE_MAP`` 2549 - 0x02 2550 - Indicates if the macroblock segmentation map is updated in this frame. 2551 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_UPDATE_FEATURE_DATA`` 2552 - 0x04 2553 - Indicates if the segment feature data is updated in this frame. 2554 * - ``V4L2_VP8_SEGMENT_HEADER_FLAG_DELTA_VALUE_MODE`` 2555 - 0x08 2556 - If is set, the segment feature data mode is delta-value. 2557 If cleared, it's absolute-value. 2558 2559.. c:type:: v4l2_vp8_loopfilter_header 2560 2561.. cssclass:: longtable 2562 2563.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2564 2565.. flat-table:: struct v4l2_vp8_loopfilter_header 2566 :header-rows: 0 2567 :stub-columns: 0 2568 :widths: 1 1 2 2569 2570 * - __s8 2571 - ``ref_frm_delta[4]`` 2572 - Reference adjustment (signed) delta value. 2573 * - __s8 2574 - ``mb_mode_delta[4]`` 2575 - Macroblock prediction mode adjustment (signed) delta value. 2576 * - __u8 2577 - ``sharpness_level`` 2578 - Sharpness level 2579 * - __u8 2580 - ``level`` 2581 - Filter level 2582 * - __u16 2583 - ``padding`` 2584 - Applications and drivers must set this to zero. 2585 * - __u32 2586 - ``flags`` 2587 - See :ref:`Loopfilter Header Flags <vp8_loopfilter_header_flags>` 2588 2589.. _vp8_loopfilter_header_flags: 2590 2591``Loopfilter Header Flags`` 2592 2593.. cssclass:: longtable 2594 2595.. flat-table:: 2596 :header-rows: 0 2597 :stub-columns: 0 2598 :widths: 1 1 2 2599 2600 * - ``V4L2_VP8_LF_HEADER_ADJ_ENABLE`` 2601 - 0x01 2602 - Enable/disable macroblock-level loop filter adjustment. 2603 * - ``V4L2_VP8_LF_HEADER_DELTA_UPDATE`` 2604 - 0x02 2605 - Indicates if the delta values used in an adjustment are updated. 2606 * - ``V4L2_VP8_LF_FILTER_TYPE_SIMPLE`` 2607 - 0x04 2608 - If set, indicates the filter type is simple. 2609 If cleared, the filter type is normal. 2610 2611.. c:type:: v4l2_vp8_quantization_header 2612 2613.. cssclass:: longtable 2614 2615.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2616 2617.. flat-table:: struct v4l2_vp8_quantization_header 2618 :header-rows: 0 2619 :stub-columns: 0 2620 :widths: 1 1 2 2621 2622 * - __u8 2623 - ``y_ac_qi`` 2624 - Luma AC coefficient table index. 2625 * - __s8 2626 - ``y_dc_delta`` 2627 - Luma DC delta vaue. 2628 * - __s8 2629 - ``y2_dc_delta`` 2630 - Y2 block DC delta value. 2631 * - __s8 2632 - ``y2_ac_delta`` 2633 - Y2 block AC delta value. 2634 * - __s8 2635 - ``uv_dc_delta`` 2636 - Chroma DC delta value. 2637 * - __s8 2638 - ``uv_ac_delta`` 2639 - Chroma AC delta value. 2640 * - __u16 2641 - ``padding`` 2642 - Applications and drivers must set this to zero. 2643 2644.. c:type:: v4l2_vp8_entropy_header 2645 2646.. cssclass:: longtable 2647 2648.. tabularcolumns:: |p{1.5cm}|p{6.3cm}|p{9.4cm}| 2649 2650.. flat-table:: struct v4l2_vp8_entropy_header 2651 :header-rows: 0 2652 :stub-columns: 0 2653 :widths: 1 1 2 2654 2655 * - __u8 2656 - ``coeff_probs[4][8][3][11]`` 2657 - Coefficient update probabilities. 2658 * - __u8 2659 - ``y_mode_probs[4]`` 2660 - Luma mode update probabilities. 2661 * - __u8 2662 - ``uv_mode_probs[3]`` 2663 - Chroma mode update probabilities. 2664 * - __u8 2665 - ``mv_probs[2][19]`` 2666 - MV decoding update probabilities. 2667 * - __u8 2668 - ``padding[3]`` 2669 - Applications and drivers must set this to zero. 2670 2671.. raw:: latex 2672 2673 \normalsize 2674 2675 2676MFC 5.1 MPEG Controls 2677===================== 2678 2679The following MPEG class controls deal with MPEG decoding and encoding 2680settings that are specific to the Multi Format Codec 5.1 device present 2681in the S5P family of SoCs by Samsung. 2682 2683 2684.. _mfc51-control-id: 2685 2686MFC 5.1 Control IDs 2687------------------- 2688 2689``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE (boolean)`` 2690 If the display delay is enabled then the decoder is forced to return 2691 a CAPTURE buffer (decoded frame) after processing a certain number 2692 of OUTPUT buffers. The delay can be set through 2693 ``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY``. This 2694 feature can be used for example for generating thumbnails of videos. 2695 Applicable to the H264 decoder. 2696 2697``V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY (integer)`` 2698 Display delay value for H264 decoder. The decoder is forced to 2699 return a decoded frame after the set 'display delay' number of 2700 frames. If this number is low it may result in frames returned out 2701 of display order, in addition the hardware may still be using the 2702 returned buffer as a reference picture for subsequent frames. 2703 2704``V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P (integer)`` 2705 The number of reference pictures used for encoding a P picture. 2706 Applicable to the H264 encoder. 2707 2708``V4L2_CID_MPEG_MFC51_VIDEO_PADDING (boolean)`` 2709 Padding enable in the encoder - use a color instead of repeating 2710 border pixels. Applicable to encoders. 2711 2712``V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV (integer)`` 2713 Padding color in the encoder. Applicable to encoders. The supplied 2714 32-bit integer is interpreted as follows (bit 0 = least significant 2715 bit): 2716 2717 2718 2719.. flat-table:: 2720 :header-rows: 0 2721 :stub-columns: 0 2722 2723 * - Bit 0:7 2724 - V chrominance information 2725 * - Bit 8:15 2726 - U chrominance information 2727 * - Bit 16:23 2728 - Y luminance information 2729 * - Bit 24:31 2730 - Must be zero. 2731 2732 2733 2734``V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF (integer)`` 2735 Reaction coefficient for MFC rate control. Applicable to encoders. 2736 2737 .. note:: 2738 2739 #. Valid only when the frame level RC is enabled. 2740 2741 #. For tight CBR, this field must be small (ex. 2 ~ 10). For 2742 VBR, this field must be large (ex. 100 ~ 1000). 2743 2744 #. It is not recommended to use the greater number than 2745 FRAME_RATE * (10^9 / BIT_RATE). 2746 2747``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK (boolean)`` 2748 Adaptive rate control for dark region. Valid only when H.264 and 2749 macroblock level RC is enabled 2750 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2751 encoder. 2752 2753``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH (boolean)`` 2754 Adaptive rate control for smooth region. Valid only when H.264 and 2755 macroblock level RC is enabled 2756 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2757 encoder. 2758 2759``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC (boolean)`` 2760 Adaptive rate control for static region. Valid only when H.264 and 2761 macroblock level RC is enabled 2762 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2763 encoder. 2764 2765``V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY (boolean)`` 2766 Adaptive rate control for activity region. Valid only when H.264 and 2767 macroblock level RC is enabled 2768 (``V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE``). Applicable to the H264 2769 encoder. 2770 2771.. _v4l2-mpeg-mfc51-video-frame-skip-mode: 2772 2773``V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE`` 2774 (enum) 2775 2776enum v4l2_mpeg_mfc51_video_frame_skip_mode - 2777 Indicates in what conditions the encoder should skip frames. If 2778 encoding a frame would cause the encoded stream to be larger then a 2779 chosen data limit then the frame will be skipped. Possible values 2780 are: 2781 2782 2783.. tabularcolumns:: |p{9.2cm}|p{8.3cm}| 2784 2785.. raw:: latex 2786 2787 \small 2788 2789.. flat-table:: 2790 :header-rows: 0 2791 :stub-columns: 0 2792 2793 * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED`` 2794 - Frame skip mode is disabled. 2795 * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT`` 2796 - Frame skip mode enabled and buffer limit is set by the chosen 2797 level and is defined by the standard. 2798 * - ``V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT`` 2799 - Frame skip mode enabled and buffer limit is set by the VBV 2800 (MPEG1/2/4) or CPB (H264) buffer size control. 2801 2802.. raw:: latex 2803 2804 \normalsize 2805 2806``V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT (integer)`` 2807 Enable rate-control with fixed target bit. If this setting is 2808 enabled, then the rate control logic of the encoder will calculate 2809 the average bitrate for a GOP and keep it below or equal the set 2810 bitrate target. Otherwise the rate control logic calculates the 2811 overall average bitrate for the stream and keeps it below or equal 2812 to the set bitrate. In the first case the average bitrate for the 2813 whole stream will be smaller then the set bitrate. This is caused 2814 because the average is calculated for smaller number of frames, on 2815 the other hand enabling this setting will ensure that the stream 2816 will meet tight bandwidth constraints. Applicable to encoders. 2817 2818.. _v4l2-mpeg-mfc51-video-force-frame-type: 2819 2820``V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE`` 2821 (enum) 2822 2823enum v4l2_mpeg_mfc51_video_force_frame_type - 2824 Force a frame type for the next queued buffer. Applicable to 2825 encoders. Possible values are: 2826 2827.. tabularcolumns:: |p{9.5cm}|p{8.0cm}| 2828 2829.. flat-table:: 2830 :header-rows: 0 2831 :stub-columns: 0 2832 2833 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED`` 2834 - Forcing a specific frame type disabled. 2835 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME`` 2836 - Force an I-frame. 2837 * - ``V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED`` 2838 - Force a non-coded frame. 2839 2840 2841.. _v4l2-mpeg-fwht: 2842 2843``V4L2_CID_MPEG_VIDEO_FWHT_PARAMS (struct)`` 2844 Specifies the fwht parameters (as extracted from the bitstream) for the 2845 associated FWHT data. This includes the necessary parameters for 2846 configuring a stateless hardware decoding pipeline for FWHT. 2847 2848 .. note:: 2849 2850 This compound control is not yet part of the public kernel API and 2851 it is expected to change. 2852 2853.. c:type:: v4l2_ctrl_fwht_params 2854 2855.. cssclass:: longtable 2856 2857.. tabularcolumns:: |p{1.4cm}|p{4.3cm}|p{11.8cm}| 2858 2859.. flat-table:: struct v4l2_ctrl_fwht_params 2860 :header-rows: 0 2861 :stub-columns: 0 2862 :widths: 1 1 2 2863 2864 * - __u64 2865 - ``backward_ref_ts`` 2866 - Timestamp of the V4L2 capture buffer to use as backward reference, used 2867 with P-coded frames. The timestamp refers to the 2868 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 2869 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 2870 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 2871 * - __u32 2872 - ``version`` 2873 - The version of the codec 2874 * - __u32 2875 - ``width`` 2876 - The width of the frame 2877 * - __u32 2878 - ``height`` 2879 - The height of the frame 2880 * - __u32 2881 - ``flags`` 2882 - The flags of the frame, see :ref:`fwht-flags`. 2883 * - __u32 2884 - ``colorspace`` 2885 - The colorspace of the frame, from enum :c:type:`v4l2_colorspace`. 2886 * - __u32 2887 - ``xfer_func`` 2888 - The transfer function, from enum :c:type:`v4l2_xfer_func`. 2889 * - __u32 2890 - ``ycbcr_enc`` 2891 - The Y'CbCr encoding, from enum :c:type:`v4l2_ycbcr_encoding`. 2892 * - __u32 2893 - ``quantization`` 2894 - The quantization range, from enum :c:type:`v4l2_quantization`. 2895 2896 2897 2898.. _fwht-flags: 2899 2900FWHT Flags 2901============ 2902 2903.. cssclass:: longtable 2904 2905.. tabularcolumns:: |p{6.8cm}|p{2.4cm}|p{8.3cm}| 2906 2907.. flat-table:: 2908 :header-rows: 0 2909 :stub-columns: 0 2910 :widths: 3 1 4 2911 2912 * - ``FWHT_FL_IS_INTERLACED`` 2913 - 0x00000001 2914 - Set if this is an interlaced format 2915 * - ``FWHT_FL_IS_BOTTOM_FIRST`` 2916 - 0x00000002 2917 - Set if this is a bottom-first (NTSC) interlaced format 2918 * - ``FWHT_FL_IS_ALTERNATE`` 2919 - 0x00000004 2920 - Set if each 'frame' contains just one field 2921 * - ``FWHT_FL_IS_BOTTOM_FIELD`` 2922 - 0x00000008 2923 - If FWHT_FL_IS_ALTERNATE was set, then this is set if this 'frame' is the 2924 bottom field, else it is the top field. 2925 * - ``FWHT_FL_LUMA_IS_UNCOMPRESSED`` 2926 - 0x00000010 2927 - Set if the luma plane is uncompressed 2928 * - ``FWHT_FL_CB_IS_UNCOMPRESSED`` 2929 - 0x00000020 2930 - Set if the cb plane is uncompressed 2931 * - ``FWHT_FL_CR_IS_UNCOMPRESSED`` 2932 - 0x00000040 2933 - Set if the cr plane is uncompressed 2934 * - ``FWHT_FL_CHROMA_FULL_HEIGHT`` 2935 - 0x00000080 2936 - Set if the chroma plane has the same height as the luma plane, 2937 else the chroma plane is half the height of the luma plane 2938 * - ``FWHT_FL_CHROMA_FULL_WIDTH`` 2939 - 0x00000100 2940 - Set if the chroma plane has the same width as the luma plane, 2941 else the chroma plane is half the width of the luma plane 2942 * - ``FWHT_FL_ALPHA_IS_UNCOMPRESSED`` 2943 - 0x00000200 2944 - Set if the alpha plane is uncompressed 2945 * - ``FWHT_FL_I_FRAME`` 2946 - 0x00000400 2947 - Set if this is an I-frame 2948 * - ``FWHT_FL_COMPONENTS_NUM_MSK`` 2949 - 0x00070000 2950 - A 4-values flag - the number of components - 1 2951 * - ``FWHT_FL_PIXENC_YUV`` 2952 - 0x00080000 2953 - Set if the pixel encoding is YUV 2954 * - ``FWHT_FL_PIXENC_RGB`` 2955 - 0x00100000 2956 - Set if the pixel encoding is RGB 2957 * - ``FWHT_FL_PIXENC_HSV`` 2958 - 0x00180000 2959 - Set if the pixel encoding is HSV 2960 2961 2962CX2341x MPEG Controls 2963===================== 2964 2965The following MPEG class controls deal with MPEG encoding settings that 2966are specific to the Conexant CX23415 and CX23416 MPEG encoding chips. 2967 2968 2969.. _cx2341x-control-id: 2970 2971CX2341x Control IDs 2972------------------- 2973 2974.. _v4l2-mpeg-cx2341x-video-spatial-filter-mode: 2975 2976``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE`` 2977 (enum) 2978 2979enum v4l2_mpeg_cx2341x_video_spatial_filter_mode - 2980 Sets the Spatial Filter mode (default ``MANUAL``). Possible values 2981 are: 2982 2983 2984 2985.. flat-table:: 2986 :header-rows: 0 2987 :stub-columns: 0 2988 2989 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL`` 2990 - Choose the filter manually 2991 * - ``V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO`` 2992 - Choose the filter automatically 2993 2994 2995 2996``V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER (integer (0-15))`` 2997 The setting for the Spatial Filter. 0 = off, 15 = maximum. (Default 2998 is 0.) 2999 3000.. _luma-spatial-filter-type: 3001 3002``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE`` 3003 (enum) 3004 3005enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type - 3006 Select the algorithm to use for the Luma Spatial Filter (default 3007 ``1D_HOR``). Possible values: 3008 3009.. tabularcolumns:: |p{14.5cm}|p{3.0cm}| 3010 3011.. raw:: latex 3012 3013 \small 3014 3015.. flat-table:: 3016 :header-rows: 0 3017 :stub-columns: 0 3018 3019 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF`` 3020 - No filter 3021 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR`` 3022 - One-dimensional horizontal 3023 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT`` 3024 - One-dimensional vertical 3025 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE`` 3026 - Two-dimensional separable 3027 * - ``V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE`` 3028 - Two-dimensional symmetrical non-separable 3029 3030.. raw:: latex 3031 3032 \normalsize 3033 3034 3035 3036.. _chroma-spatial-filter-type: 3037 3038``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE`` 3039 (enum) 3040 3041enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type - 3042 Select the algorithm for the Chroma Spatial Filter (default 3043 ``1D_HOR``). Possible values are: 3044 3045 3046.. tabularcolumns:: |p{14.0cm}|p{3.5cm}| 3047 3048.. flat-table:: 3049 :header-rows: 0 3050 :stub-columns: 0 3051 3052 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF`` 3053 - No filter 3054 * - ``V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR`` 3055 - One-dimensional horizontal 3056 3057 3058 3059.. _v4l2-mpeg-cx2341x-video-temporal-filter-mode: 3060 3061``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE`` 3062 (enum) 3063 3064enum v4l2_mpeg_cx2341x_video_temporal_filter_mode - 3065 Sets the Temporal Filter mode (default ``MANUAL``). Possible values 3066 are: 3067 3068 3069 3070.. flat-table:: 3071 :header-rows: 0 3072 :stub-columns: 0 3073 3074 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL`` 3075 - Choose the filter manually 3076 * - ``V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO`` 3077 - Choose the filter automatically 3078 3079 3080 3081``V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER (integer (0-31))`` 3082 The setting for the Temporal Filter. 0 = off, 31 = maximum. (Default 3083 is 8 for full-scale capturing and 0 for scaled capturing.) 3084 3085.. _v4l2-mpeg-cx2341x-video-median-filter-type: 3086 3087``V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE`` 3088 (enum) 3089 3090enum v4l2_mpeg_cx2341x_video_median_filter_type - 3091 Median Filter Type (default ``OFF``). Possible values are: 3092 3093 3094 3095.. flat-table:: 3096 :header-rows: 0 3097 :stub-columns: 0 3098 3099 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF`` 3100 - No filter 3101 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR`` 3102 - Horizontal filter 3103 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT`` 3104 - Vertical filter 3105 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT`` 3106 - Horizontal and vertical filter 3107 * - ``V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG`` 3108 - Diagonal filter 3109 3110 3111 3112``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 3113 Threshold above which the luminance median filter is enabled 3114 (default 0) 3115 3116``V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP (integer (0-255))`` 3117 Threshold below which the luminance median filter is enabled 3118 (default 255) 3119 3120``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM (integer (0-255))`` 3121 Threshold above which the chroma median filter is enabled (default 3122 0) 3123 3124``V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP (integer (0-255))`` 3125 Threshold below which the chroma median filter is enabled (default 3126 255) 3127 3128``V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS (boolean)`` 3129 The CX2341X MPEG encoder can insert one empty MPEG-2 PES packet into 3130 the stream between every four video frames. The packet size is 2048 3131 bytes, including the packet_start_code_prefix and stream_id 3132 fields. The stream_id is 0xBF (private stream 2). The payload 3133 consists of 0x00 bytes, to be filled in by the application. 0 = do 3134 not insert, 1 = insert packets. 3135 3136 3137VPX Control Reference 3138===================== 3139 3140The VPX controls include controls for encoding parameters of VPx video 3141codec. 3142 3143 3144.. _vpx-control-id: 3145 3146VPX Control IDs 3147--------------- 3148 3149.. _v4l2-vpx-num-partitions: 3150 3151``V4L2_CID_MPEG_VIDEO_VPX_NUM_PARTITIONS`` 3152 (enum) 3153 3154enum v4l2_vp8_num_partitions - 3155 The number of token partitions to use in VP8 encoder. Possible 3156 values are: 3157 3158 3159 3160.. flat-table:: 3161 :header-rows: 0 3162 :stub-columns: 0 3163 3164 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_PARTITION`` 3165 - 1 coefficient partition 3166 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_PARTITIONS`` 3167 - 2 coefficient partitions 3168 * - ``V4L2_CID_MPEG_VIDEO_VPX_4_PARTITIONS`` 3169 - 4 coefficient partitions 3170 * - ``V4L2_CID_MPEG_VIDEO_VPX_8_PARTITIONS`` 3171 - 8 coefficient partitions 3172 3173 3174 3175``V4L2_CID_MPEG_VIDEO_VPX_IMD_DISABLE_4X4 (boolean)`` 3176 Setting this prevents intra 4x4 mode in the intra mode decision. 3177 3178.. _v4l2-vpx-num-ref-frames: 3179 3180``V4L2_CID_MPEG_VIDEO_VPX_NUM_REF_FRAMES`` 3181 (enum) 3182 3183enum v4l2_vp8_num_ref_frames - 3184 The number of reference pictures for encoding P frames. Possible 3185 values are: 3186 3187.. tabularcolumns:: |p{7.9cm}|p{9.6cm}| 3188 3189.. raw:: latex 3190 3191 \small 3192 3193.. flat-table:: 3194 :header-rows: 0 3195 :stub-columns: 0 3196 3197 * - ``V4L2_CID_MPEG_VIDEO_VPX_1_REF_FRAME`` 3198 - Last encoded frame will be searched 3199 * - ``V4L2_CID_MPEG_VIDEO_VPX_2_REF_FRAME`` 3200 - Two frames will be searched among the last encoded frame, the 3201 golden frame and the alternate reference (altref) frame. The 3202 encoder implementation will decide which two are chosen. 3203 * - ``V4L2_CID_MPEG_VIDEO_VPX_3_REF_FRAME`` 3204 - The last encoded frame, the golden frame and the altref frame will 3205 be searched. 3206 3207.. raw:: latex 3208 3209 \normalsize 3210 3211 3212 3213``V4L2_CID_MPEG_VIDEO_VPX_FILTER_LEVEL (integer)`` 3214 Indicates the loop filter level. The adjustment of the loop filter 3215 level is done via a delta value against a baseline loop filter 3216 value. 3217 3218``V4L2_CID_MPEG_VIDEO_VPX_FILTER_SHARPNESS (integer)`` 3219 This parameter affects the loop filter. Anything above zero weakens 3220 the deblocking effect on the loop filter. 3221 3222``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD (integer)`` 3223 Sets the refresh period for the golden frame. The period is defined 3224 in number of frames. For a value of 'n', every nth frame starting 3225 from the first key frame will be taken as a golden frame. For eg. 3226 for encoding sequence of 0, 1, 2, 3, 4, 5, 6, 7 where the golden 3227 frame refresh period is set as 4, the frames 0, 4, 8 etc will be 3228 taken as the golden frames as frame 0 is always a key frame. 3229 3230.. _v4l2-vpx-golden-frame-sel: 3231 3232``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_SEL`` 3233 (enum) 3234 3235enum v4l2_vp8_golden_frame_sel - 3236 Selects the golden frame for encoding. Possible values are: 3237 3238.. raw:: latex 3239 3240 \scriptsize 3241 3242.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3243 3244.. flat-table:: 3245 :header-rows: 0 3246 :stub-columns: 0 3247 3248 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_PREV`` 3249 - Use the (n-2)th frame as a golden frame, current frame index being 3250 'n'. 3251 * - ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_USE_REF_PERIOD`` 3252 - Use the previous specific frame indicated by 3253 ``V4L2_CID_MPEG_VIDEO_VPX_GOLDEN_FRAME_REF_PERIOD`` as a 3254 golden frame. 3255 3256.. raw:: latex 3257 3258 \normalsize 3259 3260 3261``V4L2_CID_MPEG_VIDEO_VPX_MIN_QP (integer)`` 3262 Minimum quantization parameter for VP8. 3263 3264``V4L2_CID_MPEG_VIDEO_VPX_MAX_QP (integer)`` 3265 Maximum quantization parameter for VP8. 3266 3267``V4L2_CID_MPEG_VIDEO_VPX_I_FRAME_QP (integer)`` 3268 Quantization parameter for an I frame for VP8. 3269 3270``V4L2_CID_MPEG_VIDEO_VPX_P_FRAME_QP (integer)`` 3271 Quantization parameter for a P frame for VP8. 3272 3273.. _v4l2-mpeg-video-vp8-profile: 3274 3275``V4L2_CID_MPEG_VIDEO_VP8_PROFILE`` 3276 (enum) 3277 3278enum v4l2_mpeg_video_vp8_profile - 3279 This control allows selecting the profile for VP8 encoder. 3280 This is also used to enumerate supported profiles by VP8 encoder or decoder. 3281 Possible values are: 3282 3283.. flat-table:: 3284 :header-rows: 0 3285 :stub-columns: 0 3286 3287 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_0`` 3288 - Profile 0 3289 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_1`` 3290 - Profile 1 3291 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_2`` 3292 - Profile 2 3293 * - ``V4L2_MPEG_VIDEO_VP8_PROFILE_3`` 3294 - Profile 3 3295 3296.. _v4l2-mpeg-video-vp9-profile: 3297 3298``V4L2_CID_MPEG_VIDEO_VP9_PROFILE`` 3299 (enum) 3300 3301enum v4l2_mpeg_video_vp9_profile - 3302 This control allows selecting the profile for VP9 encoder. 3303 This is also used to enumerate supported profiles by VP9 encoder or decoder. 3304 Possible values are: 3305 3306.. flat-table:: 3307 :header-rows: 0 3308 :stub-columns: 0 3309 3310 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_0`` 3311 - Profile 0 3312 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_1`` 3313 - Profile 1 3314 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_2`` 3315 - Profile 2 3316 * - ``V4L2_MPEG_VIDEO_VP9_PROFILE_3`` 3317 - Profile 3 3318 3319 3320High Efficiency Video Coding (HEVC/H.265) Control Reference 3321=========================================================== 3322 3323The HEVC/H.265 controls include controls for encoding parameters of HEVC/H.265 3324video codec. 3325 3326 3327.. _hevc-control-id: 3328 3329HEVC/H.265 Control IDs 3330---------------------- 3331 3332``V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP (integer)`` 3333 Minimum quantization parameter for HEVC. 3334 Valid range: from 0 to 51. 3335 3336``V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP (integer)`` 3337 Maximum quantization parameter for HEVC. 3338 Valid range: from 0 to 51. 3339 3340``V4L2_CID_MPEG_VIDEO_HEVC_I_FRAME_QP (integer)`` 3341 Quantization parameter for an I frame for HEVC. 3342 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3343 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3344 3345``V4L2_CID_MPEG_VIDEO_HEVC_P_FRAME_QP (integer)`` 3346 Quantization parameter for a P frame for HEVC. 3347 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3348 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3349 3350``V4L2_CID_MPEG_VIDEO_HEVC_B_FRAME_QP (integer)`` 3351 Quantization parameter for a B frame for HEVC. 3352 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3353 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3354 3355``V4L2_CID_MPEG_VIDEO_HEVC_HIER_QP (boolean)`` 3356 HIERARCHICAL_QP allows the host to specify the quantization parameter 3357 values for each temporal layer through HIERARCHICAL_QP_LAYER. This is 3358 valid only if HIERARCHICAL_CODING_LAYER is greater than 1. Setting the 3359 control value to 1 enables setting of the QP values for the layers. 3360 3361.. _v4l2-hevc-hier-coding-type: 3362 3363``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_TYPE`` 3364 (enum) 3365 3366enum v4l2_mpeg_video_hevc_hier_coding_type - 3367 Selects the hierarchical coding type for encoding. Possible values are: 3368 3369.. raw:: latex 3370 3371 \footnotesize 3372 3373.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3374 3375.. flat-table:: 3376 :header-rows: 0 3377 :stub-columns: 0 3378 3379 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_B`` 3380 - Use the B frame for hierarchical coding. 3381 * - ``V4L2_MPEG_VIDEO_HEVC_HIERARCHICAL_CODING_P`` 3382 - Use the P frame for hierarchical coding. 3383 3384.. raw:: latex 3385 3386 \normalsize 3387 3388 3389``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_LAYER (integer)`` 3390 Selects the hierarchical coding layer. In normal encoding 3391 (non-hierarchial coding), it should be zero. Possible values are [0, 6]. 3392 0 indicates HIERARCHICAL CODING LAYER 0, 1 indicates HIERARCHICAL CODING 3393 LAYER 1 and so on. 3394 3395``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_QP (integer)`` 3396 Indicates quantization parameter for hierarchical coding layer 0. 3397 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3398 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3399 3400``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_QP (integer)`` 3401 Indicates quantization parameter for hierarchical coding layer 1. 3402 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3403 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3404 3405``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_QP (integer)`` 3406 Indicates quantization parameter for hierarchical coding layer 2. 3407 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3408 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3409 3410``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_QP (integer)`` 3411 Indicates quantization parameter for hierarchical coding layer 3. 3412 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3413 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3414 3415``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_QP (integer)`` 3416 Indicates quantization parameter for hierarchical coding layer 4. 3417 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3418 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3419 3420``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_QP (integer)`` 3421 Indicates quantization parameter for hierarchical coding layer 5. 3422 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3423 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3424 3425``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_QP (integer)`` 3426 Indicates quantization parameter for hierarchical coding layer 6. 3427 Valid range: [V4L2_CID_MPEG_VIDEO_HEVC_MIN_QP, 3428 V4L2_CID_MPEG_VIDEO_HEVC_MAX_QP]. 3429 3430.. _v4l2-hevc-profile: 3431 3432``V4L2_CID_MPEG_VIDEO_HEVC_PROFILE`` 3433 (enum) 3434 3435enum v4l2_mpeg_video_hevc_profile - 3436 Select the desired profile for HEVC encoder. 3437 3438.. raw:: latex 3439 3440 \footnotesize 3441 3442.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3443 3444.. flat-table:: 3445 :header-rows: 0 3446 :stub-columns: 0 3447 3448 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN`` 3449 - Main profile. 3450 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_STILL_PICTURE`` 3451 - Main still picture profile. 3452 * - ``V4L2_MPEG_VIDEO_HEVC_PROFILE_MAIN_10`` 3453 - Main 10 profile. 3454 3455.. raw:: latex 3456 3457 \normalsize 3458 3459 3460.. _v4l2-hevc-level: 3461 3462``V4L2_CID_MPEG_VIDEO_HEVC_LEVEL`` 3463 (enum) 3464 3465enum v4l2_mpeg_video_hevc_level - 3466 Selects the desired level for HEVC encoder. 3467 3468.. raw:: latex 3469 3470 \footnotesize 3471 3472.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3473 3474.. flat-table:: 3475 :header-rows: 0 3476 :stub-columns: 0 3477 3478 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_1`` 3479 - Level 1.0 3480 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2`` 3481 - Level 2.0 3482 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_2_1`` 3483 - Level 2.1 3484 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3`` 3485 - Level 3.0 3486 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_3_1`` 3487 - Level 3.1 3488 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4`` 3489 - Level 4.0 3490 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_4_1`` 3491 - Level 4.1 3492 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5`` 3493 - Level 5.0 3494 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_1`` 3495 - Level 5.1 3496 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_5_2`` 3497 - Level 5.2 3498 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6`` 3499 - Level 6.0 3500 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_1`` 3501 - Level 6.1 3502 * - ``V4L2_MPEG_VIDEO_HEVC_LEVEL_6_2`` 3503 - Level 6.2 3504 3505.. raw:: latex 3506 3507 \normalsize 3508 3509 3510``V4L2_CID_MPEG_VIDEO_HEVC_FRAME_RATE_RESOLUTION (integer)`` 3511 Indicates the number of evenly spaced subintervals, called ticks, within 3512 one second. This is a 16 bit unsigned integer and has a maximum value up to 3513 0xffff and a minimum value of 1. 3514 3515.. _v4l2-hevc-tier: 3516 3517``V4L2_CID_MPEG_VIDEO_HEVC_TIER`` 3518 (enum) 3519 3520enum v4l2_mpeg_video_hevc_tier - 3521 TIER_FLAG specifies tiers information of the HEVC encoded picture. Tier 3522 were made to deal with applications that differ in terms of maximum bit 3523 rate. Setting the flag to 0 selects HEVC tier as Main tier and setting 3524 this flag to 1 indicates High tier. High tier is for applications requiring 3525 high bit rates. 3526 3527.. raw:: latex 3528 3529 \footnotesize 3530 3531.. tabularcolumns:: |p{9.0cm}|p{8.0cm}| 3532 3533.. flat-table:: 3534 :header-rows: 0 3535 :stub-columns: 0 3536 3537 * - ``V4L2_MPEG_VIDEO_HEVC_TIER_MAIN`` 3538 - Main tier. 3539 * - ``V4L2_MPEG_VIDEO_HEVC_TIER_HIGH`` 3540 - High tier. 3541 3542.. raw:: latex 3543 3544 \normalsize 3545 3546 3547``V4L2_CID_MPEG_VIDEO_HEVC_MAX_PARTITION_DEPTH (integer)`` 3548 Selects HEVC maximum coding unit depth. 3549 3550.. _v4l2-hevc-loop-filter-mode: 3551 3552``V4L2_CID_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE`` 3553 (enum) 3554 3555enum v4l2_mpeg_video_hevc_loop_filter_mode - 3556 Loop filter mode for HEVC encoder. Possible values are: 3557 3558.. raw:: latex 3559 3560 \footnotesize 3561 3562.. tabularcolumns:: |p{12.1cm}|p{5.4cm}| 3563 3564.. flat-table:: 3565 :header-rows: 0 3566 :stub-columns: 0 3567 3568 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED`` 3569 - Loop filter is disabled. 3570 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_ENABLED`` 3571 - Loop filter is enabled. 3572 * - ``V4L2_MPEG_VIDEO_HEVC_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY`` 3573 - Loop filter is disabled at the slice boundary. 3574 3575.. raw:: latex 3576 3577 \normalsize 3578 3579 3580``V4L2_CID_MPEG_VIDEO_HEVC_LF_BETA_OFFSET_DIV2 (integer)`` 3581 Selects HEVC loop filter beta offset. The valid range is [-6, +6]. 3582 3583``V4L2_CID_MPEG_VIDEO_HEVC_LF_TC_OFFSET_DIV2 (integer)`` 3584 Selects HEVC loop filter tc offset. The valid range is [-6, +6]. 3585 3586.. _v4l2-hevc-refresh-type: 3587 3588``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_TYPE`` 3589 (enum) 3590 3591enum v4l2_mpeg_video_hevc_hier_refresh_type - 3592 Selects refresh type for HEVC encoder. 3593 Host has to specify the period into 3594 V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD. 3595 3596.. raw:: latex 3597 3598 \footnotesize 3599 3600.. tabularcolumns:: |p{8.0cm}|p{9.0cm}| 3601 3602.. flat-table:: 3603 :header-rows: 0 3604 :stub-columns: 0 3605 3606 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_NONE`` 3607 - Use the B frame for hierarchical coding. 3608 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_CRA`` 3609 - Use CRA (Clean Random Access Unit) picture encoding. 3610 * - ``V4L2_MPEG_VIDEO_HEVC_REFRESH_IDR`` 3611 - Use IDR (Instantaneous Decoding Refresh) picture encoding. 3612 3613.. raw:: latex 3614 3615 \normalsize 3616 3617 3618``V4L2_CID_MPEG_VIDEO_HEVC_REFRESH_PERIOD (integer)`` 3619 Selects the refresh period for HEVC encoder. 3620 This specifies the number of I pictures between two CRA/IDR pictures. 3621 This is valid only if REFRESH_TYPE is not 0. 3622 3623``V4L2_CID_MPEG_VIDEO_HEVC_LOSSLESS_CU (boolean)`` 3624 Indicates HEVC lossless encoding. Setting it to 0 disables lossless 3625 encoding. Setting it to 1 enables lossless encoding. 3626 3627``V4L2_CID_MPEG_VIDEO_HEVC_CONST_INTRA_PRED (boolean)`` 3628 Indicates constant intra prediction for HEVC encoder. Specifies the 3629 constrained intra prediction in which intra largest coding unit (LCU) 3630 prediction is performed by using residual data and decoded samples of 3631 neighboring intra LCU only. Setting the value to 1 enables constant intra 3632 prediction and setting the value to 0 disables constant intra prediction. 3633 3634``V4L2_CID_MPEG_VIDEO_HEVC_WAVEFRONT (boolean)`` 3635 Indicates wavefront parallel processing for HEVC encoder. Setting it to 0 3636 disables the feature and setting it to 1 enables the wavefront parallel 3637 processing. 3638 3639``V4L2_CID_MPEG_VIDEO_HEVC_GENERAL_PB (boolean)`` 3640 Setting the value to 1 enables combination of P and B frame for HEVC 3641 encoder. 3642 3643``V4L2_CID_MPEG_VIDEO_HEVC_TEMPORAL_ID (boolean)`` 3644 Indicates temporal identifier for HEVC encoder which is enabled by 3645 setting the value to 1. 3646 3647``V4L2_CID_MPEG_VIDEO_HEVC_STRONG_SMOOTHING (boolean)`` 3648 Indicates bi-linear interpolation is conditionally used in the intra 3649 prediction filtering process in the CVS when set to 1. Indicates bi-linear 3650 interpolation is not used in the CVS when set to 0. 3651 3652``V4L2_CID_MPEG_VIDEO_HEVC_MAX_NUM_MERGE_MV_MINUS1 (integer)`` 3653 Indicates maximum number of merge candidate motion vectors. 3654 Values are from 0 to 4. 3655 3656``V4L2_CID_MPEG_VIDEO_HEVC_TMV_PREDICTION (boolean)`` 3657 Indicates temporal motion vector prediction for HEVC encoder. Setting it to 3658 1 enables the prediction. Setting it to 0 disables the prediction. 3659 3660``V4L2_CID_MPEG_VIDEO_HEVC_WITHOUT_STARTCODE (boolean)`` 3661 Specifies if HEVC generates a stream with a size of the length field 3662 instead of start code pattern. The size of the length field is configurable 3663 through the V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD control. Setting 3664 the value to 0 disables encoding without startcode pattern. Setting the 3665 value to 1 will enables encoding without startcode pattern. 3666 3667.. _v4l2-hevc-size-of-length-field: 3668 3669``V4L2_CID_MPEG_VIDEO_HEVC_SIZE_OF_LENGTH_FIELD`` 3670(enum) 3671 3672enum v4l2_mpeg_video_hevc_size_of_length_field - 3673 Indicates the size of length field. 3674 This is valid when encoding WITHOUT_STARTCODE_ENABLE is enabled. 3675 3676.. raw:: latex 3677 3678 \footnotesize 3679 3680.. tabularcolumns:: |p{6.0cm}|p{11.0cm}| 3681 3682.. flat-table:: 3683 :header-rows: 0 3684 :stub-columns: 0 3685 3686 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_0`` 3687 - Generate start code pattern (Normal). 3688 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_1`` 3689 - Generate size of length field instead of start code pattern and length is 1. 3690 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_2`` 3691 - Generate size of length field instead of start code pattern and length is 2. 3692 * - ``V4L2_MPEG_VIDEO_HEVC_SIZE_4`` 3693 - Generate size of length field instead of start code pattern and length is 4. 3694 3695.. raw:: latex 3696 3697 \normalsize 3698 3699``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L0_BR (integer)`` 3700 Indicates bit rate for hierarchical coding layer 0 for HEVC encoder. 3701 3702``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L1_BR (integer)`` 3703 Indicates bit rate for hierarchical coding layer 1 for HEVC encoder. 3704 3705``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L2_BR (integer)`` 3706 Indicates bit rate for hierarchical coding layer 2 for HEVC encoder. 3707 3708``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L3_BR (integer)`` 3709 Indicates bit rate for hierarchical coding layer 3 for HEVC encoder. 3710 3711``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L4_BR (integer)`` 3712 Indicates bit rate for hierarchical coding layer 4 for HEVC encoder. 3713 3714``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L5_BR (integer)`` 3715 Indicates bit rate for hierarchical coding layer 5 for HEVC encoder. 3716 3717``V4L2_CID_MPEG_VIDEO_HEVC_HIER_CODING_L6_BR (integer)`` 3718 Indicates bit rate for hierarchical coding layer 6 for HEVC encoder. 3719 3720``V4L2_CID_MPEG_VIDEO_REF_NUMBER_FOR_PFRAMES (integer)`` 3721 Selects number of P reference pictures required for HEVC encoder. 3722 P-Frame can use 1 or 2 frames for reference. 3723 3724``V4L2_CID_MPEG_VIDEO_PREPEND_SPSPPS_TO_IDR (integer)`` 3725 Indicates whether to generate SPS and PPS at every IDR. Setting it to 0 3726 disables generating SPS and PPS at every IDR. Setting it to one enables 3727 generating SPS and PPS at every IDR. 3728 3729.. _v4l2-mpeg-hevc: 3730 3731``V4L2_CID_MPEG_VIDEO_HEVC_SPS (struct)`` 3732 Specifies the Sequence Parameter Set fields (as extracted from the 3733 bitstream) for the associated HEVC slice data. 3734 These bitstream parameters are defined according to :ref:`hevc`. 3735 They are described in section 7.4.3.2 "Sequence parameter set RBSP 3736 semantics" of the specification. 3737 3738.. c:type:: v4l2_ctrl_hevc_sps 3739 3740.. cssclass:: longtable 3741 3742.. flat-table:: struct v4l2_ctrl_hevc_sps 3743 :header-rows: 0 3744 :stub-columns: 0 3745 :widths: 1 1 2 3746 3747 * - __u16 3748 - ``pic_width_in_luma_samples`` 3749 - 3750 * - __u16 3751 - ``pic_height_in_luma_samples`` 3752 - 3753 * - __u8 3754 - ``bit_depth_luma_minus8`` 3755 - 3756 * - __u8 3757 - ``bit_depth_chroma_minus8`` 3758 - 3759 * - __u8 3760 - ``log2_max_pic_order_cnt_lsb_minus4`` 3761 - 3762 * - __u8 3763 - ``sps_max_dec_pic_buffering_minus1`` 3764 - 3765 * - __u8 3766 - ``sps_max_num_reorder_pics`` 3767 - 3768 * - __u8 3769 - ``sps_max_latency_increase_plus1`` 3770 - 3771 * - __u8 3772 - ``log2_min_luma_coding_block_size_minus3`` 3773 - 3774 * - __u8 3775 - ``log2_diff_max_min_luma_coding_block_size`` 3776 - 3777 * - __u8 3778 - ``log2_min_luma_transform_block_size_minus2`` 3779 - 3780 * - __u8 3781 - ``log2_diff_max_min_luma_transform_block_size`` 3782 - 3783 * - __u8 3784 - ``max_transform_hierarchy_depth_inter`` 3785 - 3786 * - __u8 3787 - ``max_transform_hierarchy_depth_intra`` 3788 - 3789 * - __u8 3790 - ``pcm_sample_bit_depth_luma_minus1`` 3791 - 3792 * - __u8 3793 - ``pcm_sample_bit_depth_chroma_minus1`` 3794 - 3795 * - __u8 3796 - ``log2_min_pcm_luma_coding_block_size_minus3`` 3797 - 3798 * - __u8 3799 - ``log2_diff_max_min_pcm_luma_coding_block_size`` 3800 - 3801 * - __u8 3802 - ``num_short_term_ref_pic_sets`` 3803 - 3804 * - __u8 3805 - ``num_long_term_ref_pics_sps`` 3806 - 3807 * - __u8 3808 - ``chroma_format_idc`` 3809 - 3810 * - __u64 3811 - ``flags`` 3812 - See :ref:`Sequence Parameter Set Flags <hevc_sps_flags>` 3813 3814.. _hevc_sps_flags: 3815 3816``Sequence Parameter Set Flags`` 3817 3818.. cssclass:: longtable 3819 3820.. flat-table:: 3821 :header-rows: 0 3822 :stub-columns: 0 3823 :widths: 1 1 2 3824 3825 * - ``V4L2_HEVC_SPS_FLAG_SEPARATE_COLOUR_PLANE`` 3826 - 0x00000001 3827 - 3828 * - ``V4L2_HEVC_SPS_FLAG_SCALING_LIST_ENABLED`` 3829 - 0x00000002 3830 - 3831 * - ``V4L2_HEVC_SPS_FLAG_AMP_ENABLED`` 3832 - 0x00000004 3833 - 3834 * - ``V4L2_HEVC_SPS_FLAG_SAMPLE_ADAPTIVE_OFFSET`` 3835 - 0x00000008 3836 - 3837 * - ``V4L2_HEVC_SPS_FLAG_PCM_ENABLED`` 3838 - 0x00000010 3839 - 3840 * - ``V4L2_HEVC_SPS_FLAG_PCM_LOOP_FILTER_DISABLED`` 3841 - 0x00000020 3842 - 3843 * - ``V4L2_HEVC_SPS_FLAG_LONG_TERM_REF_PICS_PRESENT`` 3844 - 0x00000040 3845 - 3846 * - ``V4L2_HEVC_SPS_FLAG_SPS_TEMPORAL_MVP_ENABLED`` 3847 - 0x00000080 3848 - 3849 * - ``V4L2_HEVC_SPS_FLAG_STRONG_INTRA_SMOOTHING_ENABLED`` 3850 - 0x00000100 3851 - 3852 3853``V4L2_CID_MPEG_VIDEO_HEVC_PPS (struct)`` 3854 Specifies the Picture Parameter Set fields (as extracted from the 3855 bitstream) for the associated HEVC slice data. 3856 These bitstream parameters are defined according to :ref:`hevc`. 3857 They are described in section 7.4.3.3 "Picture parameter set RBSP 3858 semantics" of the specification. 3859 3860.. c:type:: v4l2_ctrl_hevc_pps 3861 3862.. cssclass:: longtable 3863 3864.. flat-table:: struct v4l2_ctrl_hevc_pps 3865 :header-rows: 0 3866 :stub-columns: 0 3867 :widths: 1 1 2 3868 3869 * - __u8 3870 - ``num_extra_slice_header_bits`` 3871 - 3872 * - __s8 3873 - ``init_qp_minus26`` 3874 - 3875 * - __u8 3876 - ``diff_cu_qp_delta_depth`` 3877 - 3878 * - __s8 3879 - ``pps_cb_qp_offset`` 3880 - 3881 * - __s8 3882 - ``pps_cr_qp_offset`` 3883 - 3884 * - __u8 3885 - ``num_tile_columns_minus1`` 3886 - 3887 * - __u8 3888 - ``num_tile_rows_minus1`` 3889 - 3890 * - __u8 3891 - ``column_width_minus1[20]`` 3892 - 3893 * - __u8 3894 - ``row_height_minus1[22]`` 3895 - 3896 * - __s8 3897 - ``pps_beta_offset_div2`` 3898 - 3899 * - __s8 3900 - ``pps_tc_offset_div2`` 3901 - 3902 * - __u8 3903 - ``log2_parallel_merge_level_minus2`` 3904 - 3905 * - __u8 3906 - ``padding[4]`` 3907 - Applications and drivers must set this to zero. 3908 * - __u64 3909 - ``flags`` 3910 - See :ref:`Picture Parameter Set Flags <hevc_pps_flags>` 3911 3912.. _hevc_pps_flags: 3913 3914``Picture Parameter Set Flags`` 3915 3916.. cssclass:: longtable 3917 3918.. flat-table:: 3919 :header-rows: 0 3920 :stub-columns: 0 3921 :widths: 1 1 2 3922 3923 * - ``V4L2_HEVC_PPS_FLAG_DEPENDENT_SLICE_SEGMENT`` 3924 - 0x00000001 3925 - 3926 * - ``V4L2_HEVC_PPS_FLAG_OUTPUT_FLAG_PRESENT`` 3927 - 0x00000002 3928 - 3929 * - ``V4L2_HEVC_PPS_FLAG_SIGN_DATA_HIDING_ENABLED`` 3930 - 0x00000004 3931 - 3932 * - ``V4L2_HEVC_PPS_FLAG_CABAC_INIT_PRESENT`` 3933 - 0x00000008 3934 - 3935 * - ``V4L2_HEVC_PPS_FLAG_CONSTRAINED_INTRA_PRED`` 3936 - 0x00000010 3937 - 3938 * - ``V4L2_HEVC_PPS_FLAG_TRANSFORM_SKIP_ENABLED`` 3939 - 0x00000020 3940 - 3941 * - ``V4L2_HEVC_PPS_FLAG_CU_QP_DELTA_ENABLED`` 3942 - 0x00000040 3943 - 3944 * - ``V4L2_HEVC_PPS_FLAG_PPS_SLICE_CHROMA_QP_OFFSETS_PRESENT`` 3945 - 0x00000080 3946 - 3947 * - ``V4L2_HEVC_PPS_FLAG_WEIGHTED_PRED`` 3948 - 0x00000100 3949 - 3950 * - ``V4L2_HEVC_PPS_FLAG_WEIGHTED_BIPRED`` 3951 - 0x00000200 3952 - 3953 * - ``V4L2_HEVC_PPS_FLAG_TRANSQUANT_BYPASS_ENABLED`` 3954 - 0x00000400 3955 - 3956 * - ``V4L2_HEVC_PPS_FLAG_TILES_ENABLED`` 3957 - 0x00000800 3958 - 3959 * - ``V4L2_HEVC_PPS_FLAG_ENTROPY_CODING_SYNC_ENABLED`` 3960 - 0x00001000 3961 - 3962 * - ``V4L2_HEVC_PPS_FLAG_LOOP_FILTER_ACROSS_TILES_ENABLED`` 3963 - 0x00002000 3964 - 3965 * - ``V4L2_HEVC_PPS_FLAG_PPS_LOOP_FILTER_ACROSS_SLICES_ENABLED`` 3966 - 0x00004000 3967 - 3968 * - ``V4L2_HEVC_PPS_FLAG_DEBLOCKING_FILTER_OVERRIDE_ENABLED`` 3969 - 0x00008000 3970 - 3971 * - ``V4L2_HEVC_PPS_FLAG_PPS_DISABLE_DEBLOCKING_FILTER`` 3972 - 0x00010000 3973 - 3974 * - ``V4L2_HEVC_PPS_FLAG_LISTS_MODIFICATION_PRESENT`` 3975 - 0x00020000 3976 - 3977 * - ``V4L2_HEVC_PPS_FLAG_SLICE_SEGMENT_HEADER_EXTENSION_PRESENT`` 3978 - 0x00040000 3979 - 3980 3981``V4L2_CID_MPEG_VIDEO_HEVC_SLICE_PARAMS (struct)`` 3982 Specifies various slice-specific parameters, especially from the NAL unit 3983 header, general slice segment header and weighted prediction parameter 3984 parts of the bitstream. 3985 These bitstream parameters are defined according to :ref:`hevc`. 3986 They are described in section 7.4.7 "General slice segment header 3987 semantics" of the specification. 3988 3989.. c:type:: v4l2_ctrl_hevc_slice_params 3990 3991.. cssclass:: longtable 3992 3993.. flat-table:: struct v4l2_ctrl_hevc_slice_params 3994 :header-rows: 0 3995 :stub-columns: 0 3996 :widths: 1 1 2 3997 3998 * - __u32 3999 - ``bit_size`` 4000 - Size (in bits) of the current slice data. 4001 * - __u32 4002 - ``data_bit_offset`` 4003 - Offset (in bits) to the video data in the current slice data. 4004 * - __u8 4005 - ``nal_unit_type`` 4006 - 4007 * - __u8 4008 - ``nuh_temporal_id_plus1`` 4009 - 4010 * - __u8 4011 - ``slice_type`` 4012 - 4013 (V4L2_HEVC_SLICE_TYPE_I, V4L2_HEVC_SLICE_TYPE_P or 4014 V4L2_HEVC_SLICE_TYPE_B). 4015 * - __u8 4016 - ``colour_plane_id`` 4017 - 4018 * - __u16 4019 - ``slice_pic_order_cnt`` 4020 - 4021 * - __u8 4022 - ``num_ref_idx_l0_active_minus1`` 4023 - 4024 * - __u8 4025 - ``num_ref_idx_l1_active_minus1`` 4026 - 4027 * - __u8 4028 - ``collocated_ref_idx`` 4029 - 4030 * - __u8 4031 - ``five_minus_max_num_merge_cand`` 4032 - 4033 * - __s8 4034 - ``slice_qp_delta`` 4035 - 4036 * - __s8 4037 - ``slice_cb_qp_offset`` 4038 - 4039 * - __s8 4040 - ``slice_cr_qp_offset`` 4041 - 4042 * - __s8 4043 - ``slice_act_y_qp_offset`` 4044 - 4045 * - __s8 4046 - ``slice_act_cb_qp_offset`` 4047 - 4048 * - __s8 4049 - ``slice_act_cr_qp_offset`` 4050 - 4051 * - __s8 4052 - ``slice_beta_offset_div2`` 4053 - 4054 * - __s8 4055 - ``slice_tc_offset_div2`` 4056 - 4057 * - __u8 4058 - ``pic_struct`` 4059 - 4060 * - __u8 4061 - ``num_active_dpb_entries`` 4062 - The number of entries in ``dpb``. 4063 * - __u8 4064 - ``ref_idx_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4065 - The list of L0 reference elements as indices in the DPB. 4066 * - __u8 4067 - ``ref_idx_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4068 - The list of L1 reference elements as indices in the DPB. 4069 * - __u8 4070 - ``num_rps_poc_st_curr_before`` 4071 - The number of reference pictures in the short-term set that come before 4072 the current frame. 4073 * - __u8 4074 - ``num_rps_poc_st_curr_after`` 4075 - The number of reference pictures in the short-term set that come after 4076 the current frame. 4077 * - __u8 4078 - ``num_rps_poc_lt_curr`` 4079 - The number of reference pictures in the long-term set. 4080 * - __u8 4081 - ``padding[7]`` 4082 - Applications and drivers must set this to zero. 4083 * - struct :c:type:`v4l2_hevc_dpb_entry` 4084 - ``dpb[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4085 - The decoded picture buffer, for meta-data about reference frames. 4086 * - struct :c:type:`v4l2_hevc_pred_weight_table` 4087 - ``pred_weight_table`` 4088 - The prediction weight coefficients for inter-picture prediction. 4089 * - __u64 4090 - ``flags`` 4091 - See :ref:`Slice Parameters Flags <hevc_slice_params_flags>` 4092 4093.. _hevc_slice_params_flags: 4094 4095``Slice Parameters Flags`` 4096 4097.. cssclass:: longtable 4098 4099.. flat-table:: 4100 :header-rows: 0 4101 :stub-columns: 0 4102 :widths: 1 1 2 4103 4104 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_LUMA`` 4105 - 0x00000001 4106 - 4107 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_SAO_CHROMA`` 4108 - 0x00000002 4109 - 4110 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_TEMPORAL_MVP_ENABLED`` 4111 - 0x00000004 4112 - 4113 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_MVD_L1_ZERO`` 4114 - 0x00000008 4115 - 4116 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_CABAC_INIT`` 4117 - 0x00000010 4118 - 4119 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_COLLOCATED_FROM_L0`` 4120 - 0x00000020 4121 - 4122 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_USE_INTEGER_MV`` 4123 - 0x00000040 4124 - 4125 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_DEBLOCKING_FILTER_DISABLED`` 4126 - 0x00000080 4127 - 4128 * - ``V4L2_HEVC_SLICE_PARAMS_FLAG_SLICE_LOOP_FILTER_ACROSS_SLICES_ENABLED`` 4129 - 0x00000100 4130 - 4131 4132.. c:type:: v4l2_hevc_dpb_entry 4133 4134.. cssclass:: longtable 4135 4136.. flat-table:: struct v4l2_hevc_dpb_entry 4137 :header-rows: 0 4138 :stub-columns: 0 4139 :widths: 1 1 2 4140 4141 * - __u64 4142 - ``timestamp`` 4143 - Timestamp of the V4L2 capture buffer to use as reference, used 4144 with B-coded and P-coded frames. The timestamp refers to the 4145 ``timestamp`` field in struct :c:type:`v4l2_buffer`. Use the 4146 :c:func:`v4l2_timeval_to_ns()` function to convert the struct 4147 :c:type:`timeval` in struct :c:type:`v4l2_buffer` to a __u64. 4148 * - __u8 4149 - ``rps`` 4150 - The reference set for the reference frame 4151 (V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_BEFORE, 4152 V4L2_HEVC_DPB_ENTRY_RPS_ST_CURR_AFTER or 4153 V4L2_HEVC_DPB_ENTRY_RPS_LT_CURR) 4154 * - __u8 4155 - ``field_pic`` 4156 - Whether the reference is a field picture or a frame. 4157 * - __u16 4158 - ``pic_order_cnt[2]`` 4159 - The picture order count of the reference. Only the first element of the 4160 array is used for frame pictures, while the first element identifies the 4161 top field and the second the bottom field in field-coded pictures. 4162 * - __u8 4163 - ``padding[2]`` 4164 - Applications and drivers must set this to zero. 4165 4166.. c:type:: v4l2_hevc_pred_weight_table 4167 4168.. cssclass:: longtable 4169 4170.. flat-table:: struct v4l2_hevc_pred_weight_table 4171 :header-rows: 0 4172 :stub-columns: 0 4173 :widths: 1 1 2 4174 4175 * - __u8 4176 - ``luma_log2_weight_denom`` 4177 - 4178 * - __s8 4179 - ``delta_chroma_log2_weight_denom`` 4180 - 4181 * - __s8 4182 - ``delta_luma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4183 - 4184 * - __s8 4185 - ``luma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4186 - 4187 * - __s8 4188 - ``delta_chroma_weight_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 4189 - 4190 * - __s8 4191 - ``chroma_offset_l0[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 4192 - 4193 * - __s8 4194 - ``delta_luma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4195 - 4196 * - __s8 4197 - ``luma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX]`` 4198 - 4199 * - __s8 4200 - ``delta_chroma_weight_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 4201 - 4202 * - __s8 4203 - ``chroma_offset_l1[V4L2_HEVC_DPB_ENTRIES_NUM_MAX][2]`` 4204 - 4205 * - __u8 4206 - ``padding[6]`` 4207 - Applications and drivers must set this to zero. 4208 4209``V4L2_CID_MPEG_VIDEO_HEVC_DECODE_MODE (enum)`` 4210 Specifies the decoding mode to use. Currently exposes slice-based and 4211 frame-based decoding but new modes might be added later on. 4212 This control is used as a modifier for V4L2_PIX_FMT_HEVC_SLICE 4213 pixel format. Applications that support V4L2_PIX_FMT_HEVC_SLICE 4214 are required to set this control in order to specify the decoding mode 4215 that is expected for the buffer. 4216 Drivers may expose a single or multiple decoding modes, depending 4217 on what they can support. 4218 4219 .. note:: 4220 4221 This menu control is not yet part of the public kernel API and 4222 it is expected to change. 4223 4224.. c:type:: v4l2_mpeg_video_hevc_decode_mode 4225 4226.. cssclass:: longtable 4227 4228.. flat-table:: 4229 :header-rows: 0 4230 :stub-columns: 0 4231 :widths: 1 1 2 4232 4233 * - ``V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_SLICE_BASED`` 4234 - 0 4235 - Decoding is done at the slice granularity. 4236 The OUTPUT buffer must contain a single slice. 4237 * - ``V4L2_MPEG_VIDEO_HEVC_DECODE_MODE_FRAME_BASED`` 4238 - 1 4239 - Decoding is done at the frame granularity. 4240 The OUTPUT buffer must contain all slices needed to decode the 4241 frame. The OUTPUT buffer must also contain both fields. 4242 4243``V4L2_CID_MPEG_VIDEO_HEVC_START_CODE (enum)`` 4244 Specifies the HEVC slice start code expected for each slice. 4245 This control is used as a modifier for V4L2_PIX_FMT_HEVC_SLICE 4246 pixel format. Applications that support V4L2_PIX_FMT_HEVC_SLICE 4247 are required to set this control in order to specify the start code 4248 that is expected for the buffer. 4249 Drivers may expose a single or multiple start codes, depending 4250 on what they can support. 4251 4252 .. note:: 4253 4254 This menu control is not yet part of the public kernel API and 4255 it is expected to change. 4256 4257.. c:type:: v4l2_mpeg_video_hevc_start_code 4258 4259.. cssclass:: longtable 4260 4261.. flat-table:: 4262 :header-rows: 0 4263 :stub-columns: 0 4264 :widths: 1 1 2 4265 4266 * - ``V4L2_MPEG_VIDEO_HEVC_START_CODE_NONE`` 4267 - 0 4268 - Selecting this value specifies that HEVC slices are passed 4269 to the driver without any start code. 4270 * - ``V4L2_MPEG_VIDEO_HEVC_START_CODE_ANNEX_B`` 4271 - 1 4272 - Selecting this value specifies that HEVC slices are expected 4273 to be prefixed by Annex B start codes. According to :ref:`hevc` 4274 valid start codes can be 3-bytes 0x000001 or 4-bytes 0x00000001. 4275