blob: 8fccfe1b20582a4130926a15f9248ccb10fe1e84 [file] [log] [blame]
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001 <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 &eg; 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
Sakari Ailus0f427212011-07-04 05:37:21 -030054 <para>
55 All controls use machine endianness.
56 </para>
57
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -030058 <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),
Sylwester Nawrockid26a6632011-09-04 19:08:54 -0300235<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>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300238 </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>
Devin Heitmueller7a01f6d2010-03-11 21:27:59 -0300275 <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>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300281 <entry><constant>V4L2_CID_COLOR_KILLER</constant></entry>
282 <entry>boolean</entry>
283 <entry>Enable the color killer (&ie; force a black &amp; 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>
Sylwester Nawrocki6491d1a2012-04-02 06:40:19 -0300288 <entry>Selects a color effect. The following values are defined:
289 </entry>
290 </row><row>
291 <entry></entry>
292 <entry></entry>
293 <entrytbl spanname="descr" cols="2">
294 <tbody valign="top">
295 <row>
296 <entry><constant>V4L2_COLORFX_NONE</constant>&nbsp;</entry>
297 <entry>Color effect is disabled.</entry>
298 </row>
299 <row>
300 <entry><constant>V4L2_COLORFX_ANTIQUE</constant>&nbsp;</entry>
301 <entry>An aging (old photo) effect.</entry>
302 </row>
303 <row>
304 <entry><constant>V4L2_COLORFX_ART_FREEZE</constant>&nbsp;</entry>
305 <entry>Frost color effect.</entry>
306 </row>
307 <row>
308 <entry><constant>V4L2_COLORFX_AQUA</constant>&nbsp;</entry>
309 <entry>Water color, cool tone.</entry>
310 </row>
311 <row>
312 <entry><constant>V4L2_COLORFX_BW</constant>&nbsp;</entry>
313 <entry>Black and white.</entry>
314 </row>
315 <row>
316 <entry><constant>V4L2_COLORFX_EMBOSS</constant>&nbsp;</entry>
317 <entry>Emboss, the highlights and shadows replace light/dark boundaries
318 and low contrast areas are set to a gray background.</entry>
319 </row>
320 <row>
321 <entry><constant>V4L2_COLORFX_GRASS_GREEN</constant>&nbsp;</entry>
322 <entry>Grass green.</entry>
323 </row>
324 <row>
325 <entry><constant>V4L2_COLORFX_NEGATIVE</constant>&nbsp;</entry>
326 <entry>Negative.</entry>
327 </row>
328 <row>
329 <entry><constant>V4L2_COLORFX_SEPIA</constant>&nbsp;</entry>
330 <entry>Sepia tone.</entry>
331 </row>
332 <row>
333 <entry><constant>V4L2_COLORFX_SKETCH</constant>&nbsp;</entry>
334 <entry>Sketch.</entry>
335 </row>
336 <row>
337 <entry><constant>V4L2_COLORFX_SKIN_WHITEN</constant>&nbsp;</entry>
338 <entry>Skin whiten.</entry>
339 </row>
340 <row>
341 <entry><constant>V4L2_COLORFX_SKY_BLUE</constant>&nbsp;</entry>
342 <entry>Sky blue.</entry>
343 </row>
344 <row>
345 <entry><constant>V4L2_COLORFX_SOLARIZATION</constant>&nbsp;</entry>
346 <entry>Solarization, the image is partially reversed in tone,
347 only color values above or below a certain threshold are inverted.
348 </entry>
349 </row>
350 <row>
351 <entry><constant>V4L2_COLORFX_SILHOUETTE</constant>&nbsp;</entry>
352 <entry>Silhouette (outline).</entry>
353 </row>
354 <row>
355 <entry><constant>V4L2_COLORFX_VIVID</constant>&nbsp;</entry>
356 <entry>Vivid colors.</entry>
357 </row>
358 <row>
359 <entry><constant>V4L2_COLORFX_SET_CBCR</constant>&nbsp;</entry>
360 <entry>The Cb and Cr chroma components are replaced by fixed
361 coefficients determined by <constant>V4L2_CID_COLORFX_CBCR</constant>
362 control.</entry>
363 </row>
364 </tbody>
365 </entrytbl>
366 </row>
367 <row>
368 <entry><constant>V4L2_CID_COLORFX_CBCR</constant></entry>
369 <entry>integer</entry>
370 <entry>Determines the Cb and Cr coefficients for <constant>V4L2_COLORFX_SET_CBCR</constant>
371 color effect. Bits [7:0] of the supplied 32 bit value are interpreted as
372 Cr component, bits [15:8] as Cb component and bits [31:16] must be zero.
373 </entry>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300374 </row>
375 <row>
Vaibhav Hiremathbd977802009-11-09 10:04:06 -0300376 <entry><constant>V4L2_CID_ROTATE</constant></entry>
377 <entry>integer</entry>
378 <entry>Rotates the image by specified angle. Common angles are 90,
379 270 and 180. Rotating the image to 90 and 270 will reverse the height
380 and width of the display window. It is necessary to set the new height and
381 width of the picture using the &VIDIOC-S-FMT; ioctl according to
382 the rotation angle selected.</entry>
383 </row>
384 <row>
385 <entry><constant>V4L2_CID_BG_COLOR</constant></entry>
386 <entry>integer</entry>
387 <entry>Sets the background color on the current output device.
388 Background color needs to be specified in the RGB24 format. The
389 supplied 32 bit value is interpreted as bits 0-7 Red color information,
390 bits 8-15 Green color information, bits 16-23 Blue color
391 information and bits 24-31 must be zero.</entry>
392 </row>
393 <row>
Jean-François Moine008d35f2010-09-13 07:04:49 -0300394 <entry><constant>V4L2_CID_ILLUMINATORS_1</constant>
395 <constant>V4L2_CID_ILLUMINATORS_2</constant></entry>
396 <entry>boolean</entry>
397 <entry>Switch on or off the illuminator 1 or 2 of the device
398 (usually a microscope).</entry>
399 </row>
400 <row>
Kamil Debskie65e4f12011-06-14 10:31:04 -0300401 <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_CAPTURE</constant></entry>
402 <entry>integer</entry>
403 <entry>This is a read-only control that can be read by the application
404and used as a hint to determine the number of CAPTURE buffers to pass to REQBUFS.
405The value is the minimum number of CAPTURE buffers that is necessary for hardware
406to work.</entry>
407 </row>
408 <row>
409 <entry><constant>V4L2_CID_MIN_BUFFERS_FOR_OUTPUT</constant></entry>
410 <entry>integer</entry>
411 <entry>This is a read-only control that can be read by the application
412and used as a hint to determine the number of OUTPUT buffers to pass to REQBUFS.
413The value is the minimum number of OUTPUT buffers that is necessary for hardware
414to work.</entry>
415 </row>
Sylwester Nawrockicc1d3272011-11-14 08:48:18 -0300416 <row id="v4l2-alpha-component">
417 <entry><constant>V4L2_CID_ALPHA_COMPONENT</constant></entry>
418 <entry>integer</entry>
419 <entry> Sets the alpha color component on the capture device or on
420 the capture buffer queue of a mem-to-mem device. When a mem-to-mem
421 device produces frame format that includes an alpha component
422 (e.g. <link linkend="rgb-formats">packed RGB image formats</link>)
423 and the alpha value is not defined by the mem-to-mem input data
424 this control lets you select the alpha component value of all
425 pixels. It is applicable to any pixel format that contains an alpha
426 component.
427 </entry>
428 </row>
429 <row>
430 <entry><constant>V4L2_CID_LASTP1</constant></entry>
431 <entry></entry>
432 <entry>End of the predefined control IDs (currently
433 <constant>V4L2_CID_ALPHA_COMPONENT</constant> + 1).</entry>
434 </row>
Kamil Debskie65e4f12011-06-14 10:31:04 -0300435 <row>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300436 <entry><constant>V4L2_CID_PRIVATE_BASE</constant></entry>
437 <entry></entry>
438 <entry>ID of the first custom (driver specific) control.
439Applications depending on particular custom controls should check the
440driver name and version, see <xref linkend="querycap" />.</entry>
441 </row>
442 </tbody>
443 </tgroup>
444 </table>
445
446 <para>Applications can enumerate the available controls with the
447&VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls, get and set a
448control value with the &VIDIOC-G-CTRL; and &VIDIOC-S-CTRL; ioctls.
449Drivers must implement <constant>VIDIOC_QUERYCTRL</constant>,
450<constant>VIDIOC_G_CTRL</constant> and
451<constant>VIDIOC_S_CTRL</constant> when the device has one or more
452controls, <constant>VIDIOC_QUERYMENU</constant> when it has one or
453more menu type controls.</para>
454
455 <example>
456 <title>Enumerating all controls</title>
457
458 <programlisting>
459&v4l2-queryctrl; queryctrl;
460&v4l2-querymenu; querymenu;
461
462static void
463enumerate_menu (void)
464{
465 printf (" Menu items:\n");
466
467 memset (&amp;querymenu, 0, sizeof (querymenu));
468 querymenu.id = queryctrl.id;
469
470 for (querymenu.index = queryctrl.minimum;
471 querymenu.index &lt;= queryctrl.maximum;
472 querymenu.index++) {
473 if (0 == ioctl (fd, &VIDIOC-QUERYMENU;, &amp;querymenu)) {
474 printf (" %s\n", querymenu.name);
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300475 }
476 }
477}
478
479memset (&amp;queryctrl, 0, sizeof (queryctrl));
480
481for (queryctrl.id = V4L2_CID_BASE;
482 queryctrl.id &lt; V4L2_CID_LASTP1;
483 queryctrl.id++) {
484 if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
485 if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
486 continue;
487
488 printf ("Control %s\n", queryctrl.name);
489
490 if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
491 enumerate_menu ();
492 } else {
493 if (errno == EINVAL)
494 continue;
495
496 perror ("VIDIOC_QUERYCTRL");
497 exit (EXIT_FAILURE);
498 }
499}
500
501for (queryctrl.id = V4L2_CID_PRIVATE_BASE;;
502 queryctrl.id++) {
503 if (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
504 if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED)
505 continue;
506
507 printf ("Control %s\n", queryctrl.name);
508
509 if (queryctrl.type == V4L2_CTRL_TYPE_MENU)
510 enumerate_menu ();
511 } else {
512 if (errno == EINVAL)
513 break;
514
515 perror ("VIDIOC_QUERYCTRL");
516 exit (EXIT_FAILURE);
517 }
518}
519</programlisting>
520 </example>
521
522 <example>
523 <title>Changing controls</title>
524
525 <programlisting>
526&v4l2-queryctrl; queryctrl;
527&v4l2-control; control;
528
529memset (&amp;queryctrl, 0, sizeof (queryctrl));
530queryctrl.id = V4L2_CID_BRIGHTNESS;
531
532if (-1 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;queryctrl)) {
533 if (errno != EINVAL) {
534 perror ("VIDIOC_QUERYCTRL");
535 exit (EXIT_FAILURE);
536 } else {
537 printf ("V4L2_CID_BRIGHTNESS is not supported\n");
538 }
539} else if (queryctrl.flags &amp; V4L2_CTRL_FLAG_DISABLED) {
540 printf ("V4L2_CID_BRIGHTNESS is not supported\n");
541} else {
542 memset (&amp;control, 0, sizeof (control));
543 control.id = V4L2_CID_BRIGHTNESS;
544 control.value = queryctrl.default_value;
545
546 if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &amp;control)) {
547 perror ("VIDIOC_S_CTRL");
548 exit (EXIT_FAILURE);
549 }
550}
551
552memset (&amp;control, 0, sizeof (control));
553control.id = V4L2_CID_CONTRAST;
554
555if (0 == ioctl (fd, &VIDIOC-G-CTRL;, &amp;control)) {
556 control.value += 1;
557
558 /* The driver may clamp the value or return ERANGE, ignored here */
559
560 if (-1 == ioctl (fd, &VIDIOC-S-CTRL;, &amp;control)
561 &amp;&amp; errno != ERANGE) {
562 perror ("VIDIOC_S_CTRL");
563 exit (EXIT_FAILURE);
564 }
565/* Ignore if V4L2_CID_CONTRAST is unsupported */
566} else if (errno != EINVAL) {
567 perror ("VIDIOC_G_CTRL");
568 exit (EXIT_FAILURE);
569}
570
571control.id = V4L2_CID_AUDIO_MUTE;
572control.value = TRUE; /* silence */
573
574/* Errors ignored */
575ioctl (fd, VIDIOC_S_CTRL, &amp;control);
576</programlisting>
577 </example>
578 </section>
579
580 <section id="extended-controls">
581 <title>Extended Controls</title>
582
583 <section>
584 <title>Introduction</title>
585
586 <para>The control mechanism as originally designed was meant
587to be used for user settings (brightness, saturation, etc). However,
588it turned out to be a very useful model for implementing more
589complicated driver APIs where each driver implements only a subset of
590a larger API.</para>
591
592 <para>The MPEG encoding API was the driving force behind
593designing and implementing this extended control mechanism: the MPEG
594standard is quite large and the currently supported hardware MPEG
595encoders each only implement a subset of this standard. Further more,
596many parameters relating to how the video is encoded into an MPEG
597stream are specific to the MPEG encoding chip since the MPEG standard
598only defines the format of the resulting MPEG stream, not how the
599video is actually encoded into that format.</para>
600
601 <para>Unfortunately, the original control API lacked some
602features needed for these new uses and so it was extended into the
603(not terribly originally named) extended control API.</para>
604
605 <para>Even though the MPEG encoding API was the first effort
606to use the Extended Control API, nowadays there are also other classes
607of Extended Controls, such as Camera Controls and FM Transmitter Controls.
608The Extended Controls API as well as all Extended Controls classes are
609described in the following text.</para>
610 </section>
611
612 <section>
613 <title>The Extended Control API</title>
614
615 <para>Three new ioctls are available: &VIDIOC-G-EXT-CTRLS;,
616&VIDIOC-S-EXT-CTRLS; and &VIDIOC-TRY-EXT-CTRLS;. These ioctls act on
617arrays of controls (as opposed to the &VIDIOC-G-CTRL; and
618&VIDIOC-S-CTRL; ioctls that act on a single control). This is needed
619since it is often required to atomically change several controls at
620once.</para>
621
622 <para>Each of the new ioctls expects a pointer to a
623&v4l2-ext-controls;. This structure contains a pointer to the control
624array, a count of the number of controls in that array and a control
625class. Control classes are used to group similar controls into a
626single class. For example, control class
627<constant>V4L2_CTRL_CLASS_USER</constant> contains all user controls
628(&ie; all controls that can also be set using the old
629<constant>VIDIOC_S_CTRL</constant> ioctl). Control class
630<constant>V4L2_CTRL_CLASS_MPEG</constant> contains all controls
631relating to MPEG encoding, etc.</para>
632
633 <para>All controls in the control array must belong to the
634specified control class. An error is returned if this is not the
635case.</para>
636
637 <para>It is also possible to use an empty control array (count
638== 0) to check whether the specified control class is
639supported.</para>
640
641 <para>The control array is a &v4l2-ext-control; array. The
642<structname>v4l2_ext_control</structname> structure is very similar to
643&v4l2-control;, except for the fact that it also allows for 64-bit
644values and pointers to be passed.</para>
645
646 <para>It is important to realize that due to the flexibility of
647controls it is necessary to check whether the control you want to set
648actually is supported in the driver and what the valid range of values
649is. So use the &VIDIOC-QUERYCTRL; and &VIDIOC-QUERYMENU; ioctls to
650check this. Also note that it is possible that some of the menu
651indices in a control of type <constant>V4L2_CTRL_TYPE_MENU</constant>
652may not be supported (<constant>VIDIOC_QUERYMENU</constant> will
653return an error). A good example is the list of supported MPEG audio
654bitrates. Some drivers only support one or two bitrates, others
655support a wider range.</para>
Sakari Ailus0f427212011-07-04 05:37:21 -0300656
657 <para>
658 All controls use machine endianness.
659 </para>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300660 </section>
661
662 <section>
663 <title>Enumerating Extended Controls</title>
664
665 <para>The recommended way to enumerate over the extended
666controls is by using &VIDIOC-QUERYCTRL; in combination with the
667<constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag:</para>
668
669 <informalexample>
670 <programlisting>
671&v4l2-queryctrl; qctrl;
672
673qctrl.id = V4L2_CTRL_FLAG_NEXT_CTRL;
674while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
675 /* ... */
676 qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
677}
678</programlisting>
679 </informalexample>
680
681 <para>The initial control ID is set to 0 ORed with the
682<constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> flag. The
683<constant>VIDIOC_QUERYCTRL</constant> ioctl will return the first
684control with a higher ID than the specified one. When no such controls
685are found an error is returned.</para>
686
687 <para>If you want to get all controls within a specific control
688class, then you can set the initial
689<structfield>qctrl.id</structfield> value to the control class and add
690an extra check to break out of the loop when a control of another
691control class is found:</para>
692
693 <informalexample>
694 <programlisting>
695qctrl.id = V4L2_CTRL_CLASS_MPEG | V4L2_CTRL_FLAG_NEXT_CTRL;
696while (0 == ioctl (fd, &VIDIOC-QUERYCTRL;, &amp;qctrl)) {
697 if (V4L2_CTRL_ID2CLASS (qctrl.id) != V4L2_CTRL_CLASS_MPEG)
698 break;
699 /* ... */
700 qctrl.id |= V4L2_CTRL_FLAG_NEXT_CTRL;
701 }
702</programlisting>
703 </informalexample>
704
705 <para>The 32-bit <structfield>qctrl.id</structfield> value is
706subdivided into three bit ranges: the top 4 bits are reserved for
707flags (&eg; <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>) and are not
708actually part of the ID. The remaining 28 bits form the control ID, of
709which the most significant 12 bits define the control class and the
710least significant 16 bits identify the control within the control
711class. It is guaranteed that these last 16 bits are always non-zero
712for controls. The range of 0x1000 and up are reserved for
713driver-specific controls. The macro
714<constant>V4L2_CTRL_ID2CLASS(id)</constant> returns the control class
715ID based on a control ID.</para>
716
717 <para>If the driver does not support extended controls, then
718<constant>VIDIOC_QUERYCTRL</constant> will fail when used in
719combination with <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant>. In
720that case the old method of enumerating control should be used (see
7211.8). But if it is supported, then it is guaranteed to enumerate over
722all controls, including driver-private controls.</para>
723 </section>
724
725 <section>
726 <title>Creating Control Panels</title>
727
728 <para>It is possible to create control panels for a graphical
729user interface where the user can select the various controls.
730Basically you will have to iterate over all controls using the method
731described above. Each control class starts with a control of type
732<constant>V4L2_CTRL_TYPE_CTRL_CLASS</constant>.
733<constant>VIDIOC_QUERYCTRL</constant> will return the name of this
734control class which can be used as the title of a tab page within a
735control panel.</para>
736
737 <para>The flags field of &v4l2-queryctrl; also contains hints on
738the behavior of the control. See the &VIDIOC-QUERYCTRL; documentation
739for more details.</para>
740 </section>
741
742 <section id="mpeg-controls">
743 <title>MPEG Control Reference</title>
744
745 <para>Below all controls within the MPEG control class are
746described. First the generic controls, then controls specific for
747certain hardware.</para>
748
749 <section>
750 <title>Generic MPEG Controls</title>
751
752 <table pgwide="1" frame="none" id="mpeg-control-id">
753 <title>MPEG Control IDs</title>
754 <tgroup cols="4">
755 <colspec colname="c1" colwidth="1*" />
756 <colspec colname="c2" colwidth="6*" />
757 <colspec colname="c3" colwidth="2*" />
758 <colspec colname="c4" colwidth="6*" />
759 <spanspec namest="c1" nameend="c2" spanname="id" />
760 <spanspec namest="c2" nameend="c4" spanname="descr" />
761 <thead>
762 <row>
763 <entry spanname="id" align="left">ID</entry>
764 <entry align="left">Type</entry>
765 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
766 </row>
767 </thead>
768 <tbody valign="top">
769 <row><entry></entry></row>
770 <row>
771 <entry spanname="id"><constant>V4L2_CID_MPEG_CLASS</constant>&nbsp;</entry>
772 <entry>class</entry>
773 </row><row><entry spanname="descr">The MPEG class
774descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
775description of this control class. This description can be used as the
776caption of a Tab page in a GUI, for example.</entry>
777 </row>
778 <row><entry></entry></row>
779 <row id="v4l2-mpeg-stream-type">
780 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_TYPE</constant>&nbsp;</entry>
781 <entry>enum&nbsp;v4l2_mpeg_stream_type</entry>
782 </row><row><entry spanname="descr">The MPEG-1, -2 or -4
783output stream type. One cannot assume anything here. Each hardware
784MPEG encoder tends to support different subsets of the available MPEG
Kamil Debski4fa64da2011-07-04 13:25:50 -0300785stream types. This control is specific to multiplexed MPEG streams.
786The currently defined stream types are:</entry>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300787 </row>
788 <row>
789 <entrytbl spanname="descr" cols="2">
790 <tbody valign="top">
791 <row>
792 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_PS</constant>&nbsp;</entry>
793 <entry>MPEG-2 program stream</entry>
794 </row>
795 <row>
796 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_TS</constant>&nbsp;</entry>
797 <entry>MPEG-2 transport stream</entry>
798 </row>
799 <row>
800 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_SS</constant>&nbsp;</entry>
801 <entry>MPEG-1 system stream</entry>
802 </row>
803 <row>
804 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_DVD</constant>&nbsp;</entry>
805 <entry>MPEG-2 DVD-compatible stream</entry>
806 </row>
807 <row>
808 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG1_VCD</constant>&nbsp;</entry>
809 <entry>MPEG-1 VCD-compatible stream</entry>
810 </row>
811 <row>
812 <entry><constant>V4L2_MPEG_STREAM_TYPE_MPEG2_SVCD</constant>&nbsp;</entry>
813 <entry>MPEG-2 SVCD-compatible stream</entry>
814 </row>
815 </tbody>
816 </entrytbl>
817 </row>
818 <row><entry></entry></row>
819 <row>
820 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PMT</constant>&nbsp;</entry>
821 <entry>integer</entry>
822 </row><row><entry spanname="descr">Program Map Table
823Packet ID for the MPEG transport stream (default 16)</entry>
824 </row>
825 <row><entry></entry></row>
826 <row>
827 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_AUDIO</constant>&nbsp;</entry>
828 <entry>integer</entry>
829 </row><row><entry spanname="descr">Audio Packet ID for
830the MPEG transport stream (default 256)</entry>
831 </row>
832 <row><entry></entry></row>
833 <row>
834 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_VIDEO</constant>&nbsp;</entry>
835 <entry>integer</entry>
836 </row><row><entry spanname="descr">Video Packet ID for
837the MPEG transport stream (default 260)</entry>
838 </row>
839 <row><entry></entry></row>
840 <row>
841 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PID_PCR</constant>&nbsp;</entry>
842 <entry>integer</entry>
843 </row><row><entry spanname="descr">Packet ID for the
844MPEG transport stream carrying PCR fields (default 259)</entry>
845 </row>
846 <row><entry></entry></row>
847 <row>
848 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_AUDIO</constant>&nbsp;</entry>
849 <entry>integer</entry>
850 </row><row><entry spanname="descr">Audio ID for MPEG
851PES</entry>
852 </row>
853 <row><entry></entry></row>
854 <row>
855 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_PES_ID_VIDEO</constant>&nbsp;</entry>
856 <entry>integer</entry>
857 </row><row><entry spanname="descr">Video ID for MPEG
858PES</entry>
859 </row>
860 <row><entry></entry></row>
861 <row id="v4l2-mpeg-stream-vbi-fmt">
862 <entry spanname="id"><constant>V4L2_CID_MPEG_STREAM_VBI_FMT</constant>&nbsp;</entry>
863 <entry>enum&nbsp;v4l2_mpeg_stream_vbi_fmt</entry>
864 </row><row><entry spanname="descr">Some cards can embed
865VBI data (&eg; Closed Caption, Teletext) into the MPEG stream. This
866control selects whether VBI data should be embedded, and if so, what
867embedding method should be used. The list of possible VBI formats
868depends on the driver. The currently defined VBI format types
869are:</entry>
870 </row>
871 <row>
872 <entrytbl spanname="descr" cols="2">
873 <tbody valign="top">
874 <row>
875 <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_NONE</constant>&nbsp;</entry>
876 <entry>No VBI in the MPEG stream</entry>
877 </row>
878 <row>
879 <entry><constant>V4L2_MPEG_STREAM_VBI_FMT_IVTV</constant>&nbsp;</entry>
880 <entry>VBI in private packets, IVTV format (documented
881in the kernel sources in the file <filename>Documentation/video4linux/cx2341x/README.vbi</filename>)</entry>
882 </row>
883 </tbody>
884 </entrytbl>
885 </row>
886 <row><entry></entry></row>
887 <row id="v4l2-mpeg-audio-sampling-freq">
888 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_SAMPLING_FREQ</constant>&nbsp;</entry>
889 <entry>enum&nbsp;v4l2_mpeg_audio_sampling_freq</entry>
890 </row><row><entry spanname="descr">MPEG Audio sampling
891frequency. Possible values are:</entry>
892 </row>
893 <row>
894 <entrytbl spanname="descr" cols="2">
895 <tbody valign="top">
896 <row>
897 <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_44100</constant>&nbsp;</entry>
898 <entry>44.1 kHz</entry>
899 </row>
900 <row>
901 <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_48000</constant>&nbsp;</entry>
902 <entry>48 kHz</entry>
903 </row>
904 <row>
905 <entry><constant>V4L2_MPEG_AUDIO_SAMPLING_FREQ_32000</constant>&nbsp;</entry>
906 <entry>32 kHz</entry>
907 </row>
908 </tbody>
909 </entrytbl>
910 </row>
911 <row><entry></entry></row>
912 <row id="v4l2-mpeg-audio-encoding">
913 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_ENCODING</constant>&nbsp;</entry>
914 <entry>enum&nbsp;v4l2_mpeg_audio_encoding</entry>
915 </row><row><entry spanname="descr">MPEG Audio encoding.
Kamil Debski4fa64da2011-07-04 13:25:50 -0300916This control is specific to multiplexed MPEG streams.
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -0300917Possible values are:</entry>
918 </row>
919 <row>
920 <entrytbl spanname="descr" cols="2">
921 <tbody valign="top">
922 <row>
923 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_1</constant>&nbsp;</entry>
924 <entry>MPEG-1/2 Layer I encoding</entry>
925 </row>
926 <row>
927 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_2</constant>&nbsp;</entry>
928 <entry>MPEG-1/2 Layer II encoding</entry>
929 </row>
930 <row>
931 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_LAYER_3</constant>&nbsp;</entry>
932 <entry>MPEG-1/2 Layer III encoding</entry>
933 </row>
934 <row>
935 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AAC</constant>&nbsp;</entry>
936 <entry>MPEG-2/4 AAC (Advanced Audio Coding)</entry>
937 </row>
938 <row>
939 <entry><constant>V4L2_MPEG_AUDIO_ENCODING_AC3</constant>&nbsp;</entry>
940 <entry>AC-3 aka ATSC A/52 encoding</entry>
941 </row>
942 </tbody>
943 </entrytbl>
944 </row>
945 <row><entry></entry></row>
946 <row id="v4l2-mpeg-audio-l1-bitrate">
947 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L1_BITRATE</constant>&nbsp;</entry>
948 <entry>enum&nbsp;v4l2_mpeg_audio_l1_bitrate</entry>
949 </row><row><entry spanname="descr">MPEG-1/2 Layer I bitrate.
950Possible values are:</entry>
951 </row>
952 <row>
953 <entrytbl spanname="descr" cols="2">
954 <tbody valign="top">
955 <row>
956 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_32K</constant>&nbsp;</entry>
957 <entry>32 kbit/s</entry></row>
958 <row>
959 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_64K</constant>&nbsp;</entry>
960 <entry>64 kbit/s</entry>
961 </row>
962 <row>
963 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_96K</constant>&nbsp;</entry>
964 <entry>96 kbit/s</entry>
965 </row>
966 <row>
967 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_128K</constant>&nbsp;</entry>
968 <entry>128 kbit/s</entry>
969 </row>
970 <row>
971 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_160K</constant>&nbsp;</entry>
972 <entry>160 kbit/s</entry>
973 </row>
974 <row>
975 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_192K</constant>&nbsp;</entry>
976 <entry>192 kbit/s</entry>
977 </row>
978 <row>
979 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_224K</constant>&nbsp;</entry>
980 <entry>224 kbit/s</entry>
981 </row>
982 <row>
983 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_256K</constant>&nbsp;</entry>
984 <entry>256 kbit/s</entry>
985 </row>
986 <row>
987 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_288K</constant>&nbsp;</entry>
988 <entry>288 kbit/s</entry>
989 </row>
990 <row>
991 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_320K</constant>&nbsp;</entry>
992 <entry>320 kbit/s</entry>
993 </row>
994 <row>
995 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_352K</constant>&nbsp;</entry>
996 <entry>352 kbit/s</entry>
997 </row>
998 <row>
999 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_384K</constant>&nbsp;</entry>
1000 <entry>384 kbit/s</entry>
1001 </row>
1002 <row>
1003 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_416K</constant>&nbsp;</entry>
1004 <entry>416 kbit/s</entry>
1005 </row>
1006 <row>
1007 <entry><constant>V4L2_MPEG_AUDIO_L1_BITRATE_448K</constant>&nbsp;</entry>
1008 <entry>448 kbit/s</entry>
1009 </row>
1010 </tbody>
1011 </entrytbl>
1012 </row>
1013 <row><entry></entry></row>
1014 <row id="v4l2-mpeg-audio-l2-bitrate">
1015 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L2_BITRATE</constant>&nbsp;</entry>
1016 <entry>enum&nbsp;v4l2_mpeg_audio_l2_bitrate</entry>
1017 </row><row><entry spanname="descr">MPEG-1/2 Layer II bitrate.
1018Possible values are:</entry>
1019 </row>
1020 <row>
1021 <entrytbl spanname="descr" cols="2">
1022 <tbody valign="top">
1023 <row>
1024 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_32K</constant>&nbsp;</entry>
1025 <entry>32 kbit/s</entry>
1026 </row>
1027 <row>
1028 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_48K</constant>&nbsp;</entry>
1029 <entry>48 kbit/s</entry>
1030 </row>
1031 <row>
1032 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_56K</constant>&nbsp;</entry>
1033 <entry>56 kbit/s</entry>
1034 </row>
1035 <row>
1036 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_64K</constant>&nbsp;</entry>
1037 <entry>64 kbit/s</entry>
1038 </row>
1039 <row>
1040 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_80K</constant>&nbsp;</entry>
1041 <entry>80 kbit/s</entry>
1042 </row>
1043 <row>
1044 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_96K</constant>&nbsp;</entry>
1045 <entry>96 kbit/s</entry>
1046 </row>
1047 <row>
1048 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_112K</constant>&nbsp;</entry>
1049 <entry>112 kbit/s</entry>
1050 </row>
1051 <row>
1052 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_128K</constant>&nbsp;</entry>
1053 <entry>128 kbit/s</entry>
1054 </row>
1055 <row>
1056 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_160K</constant>&nbsp;</entry>
1057 <entry>160 kbit/s</entry>
1058 </row>
1059 <row>
1060 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_192K</constant>&nbsp;</entry>
1061 <entry>192 kbit/s</entry>
1062 </row>
1063 <row>
1064 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_224K</constant>&nbsp;</entry>
1065 <entry>224 kbit/s</entry>
1066 </row>
1067 <row>
1068 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_256K</constant>&nbsp;</entry>
1069 <entry>256 kbit/s</entry>
1070 </row>
1071 <row>
1072 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_320K</constant>&nbsp;</entry>
1073 <entry>320 kbit/s</entry>
1074 </row>
1075 <row>
1076 <entry><constant>V4L2_MPEG_AUDIO_L2_BITRATE_384K</constant>&nbsp;</entry>
1077 <entry>384 kbit/s</entry>
1078 </row>
1079 </tbody>
1080 </entrytbl>
1081 </row>
1082 <row><entry></entry></row>
1083 <row id="v4l2-mpeg-audio-l3-bitrate">
1084 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_L3_BITRATE</constant>&nbsp;</entry>
1085 <entry>enum&nbsp;v4l2_mpeg_audio_l3_bitrate</entry>
1086 </row><row><entry spanname="descr">MPEG-1/2 Layer III bitrate.
1087Possible values are:</entry>
1088 </row>
1089 <row>
1090 <entrytbl spanname="descr" cols="2">
1091 <tbody valign="top">
1092 <row>
1093 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_32K</constant>&nbsp;</entry>
1094 <entry>32 kbit/s</entry>
1095 </row>
1096 <row>
1097 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_40K</constant>&nbsp;</entry>
1098 <entry>40 kbit/s</entry>
1099 </row>
1100 <row>
1101 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_48K</constant>&nbsp;</entry>
1102 <entry>48 kbit/s</entry>
1103 </row>
1104 <row>
1105 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_56K</constant>&nbsp;</entry>
1106 <entry>56 kbit/s</entry>
1107 </row>
1108 <row>
1109 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_64K</constant>&nbsp;</entry>
1110 <entry>64 kbit/s</entry>
1111 </row>
1112 <row>
1113 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_80K</constant>&nbsp;</entry>
1114 <entry>80 kbit/s</entry>
1115 </row>
1116 <row>
1117 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_96K</constant>&nbsp;</entry>
1118 <entry>96 kbit/s</entry>
1119 </row>
1120 <row>
1121 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_112K</constant>&nbsp;</entry>
1122 <entry>112 kbit/s</entry>
1123 </row>
1124 <row>
1125 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_128K</constant>&nbsp;</entry>
1126 <entry>128 kbit/s</entry>
1127 </row>
1128 <row>
1129 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_160K</constant>&nbsp;</entry>
1130 <entry>160 kbit/s</entry>
1131 </row>
1132 <row>
1133 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_192K</constant>&nbsp;</entry>
1134 <entry>192 kbit/s</entry>
1135 </row>
1136 <row>
1137 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_224K</constant>&nbsp;</entry>
1138 <entry>224 kbit/s</entry>
1139 </row>
1140 <row>
1141 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_256K</constant>&nbsp;</entry>
1142 <entry>256 kbit/s</entry>
1143 </row>
1144 <row>
1145 <entry><constant>V4L2_MPEG_AUDIO_L3_BITRATE_320K</constant>&nbsp;</entry>
1146 <entry>320 kbit/s</entry>
1147 </row>
1148 </tbody>
1149 </entrytbl>
1150 </row>
1151 <row><entry></entry></row>
1152 <row>
1153 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AAC_BITRATE</constant>&nbsp;</entry>
1154 <entry>integer</entry>
1155 </row><row><entry spanname="descr">AAC bitrate in bits per second.</entry>
1156 </row>
1157 <row><entry></entry></row>
1158 <row id="v4l2-mpeg-audio-ac3-bitrate">
1159 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_AC3_BITRATE</constant>&nbsp;</entry>
1160 <entry>enum&nbsp;v4l2_mpeg_audio_ac3_bitrate</entry>
1161 </row><row><entry spanname="descr">AC-3 bitrate.
1162Possible values are:</entry>
1163 </row>
1164 <row>
1165 <entrytbl spanname="descr" cols="2">
1166 <tbody valign="top">
1167 <row>
1168 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_32K</constant>&nbsp;</entry>
1169 <entry>32 kbit/s</entry>
1170 </row>
1171 <row>
1172 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_40K</constant>&nbsp;</entry>
1173 <entry>40 kbit/s</entry>
1174 </row>
1175 <row>
1176 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_48K</constant>&nbsp;</entry>
1177 <entry>48 kbit/s</entry>
1178 </row>
1179 <row>
1180 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_56K</constant>&nbsp;</entry>
1181 <entry>56 kbit/s</entry>
1182 </row>
1183 <row>
1184 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_64K</constant>&nbsp;</entry>
1185 <entry>64 kbit/s</entry>
1186 </row>
1187 <row>
1188 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_80K</constant>&nbsp;</entry>
1189 <entry>80 kbit/s</entry>
1190 </row>
1191 <row>
1192 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_96K</constant>&nbsp;</entry>
1193 <entry>96 kbit/s</entry>
1194 </row>
1195 <row>
1196 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_112K</constant>&nbsp;</entry>
1197 <entry>112 kbit/s</entry>
1198 </row>
1199 <row>
1200 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_128K</constant>&nbsp;</entry>
1201 <entry>128 kbit/s</entry>
1202 </row>
1203 <row>
1204 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_160K</constant>&nbsp;</entry>
1205 <entry>160 kbit/s</entry>
1206 </row>
1207 <row>
1208 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_192K</constant>&nbsp;</entry>
1209 <entry>192 kbit/s</entry>
1210 </row>
1211 <row>
1212 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_224K</constant>&nbsp;</entry>
1213 <entry>224 kbit/s</entry>
1214 </row>
1215 <row>
1216 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_256K</constant>&nbsp;</entry>
1217 <entry>256 kbit/s</entry>
1218 </row>
1219 <row>
1220 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_320K</constant>&nbsp;</entry>
1221 <entry>320 kbit/s</entry>
1222 </row>
1223 <row>
1224 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_384K</constant>&nbsp;</entry>
1225 <entry>384 kbit/s</entry>
1226 </row>
1227 <row>
1228 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_448K</constant>&nbsp;</entry>
1229 <entry>448 kbit/s</entry>
1230 </row>
1231 <row>
1232 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_512K</constant>&nbsp;</entry>
1233 <entry>512 kbit/s</entry>
1234 </row>
1235 <row>
1236 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_576K</constant>&nbsp;</entry>
1237 <entry>576 kbit/s</entry>
1238 </row>
1239 <row>
1240 <entry><constant>V4L2_MPEG_AUDIO_AC3_BITRATE_640K</constant>&nbsp;</entry>
1241 <entry>640 kbit/s</entry>
1242 </row>
1243 </tbody>
1244 </entrytbl>
1245 </row>
1246 <row><entry></entry></row>
1247 <row id="v4l2-mpeg-audio-mode">
1248 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE</constant>&nbsp;</entry>
1249 <entry>enum&nbsp;v4l2_mpeg_audio_mode</entry>
1250 </row><row><entry spanname="descr">MPEG Audio mode.
1251Possible values are:</entry>
1252 </row>
1253 <row>
1254 <entrytbl spanname="descr" cols="2">
1255 <tbody valign="top">
1256 <row>
1257 <entry><constant>V4L2_MPEG_AUDIO_MODE_STEREO</constant>&nbsp;</entry>
1258 <entry>Stereo</entry>
1259 </row>
1260 <row>
1261 <entry><constant>V4L2_MPEG_AUDIO_MODE_JOINT_STEREO</constant>&nbsp;</entry>
1262 <entry>Joint Stereo</entry>
1263 </row>
1264 <row>
1265 <entry><constant>V4L2_MPEG_AUDIO_MODE_DUAL</constant>&nbsp;</entry>
1266 <entry>Bilingual</entry>
1267 </row>
1268 <row>
1269 <entry><constant>V4L2_MPEG_AUDIO_MODE_MONO</constant>&nbsp;</entry>
1270 <entry>Mono</entry>
1271 </row>
1272 </tbody>
1273 </entrytbl>
1274 </row>
1275 <row><entry></entry></row>
1276 <row id="v4l2-mpeg-audio-mode-extension">
1277 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MODE_EXTENSION</constant>&nbsp;</entry>
1278 <entry>enum&nbsp;v4l2_mpeg_audio_mode_extension</entry>
1279 </row><row><entry spanname="descr">Joint Stereo
1280audio mode extension. In Layer I and II they indicate which subbands
1281are in intensity stereo. All other subbands are coded in stereo. Layer
1282III is not (yet) supported. Possible values
1283are:</entry>
1284 </row>
1285 <row>
1286 <entrytbl spanname="descr" cols="2">
1287 <tbody valign="top">
1288 <row>
1289 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_4</constant>&nbsp;</entry>
1290 <entry>Subbands 4-31 in intensity stereo</entry>
1291 </row>
1292 <row>
1293 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_8</constant>&nbsp;</entry>
1294 <entry>Subbands 8-31 in intensity stereo</entry>
1295 </row>
1296 <row>
1297 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_12</constant>&nbsp;</entry>
1298 <entry>Subbands 12-31 in intensity stereo</entry>
1299 </row>
1300 <row>
1301 <entry><constant>V4L2_MPEG_AUDIO_MODE_EXTENSION_BOUND_16</constant>&nbsp;</entry>
1302 <entry>Subbands 16-31 in intensity stereo</entry>
1303 </row>
1304 </tbody>
1305 </entrytbl>
1306 </row>
1307 <row><entry></entry></row>
1308 <row id="v4l2-mpeg-audio-emphasis">
1309 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_EMPHASIS</constant>&nbsp;</entry>
1310 <entry>enum&nbsp;v4l2_mpeg_audio_emphasis</entry>
1311 </row><row><entry spanname="descr">Audio Emphasis.
1312Possible values are:</entry>
1313 </row>
1314 <row>
1315 <entrytbl spanname="descr" cols="2">
1316 <tbody valign="top">
1317 <row>
1318 <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_NONE</constant>&nbsp;</entry>
1319 <entry>None</entry>
1320 </row>
1321 <row>
1322 <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_50_DIV_15_uS</constant>&nbsp;</entry>
1323 <entry>50/15 microsecond emphasis</entry>
1324 </row>
1325 <row>
1326 <entry><constant>V4L2_MPEG_AUDIO_EMPHASIS_CCITT_J17</constant>&nbsp;</entry>
1327 <entry>CCITT J.17</entry>
1328 </row>
1329 </tbody>
1330 </entrytbl>
1331 </row>
1332 <row><entry></entry></row>
1333 <row id="v4l2-mpeg-audio-crc">
1334 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_CRC</constant>&nbsp;</entry>
1335 <entry>enum&nbsp;v4l2_mpeg_audio_crc</entry>
1336 </row><row><entry spanname="descr">CRC method. Possible
1337values are:</entry>
1338 </row>
1339 <row>
1340 <entrytbl spanname="descr" cols="2">
1341 <tbody valign="top">
1342 <row>
1343 <entry><constant>V4L2_MPEG_AUDIO_CRC_NONE</constant>&nbsp;</entry>
1344 <entry>None</entry>
1345 </row>
1346 <row>
1347 <entry><constant>V4L2_MPEG_AUDIO_CRC_CRC16</constant>&nbsp;</entry>
1348 <entry>16 bit parity check</entry>
1349 </row>
1350 </tbody>
1351 </entrytbl>
1352 </row>
1353 <row><entry></entry></row>
1354 <row>
1355 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_MUTE</constant>&nbsp;</entry>
1356 <entry>boolean</entry>
1357 </row><row><entry spanname="descr">Mutes the audio when
1358capturing. This is not done by muting audio hardware, which can still
1359produce a slight hiss, but in the encoder itself, guaranteeing a fixed
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001360and reproducible audio bitstream. 0 = unmuted, 1 = muted.</entry>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001361 </row>
1362 <row><entry></entry></row>
Hans Verkuil77bd4c02011-12-15 10:52:57 -03001363 <row id="v4l2-mpeg-audio-dec-playback">
1364 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_DEC_PLAYBACK</constant>&nbsp;</entry>
1365 <entry>enum&nbsp;v4l2_mpeg_audio_dec_playback</entry>
1366 </row><row><entry spanname="descr">Determines how monolingual audio should be played back.
1367Possible values are:</entry>
1368 </row>
1369 <row>
1370 <entrytbl spanname="descr" cols="2">
1371 <tbody valign="top">
1372 <row>
1373 <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_AUTO</constant>&nbsp;</entry>
1374 <entry>Automatically determines the best playback mode.</entry>
1375 </row>
1376 <row>
1377 <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_STEREO</constant>&nbsp;</entry>
1378 <entry>Stereo playback.</entry>
1379 </row>
1380 <row>
1381 <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_LEFT</constant>&nbsp;</entry>
1382 <entry>Left channel playback.</entry>
1383 </row>
1384 <row>
1385 <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_RIGHT</constant>&nbsp;</entry>
1386 <entry>Right channel playback.</entry>
1387 </row>
1388 <row>
1389 <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_MONO</constant>&nbsp;</entry>
1390 <entry>Mono playback.</entry>
1391 </row>
1392 <row>
1393 <entry><constant>V4L2_MPEG_AUDIO_DEC_PLAYBACK_SWAPPED_STEREO</constant>&nbsp;</entry>
1394 <entry>Stereo playback with swapped left and right channels.</entry>
1395 </row>
1396 </tbody>
1397 </entrytbl>
1398 </row>
1399 <row><entry></entry></row>
1400 <row id="v4l2-mpeg-audio-dec-multilingual-playback">
1401 <entry spanname="id"><constant>V4L2_CID_MPEG_AUDIO_DEC_MULTILINGUAL_PLAYBACK</constant>&nbsp;</entry>
1402 <entry>enum&nbsp;v4l2_mpeg_audio_dec_playback</entry>
1403 </row><row><entry spanname="descr">Determines how multilingual audio should be played back.</entry>
1404 </row>
1405 <row><entry></entry></row>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001406 <row id="v4l2-mpeg-video-encoding">
1407 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ENCODING</constant>&nbsp;</entry>
1408 <entry>enum&nbsp;v4l2_mpeg_video_encoding</entry>
1409 </row><row><entry spanname="descr">MPEG Video encoding
Kamil Debski4fa64da2011-07-04 13:25:50 -03001410method. This control is specific to multiplexed MPEG streams.
1411Possible values are:</entry>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03001412 </row>
1413 <row>
1414 <entrytbl spanname="descr" cols="2">
1415 <tbody valign="top">
1416 <row>
1417 <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_1</constant>&nbsp;</entry>
1418 <entry>MPEG-1 Video encoding</entry>
1419 </row>
1420 <row>
1421 <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_2</constant>&nbsp;</entry>
1422 <entry>MPEG-2 Video encoding</entry>
1423 </row>
1424 <row>
1425 <entry><constant>V4L2_MPEG_VIDEO_ENCODING_MPEG_4_AVC</constant>&nbsp;</entry>
1426 <entry>MPEG-4 AVC (H.264) Video encoding</entry>
1427 </row>
1428 </tbody>
1429 </entrytbl>
1430 </row>
1431 <row><entry></entry></row>
1432 <row id="v4l2-mpeg-video-aspect">
1433 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_ASPECT</constant>&nbsp;</entry>
1434 <entry>enum&nbsp;v4l2_mpeg_video_aspect</entry>
1435 </row><row><entry spanname="descr">Video aspect.
1436Possible values are:</entry>
1437 </row>
1438 <row>
1439 <entrytbl spanname="descr" cols="2">
1440 <tbody valign="top">
1441 <row>
1442 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_1x1</constant>&nbsp;</entry>
1443 </row>
1444 <row>
1445 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_4x3</constant>&nbsp;</entry>
1446 </row>
1447 <row>
1448 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_16x9</constant>&nbsp;</entry>
1449 </row>
1450 <row>
1451 <entry><constant>V4L2_MPEG_VIDEO_ASPECT_221x100</constant>&nbsp;</entry>
1452 </row>
1453 </tbody>
1454 </entrytbl>
1455 </row>
1456 <row><entry></entry></row>
1457 <row>
1458 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_B_FRAMES</constant>&nbsp;</entry>
1459 <entry>integer</entry>
1460 </row><row><entry spanname="descr">Number of B-Frames
1461(default 2)</entry>
1462 </row>
1463 <row><entry></entry></row>
1464 <row>
1465 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_SIZE</constant>&nbsp;</entry>
1466 <entry>integer</entry>
1467 </row><row><entry spanname="descr">GOP size (default
146812)</entry>
1469 </row>
1470 <row><entry></entry></row>
1471 <row>
1472 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_GOP_CLOSURE</constant>&nbsp;</entry>
1473 <entry>boolean</entry>
1474 </row><row><entry spanname="descr">GOP closure (default
14751)</entry>
1476 </row>
1477 <row><entry></entry></row>
1478 <row>
1479 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_PULLDOWN</constant>&nbsp;</entry>
1480 <entry>boolean</entry>
1481 </row><row><entry spanname="descr">Enable 3:2 pulldown
1482(default 0)</entry>
1483 </row>
1484 <row><entry></entry></row>
1485 <row id="v4l2-mpeg-video-bitrate-mode">
1486 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_MODE</constant>&nbsp;</entry>
1487 <entry>enum&nbsp;v4l2_mpeg_video_bitrate_mode</entry>
1488 </row><row><entry spanname="descr">Video bitrate mode.
1489Possible values are:</entry>
1490 </row>
1491 <row>
1492 <entrytbl spanname="descr" cols="2">
1493 <tbody valign="top">
1494 <row>
1495 <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_VBR</constant>&nbsp;</entry>
1496 <entry>Variable bitrate</entry>
1497 </row>
1498 <row>
1499 <entry><constant>V4L2_MPEG_VIDEO_BITRATE_MODE_CBR</constant>&nbsp;</entry>
1500 <entry>Constant bitrate</entry>
1501 </row>
1502 </tbody>
1503 </entrytbl>
1504 </row>
1505 <row><entry></entry></row>
1506 <row>
1507 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE</constant>&nbsp;</entry>
1508 <entry>integer</entry>
1509 </row><row><entry spanname="descr">Video bitrate in bits
1510per second.</entry>
1511 </row>
1512 <row><entry></entry></row>
1513 <row>
1514 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_BITRATE_PEAK</constant>&nbsp;</entry>
1515 <entry>integer</entry>
1516 </row><row><entry spanname="descr">Peak video bitrate in
1517bits per second. Must be larger or equal to the average video bitrate.
1518It is ignored if the video bitrate mode is set to constant
1519bitrate.</entry>
1520 </row>
1521 <row><entry></entry></row>
1522 <row>
1523 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_TEMPORAL_DECIMATION</constant>&nbsp;</entry>
1524 <entry>integer</entry>
1525 </row><row><entry spanname="descr">For every captured
1526frame, skip this many subsequent frames (default 0).</entry>
1527 </row>
1528 <row><entry></entry></row>
1529 <row>
1530 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE</constant>&nbsp;</entry>
1531 <entry>boolean</entry>
1532 </row>
1533 <row><entry spanname="descr">"Mutes" the video to a
1534fixed color when capturing. This is useful for testing, to produce a
1535fixed video bitstream. 0 = unmuted, 1 = muted.</entry>
1536 </row>
1537 <row><entry></entry></row>
1538 <row>
1539 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MUTE_YUV</constant>&nbsp;</entry>
1540 <entry>integer</entry>
1541 </row><row><entry spanname="descr">Sets the "mute" color
1542of the video. The supplied 32-bit integer is interpreted as follows (bit
15430 = least significant bit):</entry>
1544 </row>
1545 <row>
1546 <entrytbl spanname="descr" cols="2">
1547 <tbody valign="top">
1548 <row>
1549 <entry>Bit 0:7</entry>
1550 <entry>V chrominance information</entry>
1551 </row>
1552 <row>
1553 <entry>Bit 8:15</entry>
1554 <entry>U chrominance information</entry>
1555 </row>
1556 <row>
1557 <entry>Bit 16:23</entry>
1558 <entry>Y luminance information</entry>
1559 </row>
1560 <row>
1561 <entry>Bit 24:31</entry>
1562 <entry>Must be zero.</entry>
1563 </row>
1564 </tbody>
1565 </entrytbl>
1566 </row>
Hans Verkuil77bd4c02011-12-15 10:52:57 -03001567 <row><entry></entry></row>
1568 <row id="v4l2-mpeg-video-dec-pts">
1569 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DEC_PTS</constant>&nbsp;</entry>
1570 <entry>integer64</entry>
1571 </row><row><entry spanname="descr">This read-only control returns the
157233-bit video Presentation Time Stamp as defined in ITU T-REC-H.222.0 and ISO/IEC 13818-1 of
1573the currently displayed frame. This is the same PTS as is used in &VIDIOC-DECODER-CMD;.</entry>
1574 </row>
1575 <row><entry></entry></row>
1576 <row id="v4l2-mpeg-video-dec-frame">
1577 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DEC_FRAME</constant>&nbsp;</entry>
1578 <entry>integer64</entry>
1579 </row><row><entry spanname="descr">This read-only control returns the
1580frame counter of the frame that is currently displayed (decoded). This value is reset to 0 whenever
1581the decoder is started.</entry>
1582 </row>
Kamil Debskie65e4f12011-06-14 10:31:04 -03001583
1584
1585 <row><entry></entry></row>
1586 <row>
1587 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_SLICE_INTERFACE</constant>&nbsp;</entry>
1588 <entry>boolean</entry>
1589 </row>
1590 <row><entry spanname="descr">If enabled the decoder expects to receive a single slice per buffer, otherwise
1591the decoder expects a single frame in per buffer. Applicable to the decoder, all codecs.
1592</entry>
1593 </row>
1594
1595 <row><entry></entry></row>
1596 <row>
1597 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_ENABLE</constant>&nbsp;</entry>
1598 <entry>boolean</entry>
1599 </row>
1600 <row><entry spanname="descr">Enable writing sample aspect ratio in the Video Usability Information.
1601Applicable to the H264 encoder.</entry>
1602 </row>
1603
1604 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03001605 <row id="v4l2-mpeg-video-h264-vui-sar-idc">
Kamil Debskie65e4f12011-06-14 10:31:04 -03001606 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_SAR_IDC</constant>&nbsp;</entry>
1607 <entry>enum&nbsp;v4l2_mpeg_video_h264_vui_sar_idc</entry>
1608 </row>
1609 <row><entry spanname="descr">VUI sample aspect ratio indicator for H.264 encoding. The value
1610is defined in the table E-1 in the standard. Applicable to the H264 encoder.</entry>
1611 </row>
1612 <row>
1613 <entrytbl spanname="descr" cols="2">
1614 <tbody valign="top">
1615
1616 <row>
1617 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_UNSPECIFIED</constant>&nbsp;</entry>
1618 <entry>Unspecified</entry>
1619 </row>
1620 <row>
1621 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_1x1</constant>&nbsp;</entry>
1622 <entry>1x1</entry>
1623 </row>
1624 <row>
1625 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_12x11</constant>&nbsp;</entry>
1626 <entry>12x11</entry>
1627 </row>
1628 <row>
1629 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_10x11</constant>&nbsp;</entry>
1630 <entry>10x11</entry>
1631 </row>
1632 <row>
1633 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_16x11</constant>&nbsp;</entry>
1634 <entry>16x11</entry>
1635 </row>
1636 <row>
1637 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_40x33</constant>&nbsp;</entry>
1638 <entry>40x33</entry>
1639 </row>
1640 <row>
1641 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_24x11</constant>&nbsp;</entry>
1642 <entry>24x11</entry>
1643 </row>
1644 <row>
1645 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_20x11</constant>&nbsp;</entry>
1646 <entry>20x11</entry>
1647 </row>
1648 <row>
1649 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_32x11</constant>&nbsp;</entry>
1650 <entry>32x11</entry>
1651 </row>
1652 <row>
1653 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_80x33</constant>&nbsp;</entry>
1654 <entry>80x33</entry>
1655 </row>
1656 <row>
1657 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_18x11</constant>&nbsp;</entry>
1658 <entry>18x11</entry>
1659 </row>
1660 <row>
1661 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_15x11</constant>&nbsp;</entry>
1662 <entry>15x11</entry>
1663 </row>
1664 <row>
1665 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_64x33</constant>&nbsp;</entry>
1666 <entry>64x33</entry>
1667 </row>
1668 <row>
1669 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_160x99</constant>&nbsp;</entry>
1670 <entry>160x99</entry>
1671 </row>
1672 <row>
1673 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_4x3</constant>&nbsp;</entry>
1674 <entry>4x3</entry>
1675 </row>
1676 <row>
1677 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_3x2</constant>&nbsp;</entry>
1678 <entry>3x2</entry>
1679 </row>
1680 <row>
1681 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_2x1</constant>&nbsp;</entry>
1682 <entry>2x1</entry>
1683 </row>
1684 <row>
1685 <entry><constant>V4L2_MPEG_VIDEO_H264_VUI_SAR_IDC_EXTENDED</constant>&nbsp;</entry>
1686 <entry>Extended SAR</entry>
1687 </row>
1688 </tbody>
1689 </entrytbl>
1690 </row>
1691
1692 <row><entry></entry></row>
1693 <row>
1694 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_WIDTH</constant>&nbsp;</entry>
1695 <entry>integer</entry>
1696 </row>
1697 <row><entry spanname="descr">Extended sample aspect ratio width for H.264 VUI encoding.
1698Applicable to the H264 encoder.</entry>
1699 </row>
1700
1701 <row><entry></entry></row>
1702 <row>
1703 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_VUI_EXT_SAR_HEIGHT</constant>&nbsp;</entry>
1704 <entry>integer</entry>
1705 </row>
1706 <row><entry spanname="descr">Extended sample aspect ratio height for H.264 VUI encoding.
1707Applicable to the H264 encoder.</entry>
1708 </row>
1709
1710 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03001711 <row id="v4l2-mpeg-video-h264-level">
Kamil Debskie65e4f12011-06-14 10:31:04 -03001712 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LEVEL</constant>&nbsp;</entry>
1713 <entry>enum&nbsp;v4l2_mpeg_video_h264_level</entry>
1714 </row>
1715 <row><entry spanname="descr">The level information for the H264 video elementary stream.
1716Applicable to the H264 encoder.
1717Possible values are:</entry>
1718 </row>
1719 <row>
1720 <entrytbl spanname="descr" cols="2">
1721 <tbody valign="top">
1722 <row>
1723 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_0</constant>&nbsp;</entry>
1724 <entry>Level 1.0</entry>
1725 </row>
1726 <row>
1727 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1B</constant>&nbsp;</entry>
1728 <entry>Level 1B</entry>
1729 </row>
1730 <row>
1731 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_1</constant>&nbsp;</entry>
1732 <entry>Level 1.1</entry>
1733 </row>
1734 <row>
1735 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_2</constant>&nbsp;</entry>
1736 <entry>Level 1.2</entry>
1737 </row>
1738 <row>
1739 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_1_3</constant>&nbsp;</entry>
1740 <entry>Level 1.3</entry>
1741 </row>
1742 <row>
1743 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_0</constant>&nbsp;</entry>
1744 <entry>Level 2.0</entry>
1745 </row>
1746 <row>
1747 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_1</constant>&nbsp;</entry>
1748 <entry>Level 2.1</entry>
1749 </row>
1750 <row>
1751 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_2_2</constant>&nbsp;</entry>
1752 <entry>Level 2.2</entry>
1753 </row>
1754 <row>
1755 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_0</constant>&nbsp;</entry>
1756 <entry>Level 3.0</entry>
1757 </row>
1758 <row>
1759 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_1</constant>&nbsp;</entry>
1760 <entry>Level 3.1</entry>
1761 </row>
1762 <row>
1763 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_3_2</constant>&nbsp;</entry>
1764 <entry>Level 3.2</entry>
1765 </row>
1766 <row>
1767 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_0</constant>&nbsp;</entry>
1768 <entry>Level 4.0</entry>
1769 </row>
1770 <row>
1771 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_1</constant>&nbsp;</entry>
1772 <entry>Level 4.1</entry>
1773 </row>
1774 <row>
1775 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_4_2</constant>&nbsp;</entry>
1776 <entry>Level 4.2</entry>
1777 </row>
1778 <row>
1779 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_0</constant>&nbsp;</entry>
1780 <entry>Level 5.0</entry>
1781 </row>
1782 <row>
1783 <entry><constant>V4L2_MPEG_VIDEO_H264_LEVEL_5_1</constant>&nbsp;</entry>
1784 <entry>Level 5.1</entry>
1785 </row>
1786 </tbody>
1787 </entrytbl>
1788 </row>
1789
1790 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03001791 <row id="v4l2-mpeg-video-mpeg4-level">
Kamil Debskie65e4f12011-06-14 10:31:04 -03001792 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_LEVEL</constant>&nbsp;</entry>
1793 <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_level</entry>
1794 </row>
1795 <row><entry spanname="descr">The level information for the MPEG4 elementary stream.
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_LEVEL_0</constant>&nbsp;</entry>
1804 <entry>Level 0</entry>
1805 </row>
1806 <row>
1807 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_0B</constant>&nbsp;</entry>
1808 <entry>Level 0b</entry>
1809 </row>
1810 <row>
1811 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_1</constant>&nbsp;</entry>
1812 <entry>Level 1</entry>
1813 </row>
1814 <row>
1815 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_2</constant>&nbsp;</entry>
1816 <entry>Level 2</entry>
1817 </row>
1818 <row>
1819 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3</constant>&nbsp;</entry>
1820 <entry>Level 3</entry>
1821 </row>
1822 <row>
1823 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_3B</constant>&nbsp;</entry>
1824 <entry>Level 3b</entry>
1825 </row>
1826 <row>
1827 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_4</constant>&nbsp;</entry>
1828 <entry>Level 4</entry>
1829 </row>
1830 <row>
1831 <entry><constant>V4L2_MPEG_VIDEO_LEVEL_5</constant>&nbsp;</entry>
1832 <entry>Level 5</entry>
1833 </row>
1834 </tbody>
1835 </entrytbl>
1836 </row>
1837
1838 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03001839 <row id="v4l2-mpeg-video-h264-profile">
Kamil Debskie65e4f12011-06-14 10:31:04 -03001840 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_PROFILE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03001841 <entry>enum&nbsp;v4l2_mpeg_video_h264_profile</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03001842 </row>
1843 <row><entry spanname="descr">The profile information for H264.
1844Applicable to the H264 encoder.
1845Possible values are:</entry>
1846 </row>
1847 <row>
1848 <entrytbl spanname="descr" cols="2">
1849 <tbody valign="top">
1850 <row>
1851 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_BASELINE</constant>&nbsp;</entry>
1852 <entry>Baseline profile</entry>
1853 </row>
1854 <row>
1855 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CONSTRAINED_BASELINE</constant>&nbsp;</entry>
1856 <entry>Constrained Baseline profile</entry>
1857 </row>
1858 <row>
1859 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MAIN</constant>&nbsp;</entry>
1860 <entry>Main profile</entry>
1861 </row>
1862 <row>
1863 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_EXTENDED</constant>&nbsp;</entry>
1864 <entry>Extended profile</entry>
1865 </row>
1866 <row>
1867 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH</constant>&nbsp;</entry>
1868 <entry>High profile</entry>
1869 </row>
1870 <row>
1871 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10</constant>&nbsp;</entry>
1872 <entry>High 10 profile</entry>
1873 </row>
1874 <row>
1875 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422</constant>&nbsp;</entry>
1876 <entry>High 422 profile</entry>
1877 </row>
1878 <row>
1879 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_PREDICTIVE</constant>&nbsp;</entry>
1880 <entry>High 444 Predictive profile</entry>
1881 </row>
1882 <row>
1883 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_10_INTRA</constant>&nbsp;</entry>
1884 <entry>High 10 Intra profile</entry>
1885 </row>
1886 <row>
1887 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_422_INTRA</constant>&nbsp;</entry>
1888 <entry>High 422 Intra profile</entry>
1889 </row>
1890 <row>
1891 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_HIGH_444_INTRA</constant>&nbsp;</entry>
1892 <entry>High 444 Intra profile</entry>
1893 </row>
1894 <row>
1895 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_CAVLC_444_INTRA</constant>&nbsp;</entry>
1896 <entry>CAVLC 444 Intra profile</entry>
1897 </row>
1898 <row>
1899 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_BASELINE</constant>&nbsp;</entry>
1900 <entry>Scalable Baseline profile</entry>
1901 </row>
1902 <row>
1903 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH</constant>&nbsp;</entry>
1904 <entry>Scalable High profile</entry>
1905 </row>
1906 <row>
1907 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_SCALABLE_HIGH_INTRA</constant>&nbsp;</entry>
1908 <entry>Scalable High Intra profile</entry>
1909 </row>
1910 <row>
1911 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_STEREO_HIGH</constant>&nbsp;</entry>
1912 <entry>Stereo High profile</entry>
1913 </row>
1914 <row>
1915 <entry><constant>V4L2_MPEG_VIDEO_H264_PROFILE_MULTIVIEW_HIGH</constant>&nbsp;</entry>
1916 <entry>Multiview High profile</entry>
1917 </row>
1918
1919 </tbody>
1920 </entrytbl>
1921 </row>
1922
1923 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03001924 <row id="v4l2-mpeg-video-mpeg4-profile">
Kamil Debskie65e4f12011-06-14 10:31:04 -03001925 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_PROFILE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03001926 <entry>enum&nbsp;v4l2_mpeg_video_mpeg4_profile</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03001927 </row>
1928 <row><entry spanname="descr">The profile information for MPEG4.
1929Applicable to the MPEG4 encoder.
1930Possible values are:</entry>
1931 </row>
1932 <row>
1933 <entrytbl spanname="descr" cols="2">
1934 <tbody valign="top">
1935 <row>
1936 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE</constant>&nbsp;</entry>
1937 <entry>Simple profile</entry>
1938 </row>
1939 <row>
1940 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_SIMPLE</constant>&nbsp;</entry>
1941 <entry>Advanced Simple profile</entry>
1942 </row>
1943 <row>
1944 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_CORE</constant>&nbsp;</entry>
1945 <entry>Core profile</entry>
1946 </row>
1947 <row>
1948 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_SIMPLE_SCALABLE</constant>&nbsp;</entry>
1949 <entry>Simple Scalable profile</entry>
1950 </row>
1951 <row>
1952 <entry><constant>V4L2_MPEG_VIDEO_PROFILE_ADVANCED_CODING_EFFICIENCY</constant>&nbsp;</entry>
1953 <entry></entry>
1954 </row>
1955 </tbody>
1956 </entrytbl>
1957 </row>
1958
1959 <row><entry></entry></row>
1960 <row>
1961 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MAX_REF_PIC</constant>&nbsp;</entry>
1962 <entry>integer</entry>
1963 </row>
1964 <row><entry spanname="descr">The maximum number of reference pictures used for encoding.
1965Applicable to the encoder.
1966</entry>
1967 </row>
1968
1969 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03001970 <row id="v4l2-mpeg-video-multi-slice-mode">
Kamil Debskie65e4f12011-06-14 10:31:04 -03001971 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03001972 <entry>enum&nbsp;v4l2_mpeg_video_multi_slice_mode</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03001973 </row>
1974 <row><entry spanname="descr">Determines how the encoder should handle division of frame into slices.
1975Applicable to the encoder.
1976Possible values are:</entry>
1977 </row>
1978 <row>
1979 <entrytbl spanname="descr" cols="2">
1980 <tbody valign="top">
1981 <row>
1982 <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_SINGLE</constant>&nbsp;</entry>
1983 <entry>Single slice per frame.</entry>
1984 </row>
1985 <row>
1986 <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>&nbsp;</entry>
1987 <entry>Multiple slices with set maximum number of macroblocks per slice.</entry>
1988 </row>
1989 <row>
1990 <entry><constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>&nbsp;</entry>
1991 <entry>Multiple slice with set maximum size in bytes per slice.</entry>
1992 </row>
1993 </tbody>
1994 </entrytbl>
1995 </row>
1996
1997 <row><entry></entry></row>
1998 <row>
1999 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_MB</constant>&nbsp;</entry>
2000 <entry>integer</entry>
2001 </row>
2002 <row><entry spanname="descr">The maximum number of macroblocks in a slice. Used when
2003<constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_MB</constant>.
2004Applicable to the encoder.</entry>
2005 </row>
2006
2007 <row><entry></entry></row>
2008 <row>
2009 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MAX_BYTES</constant>&nbsp;</entry>
2010 <entry>integer</entry>
2011 </row>
2012 <row><entry spanname="descr">The maximum size of a slice in bytes. Used when
2013<constant>V4L2_CID_MPEG_VIDEO_MULTI_SLICE_MODE</constant> is set to <constant>V4L2_MPEG_VIDEO_MULTI_SLICE_MODE_MAX_BYTES</constant>.
2014Applicable to the encoder.</entry>
2015 </row>
2016
2017 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03002018 <row id="v4l2-mpeg-video-h264-loop-filter-mode">
Kamil Debskie65e4f12011-06-14 10:31:04 -03002019 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_MODE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03002020 <entry>enum&nbsp;v4l2_mpeg_video_h264_loop_filter_mode</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03002021 </row>
2022 <row><entry spanname="descr">Loop filter mode for H264 encoder.
2023Possible values are:</entry>
2024 </row>
2025 <row>
2026 <entrytbl spanname="descr" cols="2">
2027 <tbody valign="top">
2028 <row>
2029 <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_ENABLED</constant>&nbsp;</entry>
2030 <entry>Loop filter is enabled.</entry>
2031 </row>
2032 <row>
2033 <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED</constant>&nbsp;</entry>
2034 <entry>Loop filter is disabled.</entry>
2035 </row>
2036 <row>
2037 <entry><constant>V4L2_MPEG_VIDEO_H264_LOOP_FILTER_MODE_DISABLED_AT_SLICE_BOUNDARY</constant>&nbsp;</entry>
2038 <entry>Loop filter is disabled at the slice boundary.</entry>
2039 </row>
2040 </tbody>
2041 </entrytbl>
2042 </row>
2043
2044 <row><entry></entry></row>
2045 <row>
2046 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_ALPHA</constant>&nbsp;</entry>
2047 <entry>integer</entry>
2048 </row>
2049 <row><entry spanname="descr">Loop filter alpha coefficient, defined in the H264 standard.
2050Applicable to the H264 encoder.</entry>
2051 </row>
2052
2053 <row><entry></entry></row>
2054 <row>
2055 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_LOOP_FILTER_BETA</constant>&nbsp;</entry>
2056 <entry>integer</entry>
2057 </row>
2058 <row><entry spanname="descr">Loop filter beta coefficient, defined in the H264 standard.
2059Applicable to the H264 encoder.</entry>
2060 </row>
2061
2062 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03002063 <row id="v4l2-mpeg-video-h264-entropy-mode">
Kamil Debskie65e4f12011-06-14 10:31:04 -03002064 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_ENTROPY_MODE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03002065 <entry>enum&nbsp;v4l2_mpeg_video_h264_entropy_mode</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03002066 </row>
2067 <row><entry spanname="descr">Entropy coding mode for H264 - CABAC/CAVALC.
2068Applicable to the H264 encoder.
2069Possible values are:</entry>
2070 </row>
2071 <row>
2072 <entrytbl spanname="descr" cols="2">
2073 <tbody valign="top">
2074 <row>
2075 <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CAVLC</constant>&nbsp;</entry>
2076 <entry>Use CAVLC entropy coding.</entry>
2077 </row>
2078 <row>
2079 <entry><constant>V4L2_MPEG_VIDEO_H264_ENTROPY_MODE_CABAC</constant>&nbsp;</entry>
2080 <entry>Use CABAC entropy coding.</entry>
2081 </row>
2082 </tbody>
2083 </entrytbl>
2084 </row>
2085
2086 <row><entry></entry></row>
2087 <row>
2088 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_8X8_TRANSFORM</constant>&nbsp;</entry>
2089 <entry>boolean</entry>
2090 </row>
2091 <row><entry spanname="descr">Enable 8X8 transform for H264. Applicable to the H264 encoder.</entry>
2092 </row>
2093
2094 <row><entry></entry></row>
2095 <row>
2096 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_CYCLIC_INTRA_REFRESH_MB</constant>&nbsp;</entry>
2097 <entry>integer</entry>
2098 </row>
2099 <row><entry spanname="descr">Cyclic intra macroblock refresh. This is the number of continuous macroblocks
2100refreshed every frame. Each frame a succesive set of macroblocks is refreshed until the cycle completes and starts from the
2101top of the frame. Applicable to H264, H263 and MPEG4 encoder.</entry>
2102 </row>
2103
2104 <row><entry></entry></row>
2105 <row>
2106 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_FRAME_RC_ENABLE</constant>&nbsp;</entry>
2107 <entry>boolean</entry>
2108 </row>
2109 <row><entry spanname="descr">Frame level rate control enable.
2110If this control is disabled then the quantization parameter for each frame type is constant and set with appropriate controls
2111(e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>).
2112If frame rate control is enabled then quantization parameter is adjusted to meet the chosen bitrate. Minimum and maximum value
2113for the quantization parameter can be set with appropriate controls (e.g. <constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>).
2114Applicable to encoders.</entry>
2115 </row>
2116
2117 <row><entry></entry></row>
2118 <row>
2119 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>&nbsp;</entry>
2120 <entry>boolean</entry>
2121 </row>
2122 <row><entry spanname="descr">Macroblock level rate control enable.
2123Applicable to the MPEG4 and H264 encoders.</entry>
2124 </row>
2125
2126 <row><entry></entry></row>
2127 <row>
2128 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_QPEL</constant>&nbsp;</entry>
2129 <entry>boolean</entry>
2130 </row>
2131 <row><entry spanname="descr">Quarter pixel motion estimation for MPEG4. Applicable to the MPEG4 encoder.</entry>
2132 </row>
2133
2134 <row><entry></entry></row>
2135 <row>
2136 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_I_FRAME_QP</constant>&nbsp;</entry>
2137 <entry>integer</entry>
2138 </row>
2139 <row><entry spanname="descr">Quantization parameter for an I frame for H263. Valid range: from 1 to 31.</entry>
2140 </row>
2141
2142 <row><entry></entry></row>
2143 <row>
2144 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MIN_QP</constant>&nbsp;</entry>
2145 <entry>integer</entry>
2146 </row>
2147 <row><entry spanname="descr">Minimum quantization parameter for H263. Valid range: from 1 to 31.</entry>
2148 </row>
2149
2150 <row><entry></entry></row>
2151 <row>
2152 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_MAX_QP</constant>&nbsp;</entry>
2153 <entry>integer</entry>
2154 </row>
2155 <row><entry spanname="descr">Maximum quantization parameter for H263. Valid range: from 1 to 31.</entry>
2156 </row>
2157
2158 <row><entry></entry></row>
2159 <row>
2160 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_P_FRAME_QP</constant>&nbsp;</entry>
2161 <entry>integer</entry>
2162 </row>
2163 <row><entry spanname="descr">Quantization parameter for an P frame for H263. Valid range: from 1 to 31.</entry>
2164 </row>
2165
2166 <row><entry></entry></row>
2167 <row>
2168 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H263_B_FRAME_QP</constant>&nbsp;</entry>
2169 <entry>integer</entry>
2170 </row>
2171 <row><entry spanname="descr">Quantization parameter for an B frame for H263. Valid range: from 1 to 31.</entry>
2172 </row>
2173
2174 <row><entry></entry></row>
2175 <row>
2176 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_FRAME_QP</constant>&nbsp;</entry>
2177 <entry>integer</entry>
2178 </row>
2179 <row><entry spanname="descr">Quantization parameter for an I frame for H264. Valid range: from 0 to 51.</entry>
2180 </row>
2181
2182 <row><entry></entry></row>
2183 <row>
2184 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MIN_QP</constant>&nbsp;</entry>
2185 <entry>integer</entry>
2186 </row>
2187 <row><entry spanname="descr">Minimum quantization parameter for H264. Valid range: from 0 to 51.</entry>
2188 </row>
2189
2190 <row><entry></entry></row>
2191 <row>
2192 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_MAX_QP</constant>&nbsp;</entry>
2193 <entry>integer</entry>
2194 </row>
2195 <row><entry spanname="descr">Maximum quantization parameter for H264. Valid range: from 0 to 51.</entry>
2196 </row>
2197
2198 <row><entry></entry></row>
2199 <row>
2200 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_P_FRAME_QP</constant>&nbsp;</entry>
2201 <entry>integer</entry>
2202 </row>
2203 <row><entry spanname="descr">Quantization parameter for an P frame for H264. Valid range: from 0 to 51.</entry>
2204 </row>
2205
2206 <row><entry></entry></row>
2207 <row>
2208 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_B_FRAME_QP</constant>&nbsp;</entry>
2209 <entry>integer</entry>
2210 </row>
2211 <row><entry spanname="descr">Quantization parameter for an B frame for H264. Valid range: from 0 to 51.</entry>
2212 </row>
2213
2214 <row><entry></entry></row>
2215 <row>
2216 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_I_FRAME_QP</constant>&nbsp;</entry>
2217 <entry>integer</entry>
2218 </row>
2219 <row><entry spanname="descr">Quantization parameter for an I frame for MPEG4. Valid range: from 1 to 31.</entry>
2220 </row>
2221
2222 <row><entry></entry></row>
2223 <row>
2224 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MIN_QP</constant>&nbsp;</entry>
2225 <entry>integer</entry>
2226 </row>
2227 <row><entry spanname="descr">Minimum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
2228 </row>
2229
2230 <row><entry></entry></row>
2231 <row>
2232 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_MAX_QP</constant>&nbsp;</entry>
2233 <entry>integer</entry>
2234 </row>
2235 <row><entry spanname="descr">Maximum quantization parameter for MPEG4. Valid range: from 1 to 31.</entry>
2236 </row>
2237
2238 <row><entry></entry></row>
2239 <row>
2240 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_P_FRAME_QP</constant>&nbsp;</entry>
2241 <entry>integer</entry>
2242 </row>
2243 <row><entry spanname="descr">Quantization parameter for an P frame for MPEG4. Valid range: from 1 to 31.</entry>
2244 </row>
2245
2246 <row><entry></entry></row>
2247 <row>
2248 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_B_FRAME_QP</constant>&nbsp;</entry>
2249 <entry>integer</entry>
2250 </row>
2251 <row><entry spanname="descr">Quantization parameter for an B frame for MPEG4. Valid range: from 1 to 31.</entry>
2252 </row>
2253
2254 <row><entry></entry></row>
2255 <row>
2256 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_VBV_SIZE</constant>&nbsp;</entry>
2257 <entry>integer</entry>
2258 </row>
2259 <row><entry spanname="descr">The Video Buffer Verifier size in kilobytes, it is used as a limitation of frame skip.
2260The VBV is defined in the standard as a mean to verify that the produced stream will be succesfully decoded.
2261The standard describes it as "Part of a hypothetical decoder that is conceptually connected to the
2262output of the encoder. Its purpose is to provide a constraint on the variability of the data rate that an
2263encoder or editing process may produce.".
2264Applicable to the MPEG1, MPEG2, MPEG4 encoders.</entry>
2265 </row>
2266
2267 <row><entry></entry></row>
2268 <row>
2269 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_CPB_SIZE</constant>&nbsp;</entry>
2270 <entry>integer</entry>
2271 </row>
2272 <row><entry spanname="descr">The Coded Picture Buffer size in kilobytes, it is used as a limitation of frame skip.
2273The CPB is defined in the H264 standard as a mean to verify that the produced stream will be succesfully decoded.
2274Applicable to the H264 encoder.</entry>
2275 </row>
2276
2277 <row><entry></entry></row>
2278 <row>
2279 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_H264_I_PERIOD</constant>&nbsp;</entry>
2280 <entry>integer</entry>
2281 </row>
2282 <row><entry spanname="descr">Period between I-frames in the open GOP for H264. In case of an open GOP
2283this is the period between two I-frames. The period between IDR (Instantaneous Decoding Refresh) frames is taken from the GOP_SIZE control.
2284An IDR frame, which stands for Instantaneous Decoding Refresh is an I-frame after which no prior frames are
2285referenced. This means that a stream can be restarted from an IDR frame without the need to store or decode any
2286previous frames. Applicable to the H264 encoder.</entry>
2287 </row>
2288
2289 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03002290 <row id="v4l2-mpeg-video-header-mode">
Kamil Debskie65e4f12011-06-14 10:31:04 -03002291 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_HEADER_MODE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03002292 <entry>enum&nbsp;v4l2_mpeg_video_header_mode</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03002293 </row>
2294 <row><entry spanname="descr">Determines whether the header is returned as the first buffer or is
2295it returned together with the first frame. Applicable to encoders.
2296Possible values are:</entry>
2297 </row>
2298 <row>
2299 <entrytbl spanname="descr" cols="2">
2300 <tbody valign="top">
2301 <row>
2302 <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_SEPARATE</constant>&nbsp;</entry>
2303 <entry>The stream header is returned separately in the first buffer.</entry>
2304 </row>
2305 <row>
2306 <entry><constant>V4L2_MPEG_VIDEO_HEADER_MODE_JOINED_WITH_1ST_FRAME</constant>&nbsp;</entry>
2307 <entry>The stream header is returned together with the first encoded frame.</entry>
2308 </row>
2309 </tbody>
2310 </entrytbl>
2311 </row>
2312 <row><entry></entry></row>
2313 <row>
2314 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_DECODER_MPEG4_DEBLOCK_FILTER</constant>&nbsp;</entry>
2315 <entry>boolean</entry>
2316 </row><row><entry spanname="descr">Enabled the deblocking post processing filter for MPEG4 decoder.
2317Applicable to the MPEG4 decoder.</entry>
2318 </row>
2319 <row><entry></entry></row>
2320 <row>
2321 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_RES</constant>&nbsp;</entry>
2322 <entry>integer</entry>
2323 </row><row><entry spanname="descr">vop_time_increment_resolution value for MPEG4. Applicable to the MPEG4 encoder.</entry>
2324 </row>
2325 <row><entry></entry></row>
2326 <row>
2327 <entry spanname="id"><constant>V4L2_CID_MPEG_VIDEO_MPEG4_VOP_TIME_INC</constant>&nbsp;</entry>
2328 <entry>integer</entry>
2329 </row><row><entry spanname="descr">vop_time_increment value for MPEG4. Applicable to the MPEG4 encoder.</entry>
2330 </row>
2331
2332 </tbody>
2333 </tgroup>
2334 </table>
2335 </section>
2336
2337 <section>
2338 <title>MFC 5.1 MPEG Controls</title>
2339
2340 <para>The following MPEG class controls deal with MPEG
2341decoding and encoding settings that are specific to the Multi Format Codec 5.1 device present
2342in the S5P family of SoCs by Samsung.
2343</para>
2344
2345 <table pgwide="1" frame="none" id="mfc51-control-id">
2346 <title>MFC 5.1 Control IDs</title>
2347 <tgroup cols="4">
2348 <colspec colname="c1" colwidth="1*" />
2349 <colspec colname="c2" colwidth="6*" />
2350 <colspec colname="c3" colwidth="2*" />
2351 <colspec colname="c4" colwidth="6*" />
2352 <spanspec namest="c1" nameend="c2" spanname="id" />
2353 <spanspec namest="c2" nameend="c4" spanname="descr" />
2354 <thead>
2355 <row>
2356 <entry spanname="id" align="left">ID</entry>
2357 <entry align="left">Type</entry>
2358 </row><row><entry spanname="descr" align="left">Description</entry>
2359 </row>
2360 </thead>
2361 <tbody valign="top">
2362 <row><entry></entry></row>
2363 <row>
2364 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY_ENABLE</constant>&nbsp;</entry>
2365 <entry>integer</entry>
2366 </row><row><entry spanname="descr">If the display delay is enabled then the decoder has to return a
2367CAPTURE buffer after processing a certain number of OUTPUT buffers. If this number is low, then it may result in
2368buffers not being dequeued in display order. In addition hardware may still use those buffers as reference, thus
2369application should not write to those buffers. This feature can be used for example for generating thumbnails of videos.
2370Applicable to the H264 decoder.
2371 </entry>
2372 </row>
2373 <row><entry></entry></row>
2374 <row>
2375 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_DECODER_H264_DISPLAY_DELAY</constant>&nbsp;</entry>
2376 <entry>integer</entry>
2377 </row><row><entry spanname="descr">Display delay value for H264 decoder.
2378The decoder is forced to return a decoded frame after the set 'display delay' number of frames. If this number is
2379low it may result in frames returned out of dispaly order, in addition the hardware may still be using the returned buffer
2380as a reference picture for subsequent frames.
2381</entry>
2382 </row>
2383 <row><entry></entry></row>
2384 <row>
2385 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_NUM_REF_PIC_FOR_P</constant>&nbsp;</entry>
2386 <entry>integer</entry>
2387 </row><row><entry spanname="descr">The number of reference pictures used for encoding a P picture.
2388Applicable to the H264 encoder.</entry>
2389 </row>
2390 <row><entry></entry></row>
2391 <row>
2392 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING</constant>&nbsp;</entry>
2393 <entry>boolean</entry>
2394 </row><row><entry spanname="descr">Padding enable in the encoder - use a color instead of repeating border pixels.
2395Applicable to encoders.</entry>
2396 </row>
2397 <row><entry></entry></row>
2398 <row>
2399 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_PADDING_YUV</constant>&nbsp;</entry>
2400 <entry>integer</entry>
2401 </row><row><entry spanname="descr">Padding color in the encoder. Applicable to encoders. The supplied 32-bit integer is interpreted as follows (bit
24020 = least significant bit):</entry>
2403 </row>
2404 <row>
2405 <entrytbl spanname="descr" cols="2">
2406 <tbody valign="top">
2407 <row>
2408 <entry>Bit 0:7</entry>
2409 <entry>V chrominance information</entry>
2410 </row>
2411 <row>
2412 <entry>Bit 8:15</entry>
2413 <entry>U chrominance information</entry>
2414 </row>
2415 <row>
2416 <entry>Bit 16:23</entry>
2417 <entry>Y luminance information</entry>
2418 </row>
2419 <row>
2420 <entry>Bit 24:31</entry>
2421 <entry>Must be zero.</entry>
2422 </row>
2423 </tbody>
2424 </entrytbl>
2425 </row>
2426 <row><entry></entry></row>
2427 <row>
2428 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_REACTION_COEFF</constant>&nbsp;</entry>
2429 <entry>integer</entry>
2430 </row><row><entry spanname="descr">Reaction coefficient for MFC rate control. Applicable to encoders.
2431<para>Note 1: Valid only when the frame level RC is enabled.</para>
2432<para>Note 2: For tight CBR, this field must be small (ex. 2 ~ 10).
2433For VBR, this field must be large (ex. 100 ~ 1000).</para>
2434<para>Note 3: It is not recommended to use the greater number than FRAME_RATE * (10^9 / BIT_RATE).</para>
2435</entry>
2436 </row>
2437 <row><entry></entry></row>
2438 <row>
2439 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_DARK</constant>&nbsp;</entry>
2440 <entry>boolean</entry>
2441 </row><row><entry spanname="descr">Adaptive rate control for dark region.
2442Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
2443Applicable to the H264 encoder.</entry>
2444 </row>
2445 <row><entry></entry></row>
2446 <row>
2447 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_SMOOTH</constant>&nbsp;</entry>
2448 <entry>boolean</entry>
2449 </row><row><entry spanname="descr">Adaptive rate control for smooth region.
2450Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
2451Applicable to the H264 encoder.</entry>
2452 </row>
2453 <row><entry></entry></row>
2454 <row>
2455 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_STATIC</constant>&nbsp;</entry>
2456 <entry>boolean</entry>
2457 </row><row><entry spanname="descr">Adaptive rate control for static region.
2458Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
2459Applicable to the H264 encoder.</entry>
2460 </row>
2461 <row><entry></entry></row>
2462 <row>
2463 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_H264_ADAPTIVE_RC_ACTIVITY</constant>&nbsp;</entry>
2464 <entry>boolean</entry>
2465 </row><row><entry spanname="descr">Adaptive rate control for activity region.
2466Valid only when H.264 and macroblock level RC is enabled (<constant>V4L2_CID_MPEG_VIDEO_MB_RC_ENABLE</constant>).
2467Applicable to the H264 encoder.</entry>
2468 </row>
2469 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03002470 <row id="v4l2-mpeg-mfc51-video-frame-skip-mode">
Kamil Debskie65e4f12011-06-14 10:31:04 -03002471 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FRAME_SKIP_MODE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03002472 <entry>enum&nbsp;v4l2_mpeg_mfc51_video_frame_skip_mode</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03002473 </row>
2474 <row><entry spanname="descr">
2475Indicates in what conditions the encoder should skip frames. If encoding a frame would cause the encoded stream to be larger then
2476a chosen data limit then the frame will be skipped.
2477Possible values are:</entry>
2478 </row>
2479 <row>
2480 <entrytbl spanname="descr" cols="2">
2481 <tbody valign="top">
2482 <row>
2483 <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_DISABLED</constant>&nbsp;</entry>
2484 <entry>Frame skip mode is disabled.</entry>
2485 </row>
2486 <row>
2487 <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_LEVEL_LIMIT</constant>&nbsp;</entry>
2488 <entry>Frame skip mode enabled and buffer limit is set by the chosen level and is defined by the standard.</entry>
2489 </row>
2490 <row>
2491 <entry><constant>V4L2_MPEG_MFC51_FRAME_SKIP_MODE_BUF_LIMIT</constant>&nbsp;</entry>
2492 <entry>Frame skip mode enabled and buffer limit is set by the VBV (MPEG1/2/4) or CPB (H264) buffer size control.</entry>
2493 </row>
2494 </tbody>
2495 </entrytbl>
2496 </row>
2497 <row><entry></entry></row>
2498 <row>
2499 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_RC_FIXED_TARGET_BIT</constant>&nbsp;</entry>
2500 <entry>integer</entry>
2501 </row><row><entry spanname="descr">Enable rate-control with fixed target bit.
2502If this setting is enabled, then the rate control logic of the encoder will calculate the average bitrate
2503for a GOP and keep it below or equal the set bitrate target. Otherwise the rate control logic calculates the
2504overall average bitrate for the stream and keeps it below or equal to the set bitrate. In the first case
2505the average bitrate for the whole stream will be smaller then the set bitrate. This is caused because the
2506average is calculated for smaller number of frames, on the other hand enabling this setting will ensure that
2507the stream will meet tight bandwidth contraints. Applicable to encoders.
2508</entry>
2509 </row>
2510 <row><entry></entry></row>
Kamil Debski6a02a332011-08-02 12:53:49 -03002511 <row id="v4l2-mpeg-mfc51-video-force-frame-type">
Kamil Debskie65e4f12011-06-14 10:31:04 -03002512 <entry spanname="id"><constant>V4L2_CID_MPEG_MFC51_VIDEO_FORCE_FRAME_TYPE</constant>&nbsp;</entry>
Kamil Debski6a02a332011-08-02 12:53:49 -03002513 <entry>enum&nbsp;v4l2_mpeg_mfc51_video_force_frame_type</entry>
Kamil Debskie65e4f12011-06-14 10:31:04 -03002514 </row>
2515 <row><entry spanname="descr">Force a frame type for the next queued buffer. Applicable to encoders.
2516Possible values are:</entry>
2517 </row>
2518 <row>
2519 <entrytbl spanname="descr" cols="2">
2520 <tbody valign="top">
2521 <row>
2522 <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_DISABLED</constant>&nbsp;</entry>
2523 <entry>Forcing a specific frame type disabled.</entry>
2524 </row>
2525 <row>
2526 <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_I_FRAME</constant>&nbsp;</entry>
2527 <entry>Force an I-frame.</entry>
2528 </row>
2529 <row>
2530 <entry><constant>V4L2_MPEG_MFC51_FORCE_FRAME_TYPE_NOT_CODED</constant>&nbsp;</entry>
2531 <entry>Force a non-coded frame.</entry>
2532 </row>
2533 </tbody>
2534 </entrytbl>
2535 </row>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03002536 </tbody>
2537 </tgroup>
2538 </table>
2539 </section>
2540
2541 <section>
2542 <title>CX2341x MPEG Controls</title>
2543
2544 <para>The following MPEG class controls deal with MPEG
2545encoding settings that are specific to the Conexant CX23415 and
2546CX23416 MPEG encoding chips.</para>
2547
2548 <table pgwide="1" frame="none" id="cx2341x-control-id">
2549 <title>CX2341x Control IDs</title>
2550 <tgroup cols="4">
2551 <colspec colname="c1" colwidth="1*" />
2552 <colspec colname="c2" colwidth="6*" />
2553 <colspec colname="c3" colwidth="2*" />
2554 <colspec colname="c4" colwidth="6*" />
2555 <spanspec namest="c1" nameend="c2" spanname="id" />
2556 <spanspec namest="c2" nameend="c4" spanname="descr" />
2557 <thead>
2558 <row>
2559 <entry spanname="id" align="left">ID</entry>
2560 <entry align="left">Type</entry>
2561 </row><row><entry spanname="descr" align="left">Description</entry>
2562 </row>
2563 </thead>
2564 <tbody valign="top">
2565 <row><entry></entry></row>
2566 <row id="v4l2-mpeg-cx2341x-video-spatial-filter-mode">
2567 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE</constant>&nbsp;</entry>
2568 <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_spatial_filter_mode</entry>
2569 </row><row><entry spanname="descr">Sets the Spatial
2570Filter mode (default <constant>MANUAL</constant>). Possible values
2571are:</entry>
2572 </row>
2573 <row>
2574 <entrytbl spanname="descr" cols="2">
2575 <tbody valign="top">
2576 <row>
2577 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
2578 <entry>Choose the filter manually</entry>
2579 </row>
2580 <row>
2581 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_SPATIAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
2582 <entry>Choose the filter automatically</entry>
2583 </row>
2584 </tbody>
2585 </entrytbl>
2586 </row>
2587 <row><entry></entry></row>
2588 <row>
2589 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_SPATIAL_FILTER</constant>&nbsp;</entry>
2590 <entry>integer&nbsp;(0-15)</entry>
2591 </row><row><entry spanname="descr">The setting for the
2592Spatial Filter. 0 = off, 15 = maximum. (Default is 0.)</entry>
2593 </row>
2594 <row><entry></entry></row>
2595 <row id="luma-spatial-filter-type">
2596 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
2597 <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_luma_spatial_filter_type</entry>
2598 </row><row><entry spanname="descr">Select the algorithm
2599to use for the Luma Spatial Filter (default
2600<constant>1D_HOR</constant>). Possible values:</entry>
2601 </row>
2602 <row>
2603 <entrytbl spanname="descr" cols="2">
2604 <tbody valign="top">
2605 <row>
2606 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
2607 <entry>No filter</entry>
2608 </row>
2609 <row>
2610 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
2611 <entry>One-dimensional horizontal</entry>
2612 </row>
2613 <row>
2614 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_1D_VERT</constant>&nbsp;</entry>
2615 <entry>One-dimensional vertical</entry>
2616 </row>
2617 <row>
2618 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_HV_SEPARABLE</constant>&nbsp;</entry>
2619 <entry>Two-dimensional separable</entry>
2620 </row>
2621 <row>
2622 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_LUMA_SPATIAL_FILTER_TYPE_2D_SYM_NON_SEPARABLE</constant>&nbsp;</entry>
2623 <entry>Two-dimensional symmetrical
2624non-separable</entry>
2625 </row>
2626 </tbody>
2627 </entrytbl>
2628 </row>
2629 <row><entry></entry></row>
2630 <row id="chroma-spatial-filter-type">
2631 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE</constant>&nbsp;</entry>
2632 <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_chroma_spatial_filter_type</entry>
2633 </row><row><entry spanname="descr">Select the algorithm
2634for the Chroma Spatial Filter (default <constant>1D_HOR</constant>).
2635Possible values are:</entry>
2636 </row>
2637 <row>
2638 <entrytbl spanname="descr" cols="2">
2639 <tbody valign="top">
2640 <row>
2641 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_OFF</constant>&nbsp;</entry>
2642 <entry>No filter</entry>
2643 </row>
2644 <row>
2645 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_CHROMA_SPATIAL_FILTER_TYPE_1D_HOR</constant>&nbsp;</entry>
2646 <entry>One-dimensional horizontal</entry>
2647 </row>
2648 </tbody>
2649 </entrytbl>
2650 </row>
2651 <row><entry></entry></row>
2652 <row id="v4l2-mpeg-cx2341x-video-temporal-filter-mode">
2653 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE</constant>&nbsp;</entry>
2654 <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_temporal_filter_mode</entry>
2655 </row><row><entry spanname="descr">Sets the Temporal
2656Filter mode (default <constant>MANUAL</constant>). Possible values
2657are:</entry>
2658 </row>
2659 <row>
2660 <entrytbl spanname="descr" cols="2">
2661 <tbody valign="top">
2662 <row>
2663 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_MANUAL</constant>&nbsp;</entry>
2664 <entry>Choose the filter manually</entry>
2665 </row>
2666 <row>
2667 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER_MODE_AUTO</constant>&nbsp;</entry>
2668 <entry>Choose the filter automatically</entry>
2669 </row>
2670 </tbody>
2671 </entrytbl>
2672 </row>
2673 <row><entry></entry></row>
2674 <row>
2675 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_TEMPORAL_FILTER</constant>&nbsp;</entry>
2676 <entry>integer&nbsp;(0-31)</entry>
2677 </row><row><entry spanname="descr">The setting for the
2678Temporal Filter. 0 = off, 31 = maximum. (Default is 8 for full-scale
2679capturing and 0 for scaled capturing.)</entry>
2680 </row>
2681 <row><entry></entry></row>
2682 <row id="v4l2-mpeg-cx2341x-video-median-filter-type">
2683 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE</constant>&nbsp;</entry>
2684 <entry>enum&nbsp;v4l2_mpeg_cx2341x_video_median_filter_type</entry>
2685 </row><row><entry spanname="descr">Median Filter Type
2686(default <constant>OFF</constant>). Possible values are:</entry>
2687 </row>
2688 <row>
2689 <entrytbl spanname="descr" cols="2">
2690 <tbody valign="top">
2691 <row>
2692 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_OFF</constant>&nbsp;</entry>
2693 <entry>No filter</entry>
2694 </row>
2695 <row>
2696 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR</constant>&nbsp;</entry>
2697 <entry>Horizontal filter</entry>
2698 </row>
2699 <row>
2700 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_VERT</constant>&nbsp;</entry>
2701 <entry>Vertical filter</entry>
2702 </row>
2703 <row>
2704 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_HOR_VERT</constant>&nbsp;</entry>
2705 <entry>Horizontal and vertical filter</entry>
2706 </row>
2707 <row>
2708 <entry><constant>V4L2_MPEG_CX2341X_VIDEO_MEDIAN_FILTER_TYPE_DIAG</constant>&nbsp;</entry>
2709 <entry>Diagonal filter</entry>
2710 </row>
2711 </tbody>
2712 </entrytbl>
2713 </row>
2714 <row><entry></entry></row>
2715 <row>
2716 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
2717 <entry>integer&nbsp;(0-255)</entry>
2718 </row><row><entry spanname="descr">Threshold above which
2719the luminance median filter is enabled (default 0)</entry>
2720 </row>
2721 <row><entry></entry></row>
2722 <row>
2723 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_LUMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
2724 <entry>integer&nbsp;(0-255)</entry>
2725 </row><row><entry spanname="descr">Threshold below which
2726the luminance median filter is enabled (default 255)</entry>
2727 </row>
2728 <row><entry></entry></row>
2729 <row>
2730 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_BOTTOM</constant>&nbsp;</entry>
2731 <entry>integer&nbsp;(0-255)</entry>
2732 </row><row><entry spanname="descr">Threshold above which
2733the chroma median filter is enabled (default 0)</entry>
2734 </row>
2735 <row><entry></entry></row>
2736 <row>
2737 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_VIDEO_CHROMA_MEDIAN_FILTER_TOP</constant>&nbsp;</entry>
2738 <entry>integer&nbsp;(0-255)</entry>
2739 </row><row><entry spanname="descr">Threshold below which
2740the chroma median filter is enabled (default 255)</entry>
2741 </row>
2742 <row><entry></entry></row>
2743 <row>
2744 <entry spanname="id"><constant>V4L2_CID_MPEG_CX2341X_STREAM_INSERT_NAV_PACKETS</constant>&nbsp;</entry>
2745 <entry>boolean</entry>
2746 </row>
2747 <row><entry spanname="descr">The CX2341X MPEG encoder
2748can insert one empty MPEG-2 PES packet into the stream between every
2749four video frames. The packet size is 2048 bytes, including the
2750packet_start_code_prefix and stream_id fields. The stream_id is 0xBF
2751(private stream 2). The payload consists of 0x00 bytes, to be filled
2752in by the application. 0 = do not insert, 1 = insert packets.</entry>
2753 </row>
2754 </tbody>
2755 </tgroup>
2756 </table>
2757 </section>
2758 </section>
2759
2760 <section id="camera-controls">
2761 <title>Camera Control Reference</title>
2762
2763 <para>The Camera class includes controls for mechanical (or
2764equivalent digital) features of a device such as controllable lenses
2765or sensors.</para>
2766
2767 <table pgwide="1" frame="none" id="camera-control-id">
2768 <title>Camera Control IDs</title>
2769 <tgroup cols="4">
2770 <colspec colname="c1" colwidth="1*" />
2771 <colspec colname="c2" colwidth="6*" />
2772 <colspec colname="c3" colwidth="2*" />
2773 <colspec colname="c4" colwidth="6*" />
2774 <spanspec namest="c1" nameend="c2" spanname="id" />
2775 <spanspec namest="c2" nameend="c4" spanname="descr" />
2776 <thead>
2777 <row>
2778 <entry spanname="id" align="left">ID</entry>
2779 <entry align="left">Type</entry>
2780 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
2781 </row>
2782 </thead>
2783 <tbody valign="top">
2784 <row><entry></entry></row>
2785 <row>
2786 <entry spanname="id"><constant>V4L2_CID_CAMERA_CLASS</constant>&nbsp;</entry>
2787 <entry>class</entry>
2788 </row><row><entry spanname="descr">The Camera class
2789descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
2790description of this control class.</entry>
2791 </row>
2792 <row><entry></entry></row>
2793
2794 <row id="v4l2-exposure-auto-type">
2795 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO</constant>&nbsp;</entry>
2796 <entry>enum&nbsp;v4l2_exposure_auto_type</entry>
2797 </row><row><entry spanname="descr">Enables automatic
2798adjustments of the exposure time and/or iris aperture. The effect of
2799manual changes of the exposure time or iris aperture while these
2800features are enabled is undefined, drivers should ignore such
2801requests. Possible values are:</entry>
2802 </row>
2803 <row>
2804 <entrytbl spanname="descr" cols="2">
2805 <tbody valign="top">
2806 <row>
2807 <entry><constant>V4L2_EXPOSURE_AUTO</constant>&nbsp;</entry>
2808 <entry>Automatic exposure time, automatic iris
2809aperture.</entry>
2810 </row>
2811 <row>
2812 <entry><constant>V4L2_EXPOSURE_MANUAL</constant>&nbsp;</entry>
2813 <entry>Manual exposure time, manual iris.</entry>
2814 </row>
2815 <row>
2816 <entry><constant>V4L2_EXPOSURE_SHUTTER_PRIORITY</constant>&nbsp;</entry>
2817 <entry>Manual exposure time, auto iris.</entry>
2818 </row>
2819 <row>
2820 <entry><constant>V4L2_EXPOSURE_APERTURE_PRIORITY</constant>&nbsp;</entry>
2821 <entry>Auto exposure time, manual iris.</entry>
2822 </row>
2823 </tbody>
2824 </entrytbl>
2825 </row>
2826 <row><entry></entry></row>
2827
2828 <row>
2829 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_ABSOLUTE</constant>&nbsp;</entry>
2830 <entry>integer</entry>
2831 </row><row><entry spanname="descr">Determines the exposure
2832time of the camera sensor. The exposure time is limited by the frame
2833interval. Drivers should interpret the values as 100 &micro;s units,
2834where the value 1 stands for 1/10000th of a second, 10000 for 1 second
2835and 100000 for 10 seconds.</entry>
2836 </row>
2837 <row><entry></entry></row>
2838
2839 <row>
2840 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_AUTO_PRIORITY</constant>&nbsp;</entry>
2841 <entry>boolean</entry>
2842 </row><row><entry spanname="descr">When
2843<constant>V4L2_CID_EXPOSURE_AUTO</constant> is set to
2844<constant>AUTO</constant> or <constant>APERTURE_PRIORITY</constant>,
2845this control determines if the device may dynamically vary the frame
2846rate. By default this feature is disabled (0) and the frame rate must
2847remain constant.</entry>
2848 </row>
2849 <row><entry></entry></row>
2850
2851 <row>
Sylwester Nawrockid58083c2012-03-06 07:06:55 -03002852 <entry spanname="id"><constant>V4L2_CID_EXPOSURE_BIAS</constant>&nbsp;</entry>
2853 <entry>integer menu</entry>
2854 </row><row><entry spanname="descr"> Determines the automatic
2855exposure compensation, it is effective only when <constant>V4L2_CID_EXPOSURE_AUTO</constant>
2856control is set to <constant>AUTO</constant>, <constant>SHUTTER_PRIORITY </constant>
2857or <constant>APERTURE_PRIORITY</constant>.
2858It is expressed in terms of EV, drivers should interpret the values as 0.001 EV
2859units, where the value 1000 stands for +1 EV.
2860<para>Increasing the exposure compensation value is equivalent to decreasing
2861the exposure value (EV) and will increase the amount of light at the image
2862sensor. The camera performs the exposure compensation by adjusting absolute
2863exposure time and/or aperture.</para></entry>
2864 </row>
2865 <row><entry></entry></row>
2866
2867 <row>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03002868 <entry spanname="id"><constant>V4L2_CID_PAN_RELATIVE</constant>&nbsp;</entry>
2869 <entry>integer</entry>
2870 </row><row><entry spanname="descr">This control turns the
2871camera horizontally by the specified amount. The unit is undefined. A
2872positive value moves the camera to the right (clockwise when viewed
2873from above), a negative value to the left. A value of zero does not
2874cause motion. This is a write-only control.</entry>
2875 </row>
2876 <row><entry></entry></row>
2877
2878 <row>
2879 <entry spanname="id"><constant>V4L2_CID_TILT_RELATIVE</constant>&nbsp;</entry>
2880 <entry>integer</entry>
2881 </row><row><entry spanname="descr">This control turns the
2882camera vertically by the specified amount. The unit is undefined. A
2883positive value moves the camera up, a negative value down. A value of
2884zero does not cause motion. This is a write-only control.</entry>
2885 </row>
2886 <row><entry></entry></row>
2887
2888 <row>
2889 <entry spanname="id"><constant>V4L2_CID_PAN_RESET</constant>&nbsp;</entry>
2890 <entry>button</entry>
2891 </row><row><entry spanname="descr">When this control is set,
2892the camera moves horizontally to the default position.</entry>
2893 </row>
2894 <row><entry></entry></row>
2895
2896 <row>
2897 <entry spanname="id"><constant>V4L2_CID_TILT_RESET</constant>&nbsp;</entry>
2898 <entry>button</entry>
2899 </row><row><entry spanname="descr">When this control is set,
2900the camera moves vertically to the default position.</entry>
2901 </row>
2902 <row><entry></entry></row>
2903
2904 <row>
2905 <entry spanname="id"><constant>V4L2_CID_PAN_ABSOLUTE</constant>&nbsp;</entry>
2906 <entry>integer</entry>
2907 </row><row><entry spanname="descr">This control
2908turns the camera horizontally to the specified position. Positive
2909values move the camera to the right (clockwise when viewed from above),
2910negative values to the left. Drivers should interpret the values as arc
2911seconds, with valid values between -180 * 3600 and +180 * 3600
2912inclusive.</entry>
2913 </row>
2914 <row><entry></entry></row>
2915
2916 <row>
2917 <entry spanname="id"><constant>V4L2_CID_TILT_ABSOLUTE</constant>&nbsp;</entry>
2918 <entry>integer</entry>
2919 </row><row><entry spanname="descr">This control
2920turns the camera vertically to the specified position. Positive values
2921move the camera up, negative values down. Drivers should interpret the
2922values as arc seconds, with valid values between -180 * 3600 and +180
2923* 3600 inclusive.</entry>
2924 </row>
2925 <row><entry></entry></row>
2926
2927 <row>
2928 <entry spanname="id"><constant>V4L2_CID_FOCUS_ABSOLUTE</constant>&nbsp;</entry>
2929 <entry>integer</entry>
2930 </row><row><entry spanname="descr">This control sets the
2931focal point of the camera to the specified position. The unit is
2932undefined. Positive values set the focus closer to the camera,
2933negative values towards infinity.</entry>
2934 </row>
2935 <row><entry></entry></row>
2936
2937 <row>
2938 <entry spanname="id"><constant>V4L2_CID_FOCUS_RELATIVE</constant>&nbsp;</entry>
2939 <entry>integer</entry>
2940 </row><row><entry spanname="descr">This control moves the
2941focal point of the camera by the specified amount. The unit is
2942undefined. Positive values move the focus closer to the camera,
2943negative values towards infinity. This is a write-only control.</entry>
2944 </row>
2945 <row><entry></entry></row>
2946
2947 <row>
2948 <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry>
2949 <entry>boolean</entry>
2950 </row><row><entry spanname="descr">Enables automatic focus
2951adjustments. The effect of manual focus adjustments while this feature
2952is enabled is undefined, drivers should ignore such requests.</entry>
2953 </row>
2954 <row><entry></entry></row>
2955
2956 <row>
2957 <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant>&nbsp;</entry>
2958 <entry>integer</entry>
2959 </row><row><entry spanname="descr">Specify the objective lens
2960focal length as an absolute value. The zoom unit is driver-specific and its
2961value should be a positive integer.</entry>
2962 </row>
2963 <row><entry></entry></row>
2964
2965 <row>
2966 <entry spanname="id"><constant>V4L2_CID_ZOOM_RELATIVE</constant>&nbsp;</entry>
2967 <entry>integer</entry>
2968 </row><row><entry spanname="descr">Specify the objective lens
2969focal length relatively to the current value. Positive values move the zoom
2970lens group towards the telephoto direction, negative values towards the
2971wide-angle direction. The zoom unit is driver-specific. This is a write-only control.</entry>
2972 </row>
2973 <row><entry></entry></row>
2974
2975 <row>
2976 <entry spanname="id"><constant>V4L2_CID_ZOOM_CONTINUOUS</constant>&nbsp;</entry>
2977 <entry>integer</entry>
2978 </row><row><entry spanname="descr">Move the objective lens group
2979at the specified speed until it reaches physical device limits or until an
2980explicit request to stop the movement. A positive value moves the zoom lens
2981group towards the telephoto direction. A value of zero stops the zoom lens
2982group movement. A negative value moves the zoom lens group towards the
2983wide-angle direction. The zoom speed unit is driver-specific.</entry>
2984 </row>
2985 <row><entry></entry></row>
2986
2987 <row>
Laurent Pinchart48213fe2010-01-20 12:12:57 -03002988 <entry spanname="id"><constant>V4L2_CID_IRIS_ABSOLUTE</constant>&nbsp;</entry>
2989 <entry>integer</entry>
2990 </row><row><entry spanname="descr">This control sets the
2991camera's aperture to the specified value. The unit is undefined.
2992Larger values open the iris wider, smaller values close it.</entry>
2993 </row>
2994 <row><entry></entry></row>
2995
2996 <row>
2997 <entry spanname="id"><constant>V4L2_CID_IRIS_RELATIVE</constant>&nbsp;</entry>
2998 <entry>integer</entry>
2999 </row><row><entry spanname="descr">This control modifies the
3000camera's aperture by the specified amount. The unit is undefined.
3001Positive values open the iris one step further, negative values close
3002it one step further. This is a write-only control.</entry>
3003 </row>
3004 <row><entry></entry></row>
3005
3006 <row>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03003007 <entry spanname="id"><constant>V4L2_CID_PRIVACY</constant>&nbsp;</entry>
3008 <entry>boolean</entry>
3009 </row><row><entry spanname="descr">Prevent video from being acquired
3010by the camera. When this control is set to <constant>TRUE</constant> (1), no
3011image can be captured by the camera. Common means to enforce privacy are
3012mechanical obturation of the sensor and firmware image processing, but the
3013device is not restricted to these methods. Devices that implement the privacy
3014control must support read access and may support write access.</entry>
3015 </row>
3016
3017 <row>
3018 <entry spanname="id"><constant>V4L2_CID_BAND_STOP_FILTER</constant>&nbsp;</entry>
3019 <entry>integer</entry>
3020 </row><row><entry spanname="descr">Switch the band-stop filter of a
3021camera sensor on or off, or specify its strength. Such band-stop filters can
3022be used, for example, to filter out the fluorescent light component.</entry>
3023 </row>
3024 <row><entry></entry></row>
Sylwester Nawrockie40a0572012-03-06 07:04:26 -03003025
3026 <row id="v4l2-auto-n-preset-white-balance">
3027 <entry spanname="id"><constant>V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE</constant>&nbsp;</entry>
3028 <entry>enum&nbsp;v4l2_auto_n_preset_white_balance</entry>
3029 </row><row><entry spanname="descr">Sets white balance to automatic,
3030manual or a preset. The presets determine color temperature of the light as
3031a hint to the camera for white balance adjustments resulting in most accurate
3032color representation. The following white balance presets are listed in order
3033of increasing color temperature.</entry>
3034 </row>
3035 <row>
3036 <entrytbl spanname="descr" cols="2">
3037 <tbody valign="top">
3038 <row>
3039 <entry><constant>V4L2_WHITE_BALANCE_MANUAL</constant>&nbsp;</entry>
3040 <entry>Manual white balance.</entry>
3041 </row>
3042 <row>
3043 <entry><constant>V4L2_WHITE_BALANCE_AUTO</constant>&nbsp;</entry>
3044 <entry>Automatic white balance adjustments.</entry>
3045 </row>
3046 <row>
3047 <entry><constant>V4L2_WHITE_BALANCE_INCANDESCENT</constant>&nbsp;</entry>
3048 <entry>White balance setting for incandescent (tungsten) lighting.
3049It generally cools down the colors and corresponds approximately to 2500...3500 K
3050color temperature range.</entry>
3051 </row>
3052 <row>
3053 <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT</constant>&nbsp;</entry>
3054 <entry>White balance preset for fluorescent lighting.
3055It corresponds approximately to 4000...5000 K color temperature.</entry>
3056 </row>
3057 <row>
3058 <entry><constant>V4L2_WHITE_BALANCE_FLUORESCENT_H</constant>&nbsp;</entry>
3059 <entry>With this setting the camera will compensate for
3060fluorescent H lighting.</entry>
3061 </row>
3062 <row>
3063 <entry><constant>V4L2_WHITE_BALANCE_HORIZON</constant>&nbsp;</entry>
3064 <entry>White balance setting for horizon daylight.
3065It corresponds approximately to 5000 K color temperature.</entry>
3066 </row>
3067 <row>
3068 <entry><constant>V4L2_WHITE_BALANCE_DAYLIGHT</constant>&nbsp;</entry>
3069 <entry>White balance preset for daylight (with clear sky).
3070It corresponds approximately to 5000...6500 K color temperature.</entry>
3071 </row>
3072 <row>
3073 <entry><constant>V4L2_WHITE_BALANCE_FLASH</constant>&nbsp;</entry>
3074 <entry>With this setting the camera will compensate for the flash
3075light. It slightly warms up the colors and corresponds roughly to 5000...5500 K
3076color temperature.</entry>
3077 </row>
3078 <row>
3079 <entry><constant>V4L2_WHITE_BALANCE_CLOUDY</constant>&nbsp;</entry>
3080 <entry>White balance preset for moderately overcast sky.
3081This option corresponds approximately to 6500...8000 K color temperature
3082range.</entry>
3083 </row>
3084 <row>
3085 <entry><constant>V4L2_WHITE_BALANCE_SHADE</constant>&nbsp;</entry>
3086 <entry>White balance preset for shade or heavily overcast
3087sky. It corresponds approximately to 9000...10000 K color temperature.
3088</entry>
3089 </row>
3090 </tbody>
3091 </entrytbl>
3092 </row>
3093 <row><entry></entry></row>
3094
Sylwester Nawrocki44d44a12012-03-06 07:05:45 -03003095 <row id="v4l2-wide-dynamic-range">
3096 <entry spanname="id"><constant>V4L2_CID_WIDE_DYNAMIC_RANGE</constant></entry>
3097 <entry>boolean</entry>
3098 </row>
3099 <row>
3100 <entry spanname="descr">Enables or disables the camera's wide dynamic
3101range feature. This feature allows to obtain clear images in situations where
3102intensity of the illumination varies significantly throughout the scene, i.e.
3103there are simultaneously very dark and very bright areas. It is most commonly
3104realized in cameras by combining two subsequent frames with different exposure
3105times. <footnote id="ctypeconv"><para> This control may be changed to a menu
3106control in the future, if more options are required.</para></footnote></entry>
3107 </row>
3108 <row><entry></entry></row>
3109
Sylwester Nawrocki82b30562012-05-01 17:38:09 -03003110 <row id="v4l2-image-stabilization">
3111 <entry spanname="id"><constant>V4L2_CID_IMAGE_STABILIZATION</constant></entry>
3112 <entry>boolean</entry>
3113 </row>
3114 <row>
3115 <entry spanname="descr">Enables or disables image stabilization.
3116 <footnoteref linkend="ctypeconv"/></entry>
3117 </row>
3118 <row><entry></entry></row>
3119
Sylwester Nawrocki7f84ad82012-05-01 17:39:45 -03003120 <row>
3121 <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY</constant>&nbsp;</entry>
3122 <entry>integer menu</entry>
3123 </row><row><entry spanname="descr">Determines ISO equivalent of an
3124image sensor indicating the sensor's sensitivity to light. The numbers are
3125expressed in arithmetic scale, as per <xref linkend="iso12232" /> standard,
3126where doubling the sensor sensitivity is represented by doubling the numerical
3127ISO value. Applications should interpret the values as standard ISO values
3128multiplied by 1000, e.g. control value 800 stands for ISO 0.8. Drivers will
3129usually support only a subset of standard ISO values. The effect of setting
3130this control while the <constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>
3131control is set to a value other than <constant>V4L2_CID_ISO_SENSITIVITY_MANUAL
3132</constant> is undefined, drivers should ignore such requests.</entry>
3133 </row>
3134 <row><entry></entry></row>
3135
3136 <row id="v4l2-iso-sensitivity-auto-type">
3137 <entry spanname="id"><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>&nbsp;</entry>
3138 <entry>enum&nbsp;v4l2_iso_sensitivity_type</entry>
3139 </row><row><entry spanname="descr">Enables or disables automatic ISO
3140sensitivity adjustments.</entry>
3141 </row>
3142 <row>
3143 <entrytbl spanname="descr" cols="2">
3144 <tbody valign="top">
3145 <row>
3146 <entry><constant>V4L2_CID_ISO_SENSITIVITY_MANUAL</constant>&nbsp;</entry>
3147 <entry>Manual ISO sensitivity.</entry>
3148 </row>
3149 <row>
3150 <entry><constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>&nbsp;</entry>
3151 <entry>Automatic ISO sensitivity adjustments.</entry>
3152 </row>
3153 </tbody>
3154 </entrytbl>
3155 </row>
3156 <row><entry></entry></row>
3157
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03003158 </tbody>
3159 </tgroup>
3160 </table>
3161 </section>
3162
3163 <section id="fm-tx-controls">
3164 <title>FM Transmitter Control Reference</title>
3165
3166 <para>The FM Transmitter (FM_TX) class includes controls for common features of
3167FM transmissions capable devices. Currently this class includes parameters for audio
3168compression, pilot tone generation, audio deviation limiter, RDS transmission and
3169tuning power features.</para>
3170
3171 <table pgwide="1" frame="none" id="fm-tx-control-id">
3172 <title>FM_TX Control IDs</title>
3173
3174 <tgroup cols="4">
3175 <colspec colname="c1" colwidth="1*" />
3176 <colspec colname="c2" colwidth="6*" />
3177 <colspec colname="c3" colwidth="2*" />
3178 <colspec colname="c4" colwidth="6*" />
3179 <spanspec namest="c1" nameend="c2" spanname="id" />
3180 <spanspec namest="c2" nameend="c4" spanname="descr" />
3181 <thead>
3182 <row>
3183 <entry spanname="id" align="left">ID</entry>
3184 <entry align="left">Type</entry>
3185 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
3186 </row>
3187 </thead>
3188 <tbody valign="top">
3189 <row><entry></entry></row>
3190 <row>
3191 <entry spanname="id"><constant>V4L2_CID_FM_TX_CLASS</constant>&nbsp;</entry>
3192 <entry>class</entry>
3193 </row><row><entry spanname="descr">The FM_TX class
3194descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
3195description of this control class.</entry>
3196 </row>
3197 <row>
3198 <entry spanname="id"><constant>V4L2_CID_RDS_TX_DEVIATION</constant>&nbsp;</entry>
3199 <entry>integer</entry>
3200 </row>
3201 <row><entry spanname="descr">Configures RDS signal frequency deviation level in Hz.
3202The range and step are driver-specific.</entry>
3203 </row>
3204 <row>
3205 <entry spanname="id"><constant>V4L2_CID_RDS_TX_PI</constant>&nbsp;</entry>
3206 <entry>integer</entry>
3207 </row>
3208 <row><entry spanname="descr">Sets the RDS Programme Identification field
3209for transmission.</entry>
3210 </row>
3211 <row>
3212 <entry spanname="id"><constant>V4L2_CID_RDS_TX_PTY</constant>&nbsp;</entry>
3213 <entry>integer</entry>
3214 </row>
3215 <row><entry spanname="descr">Sets the RDS Programme Type field for transmission.
3216This encodes up to 31 pre-defined programme types.</entry>
3217 </row>
3218 <row>
3219 <entry spanname="id"><constant>V4L2_CID_RDS_TX_PS_NAME</constant>&nbsp;</entry>
3220 <entry>string</entry>
3221 </row>
3222 <row><entry spanname="descr">Sets the Programme Service name (PS_NAME) for transmission.
3223It is intended for static display on a receiver. It is the primary aid to listeners in programme service
3224identification and selection. In Annex E of <xref linkend="en50067" />, the RDS specification,
3225there is a full description of the correct character encoding for Programme Service name strings.
3226Also from RDS specification, PS is usually a single eight character text. However, it is also possible
3227to find receivers which can scroll strings sized as 8 x N characters. So, this control must be configured
3228with steps of 8 characters. The result is it must always contain a string with size multiple of 8.</entry>
3229 </row>
3230 <row>
3231 <entry spanname="id"><constant>V4L2_CID_RDS_TX_RADIO_TEXT</constant>&nbsp;</entry>
3232 <entry>string</entry>
3233 </row>
3234 <row><entry spanname="descr">Sets the Radio Text info for transmission. It is a textual description of
3235what is being broadcasted. RDS Radio Text can be applied when broadcaster wishes to transmit longer PS names,
3236programme-related information or any other text. In these cases, RadioText should be used in addition to
3237<constant>V4L2_CID_RDS_TX_PS_NAME</constant>. The encoding for Radio Text strings is also fully described
3238in Annex E of <xref linkend="en50067" />. The length of Radio Text strings depends on which RDS Block is being
3239used to transmit it, either 32 (2A block) or 64 (2B block). However, it is also possible
3240to find receivers which can scroll strings sized as 32 x N or 64 x N characters. So, this control must be configured
3241with steps of 32 or 64 characters. The result is it must always contain a string with size multiple of 32 or 64. </entry>
3242 </row>
3243 <row>
3244 <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_ENABLED</constant>&nbsp;</entry>
3245 <entry>boolean</entry>
3246 </row>
3247 <row><entry spanname="descr">Enables or disables the audio deviation limiter feature.
3248The limiter is useful when trying to maximize the audio volume, minimize receiver-generated
3249distortion and prevent overmodulation.
3250</entry>
3251 </row>
3252 <row>
3253 <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_RELEASE_TIME</constant>&nbsp;</entry>
3254 <entry>integer</entry>
3255 </row>
3256 <row><entry spanname="descr">Sets the audio deviation limiter feature release time.
3257Unit is in useconds. Step and range are driver-specific.</entry>
3258 </row>
3259 <row>
3260 <entry spanname="id"><constant>V4L2_CID_AUDIO_LIMITER_DEVIATION</constant>&nbsp;</entry>
3261 <entry>integer</entry>
3262 </row>
3263 <row><entry spanname="descr">Configures audio frequency deviation level in Hz.
3264The range and step are driver-specific.</entry>
3265 </row>
3266 <row>
3267 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ENABLED</constant>&nbsp;</entry>
3268 <entry>boolean</entry>
3269 </row>
3270 <row><entry spanname="descr">Enables or disables the audio compression feature.
3271This feature amplifies signals below the threshold by a fixed gain and compresses audio
3272signals above the threshold by the ratio of Threshold/(Gain + Threshold).</entry>
3273 </row>
3274 <row>
3275 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_GAIN</constant>&nbsp;</entry>
3276 <entry>integer</entry>
3277 </row>
3278 <row><entry spanname="descr">Sets the gain for audio compression feature. It is
3279a dB value. The range and step are driver-specific.</entry>
3280 </row>
3281 <row>
3282 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_THRESHOLD</constant>&nbsp;</entry>
3283 <entry>integer</entry>
3284 </row>
3285 <row><entry spanname="descr">Sets the threshold level for audio compression freature.
3286It is a dB value. The range and step are driver-specific.</entry>
3287 </row>
3288 <row>
3289 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_ATTACK_TIME</constant>&nbsp;</entry>
3290 <entry>integer</entry>
3291 </row>
3292 <row><entry spanname="descr">Sets the attack time for audio compression feature.
3293It is a useconds value. The range and step are driver-specific.</entry>
3294 </row>
3295 <row>
3296 <entry spanname="id"><constant>V4L2_CID_AUDIO_COMPRESSION_RELEASE_TIME</constant>&nbsp;</entry>
3297 <entry>integer</entry>
3298 </row>
3299 <row><entry spanname="descr">Sets the release time for audio compression feature.
3300It is a useconds value. The range and step are driver-specific.</entry>
3301 </row>
3302 <row>
3303 <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_ENABLED</constant>&nbsp;</entry>
3304 <entry>boolean</entry>
3305 </row>
3306 <row><entry spanname="descr">Enables or disables the pilot tone generation feature.</entry>
3307 </row>
3308 <row>
3309 <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_DEVIATION</constant>&nbsp;</entry>
3310 <entry>integer</entry>
3311 </row>
3312 <row><entry spanname="descr">Configures pilot tone frequency deviation level. Unit is
3313in Hz. The range and step are driver-specific.</entry>
3314 </row>
3315 <row>
3316 <entry spanname="id"><constant>V4L2_CID_PILOT_TONE_FREQUENCY</constant>&nbsp;</entry>
3317 <entry>integer</entry>
3318 </row>
3319 <row><entry spanname="descr">Configures pilot tone frequency value. Unit is
3320in Hz. The range and step are driver-specific.</entry>
3321 </row>
3322 <row>
3323 <entry spanname="id"><constant>V4L2_CID_TUNE_PREEMPHASIS</constant>&nbsp;</entry>
3324 <entry>integer</entry>
3325 </row>
3326 <row id="v4l2-preemphasis"><entry spanname="descr">Configures the pre-emphasis value for broadcasting.
3327A pre-emphasis filter is applied to the broadcast to accentuate the high audio frequencies.
3328Depending on the region, a time constant of either 50 or 75 useconds is used. The enum&nbsp;v4l2_preemphasis
3329defines possible values for pre-emphasis. Here they are:</entry>
3330 </row><row>
3331 <entrytbl spanname="descr" cols="2">
3332 <tbody valign="top">
3333 <row>
3334 <entry><constant>V4L2_PREEMPHASIS_DISABLED</constant>&nbsp;</entry>
3335 <entry>No pre-emphasis is applied.</entry>
3336 </row>
3337 <row>
3338 <entry><constant>V4L2_PREEMPHASIS_50_uS</constant>&nbsp;</entry>
3339 <entry>A pre-emphasis of 50 uS is used.</entry>
3340 </row>
3341 <row>
3342 <entry><constant>V4L2_PREEMPHASIS_75_uS</constant>&nbsp;</entry>
3343 <entry>A pre-emphasis of 75 uS is used.</entry>
3344 </row>
3345 </tbody>
3346 </entrytbl>
3347
3348 </row>
3349 <row>
3350 <entry spanname="id"><constant>V4L2_CID_TUNE_POWER_LEVEL</constant>&nbsp;</entry>
3351 <entry>integer</entry>
3352 </row>
3353 <row><entry spanname="descr">Sets the output power level for signal transmission.
3354Unit is in dBuV. Range and step are driver-specific.</entry>
3355 </row>
3356 <row>
3357 <entry spanname="id"><constant>V4L2_CID_TUNE_ANTENNA_CAPACITOR</constant>&nbsp;</entry>
3358 <entry>integer</entry>
3359 </row>
3360 <row><entry spanname="descr">This selects the value of antenna tuning capacitor
3361manually or automatically if set to zero. Unit, range and step are driver-specific.</entry>
3362 </row>
3363 <row><entry></entry></row>
3364 </tbody>
3365 </tgroup>
3366 </table>
3367
3368<para>For more details about RDS specification, refer to
3369<xref linkend="en50067" /> document, from CENELEC.</para>
3370 </section>
Sakari Ailus7ba85fa2011-05-04 10:45:58 -03003371
3372 <section id="flash-controls">
3373 <title>Flash Control Reference</title>
3374
3375 <note>
3376 <title>Experimental</title>
3377
3378 <para>This is an <link linkend="experimental">experimental</link>
3379interface and may change in the future.</para>
3380 </note>
3381
3382 <para>
3383 The V4L2 flash controls are intended to provide generic access
3384 to flash controller devices. Flash controller devices are
3385 typically used in digital cameras.
3386 </para>
3387
3388 <para>
3389 The interface can support both LED and xenon flash devices. As
3390 of writing this, there is no xenon flash driver using this
3391 interface.
3392 </para>
3393
3394 <section id="flash-controls-use-cases">
3395 <title>Supported use cases</title>
3396
3397 <section>
3398 <title>Unsynchronised LED flash (software strobe)</title>
3399
3400 <para>
3401 Unsynchronised LED flash is controlled directly by the
3402 host as the sensor. The flash must be enabled by the host
3403 before the exposure of the image starts and disabled once
3404 it ends. The host is fully responsible for the timing of
3405 the flash.
3406 </para>
3407
3408 <para>Example of such device: Nokia N900.</para>
3409 </section>
3410
3411 <section>
3412 <title>Synchronised LED flash (hardware strobe)</title>
3413
3414 <para>
3415 The synchronised LED flash is pre-programmed by the host
3416 (power and timeout) but controlled by the sensor through a
3417 strobe signal from the sensor to the flash.
3418 </para>
3419
3420 <para>
3421 The sensor controls the flash duration and timing. This
3422 information typically must be made available to the
3423 sensor.
3424 </para>
3425
3426 </section>
3427
3428 <section>
3429 <title>LED flash as torch</title>
3430
3431 <para>
3432 LED flash may be used as torch in conjunction with another
3433 use case involving camera or individually.
3434 </para>
3435
3436 </section>
3437
3438 </section>
3439
3440 <table pgwide="1" frame="none" id="flash-control-id">
3441 <title>Flash Control IDs</title>
3442
3443 <tgroup cols="4">
3444 <colspec colname="c1" colwidth="1*" />
3445 <colspec colname="c2" colwidth="6*" />
3446 <colspec colname="c3" colwidth="2*" />
3447 <colspec colname="c4" colwidth="6*" />
3448 <spanspec namest="c1" nameend="c2" spanname="id" />
3449 <spanspec namest="c2" nameend="c4" spanname="descr" />
3450 <thead>
3451 <row>
3452 <entry spanname="id" align="left">ID</entry>
3453 <entry align="left">Type</entry>
3454 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
3455 </row>
3456 </thead>
3457 <tbody valign="top">
3458 <row><entry></entry></row>
3459 <row>
3460 <entry spanname="id"><constant>V4L2_CID_FLASH_CLASS</constant></entry>
3461 <entry>class</entry>
3462 </row>
3463 <row>
3464 <entry spanname="descr">The FLASH class descriptor.</entry>
3465 </row>
3466 <row>
3467 <entry spanname="id"><constant>V4L2_CID_FLASH_LED_MODE</constant></entry>
3468 <entry>menu</entry>
3469 </row>
3470 <row id="v4l2-flash-led-mode">
3471 <entry spanname="descr">Defines the mode of the flash LED,
3472 the high-power white LED attached to the flash controller.
3473 Setting this control may not be possible in presence of
3474 some faults. See V4L2_CID_FLASH_FAULT.</entry>
3475 </row>
3476 <row>
3477 <entrytbl spanname="descr" cols="2">
3478 <tbody valign="top">
3479 <row>
3480 <entry><constant>V4L2_FLASH_LED_MODE_NONE</constant></entry>
3481 <entry>Off.</entry>
3482 </row>
3483 <row>
3484 <entry><constant>V4L2_FLASH_LED_MODE_FLASH</constant></entry>
3485 <entry>Flash mode.</entry>
3486 </row>
3487 <row>
3488 <entry><constant>V4L2_FLASH_LED_MODE_TORCH</constant></entry>
3489 <entry>Torch mode. See V4L2_CID_FLASH_TORCH_INTENSITY.</entry>
3490 </row>
3491 </tbody>
3492 </entrytbl>
3493 </row>
3494 <row>
3495 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_SOURCE</constant></entry>
3496 <entry>menu</entry>
3497 </row>
3498 <row id="v4l2-flash-strobe-source"><entry
3499 spanname="descr">Defines the source of the flash LED
3500 strobe.</entry>
3501 </row>
3502 <row>
3503 <entrytbl spanname="descr" cols="2">
3504 <tbody valign="top">
3505 <row>
3506 <entry><constant>V4L2_FLASH_STROBE_SOURCE_SOFTWARE</constant></entry>
3507 <entry>The flash strobe is triggered by using
3508 the V4L2_CID_FLASH_STROBE control.</entry>
3509 </row>
3510 <row>
3511 <entry><constant>V4L2_FLASH_STROBE_SOURCE_EXTERNAL</constant></entry>
3512 <entry>The flash strobe is triggered by an
3513 external source. Typically this is a sensor,
3514 which makes it possible to synchronises the
3515 flash strobe start to exposure start.</entry>
3516 </row>
3517 </tbody>
3518 </entrytbl>
3519 </row>
3520 <row>
3521 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE</constant></entry>
3522 <entry>button</entry>
3523 </row>
3524 <row>
3525 <entry spanname="descr">Strobe flash. Valid when
3526 V4L2_CID_FLASH_LED_MODE is set to
3527 V4L2_FLASH_LED_MODE_FLASH and V4L2_CID_FLASH_STROBE_SOURCE
3528 is set to V4L2_FLASH_STROBE_SOURCE_SOFTWARE. Setting this
3529 control may not be possible in presence of some faults.
3530 See V4L2_CID_FLASH_FAULT.</entry>
3531 </row>
3532 <row>
3533 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STOP</constant></entry>
3534 <entry>button</entry>
3535 </row>
3536 <row><entry spanname="descr">Stop flash strobe immediately.</entry>
3537 </row>
3538 <row>
3539 <entry spanname="id"><constant>V4L2_CID_FLASH_STROBE_STATUS</constant></entry>
3540 <entry>boolean</entry>
3541 </row>
3542 <row>
3543 <entry spanname="descr">Strobe status: whether the flash
3544 is strobing at the moment or not. This is a read-only
3545 control.</entry>
3546 </row>
3547 <row>
3548 <entry spanname="id"><constant>V4L2_CID_FLASH_TIMEOUT</constant></entry>
3549 <entry>integer</entry>
3550 </row>
3551 <row>
3552 <entry spanname="descr">Hardware timeout for flash. The
3553 flash strobe is stopped after this period of time has
3554 passed from the start of the strobe.</entry>
3555 </row>
3556 <row>
3557 <entry spanname="id"><constant>V4L2_CID_FLASH_INTENSITY</constant></entry>
3558 <entry>integer</entry>
3559 </row>
3560 <row>
3561 <entry spanname="descr">Intensity of the flash strobe when
3562 the flash LED is in flash mode
3563 (V4L2_FLASH_LED_MODE_FLASH). The unit should be milliamps
3564 (mA) if possible.</entry>
3565 </row>
3566 <row>
3567 <entry spanname="id"><constant>V4L2_CID_FLASH_TORCH_INTENSITY</constant></entry>
3568 <entry>integer</entry>
3569 </row>
3570 <row>
3571 <entry spanname="descr">Intensity of the flash LED in
3572 torch mode (V4L2_FLASH_LED_MODE_TORCH). The unit should be
3573 milliamps (mA) if possible. Setting this control may not
3574 be possible in presence of some faults. See
3575 V4L2_CID_FLASH_FAULT.</entry>
3576 </row>
3577 <row>
3578 <entry spanname="id"><constant>V4L2_CID_FLASH_INDICATOR_INTENSITY</constant></entry>
3579 <entry>integer</entry>
3580 </row>
3581 <row>
3582 <entry spanname="descr">Intensity of the indicator LED.
3583 The indicator LED may be fully independent of the flash
3584 LED. The unit should be microamps (uA) if possible.</entry>
3585 </row>
3586 <row>
3587 <entry spanname="id"><constant>V4L2_CID_FLASH_FAULT</constant></entry>
3588 <entry>bitmask</entry>
3589 </row>
3590 <row>
3591 <entry spanname="descr">Faults related to the flash. The
3592 faults tell about specific problems in the flash chip
3593 itself or the LEDs attached to it. Faults may prevent
3594 further use of some of the flash controls. In particular,
3595 V4L2_CID_FLASH_LED_MODE is set to V4L2_FLASH_LED_MODE_NONE
3596 if the fault affects the flash LED. Exactly which faults
3597 have such an effect is chip dependent. Reading the faults
3598 resets the control and returns the chip to a usable state
3599 if possible.</entry>
3600 </row>
3601 <row>
3602 <entrytbl spanname="descr" cols="2">
3603 <tbody valign="top">
3604 <row>
3605 <entry><constant>V4L2_FLASH_FAULT_OVER_VOLTAGE</constant></entry>
3606 <entry>Flash controller voltage to the flash LED
3607 has exceeded the limit specific to the flash
3608 controller.</entry>
3609 </row>
3610 <row>
3611 <entry><constant>V4L2_FLASH_FAULT_TIMEOUT</constant></entry>
3612 <entry>The flash strobe was still on when
3613 the timeout set by the user ---
3614 V4L2_CID_FLASH_TIMEOUT control --- has expired.
3615 Not all flash controllers may set this in all
3616 such conditions.</entry>
3617 </row>
3618 <row>
3619 <entry><constant>V4L2_FLASH_FAULT_OVER_TEMPERATURE</constant></entry>
3620 <entry>The flash controller has overheated.</entry>
3621 </row>
3622 <row>
3623 <entry><constant>V4L2_FLASH_FAULT_SHORT_CIRCUIT</constant></entry>
3624 <entry>The short circuit protection of the flash
3625 controller has been triggered.</entry>
3626 </row>
Laurent Pincharta597fa72011-06-10 12:23:30 -03003627 <row>
3628 <entry><constant>V4L2_FLASH_FAULT_OVER_CURRENT</constant></entry>
3629 <entry>Current in the LED power supply has exceeded the limit
3630 specific to the flash controller.</entry>
3631 </row>
3632 <row>
3633 <entry><constant>V4L2_FLASH_FAULT_INDICATOR</constant></entry>
3634 <entry>The flash controller has detected a short or open
3635 circuit condition on the indicator LED.</entry>
3636 </row>
Sakari Ailus7ba85fa2011-05-04 10:45:58 -03003637 </tbody>
3638 </entrytbl>
3639 </row>
3640 <row>
3641 <entry spanname="id"><constant>V4L2_CID_FLASH_CHARGE</constant></entry>
3642 <entry>boolean</entry>
3643 </row>
3644 <row><entry spanname="descr">Enable or disable charging of the xenon
3645 flash capacitor.</entry>
3646 </row>
3647 <row>
3648 <entry spanname="id"><constant>V4L2_CID_FLASH_READY</constant></entry>
3649 <entry>boolean</entry>
3650 </row>
3651 <row>
3652 <entry spanname="descr">Is the flash ready to strobe?
3653 Xenon flashes require their capacitors charged before
3654 strobing. LED flashes often require a cooldown period
3655 after strobe during which another strobe will not be
3656 possible. This is a read-only control.</entry>
3657 </row>
3658 <row><entry></entry></row>
3659 </tbody>
3660 </tgroup>
3661 </table>
Sylwester Nawrocki29fa0ee2012-01-20 15:38:50 -03003662 </section>
Sakari Ailus7ba85fa2011-05-04 10:45:58 -03003663
Sylwester Nawrocki29fa0ee2012-01-20 15:38:50 -03003664 <section id="jpeg-controls">
3665 <title>JPEG Control Reference</title>
3666 <para>The JPEG class includes controls for common features of JPEG
3667 encoders and decoders. Currently it includes features for codecs
3668 implementing progressive baseline DCT compression process with
3669 Huffman entrophy coding.</para>
3670 <table pgwide="1" frame="none" id="jpeg-control-id">
3671 <title>JPEG Control IDs</title>
3672
3673 <tgroup cols="4">
3674 <colspec colname="c1" colwidth="1*" />
3675 <colspec colname="c2" colwidth="6*" />
3676 <colspec colname="c3" colwidth="2*" />
3677 <colspec colname="c4" colwidth="6*" />
3678 <spanspec namest="c1" nameend="c2" spanname="id" />
3679 <spanspec namest="c2" nameend="c4" spanname="descr" />
3680 <thead>
3681 <row>
3682 <entry spanname="id" align="left">ID</entry>
3683 <entry align="left">Type</entry>
3684 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
3685 </row>
3686 </thead>
3687 <tbody valign="top">
3688 <row><entry></entry></row>
3689 <row>
3690 <entry spanname="id"><constant>V4L2_CID_JPEG_CLASS</constant>&nbsp;</entry>
3691 <entry>class</entry>
3692 </row><row><entry spanname="descr">The JPEG class descriptor. Calling
3693 &VIDIOC-QUERYCTRL; for this control will return a description of this
3694 control class.
3695
3696 </entry>
3697 </row>
3698 <row>
3699 <entry spanname="id"><constant>V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant></entry>
3700 <entry>menu</entry>
3701 </row>
3702 <row id="jpeg-chroma-subsampling-control">
3703 <entry spanname="descr">The chroma subsampling factors describe how
3704 each component of an input image is sampled, in respect to maximum
3705 sample rate in each spatial dimension. See <xref linkend="itu-t81"/>,
3706 clause A.1.1. for more details. The <constant>
3707 V4L2_CID_JPEG_CHROMA_SUBSAMPLING</constant> control determines how
3708 Cb and Cr components are downsampled after coverting an input image
3709 from RGB to Y'CbCr color space.
3710 </entry>
3711 </row>
Sylwester Nawrockifeed0252012-03-31 05:43:55 -03003712 <row id = "v4l2-jpeg-chroma-subsampling">
Sylwester Nawrocki29fa0ee2012-01-20 15:38:50 -03003713 <entrytbl spanname="descr" cols="2">
3714 <tbody valign="top">
3715 <row>
3716 <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_444</constant>
3717 </entry><entry>No chroma subsampling, each pixel has
3718 Y, Cr and Cb values.</entry>
3719 </row>
3720 <row>
3721 <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_422</constant>
3722 </entry><entry>Horizontally subsample Cr, Cb components
3723 by a factor of 2.</entry>
3724 </row>
3725 <row>
3726 <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_420</constant>
3727 </entry><entry>Subsample Cr, Cb components horizontally
3728 and vertically by 2.</entry>
3729 </row>
3730 <row>
3731 <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_411</constant>
3732 </entry><entry>Horizontally subsample Cr, Cb components
3733 by a factor of 4.</entry>
3734 </row>
3735 <row>
3736 <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_410</constant>
3737 </entry><entry>Subsample Cr, Cb components horizontally
3738 by 4 and vertically by 2.</entry>
3739 </row>
3740 <row>
3741 <entry><constant>V4L2_JPEG_CHROMA_SUBSAMPLING_GRAY</constant>
3742 </entry><entry>Use only luminance component.</entry>
3743 </row>
3744 </tbody>
3745 </entrytbl>
3746 </row>
3747 <row>
3748 <entry spanname="id"><constant>V4L2_CID_JPEG_RESTART_INTERVAL</constant>
3749 </entry><entry>integer</entry>
3750 </row>
3751 <row><entry spanname="descr">
3752 The restart interval determines an interval of inserting RSTm
3753 markers (m = 0..7). The purpose of these markers is to additionally
3754 reinitialize the encoder process, in order to process blocks of
3755 an image independently.
3756 For the lossy compression processes the restart interval unit is
3757 MCU (Minimum Coded Unit) and its value is contained in DRI
3758 (Define Restart Interval) marker. If <constant>
3759 V4L2_CID_JPEG_RESTART_INTERVAL</constant> control is set to 0,
3760 DRI and RSTm markers will not be inserted.
3761 </entry>
3762 </row>
3763 <row id="jpeg-quality-control">
Hans Verkuil7a1d0822012-04-26 07:39:14 -03003764 <entry spanname="id"><constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant></entry>
Sylwester Nawrocki29fa0ee2012-01-20 15:38:50 -03003765 <entry>integer</entry>
3766 </row>
3767 <row>
3768 <entry spanname="descr">
Hans Verkuil7a1d0822012-04-26 07:39:14 -03003769 <constant>V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control
Sylwester Nawrocki29fa0ee2012-01-20 15:38:50 -03003770 determines trade-off between image quality and size.
3771 It provides simpler method for applications to control image quality,
3772 without a need for direct reconfiguration of luminance and chrominance
3773 quantization tables.
3774
3775 In cases where a driver uses quantization tables configured directly
3776 by an application, using interfaces defined elsewhere, <constant>
Hans Verkuil7a1d0822012-04-26 07:39:14 -03003777 V4L2_CID_JPEG_COMPRESSION_QUALITY</constant> control should be set
Sylwester Nawrocki29fa0ee2012-01-20 15:38:50 -03003778 by driver to 0.
3779
3780 <para>The value range of this control is driver-specific. Only
3781 positive, non-zero values are meaningful. The recommended range
3782 is 1 - 100, where larger values correspond to better image quality.
3783 </para>
3784 </entry>
3785 </row>
3786 <row id="jpeg-active-marker-control">
3787 <entry spanname="id"><constant>V4L2_CID_JPEG_ACTIVE_MARKER</constant></entry>
3788 <entry>bitmask</entry>
3789 </row>
3790 <row>
3791 <entry spanname="descr">Specify which JPEG markers are included
3792 in compressed stream. This control is valid only for encoders.
3793 </entry>
3794 </row>
3795 <row>
3796 <entrytbl spanname="descr" cols="2">
3797 <tbody valign="top">
3798 <row>
3799 <entry><constant>V4L2_JPEG_ACTIVE_MARKER_APP0</constant></entry>
3800 <entry>Application data segment APP<subscript>0</subscript>.</entry>
3801 </row><row>
3802 <entry><constant>V4L2_JPEG_ACTIVE_MARKER_APP1</constant></entry>
3803 <entry>Application data segment APP<subscript>1</subscript>.</entry>
3804 </row><row>
3805 <entry><constant>V4L2_JPEG_ACTIVE_MARKER_COM</constant></entry>
3806 <entry>Comment segment.</entry>
3807 </row><row>
3808 <entry><constant>V4L2_JPEG_ACTIVE_MARKER_DQT</constant></entry>
3809 <entry>Quantization tables segment.</entry>
3810 </row><row>
3811 <entry><constant>V4L2_JPEG_ACTIVE_MARKER_DHT</constant></entry>
3812 <entry>Huffman tables segment.</entry>
3813 </row>
3814 </tbody>
3815 </entrytbl>
3816 </row>
3817 <row><entry></entry></row>
3818 </tbody>
3819 </tgroup>
3820 </table>
3821 <para>For more details about JPEG specification, refer
3822 to <xref linkend="itu-t81"/>, <xref linkend="jfif"/>,
3823 <xref linkend="w3c-jpeg-jfif"/>.</para>
Sakari Ailus7ba85fa2011-05-04 10:45:58 -03003824 </section>
Sakari Ailus8c9d2362011-10-04 08:20:05 -03003825
3826 <section id="image-source-controls">
3827 <title>Image Source Control Reference</title>
3828
3829 <note>
3830 <title>Experimental</title>
3831
3832 <para>This is an <link
3833 linkend="experimental">experimental</link> interface and may
3834 change in the future.</para>
3835 </note>
3836
3837 <para>
3838 The Image Source control class is intended for low-level
3839 control of image source devices such as image sensors. The
3840 devices feature an analogue to digital converter and a bus
3841 transmitter to transmit the image data out of the device.
3842 </para>
3843
3844 <table pgwide="1" frame="none" id="image-source-control-id">
3845 <title>Image Source Control IDs</title>
3846
3847 <tgroup cols="4">
3848 <colspec colname="c1" colwidth="1*" />
3849 <colspec colname="c2" colwidth="6*" />
3850 <colspec colname="c3" colwidth="2*" />
3851 <colspec colname="c4" colwidth="6*" />
3852 <spanspec namest="c1" nameend="c2" spanname="id" />
3853 <spanspec namest="c2" nameend="c4" spanname="descr" />
3854 <thead>
3855 <row>
3856 <entry spanname="id" align="left">ID</entry>
3857 <entry align="left">Type</entry>
3858 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
3859 </row>
3860 </thead>
3861 <tbody valign="top">
3862 <row><entry></entry></row>
3863 <row>
3864 <entry spanname="id"><constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant></entry>
3865 <entry>class</entry>
3866 </row>
3867 <row>
3868 <entry spanname="descr">The IMAGE_SOURCE class descriptor.</entry>
3869 </row>
3870 <row>
3871 <entry spanname="id"><constant>V4L2_CID_VBLANK</constant></entry>
3872 <entry>integer</entry>
3873 </row>
3874 <row>
3875 <entry spanname="descr">Vertical blanking. The idle period
3876 after every frame during which no image data is produced.
3877 The unit of vertical blanking is a line. Every line has
3878 length of the image width plus horizontal blanking at the
3879 pixel rate defined by
3880 <constant>V4L2_CID_PIXEL_RATE</constant> control in the
3881 same sub-device.</entry>
3882 </row>
3883 <row>
3884 <entry spanname="id"><constant>V4L2_CID_HBLANK</constant></entry>
3885 <entry>integer</entry>
3886 </row>
3887 <row>
3888 <entry spanname="descr">Horizontal blanking. The idle
3889 period after every line of image data during which no
3890 image data is produced. The unit of horizontal blanking is
3891 pixels.</entry>
3892 </row>
3893 <row>
3894 <entry spanname="id"><constant>V4L2_CID_ANALOGUE_GAIN</constant></entry>
3895 <entry>integer</entry>
3896 </row>
3897 <row>
3898 <entry spanname="descr">Analogue gain is gain affecting
3899 all colour components in the pixel matrix. The gain
3900 operation is performed in the analogue domain before A/D
3901 conversion.
3902 </entry>
3903 </row>
3904 <row><entry></entry></row>
3905 </tbody>
3906 </tgroup>
3907 </table>
3908
3909 </section>
3910
Sakari Ailusc643ee12012-02-02 20:17:54 -03003911 <section id="image-process-controls">
3912 <title>Image Process Control Reference</title>
3913
3914 <note>
3915 <title>Experimental</title>
3916
3917 <para>This is an <link
3918 linkend="experimental">experimental</link> interface and may
3919 change in the future.</para>
3920 </note>
3921
3922 <para>
3923 The Image Source control class is intended for low-level control of
3924 image processing functions. Unlike
3925 <constant>V4L2_CID_IMAGE_SOURCE_CLASS</constant>, the controls in
3926 this class affect processing the image, and do not control capturing
3927 of it.
3928 </para>
3929
3930 <table pgwide="1" frame="none" id="image-process-control-id">
3931 <title>Image Source Control IDs</title>
3932
3933 <tgroup cols="4">
3934 <colspec colname="c1" colwidth="1*" />
3935 <colspec colname="c2" colwidth="6*" />
3936 <colspec colname="c3" colwidth="2*" />
3937 <colspec colname="c4" colwidth="6*" />
3938 <spanspec namest="c1" nameend="c2" spanname="id" />
3939 <spanspec namest="c2" nameend="c4" spanname="descr" />
3940 <thead>
3941 <row>
3942 <entry spanname="id" align="left">ID</entry>
3943 <entry align="left">Type</entry>
3944 </row><row rowsep="1"><entry spanname="descr" align="left">Description</entry>
3945 </row>
3946 </thead>
3947 <tbody valign="top">
3948 <row><entry></entry></row>
3949 <row>
3950 <entry spanname="id"><constant>V4L2_CID_IMAGE_PROC_CLASS</constant></entry>
3951 <entry>class</entry>
3952 </row>
3953 <row>
3954 <entry spanname="descr">The IMAGE_PROC class descriptor.</entry>
3955 </row>
3956 <row>
3957 <entry spanname="id"><constant>V4L2_CID_LINK_FREQ</constant></entry>
3958 <entry>integer menu</entry>
3959 </row>
3960 <row>
3961 <entry spanname="descr">Data bus frequency. Together with the
3962 media bus pixel code, bus type (clock cycles per sample), the
3963 data bus frequency defines the pixel rate
3964 (<constant>V4L2_CID_PIXEL_RATE</constant>) in the
3965 pixel array (or possibly elsewhere, if the device is not an
3966 image sensor). The frame rate can be calculated from the pixel
3967 clock, image width and height and horizontal and vertical
3968 blanking. While the pixel rate control may be defined elsewhere
3969 than in the subdev containing the pixel array, the frame rate
3970 cannot be obtained from that information. This is because only
3971 on the pixel array it can be assumed that the vertical and
3972 horizontal blanking information is exact: no other blanking is
3973 allowed in the pixel array. The selection of frame rate is
3974 performed by selecting the desired horizontal and vertical
3975 blanking. The unit of this control is Hz. </entry>
3976 </row>
3977 <row>
3978 <entry spanname="id"><constant>V4L2_CID_PIXEL_RATE</constant></entry>
3979 <entry>64-bit integer</entry>
3980 </row>
3981 <row>
3982 <entry spanname="descr">Pixel rate in the source pads of
3983 the subdev. This control is read-only and its unit is
3984 pixels / second.
3985 </entry>
3986 </row>
3987 <row><entry></entry></row>
3988 </tbody>
3989 </tgroup>
3990 </table>
3991
3992 </section>
Mauro Carvalho Chehab8e080c22009-09-13 22:16:04 -03003993</section>