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>m.chehab@samsung.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       <author>
 111         <firstname>Antti</firstname>
 112         <surname>Palosaari</surname>
 113         <contrib>SDR API.</contrib>
 114         <affiliation>
 115           <address>
 116             <email>crope@iki.fi</email>
 117           </address>
 118         </affiliation>
 119       </author>
 120     </authorgroup>
 121
 122     <copyright>
 123       <year>1999</year>
 124       <year>2000</year>
 125       <year>2001</year>
 126       <year>2002</year>
 127       <year>2003</year>
 128       <year>2004</year>
 129       <year>2005</year>
 130       <year>2006</year>
 131       <year>2007</year>
 132       <year>2008</year>
 133       <year>2009</year>
 134       <year>2010</year>
 135       <year>2011</year>
 136       <year>2012</year>
 137       <year>2013</year>
 138       <year>2014</year>
 139       <year>2015</year>
 140       <holder>Bill Dirks, Michael H. Schimek, Hans Verkuil, Martin
 141 Rubli, Andy Walls, Muralidharan Karicheri, Mauro Carvalho Chehab,
 142         Pawel Osciak</holder>
 143     </copyright>
 144     <legalnotice>
 145     <para>Except when explicitly stated as GPL, programming examples within
 146             this part can be used and distributed without restrictions.</para>
 147     </legalnotice>
 148     <revhistory>
 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
 153 applications. -->
 154       <revision>
 155         <revnumber>4.5</revnumber>
 156         <date>2015-10-29</date>
 157         <authorinitials>rr</authorinitials>
 158         <revremark>Extend vidioc-g-ext-ctrls;. Replace ctrl_class with a new
 159 union with ctrl_class and which. Which is used to select the current value of
 160 the control or the default value.
 161         </revremark>
 162       </revision>
 163
 164       <revision>
 165         <revnumber>4.4</revnumber>
 166         <date>2015-05-26</date>
 167         <authorinitials>ap</authorinitials>
 168         <revremark>Renamed V4L2_TUNER_ADC to V4L2_TUNER_SDR.
 169 Added V4L2_CID_RF_TUNER_RF_GAIN control.
 170 Added transmitter support for Software Defined Radio (SDR) Interface.
 171         </revremark>
 172       </revision>
 173
 174       <revision>
 175         <revnumber>4.1</revnumber>
 176         <date>2015-02-13</date>
 177         <authorinitials>mcc</authorinitials>
 178         <revremark>Fix documentation for media controller device nodes and add support for DVB device nodes.
 179 Add support for Tuner sub-device.
 180         </revremark>
 181       </revision>
 182       <revision>
 183         <revnumber>3.19</revnumber>
 184         <date>2014-12-05</date>
 185         <authorinitials>hv</authorinitials>
 186         <revremark>Rewrote Colorspace chapter, added new &v4l2-ycbcr-encoding; and &v4l2-quantization; fields
 187 to &v4l2-pix-format;, &v4l2-pix-format-mplane; and &v4l2-mbus-framefmt;.
 188         </revremark>
 189       </revision>
 190
 191       <revision>
 192         <revnumber>3.17</revnumber>
 193         <date>2014-08-04</date>
 194         <authorinitials>lp, hv</authorinitials>
 195         <revremark>Extended &v4l2-pix-format;. Added format flags. Added compound control types
 196 and VIDIOC_QUERY_EXT_CTRL.
 197         </revremark>
 198       </revision>
 199
 200       <revision>
 201         <revnumber>3.15</revnumber>
 202         <date>2014-02-03</date>
 203         <authorinitials>hv, ap</authorinitials>
 204         <revremark>Update several sections of "Common API Elements": "Opening and Closing Devices"
 205 "Querying Capabilities", "Application Priority", "Video Inputs and Outputs", "Audio Inputs and Outputs"
 206 "Tuners and Modulators", "Video Standards" and "Digital Video (DV) Timings". Added SDR API.
 207         </revremark>
 208       </revision>
 209
 210       <revision>
 211         <revnumber>3.14</revnumber>
 212         <date>2013-11-25</date>
 213         <authorinitials>rr</authorinitials>
 214         <revremark>Set width and height as unsigned on v4l2_rect.
 215         </revremark>
 216       </revision>
 217
 218       <revision>
 219         <revnumber>3.11</revnumber>
 220         <date>2013-05-26</date>
 221         <authorinitials>hv</authorinitials>
 222         <revremark>Remove obsolete VIDIOC_DBG_G_CHIP_IDENT ioctl.
 223         </revremark>
 224       </revision>
 225
 226       <revision>
 227         <revnumber>3.10</revnumber>
 228         <date>2013-03-25</date>
 229         <authorinitials>hv</authorinitials>
 230         <revremark>Remove obsolete and unused DV_PRESET ioctls:
 231         VIDIOC_G_DV_PRESET, VIDIOC_S_DV_PRESET, VIDIOC_QUERY_DV_PRESET and
 232         VIDIOC_ENUM_DV_PRESET. Remove the related v4l2_input/output capability
 233         flags V4L2_IN_CAP_PRESETS and V4L2_OUT_CAP_PRESETS. Added VIDIOC_DBG_G_CHIP_INFO.
 234         </revremark>
 235       </revision>
 236
 237       <revision>
 238         <revnumber>3.9</revnumber>
 239         <date>2012-12-03</date>
 240         <authorinitials>sa, sn</authorinitials>
 241         <revremark>Added timestamp types to v4l2_buffer.
 242         Added V4L2_EVENT_CTRL_CH_RANGE control event changes flag.
 243         </revremark>
 244       </revision>
 245
 246       <revision>
 247         <revnumber>3.6</revnumber>
 248         <date>2012-07-02</date>
 249         <authorinitials>hv</authorinitials>
 250         <revremark>Added VIDIOC_ENUM_FREQ_BANDS.
 251         </revremark>
 252       </revision>
 253
 254       <revision>
 255         <revnumber>3.5</revnumber>
 256         <date>2012-05-07</date>
 257         <authorinitials>sa, sn, hv</authorinitials>
 258         <revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU and V4L2 subdev
 259             selections API. Improved the description of V4L2_CID_COLORFX
 260             control, added V4L2_CID_COLORFX_CBCR control.
 261             Added camera controls V4L2_CID_AUTO_EXPOSURE_BIAS,
 262             V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE, V4L2_CID_IMAGE_STABILIZATION,
 263             V4L2_CID_ISO_SENSITIVITY, V4L2_CID_ISO_SENSITIVITY_AUTO,
 264             V4L2_CID_EXPOSURE_METERING, V4L2_CID_SCENE_MODE,
 265             V4L2_CID_3A_LOCK, V4L2_CID_AUTO_FOCUS_START,
 266             V4L2_CID_AUTO_FOCUS_STOP, V4L2_CID_AUTO_FOCUS_STATUS
 267             and V4L2_CID_AUTO_FOCUS_RANGE.
 268             Added VIDIOC_ENUM_DV_TIMINGS, VIDIOC_QUERY_DV_TIMINGS and
 269             VIDIOC_DV_TIMINGS_CAP.
 270         </revremark>
 271       </revision>
 272
 273       <revision>
 274         <revnumber>3.4</revnumber>
 275         <date>2012-01-25</date>
 276         <authorinitials>sn</authorinitials>
 277         <revremark>Added <link linkend="jpeg-controls">JPEG compression
 278             control class.</link>
 279         </revremark>
 280       </revision>
 281
 282       <revision>
 283         <revnumber>3.3</revnumber>
 284         <date>2012-01-11</date>
 285         <authorinitials>hv</authorinitials>
 286         <revremark>Added device_caps field to struct v4l2_capabilities.</revremark>
 287       </revision>
 288
 289       <revision>
 290         <revnumber>3.2</revnumber>
 291         <date>2011-08-26</date>
 292         <authorinitials>hv</authorinitials>
 293         <revremark>Added V4L2_CTRL_FLAG_VOLATILE.</revremark>
 294       </revision>
 295
 296       <revision>
 297         <revnumber>3.1</revnumber>
 298         <date>2011-06-27</date>
 299         <authorinitials>mcc, po, hv</authorinitials>
 300         <revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.
 301                    Standardize an error code for invalid ioctl.
 302                    Added V4L2_CTRL_TYPE_BITMASK.</revremark>
 303       </revision>
 304
 305       <revision>
 306         <revnumber>2.6.39</revnumber>
 307         <date>2011-03-01</date>
 308         <authorinitials>mcc, po</authorinitials>
 309         <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>
 310       </revision>
 311
 312       <revision>
 313         <revnumber>2.6.37</revnumber>
 314         <date>2010-08-06</date>
 315         <authorinitials>hv</authorinitials>
 316         <revremark>Removed obsolete vtx (videotext) API.</revremark>
 317       </revision>
 318
 319       <revision>
 320         <revnumber>2.6.33</revnumber>
 321         <date>2009-12-03</date>
 322         <authorinitials>mk</authorinitials>
 323         <revremark>Added documentation for the Digital Video timings API.</revremark>
 324       </revision>
 325
 326       <revision>
 327         <revnumber>2.6.32</revnumber>
 328         <date>2009-08-31</date>
 329         <authorinitials>mcc</authorinitials>
 330         <revremark>Now, revisions will match the kernel version where
 331 the V4L2 API changes will be used by the Linux Kernel.
 332 Also added Remote Controller chapter.</revremark>
 333       </revision>
 334
 335       <revision>
 336         <revnumber>0.29</revnumber>
 337         <date>2009-08-26</date>
 338         <authorinitials>ev</authorinitials>
 339         <revremark>Added documentation for string controls and for FM Transmitter controls.</revremark>
 340       </revision>
 341
 342       <revision>
 343         <revnumber>0.28</revnumber>
 344         <date>2009-08-26</date>
 345         <authorinitials>gl</authorinitials>
 346         <revremark>Added V4L2_CID_BAND_STOP_FILTER documentation.</revremark>
 347       </revision>
 348
 349       <revision>
 350         <revnumber>0.27</revnumber>
 351         <date>2009-08-15</date>
 352         <authorinitials>mcc</authorinitials>
 353         <revremark>Added libv4l and Remote Controller documentation;
 354 added v4l2grab and keytable application examples.</revremark>
 355       </revision>
 356
 357       <revision>
 358         <revnumber>0.26</revnumber>
 359         <date>2009-07-23</date>
 360         <authorinitials>hv</authorinitials>
 361         <revremark>Finalized the RDS capture API. Added modulator and RDS encoder
 362 capabilities. Added support for string controls.</revremark>
 363       </revision>
 364
 365       <revision>
 366         <revnumber>0.25</revnumber>
 367         <date>2009-01-18</date>
 368         <authorinitials>hv</authorinitials>
 369         <revremark>Added pixel formats VYUY, NV16 and NV61, and changed
 370 the debug ioctls VIDIOC_DBG_G/S_REGISTER and VIDIOC_DBG_G_CHIP_IDENT.
 371 Added camera controls V4L2_CID_ZOOM_ABSOLUTE, V4L2_CID_ZOOM_RELATIVE,
 372 V4L2_CID_ZOOM_CONTINUOUS and V4L2_CID_PRIVACY.</revremark>
 373       </revision>
 374
 375       <revision>
 376         <revnumber>0.24</revnumber>
 377         <date>2008-03-04</date>
 378         <authorinitials>mhs</authorinitials>
 379         <revremark>Added pixel formats Y16 and SBGGR16, new controls
 380 and a camera controls class. Removed VIDIOC_G/S_MPEGCOMP.</revremark>
 381       </revision>
 382
 383       <revision>
 384         <revnumber>0.23</revnumber>
 385         <date>2007-08-30</date>
 386         <authorinitials>mhs</authorinitials>
 387         <revremark>Fixed a typo in VIDIOC_DBG_G/S_REGISTER.
 388 Clarified the byte order of packed pixel formats.</revremark>
 389       </revision>
 390
 391       <revision>
 392         <revnumber>0.22</revnumber>
 393         <date>2007-08-29</date>
 394         <authorinitials>mhs</authorinitials>
 395         <revremark>Added the Video Output Overlay interface, new MPEG
 396 controls, V4L2_FIELD_INTERLACED_TB and V4L2_FIELD_INTERLACED_BT,
 397 VIDIOC_DBG_G/S_REGISTER, VIDIOC_(TRY_)ENCODER_CMD,
 398 VIDIOC_G_CHIP_IDENT, VIDIOC_G_ENC_INDEX, new pixel formats.
 399 Clarifications in the cropping chapter, about RGB pixel formats, the
 400 mmap(), poll(), select(), read() and write() functions. Typographical
 401 fixes.</revremark>
 402       </revision>
 403
 404       <revision>
 405         <revnumber>0.21</revnumber>
 406         <date>2006-12-19</date>
 407         <authorinitials>mhs</authorinitials>
 408         <revremark>Fixed a link in the VIDIOC_G_EXT_CTRLS section.</revremark>
 409       </revision>
 410
 411       <revision>
 412         <revnumber>0.20</revnumber>
 413         <date>2006-11-24</date>
 414         <authorinitials>mhs</authorinitials>
 415         <revremark>Clarified the purpose of the audioset field in
 416 struct v4l2_input and v4l2_output.</revremark>
 417       </revision>
 418
 419       <revision>
 420         <revnumber>0.19</revnumber>
 421         <date>2006-10-19</date>
 422         <authorinitials>mhs</authorinitials>
 423         <revremark>Documented V4L2_PIX_FMT_RGB444.</revremark>
 424       </revision>
 425
 426       <revision>
 427         <revnumber>0.18</revnumber>
 428         <date>2006-10-18</date>
 429         <authorinitials>mhs</authorinitials>
 430         <revremark>Added the description of extended controls by Hans
 431 Verkuil. Linked V4L2_PIX_FMT_MPEG to V4L2_CID_MPEG_STREAM_TYPE.</revremark>
 432       </revision>
 433
 434       <revision>
 435         <revnumber>0.17</revnumber>
 436         <date>2006-10-12</date>
 437         <authorinitials>mhs</authorinitials>
 438         <revremark>Corrected V4L2_PIX_FMT_HM12 description.</revremark>
 439       </revision>
 440
 441       <revision>
 442         <revnumber>0.16</revnumber>
 443         <date>2006-10-08</date>
 444         <authorinitials>mhs</authorinitials>
 445         <revremark>VIDIOC_ENUM_FRAMESIZES and
 446 VIDIOC_ENUM_FRAMEINTERVALS are now part of the API.</revremark>
 447       </revision>
 448
 449       <revision>
 450         <revnumber>0.15</revnumber>
 451         <date>2006-09-23</date>
 452         <authorinitials>mhs</authorinitials>
 453         <revremark>Cleaned up the bibliography, added BT.653 and
 454 BT.1119. capture.c/start_capturing() for user pointer I/O did not
 455 initialize the buffer index. Documented the V4L MPEG and MJPEG
 456 VID_TYPEs and V4L2_PIX_FMT_SBGGR8. Updated the list of reserved pixel
 457 formats. See the history chapter for API changes.</revremark>
 458       </revision>
 459
 460       <revision>
 461         <revnumber>0.14</revnumber>
 462         <date>2006-09-14</date>
 463         <authorinitials>mr</authorinitials>
 464         <revremark>Added VIDIOC_ENUM_FRAMESIZES and
 465 VIDIOC_ENUM_FRAMEINTERVALS proposal for frame format enumeration of
 466 digital devices.</revremark>
 467       </revision>
 468
 469       <revision>
 470         <revnumber>0.13</revnumber>
 471         <date>2006-04-07</date>
 472         <authorinitials>mhs</authorinitials>
 473         <revremark>Corrected the description of struct v4l2_window
 474 clips. New V4L2_STD_ and V4L2_TUNER_MODE_LANG1_LANG2
 475 defines.</revremark>
 476       </revision>
 477
 478       <revision>
 479         <revnumber>0.12</revnumber>
 480         <date>2006-02-03</date>
 481         <authorinitials>mhs</authorinitials>
 482         <revremark>Corrected the description of struct
 483 v4l2_captureparm and v4l2_outputparm.</revremark>
 484       </revision>
 485
 486       <revision>
 487         <revnumber>0.11</revnumber>
 488         <date>2006-01-27</date>
 489         <authorinitials>mhs</authorinitials>
 490         <revremark>Improved the description of struct
 491 v4l2_tuner.</revremark>
 492       </revision>
 493
 494       <revision>
 495         <revnumber>0.10</revnumber>
 496         <date>2006-01-10</date>
 497         <authorinitials>mhs</authorinitials>
 498         <revremark>VIDIOC_G_INPUT and VIDIOC_S_PARM
 499 clarifications.</revremark>
 500       </revision>
 501
 502       <revision>
 503         <revnumber>0.9</revnumber>
 504         <date>2005-11-27</date>
 505         <authorinitials>mhs</authorinitials>
 506         <revremark>Improved the 525 line numbering diagram. Hans
 507 Verkuil and I rewrote the sliced VBI section. He also contributed a
 508 VIDIOC_LOG_STATUS page. Fixed VIDIOC_S_STD call in the video standard
 509 selection example. Various updates.</revremark>
 510       </revision>
 511
 512       <revision>
 513         <revnumber>0.8</revnumber>
 514         <date>2004-10-04</date>
 515         <authorinitials>mhs</authorinitials>
 516         <revremark>Somehow a piece of junk slipped into the capture
 517 example, removed.</revremark>
 518       </revision>
 519
 520       <revision>
 521         <revnumber>0.7</revnumber>
 522         <date>2004-09-19</date>
 523         <authorinitials>mhs</authorinitials>
 524         <revremark>Fixed video standard selection, control
 525 enumeration, downscaling and aspect example. Added read and user
 526 pointer i/o to video capture example.</revremark>
 527       </revision>
 528
 529       <revision>
 530         <revnumber>0.6</revnumber>
 531         <date>2004-08-01</date>
 532         <authorinitials>mhs</authorinitials>
 533         <revremark>v4l2_buffer changes, added video capture example,
 534 various corrections.</revremark>
 535       </revision>
 536
 537       <revision>
 538         <revnumber>0.5</revnumber>
 539         <date>2003-11-05</date>
 540         <authorinitials>mhs</authorinitials>
 541         <revremark>Pixel format erratum.</revremark>
 542       </revision>
 543
 544       <revision>
 545         <revnumber>0.4</revnumber>
 546         <date>2003-09-17</date>
 547         <authorinitials>mhs</authorinitials>
 548         <revremark>Corrected source and Makefile to generate a PDF.
 549 SGML fixes. Added latest API changes. Closed gaps in the history
 550 chapter.</revremark>
 551       </revision>
 552
 553       <revision>
 554         <revnumber>0.3</revnumber>
 555         <date>2003-02-05</date>
 556         <authorinitials>mhs</authorinitials>
 557         <revremark>Another draft, more corrections.</revremark>
 558       </revision>
 559
 560       <revision>
 561         <revnumber>0.2</revnumber>
 562         <date>2003-01-15</date>
 563         <authorinitials>mhs</authorinitials>
 564         <revremark>Second draft, with corrections pointed out by Gerd
 565 Knorr.</revremark>
 566       </revision>
 567
 568       <revision>
 569         <revnumber>0.1</revnumber>
 570         <date>2002-12-01</date>
 571         <authorinitials>mhs</authorinitials>
 572         <revremark>First draft, based on documentation by Bill Dirks
 573 and discussions on the V4L mailing list.</revremark>
 574       </revision>
 575     </revhistory>
 576 </partinfo>
 577
 578 <title>Video for Linux Two API Specification</title>
 579  <subtitle>Revision 4.4</subtitle>
 580
 581   <chapter id="common">
 582     &sub-common;
 583   </chapter>
 584
 585   <chapter id="pixfmt">
 586     &sub-pixfmt;
 587   </chapter>
 588
 589   <chapter id="io">
 590     &sub-io;
 591   </chapter>
 592
 593   <chapter id="devices">
 594     <title>Interfaces</title>
 595
 596     <section id="capture"> &sub-dev-capture; </section>
 597     <section id="overlay"> &sub-dev-overlay; </section>
 598     <section id="output"> &sub-dev-output; </section>
 599     <section id="osd"> &sub-dev-osd; </section>
 600     <section id="codec"> &sub-dev-codec; </section>
 601     <section id="effect"> &sub-dev-effect; </section>
 602     <section id="raw-vbi"> &sub-dev-raw-vbi; </section>
 603     <section id="sliced"> &sub-dev-sliced-vbi; </section>
 604     <section id="ttx"> &sub-dev-teletext; </section>
 605     <section id="radio"> &sub-dev-radio; </section>
 606     <section id="rds"> &sub-dev-rds; </section>
 607     <section id="sdr"> &sub-dev-sdr; </section>
 608     <section id="event"> &sub-dev-event; </section>
 609     <section id="subdev"> &sub-dev-subdev; </section>
 610   </chapter>
 611
 612   <chapter id="driver">
 613           &sub-driver;
 614   </chapter>
 615
 616   <chapter id="libv4l">
 617           &sub-libv4l;
 618   </chapter>
 619
 620   <chapter id="compat">
 621           &sub-compat;
 622   </chapter>
 623
 624   <appendix id="user-func">
 625   <title>Function Reference</title>
 626
 627     <!-- Keep this alphabetically sorted. -->
 628
 629     &sub-close;
 630     &sub-ioctl;
 631     <!-- All ioctls go here. -->
 632     &sub-create-bufs;
 633     &sub-cropcap;
 634     &sub-dbg-g-chip-info;
 635     &sub-dbg-g-register;
 636     &sub-decoder-cmd;
 637     &sub-dqevent;
 638     &sub-dv-timings-cap;
 639     &sub-encoder-cmd;
 640     &sub-enumaudio;
 641     &sub-enumaudioout;
 642     &sub-enum-dv-timings;
 643     &sub-enum-fmt;
 644     &sub-enum-framesizes;
 645     &sub-enum-frameintervals;
 646     &sub-enum-freq-bands;
 647     &sub-enuminput;
 648     &sub-enumoutput;
 649     &sub-enumstd;
 650     &sub-expbuf;
 651     &sub-g-audio;
 652     &sub-g-audioout;
 653     &sub-g-crop;
 654     &sub-g-ctrl;
 655     &sub-g-dv-timings;
 656     &sub-g-edid;
 657     &sub-g-enc-index;
 658     &sub-g-ext-ctrls;
 659     &sub-g-fbuf;
 660     &sub-g-fmt;
 661     &sub-g-frequency;
 662     &sub-g-input;
 663     &sub-g-jpegcomp;
 664     &sub-g-modulator;
 665     &sub-g-output;
 666     &sub-g-parm;
 667     &sub-g-priority;
 668     &sub-g-selection;
 669     &sub-g-sliced-vbi-cap;
 670     &sub-g-std;
 671     &sub-g-tuner;
 672     &sub-log-status;
 673     &sub-overlay;
 674     &sub-prepare-buf;
 675     &sub-qbuf;
 676     &sub-querybuf;
 677     &sub-querycap;
 678     &sub-queryctrl;
 679     &sub-query-dv-timings;
 680     &sub-querystd;
 681     &sub-reqbufs;
 682     &sub-s-hw-freq-seek;
 683     &sub-streamon;
 684     &sub-subdev-enum-frame-interval;
 685     &sub-subdev-enum-frame-size;
 686     &sub-subdev-enum-mbus-code;
 687     &sub-subdev-g-crop;
 688     &sub-subdev-g-fmt;
 689     &sub-subdev-g-frame-interval;
 690     &sub-subdev-g-selection;
 691     &sub-subscribe-event;
 692     <!-- End of ioctls. -->
 693     &sub-mmap;
 694     &sub-munmap;
 695     &sub-open;
 696     &sub-poll;
 697     &sub-read;
 698     &sub-select;
 699     &sub-write;
 700   </appendix>
 701
 702   <appendix>
 703     <title>Common definitions for V4L2 and V4L2 subdev interfaces</title>
 704       &sub-selections-common;
 705   </appendix>
 706
 707   <appendix id="videodev">
 708     <title>Video For Linux Two Header File</title>
 709     &sub-videodev2-h;
 710   </appendix>
 711
 712   <appendix id="capture-example">
 713     <title>Video Capture Example</title>
 714     &sub-capture-c;
 715   </appendix>
 716
 717   <appendix id="v4l2grab-example">
 718     <title>Video Grabber example using libv4l</title>
 719     <para>This program demonstrates how to grab V4L2 images in ppm format by
 720 using libv4l handlers. The advantage is that this grabber can potentially work
 721 with any V4L2 driver.</para>
 722     &sub-v4l2grab-c;
 723   </appendix>
 724
 725   &sub-media-indices;
 726
 727   &sub-biblio;
 728