source: multimedia/videoutils/vlc.xml@ f76c8ab

11.0 ken/refactor-virt lazarus qt5new trunk
Last change on this file since f76c8ab was f76c8ab, checked in by Bruce Dubbs <bdubbs@…>, 5 months ago

Update to vlc vlc-3.0.14

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