]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - Documentation/DocBook/media/v4l/v4l2.xml
Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[mirror_ubuntu-bionic-kernel.git] / Documentation / DocBook / media / v4l / v4l2.xml
1 <partinfo>
2 <authorgroup>
3 <author>
4 <firstname>Michael</firstname>
5 <surname>Schimek</surname>
6 <othername role="mi">H</othername>
7 <affiliation>
8 <address>
9 <email>mschimek@gmx.at</email>
10 </address>
11 </affiliation>
12 </author>
13
14 <author>
15 <firstname>Bill</firstname>
16 <surname>Dirks</surname>
17 <!-- Commented until Bill opts in to be spammed.
18 <affiliation>
19 <address>
20 <email>bill@thedirks.org</email>
21 </address>
22 </affiliation> -->
23 <contrib>Original author of the V4L2 API and
24 documentation.</contrib>
25 </author>
26
27 <author>
28 <firstname>Hans</firstname>
29 <surname>Verkuil</surname>
30 <contrib>Designed and documented the VIDIOC_LOG_STATUS ioctl,
31 the extended control ioctls, major parts of the sliced VBI API, the
32 MPEG encoder and decoder APIs and the DV Timings API.</contrib>
33 <affiliation>
34 <address>
35 <email>hverkuil@xs4all.nl</email>
36 </address>
37 </affiliation>
38 </author>
39
40 <author>
41 <firstname>Martin</firstname>
42 <surname>Rubli</surname>
43 <!--
44 <affiliation>
45 <address>
46 <email>martin_rubli@logitech.com</email>
47 </address>
48 </affiliation> -->
49 <contrib>Designed and documented the VIDIOC_ENUM_FRAMESIZES
50 and VIDIOC_ENUM_FRAMEINTERVALS ioctls.</contrib>
51 </author>
52
53 <author>
54 <firstname>Andy</firstname>
55 <surname>Walls</surname>
56 <contrib>Documented the fielded V4L2_MPEG_STREAM_VBI_FMT_IVTV
57 MPEG stream embedded, sliced VBI data format in this specification.
58 </contrib>
59 <affiliation>
60 <address>
61 <email>awalls@md.metrocast.net</email>
62 </address>
63 </affiliation>
64 </author>
65
66 <author>
67 <firstname>Mauro</firstname>
68 <surname>Carvalho Chehab</surname>
69 <contrib>Documented libv4l, designed and added v4l2grab example,
70 Remote Controller chapter.</contrib>
71 <affiliation>
72 <address>
73 <email>mchehab@redhat.com</email>
74 </address>
75 </affiliation>
76 </author>
77
78 <author>
79 <firstname>Muralidharan</firstname>
80 <surname>Karicheri</surname>
81 <contrib>Documented the Digital Video timings API.</contrib>
82 <affiliation>
83 <address>
84 <email>m-karicheri2@ti.com</email>
85 </address>
86 </affiliation>
87 </author>
88
89 <author>
90 <firstname>Pawel</firstname>
91 <surname>Osciak</surname>
92 <contrib>Designed and documented the multi-planar API.</contrib>
93 <affiliation>
94 <address>
95 <email>pawel AT osciak.com</email>
96 </address>
97 </affiliation>
98 </author>
99
100 <author>
101 <firstname>Sakari</firstname>
102 <surname>Ailus</surname>
103 <contrib>Subdev selections API.</contrib>
104 <affiliation>
105 <address>
106 <email>sakari.ailus@iki.fi</email>
107 </address>
108 </affiliation>
109 </author>
110 </authorgroup>
111
112 <copyright>
113 <year>1999</year>
114 <year>2000</year>
115 <year>2001</year>
116 <year>2002</year>
117 <year>2003</year>
118 <year>2004</year>
119 <year>2005</year>
120 <year>2006</year>
121 <year>2007</year>
122 <year>2008</year>
123 <year>2009</year>
124 <year>2010</year>
125 <year>2011</year>
126 <year>2012</year>
127 <year>2013</year>
128 <holder>Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin
129 Rubli, Andy Walls, Muralidharan Karicheri, Mauro Carvalho Chehab,
130 Pawel Osciak</holder>
131 </copyright>
132 <legalnotice>
133 <para>Except when explicitly stated as GPL, programming examples within
134 this part can be used and distributed without restrictions.</para>
135 </legalnotice>
136 <revhistory>
137 <!-- Put document revisions here, newest first. -->
138 <!-- API revisions (changes and additions of defines, enums,
139 structs, ioctls) must be noted in more detail in the history chapter
140 (compat.xml), along with the possible impact on existing drivers and
141 applications. -->
142
143 <revision>
144 <revnumber>3.11</revnumber>
145 <date>2013-05-26</date>
146 <authorinitials>hv</authorinitials>
147 <revremark>Remove obsolete VIDIOC_DBG_G_CHIP_IDENT ioctl.
148 </revremark>
149 </revision>
150
151 <revision>
152 <revnumber>3.10</revnumber>
153 <date>2013-03-25</date>
154 <authorinitials>hv</authorinitials>
155 <revremark>Remove obsolete and unused DV_PRESET ioctls:
156 VIDIOC_G_DV_PRESET, VIDIOC_S_DV_PRESET, VIDIOC_QUERY_DV_PRESET and
157 VIDIOC_ENUM_DV_PRESET. Remove the related v4l2_input/output capability
158 flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_INFO.
159 </revremark>
160 </revision>
161
162 <revision>
163 <revnumber>3.9</revnumber>
164 <date>2012-12-03</date>
165 <authorinitials>sa, sn</authorinitials>
166 <revremark>Added timestamp types to v4l2_buffer.
167 Added V4L2_EVENT_CTRL_CH_RANGE control event changes flag.
168 </revremark>
169 </revision>
170
171 <revision>
172 <revnumber>3.6</revnumber>
173 <date>2012-07-02</date>
174 <authorinitials>hv</authorinitials>
175 <revremark>Added VIDIOC_ENUM_FREQ_BANDS.
176 </revremark>
177 </revision>
178
179 <revision>
180 <revnumber>3.5</revnumber>
181 <date>2012-05-07</date>
182 <authorinitials>sa, sn, hv</authorinitials>
183 <revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU and V4L2 subdev
184 selections API. Improved the description of V4L2_CID_COLORFX
185 control, added V4L2_CID_COLORFX_CBCR control.
186 Added camera controls V4L2_CID_AUTO_EXPOSURE_BIAS,
187 V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE, V4L2_CID_IMAGE_STABILIZATION,
188 V4L2_CID_ISO_SENSITIVITY, V4L2_CID_ISO_SENSITIVITY_AUTO,
189 V4L2_CID_EXPOSURE_METERING, V4L2_CID_SCENE_MODE,
190 V4L2_CID_3A_LOCK, V4L2_CID_AUTO_FOCUS_START,
191 V4L2_CID_AUTO_FOCUS_STOP, V4L2_CID_AUTO_FOCUS_STATUS
192 and V4L2_CID_AUTO_FOCUS_RANGE.
193 Added VIDIOC_ENUM_DV_TIMINGS, VIDIOC_QUERY_DV_TIMINGS and
194 VIDIOC_DV_TIMINGS_CAP.
195 </revremark>
196 </revision>
197
198 <revision>
199 <revnumber>3.4</revnumber>
200 <date>2012-01-25</date>
201 <authorinitials>sn</authorinitials>
202 <revremark>Added <link linkend="jpeg-controls">JPEG compression
203 control class.</link>
204 </revremark>
205 </revision>
206
207 <revision>
208 <revnumber>3.3</revnumber>
209 <date>2012-01-11</date>
210 <authorinitials>hv</authorinitials>
211 <revremark>Added device_caps field to struct v4l2_capabilities.</revremark>
212 </revision>
213
214 <revision>
215 <revnumber>3.2</revnumber>
216 <date>2011-08-26</date>
217 <authorinitials>hv</authorinitials>
218 <revremark>Added V4L2_CTRL_FLAG_VOLATILE.</revremark>
219 </revision>
220
221 <revision>
222 <revnumber>3.1</revnumber>
223 <date>2011-06-27</date>
224 <authorinitials>mcc, po, hv</authorinitials>
225 <revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.
226 Standardize an error code for invalid ioctl.
227 Added V4L2_CTRL_TYPE_BITMASK.</revremark>
228 </revision>
229
230 <revision>
231 <revnumber>2.6.39</revnumber>
232 <date>2011-03-01</date>
233 <authorinitials>mcc, po</authorinitials>
234 <revremark>Removed VIDIOC_*_OLD from videodev2.h header and update it to reflect latest changes. Added the <link linkend="planar-apis">multi-planar API</link>.</revremark>
235 </revision>
236
237 <revision>
238 <revnumber>2.6.37</revnumber>
239 <date>2010-08-06</date>
240 <authorinitials>hv</authorinitials>
241 <revremark>Removed obsolete vtx (videotext) API.</revremark>
242 </revision>
243
244 <revision>
245 <revnumber>2.6.33</revnumber>
246 <date>2009-12-03</date>
247 <authorinitials>mk</authorinitials>
248 <revremark>Added documentation for the Digital Video timings API.</revremark>
249 </revision>
250
251 <revision>
252 <revnumber>2.6.32</revnumber>
253 <date>2009-08-31</date>
254 <authorinitials>mcc</authorinitials>
255 <revremark>Now, revisions will match the kernel version where
256 the V4L2 API changes will be used by the Linux Kernel.
257 Also added Remote Controller chapter.</revremark>
258 </revision>
259
260 <revision>
261 <revnumber>0.29</revnumber>
262 <date>2009-08-26</date>
263 <authorinitials>ev</authorinitials>
264 <revremark>Added documentation for string controls and for FM Transmitter controls.</revremark>
265 </revision>
266
267 <revision>
268 <revnumber>0.28</revnumber>
269 <date>2009-08-26</date>
270 <authorinitials>gl</authorinitials>
271 <revremark>Added V4L2_CID_BAND_STOP_FILTER documentation.</revremark>
272 </revision>
273
274 <revision>
275 <revnumber>0.27</revnumber>
276 <date>2009-08-15</date>
277 <authorinitials>mcc</authorinitials>
278 <revremark>Added libv4l and Remote Controller documentation;
279 added v4l2grab and keytable application examples.</revremark>
280 </revision>
281
282 <revision>
283 <revnumber>0.26</revnumber>
284 <date>2009-07-23</date>
285 <authorinitials>hv</authorinitials>
286 <revremark>Finalized the RDS capture API. Added modulator and RDS encoder
287 capabilities. Added support for string controls.</revremark>
288 </revision>
289
290 <revision>
291 <revnumber>0.25</revnumber>
292 <date>2009-01-18</date>
293 <authorinitials>hv</authorinitials>
294 <revremark>Added pixel formats VYUY, NV16 and NV61, and changed
295 the debug ioctls VIDIOC_DBG_G/S_REGISTER and VIDIOC_DBG_G_CHIP_IDENT.
296 Added camera controls V4L2_CID_ZOOM_ABSOLUTE, V4L2_CID_ZOOM_RELATIVE,
297 V4L2_CID_ZOOM_CONTINUOUS and V4L2_CID_PRIVACY.</revremark>
298 </revision>
299
300 <revision>
301 <revnumber>0.24</revnumber>
302 <date>2008-03-04</date>
303 <authorinitials>mhs</authorinitials>
304 <revremark>Added pixel formats Y16 and SBGGR16, new controls
305 and a camera controls class. Removed VIDIOC_G/S_MPEGCOMP.</revremark>
306 </revision>
307
308 <revision>
309 <revnumber>0.23</revnumber>
310 <date>2007-08-30</date>
311 <authorinitials>mhs</authorinitials>
312 <revremark>Fixed a typo in VIDIOC_DBG_G/S_REGISTER.
313 Clarified the byte order of packed pixel formats.</revremark>
314 </revision>
315
316 <revision>
317 <revnumber>0.22</revnumber>
318 <date>2007-08-29</date>
319 <authorinitials>mhs</authorinitials>
320 <revremark>Added the Video Output Overlay interface, new MPEG
321 controls, V4L2_FIELD_INTERLACED_TB and V4L2_FIELD_INTERLACED_BT,
322 VIDIOC_DBG_G/S_REGISTER, VIDIOC_(TRY_)ENCODER_CMD,
323 VIDIOC_G_CHIP_IDENT, VIDIOC_G_ENC_INDEX, new pixel formats.
324 Clarifications in the cropping chapter, about RGB pixel formats, the
325 mmap(), poll(), select(), read() and write() functions. Typographical
326 fixes.</revremark>
327 </revision>
328
329 <revision>
330 <revnumber>0.21</revnumber>
331 <date>2006-12-19</date>
332 <authorinitials>mhs</authorinitials>
333 <revremark>Fixed a link in the VIDIOC_G_EXT_CTRLS section.</revremark>
334 </revision>
335
336 <revision>
337 <revnumber>0.20</revnumber>
338 <date>2006-11-24</date>
339 <authorinitials>mhs</authorinitials>
340 <revremark>Clarified the purpose of the audioset field in
341 struct v4l2_input and v4l2_output.</revremark>
342 </revision>
343
344 <revision>
345 <revnumber>0.19</revnumber>
346 <date>2006-10-19</date>
347 <authorinitials>mhs</authorinitials>
348 <revremark>Documented V4L2_PIX_FMT_RGB444.</revremark>
349 </revision>
350
351 <revision>
352 <revnumber>0.18</revnumber>
353 <date>2006-10-18</date>
354 <authorinitials>mhs</authorinitials>
355 <revremark>Added the description of extended controls by Hans
356 Verkuil. Linked V4L2_PIX_FMT_MPEG to V4L2_CID_MPEG_STREAM_TYPE.</revremark>
357 </revision>
358
359 <revision>
360 <revnumber>0.17</revnumber>
361 <date>2006-10-12</date>
362 <authorinitials>mhs</authorinitials>
363 <revremark>Corrected V4L2_PIX_FMT_HM12 description.</revremark>
364 </revision>
365
366 <revision>
367 <revnumber>0.16</revnumber>
368 <date>2006-10-08</date>
369 <authorinitials>mhs</authorinitials>
370 <revremark>VIDIOC_ENUM_FRAMESIZES and
371 VIDIOC_ENUM_FRAMEINTERVALS are now part of the API.</revremark>
372 </revision>
373
374 <revision>
375 <revnumber>0.15</revnumber>
376 <date>2006-09-23</date>
377 <authorinitials>mhs</authorinitials>
378 <revremark>Cleaned up the bibliography, added BT.653 and
379 BT.1119. capture.c/start_capturing() for user pointer I/O did not
380 initialize the buffer index. Documented the V4L MPEG and MJPEG
381 VID_TYPEs and V4L2_PIX_FMT_SBGGR8. Updated the list of reserved pixel
382 formats. See the history chapter for API changes.</revremark>
383 </revision>
384
385 <revision>
386 <revnumber>0.14</revnumber>
387 <date>2006-09-14</date>
388 <authorinitials>mr</authorinitials>
389 <revremark>Added VIDIOC_ENUM_FRAMESIZES and
390 VIDIOC_ENUM_FRAMEINTERVALS proposal for frame format enumeration of
391 digital devices.</revremark>
392 </revision>
393
394 <revision>
395 <revnumber>0.13</revnumber>
396 <date>2006-04-07</date>
397 <authorinitials>mhs</authorinitials>
398 <revremark>Corrected the description of struct v4l2_window
399 clips. New V4L2_STD_ and V4L2_TUNER_MODE_LANG1_LANG2
400 defines.</revremark>
401 </revision>
402
403 <revision>
404 <revnumber>0.12</revnumber>
405 <date>2006-02-03</date>
406 <authorinitials>mhs</authorinitials>
407 <revremark>Corrected the description of struct
408 v4l2_captureparm and v4l2_outputparm.</revremark>
409 </revision>
410
411 <revision>
412 <revnumber>0.11</revnumber>
413 <date>2006-01-27</date>
414 <authorinitials>mhs</authorinitials>
415 <revremark>Improved the description of struct
416 v4l2_tuner.</revremark>
417 </revision>
418
419 <revision>
420 <revnumber>0.10</revnumber>
421 <date>2006-01-10</date>
422 <authorinitials>mhs</authorinitials>
423 <revremark>VIDIOC_G_INPUT and VIDIOC_S_PARM
424 clarifications.</revremark>
425 </revision>
426
427 <revision>
428 <revnumber>0.9</revnumber>
429 <date>2005-11-27</date>
430 <authorinitials>mhs</authorinitials>
431 <revremark>Improved the 525 line numbering diagram. Hans
432 Verkuil and I rewrote the sliced VBI section. He also contributed a
433 VIDIOC_LOG_STATUS page. Fixed VIDIOC_S_STD call in the video standard
434 selection example. Various updates.</revremark>
435 </revision>
436
437 <revision>
438 <revnumber>0.8</revnumber>
439 <date>2004-10-04</date>
440 <authorinitials>mhs</authorinitials>
441 <revremark>Somehow a piece of junk slipped into the capture
442 example, removed.</revremark>
443 </revision>
444
445 <revision>
446 <revnumber>0.7</revnumber>
447 <date>2004-09-19</date>
448 <authorinitials>mhs</authorinitials>
449 <revremark>Fixed video standard selection, control
450 enumeration, downscaling and aspect example. Added read and user
451 pointer i/o to video capture example.</revremark>
452 </revision>
453
454 <revision>
455 <revnumber>0.6</revnumber>
456 <date>2004-08-01</date>
457 <authorinitials>mhs</authorinitials>
458 <revremark>v4l2_buffer changes, added video capture example,
459 various corrections.</revremark>
460 </revision>
461
462 <revision>
463 <revnumber>0.5</revnumber>
464 <date>2003-11-05</date>
465 <authorinitials>mhs</authorinitials>
466 <revremark>Pixel format erratum.</revremark>
467 </revision>
468
469 <revision>
470 <revnumber>0.4</revnumber>
471 <date>2003-09-17</date>
472 <authorinitials>mhs</authorinitials>
473 <revremark>Corrected source and Makefile to generate a PDF.
474 SGML fixes. Added latest API changes. Closed gaps in the history
475 chapter.</revremark>
476 </revision>
477
478 <revision>
479 <revnumber>0.3</revnumber>
480 <date>2003-02-05</date>
481 <authorinitials>mhs</authorinitials>
482 <revremark>Another draft, more corrections.</revremark>
483 </revision>
484
485 <revision>
486 <revnumber>0.2</revnumber>
487 <date>2003-01-15</date>
488 <authorinitials>mhs</authorinitials>
489 <revremark>Second draft, with corrections pointed out by Gerd
490 Knorr.</revremark>
491 </revision>
492
493 <revision>
494 <revnumber>0.1</revnumber>
495 <date>2002-12-01</date>
496 <authorinitials>mhs</authorinitials>
497 <revremark>First draft, based on documentation by Bill Dirks
498 and discussions on the V4L mailing list.</revremark>
499 </revision>
500 </revhistory>
501 </partinfo>
502
503 <title>Video for Linux Two API Specification</title>
504 <subtitle>Revision 3.11</subtitle>
505
506 <chapter id="common">
507 &sub-common;
508 </chapter>
509
510 <chapter id="pixfmt">
511 &sub-pixfmt;
512 </chapter>
513
514 <chapter id="io">
515 &sub-io;
516 </chapter>
517
518 <chapter id="devices">
519 <title>Interfaces</title>
520
521 <section id="capture"> &sub-dev-capture; </section>
522 <section id="overlay"> &sub-dev-overlay; </section>
523 <section id="output"> &sub-dev-output; </section>
524 <section id="osd"> &sub-dev-osd; </section>
525 <section id="codec"> &sub-dev-codec; </section>
526 <section id="effect"> &sub-dev-effect; </section>
527 <section id="raw-vbi"> &sub-dev-raw-vbi; </section>
528 <section id="sliced"> &sub-dev-sliced-vbi; </section>
529 <section id="ttx"> &sub-dev-teletext; </section>
530 <section id="radio"> &sub-dev-radio; </section>
531 <section id="rds"> &sub-dev-rds; </section>
532 <section id="event"> &sub-dev-event; </section>
533 <section id="subdev"> &sub-dev-subdev; </section>
534 </chapter>
535
536 <chapter id="driver">
537 &sub-driver;
538 </chapter>
539
540 <chapter id="libv4l">
541 &sub-libv4l;
542 </chapter>
543
544 <chapter id="compat">
545 &sub-compat;
546 </chapter>
547
548 <appendix id="user-func">
549 <title>Function Reference</title>
550
551 <!-- Keep this alphabetically sorted. -->
552
553 &sub-close;
554 &sub-ioctl;
555 <!-- All ioctls go here. -->
556 &sub-create-bufs;
557 &sub-cropcap;
558 &sub-dbg-g-chip-info;
559 &sub-dbg-g-register;
560 &sub-decoder-cmd;
561 &sub-dqevent;
562 &sub-dv-timings-cap;
563 &sub-encoder-cmd;
564 &sub-enumaudio;
565 &sub-enumaudioout;
566 &sub-enum-dv-timings;
567 &sub-enum-fmt;
568 &sub-enum-framesizes;
569 &sub-enum-frameintervals;
570 &sub-enum-freq-bands;
571 &sub-enuminput;
572 &sub-enumoutput;
573 &sub-enumstd;
574 &sub-expbuf;
575 &sub-g-audio;
576 &sub-g-audioout;
577 &sub-g-crop;
578 &sub-g-ctrl;
579 &sub-g-dv-timings;
580 &sub-g-enc-index;
581 &sub-g-ext-ctrls;
582 &sub-g-fbuf;
583 &sub-g-fmt;
584 &sub-g-frequency;
585 &sub-g-input;
586 &sub-g-jpegcomp;
587 &sub-g-modulator;
588 &sub-g-output;
589 &sub-g-parm;
590 &sub-g-priority;
591 &sub-g-selection;
592 &sub-g-sliced-vbi-cap;
593 &sub-g-std;
594 &sub-g-tuner;
595 &sub-log-status;
596 &sub-overlay;
597 &sub-prepare-buf;
598 &sub-qbuf;
599 &sub-querybuf;
600 &sub-querycap;
601 &sub-queryctrl;
602 &sub-query-dv-timings;
603 &sub-querystd;
604 &sub-reqbufs;
605 &sub-s-hw-freq-seek;
606 &sub-streamon;
607 &sub-subdev-enum-frame-interval;
608 &sub-subdev-enum-frame-size;
609 &sub-subdev-enum-mbus-code;
610 &sub-subdev-g-crop;
611 &sub-subdev-g-edid;
612 &sub-subdev-g-fmt;
613 &sub-subdev-g-frame-interval;
614 &sub-subdev-g-selection;
615 &sub-subscribe-event;
616 <!-- End of ioctls. -->
617 &sub-mmap;
618 &sub-munmap;
619 &sub-open;
620 &sub-poll;
621 &sub-read;
622 &sub-select;
623 &sub-write;
624 </appendix>
625
626 <appendix>
627 <title>Common definitions for V4L2 and V4L2 subdev interfaces</title>
628 &sub-selections-common;
629 </appendix>
630
631 <appendix id="videodev">
632 <title>Video For Linux Two Header File</title>
633 &sub-videodev2-h;
634 </appendix>
635
636 <appendix id="capture-example">
637 <title>Video Capture Example</title>
638 &sub-capture-c;
639 </appendix>
640
641 <appendix id="v4l2grab-example">
642 <title>Video Grabber example using libv4l</title>
643 <para>This program demonstrates how to grab V4L2 images in ppm format by
644 using libv4l handlers. The advantage is that this grabber can potentially work
645 with any V4L2 driver.</para>
646 &sub-v4l2grab-c;
647 </appendix>
648
649 &sub-media-indices;
650
651 &sub-biblio;
652