source: multimedia/libdriv/v4l-utils.xml@ 9b515726

12.2 lazarus trunk xry111/for-12.3 xry111/spidermonkey128
Last change on this file since 9b515726 was 9b515726, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

Update to v4l-utils-1.28.0.
  • Property mode set to 100644
File size: 13.5 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 "9551b13e088a8b00a7706863ec68f198">
10 <!ENTITY v4l-size "1.2 MB">
11 <!ENTITY v4l-buildsize "34 MB">
12 <!ENTITY v4l-time "0.4 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 <xref linkend="qt6"/> (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>-D LLVM_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 .. \
126 --prefix=/usr \
127 --buildtype=release \
128 -D doxygen-doc=disabled &amp;&amp;
129ninja</userinput></screen>
130
131 <!-- I don't think this is needed any more
132 -D gconv=disabled
133 -->
134
135 <para>
136 This package does not come with a test suite.
137 </para>
138
139 <para>
140 Now, as the <systemitem class="username">root</systemitem> user:
141 </para>
142
143<screen role="root"><userinput>ninja install</userinput></screen>
144
145 <para>
146 If you also wish to install the contrib programs, add:
147 </para>
148
149<screen role="root"><userinput>for prog in v4l2gl v4l2grab
150do
151 cp -v contrib/test/$prog /usr/bin
152done</userinput></screen>
153
154 </sect2>
155<!--
156 <sect2 role="commands">
157 <title>Command Explanations</title>
158
159 <para>
160 <parameter>-D gconv=disabled</parameter>: This switch disables
161 the erroneous installation of gconv-modules that would break glibc.
162 </para>
163
164 </sect2>
165-->
166
167 <sect2 role="content">
168 <title>Contents</title>
169
170 <segmentedlist>
171 <segtitle>Installed Programs</segtitle>
172 <segtitle>Installed Library</segtitle>
173 <segtitle>Installed Directories</segtitle>
174
175 <seglistitem>
176 <seg>
177 cec-compliance,
178 cec-ctl,
179 cec-follower,
180 cx18-ctl,
181 decode_tm6000,
182 dvb-fe-tool,
183 dvb-format-convert,
184 dvbv5-daemon,
185 dvbv5-scan,
186 dvbv5-zap,
187 ir-ctl,
188 ir-keytable,
189 ivtv-ctl,
190 media-ctl,
191 qv4l2,
192 qvidcap,
193 rds-ctl,
194 v4l2-compliance,
195 v4l2-ctl,
196 v4l2-dbg,
197 v4l2gl,
198 v4l2grab, and
199 v4l2-sysfs-path
200 </seg>
201 <seg>
202 libdvbv5.so,
203 libv4l1.so,
204 libv4l2.so,
205 libv4l2rds.so,
206 libv4lconvert.so,
207 v4l1compat.so, and
208 v4l2convert.so
209 </seg>
210 <seg>
211 /etc/rc_keymaps,
212 /lib/udev/rc_keymaps,
213 /usr/include/libdvbv5, and
214 /usr/lib/libv4l
215 </seg>
216 </seglistitem>
217 </segmentedlist>
218
219 <variablelist>
220 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
221 <?dbfo list-presentation="list"?>
222 <?dbhtml list-presentation="table"?>
223
224 <varlistentry id="cx18-ctl">
225 <term><command>cx18-ctl</command></term>
226 <listitem>
227 <para>
228 is a tool to handle cx18 based devices
229 </para>
230 <indexterm zone="v4l-utils cx18-ctl">
231 <primary sortas="b-cx18-ctl">cx18-ctl</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="decode_tm6000">
237 <term><command>decode_tm6000</command></term>
238 <listitem>
239 <para>
240 decodes multiplexed formats from TM5600/TM6000 USB devices
241 </para>
242 <indexterm zone="v4l-utils decode_tm6000">
243 <primary sortas="b-decode_tm6000">decode_tm6000</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="dvb-fe-tool">
249 <term><command>dvb-fe-tool</command></term>
250 <listitem>
251 <para>
252 is a command line tool for digital TV services
253 </para>
254 <indexterm zone="v4l-utils dvb-fe-tool">
255 <primary sortas="b-dvb-fe-tool">dvb-fe-tool</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 <varlistentry id="dvb-format-convert">
261 <term><command>dvb-format-convert</command></term>
262 <listitem>
263 <para>
264 is a tool meant to convert among different file formats. It is
265 compliant with version 5 of the DVB API
266 </para>
267 <indexterm zone="v4l-utils dvb-format-convert">
268 <primary sortas="b-dvb-format-convert">dvb-format-convert</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="dvbv5-scan">
274 <term><command>dvbv5-scan</command></term>
275 <listitem>
276 <para>
277 is a command line frequency scanning tool for digital TV
278 services that are compliant with version 5 of the DVB API
279 </para>
280 <indexterm zone="v4l-utils dvbv5-scan">
281 <primary sortas="b-dvbv5-scan">dvbv5-scan</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="dvbv5-zap">
287 <term><command>dvbv5-zap</command></term>
288 <listitem>
289 <para>
290 is a command line tuning tool for digital TV services
291 that is compliant with version 5 of the DVB API
292 </para>
293 <indexterm zone="v4l-utils dvbv5-zap">
294 <primary sortas="b-dvbv5-zap">dvbv5-zap</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="ir-keytable">
300 <term><command>ir-keytable</command></term>
301 <listitem>
302 <para>
303 is a tool that lists the Remote Controller devices, allows one
304 to get/set IR keycode/scancode tables, test events generated by
305 IR, and to adjust other Remote Controller options
306 </para>
307 <indexterm zone="v4l-utils ir-keytable">
308 <primary sortas="b-ir-keytable">ir-keytable</primary>
309 </indexterm>
310 </listitem>
311 </varlistentry>
312
313 <varlistentry id="ivtv-ctl">
314 <term><command>ivtv-ctl</command></term>
315 <listitem>
316 <para>
317 is a utility that can control many card settings, like changing
318 the inputs from tuner to svideo or composite, setting video
319 resolution or changing video mode (PAL, SECAM, NTSC)
320 </para>
321 <indexterm zone="v4l-utils ivtv-ctl">
322 <primary sortas="b-ivtv-ctl">ivtv-ctl</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="media-ctl">
328 <term><command>media-ctl</command></term>
329 <listitem>
330 <para>
331 is a utility used to configure V4L2 devices
332 </para>
333 <indexterm zone="v4l-utils media-ctl">
334 <primary sortas="b-media-ctl">media-ctl</primary>
335 </indexterm>
336 </listitem>
337 </varlistentry>
338
339 <varlistentry id="qv4l2">
340 <term><command>qv4l2</command></term>
341 <listitem>
342 <para>
343 is used to test video4linux capture devices
344 </para>
345 <indexterm zone="v4l-utils qv4l2">
346 <primary sortas="b-qv4l2">qv4l2</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="qvidcap">
352 <term><command>qvidcap</command></term>
353 <listitem>
354 <para>
355 is used to capture video from a V4L2 device
356 </para>
357 <indexterm zone="v4l-utils qvidcap">
358 <primary sortas="b-qvidcap">qvidcap</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="rds-ctl">
364 <term><command>rds-ctl</command></term>
365 <listitem>
366 <para>
367 is a utility for decoding raw RDS data from V4L2 Radio devices
368 and offers simple ways to access the received RDS information
369 </para>
370 <indexterm zone="v4l-utils rds-ctl">
371 <primary sortas="b-rds-ctl">rds-ctl</primary>
372 </indexterm>
373 </listitem>
374 </varlistentry>
375
376 <varlistentry id="v4l2-compliance">
377 <term><command>v4l2-compliance</command></term>
378 <listitem>
379 <para>
380 is a compliance test tool
381 </para>
382 <indexterm zone="v4l-utils v4l2-compliance">
383 <primary sortas="b-v4l2-compliance">v4l2-compliance</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="v4l2-ctl">
389 <term><command>v4l2-ctl</command></term>
390 <listitem>
391 <para>
392 is a tool to control v4l2 controls from the cmdline
393 </para>
394 <indexterm zone="v4l-utils v4l2-ctl">
395 <primary sortas="b-v4l2-ctl">v4l2-ctl</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="v4l2-dbg">
401 <term><command>v4l2-dbg</command></term>
402 <listitem>
403 <para>
404 is a tool to directly get and set registers of v4l2 devices
405 </para>
406 <indexterm zone="v4l-utils v4l2-dbg">
407 <primary sortas="b-v4l2-dbg">v4l2-dbg</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="v4l2gl">
413 <term><command>v4l2gl</command></term>
414 <listitem>
415 <para>
416 captures images using libv4l and stores them as PPM files
417 </para>
418 <indexterm zone="v4l-utils v4l2gl">
419 <primary sortas="b-v4l2gl">v4l2gl</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="v4l2grab">
425 <term><command>v4l2grab</command></term>
426 <listitem>
427 <para>
428 captures images using libv4l and stores them as PPM files, while
429 also allowing for additional options such as setting the amount of
430 frames captured and saving the file as a RAW file
431 </para>
432 <indexterm zone="v4l-utils v4l2grab">
433 <primary sortas="b-v4l2grab">v4l2grab</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="v4l2-sysfs-path">
439 <term><command>v4l2-sysfs-path</command></term>
440 <listitem>
441 <para>
442 checks the media devices installed on a machine and the
443 corresponding device nodes
444 </para>
445 <indexterm zone="v4l-utils v4l2-sysfs-path">
446 <primary sortas="b-v4l2-sysfs-path">v4l2-sysfs-path</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450
451 </variablelist>
452
453 </sect2>
454
455</sect1>
Note: See TracBrowser for help on using the repository browser.