source: multimedia/videoutils/vlc.xml@ a12730f

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

Remove sdl dependeny from pages that also have sdl2 as a dependency

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