source: multimedia/videoutils/vlc.xml@ 24f179da

gimp3 trunk
Last change on this file since 24f179da was 5f467e1, checked in by Douglas R. Reno <renodr@…>, 7 weeks ago

vlc: remove an extra newline before patch application

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