Documentation/DocBook/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 and major parts of the sliced VBI
  32 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     </authorgroup>
  89
  90     <copyright>
  91       <year>1999</year>
  92       <year>2000</year>
  93       <year>2001</year>
  94       <year>2002</year>
  95       <year>2003</year>
  96       <year>2004</year>
  97       <year>2005</year>
  98       <year>2006</year>
  99       <year>2007</year>
 100       <year>2008</year>
 101       <year>2009</year>
 102       <year>2010</year>
 103       <year>2011</year>
 104       <holder>Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin
 105 Rubli, Andy Walls, Muralidharan Karicheri, Mauro Carvalho Chehab</holder>
 106     </copyright>
 107     <legalnotice>
 108     <para>Except when explicitly stated as GPL, programming examples within
 109             this part can be used and distributed without restrictions.</para>
 110     </legalnotice>
 111     <revhistory>
 112       <!-- Put document revisions here, newest first. -->
 113       <!-- API revisions (changes and additions of defines, enums,
 114 structs, ioctls) must be noted in more detail in the history chapter
 115 (compat.xml), along with the possible impact on existing drivers and
 116 applications. -->
 117
 118       <revision>
 119         <revnumber>2.6.37</revnumber>
 120         <date>2010-08-06</date>
 121         <authorinitials>hv</authorinitials>
 122         <revremark>Removed obsolete vtx (videotext) API.</revremark>
 123       </revision>
 124
 125       <revision>
 126         <revnumber>2.6.33</revnumber>
 127         <date>2009-12-03</date>
 128         <authorinitials>mk</authorinitials>
 129         <revremark>Added documentation for the Digital Video timings API.</revremark>
 130       </revision>
 131
 132       <revision>
 133         <revnumber>2.6.32</revnumber>
 134         <date>2009-08-31</date>
 135         <authorinitials>mcc</authorinitials>
 136         <revremark>Now, revisions will match the kernel version where
 137 the V4L2 API changes will be used by the Linux Kernel.
 138 Also added Remote Controller chapter.</revremark>
 139       </revision>
 140
 141       <revision>
 142         <revnumber>0.29</revnumber>
 143         <date>2009-08-26</date>
 144         <authorinitials>ev</authorinitials>
 145         <revremark>Added documentation for string controls and for FM Transmitter controls.</revremark>
 146       </revision>
 147
 148       <revision>
 149         <revnumber>0.28</revnumber>
 150         <date>2009-08-26</date>
 151         <authorinitials>gl</authorinitials>
 152         <revremark>Added V4L2_CID_BAND_STOP_FILTER documentation.</revremark>
 153       </revision>
 154
 155       <revision>
 156         <revnumber>0.27</revnumber>
 157         <date>2009-08-15</date>
 158         <authorinitials>mcc</authorinitials>
 159         <revremark>Added libv4l and Remote Controller documentation;
 160 added v4l2grab and keytable application examples.</revremark>
 161       </revision>
 162
 163       <revision>
 164         <revnumber>0.26</revnumber>
 165         <date>2009-07-23</date>
 166         <authorinitials>hv</authorinitials>
 167         <revremark>Finalized the RDS capture API. Added modulator and RDS encoder
 168 capabilities. Added support for string controls.</revremark>
 169       </revision>
 170
 171       <revision>
 172         <revnumber>0.25</revnumber>
 173         <date>2009-01-18</date>
 174         <authorinitials>hv</authorinitials>
 175         <revremark>Added pixel formats VYUY, NV16 and NV61, and changed
 176 the debug ioctls VIDIOC_DBG_G/S_REGISTER and VIDIOC_DBG_G_CHIP_IDENT.
 177 Added camera controls V4L2_CID_ZOOM_ABSOLUTE, V4L2_CID_ZOOM_RELATIVE,
 178 V4L2_CID_ZOOM_CONTINUOUS and V4L2_CID_PRIVACY.</revremark>
 179       </revision>
 180
 181       <revision>
 182         <revnumber>0.24</revnumber>
 183         <date>2008-03-04</date>
 184         <authorinitials>mhs</authorinitials>
 185         <revremark>Added pixel formats Y16 and SBGGR16, new controls
 186 and a camera controls class. Removed VIDIOC_G/S_MPEGCOMP.</revremark>
 187       </revision>
 188
 189       <revision>
 190         <revnumber>0.23</revnumber>
 191         <date>2007-08-30</date>
 192         <authorinitials>mhs</authorinitials>
 193         <revremark>Fixed a typo in VIDIOC_DBG_G/S_REGISTER.
 194 Clarified the byte order of packed pixel formats.</revremark>
 195       </revision>
 196
 197       <revision>
 198         <revnumber>0.22</revnumber>
 199         <date>2007-08-29</date>
 200         <authorinitials>mhs</authorinitials>
 201         <revremark>Added the Video Output Overlay interface, new MPEG
 202 controls, V4L2_FIELD_INTERLACED_TB and V4L2_FIELD_INTERLACED_BT,
 203 VIDIOC_DBG_G/S_REGISTER, VIDIOC_(TRY_)ENCODER_CMD,
 204 VIDIOC_G_CHIP_IDENT, VIDIOC_G_ENC_INDEX, new pixel formats.
 205 Clarifications in the cropping chapter, about RGB pixel formats, the
 206 mmap(), poll(), select(), read() and write() functions. Typographical
 207 fixes.</revremark>
 208       </revision>
 209
 210       <revision>
 211         <revnumber>0.21</revnumber>
 212         <date>2006-12-19</date>
 213         <authorinitials>mhs</authorinitials>
 214         <revremark>Fixed a link in the VIDIOC_G_EXT_CTRLS section.</revremark>
 215       </revision>
 216
 217       <revision>
 218         <revnumber>0.20</revnumber>
 219         <date>2006-11-24</date>
 220         <authorinitials>mhs</authorinitials>
 221         <revremark>Clarified the purpose of the audioset field in
 222 struct v4l2_input and v4l2_output.</revremark>
 223       </revision>
 224
 225       <revision>
 226         <revnumber>0.19</revnumber>
 227         <date>2006-10-19</date>
 228         <authorinitials>mhs</authorinitials>
 229         <revremark>Documented V4L2_PIX_FMT_RGB444.</revremark>
 230       </revision>
 231
 232       <revision>
 233         <revnumber>0.18</revnumber>
 234         <date>2006-10-18</date>
 235         <authorinitials>mhs</authorinitials>
 236         <revremark>Added the description of extended controls by Hans
 237 Verkuil. Linked V4L2_PIX_FMT_MPEG to V4L2_CID_MPEG_STREAM_TYPE.</revremark>
 238       </revision>
 239
 240       <revision>
 241         <revnumber>0.17</revnumber>
 242         <date>2006-10-12</date>
 243         <authorinitials>mhs</authorinitials>
 244         <revremark>Corrected V4L2_PIX_FMT_HM12 description.</revremark>
 245       </revision>
 246
 247       <revision>
 248         <revnumber>0.16</revnumber>
 249         <date>2006-10-08</date>
 250         <authorinitials>mhs</authorinitials>
 251         <revremark>VIDIOC_ENUM_FRAMESIZES and
 252 VIDIOC_ENUM_FRAMEINTERVALS are now part of the API.</revremark>
 253       </revision>
 254
 255       <revision>
 256         <revnumber>0.15</revnumber>
 257         <date>2006-09-23</date>
 258         <authorinitials>mhs</authorinitials>
 259         <revremark>Cleaned up the bibliography, added BT.653 and
 260 BT.1119. capture.c/start_capturing() for user pointer I/O did not
 261 initialize the buffer index. Documented the V4L MPEG and MJPEG
 262 VID_TYPEs and V4L2_PIX_FMT_SBGGR8. Updated the list of reserved pixel
 263 formats. See the history chapter for API changes.</revremark>
 264       </revision>
 265
 266       <revision>
 267         <revnumber>0.14</revnumber>
 268         <date>2006-09-14</date>
 269         <authorinitials>mr</authorinitials>
 270         <revremark>Added VIDIOC_ENUM_FRAMESIZES and
 271 VIDIOC_ENUM_FRAMEINTERVALS proposal for frame format enumeration of
 272 digital devices.</revremark>
 273       </revision>
 274
 275       <revision>
 276         <revnumber>0.13</revnumber>
 277         <date>2006-04-07</date>
 278         <authorinitials>mhs</authorinitials>
 279         <revremark>Corrected the description of struct v4l2_window
 280 clips. New V4L2_STD_ and V4L2_TUNER_MODE_LANG1_LANG2
 281 defines.</revremark>
 282       </revision>
 283
 284       <revision>
 285         <revnumber>0.12</revnumber>
 286         <date>2006-02-03</date>
 287         <authorinitials>mhs</authorinitials>
 288         <revremark>Corrected the description of struct
 289 v4l2_captureparm and v4l2_outputparm.</revremark>
 290       </revision>
 291
 292       <revision>
 293         <revnumber>0.11</revnumber>
 294         <date>2006-01-27</date>
 295         <authorinitials>mhs</authorinitials>
 296         <revremark>Improved the description of struct
 297 v4l2_tuner.</revremark>
 298       </revision>
 299
 300       <revision>
 301         <revnumber>0.10</revnumber>
 302         <date>2006-01-10</date>
 303         <authorinitials>mhs</authorinitials>
 304         <revremark>VIDIOC_G_INPUT and VIDIOC_S_PARM
 305 clarifications.</revremark>
 306       </revision>
 307
 308       <revision>
 309         <revnumber>0.9</revnumber>
 310         <date>2005-11-27</date>
 311         <authorinitials>mhs</authorinitials>
 312         <revremark>Improved the 525 line numbering diagram. Hans
 313 Verkuil and I rewrote the sliced VBI section. He also contributed a
 314 VIDIOC_LOG_STATUS page. Fixed VIDIOC_S_STD call in the video standard
 315 selection example. Various updates.</revremark>
 316       </revision>
 317
 318       <revision>
 319         <revnumber>0.8</revnumber>
 320         <date>2004-10-04</date>
 321         <authorinitials>mhs</authorinitials>
 322         <revremark>Somehow a piece of junk slipped into the capture
 323 example, removed.</revremark>
 324       </revision>
 325
 326       <revision>
 327         <revnumber>0.7</revnumber>
 328         <date>2004-09-19</date>
 329         <authorinitials>mhs</authorinitials>
 330         <revremark>Fixed video standard selection, control
 331 enumeration, downscaling and aspect example. Added read and user
 332 pointer i/o to video capture example.</revremark>
 333       </revision>
 334
 335       <revision>
 336         <revnumber>0.6</revnumber>
 337         <date>2004-08-01</date>
 338         <authorinitials>mhs</authorinitials>
 339         <revremark>v4l2_buffer changes, added video capture example,
 340 various corrections.</revremark>
 341       </revision>
 342
 343       <revision>
 344         <revnumber>0.5</revnumber>
 345         <date>2003-11-05</date>
 346         <authorinitials>mhs</authorinitials>
 347         <revremark>Pixel format erratum.</revremark>
 348       </revision>
 349
 350       <revision>
 351         <revnumber>0.4</revnumber>
 352         <date>2003-09-17</date>
 353         <authorinitials>mhs</authorinitials>
 354         <revremark>Corrected source and Makefile to generate a PDF.
 355 SGML fixes. Added latest API changes. Closed gaps in the history
 356 chapter.</revremark>
 357       </revision>
 358
 359       <revision>
 360         <revnumber>0.3</revnumber>
 361         <date>2003-02-05</date>
 362         <authorinitials>mhs</authorinitials>
 363         <revremark>Another draft, more corrections.</revremark>
 364       </revision>
 365
 366       <revision>
 367         <revnumber>0.2</revnumber>
 368         <date>2003-01-15</date>
 369         <authorinitials>mhs</authorinitials>
 370         <revremark>Second draft, with corrections pointed out by Gerd
 371 Knorr.</revremark>
 372       </revision>
 373
 374       <revision>
 375         <revnumber>0.1</revnumber>
 376         <date>2002-12-01</date>
 377         <authorinitials>mhs</authorinitials>
 378         <revremark>First draft, based on documentation by Bill Dirks
 379 and discussions on the V4L mailing list.</revremark>
 380       </revision>
 381     </revhistory>
 382 </partinfo>
 383
 384 <title>Video for Linux Two API Specification</title>
 385  <subtitle>Revision 2.6.38</subtitle>
 386
 387   <chapter id="common">
 388     &sub-common;
 389   </chapter>
 390
 391   <chapter id="pixfmt">
 392     &sub-pixfmt;
 393   </chapter>
 394
 395   <chapter id="io">
 396     &sub-io;
 397   </chapter>
 398
 399   <chapter id="devices">
 400     <title>Interfaces</title>
 401
 402     <section id="capture"> &sub-dev-capture; </section>
 403     <section id="overlay"> &sub-dev-overlay; </section>
 404     <section id="output"> &sub-dev-output; </section>
 405     <section id="osd"> &sub-dev-osd; </section>
 406     <section id="codec"> &sub-dev-codec; </section>
 407     <section id="effect"> &sub-dev-effect; </section>
 408     <section id="raw-vbi"> &sub-dev-raw-vbi; </section>
 409     <section id="sliced"> &sub-dev-sliced-vbi; </section>
 410     <section id="ttx"> &sub-dev-teletext; </section>
 411     <section id="radio"> &sub-dev-radio; </section>
 412     <section id="rds"> &sub-dev-rds; </section>
 413     <section id="event"> &sub-dev-event; </section>
 414   </chapter>
 415
 416   <chapter id="driver">
 417           &sub-driver;
 418   </chapter>
 419
 420   <chapter id="libv4l">
 421           &sub-libv4l;
 422   </chapter>
 423
 424   <chapter id="compat">
 425           &sub-compat;
 426   </chapter>
 427
 428   <appendix id="user-func">
 429   <title>Function Reference</title>
 430
 431     <!-- Keep this alphabetically sorted. -->
 432
 433     &sub-close;
 434     &sub-ioctl;
 435     <!-- All ioctls go here. -->
 436     &sub-cropcap;
 437     &sub-dbg-g-chip-ident;
 438     &sub-dbg-g-register;
 439     &sub-dqevent;
 440     &sub-encoder-cmd;
 441     &sub-enumaudio;
 442     &sub-enumaudioout;
 443     &sub-enum-dv-presets;
 444     &sub-enum-fmt;
 445     &sub-enum-framesizes;
 446     &sub-enum-frameintervals;
 447     &sub-enuminput;
 448     &sub-enumoutput;
 449     &sub-enumstd;
 450     &sub-g-audio;
 451     &sub-g-audioout;
 452     &sub-g-crop;
 453     &sub-g-ctrl;
 454     &sub-g-dv-preset;
 455     &sub-g-dv-timings;
 456     &sub-g-enc-index;
 457     &sub-g-ext-ctrls;
 458     &sub-g-fbuf;
 459     &sub-g-fmt;
 460     &sub-g-frequency;
 461     &sub-g-input;
 462     &sub-g-jpegcomp;
 463     &sub-g-modulator;
 464     &sub-g-output;
 465     &sub-g-parm;
 466     &sub-g-priority;
 467     &sub-g-sliced-vbi-cap;
 468     &sub-g-std;
 469     &sub-g-tuner;
 470     &sub-log-status;
 471     &sub-overlay;
 472     &sub-qbuf;
 473     &sub-querybuf;
 474     &sub-querycap;
 475     &sub-queryctrl;
 476     &sub-query-dv-preset;
 477     &sub-querystd;
 478     &sub-reqbufs;
 479     &sub-s-hw-freq-seek;
 480     &sub-streamon;
 481     &sub-subscribe-event;
 482     <!-- End of ioctls. -->
 483     &sub-mmap;
 484     &sub-munmap;
 485     &sub-open;
 486     &sub-poll;
 487     &sub-read;
 488     &sub-select;
 489     &sub-write;
 490   </appendix>
 491
 492   <appendix id="videodev">
 493     <title>Video For Linux Two Header File</title>
 494     &sub-videodev2-h;
 495   </appendix>
 496
 497   <appendix id="capture-example">
 498     <title>Video Capture Example</title>
 499     &sub-capture-c;
 500   </appendix>
 501
 502   <appendix id="v4l2grab-example">
 503     <title>Video Grabber example using libv4l</title>
 504     <para>This program demonstrates how to grab V4L2 images in ppm format by
 505 using libv4l handlers. The advantage is that this grabber can potentially work
 506 with any V4L2 driver.</para>
 507     &sub-v4l2grab-c;
 508   </appendix>
 509
 510   &sub-media-indices;
 511
 512   &sub-biblio;
 513