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