source: multimedia/libdriv/v4l-utils.xml

trunk
Last change on this file was 49a84f0b, checked in by Bruce Dubbs <bdubbs@…>, 2 months ago

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