source: multimedia/videoutils/vlc.xml@ 1b533771

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 1b533771 was 1b533771, checked in by Bruce Dubbs <bdubbs@…>, 17 months ago

Update to vlc-3.0.18.

  • Property mode set to 100644
File size: 15.7 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 "f3c031357c0eeffb41e928eca220a803">
10 <!ENTITY vlc-size "25 MB">
11 <!ENTITY vlc-buildsize "700 MB">
12 <!ENTITY vlc-time "1.7 SBU (using parallelism=4)">
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 &lfs112_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"/>,
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="libvpx"/>,
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="https://sourceforge.net/projects/dirac/">Dirac</ulink>,
149 <ulink url="https://github.com/divideconcept/FluidLite">FluidLite</ulink>,
150 <ulink url="https://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="https://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="https://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="https://sourceforge.net/projects/goom/">Goom</ulink>,
196 <ulink url="https://www.vsxu.com">libvsxu</ulink>, and
197 <ulink url="https://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="https://sourceforge.net/projects/libmtp/">libmtp</ulink> and
204 <ulink url="https://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://github.com/Haivision/srt">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>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 --disable-libva &amp;&amp;
237
238make</userinput></screen>
239
240 <para>
241 To test the results, issue: <command>make check</command>.
242 </para>
243
244 <para>
245 Now, as the <systemitem class="username">root</systemitem> user:
246 </para>
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>export ...</command>: These commands ensure building with
260 <xref linkend="lua52"/>. Upstream does not support lua 5.4 yet.
261 </para>
262
263 <!--<para>
264 <command>sed ... modules/lua/...</command>: This command allows
265 building with the current version of <xref linkend="lua"/>.
266 </para>-->
267
268 <!--<para>
269 <command>sed ... a\#include &lt;QPainterPath&gt;/ ...</command>: These two
270 sed commands fix building with Qt-5.15.0.
271 </para>-->
272
273 <!--<para>
274 <parameter>- -disable-opencv</parameter>: This switch is required to disable
275 <application>opencv</application> which is not compatible with this
276 version of <application>vlc</application>.
277 </para>-->
278
279 <para>
280 <parameter>--disable-libva</parameter>: This switch is required to disable
281 video acceleration in VLC since it is incompatible with ffmpeg-5, and
282 upstream has no plans to port it due to complexity.
283 </para>
284
285 <para>
286 <option>--disable-vpx</option>: Use this switch to disable
287 <application>libvpx</application>.
288 </para>
289
290 <!--<para>
291 <option>- -disable-lua</option>: Use this switch if you don't have
292 <application>Lua</application> installed.
293 </para>-->
294
295 <para>
296 <option>--disable-mad</option>: Use this switch if you don't
297 have <application>libmad</application> installed.
298 </para>
299
300 <para>
301 <option>--disable-avcodec --disable-swscale</option>: Use these switches
302 if you don't have <application>FFmpeg</application> installed.
303 </para>
304
305 <para>
306 <option>--disable-a52</option>: Use this switch if you don't have
307 <application>liba52</application> installed.
308 </para>
309
310 <para>
311 <option>--disable-xcb</option>: Use this switch if you don't have
312 <application>X Window System</application> installed.
313 </para>
314
315 <para>
316 <option>--disable-alsa</option>: Use this switch if you don't have
317 <application>ALSA</application> installed.
318 </para>
319
320 <para>
321 <option>--disable-libgcrypt</option>: Use this switch if you don't
322 have <application>libgcrypt</application> installed.
323 </para>
324
325 <para>
326 <option>--disable-sftp</option>: The default is to build the sftp
327 module if <xref linkend="libssh2"/> is installed. Use this switch
328 if you do not want to build this module.
329 </para>
330
331 <note>
332 <para>
333 There are many options to <application>VLC</application>'s
334 <command>configure</command> command. Check the
335 <command>configure --help</command> output for a complete list.
336 </para>
337 </note>
338
339 </sect2>
340
341 <sect2 role="content">
342 <title>Contents</title>
343
344 <segmentedlist>
345 <segtitle>Installed Programs</segtitle>
346 <segtitle>Installed Libraries</segtitle>
347 <segtitle>Installed Directories</segtitle>
348
349 <seglistitem>
350 <seg>
351 cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
352 </seg>
353 <seg>
354 libvlccore.so, libvlc.so, and many plugins in
355 /usr/lib/vlc/plugins
356 </seg>
357 <seg>
358 /usr/{include,lib,share}/vlc,
359 /usr/share/kde4, and
360 /usr/share/doc/vlc-&vlc-version;
361 </seg>
362 </seglistitem>
363 </segmentedlist>
364
365 <variablelist>
366 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
367 <?dbfo list-presentation="list"?>
368 <?dbhtml list-presentation="table"?>
369
370 <varlistentry id="cvlc">
371 <term><command>cvlc</command></term>
372 <listitem>
373 <para>
374 is a script to run VLC with the dummy interface
375 </para>
376 <indexterm zone="vlc cvlc">
377 <primary sortas="b-cvlc">cvlc</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="nvlc">
383 <term><command>nvlc</command></term>
384 <listitem>
385 <para>
386 is a script to run VLC with the ncurses interface
387 </para>
388 <indexterm zone="vlc nvlc">
389 <primary sortas="b-nvlc">nvlc</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="qvlc">
395 <term><command>qvlc</command></term>
396 <listitem>
397 <para>
398 is a script to run <application>VLC</application> with the
399 <application>Qt</application> interface
400 </para>
401 <indexterm zone="vlc qvlc">
402 <primary sortas="b-qvlc">qvlc</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="rvlc">
408 <term><command>rvlc</command></term>
409 <listitem>
410 <para>
411 is a script to run <application>VLC</application> with a command
412 line interface
413 </para>
414 <indexterm zone="vlc rvlc">
415 <primary sortas="b-rvlc">rvlc</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="svlc">
421 <term><command>svlc</command></term>
422 <listitem>
423 <para>
424 is a script to run <application>VLC</application> with the skins
425 interface
426 </para>
427 <indexterm zone="vlc svlc">
428 <primary sortas="b-svlc">svlc</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="vlc-prog">
434 <term><command>vlc</command></term>
435 <listitem>
436 <para>
437 is the <application>VLC</application> media player
438 </para>
439 <indexterm zone="vlc vlc-prog">
440 <primary sortas="b-vlc">vlc</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="vlc-wrapper">
446 <term><command>vlc-wrapper</command></term>
447 <listitem>
448 <para>
449 is a wrapper to drop privileges with <application>VLC</application>
450 </para>
451 <indexterm zone="vlc vlc-wrapper">
452 <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
453 </indexterm>
454 </listitem>
455 </varlistentry>
456
457 </variablelist>
458
459 </sect2>
460
461</sect1>
Note: See TracBrowser for help on using the repository browser.