source: multimedia/videoutils/vlc.xml@ 3eafe37

10.1 11.0 11.1 11.2 lazarus plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 3eafe37 was 3eafe37, checked in by Bruce Dubbs <bdubbs@…>, 22 months ago

A couple more tags

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

  • Property mode set to 100644
File size: 15.8 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 "452d3423bcbaf1b85faebab0c45a7ecf">
10 <!ENTITY vlc-size "25 MB">
11 <!ENTITY vlc-buildsize "918 MB (add 37 MB for tests)">
12 <!ENTITY vlc-time "2.0 SBU (using parallelism=4; add 0.4 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 &lfs101_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">VLC Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
80 <para role="recommended">
81 <xref linkend="alsa-lib"/>,
82 <xref linkend="desktop-file-utils"/>,
83 <xref linkend="ffmpeg"/>,
84 <xref linkend="liba52"/>,
85 <xref linkend="libgcrypt"/>
86 <xref linkend="libmad"/>,
87 <xref linkend="lua52"/>, and
88 <xref linkend="x-window-system"/>,
89 </para>
90
91 <bridgehead renderas="sect4">Optional features and packages</bridgehead>
92 <para role="optional">
93 <xref linkend="dbus"/>,
94 <xref linkend="libidn"/>, and
95 <xref linkend="libssh2"/>
96 </para>
97
98 <bridgehead renderas="sect4">Optional input plugins</bridgehead>
99 <para role="optional">
100 <xref linkend="libarchive"/>,
101 <xref linkend="libcddb"/>,
102 <xref linkend="libdv"/>,
103 <xref linkend="libdvdcss"/>,
104 <xref linkend="libdvdread"/>,
105 <xref linkend="libdvdnav"/>,
106 <xref linkend="opencv"/> (currently broken),
107 <xref linkend="samba"/>,
108 <xref linkend="v4l-utils"/>,
109 <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
110 <ulink url="http://sourceforge.net/projects/libdc1394/">libdc1394</ulink>,
111 <ulink url="https://github.com/sahlberg/libnfs">libnfs</ulink>,
112 <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
113 <ulink url="https://sourceforge.net/projects/libraw1394/">libraw1394</ulink>,
114 <ulink url="http://www.live555.com/">Live555</ulink>, and
115 <ulink url="https://www.gnu.org/software/vcdimager/">VCDImager</ulink>
116 (requires <xref linkend="libcdio"/>)
117 </para>
118
119 <bridgehead renderas="sect4">Optional mux/demux plugins</bridgehead>
120 <para role="optional">
121 <xref linkend="libogg"/>,
122 <ulink url="https://github.com/kode54/Game_Music_Emu">Game Music Emu</ulink>,
123 <ulink url="http://www.videolan.org/developers/libdvbpsi.html">libdvbpsi</ulink>,
124 <ulink url="http://downloads.xiph.org/releases/libshout/">libshout</ulink>,
125 <ulink url="http://dl.matroska.org/downloads/libmatroska/">libmatroska</ulink>
126 (requires <ulink url="http://dl.matroska.org/downloads/libebml/">libebml</ulink>),
127 <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
128 <ulink url="http://www.musepack.net/">Musepack</ulink>, and
129 <ulink url="http://sourceforge.net/projects/sidplay2/">sidplay-libs</ulink>
130 </para>
131
132 <bridgehead renderas="sect4">Optional codec plugins</bridgehead>
133 <para role="optional">
134 <xref linkend="faad2"/>,
135 <xref linkend="flac"/>,
136 <xref linkend="libass"/>,
137 <xref linkend="libmpeg2"/>,
138 <xref linkend="libpng"/>,
139 <xref linkend="libtheora"/>,
140 <xref linkend="libva"/>,
141 <xref linkend="libvorbis"/>,
142 <xref linkend="opus"/>,
143 <xref linkend="speex"/>,
144 <xref linkend="x264"/>,
145 <ulink url="https://aomedia.googlesource.com/aom/">aom</ulink>,
146 <ulink url="https://github.com/nkoriyama/aribb24">aribb24</ulink>,
147 <ulink url="https://code.videolan.org/videolan/dav1d">dav1d</ulink>,
148 <ulink url="http://sourceforge.net/projects/dirac/">Dirac</ulink>,
149 <ulink url="https://github.com/divideconcept/FluidLite">FluidLite</ulink>,
150 <ulink url="http://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
151 <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>,
152 <ulink url="https://wiki.xiph.org/index.php/OggKate">libkate</ulink>,
153 <ulink url="http://www.khronos.org/openmax/">OpenMAX</ulink>,
154 <ulink url="http://sourceforge.net/projects/schrodinger/">Schroedinger</ulink>,
155 <ulink url="https://github.com/toots/shine">Shine</ulink>,
156 <ulink url="https://sourceforge.net/p/soxr/wiki/Home/">SoX</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/release-1.2.html">SDL_image</ulink>),
172 <ulink url="http://caca.zoy.org/">libcaca</ulink>, and
173 <ulink url="https://github.com/Intel-Media-SDK/MediaSDK">libmfx</ulink>
174 </para>
175
176 <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
177 <para role="optional">
178 <xref linkend="pulseaudio"/>,
179 <xref linkend="libsamplerate"/>,
180 <ulink url="https://github.com/videolabs/libspatialaudio">spatialaudio</ulink>, and
181 <ulink url="http://jackaudio.org/">JACK</ulink>
182 </para>
183
184 <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
185 <para role="optional">
186 <xref linkend="qt5"/> (required for the graphical user interface),
187 <ulink url="https://repo.or.cz/w/libtar.git/">libtar</ulink>,
188 <ulink url="https://libvnc.github.io/">libvncclient</ulink>,
189 <ulink url="http://www.lirc.org/">LIRC</ulink>, and
190 <ulink url="http://www.freerdp.com/">freerdp</ulink>
191 </para>
192
193 <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
194 <para role="optional">
195 <ulink url="http://sourceforge.net/projects/goom/">Goom</ulink>,
196 <ulink url="https://www.vsxu.com">libvsxu</ulink>, and
197 <ulink url="http://sourceforge.net/projects/projectm/">projectM</ulink>
198 </para>
199
200 <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
201 <para role="optional">
202 <xref linkend="avahi"/>,
203 <ulink url="http://sourceforge.net/projects/libmtp/">libmtp</ulink> and
204 <ulink url="http://sourceforge.net/projects/pupnp/">libupnp</ulink>
205 </para>
206
207 <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
208 <para role="optional">
209 <xref linkend="gnutls"/>,
210 <xref linkend="libnotify"/>,
211 <xref linkend="libxml2"/>,
212 <xref linkend="taglib"/>,
213 <xref role="runtime" linkend="xdg-utils"/> (runtime),
214 <ulink url="https://www.team-mediaportal.com/extensions/mp2-plugins/atmolight">AtmoLight</ulink>,
215 <ulink url="https://github.com/videolabs/libmicrodns">libmicrodns</ulink>,
216 <ulink url="https://developers.google.com/protocol-buffers/">protobuf</ulink>, and
217 <ulink url="https://www.srtalliance.org/">srt</ulink>
218 </para>
219
220 <para condition="html" role="usernotes">
221 User Notes: <ulink url="&blfs-wiki;/vlc"/>
222 </para>
223 </sect2>
224
225 <sect2 role="installation">
226 <title>Installation of VLC</title>
227
228 <para>
229 Install <application>VLC</application> by running the following commands:
230 </para>
231<!--
232<screen><userinput>sed -i '/vlc_demux.h/a #define LUA_COMPAT_APIINTCASTS' modules/lua/vlc.h &amp;&amp;-->
233<screen><userinput>export LUAC=/usr/bin/luac5.2 &amp;&amp;
234export LUA_LIBS="$(pkg-config --libs lua52)" &amp;&amp;
235export CFLAGS="$(pkg-config --cflags lua52)" &amp;&amp;
236
237BUILDCC=gcc ./configure --prefix=/usr \
238 --disable-opencv \
239 --disable-vpx &amp;&amp;
240
241make</userinput></screen>
242
243 <para>
244 To test the results, issue: <command>make check</command>.
245 </para>
246
247 <para>
248 Now, as the <systemitem class="username">root</systemitem> user:
249 </para>
250
251<screen role="root"><userinput>make docdir=/usr/share/doc/vlc-&vlc-version; install</userinput></screen>
252
253 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
254 href="../../xincludes/update-icons-and-desktop.xml"/>
255
256 </sect2>
257
258 <sect2 role="commands">
259 <title>Command Explanations</title>
260
261 <para>
262 <command>export ...</command>: These commands ensure building with
263 <xref linkend="lua52"/>. Upstream does not support lua 5.4 yet.
264 </para>
265
266 <!--<para>
267 <command>sed ... modules/lua/...</command>: This command allows
268 building with the current version of <xref linkend="lua"/>.
269 </para>-->
270
271 <!--<para>
272 <command>sed ... a\#include &lt;QPainterPath&gt;/ ...</command>: These two
273 sed commands fix building with Qt-5.15.0.
274 </para>-->
275
276 <para>
277 <parameter>--disable-opencv</parameter>: This switch is required to disable
278 <application>opencv</application> which is not compatible with this
279 version of <application>vlc</application>.
280 </para>
281
282 <para>
283 <parameter>--disable-vpx</parameter>: This switch is required to disable
284 <application>libvpx</application>. The latest version is not compatible
285 with this version of <application>vlc</application>.
286 </para>
287
288 <para>
289 <option>--disable-lua</option>: Use this switch if you don't have
290 <application>Lua</application> installed.
291 </para>
292
293 <para>
294 <option>--disable-mad</option>: Use this switch if you don't
295 have <application>libmad</application> installed.
296 </para>
297
298 <para>
299 <option>--disable-avcodec --disable-swscale</option>: Use these switches
300 if you don't have <application>FFmpeg</application> installed.
301 </para>
302
303 <para>
304 <option>--disable-a52</option>: Use this switch if you don't have
305 <application>liba52</application> installed.
306 </para>
307
308 <para>
309 <option>--disable-xcb</option>: Use this switch if you don't have
310 <application>X Window System</application> installed.
311 </para>
312
313 <para>
314 <option>--disable-alsa</option>: Use this switch if you don't have
315 <application>ALSA</application> installed.
316 </para>
317
318 <para>
319 <option>--disable-libgcrypt</option>: Use this switch if you don't
320 have <application>libgcrypt</application> installed.
321 </para>
322
323 <para>
324 <option>--disable-sftp</option>: The default is to build the sftp
325 module if <xref linkend="libssh2"/> is installed. Use this switch
326 if you do not want to build this module.
327 </para>
328
329 <note>
330 <para>
331 There are many options to <application>VLC</application>'s
332 <command>configure</command> command. Check the
333 <command>configure --help</command> output for a complete list.
334 </para>
335 </note>
336
337 </sect2>
338
339 <sect2 role="content">
340 <title>Contents</title>
341
342 <segmentedlist>
343 <segtitle>Installed Programs</segtitle>
344 <segtitle>Installed Libraries</segtitle>
345 <segtitle>Installed Directories</segtitle>
346
347 <seglistitem>
348 <seg>
349 cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
350 </seg>
351 <seg>
352 libvlccore.so, libvlc.so, and many plugins in
353 /usr/lib/vlc/plugins
354 </seg>
355 <seg>
356 /usr/{include,lib,share}/vlc,
357 /usr/share/kde4, and
358 /usr/share/doc/vlc-&vlc-version;
359 </seg>
360 </seglistitem>
361 </segmentedlist>
362
363 <variablelist>
364 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
365 <?dbfo list-presentation="list"?>
366 <?dbhtml list-presentation="table"?>
367
368 <varlistentry id="cvlc">
369 <term><command>cvlc</command></term>
370 <listitem>
371 <para>
372 is a script to run VLC with the dummy interface
373 </para>
374 <indexterm zone="vlc cvlc">
375 <primary sortas="b-cvlc">cvlc</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="nvlc">
381 <term><command>nvlc</command></term>
382 <listitem>
383 <para>
384 is a script to run VLC with the ncurses interface
385 </para>
386 <indexterm zone="vlc nvlc">
387 <primary sortas="b-nvlc">nvlc</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="qvlc">
393 <term><command>qvlc</command></term>
394 <listitem>
395 <para>
396 is a script to run <application>VLC</application> with the
397 <application>Qt</application> interface
398 </para>
399 <indexterm zone="vlc qvlc">
400 <primary sortas="b-qvlc">qvlc</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="rvlc">
406 <term><command>rvlc</command></term>
407 <listitem>
408 <para>
409 is a script to run <application>VLC</application> with a command
410 line interface
411 </para>
412 <indexterm zone="vlc rvlc">
413 <primary sortas="b-rvlc">rvlc</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="svlc">
419 <term><command>svlc</command></term>
420 <listitem>
421 <para>
422 is a script to run <application>VLC</application> with the skins
423 interface
424 </para>
425 <indexterm zone="vlc svlc">
426 <primary sortas="b-svlc">svlc</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="vlc-prog">
432 <term><command>vlc</command></term>
433 <listitem>
434 <para>
435 is the <application>VLC</application> media player
436 </para>
437 <indexterm zone="vlc vlc-prog">
438 <primary sortas="b-vlc">vlc</primary>
439 </indexterm>
440 </listitem>
441 </varlistentry>
442
443 <varlistentry id="vlc-wrapper">
444 <term><command>vlc-wrapper</command></term>
445 <listitem>
446 <para>
447 is a wrapper to drop privileges with <application>VLC</application>
448 </para>
449 <indexterm zone="vlc vlc-wrapper">
450 <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
451 </indexterm>
452 </listitem>
453 </varlistentry>
454
455 </variablelist>
456
457 </sect2>
458
459</sect1>
Note: See TracBrowser for help on using the repository browser.