4 <firstname>Michael</firstname>
5 <surname>Schimek</surname>
6 <othername role="mi">H</othername>
9 <email>mschimek@gmx.at</email>
15 <firstname>Bill</firstname>
16 <surname>Dirks</surname>
17 <!-- Commented until Bill opts in to be spammed.
20 <email>bill@thedirks.org</email>
23 <contrib>Original author of the V4L2 API and
24 documentation.</contrib>
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>
35 <email>hverkuil@xs4all.nl</email>
41 <firstname>Martin</firstname>
42 <surname>Rubli</surname>
46 <email>martin_rubli@logitech.com</email>
49 <contrib>Designed and documented the VIDIOC_ENUM_FRAMESIZES
50 and VIDIOC_ENUM_FRAMEINTERVALS ioctls.</contrib>
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.
61 <email>awalls@md.metrocast.net</email>
67 <firstname>Mauro</firstname>
68 <surname>Carvalho Chehab</surname>
69 <contrib>Documented libv4l, designed and added v4l2grab example,
70 Remote Controller chapter.</contrib>
73 <email>m.chehab@samsung.com</email>
79 <firstname>Muralidharan</firstname>
80 <surname>Karicheri</surname>
81 <contrib>Documented the Digital Video timings API.</contrib>
84 <email>m-karicheri2@ti.com</email>
90 <firstname>Pawel</firstname>
91 <surname>Osciak</surname>
92 <contrib>Designed and documented the multi-planar API.</contrib>
95 <email>pawel AT osciak.com</email>
101 <firstname>Sakari</firstname>
102 <surname>Ailus</surname>
103 <contrib>Subdev selections API.</contrib>
106 <email>sakari.ailus@iki.fi</email>
111 <firstname>Antti</firstname>
112 <surname>Palosaari</surname>
113 <contrib>SDR API.</contrib>
116 <email>crope@iki.fi</email>
140 <holder>Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin
141 Rubli, Andy Walls, Muralidharan Karicheri, Mauro Carvalho Chehab,
142 Pawel Osciak</holder>
145 <para>Except when explicitly stated as GPL, programming examples within
146 this part can be used and distributed without restrictions.</para>
149 <!-- Put document revisions here, newest first. -->
150 <!-- API revisions (changes and additions of defines, enums,
151 structs, ioctls) must be noted in more detail in the history chapter
152 (compat.xml), along with the possible impact on existing drivers and
155 <revnumber>4.4</revnumber>
156 <date>2015-05-26</date>
157 <authorinitials>ap</authorinitials>
158 <revremark>Renamed V4L2_TUNER_ADC to V4L2_TUNER_SDR.
159 Added V4L2_CID_RF_TUNER_RF_GAIN control.
160 Added transmitter support for Software Defined Radio (SDR) Interface.
165 <revnumber>4.1</revnumber>
166 <date>2015-02-13</date>
167 <authorinitials>mcc</authorinitials>
168 <revremark>Fix documentation for media controller device nodes and add support for DVB device nodes.
169 Add support for Tuner sub-device.
173 <revnumber>3.19</revnumber>
174 <date>2014-12-05</date>
175 <authorinitials>hv</authorinitials>
176 <revremark>Rewrote Colorspace chapter, added new &v4l2-ycbcr-encoding; and &v4l2-quantization; fields
177 to &v4l2-pix-format;, &v4l2-pix-format-mplane; and &v4l2-mbus-framefmt;.
182 <revnumber>3.17</revnumber>
183 <date>2014-08-04</date>
184 <authorinitials>lp, hv</authorinitials>
185 <revremark>Extended &v4l2-pix-format;. Added format flags. Added compound control types
186 and VIDIOC_QUERY_EXT_CTRL.
191 <revnumber>3.15</revnumber>
192 <date>2014-02-03</date>
193 <authorinitials>hv, ap</authorinitials>
194 <revremark>Update several sections of "Common API Elements": "Opening and Closing Devices"
195 "Querying Capabilities", "Application Priority", "Video Inputs and Outputs", "Audio Inputs and Outputs"
196 "Tuners and Modulators", "Video Standards" and "Digital Video (DV) Timings". Added SDR API.
201 <revnumber>3.14</revnumber>
202 <date>2013-11-25</date>
203 <authorinitials>rr</authorinitials>
204 <revremark>Set width and height as unsigned on v4l2_rect.
209 <revnumber>3.11</revnumber>
210 <date>2013-05-26</date>
211 <authorinitials>hv</authorinitials>
212 <revremark>Remove obsolete VIDIOC_DBG_G_CHIP_IDENT ioctl.
217 <revnumber>3.10</revnumber>
218 <date>2013-03-25</date>
219 <authorinitials>hv</authorinitials>
220 <revremark>Remove obsolete and unused DV_PRESET ioctls:
221 VIDIOC_G_DV_PRESET, VIDIOC_S_DV_PRESET, VIDIOC_QUERY_DV_PRESET and
222 VIDIOC_ENUM_DV_PRESET. Remove the related v4l2_input/output capability
223 flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_INFO.
228 <revnumber>3.9</revnumber>
229 <date>2012-12-03</date>
230 <authorinitials>sa, sn</authorinitials>
231 <revremark>Added timestamp types to v4l2_buffer.
232 Added V4L2_EVENT_CTRL_CH_RANGE control event changes flag.
237 <revnumber>3.6</revnumber>
238 <date>2012-07-02</date>
239 <authorinitials>hv</authorinitials>
240 <revremark>Added VIDIOC_ENUM_FREQ_BANDS.
245 <revnumber>3.5</revnumber>
246 <date>2012-05-07</date>
247 <authorinitials>sa, sn, hv</authorinitials>
248 <revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU and V4L2 subdev
249 selections API. Improved the description of V4L2_CID_COLORFX
250 control, added V4L2_CID_COLORFX_CBCR control.
251 Added camera controls V4L2_CID_AUTO_EXPOSURE_BIAS,
252 V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE, V4L2_CID_IMAGE_STABILIZATION,
253 V4L2_CID_ISO_SENSITIVITY, V4L2_CID_ISO_SENSITIVITY_AUTO,
254 V4L2_CID_EXPOSURE_METERING, V4L2_CID_SCENE_MODE,
255 V4L2_CID_3A_LOCK, V4L2_CID_AUTO_FOCUS_START,
256 V4L2_CID_AUTO_FOCUS_STOP, V4L2_CID_AUTO_FOCUS_STATUS
257 and V4L2_CID_AUTO_FOCUS_RANGE.
258 Added VIDIOC_ENUM_DV_TIMINGS, VIDIOC_QUERY_DV_TIMINGS and
259 VIDIOC_DV_TIMINGS_CAP.
264 <revnumber>3.4</revnumber>
265 <date>2012-01-25</date>
266 <authorinitials>sn</authorinitials>
267 <revremark>Added <link linkend="jpeg-controls">JPEG compression
268 control class.</link>
273 <revnumber>3.3</revnumber>
274 <date>2012-01-11</date>
275 <authorinitials>hv</authorinitials>
276 <revremark>Added device_caps field to struct v4l2_capabilities.</revremark>
280 <revnumber>3.2</revnumber>
281 <date>2011-08-26</date>
282 <authorinitials>hv</authorinitials>
283 <revremark>Added V4L2_CTRL_FLAG_VOLATILE.</revremark>
287 <revnumber>3.1</revnumber>
288 <date>2011-06-27</date>
289 <authorinitials>mcc, po, hv</authorinitials>
290 <revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.
291 Standardize an error code for invalid ioctl.
292 Added V4L2_CTRL_TYPE_BITMASK.</revremark>
296 <revnumber>2.6.39</revnumber>
297 <date>2011-03-01</date>
298 <authorinitials>mcc, po</authorinitials>
299 <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>
303 <revnumber>2.6.37</revnumber>
304 <date>2010-08-06</date>
305 <authorinitials>hv</authorinitials>
306 <revremark>Removed obsolete vtx (videotext) API.</revremark>
310 <revnumber>2.6.33</revnumber>
311 <date>2009-12-03</date>
312 <authorinitials>mk</authorinitials>
313 <revremark>Added documentation for the Digital Video timings API.</revremark>
317 <revnumber>2.6.32</revnumber>
318 <date>2009-08-31</date>
319 <authorinitials>mcc</authorinitials>
320 <revremark>Now, revisions will match the kernel version where
321 the V4L2 API changes will be used by the Linux Kernel.
322 Also added Remote Controller chapter.</revremark>
326 <revnumber>0.29</revnumber>
327 <date>2009-08-26</date>
328 <authorinitials>ev</authorinitials>
329 <revremark>Added documentation for string controls and for FM Transmitter controls.</revremark>
333 <revnumber>0.28</revnumber>
334 <date>2009-08-26</date>
335 <authorinitials>gl</authorinitials>
336 <revremark>Added V4L2_CID_BAND_STOP_FILTER documentation.</revremark>
340 <revnumber>0.27</revnumber>
341 <date>2009-08-15</date>
342 <authorinitials>mcc</authorinitials>
343 <revremark>Added libv4l and Remote Controller documentation;
344 added v4l2grab and keytable application examples.</revremark>
348 <revnumber>0.26</revnumber>
349 <date>2009-07-23</date>
350 <authorinitials>hv</authorinitials>
351 <revremark>Finalized the RDS capture API. Added modulator and RDS encoder
352 capabilities. Added support for string controls.</revremark>
356 <revnumber>0.25</revnumber>
357 <date>2009-01-18</date>
358 <authorinitials>hv</authorinitials>
359 <revremark>Added pixel formats VYUY, NV16 and NV61, and changed
360 the debug ioctls VIDIOC_DBG_G/S_REGISTER and VIDIOC_DBG_G_CHIP_IDENT.
361 Added camera controls V4L2_CID_ZOOM_ABSOLUTE, V4L2_CID_ZOOM_RELATIVE,
362 V4L2_CID_ZOOM_CONTINUOUS and V4L2_CID_PRIVACY.</revremark>
366 <revnumber>0.24</revnumber>
367 <date>2008-03-04</date>
368 <authorinitials>mhs</authorinitials>
369 <revremark>Added pixel formats Y16 and SBGGR16, new controls
370 and a camera controls class. Removed VIDIOC_G/S_MPEGCOMP.</revremark>
374 <revnumber>0.23</revnumber>
375 <date>2007-08-30</date>
376 <authorinitials>mhs</authorinitials>
377 <revremark>Fixed a typo in VIDIOC_DBG_G/S_REGISTER.
378 Clarified the byte order of packed pixel formats.</revremark>
382 <revnumber>0.22</revnumber>
383 <date>2007-08-29</date>
384 <authorinitials>mhs</authorinitials>
385 <revremark>Added the Video Output Overlay interface, new MPEG
386 controls, V4L2_FIELD_INTERLACED_TB and V4L2_FIELD_INTERLACED_BT,
387 VIDIOC_DBG_G/S_REGISTER, VIDIOC_(TRY_)ENCODER_CMD,
388 VIDIOC_G_CHIP_IDENT, VIDIOC_G_ENC_INDEX, new pixel formats.
389 Clarifications in the cropping chapter, about RGB pixel formats, the
390 mmap(), poll(), select(), read() and write() functions. Typographical
395 <revnumber>0.21</revnumber>
396 <date>2006-12-19</date>
397 <authorinitials>mhs</authorinitials>
398 <revremark>Fixed a link in the VIDIOC_G_EXT_CTRLS section.</revremark>
402 <revnumber>0.20</revnumber>
403 <date>2006-11-24</date>
404 <authorinitials>mhs</authorinitials>
405 <revremark>Clarified the purpose of the audioset field in
406 struct v4l2_input and v4l2_output.</revremark>
410 <revnumber>0.19</revnumber>
411 <date>2006-10-19</date>
412 <authorinitials>mhs</authorinitials>
413 <revremark>Documented V4L2_PIX_FMT_RGB444.</revremark>
417 <revnumber>0.18</revnumber>
418 <date>2006-10-18</date>
419 <authorinitials>mhs</authorinitials>
420 <revremark>Added the description of extended controls by Hans
421 Verkuil. Linked V4L2_PIX_FMT_MPEG to V4L2_CID_MPEG_STREAM_TYPE.</revremark>
425 <revnumber>0.17</revnumber>
426 <date>2006-10-12</date>
427 <authorinitials>mhs</authorinitials>
428 <revremark>Corrected V4L2_PIX_FMT_HM12 description.</revremark>
432 <revnumber>0.16</revnumber>
433 <date>2006-10-08</date>
434 <authorinitials>mhs</authorinitials>
435 <revremark>VIDIOC_ENUM_FRAMESIZES and
436 VIDIOC_ENUM_FRAMEINTERVALS are now part of the API.</revremark>
440 <revnumber>0.15</revnumber>
441 <date>2006-09-23</date>
442 <authorinitials>mhs</authorinitials>
443 <revremark>Cleaned up the bibliography, added BT.653 and
444 BT.1119. capture.c/start_capturing() for user pointer I/O did not
445 initialize the buffer index. Documented the V4L MPEG and MJPEG
446 VID_TYPEs and V4L2_PIX_FMT_SBGGR8. Updated the list of reserved pixel
447 formats. See the history chapter for API changes.</revremark>
451 <revnumber>0.14</revnumber>
452 <date>2006-09-14</date>
453 <authorinitials>mr</authorinitials>
454 <revremark>Added VIDIOC_ENUM_FRAMESIZES and
455 VIDIOC_ENUM_FRAMEINTERVALS proposal for frame format enumeration of
456 digital devices.</revremark>
460 <revnumber>0.13</revnumber>
461 <date>2006-04-07</date>
462 <authorinitials>mhs</authorinitials>
463 <revremark>Corrected the description of struct v4l2_window
464 clips. New V4L2_STD_ and V4L2_TUNER_MODE_LANG1_LANG2
469 <revnumber>0.12</revnumber>
470 <date>2006-02-03</date>
471 <authorinitials>mhs</authorinitials>
472 <revremark>Corrected the description of struct
473 v4l2_captureparm and v4l2_outputparm.</revremark>
477 <revnumber>0.11</revnumber>
478 <date>2006-01-27</date>
479 <authorinitials>mhs</authorinitials>
480 <revremark>Improved the description of struct
481 v4l2_tuner.</revremark>
485 <revnumber>0.10</revnumber>
486 <date>2006-01-10</date>
487 <authorinitials>mhs</authorinitials>
488 <revremark>VIDIOC_G_INPUT and VIDIOC_S_PARM
489 clarifications.</revremark>
493 <revnumber>0.9</revnumber>
494 <date>2005-11-27</date>
495 <authorinitials>mhs</authorinitials>
496 <revremark>Improved the 525 line numbering diagram. Hans
497 Verkuil and I rewrote the sliced VBI section. He also contributed a
498 VIDIOC_LOG_STATUS page. Fixed VIDIOC_S_STD call in the video standard
499 selection example. Various updates.</revremark>
503 <revnumber>0.8</revnumber>
504 <date>2004-10-04</date>
505 <authorinitials>mhs</authorinitials>
506 <revremark>Somehow a piece of junk slipped into the capture
507 example, removed.</revremark>
511 <revnumber>0.7</revnumber>
512 <date>2004-09-19</date>
513 <authorinitials>mhs</authorinitials>
514 <revremark>Fixed video standard selection, control
515 enumeration, downscaling and aspect example. Added read and user
516 pointer i/o to video capture example.</revremark>
520 <revnumber>0.6</revnumber>
521 <date>2004-08-01</date>
522 <authorinitials>mhs</authorinitials>
523 <revremark>v4l2_buffer changes, added video capture example,
524 various corrections.</revremark>
528 <revnumber>0.5</revnumber>
529 <date>2003-11-05</date>
530 <authorinitials>mhs</authorinitials>
531 <revremark>Pixel format erratum.</revremark>
535 <revnumber>0.4</revnumber>
536 <date>2003-09-17</date>
537 <authorinitials>mhs</authorinitials>
538 <revremark>Corrected source and Makefile to generate a PDF.
539 SGML fixes. Added latest API changes. Closed gaps in the history
544 <revnumber>0.3</revnumber>
545 <date>2003-02-05</date>
546 <authorinitials>mhs</authorinitials>
547 <revremark>Another draft, more corrections.</revremark>
551 <revnumber>0.2</revnumber>
552 <date>2003-01-15</date>
553 <authorinitials>mhs</authorinitials>
554 <revremark>Second draft, with corrections pointed out by Gerd
559 <revnumber>0.1</revnumber>
560 <date>2002-12-01</date>
561 <authorinitials>mhs</authorinitials>
562 <revremark>First draft, based on documentation by Bill Dirks
563 and discussions on the V4L mailing list.</revremark>
568 <title>Video for Linux Two API Specification</title>
569 <subtitle>Revision 4.4</subtitle>
571 <chapter id="common">
575 <chapter id="pixfmt">
583 <chapter id="devices">
584 <title>Interfaces</title>
586 <section id="capture"> &sub-dev-capture; </section>
587 <section id="overlay"> &sub-dev-overlay; </section>
588 <section id="output"> &sub-dev-output; </section>
589 <section id="osd"> &sub-dev-osd; </section>
590 <section id="codec"> &sub-dev-codec; </section>
591 <section id="effect"> &sub-dev-effect; </section>
592 <section id="raw-vbi"> &sub-dev-raw-vbi; </section>
593 <section id="sliced"> &sub-dev-sliced-vbi; </section>
594 <section id="ttx"> &sub-dev-teletext; </section>
595 <section id="radio"> &sub-dev-radio; </section>
596 <section id="rds"> &sub-dev-rds; </section>
597 <section id="sdr"> &sub-dev-sdr; </section>
598 <section id="event"> &sub-dev-event; </section>
599 <section id="subdev"> &sub-dev-subdev; </section>
602 <chapter id="driver">
606 <chapter id="libv4l">
610 <chapter id="compat">
614 <appendix id="user-func">
615 <title>Function Reference</title>
617 <!-- Keep this alphabetically sorted. -->
621 <!-- All ioctls go here. -->
624 &sub-dbg-g-chip-info;
632 &sub-enum-dv-timings;
634 &sub-enum-framesizes;
635 &sub-enum-frameintervals;
636 &sub-enum-freq-bands;
659 &sub-g-sliced-vbi-cap;
669 &sub-query-dv-timings;
674 &sub-subdev-enum-frame-interval;
675 &sub-subdev-enum-frame-size;
676 &sub-subdev-enum-mbus-code;
679 &sub-subdev-g-frame-interval;
680 &sub-subdev-g-selection;
681 &sub-subscribe-event;
682 <!-- End of ioctls. -->
693 <title>Common definitions for V4L2 and V4L2 subdev interfaces</title>
694 &sub-selections-common;
697 <appendix id="videodev">
698 <title>Video For Linux Two Header File</title>
702 <appendix id="capture-example">
703 <title>Video Capture Example</title>
707 <appendix id="v4l2grab-example">
708 <title>Video Grabber example using libv4l</title>
709 <para>This program demonstrates how to grab V4L2 images in ppm format by
710 using libv4l handlers. The advantage is that this grabber can potentially work
711 with any V4L2 driver.</para>