source: multimedia/videoutils/vlc.xml@ 2433413

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 2433413 was e47e528, checked in by Pierre Labastie <pieere@…>, 6 years ago

bump date and a few typos

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19577 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 14.3 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
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 vlc-download-http "https://download.videolan.org/vlc/&vlc-version;/vlc-&vlc-version;.tar.xz">
8 <!ENTITY vlc-download-ftp " ">
9 <!ENTITY vlc-md5sum "b721fddf65aaf64eeee5629aa9bf7c9e">
10 <!ENTITY vlc-size "21 MB">
11 <!ENTITY vlc-buildsize "546 MB (add 3 MB for tests)">
12 <!ENTITY vlc-time "1.6 SBU (using parallelism=4; add 0.1 SBU for tests)">
13]>
14
15<sect1 id="vlc" xreflabel="VLC-&vlc-version;">
16 <?dbhtml filename="vlc.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>VLC-&vlc-version;</title>
24
25 <indexterm zone="vlc">
26 <primary sortas="a-VLC">VLC</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to VLC</title>
31
32 <para>
33 <application>VLC</application> is a media player, streamer, and encoder.
34 It can play from many inputs, such as files, network streams, capture
35 devices, desktops, or DVD, SVCD, VCD, and audio CD. It can use most audio
36 and video codecs (MPEG 1/2/4, H264, VC-1, DivX, WMV, Vorbis, AC3, AAC,
37 etc.), and it can also convert to different formats and/or send streams
38 through the network.
39 </para>
40
41 &lfs81_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&vlc-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&vlc-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &vlc-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &vlc-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &vlc-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &vlc-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
78 <itemizedlist spacing="compact">
79 <listitem>
80 <para>
81 Required patch:
82 <ulink
83 url="&patch-root;/vlc-&vlc-version;-ffmpeg3-1.patch"/>
84 </para>
85 </listitem>
86 </itemizedlist>
87
88 <bridgehead renderas="sect3">VLC Dependencies</bridgehead>
89
90 <bridgehead renderas="sect4">Recommended</bridgehead>
91 <para role="recommended">
92 <xref linkend="alsa-lib"/>,
93 <xref linkend="ffmpeg"/>,
94 <xref linkend="liba52"/>,
95 <xref linkend="libgcrypt"/>
96 <xref linkend="libmad"/>,
97 <xref linkend="lua"/>, and
98 <xref linkend="x-window-system"/>,
99 </para>
100
101 <bridgehead renderas="sect4">Optional features and packages</bridgehead>
102 <para role="optional">
103 <xref linkend="dbus"/>
104 </para>
105
106 <bridgehead renderas="sect4">Optional input plugins</bridgehead>
107 <para role="optional">
108
109 <xref linkend="libcddb"/>,
110 <xref linkend="libdv"/>,
111 <xref linkend="libdvdcss"/>,
112 <xref linkend="libdvdread"/>,
113 <xref linkend="libdvdnav"/>,
114 <xref linkend="opencv"/>,
115 <xref linkend="samba"/>,
116 <xref linkend="v4l-utils"/>,
117 <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
118 <ulink url="http://sourceforge.net/projects/libdc1394/">libdc1394</ulink>,
119 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
120 <ulink url="http://www.live555.com/">Live555</ulink>, and
121 <ulink url="http://www.gnu.org/software/vcdimager/">VCDImager</ulink>
122 (requires <xref linkend="libcdio"/>)
123 </para>
124
125 <bridgehead renderas="sect4">Optional mux/demux plugins</bridgehead>
126 <para role="optional">
127 <xref linkend="libogg"/>,
128 <ulink url="https://github.com/kode54/Game_Music_Emu">Game Music Emu</ulink>,
129 <ulink url="http://www.videolan.org/developers/libdvbpsi.html">libdvbpsi</ulink>,
130 <ulink url="http://downloads.xiph.org/releases/libshout/">libshout</ulink>,
131 <ulink url="http://dl.matroska.org/downloads/libmatroska/">libmatroska</ulink>
132 (requires <ulink url="http://dl.matroska.org/downloads/libebml/">libebml</ulink>),
133 <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
134 <ulink url="http://www.musepack.net/">Musepack</ulink>, and
135 <ulink url="http://sourceforge.net/projects/sidplay2/">sidplay-libs</ulink>
136 </para>
137
138 <bridgehead renderas="sect4">Optional codec plugins</bridgehead>
139 <para role="optional">
140 <xref linkend="faad2"/>,
141 <xref linkend="flac"/>,
142 <xref linkend="libass"/>,
143 <xref linkend="libmpeg2"/>,
144 <xref linkend="libpng"/>,
145 <xref linkend="libtheora"/>,
146 <xref linkend="libva"/>,
147 <xref linkend="libvorbis"/>,
148 <xref linkend="opus"/>,
149 <xref linkend="speex"/>,
150 <xref linkend="x264"/>,
151 <ulink url="http://sourceforge.net/projects/dirac/">Dirac</ulink>,
152 <ulink url="http://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
153 <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>,
154 <ulink url="http://code.google.com/p/libkate/">libkate</ulink>,
155 <ulink url="http://www.khronos.org/openmax/">OpenMAX</ulink>,
156 <ulink url="http://sourceforge.net/projects/schrodinger/">Schroedinger</ulink>,
157 <ulink url="http://wiki.xiph.org/Tremor">Tremor</ulink>,
158 <ulink url="http://www.twolame.org/">Twolame</ulink>, and
159 <ulink url="http://sourceforge.net/projects/zapping/">Zapping VBI</ulink>
160 </para>
161
162 <bridgehead renderas="sect4">Optional video plugins</bridgehead>
163 <para role="optional">
164 <xref linkend="aalib"/>,
165 <xref linkend="fontconfig"/>,
166 <xref linkend="freetype2"/>,
167 <xref linkend="fribidi"/>,
168 <xref linkend="librsvg"/>,
169 <xref linkend="libvdpau"/>,
170 <xref linkend="sdl"/>
171 (with <ulink url="http://www.libsdl.org/projects/SDL_image/">SDL_image</ulink>), and
172 <ulink url="http://caca.zoy.org/">libcaca</ulink>
173 </para>
174
175 <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
176 <para role="optional">
177 <xref linkend="pulseaudio"/>,
178 <xref linkend="libsamplerate"/>, and
179 <ulink url="http://jackaudio.org/">JACK</ulink>
180 </para>
181
182 <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
183 <para role="optional">
184 <xref linkend="qt5"/> (required for the graphical user interface),
185 <ulink url="http://pkgbuild.com/~giovanni/libtar/">libtar</ulink>, and
186 <ulink url="http://www.lirc.org/">LIRC</ulink>
187 </para>
188
189 <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
190 <para role="optional">
191 <ulink url="http://sourceforge.net/projects/goom/">Goom</ulink> and
192 <ulink url="http://sourceforge.net/projects/projectm/">projectM</ulink>
193 </para>
194
195 <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
196 <para role="optional">
197 <xref linkend="avahi"/>,
198 <ulink url="http://sourceforge.net/projects/libmtp/">libmtp</ulink> and
199 <ulink url="http://sourceforge.net/projects/pupnp/">libupnp</ulink>
200 </para>
201
202 <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
203 <para role="optional">
204 <xref linkend="gnutls"/>,
205 <xref linkend="libnotify"/>,
206 <xref linkend="libxml2"/>,
207 <xref linkend="taglib"/>,
208 <xref role="runtime" linkend="xdg-utils"/> (runtime), and
209 <ulink url="http://www.ambilight4pc.com/atmolight.html">AtmoLight</ulink>
210 </para>
211
212 <para condition="html" role="usernotes">
213 User Notes: <ulink url="&blfs-wiki;/vlc"/>
214 </para>
215 </sect2>
216
217 <sect2 role="installation">
218 <title>Installation of VLC</title>
219
220 <para>
221 Install <application>VLC</application> by running the following commands:
222 </para>
223
224<screen><userinput>patch -Np1 -i ../vlc-&vlc-version;-ffmpeg3-1.patch &amp;&amp;
225sed -i 's/error-implicit-function-declaration//' configure &amp;&amp;
226
227./configure --prefix=/usr --disable-atmo &amp;&amp;
228
229make</userinput></screen>
230
231 <para>
232 To test the results, issue: <command>make -k check</command>.
233 </para>
234
235 <para>
236 Now, as the <systemitem class="username">root</systemitem> user:
237 </para>
238
239 <note>
240 <para>
241 If the XORG_PREFIX is not /usr, make sure the LIBRARY_PATH
242 environment variable is set properly for the root user when
243 doing the install, For example:
244 <command>sudo make LIBRARY_PATH=$XORG_PREFIX/lib ... install</command>.
245 </para>
246 </note>
247
248<screen role="root"><userinput>make docdir=/usr/share/doc/vlc-&vlc-version; install</userinput></screen>
249
250 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
251 href="../../xincludes/update-icons-and-desktop.xml"/>
252
253 </sect2>
254
255 <sect2 role="commands">
256 <title>Command Explanations</title>
257
258 <para>
259 <command>sed ... configure</command>: This command removes
260 a gcc option that treats a warning as an error.
261 </para>
262<!--
263 <para>
264 <envar>CFLAGS="-DLUA_COMPAT_5_1"</envar>: This environment variable
265 ensures the use of the correct variation of <xref linkend='lua'/>.
266 </para>
267-->
268 <para>
269 <parameter>--disable-atmo</parameter>: This switch disables
270 trying to build AtmoLight (homemade Philips Ambilight clone).
271 </para>
272
273 <para>
274 <option>--enable-opencv=no</option>: This switch disables
275 <application>OpenCV</application> suport.
276 </para>
277
278 <para>
279 <option>--disable-lua</option>: Use this switch if you don't have
280 <application>Lua</application> installed.
281 </para>
282
283 <para>
284 <option>--disable-mad</option>: Use this switch if you don't
285 have <application>libmad</application> installed.
286 </para>
287
288 <para>
289 <option>--disable-avcodec --disable-swscale</option>: Use these switches
290 if you don't have <application>FFmpeg</application> installed.
291 </para>
292
293 <para>
294 <option>--disable-a52</option>: Use this switch if you don't have
295 <application>liba52</application> installed.
296 </para>
297
298 <para>
299 <option>--disable-xcb</option>: Use this switch if you don't have
300 <application>X Window System</application> installed.
301 </para>
302
303 <para>
304 <option>--disable-alsa</option>: Use this switch if you don't have
305 <application>ALSA</application> installed.
306 </para>
307
308 <para>
309 <option>--disable-libgcrypt</option>: Use this switch if you don't
310 have <application>libgcrypt</application> installed.
311 </para>
312
313 <note>
314 <para>
315 There are many options to <application>VLC</application>'s
316 <command>configure</command> command. Check the
317 <command>configure --help</command> output for a complete list.
318 </para>
319 </note>
320
321 </sect2>
322
323 <sect2 role="content">
324 <title>Contents</title>
325
326 <segmentedlist>
327 <segtitle>Installed Programs</segtitle>
328 <segtitle>Installed Libraries</segtitle>
329 <segtitle>Installed Directories</segtitle>
330
331 <seglistitem>
332 <seg>
333 cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
334 </seg>
335 <seg>
336 libvlccore.so, libvlc.so, and many plugins in
337 /usr/lib/vlc/plugins
338 </seg>
339 <seg>
340 /usr/{include,lib,share}/vlc and
341 /usr/share/doc/vlc-&vlc-version;
342 </seg>
343 </seglistitem>
344 </segmentedlist>
345
346 <variablelist>
347 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
348 <?dbfo list-presentation="list"?>
349 <?dbhtml list-presentation="table"?>
350
351 <varlistentry id="cvlc">
352 <term><command>cvlc</command></term>
353 <listitem>
354 <para>
355 is a script to run VLC with the dummy interface.
356 </para>
357 <indexterm zone="vlc cvlc">
358 <primary sortas="b-cvlc">cvlc</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="nvlc">
364 <term><command>nvlc</command></term>
365 <listitem>
366 <para>
367 is a script to run VLC with the ncurses interface.
368 </para>
369 <indexterm zone="vlc nvlc">
370 <primary sortas="b-nvlc">nvlc</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="qvlc">
376 <term><command>qvlc</command></term>
377 <listitem>
378 <para>
379 is a script to run <application>VLC</application> with the
380 <application>Qt</application> interface.
381 </para>
382 <indexterm zone="vlc qvlc">
383 <primary sortas="b-qvlc">qvlc</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="rvlc">
389 <term><command>rvlc</command></term>
390 <listitem>
391 <para>
392 is a script to run <application>VLC</application> with a command
393 line interface.
394 </para>
395 <indexterm zone="vlc rvlc">
396 <primary sortas="b-rvlc">rvlc</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="svlc">
402 <term><command>svlc</command></term>
403 <listitem>
404 <para>
405 is a script to run <application>VLC</application> with the skins
406 interface.
407 </para>
408 <indexterm zone="vlc svlc">
409 <primary sortas="b-svlc">svlc</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="vlc-prog">
415 <term><command>vlc</command></term>
416 <listitem>
417 <para>
418 is the <application>VLC</application> media player.
419 </para>
420 <indexterm zone="vlc vlc-prog">
421 <primary sortas="b-vlc">vlc</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="vlc-wrapper">
427 <term><command>vlc-wrapper</command></term>
428 <listitem>
429 <para>
430 is a wrapper to drop privileges with <application>VLC</application>.
431 </para>
432 <indexterm zone="vlc vlc-wrapper">
433 <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 </variablelist>
439
440 </sect2>
441
442</sect1>
Note: See TracBrowser for help on using the repository browser.