source: multimedia/videoutils/vlc.xml@ 49a84f0b

12.1 ken/TL2024 lazarus trunk xry111/llvm18
Last change on this file since 49a84f0b was 49a84f0b, checked in by Bruce Dubbs <bdubbs@…>, 4 months ago

Tag most of multimedia (kwave remains)

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