source: multimedia/videoutils/vlc.xml@ 586ae9d

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/soup3 xry111/xf86-video-removal
Last change on this file since 586ae9d was 586ae9d, checked in by Xi Ruoyao <xry111@…>, 19 months ago

use github repo URL for external link to srt

It's not very easy to find the download link on srtalliance.com.

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