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