source: multimedia/libdriv/v4l-utils.xml@ b359074a

gimp3 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since b359074a was 4f1c8743, checked in by Bruce Dubbs <bdubbs@…>, 3 months ago

Reformat v4l-utils page.wq
  • Property mode set to 100644
File size: 13.4 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY v4l-download-http "https://www.linuxtv.org/downloads/v4l-utils/v4l-utils-&v4l-utils-version;.tar.xz">
8 <!ENTITY v4l-download-ftp " ">
9 <!ENTITY v4l-md5sum "a3565a8ccc427dcce52845c2b8880c28">
10 <!ENTITY v4l-size "1.2 MB">
11 <!ENTITY v4l-buildsize "32 MB">
12 <!ENTITY v4l-time "1.1 SBU (using parallelism=4)">
13]>
14
15<sect1 id="v4l-utils" xreflabel="v4l-utils-&v4l-utils-version;">
16 <?dbhtml filename="v4l-utils.html" ?>
17
18
19 <title>v4l-utils-&v4l-utils-version;</title>
20
21 <indexterm zone="v4l-utils">
22 <primary sortas="a-v4l-utils">v4l-utils</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to v4l-utils</title>
27
28 <para>
29 <application>v4l-utils</application> provides a series of utilities for
30 media devices, allowing the ability to handle the proprietary formats
31 available from most webcams (libv4l), and providing tools to test V4L devices.
32 </para>
33
34 &lfs121_checked;
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&v4l-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download (FTP): <ulink url="&v4l-download-ftp;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download MD5 sum: &v4l-md5sum;
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download size: &v4l-size;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Estimated disk space required: &v4l-buildsize;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated build time: &v4l-time;
66 </para>
67 </listitem>
68 </itemizedlist>
69<!--
70 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
71 <itemizedlist>
72 <listitem>
73 <para>
74 Required patch:
75 <ulink url="&patch-root;/v4l-utils-&v4l-utils-version;-upstream_fixes-1.patch"/>
76 </para>
77 </listitem>
78 </itemizedlist>
79-->
80 <bridgehead renderas="sect3">v4l-utils Dependencies</bridgehead>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended">
84 <xref linkend="alsa-lib"/>,
85 <xref linkend="glu"/>, and
86 <xref linkend="libjpeg"/>
87 </para>
88
89 <bridgehead renderas="sect4">Optional</bridgehead>
90 <para role="optional">
91 <xref linkend="doxygen"/>,
92 &qt5-deps; (for qv4l2 and qvidcap),
93 <xref linkend="sdl2"/>,
94 both <xref linkend="llvm"/> (with Clang and target BPF)
95 and <ulink url='https://github.com/libbpf/libbpf'>libbpf</ulink>
96 (for infrared remote control decoders based on BPF), and
97 <ulink url="https://github.com/libsdl-org/SDL_image">SDL_image</ulink>
98 </para>
99
100 </sect2>
101
102 <sect2 role="installation">
103 <title>Installation of v4l-utils</title>
104
105 <note>
106 <para>
107 If you've installed both LLVM and libbpf (not in BLFS), either
108 enable the BPF target (via
109 <option>-DLLVM_TARGETS_TO_BUILD=</option>) building LLVM, or disable
110 the infrared remote control decoders based on BPF:
111 </para>
112
113 <!-- not "nodump" because it's harmless for BLFS anyway -->
114 <screen><userinput>sed -i '/^ir_bpf_enabled/s/=.*/= false/' utils/keytable/meson.build</userinput></screen>
115 </note>
116
117 <para>
118 Install <application>v4l-utils</application> by running
119 the following commands:
120 </para>
121
122<screen><userinput>mkdir build &amp;&amp;
123cd build &amp;&amp;
124
125meson setup --prefix=/usr \
126 -D doxygen-doc=disabled \
127 -D gconv=disabled \
128 --buildtype=release .. &amp;&amp;
129ninja</userinput></screen>
130
131 <para>
132 This package does not come with a test suite.
133 </para>
134
135 <para>
136 Now, as the <systemitem class="username">root</systemitem> user:
137 </para>
138
139<screen role="root"><userinput>ninja install</userinput></screen>
140
141 <para>
142 If you also wish to install the contrib programs, add:
143 </para>
144
145<screen role="root"><userinput>for prog in v4l2gl v4l2grab
146do
147 cp -v contrib/test/$prog /usr/bin
148done</userinput></screen>
149
150 </sect2>
151
152 <sect2 role="commands">
153 <title>Command Explanations</title>
154
155 <para>
156 <parameter>-Dgconv=disabled</parameter>: This switch disables
157 the erroneous installation of gconv-modules that would break glibc.
158 </para>
159
160 </sect2>
161
162
163 <sect2 role="content">
164 <title>Contents</title>
165
166 <segmentedlist>
167 <segtitle>Installed Programs</segtitle>
168 <segtitle>Installed Library</segtitle>
169 <segtitle>Installed Directories</segtitle>
170
171 <seglistitem>
172 <seg>
173 cec-compliance,
174 cec-ctl,
175 cec-follower,
176 cx18-ctl,
177 decode_tm6000,
178 dvb-fe-tool,
179 dvb-format-convert,
180 dvbv5-daemon,
181 dvbv5-scan,
182 dvbv5-zap,
183 ir-ctl,
184 ir-keytable,
185 ivtv-ctl,
186 media-ctl,
187 qv4l2,
188 qvidcap,
189 rds-ctl,
190 v4l2-compliance,
191 v4l2-ctl,
192 v4l2-dbg,
193 v4l2gl,
194 v4l2grab, and
195 v4l2-sysfs-path
196 </seg>
197 <seg>
198 libdvbv5.so,
199 libv4l1.so,
200 libv4l2.so,
201 libv4l2rds.so,
202 libv4lconvert.so,
203 v4l1compat.so, and
204 v4l2convert.so
205 </seg>
206 <seg>
207 /etc/rc_keymaps,
208 /lib/udev/rc_keymaps,
209 /usr/include/libdvbv5, and
210 /usr/lib/libv4l
211 </seg>
212 </seglistitem>
213 </segmentedlist>
214
215 <variablelist>
216 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
217 <?dbfo list-presentation="list"?>
218 <?dbhtml list-presentation="table"?>
219
220 <varlistentry id="cx18-ctl">
221 <term><command>cx18-ctl</command></term>
222 <listitem>
223 <para>
224 is a tool to handle cx18 based devices
225 </para>
226 <indexterm zone="v4l-utils cx18-ctl">
227 <primary sortas="b-cx18-ctl">cx18-ctl</primary>
228 </indexterm>
229 </listitem>
230 </varlistentry>
231
232 <varlistentry id="decode_tm6000">
233 <term><command>decode_tm6000</command></term>
234 <listitem>
235 <para>
236 decodes multiplexed formats from TM5600/TM6000 USB devices
237 </para>
238 <indexterm zone="v4l-utils decode_tm6000">
239 <primary sortas="b-decode_tm6000">decode_tm6000</primary>
240 </indexterm>
241 </listitem>
242 </varlistentry>
243
244 <varlistentry id="dvb-fe-tool">
245 <term><command>dvb-fe-tool</command></term>
246 <listitem>
247 <para>
248 is a command line tool for digital TV services
249 </para>
250 <indexterm zone="v4l-utils dvb-fe-tool">
251 <primary sortas="b-dvb-fe-tool">dvb-fe-tool</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="dvb-format-convert">
257 <term><command>dvb-format-convert</command></term>
258 <listitem>
259 <para>
260 is a tool meant to convert among different file formats. It is
261 compliant with version 5 of the DVB API
262 </para>
263 <indexterm zone="v4l-utils dvb-format-convert">
264 <primary sortas="b-dvb-format-convert">dvb-format-convert</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="dvbv5-scan">
270 <term><command>dvbv5-scan</command></term>
271 <listitem>
272 <para>
273 is a command line frequency scanning tool for digital TV
274 services that are compliant with version 5 of the DVB API
275 </para>
276 <indexterm zone="v4l-utils dvbv5-scan">
277 <primary sortas="b-dvbv5-scan">dvbv5-scan</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="dvbv5-zap">
283 <term><command>dvbv5-zap</command></term>
284 <listitem>
285 <para>
286 is a command line tuning tool for digital TV services
287 that is compliant with version 5 of the DVB API
288 </para>
289 <indexterm zone="v4l-utils dvbv5-zap">
290 <primary sortas="b-dvbv5-zap">dvbv5-zap</primary>
291 </indexterm>
292 </listitem>
293 </varlistentry>
294
295 <varlistentry id="ir-keytable">
296 <term><command>ir-keytable</command></term>
297 <listitem>
298 <para>
299 is a tool that lists the Remote Controller devices, allows one
300 to get/set IR keycode/scancode tables, test events generated by
301 IR, and to adjust other Remote Controller options
302 </para>
303 <indexterm zone="v4l-utils ir-keytable">
304 <primary sortas="b-ir-keytable">ir-keytable</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="ivtv-ctl">
310 <term><command>ivtv-ctl</command></term>
311 <listitem>
312 <para>
313 is a utility that can control many card settings, like changing
314 the inputs from tuner to svideo or composite, setting video
315 resolution or changing video mode (PAL, SECAM, NTSC)
316 </para>
317 <indexterm zone="v4l-utils ivtv-ctl">
318 <primary sortas="b-ivtv-ctl">ivtv-ctl</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="media-ctl">
324 <term><command>media-ctl</command></term>
325 <listitem>
326 <para>
327 is a utility used to configure V4L2 devices
328 </para>
329 <indexterm zone="v4l-utils media-ctl">
330 <primary sortas="b-media-ctl">media-ctl</primary>
331 </indexterm>
332 </listitem>
333 </varlistentry>
334
335 <varlistentry id="qv4l2">
336 <term><command>qv4l2</command></term>
337 <listitem>
338 <para>
339 is used to test video4linux capture devices
340 </para>
341 <indexterm zone="v4l-utils qv4l2">
342 <primary sortas="b-qv4l2">qv4l2</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="qvidcap">
348 <term><command>qvidcap</command></term>
349 <listitem>
350 <para>
351 is used to capture video from a V4L2 device
352 </para>
353 <indexterm zone="v4l-utils qvidcap">
354 <primary sortas="b-qvidcap">qvidcap</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="rds-ctl">
360 <term><command>rds-ctl</command></term>
361 <listitem>
362 <para>
363 is a utility for decoding raw RDS data from V4L2 Radio devices
364 and offers simple ways to access the received RDS information
365 </para>
366 <indexterm zone="v4l-utils rds-ctl">
367 <primary sortas="b-rds-ctl">rds-ctl</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="v4l2-compliance">
373 <term><command>v4l2-compliance</command></term>
374 <listitem>
375 <para>
376 is a compliance test tool
377 </para>
378 <indexterm zone="v4l-utils v4l2-compliance">
379 <primary sortas="b-v4l2-compliance">v4l2-compliance</primary>
380 </indexterm>
381 </listitem>
382 </varlistentry>
383
384 <varlistentry id="v4l2-ctl">
385 <term><command>v4l2-ctl</command></term>
386 <listitem>
387 <para>
388 is a tool to control v4l2 controls from the cmdline
389 </para>
390 <indexterm zone="v4l-utils v4l2-ctl">
391 <primary sortas="b-v4l2-ctl">v4l2-ctl</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="v4l2-dbg">
397 <term><command>v4l2-dbg</command></term>
398 <listitem>
399 <para>
400 is a tool to directly get and set registers of v4l2 devices
401 </para>
402 <indexterm zone="v4l-utils v4l2-dbg">
403 <primary sortas="b-v4l2-dbg">v4l2-dbg</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="v4l2gl">
409 <term><command>v4l2gl</command></term>
410 <listitem>
411 <para>
412 captures images using libv4l and stores them as PPM files
413 </para>
414 <indexterm zone="v4l-utils v4l2gl">
415 <primary sortas="b-v4l2gl">v4l2gl</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="v4l2grab">
421 <term><command>v4l2grab</command></term>
422 <listitem>
423 <para>
424 captures images using libv4l and stores them as PPM files, while
425 also allowing for additional options such as setting the amount of
426 frames captured and saving the file as a RAW file
427 </para>
428 <indexterm zone="v4l-utils v4l2grab">
429 <primary sortas="b-v4l2grab">v4l2grab</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="v4l2-sysfs-path">
435 <term><command>v4l2-sysfs-path</command></term>
436 <listitem>
437 <para>
438 checks the media devices installed on a machine and the
439 corresponding device nodes
440 </para>
441 <indexterm zone="v4l-utils v4l2-sysfs-path">
442 <primary sortas="b-v4l2-sysfs-path">v4l2-sysfs-path</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 </variablelist>
448
449 </sect2>
450
451</sect1>
Note: See TracBrowser for help on using the repository browser.