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

trunk
Last change on this file since 1a7ca39c was e4f4182, checked in by Tim Tassonis <stuff@…>, 5 weeks ago

Force vlc to compile against lua52

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