source: multimedia/videoutils/vlc.xml@ 4b6e2b2

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods 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 4b6e2b2 was 4b6e2b2, checked in by Bruce Dubbs <bdubbs@…>, 15 months ago

More tags

  • 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
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 (with <ulink url="https://github.com/libsdl-org/SDL_image">SDL_image</ulink>),
169 <ulink url="https://github.com/cacalabs/libcaca">libcaca</ulink>, and
170 <ulink url="https://github.com/Intel-Media-SDK/MediaSDK">libmfx</ulink>
171 </para>
172
173 <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
174 <para role="optional">
175 <xref linkend="pulseaudio"/>,
176 <xref linkend="libsamplerate"/>,
177 <ulink url="https://github.com/videolabs/libspatialaudio">spatialaudio</ulink>, and
178 <ulink url="https://jackaudio.org/">JACK</ulink>
179 </para>
180
181 <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
182 <para role="optional">
183 <xref linkend="qt5"/> (required for the graphical user interface),
184 <ulink url="https://repo.or.cz/w/libtar.git/">libtar</ulink>,
185 <ulink url="https://libvnc.github.io/">libvncclient</ulink>,
186 <ulink url="https://www.lirc.org/">LIRC</ulink>, and
187 <ulink url="https://www.freerdp.com/">freerdp</ulink>
188 </para>
189
190 <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
191 <para role="optional">
192 <ulink url="https://sourceforge.net/projects/goom/">Goom</ulink>,
193 <ulink url="https://www.vsxu.com">libvsxu</ulink>, and
194 <ulink url="https://sourceforge.net/projects/projectm/">projectM</ulink>
195 </para>
196
197 <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
198 <para role="optional">
199 <xref linkend="avahi"/>,
200 <ulink url="https://sourceforge.net/projects/libmtp/">libmtp</ulink> and
201 <ulink url="https://sourceforge.net/projects/pupnp/">libupnp</ulink>
202 </para>
203
204 <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
205 <para role="optional">
206 <xref linkend="gnutls"/>,
207 <xref linkend="libnotify"/>,
208 <xref linkend="libxml2"/>,
209 <xref linkend="taglib"/>,
210 <xref role="runtime" linkend="xdg-utils"/> (runtime),
211 <ulink url="https://www.team-mediaportal.com/extensions/mp2-plugins/atmolight">AtmoLight</ulink>,
212 <ulink url="https://github.com/videolabs/libmicrodns">libmicrodns</ulink>,
213 <ulink url="https://developers.google.com/protocol-buffers/">protobuf</ulink>, and
214 <ulink url="https://github.com/Haivision/srt">Srt</ulink>
215 </para>
216
217 <para condition="html" role="usernotes">
218 User Notes: <ulink url="&blfs-wiki;/vlc"/>
219 </para>
220 </sect2>
221
222 <sect2 role="installation">
223 <title>Installation of VLC</title>
224
225 <para>
226 Install <application>VLC</application> by running the following commands:
227 </para>
228
229<screen><userinput>export LUAC=/usr/bin/luac5.2 &amp;&amp;
230export LUA_LIBS="$(pkg-config --libs lua52)" &amp;&amp;
231export CPPFLAGS="$(pkg-config --cflags lua52)" &amp;&amp;
232
233BUILDCC=gcc ./configure --prefix=/usr --disable-libva &amp;&amp;
234
235make</userinput></screen>
236
237 <para>
238 To test the results, issue: <command>make check</command>.
239 </para>
240
241 <para>
242 Now, as the <systemitem class="username">root</systemitem> user:
243 </para>
244
245<screen role="root"><userinput>make docdir=/usr/share/doc/vlc-&vlc-version; install</userinput></screen>
246
247 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
248 href="../../xincludes/update-icons-and-desktop.xml"/>
249
250 </sect2>
251
252 <sect2 role="commands">
253 <title>Command Explanations</title>
254
255 <para>
256 <command>export ...</command>: These commands ensure building with
257 <xref linkend="lua52"/>. Upstream does not support lua 5.4 yet.
258 </para>
259
260 <!--<para>
261 <command>sed ... modules/lua/...</command>: This command allows
262 building with the current version of <xref linkend="lua"/>.
263 </para>-->
264
265 <!--<para>
266 <command>sed ... a\#include &lt;QPainterPath&gt;/ ...</command>: These two
267 sed commands fix building with Qt-5.15.0.
268 </para>-->
269
270 <!--<para>
271 <parameter>- -disable-opencv</parameter>: This switch is required to disable
272 <application>opencv</application> which is not compatible with this
273 version of <application>vlc</application>.
274 </para>-->
275
276 <para>
277 <parameter>--disable-libva</parameter>: This switch is required to disable
278 video acceleration in VLC since it is incompatible with ffmpeg-5, and
279 upstream has no plans to port it due to complexity.
280 </para>
281
282 <para>
283 <option>--disable-vpx</option>: Use this switch to disable
284 <application>libvpx</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.