1 <section id="control"> 2 <title>User Controls</title> 3 4 <para>Devices typically have a number of user-settable controls 5such as brightness, saturation and so on, which would be presented to 6the user on a graphical user interface. But, different devices 7will have different controls available, and furthermore, the range of 8possible values, and the default value will vary from device to 9device. The control ioctls provide the information and a mechanism to 10create a nice user interface for these controls that will work 11correctly with any device.</para> 12 13 <para>All controls are accessed using an ID value. V4L2 defines 14several IDs for specific purposes. Drivers can also implement their 15own custom controls using <constant>V4L2_CID_PRIVATE_BASE</constant> 16and higher values. The pre-defined control IDs have the prefix 17<constant>V4L2_CID_</constant>, and are listed in <xref 18linkend="control-id" />. The ID is used when querying the attributes of 19a control, and when getting or setting the current value.</para> 20 21 <para>Generally applications should present controls to the user 22without assumptions about their purpose. Each control comes with a 23name string the user is supposed to understand. When the purpose is 24non-intuitive the driver writer should provide a user manual, a user 25interface plug-in or a driver specific panel application. Predefined 26IDs were introduced to change a few controls programmatically, for 27example to mute a device during a channel switch.</para> 28 29 <para>Drivers may enumerate different controls after switching 30the current video input or output, tuner or modulator, or audio input 31or output. Different in the sense of other bounds, another default and 32current value, step size or other menu items. A control with a certain 33<emphasis>custom</emphasis> ID can also change name and 34type.<footnote> 35 <para>It will be more convenient for applications if drivers 36make use of the <constant>V4L2_CTRL_FLAG_DISABLED</constant> flag, but 37that was never required.</para> 38 </footnote> Control values are stored globally, they do not 39change when switching except to stay within the reported bounds. They 40also do not change ⪚ when the device is opened or closed, when the 41tuner radio frequency is changed or generally never without 42application request. Since V4L2 specifies no event mechanism, panel 43applications intended to cooperate with other panel applications (be 44they built into a larger application, as a TV viewer) may need to 45regularly poll control values to update their user 46interface.<footnote> 47 <para>Applications could call an ioctl to request events. 48After another process called &VIDIOC-S-CTRL; or another ioctl changing 49shared properties the &func-select; function would indicate 50readability until any ioctl (querying the properties) is 51called.</para> 52 </footnote></para> 53 54 <para> 55 All controls use machine endianness. 56 </para> 57 58 <table pgwide="1" frame="none" id="control-id"> 59 <title>Control IDs</title> 60 <tgroup cols="3"> 61 &cs-def; 62 <thead> 63 <row> 64 <entry>ID</entry> 65 <entry>Type</entry> 66 <entry>Description</entry> 67 </row> 68 </thead> 69 <tbody valign="top"> 70 <row> 71 <entry><constant>V4L2_CID_BASE</constant></entry> 72 <entry></entry> 73 <entry>First predefined ID, equal to 74<constant>V4L2_CID_BRIGHTNESS</constant>.</entry> 75 </row> 76 <row> 77 <entry><constant>V4L2_CID_USER_BASE</constant></entry> 78 <entry></entry> 79 <entry>Synonym of <constant>V4L2_CID_BASE</constant>.</entry> 80 </row> 81 <row> 82 <entry><constant>V4L2_CID_BRIGHTNESS</constant></entry> 83 <entry>integer</entry> 84 <entry>Picture brightness, or more precisely, the black 85level.</entry> 86 </row> 87 <row> 88 <entry><constant>V4L2_CID_CONTRAST</constant></entry> 89 <entry>integer</entry> 90 <entry>Picture contrast or luma gain.</entry> 91 </row> 92 <row> 93 <entry><constant>V4L2_CID_SATURATION</constant></entry> 94 <entry>integer</entry> 95 <entry>Picture color saturation or chroma gain.</entry> 96 </row> 97 <row> 98 <entry><constant>V4L2_CID_HUE</constant></entry> 99 <entry>integer</entry> 100 <entry>Hue or color balance.</entry> 101 </row> 102 <row> 103 <entry><constant>V4L2_CID_AUDIO_VOLUME</constant></entry> 104 <entry>integer</entry> 105 <entry>Overall audio volume. Note some drivers also 106provide an OSS or ALSA mixer interface.</entry> 107 </row> 108 <row> 109 <entry><constant>V4L2_CID_AUDIO_BALANCE</constant></entry> 110 <entry>integer</entry> 111 <entry>Audio stereo balance. Minimum corresponds to all 112the way left, maximum to right.</entry> 113 </row> 114 <row> 115 <entry><constant>V4L2_CID_AUDIO_BASS</constant></entry> 116 <entry>integer</entry> 117 <entry>Audio bass adjustment.</entry> 118 </row> 119 <row> 120 <entry><constant>V4L2_CID_AUDIO_TREBLE</constant></entry> 121 <entry>integer</entry> 122 <entry>Audio treble adjustment.</entry> 123 </row> 124 <row> 125 <entry><constant>V4L2_CID_AUDIO_MUTE</constant></entry> 126 <entry>boolean</entry> 127 <entry>Mute audio, &ie; set the volume to zero, however 128without affecting <constant>V4L2_CID_AUDIO_VOLUME</constant>. Like 129ALSA drivers, V4L2 drivers must mute at load time to avoid excessive 130noise. Actually the entire device should be reset to a low power 131consumption state.</entry> 132 </row> 133 <row> 134 <entry><constant>V4L2_CID_AUDIO_LOUDNESS</constant></entry> 135 <entry>boolean</entry> 136 <entry>Loudness mode (bass boost).</entry> 137 </row> 138 <row> 139 <entry><constant>V4L2_CID_BLACK_LEVEL</constant></entry> 140 <entry>integer</entry> 141 <entry>Another name for brightness (not a synonym of 142<constant>V4L2_CID_BRIGHTNESS</constant>). This control is deprecated 143and should not be used in new drivers and applications.</entry> 144 </row> 145 <row> 146 <entry><constant>V4L2_CID_AUTO_WHITE_BALANCE</constant></entry> 147 <entry>boolean</entry> 148 <entry>Automatic white balance (cameras).</entry> 149 </row> 150 <row> 151 <entry><constant>V4L2_CID_DO_WHITE_BALANCE</constant></entry> 152 <entry>button</entry> 153 <entry>This is an action control. When set (the value is 154ignored), the device will do a white balance and then hold the current 155setting. Contrast this with the boolean 156<constant>V4L2_CID_AUTO_WHITE_BALANCE</constant>, which, when 157activated, keeps adjusting the white balance.</entry> 158 </row> 159 <row> 160 <entry><constant>V4L2_CID_RED_BALANCE</constant></entry> 161 <entry>integer</entry> 162 <entry>Red chroma balance.</entry> 163 </row> 164 <row> 165 <entry><constant>V4L2_CID_BLUE_BALANCE</constant></entry> 166 <entry>integer</entry> 167 <entry>Blue chroma balance.</entry> 168 </row> 169 <row> 170 <entry><constant>V4L2_CID_GAMMA</constant></entry> 171 <entry>integer</entry> 172 <entry>Gamma adjust.</entry> 173 </row> 174 <row> 175 <entry><constant>V4L2_CID_WHITENESS</constant></entry> 176 <entry>integer</entry> 177 <entry>Whiteness for grey-scale devices. This is a synonym 178for <constant>V4L2_CID_GAMMA</constant>. This control is deprecated 179and should not be used in new drivers and applications.</entry> 180 </row> 181 <row> 182 <entry><constant>V4L2_CID_EXPOSURE</constant></entry> 183 <entry>integer</entry> 184 <entry>Exposure (cameras). [Unit?]</entry> 185 </row> 186 <row> 187 <entry><constant>V4L2_CID_AUTOGAIN</constant></entry> 188 <entry>boolean</entry> 189 <entry>Automatic gain/exposure control.</entry> 190 </row> 191 <row> 192 <entry><constant>V4L2_CID_GAIN</constant></entry> 193 <entry>integer</entry> 194 <entry>Gain control.</entry> 195 </row> 196 <row> 197 <entry><constant>V4L2_CID_HFLIP</constant></entry> 198 <entry>boolean</entry> 199 <entry>Mirror the picture horizontally.</entry> 200 </row> 201 <row> 202 <entry><constant>V4L2_CID_VFLIP</constant></entry> 203 <entry>boolean</entry> 204 <entry>Mirror the picture vertically.</entry> 205 </row> 206 <row> 207 <entry><constant>V4L2_CID_HCENTER_DEPRECATED</constant> (formerly <constant>V4L2_CID_HCENTER</constant>)</entry> 208 <entry>integer</entry> 209 <entry>Horizontal image centering. This control is 210deprecated. New drivers and applications should use the <link 211linkend="camera-controls">Camera class controls</link> 212<constant>V4L2_CID_PAN_ABSOLUTE</constant>, 213<constant>V4L2_CID_PAN_RELATIVE</constant> and 214<constant>V4L2_CID_PAN_RESET</constant> instead.</entry> 215 </row> 216 <row> 217 <entry><constant>V4L2_CID_VCENTER_DEPRECATED</constant> 218 (formerly <constant>V4L2_CID_VCENTER</constant>)</entry> 219 <entry>integer</entry> 220 <entry>Vertical image centering. Centering is intended to 221<emphasis>physically</emphasis> adjust cameras. For image cropping see 222<xref linkend="crop" />, for clipping <xref linkend="overlay" />. This 223control is deprecated. New drivers and applications should use the 224<link linkend="camera-controls">Camera class controls</link> 225<constant>V4L2_CID_TILT_ABSOLUTE</constant>, 226<constant>V4L2_CID_TILT_RELATIVE</constant> and 227<constant>V4L2_CID_TILT_RESET</constant> instead.</entry> 228 </row> 229 <row id="v4l2-power-line-frequency"> 230 <entry><constant>V4L2_CID_POWER_LINE_FREQUENCY</constant></entry> 231 <entry>enum</entry> 232 <entry>Enables a power line frequency filter to avoid 233flicker. Possible values for <constant>enum v4l2_power_line_frequency</constant> are: 234<constant>V4L2_CID_POWER_LINE_FREQUENCY_DISABLED</constant> (0), 235<constant>V4L2_CID_POWER_LINE_FREQUENCY_50HZ</constant> (1), 236<constant>V4L2_CID_POWER_LINE_FREQUENCY_60HZ</constant> (2) and 237<constant>V4L2_CID_POWER_LINE_FREQUENCY_AUTO</constant> (3).</entry> 238 </row> 239 <row> 240 <entry><constant>V4L2_CID_HUE_AUTO</constant></entry> 241 <entry>boolean</entry> 242 <entry>Enables automatic hue control by the device. The 243effect of setting <constant>V4L2_CID_HUE</constant> while automatic 244hue control is enabled is undefined, drivers should ignore such 245request.</entry> 246 </row> 247 <row> 248 <entry><constant>V4L2_CID_WHITE_BALANCE_TEMPERATURE</constant></entry> 249 <entry>integer</entry> 250 <entry>This control specifies the white balance settings 251as a color temperature in Kelvin. A driver should have a minimum of 2522800 (incandescent) to 6500 (daylight). For more information about 253color temperature see <ulink 254url="http://en.wikipedia.org/wiki/Color_temperature">Wikipedia</ulink>.</entry> 255 </row> 256 <row> 257 <entry><constant>V4L2_CID_SHARPNESS</constant></entry> 258 <entry>integer</entry> 259 <entry>Adjusts the sharpness filters in a camera. The 260minimum value disables the filters, higher values give a sharper 261picture.</entry> 262 </row> 263 <row> 264 <entry><constant>V4L2_CID_BACKLIGHT_COMPENSATION</constant></entry> 265 <entry>integer</entry> 266 <entry>Adjusts the backlight compensation in a camera. The 267minimum value disables backlight compensation.</entry> 268 </row> 269 <row> 270 <entry><constant>V4L2_CID_CHROMA_AGC</constant></entry> 271 <entry>boolean</entry> 272 <entry>Chroma automatic gain control.</entry> 273 </row> 274 <row> 275 <entry><constant>V4L2_CID_CHROMA_GAIN</constant></entry> 276 <entry>integer</entry> 277 <entry>Adjusts the Chroma gain control (for use when chroma AGC 278 is disabled).</entry> 279 </row> 280 <row> 281 <entry><constant>V4L2_CID_COLOR_KILLER</constant></entry> 282 <entry>boolean</entry> 283 <entry>Enable the color killer (&ie; force a black & white image in case of a weak video signal).</entry> 284 </row> 285 <row id="v4l2-colorfx"> 286 <entry><constant>V4L2_CID_COLORFX</constant></entry> 287 <entry>enum</entry> 288 <entry>Selects a color effect. Possible values for 289<constant>enum v4l2_colorfx</constant> are: 290<constant>V4L2_COLORFX_NONE</constant> (0), 291<constant>V4L2_COLORFX_BW</constant> (1), 292<constant>V4L2_COLORFX_SEPIA</constant> (2), 293<constant>V4L2_COLORFX_NEGATIVE</constant> (3), 294<constant>V4L2_COLORFX_EMBOSS</constant> (4), 295<constant>V4L2_COLORFX_SKETCH</constant> (5), 296<constant>V4L2_COLORFX_SKY_BLUE</constant> (6), 297<constant>V4L2_COLORFX_GRASS_GREEN</constant> (7), 298<constant>V4L2_COLORFX_SKIN_WHITEN</constant> (8) and 299<constant>V4L2_COLORFX_VIVID</constant> (9).</entry> 300 </row> 301 <row> 302 <entry><constant>V4L2_CID_ROTATE</constant></entry> 303 <entry>integer</entry> 304 <entry>Rotates the image by specified angle. Common angles are 90, 305 270 and 180. Rotating the image to 90 and 270 will reverse the height 306 and width of the display window. It is necessary to set the new height and 307 width of the picture using the &VIDIOC-S-FMT; ioctl according to 308 the rotation angle selected.</entry> 309 </row> 310 <row> 311 <entry><constant>V4L2_CID_BG_COLOR</constant></entry> 312 <entry>integer</entry> 313 <entry>Sets the background color on the current output device. 314 Background color needs to be specified in the RGB24 format. The 315 supplied 32 bit value is interpreted as bits 0-7 Red color information, 316 bits 8-15 Green color information, bits 16-23 Blue color 317 information and bits 24-31 must be zero.</entry> 318 </row> 319 <row> 320 <entry><constant>V4L2_CID_ILLUMINATORS_1</constant> 321 <constant>V4L2_CID_ILLUMINATORS_2</constant></entry> 322 <entry>boolean</entry> 323 <entry>Switch on or off the illuminator 1 or 2 of the device 324 (usually a microscope).</entry> 325 </row> 326 <row> 327 <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry> 328 <entry>integer</entry> 329 <entry>This is a read-only control that can be read by the application 330and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS. 331The value is the minimum number of CAPTURE buffers that is necessary for hardware 332to work.</entry> 333 </row> 334 <row> 335 <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_OUTPUT</constant></entry> 336 <entry>integer</entry> 337 <entry>This is a read-only control that can be read by the application 338and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS. 339The value is the minimum number of OUTPUT buffers that is necessary for hardware 340to work.</entry> 341 </row> 342 <row id="v4l2-alpha-component"> 343 <entry><constant>V4L2_CID_ALPHA_COMPONENT</constant></entry> 344 <entry>integer</entry> 345 <entry> Sets the alpha color component on the capture device or on 346 the capture buffer queue of a mem-to-mem device. When a mem-to-mem 347 device produces frame format that includes an alpha component 348 (e.g. <link linkend="rgb-formats">packed RGB image formats</link>) 349 and the alpha value is not defined by the mem-to-mem input data 350 this control lets you select the alpha component value of all 351 pixels. It is applicable to any pixel format that contains an alpha 352 component. 353 </entry> 354 </row> 355 <row> 356 <entry><constant>V4L2_CID_LASTP1</constant></entry> 357 <entry></entry> 358 <entry>End of the predefined control IDs (currently 359 <constant>V4L2_CID_ALPHA_COMPONENT</constant> + 1).</entry> 360 </row> 361 <row> 362 <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry> 363 <entry></entry> 364 <entry>ID of the first custom (driver specific) control. 365Applications depending on particular custom controls should check the 366driver name and version, see <xref linkend="querycap" />.</entry> 367 </row> 368 </tbody> 369 </tgroup> 370 </table> 371 372 <para>Applications can enumerate the available controls with the 373&VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls, get and set a 374control value with the &VIDIOC-G-CTRL; and &VIDIOC-S-CTRL; ioctls. 375Drivers must implement <constant>VIDIOC_QUERYCTRL</constant>, 376<constant>VIDIOC_G_CTRL</constant> and 377<constant>VIDIOC_S_CTRL</constant> when the device has one or more 378controls, <constant>VIDIOC_QUERYMENU</constant> when it has one or 379more menu type controls.</para> 380 381 <example> 382 <title>Enumerating all controls</title> 383 384 <programlisting> 385&v4l2-queryctrl; queryctrl; 386&v4l2-querymenu; querymenu; 387 388static void 389enumerate_menu (void) 390{ 391 printf (" Menu items:\n"); 392 393 memset (&querymenu, 0, sizeof (querymenu)); 394 querymenu.id = queryctrl.id; 395 396 for (querymenu.index = queryctrl.minimum; 397 querymenu.index <= queryctrl.maximum; 398 querymenu.index++) { 399 if (0 == ioctl (fd, &VIDIOC-QUERYMENU;, &querymenu)) { 400 printf (" %s\n", querymenu.name); 401 } 402 } 403} 404 405memset (&queryctrl, 0, sizeof (queryctrl)); 406 407for (queryctrl.id = V4L2_CID_BASE; 408 queryctrl.id < V4L2_CID_LASTP1; 409 queryctrl.id++) { 410 if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &queryctrl)) { 411 if (queryctrl.flags & V4L2_CTRL_FLAG_DISABLED) 412 continue; 413 414 printf ("Control %s\n", queryctrl.name); 415 416 if (queryctrl.type == V4L2_CTRL_TYPE_MENU) 417 enumerate_menu (); 418 } else { 419 if (errno == EINVAL) 420 continue; 421 422 perror ("VIDIOC_QUERYCTRL"); 423 exit (EXIT_FAILURE); 424 } 425} 426 427for (queryctrl.id = V4L2_CID_PRIVATE_BASE;; 428 queryctrl.id++) { 429 if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &queryctrl)) { 430 if (queryctrl.flags & V4L2_CTRL_FLAG_DISABLED) 431 continue; 432 433 printf ("Control %s\n", queryctrl.name); 434 435 if (queryctrl.type == V4L2_CTRL_TYPE_MENU) 436 enumerate_menu (); 437 } else { 438 if (errno == EINVAL) 439 break; 440 441 perror ("VIDIOC_QUERYCTRL"); 442 exit (EXIT_FAILURE); 443 } 444} 445</programlisting> 446 </example> 447 448 <example> 449 <title>Changing controls</title> 450 451 <programlisting> 452&v4l2-queryctrl; queryctrl; 453&v4l2-control; control; 454 455memset (&queryctrl, 0, sizeof (queryctrl)); 456queryctrl.id = V4L2_CID_BRIGHTNESS; 457 458if (-1 == ioctl (fd, &VIDIOC-QUERYCTRL;, &queryctrl)) { 459 if (errno != EINVAL) { 460 perror ("VIDIOC_QUERYCTRL"); 461 exit (EXIT_FAILURE); 462 } else { 463 printf ("V4L2_CID_BRIGHTNESS is not supported\n"); 464 } 465} else if (queryctrl.flags & V4L2_CTRL_FLAG_DISABLED) { 466 printf ("V4L2_CID_BRIGHTNESS is not supported\n"); 467} else { 468 memset (&control, 0, sizeof (control)); 469 control.id = V4L2_CID_BRIGHTNESS; 470 control.value = queryctrl.default_value; 471 472 if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &control)) { 473 perror ("VIDIOC_S_CTRL"); 474 exit (EXIT_FAILURE); 475 } 476} 477 478memset (&control, 0, sizeof (control)); 479control.id = V4L2_CID_CONTRAST; 480 481if (0 == ioctl (fd, &VIDIOC-G-CTRL;, &control)) { 482 control.value += 1; 483 484 /* The driver may clamp the value or return ERANGE, ignored here */ 485 486 if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &control) 487 && errno != ERANGE) { 488 perror ("VIDIOC_S_CTRL"); 489 exit (EXIT_FAILURE); 490 } 491/* Ignore if V4L2_CID_CONTRAST is unsupported */ 492} else if (errno != EINVAL) { 493 perror ("VIDIOC_G_CTRL"); 494 exit (EXIT_FAILURE); 495} 496 497control.id = V4L2_CID_AUDIO_MUTE; 498control.value = TRUE; /* silence */ 499 500/* Errors ignored */ 501ioctl (fd, VIDIOC_S_CTRL, &control); 502</programlisting> 503 </example> 504 </section> 505 506 <section id="extended-controls"> 507 <title>Extended Controls</title> 508 509 <section> 510 <title>Introduction</title> 511 512 <para>The control mechanism as originally designed was meant 513to be used for user settings (brightness, saturation, etc). However, 514it turned out to be a very useful model for implementing more 515complicated driver APIs where each driver implements only a subset of 516a larger API.</para> 517 518 <para>The MPEG encoding API was the driving force behind 519designing and implementing this extended control mechanism: the MPEG 520standard is quite large and the currently supported hardware MPEG 521encoders each only implement a subset of this standard. Further more, 522many parameters relating to how the video is encoded into an MPEG 523stream are specific to the MPEG encoding chip since the MPEG standard 524only defines the format of the resulting MPEG stream, not how the 525video is actually encoded into that format.</para> 526 527 <para>Unfortunately, the original control API lacked some 528features needed for these new uses and so it was extended into the 529(not terribly originally named) extended control API.</para> 530 531 <para>Even though the MPEG encoding API was the first effort 532to use the Extended Control API, nowadays there are also other classes 533of Extended Controls, such as Camera Controls and FM Transmitter Controls. 534The Extended Controls API as well as all Extended Controls classes are 535described in the following text.</para> 536 </section> 537 538 <section> 539 <title>The Extended Control API</title> 540 541 <para>Three new ioctls are available: &VIDIOC-G-EXT-CTRLS;, 542&VIDIOC-S-EXT-CTRLS; and &VIDIOC-TRY-EXT-CTRLS;. These ioctls act on 543arrays of controls (as opposed to the &VIDIOC-G-CTRL; and 544&VIDIOC-S-CTRL; ioctls that act on a single control). This is needed 545since it is often required to atomically change several controls at 546once.</para> 547 548 <para>Each of the new ioctls expects a pointer to a 549&v4l2-ext-controls;. This structure contains a pointer to the control 550array, a count of the number of controls in that array and a control 551class. Control classes are used to group similar controls into a 552single class. For example, control class 553<constant>V4L2_CTRL_CLASS_USER</constant> contains all user controls 554(&ie; all controls that can also be set using the old 555<constant>VIDIOC_S_CTRL</constant> ioctl). Control class 556<constant>V4L2_CTRL_CLASS_MPEG</constant> contains all controls 557relating to MPEG encoding, etc.</para> 558 559 <para>All controls in the control array must belong to the 560specified control class. An error is returned if this is not the 561case.</para> 562 563 <para>It is also possible to use an empty control array (count 564== 0) to check whether the specified control class is 565supported.</para> 566 567 <para>The control array is a &v4l2-ext-control; array. The 568<structname>v4l2_ext_control</structname> structure is very similar to 569&v4l2-control;, except for the fact that it also allows for 64-bit 570values and pointers to be passed.</para> 571 572 <para>It is important to realize that due to the flexibility of 573controls it is necessary to check whether the control you want to set 574actually is supported in the driver and what the valid range of values 575is. So use the &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls to 576check this. Also note that it is possible that some of the menu 577indices in a control of type <constant>V4L2_CTRL_TYPE_MENU</constant> 578may not be supported (<constant>VIDIOC_QUERYMENU</constant> will 579return an error). A good example is the list of supported MPEG audio 580bitrates. Some drivers only support one or two bitrates, others 581support a wider range.</para> 582 583 <para> 584 All controls use machine endianness. 585 </para> 586 </section> 587 588 <section> 589 <title>Enumerating Extended Controls</title> 590 591 <para>The recommended way to enumerate over the extended 592controls is by using &VIDIOC-QUERYCTRL; in combination with the 593<constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag:</para> 594 595 <informalexample> 596 <programlisting> 597&v4l2-queryctrl; qctrl; 598 599qctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL; 600while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &qctrl)) { 601 /* ... */ 602 qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL; 603} 604</programlisting> 605 </informalexample> 606 607 <para>The initial control ID is set to 0 ORed with the 608<constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag. The 609<constant>VIDIOC_QUERYCTRL</constant> ioctl will return the first 610control with a higher ID than the specified one. When no such controls 611are found an error is returned.</para> 612 613 <para>If you want to get all controls within a specific control 614class, then you can set the initial 615<structfield>qctrl.id</structfield> value to the control class and add 616an extra check to break out of the loop when a control of another 617control class is found:</para> 618 619 <informalexample> 620 <programlisting> 621qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL; 622while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &qctrl)) { 623 if (V4L2_CTRL_ID2CLASS (qctrl.id) != V4L2_CTRL_CLASS_MPEG) 624 break; 625 /* ... */ 626 qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL; 627 } 628</programlisting> 629 </informalexample> 630 631 <para>The 32-bit <structfield>qctrl.id</structfield> value is 632subdivided into three bit ranges: the top 4 bits are reserved for 633flags (⪚ <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>) and are not 634actually part of the ID. The remaining 28 bits form the control ID, of 635which the most significant 12 bits define the control class and the 636least significant 16 bits identify the control within the control 637class. It is guaranteed that these last 16 bits are always non-zero 638for controls. The range of 0x1000 and up are reserved for 639driver-specific controls. The macro 640<constant>V4L2_CTRL_ID2CLASS(id)</constant> returns the control class 641ID based on a control ID.</para> 642 643 <para>If the driver does not support extended controls, then 644<constant>VIDIOC_QUERYCTRL</constant> will fail when used in 645combination with <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>. In 646that case the old method of enumerating control should be used (see 6471.8). But if it is supported, then it is guaranteed to enumerate over 648all controls, including driver-private controls.</para> 649 </section> 650 651 <section> 652 <title>Creating Control Panels</title> 653 654 <para>It is possible to create control panels for a graphical 655user interface where the user can select the various controls. 656Basically you will have to iterate over all controls using the method 657described above. Each control class starts with a control of type 658<constant>V4L2_CTRL_TYPE_CTRL_CLASS</constant>. 659<constant>VIDIOC_QUERYCTRL</constant> will return the name of this 660control class which can be used as the title of a tab page within a 661control panel.</para> 662 663 <para>The flags field of &v4l2-queryctrl; also contains hints on 664the behavior of the control. See the &VIDIOC-QUERYCTRL; documentation 665for more details.</para> 666 </section> 667 668 <section id="mpeg-controls"> 669 <title>MPEG Control Reference</title> 670 671 <para>Below all controls within the MPEG control class are 672described. First the generic controls, then controls specific for 673certain hardware.</para> 674 675 <section> 676 <title>Generic MPEG Controls</title> 677 678 <table pgwide="1" frame="none" id="mpeg-control-id"> 679 <title>MPEG Control IDs</title> 680 <tgroup cols="4"> 681 <colspec colname="c1" colwidth="1*" /> 682 <colspec colname="c2" colwidth="6*" /> 683 <colspec colname="c3" colwidth="2*" /> 684 <colspec colname="c4" colwidth="6*" /> 685 <spanspec namest="c1" nameend="c2" spanname="id" /> 686 <spanspec namest="c2" nameend="c4" spanname="descr" /> 687 <thead> 688 <row> 689 <entry spanname="id" align="left">ID</entry> 690 <entry align="left">Type</entry> 691 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> 692 </row> 693 </thead> 694 <tbody valign="top"> 695 <row><entry></entry></row> 696 <row> 697 <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant> </entry> 698 <entry>class</entry> 699 </row><row><entry spanname="descr">The MPEG class 700descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a 701description of this control class. This description can be used as the 702caption of a Tab page in a GUI, for example.</entry> 703 </row> 704 <row><entry></entry></row> 705 <row id="v4l2-mpeg-stream-type"> 706 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_TYPE</constant> </entry> 707 <entry>enum v4l2_mpeg_stream_type</entry> 708 </row><row><entry spanname="descr">The MPEG-1, -2 or -4 709output stream type. One cannot assume anything here. Each hardware 710MPEG encoder tends to support different subsets of the available MPEG 711stream types. This control is specific to multiplexed MPEG streams. 712The currently defined stream types are:</entry> 713 </row> 714 <row> 715 <entrytbl spanname="descr" cols="2"> 716 <tbody valign="top"> 717 <row> 718 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_PS</constant> </entry> 719 <entry>MPEG-2 program stream</entry> 720 </row> 721 <row> 722 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_TS</constant> </entry> 723 <entry>MPEG-2 transport stream</entry> 724 </row> 725 <row> 726 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_SS</constant> </entry> 727 <entry>MPEG-1 system stream</entry> 728 </row> 729 <row> 730 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_DVD</constant> </entry> 731 <entry>MPEG-2 DVD-compatible stream</entry> 732 </row> 733 <row> 734 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_VCD</constant> </entry> 735 <entry>MPEG-1 VCD-compatible stream</entry> 736 </row> 737 <row> 738 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD</constant> </entry> 739 <entry>MPEG-2 SVCD-compatible stream</entry> 740 </row> 741 </tbody> 742 </entrytbl> 743 </row> 744 <row><entry></entry></row> 745 <row> 746 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PMT</constant> </entry> 747 <entry>integer</entry> 748 </row><row><entry spanname="descr">Program Map Table 749Packet ID for the MPEG transport stream (default 16)</entry> 750 </row> 751 <row><entry></entry></row> 752 <row> 753 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_AUDIO</constant> </entry> 754 <entry>integer</entry> 755 </row><row><entry spanname="descr">Audio Packet ID for 756the MPEG transport stream (default 256)</entry> 757 </row> 758 <row><entry></entry></row> 759 <row> 760 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_VIDEO</constant> </entry> 761 <entry>integer</entry> 762 </row><row><entry spanname="descr">Video Packet ID for 763the MPEG transport stream (default 260)</entry> 764 </row> 765 <row><entry></entry></row> 766 <row> 767 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PCR</constant> </entry> 768 <entry>integer</entry> 769 </row><row><entry spanname="descr">Packet ID for the 770MPEG transport stream carrying PCR fields (default 259)</entry> 771 </row> 772 <row><entry></entry></row> 773 <row> 774 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_AUDIO</constant> </entry> 775 <entry>integer</entry> 776 </row><row><entry spanname="descr">Audio ID for MPEG 777PES</entry> 778 </row> 779 <row><entry></entry></row> 780 <row> 781 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_VIDEO</constant> </entry> 782 <entry>integer</entry> 783 </row><row><entry spanname="descr">Video ID for MPEG 784PES</entry> 785 </row> 786 <row><entry></entry></row> 787 <row id="v4l2-mpeg-stream-vbi-fmt"> 788 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_VBI_FMT</constant> </entry> 789 <entry>enum v4l2_mpeg_stream_vbi_fmt</entry> 790 </row><row><entry spanname="descr">Some cards can embed 791VBI data (⪚ Closed Caption, Teletext) into the MPEG stream. This 792control selects whether VBI data should be embedded, and if so, what 793embedding method should be used. The list of possible VBI formats 794depends on the driver. The currently defined VBI format types 795are:</entry> 796 </row> 797 <row> 798 <entrytbl spanname="descr" cols="2"> 799 <tbody valign="top"> 800 <row> 801 <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_NONE</constant> </entry> 802 <entry>No VBI in the MPEG stream</entry> 803 </row> 804 <row> 805 <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_IVTV</constant> </entry> 806 <entry>VBI in private packets, IVTV format (documented 807in the kernel sources in the file <filename>Documentation/video4linux/cx2341x/README.vbi</filename>)</entry> 808 </row> 809 </tbody> 810 </entrytbl> 811 </row> 812 <row><entry></entry></row> 813 <row id="v4l2-mpeg-audio-sampling-freq"> 814 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ</constant> </entry> 815 <entry>enum v4l2_mpeg_audio_sampling_freq</entry> 816 </row><row><entry spanname="descr">MPEG Audio sampling 817frequency. Possible values are:</entry> 818 </row> 819 <row> 820 <entrytbl spanname="descr" cols="2"> 821 <tbody valign="top"> 822 <row> 823 <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100</constant> </entry> 824 <entry>44.1 kHz</entry> 825 </row> 826 <row> 827 <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000</constant> </entry> 828 <entry>48 kHz</entry> 829 </row> 830 <row> 831 <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000</constant> </entry> 832 <entry>32 kHz</entry> 833 </row> 834 </tbody> 835 </entrytbl> 836 </row> 837 <row><entry></entry></row> 838 <row id="v4l2-mpeg-audio-encoding"> 839 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_ENCODING</constant> </entry> 840 <entry>enum v4l2_mpeg_audio_encoding</entry> 841 </row><row><entry spanname="descr">MPEG Audio encoding. 842This control is specific to multiplexed MPEG streams. 843Possible values are:</entry> 844 </row> 845 <row> 846 <entrytbl spanname="descr" cols="2"> 847 <tbody valign="top"> 848 <row> 849 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_1</constant> </entry> 850 <entry>MPEG-1/2 Layer I encoding</entry> 851 </row> 852 <row> 853 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_2</constant> </entry> 854 <entry>MPEG-1/2 Layer II encoding</entry> 855 </row> 856 <row> 857 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_3</constant> </entry> 858 <entry>MPEG-1/2 Layer III encoding</entry> 859 </row> 860 <row> 861 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AAC</constant> </entry> 862 <entry>MPEG-2/4 AAC (Advanced Audio Coding)</entry> 863 </row> 864 <row> 865 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AC3</constant> </entry> 866 <entry>AC-3 aka ATSC A/52 encoding</entry> 867 </row> 868 </tbody> 869 </entrytbl> 870 </row> 871 <row><entry></entry></row> 872 <row id="v4l2-mpeg-audio-l1-bitrate"> 873 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L1_BITRATE</constant> </entry> 874 <entry>enum v4l2_mpeg_audio_l1_bitrate</entry> 875 </row><row><entry spanname="descr">MPEG-1/2 Layer I bitrate. 876Possible values are:</entry> 877 </row> 878 <row> 879 <entrytbl spanname="descr" cols="2"> 880 <tbody valign="top"> 881 <row> 882 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_32K</constant> </entry> 883 <entry>32 kbit/s</entry></row> 884 <row> 885 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_64K</constant> </entry> 886 <entry>64 kbit/s</entry> 887 </row> 888 <row> 889 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_96K</constant> </entry> 890 <entry>96 kbit/s</entry> 891 </row> 892 <row> 893 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_128K</constant> </entry> 894 <entry>128 kbit/s</entry> 895 </row> 896 <row> 897 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_160K</constant> </entry> 898 <entry>160 kbit/s</entry> 899 </row> 900 <row> 901 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_192K</constant> </entry> 902 <entry>192 kbit/s</entry> 903 </row> 904 <row> 905 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_224K</constant> </entry> 906 <entry>224 kbit/s</entry> 907 </row> 908 <row> 909 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_256K</constant> </entry> 910 <entry>256 kbit/s</entry> 911 </row> 912 <row> 913 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_288K</constant> </entry> 914 <entry>288 kbit/s</entry> 915 </row> 916 <row> 917 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_320K</constant> </entry> 918 <entry>320 kbit/s</entry> 919 </row> 920 <row> 921 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_352K</constant> </entry> 922 <entry>352 kbit/s</entry> 923 </row> 924 <row> 925 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_384K</constant> </entry> 926 <entry>384 kbit/s</entry> 927 </row> 928 <row> 929 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_416K</constant> </entry> 930 <entry>416 kbit/s</entry> 931 </row> 932 <row> 933 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_448K</constant> </entry> 934 <entry>448 kbit/s</entry> 935 </row> 936 </tbody> 937 </entrytbl> 938 </row> 939 <row><entry></entry></row> 940 <row id="v4l2-mpeg-audio-l2-bitrate"> 941 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L2_BITRATE</constant> </entry> 942 <entry>enum v4l2_mpeg_audio_l2_bitrate</entry> 943 </row><row><entry spanname="descr">MPEG-1/2 Layer II bitrate. 944Possible values are:</entry> 945 </row> 946 <row> 947 <entrytbl spanname="descr" cols="2"> 948 <tbody valign="top"> 949 <row> 950 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_32K</constant> </entry> 951 <entry>32 kbit/s</entry> 952 </row> 953 <row> 954 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_48K</constant> </entry> 955 <entry>48 kbit/s</entry> 956 </row> 957 <row> 958 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_56K</constant> </entry> 959 <entry>56 kbit/s</entry> 960 </row> 961 <row> 962 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_64K</constant> </entry> 963 <entry>64 kbit/s</entry> 964 </row> 965 <row> 966 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_80K</constant> </entry> 967 <entry>80 kbit/s</entry> 968 </row> 969 <row> 970 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_96K</constant> </entry> 971 <entry>96 kbit/s</entry> 972 </row> 973 <row> 974 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_112K</constant> </entry> 975 <entry>112 kbit/s</entry> 976 </row> 977 <row> 978 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_128K</constant> </entry> 979 <entry>128 kbit/s</entry> 980 </row> 981 <row> 982 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_160K</constant> </entry> 983 <entry>160 kbit/s</entry> 984 </row> 985 <row> 986 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_192K</constant> </entry> 987 <entry>192 kbit/s</entry> 988 </row> 989 <row> 990 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_224K</constant> </entry> 991 <entry>224 kbit/s</entry> 992 </row> 993 <row> 994 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_256K</constant> </entry> 995 <entry>256 kbit/s</entry> 996 </row> 997 <row> 998 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_320K</constant> </entry> 999 <entry>320 kbit/s</entry> 1000 </row> 1001 <row> 1002 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_384K</constant> </entry> 1003 <entry>384 kbit/s</entry> 1004 </row> 1005 </tbody> 1006 </entrytbl> 1007 </row> 1008 <row><entry></entry></row> 1009 <row id="v4l2-mpeg-audio-l3-bitrate"> 1010 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L3_BITRATE</constant> </entry> 1011 <entry>enum v4l2_mpeg_audio_l3_bitrate</entry> 1012 </row><row><entry spanname="descr">MPEG-1/2 Layer III bitrate. 1013Possible values are:</entry> 1014 </row> 1015 <row> 1016 <entrytbl spanname="descr" cols="2"> 1017 <tbody valign="top"> 1018 <row> 1019 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_32K</constant> </entry> 1020 <entry>32 kbit/s</entry> 1021 </row> 1022 <row> 1023 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_40K</constant> </entry> 1024 <entry>40 kbit/s</entry> 1025 </row> 1026 <row> 1027 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_48K</constant> </entry> 1028 <entry>48 kbit/s</entry> 1029 </row> 1030 <row> 1031 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_56K</constant> </entry> 1032 <entry>56 kbit/s</entry> 1033 </row> 1034 <row> 1035 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_64K</constant> </entry> 1036 <entry>64 kbit/s</entry> 1037 </row> 1038 <row> 1039 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_80K</constant> </entry> 1040 <entry>80 kbit/s</entry> 1041 </row> 1042 <row> 1043 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_96K</constant> </entry> 1044 <entry>96 kbit/s</entry> 1045 </row> 1046 <row> 1047 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_112K</constant> </entry> 1048 <entry>112 kbit/s</entry> 1049 </row> 1050 <row> 1051 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_128K</constant> </entry> 1052 <entry>128 kbit/s</entry> 1053 </row> 1054 <row> 1055 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_160K</constant> </entry> 1056 <entry>160 kbit/s</entry> 1057 </row> 1058 <row> 1059 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_192K</constant> </entry> 1060 <entry>192 kbit/s</entry> 1061 </row> 1062 <row> 1063 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_224K</constant> </entry> 1064 <entry>224 kbit/s</entry> 1065 </row> 1066 <row> 1067 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_256K</constant> </entry> 1068 <entry>256 kbit/s</entry> 1069 </row> 1070 <row> 1071 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_320K</constant> </entry> 1072 <entry>320 kbit/s</entry> 1073 </row> 1074 </tbody> 1075 </entrytbl> 1076 </row> 1077 <row><entry></entry></row> 1078 <row> 1079 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AAC_BITRATE</constant> </entry> 1080 <entry>integer</entry> 1081 </row><row><entry spanname="descr">AAC bitrate in bits per second.</entry> 1082 </row> 1083 <row><entry></entry></row> 1084 <row id="v4l2-mpeg-audio-ac3-bitrate"> 1085 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AC3_BITRATE</constant> </entry> 1086 <entry>enum v4l2_mpeg_audio_ac3_bitrate</entry> 1087 </row><row><entry spanname="descr">AC-3 bitrate. 1088Possible values are:</entry> 1089 </row> 1090 <row> 1091 <entrytbl spanname="descr" cols="2"> 1092 <tbody valign="top"> 1093 <row> 1094 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_32K</constant> </entry> 1095 <entry>32 kbit/s</entry> 1096 </row> 1097 <row> 1098 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_40K</constant> </entry> 1099 <entry>40 kbit/s</entry> 1100 </row> 1101 <row> 1102 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_48K</constant> </entry> 1103 <entry>48 kbit/s</entry> 1104 </row> 1105 <row> 1106 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_56K</constant> </entry> 1107 <entry>56 kbit/s</entry> 1108 </row> 1109 <row> 1110 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_64K</constant> </entry> 1111 <entry>64 kbit/s</entry> 1112 </row> 1113 <row> 1114 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_80K</constant> </entry> 1115 <entry>80 kbit/s</entry> 1116 </row> 1117 <row> 1118 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_96K</constant> </entry> 1119 <entry>96 kbit/s</entry> 1120 </row> 1121 <row> 1122 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_112K</constant> </entry> 1123 <entry>112 kbit/s</entry> 1124 </row> 1125 <row> 1126 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_128K</constant> </entry> 1127 <entry>128 kbit/s</entry> 1128 </row> 1129 <row> 1130 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_160K</constant> </entry> 1131 <entry>160 kbit/s</entry> 1132 </row> 1133 <row> 1134 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_192K</constant> </entry> 1135 <entry>192 kbit/s</entry> 1136 </row> 1137 <row> 1138 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_224K</constant> </entry> 1139 <entry>224 kbit/s</entry> 1140 </row> 1141 <row> 1142 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_256K</constant> </entry> 1143 <entry>256 kbit/s</entry> 1144 </row> 1145 <row> 1146 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_320K</constant> </entry> 1147 <entry>320 kbit/s</entry> 1148 </row> 1149 <row> 1150 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_384K</constant> </entry> 1151 <entry>384 kbit/s</entry> 1152 </row> 1153 <row> 1154 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_448K</constant> </entry> 1155 <entry>448 kbit/s</entry> 1156 </row> 1157 <row> 1158 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_512K</constant> </entry> 1159 <entry>512 kbit/s</entry> 1160 </row> 1161 <row> 1162 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_576K</constant> </entry> 1163 <entry>576 kbit/s</entry> 1164 </row> 1165 <row> 1166 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_640K</constant> </entry> 1167 <entry>640 kbit/s</entry> 1168 </row> 1169 </tbody> 1170 </entrytbl> 1171 </row> 1172 <row><entry></entry></row> 1173 <row id="v4l2-mpeg-audio-mode"> 1174 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE</constant> </entry> 1175 <entry>enum v4l2_mpeg_audio_mode</entry> 1176 </row><row><entry spanname="descr">MPEG Audio mode. 1177Possible values are:</entry> 1178 </row> 1179 <row> 1180 <entrytbl spanname="descr" cols="2"> 1181 <tbody valign="top"> 1182 <row> 1183 <entry><constant>V4L2_MPEG_AUDIO_MODE_STEREO</constant> </entry> 1184 <entry>Stereo</entry> 1185 </row> 1186 <row> 1187 <entry><constant>V4L2_MPEG_AUDIO_MODE_JOINT_STEREO</constant> </entry> 1188 <entry>Joint Stereo</entry> 1189 </row> 1190 <row> 1191 <entry><constant>V4L2_MPEG_AUDIO_MODE_DUAL</constant> </entry> 1192 <entry>Bilingual</entry> 1193 </row> 1194 <row> 1195 <entry><constant>V4L2_MPEG_AUDIO_MODE_MONO</constant> </entry> 1196 <entry>Mono</entry> 1197 </row> 1198 </tbody> 1199 </entrytbl> 1200 </row> 1201 <row><entry></entry></row> 1202 <row id="v4l2-mpeg-audio-mode-extension"> 1203 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE_EXTENSION</constant> </entry> 1204 <entry>enum v4l2_mpeg_audio_mode_extension</entry> 1205 </row><row><entry spanname="descr">Joint Stereo 1206audio mode extension. In Layer I and II they indicate which subbands 1207are in intensity stereo. All other subbands are coded in stereo. Layer 1208III is not (yet) supported. Possible values 1209are:</entry> 1210 </row> 1211 <row> 1212 <entrytbl spanname="descr" cols="2"> 1213 <tbody valign="top"> 1214 <row> 1215 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4</constant> </entry> 1216 <entry>Subbands 4-31 in intensity stereo</entry> 1217 </row> 1218 <row> 1219 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8</constant> </entry> 1220 <entry>Subbands 8-31 in intensity stereo</entry> 1221 </row> 1222 <row> 1223 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12</constant> </entry> 1224 <entry>Subbands 12-31 in intensity stereo</entry> 1225 </row> 1226 <row> 1227 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16</constant> </entry> 1228 <entry>Subbands 16-31 in intensity stereo</entry> 1229 </row> 1230 </tbody> 1231 </entrytbl> 1232 </row> 1233 <row><entry></entry></row> 1234 <row id="v4l2-mpeg-audio-emphasis"> 1235 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_EMPHASIS</constant> </entry> 1236 <entry>enum v4l2_mpeg_audio_emphasis</entry> 1237 </row><row><entry spanname="descr">Audio Emphasis. 1238Possible values are:</entry> 1239 </row> 1240 <row> 1241 <entrytbl spanname="descr" cols="2"> 1242 <tbody valign="top"> 1243 <row> 1244 <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_NONE</constant> </entry> 1245 <entry>None</entry> 1246 </row> 1247 <row> 1248 <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS</constant> </entry> 1249 <entry>50/15 microsecond emphasis</entry> 1250 </row> 1251 <row> 1252 <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17</constant> </entry> 1253 <entry>CCITT J.17</entry> 1254 </row> 1255 </tbody> 1256 </entrytbl> 1257 </row> 1258 <row><entry></entry></row> 1259 <row id="v4l2-mpeg-audio-crc"> 1260 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_CRC</constant> </entry> 1261 <entry>enum v4l2_mpeg_audio_crc</entry> 1262 </row><row><entry spanname="descr">CRC method. Possible 1263values are:</entry> 1264 </row> 1265 <row> 1266 <entrytbl spanname="descr" cols="2"> 1267 <tbody valign="top"> 1268 <row> 1269 <entry><constant>V4L2_MPEG_AUDIO_CRC_NONE</constant> </entry> 1270 <entry>None</entry> 1271 </row> 1272 <row> 1273 <entry><constant>V4L2_MPEG_AUDIO_CRC_CRC16</constant> </entry> 1274 <entry>16 bit parity check</entry> 1275 </row> 1276 </tbody> 1277 </entrytbl> 1278 </row> 1279 <row><entry></entry></row> 1280 <row> 1281 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MUTE</constant> </entry> 1282 <entry>boolean</entry> 1283 </row><row><entry spanname="descr">Mutes the audio when 1284capturing. This is not done by muting audio hardware, which can still 1285produce a slight hiss, but in the encoder itself, guaranteeing a fixed 1286and reproducible audio bitstream. 0 = unmuted, 1 = muted.</entry> 1287 </row> 1288 <row><entry></entry></row> 1289 <row id="v4l2-mpeg-video-encoding"> 1290 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ENCODING</constant> </entry> 1291 <entry>enum v4l2_mpeg_video_encoding</entry> 1292 </row><row><entry spanname="descr">MPEG Video encoding 1293method. This control is specific to multiplexed MPEG streams. 1294Possible values are:</entry> 1295 </row> 1296 <row> 1297 <entrytbl spanname="descr" cols="2"> 1298 <tbody valign="top"> 1299 <row> 1300 <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_1</constant> </entry> 1301 <entry>MPEG-1 Video encoding</entry> 1302 </row> 1303 <row> 1304 <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_2</constant> </entry> 1305 <entry>MPEG-2 Video encoding</entry> 1306 </row> 1307 <row> 1308 <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC</constant> </entry> 1309 <entry>MPEG-4 AVC (H.264) Video encoding</entry> 1310 </row> 1311 </tbody> 1312 </entrytbl> 1313 </row> 1314 <row><entry></entry></row> 1315 <row id="v4l2-mpeg-video-aspect"> 1316 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ASPECT</constant> </entry> 1317 <entry>enum v4l2_mpeg_video_aspect</entry> 1318 </row><row><entry spanname="descr">Video aspect. 1319Possible values are:</entry> 1320 </row> 1321 <row> 1322 <entrytbl spanname="descr" cols="2"> 1323 <tbody valign="top"> 1324 <row> 1325 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_1x1</constant> </entry> 1326 </row> 1327 <row> 1328 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_4x3</constant> </entry> 1329 </row> 1330 <row> 1331 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_16x9</constant> </entry> 1332 </row> 1333 <row> 1334 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_221x100</constant> </entry> 1335 </row> 1336 </tbody> 1337 </entrytbl> 1338 </row> 1339 <row><entry></entry></row> 1340 <row> 1341 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_B_FRAMES</constant> </entry> 1342 <entry>integer</entry> 1343 </row><row><entry spanname="descr">Number of B-Frames 1344(default 2)</entry> 1345 </row> 1346 <row><entry></entry></row> 1347 <row> 1348 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_SIZE</constant> </entry> 1349 <entry>integer</entry> 1350 </row><row><entry spanname="descr">GOP size (default 135112)</entry> 1352 </row> 1353 <row><entry></entry></row> 1354 <row> 1355 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_CLOSURE</constant> </entry> 1356 <entry>boolean</entry> 1357 </row><row><entry spanname="descr">GOP closure (default 13581)</entry> 1359 </row> 1360 <row><entry></entry></row> 1361 <row> 1362 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_PULLDOWN</constant> </entry> 1363 <entry>boolean</entry> 1364 </row><row><entry spanname="descr">Enable 3:2 pulldown 1365(default 0)</entry> 1366 </row> 1367 <row><entry></entry></row> 1368 <row id="v4l2-mpeg-video-bitrate-mode"> 1369 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_MODE</constant> </entry> 1370 <entry>enum v4l2_mpeg_video_bitrate_mode</entry> 1371 </row><row><entry spanname="descr">Video bitrate mode. 1372Possible values are:</entry> 1373 </row> 1374 <row> 1375 <entrytbl spanname="descr" cols="2"> 1376 <tbody valign="top"> 1377 <row> 1378 <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_VBR</constant> </entry> 1379 <entry>Variable bitrate</entry> 1380 </row> 1381 <row> 1382 <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_CBR</constant> </entry> 1383 <entry>Constant bitrate</entry> 1384 </row> 1385 </tbody> 1386 </entrytbl> 1387 </row> 1388 <row><entry></entry></row> 1389 <row> 1390 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE</constant> </entry> 1391 <entry>integer</entry> 1392 </row><row><entry spanname="descr">Video bitrate in bits 1393per second.</entry> 1394 </row> 1395 <row><entry></entry></row> 1396 <row> 1397 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_PEAK</constant> </entry> 1398 <entry>integer</entry> 1399 </row><row><entry spanname="descr">Peak video bitrate in 1400bits per second. Must be larger or equal to the average video bitrate. 1401It is ignored if the video bitrate mode is set to constant 1402bitrate.</entry> 1403 </row> 1404 <row><entry></entry></row> 1405 <row> 1406 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION</constant> </entry> 1407 <entry>integer</entry> 1408 </row><row><entry spanname="descr">For every captured 1409frame, skip this many subsequent frames (default 0).</entry> 1410 </row> 1411 <row><entry></entry></row> 1412 <row> 1413 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE</constant> </entry> 1414 <entry>boolean</entry> 1415 </row> 1416 <row><entry spanname="descr">"Mutes" the video to a 1417fixed color when capturing. This is useful for testing, to produce a 1418fixed video bitstream. 0 = unmuted, 1 = muted.</entry> 1419 </row> 1420 <row><entry></entry></row> 1421 <row> 1422 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE_YUV</constant> </entry> 1423 <entry>integer</entry> 1424 </row><row><entry spanname="descr">Sets the "mute" color 1425of the video. The supplied 32-bit integer is interpreted as follows (bit 14260 = least significant bit):</entry> 1427 </row> 1428 <row> 1429 <entrytbl spanname="descr" cols="2"> 1430 <tbody valign="top"> 1431 <row> 1432 <entry>Bit 0:7</entry> 1433 <entry>V chrominance information</entry> 1434 </row> 1435 <row> 1436 <entry>Bit 8:15</entry> 1437 <entry>U chrominance information</entry> 1438 </row> 1439 <row> 1440 <entry>Bit 16:23</entry> 1441 <entry>Y luminance information</entry> 1442 </row> 1443 <row> 1444 <entry>Bit 24:31</entry> 1445 <entry>Must be zero.</entry> 1446 </row> 1447 </tbody> 1448 </entrytbl> 1449 </row> 1450 1451 1452 <row><entry></entry></row> 1453 <row> 1454 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE</constant> </entry> 1455 <entry>boolean</entry> 1456 </row> 1457 <row><entry spanname="descr">If enabled the decoder expects to receive a single slice per buffer, otherwise 1458the decoder expects a single frame in per buffer. Applicable to the decoder, all codecs. 1459</entry> 1460 </row> 1461 1462 <row><entry></entry></row> 1463 <row> 1464 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE</constant> </entry> 1465 <entry>boolean</entry> 1466 </row> 1467 <row><entry spanname="descr">Enable writing sample aspect ratio in the Video Usability Information. 1468Applicable to the H264 encoder.</entry> 1469 </row> 1470 1471 <row><entry></entry></row> 1472 <row id="v4l2-mpeg-video-h264-vui-sar-idc"> 1473 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC</constant> </entry> 1474 <entry>enum v4l2_mpeg_video_h264_vui_sar_idc</entry> 1475 </row> 1476 <row><entry spanname="descr">VUI sample aspect ratio indicator for H.264 encoding. The value 1477is defined in the table E-1 in the standard. Applicable to the H264 encoder.</entry> 1478 </row> 1479 <row> 1480 <entrytbl spanname="descr" cols="2"> 1481 <tbody valign="top"> 1482 1483 <row> 1484 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED</constant> </entry> 1485 <entry>Unspecified</entry> 1486 </row> 1487 <row> 1488 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1</constant> </entry> 1489 <entry>1x1</entry> 1490 </row> 1491 <row> 1492 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11</constant> </entry> 1493 <entry>12x11</entry> 1494 </row> 1495 <row> 1496 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11</constant> </entry> 1497 <entry>10x11</entry> 1498 </row> 1499 <row> 1500 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11</constant> </entry> 1501 <entry>16x11</entry> 1502 </row> 1503 <row> 1504 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33</constant> </entry> 1505 <entry>40x33</entry> 1506 </row> 1507 <row> 1508 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11</constant> </entry> 1509 <entry>24x11</entry> 1510 </row> 1511 <row> 1512 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11</constant> </entry> 1513 <entry>20x11</entry> 1514 </row> 1515 <row> 1516 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11</constant> </entry> 1517 <entry>32x11</entry> 1518 </row> 1519 <row> 1520 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33</constant> </entry> 1521 <entry>80x33</entry> 1522 </row> 1523 <row> 1524 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11</constant> </entry> 1525 <entry>18x11</entry> 1526 </row> 1527 <row> 1528 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11</constant> </entry> 1529 <entry>15x11</entry> 1530 </row> 1531 <row> 1532 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33</constant> </entry> 1533 <entry>64x33</entry> 1534 </row> 1535 <row> 1536 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99</constant> </entry> 1537 <entry>160x99</entry> 1538 </row> 1539 <row> 1540 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3</constant> </entry> 1541 <entry>4x3</entry> 1542 </row> 1543 <row> 1544 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2</constant> </entry> 1545 <entry>3x2</entry> 1546 </row> 1547 <row> 1548 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1</constant> </entry> 1549 <entry>2x1</entry> 1550 </row> 1551 <row> 1552 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED</constant> </entry> 1553 <entry>Extended SAR</entry> 1554 </row> 1555 </tbody> 1556 </entrytbl> 1557 </row> 1558 1559 <row><entry></entry></row> 1560 <row> 1561 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH</constant> </entry> 1562 <entry>integer</entry> 1563 </row> 1564 <row><entry spanname="descr">Extended sample aspect ratio width for H.264 VUI encoding. 1565Applicable to the H264 encoder.</entry> 1566 </row> 1567 1568 <row><entry></entry></row> 1569 <row> 1570 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT</constant> </entry> 1571 <entry>integer</entry> 1572 </row> 1573 <row><entry spanname="descr">Extended sample aspect ratio height for H.264 VUI encoding. 1574Applicable to the H264 encoder.</entry> 1575 </row> 1576 1577 <row><entry></entry></row> 1578 <row id="v4l2-mpeg-video-h264-level"> 1579 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LEVEL</constant> </entry> 1580 <entry>enum v4l2_mpeg_video_h264_level</entry> 1581 </row> 1582 <row><entry spanname="descr">The level information for the H264 video elementary stream. 1583Applicable to the H264 encoder. 1584Possible values are:</entry> 1585 </row> 1586 <row> 1587 <entrytbl spanname="descr" cols="2"> 1588 <tbody valign="top"> 1589 <row> 1590 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_0</constant> </entry> 1591 <entry>Level 1.0</entry> 1592 </row> 1593 <row> 1594 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1B</constant> </entry> 1595 <entry>Level 1B</entry> 1596 </row> 1597 <row> 1598 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_1</constant> </entry> 1599 <entry>Level 1.1</entry> 1600 </row> 1601 <row> 1602 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_2</constant> </entry> 1603 <entry>Level 1.2</entry> 1604 </row> 1605 <row> 1606 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_3</constant> </entry> 1607 <entry>Level 1.3</entry> 1608 </row> 1609 <row> 1610 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_0</constant> </entry> 1611 <entry>Level 2.0</entry> 1612 </row> 1613 <row> 1614 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_1</constant> </entry> 1615 <entry>Level 2.1</entry> 1616 </row> 1617 <row> 1618 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_2</constant> </entry> 1619 <entry>Level 2.2</entry> 1620 </row> 1621 <row> 1622 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_0</constant> </entry> 1623 <entry>Level 3.0</entry> 1624 </row> 1625 <row> 1626 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_1</constant> </entry> 1627 <entry>Level 3.1</entry> 1628 </row> 1629 <row> 1630 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_2</constant> </entry> 1631 <entry>Level 3.2</entry> 1632 </row> 1633 <row> 1634 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_0</constant> </entry> 1635 <entry>Level 4.0</entry> 1636 </row> 1637 <row> 1638 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_1</constant> </entry> 1639 <entry>Level 4.1</entry> 1640 </row> 1641 <row> 1642 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_2</constant> </entry> 1643 <entry>Level 4.2</entry> 1644 </row> 1645 <row> 1646 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_0</constant> </entry> 1647 <entry>Level 5.0</entry> 1648 </row> 1649 <row> 1650 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_1</constant> </entry> 1651 <entry>Level 5.1</entry> 1652 </row> 1653 </tbody> 1654 </entrytbl> 1655 </row> 1656 1657 <row><entry></entry></row> 1658 <row id="v4l2-mpeg-video-mpeg4-level"> 1659 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL</constant> </entry> 1660 <entry>enum v4l2_mpeg_video_mpeg4_level</entry> 1661 </row> 1662 <row><entry spanname="descr">The level information for the MPEG4 elementary stream. 1663Applicable to the MPEG4 encoder. 1664Possible values are:</entry> 1665 </row> 1666 <row> 1667 <entrytbl spanname="descr" cols="2"> 1668 <tbody valign="top"> 1669 <row> 1670 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0</constant> </entry> 1671 <entry>Level 0</entry> 1672 </row> 1673 <row> 1674 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0B</constant> </entry> 1675 <entry>Level 0b</entry> 1676 </row> 1677 <row> 1678 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_1</constant> </entry> 1679 <entry>Level 1</entry> 1680 </row> 1681 <row> 1682 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_2</constant> </entry> 1683 <entry>Level 2</entry> 1684 </row> 1685 <row> 1686 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3</constant> </entry> 1687 <entry>Level 3</entry> 1688 </row> 1689 <row> 1690 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3B</constant> </entry> 1691 <entry>Level 3b</entry> 1692 </row> 1693 <row> 1694 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_4</constant> </entry> 1695 <entry>Level 4</entry> 1696 </row> 1697 <row> 1698 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_5</constant> </entry> 1699 <entry>Level 5</entry> 1700 </row> 1701 </tbody> 1702 </entrytbl> 1703 </row> 1704 1705 <row><entry></entry></row> 1706 <row id="v4l2-mpeg-video-h264-profile"> 1707 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_PROFILE</constant> </entry> 1708 <entry>enum v4l2_mpeg_video_h264_profile</entry> 1709 </row> 1710 <row><entry spanname="descr">The profile information for H264. 1711Applicable to the H264 encoder. 1712Possible values are:</entry> 1713 </row> 1714 <row> 1715 <entrytbl spanname="descr" cols="2"> 1716 <tbody valign="top"> 1717 <row> 1718 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE</constant> </entry> 1719 <entry>Baseline profile</entry> 1720 </row> 1721 <row> 1722 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE</constant> </entry> 1723 <entry>Constrained Baseline profile</entry> 1724 </row> 1725 <row> 1726 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MAIN</constant> </entry> 1727 <entry>Main profile</entry> 1728 </row> 1729 <row> 1730 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED</constant> </entry> 1731 <entry>Extended profile</entry> 1732 </row> 1733 <row> 1734 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH</constant> </entry> 1735 <entry>High profile</entry> 1736 </row> 1737 <row> 1738 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10</constant> </entry> 1739 <entry>High 10 profile</entry> 1740 </row> 1741 <row> 1742 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422</constant> </entry> 1743 <entry>High 422 profile</entry> 1744 </row> 1745 <row> 1746 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE</constant> </entry> 1747 <entry>High 444 Predictive profile</entry> 1748 </row> 1749 <row> 1750 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA</constant> </entry> 1751 <entry>High 10 Intra profile</entry> 1752 </row> 1753 <row> 1754 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA</constant> </entry> 1755 <entry>High 422 Intra profile</entry> 1756 </row> 1757 <row> 1758 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA</constant> </entry> 1759 <entry>High 444 Intra profile</entry> 1760 </row> 1761 <row> 1762 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA</constant> </entry> 1763 <entry>CAVLC 444 Intra profile</entry> 1764 </row> 1765 <row> 1766 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE</constant> </entry> 1767 <entry>Scalable Baseline profile</entry> 1768 </row> 1769 <row> 1770 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH</constant> </entry> 1771 <entry>Scalable High profile</entry> 1772 </row> 1773 <row> 1774 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA</constant> </entry> 1775 <entry>Scalable High Intra profile</entry> 1776 </row> 1777 <row> 1778 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH</constant> </entry> 1779 <entry>Stereo High profile</entry> 1780 </row> 1781 <row> 1782 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH</constant> </entry> 1783 <entry>Multiview High profile</entry> 1784 </row> 1785 1786 </tbody> 1787 </entrytbl> 1788 </row> 1789 1790 <row><entry></entry></row> 1791 <row id="v4l2-mpeg-video-mpeg4-profile"> 1792 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE</constant> </entry> 1793 <entry>enum v4l2_mpeg_video_mpeg4_profile</entry> 1794 </row> 1795 <row><entry spanname="descr">The profile information for MPEG4. 1796Applicable to the MPEG4 encoder. 1797Possible values are:</entry> 1798 </row> 1799 <row> 1800 <entrytbl spanname="descr" cols="2"> 1801 <tbody valign="top"> 1802 <row> 1803 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE</constant> </entry> 1804 <entry>Simple profile</entry> 1805 </row> 1806 <row> 1807 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_SIMPLE</constant> </entry> 1808 <entry>Advanced Simple profile</entry> 1809 </row> 1810 <row> 1811 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_CORE</constant> </entry> 1812 <entry>Core profile</entry> 1813 </row> 1814 <row> 1815 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE_SCALABLE</constant> </entry> 1816 <entry>Simple Scalable profile</entry> 1817 </row> 1818 <row> 1819 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_CODING_EFFICIENCY</constant> </entry> 1820 <entry></entry> 1821 </row> 1822 </tbody> 1823 </entrytbl> 1824 </row> 1825 1826 <row><entry></entry></row> 1827 <row> 1828 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MAX_REF_PIC</constant> </entry> 1829 <entry>integer</entry> 1830 </row> 1831 <row><entry spanname="descr">The maximum number of reference pictures used for encoding. 1832Applicable to the encoder. 1833</entry> 1834 </row> 1835 1836 <row><entry></entry></row> 1837 <row id="v4l2-mpeg-video-multi-slice-mode"> 1838 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> </entry> 1839 <entry>enum v4l2_mpeg_video_multi_slice_mode</entry> 1840 </row> 1841 <row><entry spanname="descr">Determines how the encoder should handle division of frame into slices. 1842Applicable to the encoder. 1843Possible values are:</entry> 1844 </row> 1845 <row> 1846 <entrytbl spanname="descr" cols="2"> 1847 <tbody valign="top"> 1848 <row> 1849 <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE</constant> </entry> 1850 <entry>Single slice per frame.</entry> 1851 </row> 1852 <row> 1853 <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant> </entry> 1854 <entry>Multiple slices with set maximum number of macroblocks per slice.</entry> 1855 </row> 1856 <row> 1857 <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant> </entry> 1858 <entry>Multiple slice with set maximum size in bytes per slice.</entry> 1859 </row> 1860 </tbody> 1861 </entrytbl> 1862 </row> 1863 1864 <row><entry></entry></row> 1865 <row> 1866 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB</constant> </entry> 1867 <entry>integer</entry> 1868 </row> 1869 <row><entry spanname="descr">The maximum number of macroblocks in a slice. Used when 1870<constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>. 1871Applicable to the encoder.</entry> 1872 </row> 1873 1874 <row><entry></entry></row> 1875 <row> 1876 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES</constant> </entry> 1877 <entry>integer</entry> 1878 </row> 1879 <row><entry spanname="descr">The maximum size of a slice in bytes. Used when 1880<constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>. 1881Applicable to the encoder.</entry> 1882 </row> 1883 1884 <row><entry></entry></row> 1885 <row id="v4l2-mpeg-video-h264-loop-filter-mode"> 1886 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE</constant> </entry> 1887 <entry>enum v4l2_mpeg_video_h264_loop_filter_mode</entry> 1888 </row> 1889 <row><entry spanname="descr">Loop filter mode for H264 encoder. 1890Possible values are:</entry> 1891 </row> 1892 <row> 1893 <entrytbl spanname="descr" cols="2"> 1894 <tbody valign="top"> 1895 <row> 1896 <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED</constant> </entry> 1897 <entry>Loop filter is enabled.</entry> 1898 </row> 1899 <row> 1900 <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED</constant> </entry> 1901 <entry>Loop filter is disabled.</entry> 1902 </row> 1903 <row> 1904 <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY</constant> </entry> 1905 <entry>Loop filter is disabled at the slice boundary.</entry> 1906 </row> 1907 </tbody> 1908 </entrytbl> 1909 </row> 1910 1911 <row><entry></entry></row> 1912 <row> 1913 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA</constant> </entry> 1914 <entry>integer</entry> 1915 </row> 1916 <row><entry spanname="descr">Loop filter alpha coefficient, defined in the H264 standard. 1917Applicable to the H264 encoder.</entry> 1918 </row> 1919 1920 <row><entry></entry></row> 1921 <row> 1922 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA</constant> </entry> 1923 <entry>integer</entry> 1924 </row> 1925 <row><entry spanname="descr">Loop filter beta coefficient, defined in the H264 standard. 1926Applicable to the H264 encoder.</entry> 1927 </row> 1928 1929 <row><entry></entry></row> 1930 <row id="v4l2-mpeg-video-h264-entropy-mode"> 1931 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE</constant> </entry> 1932 <entry>enum v4l2_mpeg_video_h264_entropy_mode</entry> 1933 </row> 1934 <row><entry spanname="descr">Entropy coding mode for H264 - CABAC/CAVALC. 1935Applicable to the H264 encoder. 1936Possible values are:</entry> 1937 </row> 1938 <row> 1939 <entrytbl spanname="descr" cols="2"> 1940 <tbody valign="top"> 1941 <row> 1942 <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC</constant> </entry> 1943 <entry>Use CAVLC entropy coding.</entry> 1944 </row> 1945 <row> 1946 <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC</constant> </entry> 1947 <entry>Use CABAC entropy coding.</entry> 1948 </row> 1949 </tbody> 1950 </entrytbl> 1951 </row> 1952 1953 <row><entry></entry></row> 1954 <row> 1955 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM</constant> </entry> 1956 <entry>boolean</entry> 1957 </row> 1958 <row><entry spanname="descr">Enable 8X8 transform for H264. Applicable to the H264 encoder.</entry> 1959 </row> 1960 1961 <row><entry></entry></row> 1962 <row> 1963 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB</constant> </entry> 1964 <entry>integer</entry> 1965 </row> 1966 <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks 1967refreshed every frame. Each frame a succesive set of macroblocks is refreshed until the cycle completes and starts from the 1968top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry> 1969 </row> 1970 1971 <row><entry></entry></row> 1972 <row> 1973 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE</constant> </entry> 1974 <entry>boolean</entry> 1975 </row> 1976 <row><entry spanname="descr">Frame level rate control enable. 1977If this control is disabled then the quantization parameter for each frame type is constant and set with appropriate controls 1978(e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>). 1979If frame rate control is enabled then quantization parameter is adjusted to meet the chosen bitrate. Minimum and maximum value 1980for the quantization parameter can be set with appropriate controls (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>). 1981Applicable to encoders.</entry> 1982 </row> 1983 1984 <row><entry></entry></row> 1985 <row> 1986 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant> </entry> 1987 <entry>boolean</entry> 1988 </row> 1989 <row><entry spanname="descr">Macroblock level rate control enable. 1990Applicable to the MPEG4 and H264 encoders.</entry> 1991 </row> 1992 1993 <row><entry></entry></row> 1994 <row> 1995 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_QPEL</constant> </entry> 1996 <entry>boolean</entry> 1997 </row> 1998 <row><entry spanname="descr">Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 encoder.</entry> 1999 </row> 2000 2001 <row><entry></entry></row> 2002 <row> 2003 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant> </entry> 2004 <entry>integer</entry> 2005 </row> 2006 <row><entry spanname="descr">Quantization parameter for an I frame for H263. Valid range: from 1 to 31.</entry> 2007 </row> 2008 2009 <row><entry></entry></row> 2010 <row> 2011 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant> </entry> 2012 <entry>integer</entry> 2013 </row> 2014 <row><entry spanname="descr">Minimum quantization parameter for H263. Valid range: from 1 to 31.</entry> 2015 </row> 2016 2017 <row><entry></entry></row> 2018 <row> 2019 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MAX_QP</constant> </entry> 2020 <entry>integer</entry> 2021 </row> 2022 <row><entry spanname="descr">Maximum quantization parameter for H263. Valid range: from 1 to 31.</entry> 2023 </row> 2024 2025 <row><entry></entry></row> 2026 <row> 2027 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP</constant> </entry> 2028 <entry>integer</entry> 2029 </row> 2030 <row><entry spanname="descr">Quantization parameter for an P frame for H263. Valid range: from 1 to 31.</entry> 2031 </row> 2032 2033 <row><entry></entry></row> 2034 <row> 2035 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP</constant> </entry> 2036 <entry>integer</entry> 2037 </row> 2038 <row><entry spanname="descr">Quantization parameter for an B frame for H263. Valid range: from 1 to 31.</entry> 2039 </row> 2040 2041 <row><entry></entry></row> 2042 <row> 2043 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP</constant> </entry> 2044 <entry>integer</entry> 2045 </row> 2046 <row><entry spanname="descr">Quantization parameter for an I frame for H264. Valid range: from 0 to 51.</entry> 2047 </row> 2048 2049 <row><entry></entry></row> 2050 <row> 2051 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MIN_QP</constant> </entry> 2052 <entry>integer</entry> 2053 </row> 2054 <row><entry spanname="descr">Minimum quantization parameter for H264. Valid range: from 0 to 51.</entry> 2055 </row> 2056 2057 <row><entry></entry></row> 2058 <row> 2059 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MAX_QP</constant> </entry> 2060 <entry>integer</entry> 2061 </row> 2062 <row><entry spanname="descr">Maximum quantization parameter for H264. Valid range: from 0 to 51.</entry> 2063 </row> 2064 2065 <row><entry></entry></row> 2066 <row> 2067 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP</constant> </entry> 2068 <entry>integer</entry> 2069 </row> 2070 <row><entry spanname="descr">Quantization parameter for an P frame for H264. Valid range: from 0 to 51.</entry> 2071 </row> 2072 2073 <row><entry></entry></row> 2074 <row> 2075 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP</constant> </entry> 2076 <entry>integer</entry> 2077 </row> 2078 <row><entry spanname="descr">Quantization parameter for an B frame for H264. Valid range: from 0 to 51.</entry> 2079 </row> 2080 2081 <row><entry></entry></row> 2082 <row> 2083 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP</constant> </entry> 2084 <entry>integer</entry> 2085 </row> 2086 <row><entry spanname="descr">Quantization parameter for an I frame for MPEG4. Valid range: from 1 to 31.</entry> 2087 </row> 2088 2089 <row><entry></entry></row> 2090 <row> 2091 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP</constant> </entry> 2092 <entry>integer</entry> 2093 </row> 2094 <row><entry spanname="descr">Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry> 2095 </row> 2096 2097 <row><entry></entry></row> 2098 <row> 2099 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP</constant> </entry> 2100 <entry>integer</entry> 2101 </row> 2102 <row><entry spanname="descr">Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry> 2103 </row> 2104 2105 <row><entry></entry></row> 2106 <row> 2107 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP</constant> </entry> 2108 <entry>integer</entry> 2109 </row> 2110 <row><entry spanname="descr">Quantization parameter for an P frame for MPEG4. Valid range: from 1 to 31.</entry> 2111 </row> 2112 2113 <row><entry></entry></row> 2114 <row> 2115 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP</constant> </entry> 2116 <entry>integer</entry> 2117 </row> 2118 <row><entry spanname="descr">Quantization parameter for an B frame for MPEG4. Valid range: from 1 to 31.</entry> 2119 </row> 2120 2121 <row><entry></entry></row> 2122 <row> 2123 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VBV_SIZE</constant> </entry> 2124 <entry>integer</entry> 2125 </row> 2126 <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip. 2127The VBV is defined in the standard as a mean to verify that the produced stream will be succesfully decoded. 2128The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the 2129output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an 2130encoder or editing process may produce.". 2131Applicable to the MPEG1, MPEG2, MPEG4 encoders.</entry> 2132 </row> 2133 2134 <row><entry></entry></row> 2135 <row> 2136 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE</constant> </entry> 2137 <entry>integer</entry> 2138 </row> 2139 <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip. 2140The CPB is defined in the H264 standard as a mean to verify that the produced stream will be succesfully decoded. 2141Applicable to the H264 encoder.</entry> 2142 </row> 2143 2144 <row><entry></entry></row> 2145 <row> 2146 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_PERIOD</constant> </entry> 2147 <entry>integer</entry> 2148 </row> 2149 <row><entry spanname="descr">Period between I-frames in the open GOP for H264. In case of an open GOP 2150this is the period between two I-frames. The period between IDR (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE control. 2151An IDR frame, which stands for Instantaneous Decoding Refresh is an I-frame after which no prior frames are 2152referenced. This means that a stream can be restarted from an IDR frame without the need to store or decode any 2153previous frames. Applicable to the H264 encoder.</entry> 2154 </row> 2155 2156 <row><entry></entry></row> 2157 <row id="v4l2-mpeg-video-header-mode"> 2158 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_HEADER_MODE</constant> </entry> 2159 <entry>enum v4l2_mpeg_video_header_mode</entry> 2160 </row> 2161 <row><entry spanname="descr">Determines whether the header is returned as the first buffer or is 2162it returned together with the first frame. Applicable to encoders. 2163Possible values are:</entry> 2164 </row> 2165 <row> 2166 <entrytbl spanname="descr" cols="2"> 2167 <tbody valign="top"> 2168 <row> 2169 <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE</constant> </entry> 2170 <entry>The stream header is returned separately in the first buffer.</entry> 2171 </row> 2172 <row> 2173 <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME</constant> </entry> 2174 <entry>The stream header is returned together with the first encoded frame.</entry> 2175 </row> 2176 </tbody> 2177 </entrytbl> 2178 </row> 2179 <row><entry></entry></row> 2180 <row> 2181 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER</constant> </entry> 2182 <entry>boolean</entry> 2183 </row><row><entry spanname="descr">Enabled the deblocking post processing filter for MPEG4 decoder. 2184Applicable to the MPEG4 decoder.</entry> 2185 </row> 2186 <row><entry></entry></row> 2187 <row> 2188 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES</constant> </entry> 2189 <entry>integer</entry> 2190 </row><row><entry spanname="descr">vop_time_increment_resolution value for MPEG4. Applicable to the MPEG4 encoder.</entry> 2191 </row> 2192 <row><entry></entry></row> 2193 <row> 2194 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC</constant> </entry> 2195 <entry>integer</entry> 2196 </row><row><entry spanname="descr">vop_time_increment value for MPEG4. Applicable to the MPEG4 encoder.</entry> 2197 </row> 2198 2199 </tbody> 2200 </tgroup> 2201 </table> 2202 </section> 2203 2204 <section> 2205 <title>MFC 5.1 MPEG Controls</title> 2206 2207 <para>The following MPEG class controls deal with MPEG 2208decoding and encoding settings that are specific to the Multi Format Codec 5.1 device present 2209in the S5P family of SoCs by Samsung. 2210</para> 2211 2212 <table pgwide="1" frame="none" id="mfc51-control-id"> 2213 <title>MFC 5.1 Control IDs</title> 2214 <tgroup cols="4"> 2215 <colspec colname="c1" colwidth="1*" /> 2216 <colspec colname="c2" colwidth="6*" /> 2217 <colspec colname="c3" colwidth="2*" /> 2218 <colspec colname="c4" colwidth="6*" /> 2219 <spanspec namest="c1" nameend="c2" spanname="id" /> 2220 <spanspec namest="c2" nameend="c4" spanname="descr" /> 2221 <thead> 2222 <row> 2223 <entry spanname="id" align="left">ID</entry> 2224 <entry align="left">Type</entry> 2225 </row><row><entry spanname="descr" align="left">Description</entry> 2226 </row> 2227 </thead> 2228 <tbody valign="top"> 2229 <row><entry></entry></row> 2230 <row> 2231 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE</constant> </entry> 2232 <entry>integer</entry> 2233 </row><row><entry spanname="descr">If the display delay is enabled then the decoder has to return a 2234CAPTURE buffer after processing a certain number of OUTPUT buffers. If this number is low, then it may result in 2235buffers not being dequeued in display order. In addition hardware may still use those buffers as reference, thus 2236application should not write to those buffers. This feature can be used for example for generating thumbnails of videos. 2237Applicable to the H264 decoder. 2238 </entry> 2239 </row> 2240 <row><entry></entry></row> 2241 <row> 2242 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant> </entry> 2243 <entry>integer</entry> 2244 </row><row><entry spanname="descr">Display delay value for H264 decoder. 2245The decoder is forced to return a decoded frame after the set 'display delay' number of frames. If this number is 2246low it may result in frames returned out of dispaly order, in addition the hardware may still be using the returned buffer 2247as a reference picture for subsequent frames. 2248</entry> 2249 </row> 2250 <row><entry></entry></row> 2251 <row> 2252 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P</constant> </entry> 2253 <entry>integer</entry> 2254 </row><row><entry spanname="descr">The number of reference pictures used for encoding a P picture. 2255Applicable to the H264 encoder.</entry> 2256 </row> 2257 <row><entry></entry></row> 2258 <row> 2259 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING</constant> </entry> 2260 <entry>boolean</entry> 2261 </row><row><entry spanname="descr">Padding enable in the encoder - use a color instead of repeating border pixels. 2262Applicable to encoders.</entry> 2263 </row> 2264 <row><entry></entry></row> 2265 <row> 2266 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV</constant> </entry> 2267 <entry>integer</entry> 2268 </row><row><entry spanname="descr">Padding color in the encoder. Applicable to encoders. The supplied 32-bit integer is interpreted as follows (bit 22690 = least significant bit):</entry> 2270 </row> 2271 <row> 2272 <entrytbl spanname="descr" cols="2"> 2273 <tbody valign="top"> 2274 <row> 2275 <entry>Bit 0:7</entry> 2276 <entry>V chrominance information</entry> 2277 </row> 2278 <row> 2279 <entry>Bit 8:15</entry> 2280 <entry>U chrominance information</entry> 2281 </row> 2282 <row> 2283 <entry>Bit 16:23</entry> 2284 <entry>Y luminance information</entry> 2285 </row> 2286 <row> 2287 <entry>Bit 24:31</entry> 2288 <entry>Must be zero.</entry> 2289 </row> 2290 </tbody> 2291 </entrytbl> 2292 </row> 2293 <row><entry></entry></row> 2294 <row> 2295 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF</constant> </entry> 2296 <entry>integer</entry> 2297 </row><row><entry spanname="descr">Reaction coefficient for MFC rate control. Applicable to encoders. 2298<para>Note 1: Valid only when the frame level RC is enabled.</para> 2299<para>Note 2: For tight CBR, this field must be small (ex. 2 ~ 10). 2300For VBR, this field must be large (ex. 100 ~ 1000).</para> 2301<para>Note 3: It is not recommended to use the greater number than FRAME_RATE * (10^9 / BIT_RATE).</para> 2302</entry> 2303 </row> 2304 <row><entry></entry></row> 2305 <row> 2306 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK</constant> </entry> 2307 <entry>boolean</entry> 2308 </row><row><entry spanname="descr">Adaptive rate control for dark region. 2309Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>). 2310Applicable to the H264 encoder.</entry> 2311 </row> 2312 <row><entry></entry></row> 2313 <row> 2314 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH</constant> </entry> 2315 <entry>boolean</entry> 2316 </row><row><entry spanname="descr">Adaptive rate control for smooth region. 2317Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>). 2318Applicable to the H264 encoder.</entry> 2319 </row> 2320 <row><entry></entry></row> 2321 <row> 2322 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC</constant> </entry> 2323 <entry>boolean</entry> 2324 </row><row><entry spanname="descr">Adaptive rate control for static region. 2325Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>). 2326Applicable to the H264 encoder.</entry> 2327 </row> 2328 <row><entry></entry></row> 2329 <row> 2330 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY</constant> </entry> 2331 <entry>boolean</entry> 2332 </row><row><entry spanname="descr">Adaptive rate control for activity region. 2333Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>). 2334Applicable to the H264 encoder.</entry> 2335 </row> 2336 <row><entry></entry></row> 2337 <row id="v4l2-mpeg-mfc51-video-frame-skip-mode"> 2338 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE</constant> </entry> 2339 <entry>enum v4l2_mpeg_mfc51_video_frame_skip_mode</entry> 2340 </row> 2341 <row><entry spanname="descr"> 2342Indicates in what conditions the encoder should skip frames. If encoding a frame would cause the encoded stream to be larger then 2343a chosen data limit then the frame will be skipped. 2344Possible values are:</entry> 2345 </row> 2346 <row> 2347 <entrytbl spanname="descr" cols="2"> 2348 <tbody valign="top"> 2349 <row> 2350 <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED</constant> </entry> 2351 <entry>Frame skip mode is disabled.</entry> 2352 </row> 2353 <row> 2354 <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT</constant> </entry> 2355 <entry>Frame skip mode enabled and buffer limit is set by the chosen level and is defined by the standard.</entry> 2356 </row> 2357 <row> 2358 <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT</constant> </entry> 2359 <entry>Frame skip mode enabled and buffer limit is set by the VBV (MPEG1/2/4) or CPB (H264) buffer size control.</entry> 2360 </row> 2361 </tbody> 2362 </entrytbl> 2363 </row> 2364 <row><entry></entry></row> 2365 <row> 2366 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT</constant> </entry> 2367 <entry>integer</entry> 2368 </row><row><entry spanname="descr">Enable rate-control with fixed target bit. 2369If this setting is enabled, then the rate control logic of the encoder will calculate the average bitrate 2370for a GOP and keep it below or equal the set bitrate target. Otherwise the rate control logic calculates the 2371overall average bitrate for the stream and keeps it below or equal to the set bitrate. In the first case 2372the average bitrate for the whole stream will be smaller then the set bitrate. This is caused because the 2373average is calculated for smaller number of frames, on the other hand enabling this setting will ensure that 2374the stream will meet tight bandwidth contraints. Applicable to encoders. 2375</entry> 2376 </row> 2377 <row><entry></entry></row> 2378 <row id="v4l2-mpeg-mfc51-video-force-frame-type"> 2379 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE</constant> </entry> 2380 <entry>enum v4l2_mpeg_mfc51_video_force_frame_type</entry> 2381 </row> 2382 <row><entry spanname="descr">Force a frame type for the next queued buffer. Applicable to encoders. 2383Possible values are:</entry> 2384 </row> 2385 <row> 2386 <entrytbl spanname="descr" cols="2"> 2387 <tbody valign="top"> 2388 <row> 2389 <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED</constant> </entry> 2390 <entry>Forcing a specific frame type disabled.</entry> 2391 </row> 2392 <row> 2393 <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME</constant> </entry> 2394 <entry>Force an I-frame.</entry> 2395 </row> 2396 <row> 2397 <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED</constant> </entry> 2398 <entry>Force a non-coded frame.</entry> 2399 </row> 2400 </tbody> 2401 </entrytbl> 2402 </row> 2403 </tbody> 2404 </tgroup> 2405 </table> 2406 </section> 2407 2408 <section> 2409 <title>CX2341x MPEG Controls</title> 2410 2411 <para>The following MPEG class controls deal with MPEG 2412encoding settings that are specific to the Conexant CX23415 and 2413CX23416 MPEG encoding chips.</para> 2414 2415 <table pgwide="1" frame="none" id="cx2341x-control-id"> 2416 <title>CX2341x Control IDs</title> 2417 <tgroup cols="4"> 2418 <colspec colname="c1" colwidth="1*" /> 2419 <colspec colname="c2" colwidth="6*" /> 2420 <colspec colname="c3" colwidth="2*" /> 2421 <colspec colname="c4" colwidth="6*" /> 2422 <spanspec namest="c1" nameend="c2" spanname="id" /> 2423 <spanspec namest="c2" nameend="c4" spanname="descr" /> 2424 <thead> 2425 <row> 2426 <entry spanname="id" align="left">ID</entry> 2427 <entry align="left">Type</entry> 2428 </row><row><entry spanname="descr" align="left">Description</entry> 2429 </row> 2430 </thead> 2431 <tbody valign="top"> 2432 <row><entry></entry></row> 2433 <row id="v4l2-mpeg-cx2341x-video-spatial-filter-mode"> 2434 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE</constant> </entry> 2435 <entry>enum v4l2_mpeg_cx2341x_video_spatial_filter_mode</entry> 2436 </row><row><entry spanname="descr">Sets the Spatial 2437Filter mode (default <constant>MANUAL</constant>). Possible values 2438are:</entry> 2439 </row> 2440 <row> 2441 <entrytbl spanname="descr" cols="2"> 2442 <tbody valign="top"> 2443 <row> 2444 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL</constant> </entry> 2445 <entry>Choose the filter manually</entry> 2446 </row> 2447 <row> 2448 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO</constant> </entry> 2449 <entry>Choose the filter automatically</entry> 2450 </row> 2451 </tbody> 2452 </entrytbl> 2453 </row> 2454 <row><entry></entry></row> 2455 <row> 2456 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER</constant> </entry> 2457 <entry>integer (0-15)</entry> 2458 </row><row><entry spanname="descr">The setting for the 2459Spatial Filter. 0 = off, 15 = maximum. (Default is 0.)</entry> 2460 </row> 2461 <row><entry></entry></row> 2462 <row id="luma-spatial-filter-type"> 2463 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE</constant> </entry> 2464 <entry>enum v4l2_mpeg_cx2341x_video_luma_spatial_filter_type</entry> 2465 </row><row><entry spanname="descr">Select the algorithm 2466to use for the Luma Spatial Filter (default 2467<constant>1D_HOR</constant>). Possible values:</entry> 2468 </row> 2469 <row> 2470 <entrytbl spanname="descr" cols="2"> 2471 <tbody valign="top"> 2472 <row> 2473 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF</constant> </entry> 2474 <entry>No filter</entry> 2475 </row> 2476 <row> 2477 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR</constant> </entry> 2478 <entry>One-dimensional horizontal</entry> 2479 </row> 2480 <row> 2481 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT</constant> </entry> 2482 <entry>One-dimensional vertical</entry> 2483 </row> 2484 <row> 2485 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE</constant> </entry> 2486 <entry>Two-dimensional separable</entry> 2487 </row> 2488 <row> 2489 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE</constant> </entry> 2490 <entry>Two-dimensional symmetrical 2491non-separable</entry> 2492 </row> 2493 </tbody> 2494 </entrytbl> 2495 </row> 2496 <row><entry></entry></row> 2497 <row id="chroma-spatial-filter-type"> 2498 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE</constant> </entry> 2499 <entry>enum v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type</entry> 2500 </row><row><entry spanname="descr">Select the algorithm 2501for the Chroma Spatial Filter (default <constant>1D_HOR</constant>). 2502Possible values are:</entry> 2503 </row> 2504 <row> 2505 <entrytbl spanname="descr" cols="2"> 2506 <tbody valign="top"> 2507 <row> 2508 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF</constant> </entry> 2509 <entry>No filter</entry> 2510 </row> 2511 <row> 2512 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR</constant> </entry> 2513 <entry>One-dimensional horizontal</entry> 2514 </row> 2515 </tbody> 2516 </entrytbl> 2517 </row> 2518 <row><entry></entry></row> 2519 <row id="v4l2-mpeg-cx2341x-video-temporal-filter-mode"> 2520 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE</constant> </entry> 2521 <entry>enum v4l2_mpeg_cx2341x_video_temporal_filter_mode</entry> 2522 </row><row><entry spanname="descr">Sets the Temporal 2523Filter mode (default <constant>MANUAL</constant>). Possible values 2524are:</entry> 2525 </row> 2526 <row> 2527 <entrytbl spanname="descr" cols="2"> 2528 <tbody valign="top"> 2529 <row> 2530 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL</constant> </entry> 2531 <entry>Choose the filter manually</entry> 2532 </row> 2533 <row> 2534 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO</constant> </entry> 2535 <entry>Choose the filter automatically</entry> 2536 </row> 2537 </tbody> 2538 </entrytbl> 2539 </row> 2540 <row><entry></entry></row> 2541 <row> 2542 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER</constant> </entry> 2543 <entry>integer (0-31)</entry> 2544 </row><row><entry spanname="descr">The setting for the 2545Temporal Filter. 0 = off, 31 = maximum. (Default is 8 for full-scale 2546capturing and 0 for scaled capturing.)</entry> 2547 </row> 2548 <row><entry></entry></row> 2549 <row id="v4l2-mpeg-cx2341x-video-median-filter-type"> 2550 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE</constant> </entry> 2551 <entry>enum v4l2_mpeg_cx2341x_video_median_filter_type</entry> 2552 </row><row><entry spanname="descr">Median Filter Type 2553(default <constant>OFF</constant>). Possible values are:</entry> 2554 </row> 2555 <row> 2556 <entrytbl spanname="descr" cols="2"> 2557 <tbody valign="top"> 2558 <row> 2559 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF</constant> </entry> 2560 <entry>No filter</entry> 2561 </row> 2562 <row> 2563 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR</constant> </entry> 2564 <entry>Horizontal filter</entry> 2565 </row> 2566 <row> 2567 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT</constant> </entry> 2568 <entry>Vertical filter</entry> 2569 </row> 2570 <row> 2571 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT</constant> </entry> 2572 <entry>Horizontal and vertical filter</entry> 2573 </row> 2574 <row> 2575 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG</constant> </entry> 2576 <entry>Diagonal filter</entry> 2577 </row> 2578 </tbody> 2579 </entrytbl> 2580 </row> 2581 <row><entry></entry></row> 2582 <row> 2583 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM</constant> </entry> 2584 <entry>integer (0-255)</entry> 2585 </row><row><entry spanname="descr">Threshold above which 2586the luminance median filter is enabled (default 0)</entry> 2587 </row> 2588 <row><entry></entry></row> 2589 <row> 2590 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP</constant> </entry> 2591 <entry>integer (0-255)</entry> 2592 </row><row><entry spanname="descr">Threshold below which 2593the luminance median filter is enabled (default 255)</entry> 2594 </row> 2595 <row><entry></entry></row> 2596 <row> 2597 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM</constant> </entry> 2598 <entry>integer (0-255)</entry> 2599 </row><row><entry spanname="descr">Threshold above which 2600the chroma median filter is enabled (default 0)</entry> 2601 </row> 2602 <row><entry></entry></row> 2603 <row> 2604 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP</constant> </entry> 2605 <entry>integer (0-255)</entry> 2606 </row><row><entry spanname="descr">Threshold below which 2607the chroma median filter is enabled (default 255)</entry> 2608 </row> 2609 <row><entry></entry></row> 2610 <row> 2611 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS</constant> </entry> 2612 <entry>boolean</entry> 2613 </row> 2614 <row><entry spanname="descr">The CX2341X MPEG encoder 2615can insert one empty MPEG-2 PES packet into the stream between every 2616four video frames. The packet size is 2048 bytes, including the 2617packet_start_code_prefix and stream_id fields. The stream_id is 0xBF 2618(private stream 2). The payload consists of 0x00 bytes, to be filled 2619in by the application. 0 = do not insert, 1 = insert packets.</entry> 2620 </row> 2621 </tbody> 2622 </tgroup> 2623 </table> 2624 </section> 2625 </section> 2626 2627 <section id="camera-controls"> 2628 <title>Camera Control Reference</title> 2629 2630 <para>The Camera class includes controls for mechanical (or 2631equivalent digital) features of a device such as controllable lenses 2632or sensors.</para> 2633 2634 <table pgwide="1" frame="none" id="camera-control-id"> 2635 <title>Camera Control IDs</title> 2636 <tgroup cols="4"> 2637 <colspec colname="c1" colwidth="1*" /> 2638 <colspec colname="c2" colwidth="6*" /> 2639 <colspec colname="c3" colwidth="2*" /> 2640 <colspec colname="c4" colwidth="6*" /> 2641 <spanspec namest="c1" nameend="c2" spanname="id" /> 2642 <spanspec namest="c2" nameend="c4" spanname="descr" /> 2643 <thead> 2644 <row> 2645 <entry spanname="id" align="left">ID</entry> 2646 <entry align="left">Type</entry> 2647 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> 2648 </row> 2649 </thead> 2650 <tbody valign="top"> 2651 <row><entry></entry></row> 2652 <row> 2653 <entry spanname="id"><constant>V4L2_CID_CAMERA_CLASS</constant> </entry> 2654 <entry>class</entry> 2655 </row><row><entry spanname="descr">The Camera class 2656descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a 2657description of this control class.</entry> 2658 </row> 2659 <row><entry></entry></row> 2660 2661 <row id="v4l2-exposure-auto-type"> 2662 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO</constant> </entry> 2663 <entry>enum v4l2_exposure_auto_type</entry> 2664 </row><row><entry spanname="descr">Enables automatic 2665adjustments of the exposure time and/or iris aperture. The effect of 2666manual changes of the exposure time or iris aperture while these 2667features are enabled is undefined, drivers should ignore such 2668requests. Possible values are:</entry> 2669 </row> 2670 <row> 2671 <entrytbl spanname="descr" cols="2"> 2672 <tbody valign="top"> 2673 <row> 2674 <entry><constant>V4L2_EXPOSURE_AUTO</constant> </entry> 2675 <entry>Automatic exposure time, automatic iris 2676aperture.</entry> 2677 </row> 2678 <row> 2679 <entry><constant>V4L2_EXPOSURE_MANUAL</constant> </entry> 2680 <entry>Manual exposure time, manual iris.</entry> 2681 </row> 2682 <row> 2683 <entry><constant>V4L2_EXPOSURE_SHUTTER_PRIORITY</constant> </entry> 2684 <entry>Manual exposure time, auto iris.</entry> 2685 </row> 2686 <row> 2687 <entry><constant>V4L2_EXPOSURE_APERTURE_PRIORITY</constant> </entry> 2688 <entry>Auto exposure time, manual iris.</entry> 2689 </row> 2690 </tbody> 2691 </entrytbl> 2692 </row> 2693 <row><entry></entry></row> 2694 2695 <row> 2696 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_ABSOLUTE</constant> </entry> 2697 <entry>integer</entry> 2698 </row><row><entry spanname="descr">Determines the exposure 2699time of the camera sensor. The exposure time is limited by the frame 2700interval. Drivers should interpret the values as 100 µs units, 2701where the value 1 stands for 1/10000th of a second, 10000 for 1 second 2702and 100000 for 10 seconds.</entry> 2703 </row> 2704 <row><entry></entry></row> 2705 2706 <row> 2707 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO_PRIORITY</constant> </entry> 2708 <entry>boolean</entry> 2709 </row><row><entry spanname="descr">When 2710<constant>V4L2_CID_EXPOSURE_AUTO</constant> is set to 2711<constant>AUTO</constant> or <constant>APERTURE_PRIORITY</constant>, 2712this control determines if the device may dynamically vary the frame 2713rate. By default this feature is disabled (0) and the frame rate must 2714remain constant.</entry> 2715 </row> 2716 <row><entry></entry></row> 2717 2718 <row> 2719 <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant> </entry> 2720 <entry>integer</entry> 2721 </row><row><entry spanname="descr">This control turns the 2722camera horizontally by the specified amount. The unit is undefined. A 2723positive value moves the camera to the right (clockwise when viewed 2724from above), a negative value to the left. A value of zero does not 2725cause motion. This is a write-only control.</entry> 2726 </row> 2727 <row><entry></entry></row> 2728 2729 <row> 2730 <entry spanname="id"><constant>V4L2_CID_TILT_RELATIVE</constant> </entry> 2731 <entry>integer</entry> 2732 </row><row><entry spanname="descr">This control turns the 2733camera vertically by the specified amount. The unit is undefined. A 2734positive value moves the camera up, a negative value down. A value of 2735zero does not cause motion. This is a write-only control.</entry> 2736 </row> 2737 <row><entry></entry></row> 2738 2739 <row> 2740 <entry spanname="id"><constant>V4L2_CID_PAN_RESET</constant> </entry> 2741 <entry>button</entry> 2742 </row><row><entry spanname="descr">When this control is set, 2743the camera moves horizontally to the default position.</entry> 2744 </row> 2745 <row><entry></entry></row> 2746 2747 <row> 2748 <entry spanname="id"><constant>V4L2_CID_TILT_RESET</constant> </entry> 2749 <entry>button</entry> 2750 </row><row><entry spanname="descr">When this control is set, 2751the camera moves vertically to the default position.</entry> 2752 </row> 2753 <row><entry></entry></row> 2754 2755 <row> 2756 <entry spanname="id"><constant>V4L2_CID_PAN_ABSOLUTE</constant> </entry> 2757 <entry>integer</entry> 2758 </row><row><entry spanname="descr">This control 2759turns the camera horizontally to the specified position. Positive 2760values move the camera to the right (clockwise when viewed from above), 2761negative values to the left. Drivers should interpret the values as arc 2762seconds, with valid values between -180 * 3600 and +180 * 3600 2763inclusive.</entry> 2764 </row> 2765 <row><entry></entry></row> 2766 2767 <row> 2768 <entry spanname="id"><constant>V4L2_CID_TILT_ABSOLUTE</constant> </entry> 2769 <entry>integer</entry> 2770 </row><row><entry spanname="descr">This control 2771turns the camera vertically to the specified position. Positive values 2772move the camera up, negative values down. Drivers should interpret the 2773values as arc seconds, with valid values between -180 * 3600 and +180 2774* 3600 inclusive.</entry> 2775 </row> 2776 <row><entry></entry></row> 2777 2778 <row> 2779 <entry spanname="id"><constant>V4L2_CID_FOCUS_ABSOLUTE</constant> </entry> 2780 <entry>integer</entry> 2781 </row><row><entry spanname="descr">This control sets the 2782focal point of the camera to the specified position. The unit is 2783undefined. Positive values set the focus closer to the camera, 2784negative values towards infinity.</entry> 2785 </row> 2786 <row><entry></entry></row> 2787 2788 <row> 2789 <entry spanname="id"><constant>V4L2_CID_FOCUS_RELATIVE</constant> </entry> 2790 <entry>integer</entry> 2791 </row><row><entry spanname="descr">This control moves the 2792focal point of the camera by the specified amount. The unit is 2793undefined. Positive values move the focus closer to the camera, 2794negative values towards infinity. This is a write-only control.</entry> 2795 </row> 2796 <row><entry></entry></row> 2797 2798 <row> 2799 <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant> </entry> 2800 <entry>boolean</entry> 2801 </row><row><entry spanname="descr">Enables automatic focus 2802adjustments. The effect of manual focus adjustments while this feature 2803is enabled is undefined, drivers should ignore such requests.</entry> 2804 </row> 2805 <row><entry></entry></row> 2806 2807 <row> 2808 <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant> </entry> 2809 <entry>integer</entry> 2810 </row><row><entry spanname="descr">Specify the objective lens 2811focal length as an absolute value. The zoom unit is driver-specific and its 2812value should be a positive integer.</entry> 2813 </row> 2814 <row><entry></entry></row> 2815 2816 <row> 2817 <entry spanname="id"><constant>V4L2_CID_ZOOM_RELATIVE</constant> </entry> 2818 <entry>integer</entry> 2819 </row><row><entry spanname="descr">Specify the objective lens 2820focal length relatively to the current value. Positive values move the zoom 2821lens group towards the telephoto direction, negative values towards the 2822wide-angle direction. The zoom unit is driver-specific. This is a write-only control.</entry> 2823 </row> 2824 <row><entry></entry></row> 2825 2826 <row> 2827 <entry spanname="id"><constant>V4L2_CID_ZOOM_CONTINUOUS</constant> </entry> 2828 <entry>integer</entry> 2829 </row><row><entry spanname="descr">Move the objective lens group 2830at the specified speed until it reaches physical device limits or until an 2831explicit request to stop the movement. A positive value moves the zoom lens 2832group towards the telephoto direction. A value of zero stops the zoom lens 2833group movement. A negative value moves the zoom lens group towards the 2834wide-angle direction. The zoom speed unit is driver-specific.</entry> 2835 </row> 2836 <row><entry></entry></row> 2837 2838 <row> 2839 <entry spanname="id"><constant>V4L2_CID_IRIS_ABSOLUTE</constant> </entry> 2840 <entry>integer</entry> 2841 </row><row><entry spanname="descr">This control sets the 2842camera's aperture to the specified value. The unit is undefined. 2843Larger values open the iris wider, smaller values close it.</entry> 2844 </row> 2845 <row><entry></entry></row> 2846 2847 <row> 2848 <entry spanname="id"><constant>V4L2_CID_IRIS_RELATIVE</constant> </entry> 2849 <entry>integer</entry> 2850 </row><row><entry spanname="descr">This control modifies the 2851camera's aperture by the specified amount. The unit is undefined. 2852Positive values open the iris one step further, negative values close 2853it one step further. This is a write-only control.</entry> 2854 </row> 2855 <row><entry></entry></row> 2856 2857 <row> 2858 <entry spanname="id"><constant>V4L2_CID_PRIVACY</constant> </entry> 2859 <entry>boolean</entry> 2860 </row><row><entry spanname="descr">Prevent video from being acquired 2861by the camera. When this control is set to <constant>TRUE</constant> (1), no 2862image can be captured by the camera. Common means to enforce privacy are 2863mechanical obturation of the sensor and firmware image processing, but the 2864device is not restricted to these methods. Devices that implement the privacy 2865control must support read access and may support write access.</entry> 2866 </row> 2867 2868 <row> 2869 <entry spanname="id"><constant>V4L2_CID_BAND_STOP_FILTER</constant> </entry> 2870 <entry>integer</entry> 2871 </row><row><entry spanname="descr">Switch the band-stop filter of a 2872camera sensor on or off, or specify its strength. Such band-stop filters can 2873be used, for example, to filter out the fluorescent light component.</entry> 2874 </row> 2875 <row><entry></entry></row> 2876 </tbody> 2877 </tgroup> 2878 </table> 2879 </section> 2880 2881 <section id="fm-tx-controls"> 2882 <title>FM Transmitter Control Reference</title> 2883 2884 <para>The FM Transmitter (FM_TX) class includes controls for common features of 2885FM transmissions capable devices. Currently this class includes parameters for audio 2886compression, pilot tone generation, audio deviation limiter, RDS transmission and 2887tuning power features.</para> 2888 2889 <table pgwide="1" frame="none" id="fm-tx-control-id"> 2890 <title>FM_TX Control IDs</title> 2891 2892 <tgroup cols="4"> 2893 <colspec colname="c1" colwidth="1*" /> 2894 <colspec colname="c2" colwidth="6*" /> 2895 <colspec colname="c3" colwidth="2*" /> 2896 <colspec colname="c4" colwidth="6*" /> 2897 <spanspec namest="c1" nameend="c2" spanname="id" /> 2898 <spanspec namest="c2" nameend="c4" spanname="descr" /> 2899 <thead> 2900 <row> 2901 <entry spanname="id" align="left">ID</entry> 2902 <entry align="left">Type</entry> 2903 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> 2904 </row> 2905 </thead> 2906 <tbody valign="top"> 2907 <row><entry></entry></row> 2908 <row> 2909 <entry spanname="id"><constant>V4L2_CID_FM_TX_CLASS</constant> </entry> 2910 <entry>class</entry> 2911 </row><row><entry spanname="descr">The FM_TX class 2912descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a 2913description of this control class.</entry> 2914 </row> 2915 <row> 2916 <entry spanname="id"><constant>V4L2_CID_RDS_TX_DEVIATION</constant> </entry> 2917 <entry>integer</entry> 2918 </row> 2919 <row><entry spanname="descr">Configures RDS signal frequency deviation level in Hz. 2920The range and step are driver-specific.</entry> 2921 </row> 2922 <row> 2923 <entry spanname="id"><constant>V4L2_CID_RDS_TX_PI</constant> </entry> 2924 <entry>integer</entry> 2925 </row> 2926 <row><entry spanname="descr">Sets the RDS Programme Identification field 2927for transmission.</entry> 2928 </row> 2929 <row> 2930 <entry spanname="id"><constant>V4L2_CID_RDS_TX_PTY</constant> </entry> 2931 <entry>integer</entry> 2932 </row> 2933 <row><entry spanname="descr">Sets the RDS Programme Type field for transmission. 2934This encodes up to 31 pre-defined programme types.</entry> 2935 </row> 2936 <row> 2937 <entry spanname="id"><constant>V4L2_CID_RDS_TX_PS_NAME</constant> </entry> 2938 <entry>string</entry> 2939 </row> 2940 <row><entry spanname="descr">Sets the Programme Service name (PS_NAME) for transmission. 2941It is intended for static display on a receiver. It is the primary aid to listeners in programme service 2942identification and selection. In Annex E of <xref linkend="en50067" />, the RDS specification, 2943there is a full description of the correct character encoding for Programme Service name strings. 2944Also from RDS specification, PS is usually a single eight character text. However, it is also possible 2945to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured 2946with steps of 8 characters. The result is it must always contain a string with size multiple of 8.</entry> 2947 </row> 2948 <row> 2949 <entry spanname="id"><constant>V4L2_CID_RDS_TX_RADIO_TEXT</constant> </entry> 2950 <entry>string</entry> 2951 </row> 2952 <row><entry spanname="descr">Sets the Radio Text info for transmission. It is a textual description of 2953what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names, 2954programme-related information or any other text. In these cases, RadioText should be used in addition to 2955<constant>V4L2_CID_RDS_TX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described 2956in Annex E of <xref linkend="en50067" />. The length of Radio Text strings depends on which RDS Block is being 2957used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible 2958to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured 2959with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry> 2960 </row> 2961 <row> 2962 <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_ENABLED</constant> </entry> 2963 <entry>boolean</entry> 2964 </row> 2965 <row><entry spanname="descr">Enables or disables the audio deviation limiter feature. 2966The limiter is useful when trying to maximize the audio volume, minimize receiver-generated 2967distortion and prevent overmodulation. 2968</entry> 2969 </row> 2970 <row> 2971 <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_RELEASE_TIME</constant> </entry> 2972 <entry>integer</entry> 2973 </row> 2974 <row><entry spanname="descr">Sets the audio deviation limiter feature release time. 2975Unit is in useconds. Step and range are driver-specific.</entry> 2976 </row> 2977 <row> 2978 <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_DEVIATION</constant> </entry> 2979 <entry>integer</entry> 2980 </row> 2981 <row><entry spanname="descr">Configures audio frequency deviation level in Hz. 2982The range and step are driver-specific.</entry> 2983 </row> 2984 <row> 2985 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ENABLED</constant> </entry> 2986 <entry>boolean</entry> 2987 </row> 2988 <row><entry spanname="descr">Enables or disables the audio compression feature. 2989This feature amplifies signals below the threshold by a fixed gain and compresses audio 2990signals above the threshold by the ratio of Threshold/(Gain + Threshold).</entry> 2991 </row> 2992 <row> 2993 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_GAIN</constant> </entry> 2994 <entry>integer</entry> 2995 </row> 2996 <row><entry spanname="descr">Sets the gain for audio compression feature. It is 2997a dB value. The range and step are driver-specific.</entry> 2998 </row> 2999 <row> 3000 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_THRESHOLD</constant> </entry> 3001 <entry>integer</entry> 3002 </row> 3003 <row><entry spanname="descr">Sets the threshold level for audio compression freature. 3004It is a dB value. The range and step are driver-specific.</entry> 3005 </row> 3006 <row> 3007 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME</constant> </entry> 3008 <entry>integer</entry> 3009 </row> 3010 <row><entry spanname="descr">Sets the attack time for audio compression feature. 3011It is a useconds value. The range and step are driver-specific.</entry> 3012 </row> 3013 <row> 3014 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME</constant> </entry> 3015 <entry>integer</entry> 3016 </row> 3017 <row><entry spanname="descr">Sets the release time for audio compression feature. 3018It is a useconds value. The range and step are driver-specific.</entry> 3019 </row> 3020 <row> 3021 <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_ENABLED</constant> </entry> 3022 <entry>boolean</entry> 3023 </row> 3024 <row><entry spanname="descr">Enables or disables the pilot tone generation feature.</entry> 3025 </row> 3026 <row> 3027 <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_DEVIATION</constant> </entry> 3028 <entry>integer</entry> 3029 </row> 3030 <row><entry spanname="descr">Configures pilot tone frequency deviation level. Unit is 3031in Hz. The range and step are driver-specific.</entry> 3032 </row> 3033 <row> 3034 <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_FREQUENCY</constant> </entry> 3035 <entry>integer</entry> 3036 </row> 3037 <row><entry spanname="descr">Configures pilot tone frequency value. Unit is 3038in Hz. The range and step are driver-specific.</entry> 3039 </row> 3040 <row> 3041 <entry spanname="id"><constant>V4L2_CID_TUNE_PREEMPHASIS</constant> </entry> 3042 <entry>integer</entry> 3043 </row> 3044 <row id="v4l2-preemphasis"><entry spanname="descr">Configures the pre-emphasis value for broadcasting. 3045A pre-emphasis filter is applied to the broadcast to accentuate the high audio frequencies. 3046Depending on the region, a time constant of either 50 or 75 useconds is used. The enum v4l2_preemphasis 3047defines possible values for pre-emphasis. Here they are:</entry> 3048 </row><row> 3049 <entrytbl spanname="descr" cols="2"> 3050 <tbody valign="top"> 3051 <row> 3052 <entry><constant>V4L2_PREEMPHASIS_DISABLED</constant> </entry> 3053 <entry>No pre-emphasis is applied.</entry> 3054 </row> 3055 <row> 3056 <entry><constant>V4L2_PREEMPHASIS_50_uS</constant> </entry> 3057 <entry>A pre-emphasis of 50 uS is used.</entry> 3058 </row> 3059 <row> 3060 <entry><constant>V4L2_PREEMPHASIS_75_uS</constant> </entry> 3061 <entry>A pre-emphasis of 75 uS is used.</entry> 3062 </row> 3063 </tbody> 3064 </entrytbl> 3065 3066 </row> 3067 <row> 3068 <entry spanname="id"><constant>V4L2_CID_TUNE_POWER_LEVEL</constant> </entry> 3069 <entry>integer</entry> 3070 </row> 3071 <row><entry spanname="descr">Sets the output power level for signal transmission. 3072Unit is in dBuV. Range and step are driver-specific.</entry> 3073 </row> 3074 <row> 3075 <entry spanname="id"><constant>V4L2_CID_TUNE_ANTENNA_CAPACITOR</constant> </entry> 3076 <entry>integer</entry> 3077 </row> 3078 <row><entry spanname="descr">This selects the value of antenna tuning capacitor 3079manually or automatically if set to zero. Unit, range and step are driver-specific.</entry> 3080 </row> 3081 <row><entry></entry></row> 3082 </tbody> 3083 </tgroup> 3084 </table> 3085 3086<para>For more details about RDS specification, refer to 3087<xref linkend="en50067" /> document, from CENELEC.</para> 3088 </section> 3089 3090 <section id="flash-controls"> 3091 <title>Flash Control Reference</title> 3092 3093 <note> 3094 <title>Experimental</title> 3095 3096 <para>This is an <link linkend="experimental">experimental</link> 3097interface and may change in the future.</para> 3098 </note> 3099 3100 <para> 3101 The V4L2 flash controls are intended to provide generic access 3102 to flash controller devices. Flash controller devices are 3103 typically used in digital cameras. 3104 </para> 3105 3106 <para> 3107 The interface can support both LED and xenon flash devices. As 3108 of writing this, there is no xenon flash driver using this 3109 interface. 3110 </para> 3111 3112 <section id="flash-controls-use-cases"> 3113 <title>Supported use cases</title> 3114 3115 <section> 3116 <title>Unsynchronised LED flash (software strobe)</title> 3117 3118 <para> 3119 Unsynchronised LED flash is controlled directly by the 3120 host as the sensor. The flash must be enabled by the host 3121 before the exposure of the image starts and disabled once 3122 it ends. The host is fully responsible for the timing of 3123 the flash. 3124 </para> 3125 3126 <para>Example of such device: Nokia N900.</para> 3127 </section> 3128 3129 <section> 3130 <title>Synchronised LED flash (hardware strobe)</title> 3131 3132 <para> 3133 The synchronised LED flash is pre-programmed by the host 3134 (power and timeout) but controlled by the sensor through a 3135 strobe signal from the sensor to the flash. 3136 </para> 3137 3138 <para> 3139 The sensor controls the flash duration and timing. This 3140 information typically must be made available to the 3141 sensor. 3142 </para> 3143 3144 </section> 3145 3146 <section> 3147 <title>LED flash as torch</title> 3148 3149 <para> 3150 LED flash may be used as torch in conjunction with another 3151 use case involving camera or individually. 3152 </para> 3153 3154 </section> 3155 3156 </section> 3157 3158 <table pgwide="1" frame="none" id="flash-control-id"> 3159 <title>Flash Control IDs</title> 3160 3161 <tgroup cols="4"> 3162 <colspec colname="c1" colwidth="1*" /> 3163 <colspec colname="c2" colwidth="6*" /> 3164 <colspec colname="c3" colwidth="2*" /> 3165 <colspec colname="c4" colwidth="6*" /> 3166 <spanspec namest="c1" nameend="c2" spanname="id" /> 3167 <spanspec namest="c2" nameend="c4" spanname="descr" /> 3168 <thead> 3169 <row> 3170 <entry spanname="id" align="left">ID</entry> 3171 <entry align="left">Type</entry> 3172 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry> 3173 </row> 3174 </thead> 3175 <tbody valign="top"> 3176 <row><entry></entry></row> 3177 <row> 3178 <entry spanname="id"><constant>V4L2_CID_FLASH_CLASS</constant></entry> 3179 <entry>class</entry> 3180 </row> 3181 <row> 3182 <entry spanname="descr">The FLASH class descriptor.</entry> 3183 </row> 3184 <row> 3185 <entry spanname="id"><constant>V4L2_CID_FLASH_LED_MODE</constant></entry> 3186 <entry>menu</entry> 3187 </row> 3188 <row id="v4l2-flash-led-mode"> 3189 <entry spanname="descr">Defines the mode of the flash LED, 3190 the high-power white LED attached to the flash controller. 3191 Setting this control may not be possible in presence of 3192 some faults. See V4L2_CID_FLASH_FAULT.</entry> 3193 </row> 3194 <row> 3195 <entrytbl spanname="descr" cols="2"> 3196 <tbody valign="top"> 3197 <row> 3198 <entry><constant>V4L2_FLASH_LED_MODE_NONE</constant></entry> 3199 <entry>Off.</entry> 3200 </row> 3201 <row> 3202 <entry><constant>V4L2_FLASH_LED_MODE_FLASH</constant></entry> 3203 <entry>Flash mode.</entry> 3204 </row> 3205 <row> 3206 <entry><constant>V4L2_FLASH_LED_MODE_TORCH</constant></entry> 3207 <entry>Torch mode. See V4L2_CID_FLASH_TORCH_INTENSITY.</entry> 3208 </row> 3209 </tbody> 3210 </entrytbl> 3211 </row> 3212 <row> 3213 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_SOURCE</constant></entry> 3214 <entry>menu</entry> 3215 </row> 3216 <row id="v4l2-flash-strobe-source"><entry 3217 spanname="descr">Defines the source of the flash LED 3218 strobe.</entry> 3219 </row> 3220 <row> 3221 <entrytbl spanname="descr" cols="2"> 3222 <tbody valign="top"> 3223 <row> 3224 <entry><constant>V4L2_FLASH_STROBE_SOURCE_SOFTWARE</constant></entry> 3225 <entry>The flash strobe is triggered by using 3226 the V4L2_CID_FLASH_STROBE control.</entry> 3227 </row> 3228 <row> 3229 <entry><constant>V4L2_FLASH_STROBE_SOURCE_EXTERNAL</constant></entry> 3230 <entry>The flash strobe is triggered by an 3231 external source. Typically this is a sensor, 3232 which makes it possible to synchronises the 3233 flash strobe start to exposure start.</entry> 3234 </row> 3235 </tbody> 3236 </entrytbl> 3237 </row> 3238 <row> 3239 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE</constant></entry> 3240 <entry>button</entry> 3241 </row> 3242 <row> 3243 <entry spanname="descr">Strobe flash. Valid when 3244 V4L2_CID_FLASH_LED_MODE is set to 3245 V4L2_FLASH_LED_MODE_FLASH and V4L2_CID_FLASH_STROBE_SOURCE 3246 is set to V4L2_FLASH_STROBE_SOURCE_SOFTWARE. Setting this 3247 control may not be possible in presence of some faults. 3248 See V4L2_CID_FLASH_FAULT.</entry> 3249 </row> 3250 <row> 3251 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STOP</constant></entry> 3252 <entry>button</entry> 3253 </row> 3254 <row><entry spanname="descr">Stop flash strobe immediately.</entry> 3255 </row> 3256 <row> 3257 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STATUS</constant></entry> 3258 <entry>boolean</entry> 3259 </row> 3260 <row> 3261 <entry spanname="descr">Strobe status: whether the flash 3262 is strobing at the moment or not. This is a read-only 3263 control.</entry> 3264 </row> 3265 <row> 3266 <entry spanname="id"><constant>V4L2_CID_FLASH_TIMEOUT</constant></entry> 3267 <entry>integer</entry> 3268 </row> 3269 <row> 3270 <entry spanname="descr">Hardware timeout for flash. The 3271 flash strobe is stopped after this period of time has 3272 passed from the start of the strobe.</entry> 3273 </row> 3274 <row> 3275 <entry spanname="id"><constant>V4L2_CID_FLASH_INTENSITY</constant></entry> 3276 <entry>integer</entry> 3277 </row> 3278 <row> 3279 <entry spanname="descr">Intensity of the flash strobe when 3280 the flash LED is in flash mode 3281 (V4L2_FLASH_LED_MODE_FLASH). The unit should be milliamps 3282 (mA) if possible.</entry> 3283 </row> 3284 <row> 3285 <entry spanname="id"><constant>V4L2_CID_FLASH_TORCH_INTENSITY</constant></entry> 3286 <entry>integer</entry> 3287 </row> 3288 <row> 3289 <entry spanname="descr">Intensity of the flash LED in 3290 torch mode (V4L2_FLASH_LED_MODE_TORCH). The unit should be 3291 milliamps (mA) if possible. Setting this control may not 3292 be possible in presence of some faults. See 3293 V4L2_CID_FLASH_FAULT.</entry> 3294 </row> 3295 <row> 3296 <entry spanname="id"><constant>V4L2_CID_FLASH_INDICATOR_INTENSITY</constant></entry> 3297 <entry>integer</entry> 3298 </row> 3299 <row> 3300 <entry spanname="descr">Intensity of the indicator LED. 3301 The indicator LED may be fully independent of the flash 3302 LED. The unit should be microamps (uA) if possible.</entry> 3303 </row> 3304 <row> 3305 <entry spanname="id"><constant>V4L2_CID_FLASH_FAULT</constant></entry> 3306 <entry>bitmask</entry> 3307 </row> 3308 <row> 3309 <entry spanname="descr">Faults related to the flash. The 3310 faults tell about specific problems in the flash chip 3311 itself or the LEDs attached to it. Faults may prevent 3312 further use of some of the flash controls. In particular, 3313 V4L2_CID_FLASH_LED_MODE is set to V4L2_FLASH_LED_MODE_NONE 3314 if the fault affects the flash LED. Exactly which faults 3315 have such an effect is chip dependent. Reading the faults 3316 resets the control and returns the chip to a usable state 3317 if possible.</entry> 3318 </row> 3319 <row> 3320 <entrytbl spanname="descr" cols="2"> 3321 <tbody valign="top"> 3322 <row> 3323 <entry><constant>V4L2_FLASH_FAULT_OVER_VOLTAGE</constant></entry> 3324 <entry>Flash controller voltage to the flash LED 3325 has exceeded the limit specific to the flash 3326 controller.</entry> 3327 </row> 3328 <row> 3329 <entry><constant>V4L2_FLASH_FAULT_TIMEOUT</constant></entry> 3330 <entry>The flash strobe was still on when 3331 the timeout set by the user --- 3332 V4L2_CID_FLASH_TIMEOUT control --- has expired. 3333 Not all flash controllers may set this in all 3334 such conditions.</entry> 3335 </row> 3336 <row> 3337 <entry><constant>V4L2_FLASH_FAULT_OVER_TEMPERATURE</constant></entry> 3338 <entry>The flash controller has overheated.</entry> 3339 </row> 3340 <row> 3341 <entry><constant>V4L2_FLASH_FAULT_SHORT_CIRCUIT</constant></entry> 3342 <entry>The short circuit protection of the flash 3343 controller has been triggered.</entry> 3344 </row> 3345 <row> 3346 <entry><constant>V4L2_FLASH_FAULT_OVER_CURRENT</constant></entry> 3347 <entry>Current in the LED power supply has exceeded the limit 3348 specific to the flash controller.</entry> 3349 </row> 3350 <row> 3351 <entry><constant>V4L2_FLASH_FAULT_INDICATOR</constant></entry> 3352 <entry>The flash controller has detected a short or open 3353 circuit condition on the indicator LED.</entry> 3354 </row> 3355 </tbody> 3356 </entrytbl> 3357 </row> 3358 <row> 3359 <entry spanname="id"><constant>V4L2_CID_FLASH_CHARGE</constant></entry> 3360 <entry>boolean</entry> 3361 </row> 3362 <row><entry spanname="descr">Enable or disable charging of the xenon 3363 flash capacitor.</entry> 3364 </row> 3365 <row> 3366 <entry spanname="id"><constant>V4L2_CID_FLASH_READY</constant></entry> 3367 <entry>boolean</entry> 3368 </row> 3369 <row> 3370 <entry spanname="descr">Is the flash ready to strobe? 3371 Xenon flashes require their capacitors charged before 3372 strobing. LED flashes often require a cooldown period 3373 after strobe during which another strobe will not be 3374 possible. This is a read-only control.</entry> 3375 </row> 3376 <row><entry></entry></row> 3377 </tbody> 3378 </tgroup> 3379 </table> 3380 3381 </section> 3382</section> 3383