source: multimedia/videoutils/vlc.xml@ d7bee48

systemd-13485
Last change on this file since d7bee48 was d7bee48, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Sync to trunk r17332

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17335 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 15.2 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 "http://download.videolan.org/vlc/&vlc-version;/vlc-&vlc-version;.tar.xz">
8 <!ENTITY vlc-download-ftp " ">
9 <!ENTITY vlc-md5sum "ecbc65be549e5cc83e4cbe0129e66dcd">
10 <!ENTITY vlc-size "21 MB">
11 <!ENTITY vlc-buildsize "603 MB (with tests)">
12 <!ENTITY vlc-time "4.6 SBU (with 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 &lfs78_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 url="&patch-root;/vlc-&vlc-version;-ffmpeg3-1.patch"/>
83 </para>
84 </listitem>
85 </itemizedlist>
86
87 <bridgehead renderas="sect3">VLC Dependencies</bridgehead>
88
89 <bridgehead renderas="sect4">Recommended</bridgehead>
90 <para role="recommended">
91 <xref linkend="alsa-lib"/>,
92 <xref linkend="ffmpeg"/>,
93 <xref linkend="liba52"/>,
94 <xref linkend="libgcrypt"/>
95 <xref linkend="libmad"/>,
96 <xref linkend="lua"/>, and
97 <xref linkend="x-window-system"/>,
98 </para>
99
100 <bridgehead renderas="sect4">Optional features and packages</bridgehead>
101 <para role="optional">
102 <xref linkend="dbus"/>
103 </para>
104
105 <bridgehead renderas="sect4">Optional input plugins</bridgehead>
106 <para role="optional">
107
108 <xref linkend="libdv"/>,
109 <xref linkend="libdvdcss"/>,
110 <xref linkend="libdvdread"/>,
111 <xref linkend="libdvdnav"/>,
112 <xref linkend="opencv"/>,
113 <xref linkend="samba"/>,
114 <xref linkend="v4l-utils"/>,
115 <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
116 <ulink url="http://sourceforge.net/projects/libdc1394/">libdc1394</ulink>,
117 <ulink url="http://sourceforge.net/projects/libcddb/">libcddb</ulink>,
118 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
119 <ulink url="http://www.live555.com/">Live555</ulink>, and
120 <ulink url="http://www.gnu.org/software/vcdimager/">VCDImager</ulink>
121 (requires <xref linkend="libcdio"/>)
122 </para>
123
124 <bridgehead renderas="sect4">Optional mux/demux plugins</bridgehead>
125 <para role="optional">
126 <xref linkend="libogg"/>,
127 <ulink url="https://github.com/kode54/Game_Music_Emu">Game Music Emu</ulink>,
128 <ulink url="http://www.videolan.org/developers/libdvbpsi.html">libdvbpsi</ulink>,
129 <ulink url="http://downloads.xiph.org/releases/libshout/">libshout</ulink>,
130 <ulink url="http://dl.matroska.org/downloads/libmatroska/">libmatroska</ulink>
131 (requires <ulink url="http://dl.matroska.org/downloads/libebml/">libebml</ulink>),
132 <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
133 <ulink url="http://www.musepack.net/">Musepack</ulink>, and
134 <ulink url="http://sourceforge.net/projects/sidplay2/">sidplay-libs</ulink>
135 </para>
136
137 <bridgehead renderas="sect4">Optional codec plugins</bridgehead>
138 <para role="optional">
139 <xref linkend="faad2"/>,
140 <xref linkend="flac"/>,
141 <xref linkend="libass"/>,
142 <xref linkend="libmpeg2"/>,
143 <xref linkend="libpng"/>,
144 <xref linkend="libtheora"/>,
145 <xref linkend="libva"/>,
146 <xref linkend="libvorbis"/>,
147 <xref linkend="opus"/>,
148 <xref linkend="speex"/>,
149 <xref linkend="x264"/>,
150 <ulink url="http://sourceforge.net/projects/dirac/">Dirac</ulink>,
151 <ulink url="http://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
152 <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>,
153 <ulink url="http://code.google.com/p/libkate/">libkate</ulink>,
154 <!--<ulink url="http://code.google.com/p/libtiger/">libtiger</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="qt4"/> (required for the graphical user interface),
185 <xref linkend="qt5"/> (for some plugins, but currently broken with
186 Qt-5.5),
187 <ulink url="http://pkgbuild.com/~giovanni/libtar/">libtar</ulink>, and
188 <ulink url="http://www.lirc.org/">LIRC</ulink>
189 <!--<ulink url="http://www.feep.net/libtar/">libtar</ulink>-->
190 </para>
191
192 <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
193 <para role="optional">
194 <ulink url="http://sourceforge.net/projects/goom/">Goom</ulink> and
195 <ulink url="http://sourceforge.net/projects/projectm/">projectM</ulink>
196 </para>
197
198 <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
199 <para role="optional">
200 <xref linkend="avahi"/>,
201 <ulink url="http://sourceforge.net/projects/libmtp/">libmtp</ulink> and
202 <ulink url="http://sourceforge.net/projects/pupnp/">libupnp</ulink>
203 </para>
204
205 <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
206 <para role="optional">
207 <xref linkend="gnutls"/>,
208 <xref linkend="libnotify"/>,
209 <xref linkend="libxml2"/>,
210 <xref linkend="taglib"/>, and
211 <xref linkend="xdg-utils"/> (runtime)
212 </para>
213
214 <para condition="html" role="usernotes">
215 User Notes: <ulink url="&blfs-wiki;/vlc"/>
216 </para>
217 </sect2>
218
219 <sect2 role="installation">
220 <title>Installation of VLC</title>
221
222 <para>
223 If both Qt4 and Qt5 are installed, Qt5 needs to be hidden from
224 <envar>PKG_CONFIG_PATH</envar>, due to a bug. Temporarily do it by issuing:
225 </para>
226
227<screen><userinput>SAVEPATH=$PKG_CONFIG_PATH &amp;&amp;
228PKG_CONFIG_PATH="\
229`echo $PKG_CONFIG_PATH | sed 's@:/opt/qt5/lib/pkgconfig@@'`"</userinput></screen>
230
231 <para>
232 If you wish to avoid many invalid warnings, issue:
233 </para>
234<screen><userinput>sed -i '/seems to be moved/s/^/#/' autotools/ltmain.sh</userinput></screen>
235
236 <para>
237 Install <application>VLC</application> by running the following commands:
238 </para>
239
240<screen><userinput>patch -Np1 -i ../vlc-&vlc-version;-ffmpeg3-1.patch &amp;&amp;
241
242CXX="g++ -std=c++11" \
243CFLAGS="-DLUA_COMPAT_5_1" \
244OPENCV_LIBS="-L/usr/share/OpenCV" \
245./configure --prefix=/usr &amp;&amp;
246
247make</userinput></screen>
248
249 <para>
250 Again, if both Qt4 and 5 are installed, restore
251 <envar>PKG_CONFIG_PATH</envar>:
252 </para>
253
254<screen><userinput>PKG_CONFIG_PATH=$SAVEPATH &amp;&amp;
255unset SAVEPATH</userinput></screen>
256
257 <para>
258 To test the results, issue: <command>make -k check</command>. Tests must be
259 run from an active X session. One test fails for unknown reasons.
260 </para>
261
262 <para>
263 Now, as the <systemitem class="username">root</systemitem> user:
264 </para>
265
266 <note>
267 <para>
268 If the XORG_PREFIX is not /usr, make sure the LIBRARY_PATH
269 environment variable is set properly when doing the install, For example:
270 <command>sudo make LIBRARY_PATH=$XORG_PREFIX/lib ... install</command>.
271 </para>
272 </note>
273
274<screen role="root"><userinput>make docdir=/usr/share/doc/vlc-&vlc-version; install</userinput></screen>
275
276 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
277 href="../../xincludes/update-icons-and-desktop.xml"/>
278
279 </sect2>
280
281 <sect2 role="commands">
282 <title>Command Explanations</title>
283
284 <para>
285 <envar>CXX="g++ -std=c++11"</envar>: This environment variable
286 is needed for compatibility with <xref linkend="gcc"/>.
287 </para>
288
289 <para>
290 <envar>CFLAGS="-DLUA_COMPAT_5_1"</envar>: This environment variable
291 is needed for compatibility with <xref linkend="lua"/>.
292 </para>
293
294 <para>
295 <envar>OPENCV_LIBS="-L/usr/share/OpenCV"</envar> This environment variable
296 helps the linker to find <filename>libippicv.a</filename> installed by
297 <application>OpenCV</application> 3.
298 </para>
299
300 <para>
301 <option>--enable-opencv=no</option>: This switch disables
302 <application>OpenCV</application> suport.
303 </para>
304
305 <para>
306 <option>--disable-lua</option>: Use this switch if you don't have
307 <application>Lua</application> installed.
308 </para>
309
310 <para>
311 <option>--disable-mad</option>: Use this switch if you don't
312 have <application>libmad</application> installed.
313 </para>
314
315 <para>
316 <option>--disable-avcodec --disable-swscale</option>: Use these switches
317 if you don't have <application>FFmpeg</application> installed.
318 </para>
319
320 <para>
321 <option>--disable-a52</option>: Use this switch if you don't have
322 <application>liba52</application> installed.
323 </para>
324
325 <para>
326 <option>--disable-xcb</option>: Use this switch if you don't have
327 <application>X Window System</application> installed.
328 </para>
329
330 <para>
331 <option>--disable-alsa</option>: Use this switch if you don't have
332 <application>ALSA</application> installed.
333 </para>
334
335 <para>
336 <option>--disable-libgcrypt</option>: Use this switch if you don't
337 have <application>libgcrypt</application> installed.
338 </para>
339
340 <note>
341 <para>
342 There are many options to <application>VLC</application>'s
343 <command>configure</command> command. Check the
344 <command>configure --help</command> output for a complete list.
345 </para>
346 </note>
347
348 </sect2>
349
350 <sect2 role="content">
351 <title>Contents</title>
352
353 <segmentedlist>
354 <segtitle>Installed Programs</segtitle>
355 <segtitle>Installed Libraries</segtitle>
356 <segtitle>Installed Directories</segtitle>
357
358 <seglistitem>
359 <seg>
360 cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
361 </seg>
362 <seg>
363 libvlccore.so, libvlc.so and many plugins in
364 /usr/lib/vlc/plugins
365 </seg>
366 <seg>
367 /usr/{include,lib,share}/vlc and
368 /usr/share/doc/vlc-&vlc-version;
369 </seg>
370 </seglistitem>
371 </segmentedlist>
372
373 <variablelist>
374 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
375 <?dbfo list-presentation="list"?>
376 <?dbhtml list-presentation="table"?>
377
378 <varlistentry id="cvlc">
379 <term><command>cvlc</command></term>
380 <listitem>
381 <para>
382 is a script to run VLC with the dummy interface.
383 </para>
384 <indexterm zone="vlc cvlc">
385 <primary sortas="b-cvlc">cvlc</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="nvlc">
391 <term><command>nvlc</command></term>
392 <listitem>
393 <para>
394 is a script to run VLC with the ncurses interface.
395 </para>
396 <indexterm zone="vlc nvlc">
397 <primary sortas="b-nvlc">nvlc</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="qvlc">
403 <term><command>qvlc</command></term>
404 <listitem>
405 <para>
406 is a script to run <application>VLC</application> with the
407 <application>Qt</application> interface.
408 </para>
409 <indexterm zone="vlc qvlc">
410 <primary sortas="b-qvlc">qvlc</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="rvlc">
416 <term><command>rvlc</command></term>
417 <listitem>
418 <para>
419 is a script to run <application>VLC</application> with a command
420 line interface.
421 </para>
422 <indexterm zone="vlc rvlc">
423 <primary sortas="b-rvlc">rvlc</primary>
424 </indexterm>
425 </listitem>
426 </varlistentry>
427
428 <varlistentry id="svlc">
429 <term><command>svlc</command></term>
430 <listitem>
431 <para>
432 is a script to run <application>VLC</application> with the skins
433 interface.
434 </para>
435 <indexterm zone="vlc svlc">
436 <primary sortas="b-svlc">svlc</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="vlc-prog">
442 <term><command>vlc</command></term>
443 <listitem>
444 <para>
445 is the <application>VLC</application> media player.
446 </para>
447 <indexterm zone="vlc vlc-prog">
448 <primary sortas="b-vlc">vlc</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 <varlistentry id="vlc-wrapper">
454 <term><command>vlc-wrapper</command></term>
455 <listitem>
456 <para>
457 is a wrapper to drop privileges with <application>VLC</application>.
458 </para>
459 <indexterm zone="vlc vlc-wrapper">
460 <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
461 </indexterm>
462 </listitem>
463 </varlistentry>
464
465 </variablelist>
466
467 </sect2>
468
469</sect1>
Note: See TracBrowser for help on using the repository browser.