source: multimedia/videoutils/vlc.xml@ a11c886

12.1 ken/TL2024 lazarus trunk xry111/llvm18
Last change on this file since a11c886 was ab4fdfc, checked in by Pierre Labastie <pierre.labastie@…>, 5 months ago

Change all xml decl to encoding=utf-8

  • Property mode set to 100644
File size: 15.1 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 &lfs120_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="lua"/>, 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="libaom"/>,
133 <xref linkend="libass"/>,
134 <xref linkend="libmpeg2"/>,
135 <xref linkend="libpng"/>,
136 <!--<xref linkend="libtheora"/>,-->
137 <xref linkend="libva"/>,
138 <xref linkend="libvorbis"/>,
139 <xref linkend="opus"/>,
140 <xref linkend="speex"/>,
141 <xref linkend="libvpx"/>,
142 <xref linkend="x264"/>,
143 <!--<ulink url="https://aomedia.googlesource.com/aom/">aom</ulink>,-->
144 <ulink url="https://github.com/nkoriyama/aribb24">aribb24</ulink>,
145 <ulink url="https://code.videolan.org/videolan/dav1d">dav1d</ulink>,
146 <ulink url="https://sourceforge.net/projects/dirac/">Dirac</ulink>,
147 <ulink url="https://github.com/divideconcept/FluidLite">FluidLite</ulink>,
148 <ulink url="https://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
149 <ulink url="https://www.videolan.org/developers/libdca.html">libdca</ulink>,
150 <ulink url="https://wiki.xiph.org/index.php/OggKate">libkate</ulink>,
151 <ulink url="https://www.theora.org">libthora</ulink>,
152 <ulink url="https://www.khronos.org/openmax/">OpenMAX</ulink>,
153 <ulink url="https://sourceforge.net/projects/schrodinger/">Schroedinger</ulink>,
154 <ulink url="https://github.com/toots/shine">Shine</ulink>,
155 <ulink url="https://sourceforge.net/p/soxr/wiki/Home/">SoX</ulink>,
156 <ulink url="https://wiki.xiph.org/Tremor">Tremor</ulink>,
157 <ulink url="https://www.twolame.org/">Twolame</ulink>, and
158 <ulink url="https://sourceforge.net/projects/zapping/">Zapping VBI</ulink>
159 </para>
160
161 <bridgehead renderas="sect4">Optional video plugins</bridgehead>
162 <para role="optional">
163 <xref linkend="aalib"/>,
164 <xref linkend="fontconfig"/>,
165 <xref linkend="freetype2"/>,
166 <xref linkend="fribidi"/>,
167 <!-- Using libplacebo is broken due to many API changes. The patch Arch
168 has for this only works on a version of libplacebo from July. VLC has
169 fixed this problem, but only for the upcoming VLC4.
170 https://code.videolan.org/videolan/vlc/-/merge_requests/2233#top -->
171 <xref linkend="libplacebo"/> (currently broken),
172 <xref linkend="librsvg"/>,
173 <xref linkend="libvdpau"/>,
174 <xref linkend="sdl"/>,
175 <ulink url="https://github.com/cacalabs/libcaca">libcaca</ulink>,
176 <!--<ulink url="http://libplacebo.org/">libplacebo</ulink>, and-->
177 <ulink url="https://github.com/Intel-Media-SDK/MediaSDK">libmfx</ulink>
178 </para>
179
180 <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
181 <para role="optional">
182 <xref linkend="pulseaudio"/>,
183 <xref linkend="libsamplerate"/>,
184 <ulink url="https://github.com/videolabs/libspatialaudio">spatialaudio</ulink>, and
185 <ulink url="https://jackaudio.org/">JACK</ulink>
186 </para>
187
188 <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
189 <para role="optional">
190 &qt5-deps; (required for the graphical user interface),
191 <ulink url="https://repo.or.cz/w/libtar.git/">libtar</ulink>,
192 <ulink url="https://libvnc.github.io/">libvncclient</ulink>,
193 <ulink url="https://www.lirc.org/">LIRC</ulink>, and
194 <ulink url="https://www.freerdp.com/">freerdp</ulink>
195 </para>
196
197 <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
198 <para role="optional">
199 <ulink url="https://sourceforge.net/projects/goom/">Goom</ulink>,
200 <ulink url="https://www.vsxu.com">libvsxu</ulink>, and
201 <ulink url="https://sourceforge.net/projects/projectm/">projectM</ulink>
202 </para>
203
204 <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
205 <para role="optional">
206 <xref linkend="avahi"/>,
207 <ulink url="https://sourceforge.net/projects/libmtp/">libmtp</ulink> and
208 <ulink url="https://sourceforge.net/projects/pupnp/">libupnp</ulink>
209 </para>
210
211 <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
212 <para role="optional">
213 <xref linkend="gnutls"/>,
214 <xref linkend="libnotify"/>,
215 <xref linkend="libxml2"/>,
216 <xref linkend="taglib"/>,
217 <xref role="runtime" linkend="xdg-utils"/> (runtime),
218 <ulink url="https://www.team-mediaportal.com/extensions/mp2-plugins/atmolight">AtmoLight</ulink>,
219 <ulink url="https://github.com/videolabs/libmicrodns">libmicrodns</ulink>,
220 <ulink url="https://developers.google.com/protocol-buffers/">protobuf</ulink>, and
221 <ulink url="https://github.com/Haivision/srt">Srt</ulink>
222 </para>
223
224 </sect2>
225
226 <sect2 role="installation">
227 <title>Installation of VLC</title>
228
229 <para>
230 Install <application>VLC</application> by running the following commands:
231 </para>
232
233<screen><userinput>BUILDCC=gcc ./configure --prefix=/usr --disable-libplacebo &amp;&amp;
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 <parameter>--disable-libplacebo</parameter>: This switch is required to
256 disable support for using libplacebo as a rendering pipeline because VLC
257 is incompatible with the latest version of libplacebo.
258 </para>
259
260 <para>
261 <option>--disable-vpx</option>: Use this switch to disable
262 <application>libvpx</application>.
263 </para>
264
265 <!--<para>
266 <option>- -disable-lua</option>: Use this switch if you don't have
267 <application>Lua</application> installed.
268 </para>-->
269
270 <para>
271 <option>--disable-mad</option>: Use this switch if you don't
272 have <application>libmad</application> installed.
273 </para>
274
275 <para>
276 <option>--disable-avcodec --disable-swscale</option>: Use these switches
277 if you don't have <application>FFmpeg</application> installed.
278 </para>
279
280 <para>
281 <option>--disable-a52</option>: Use this switch if you don't have
282 <application>liba52</application> installed.
283 </para>
284
285 <para>
286 <option>--disable-xcb</option>: Use this switch if you don't have
287 <application>X Window System</application> installed.
288 </para>
289
290 <para>
291 <option>--disable-alsa</option>: Use this switch if you don't have
292 <application>ALSA</application> installed.
293 </para>
294
295 <para>
296 <option>--disable-libgcrypt</option>: Use this switch if you don't
297 have <application>libgcrypt</application> installed.
298 </para>
299
300 <para>
301 <option>--disable-sftp</option>: The default is to build the sftp
302 module if <xref linkend="libssh2"/> is installed. Use this switch
303 if you do not want to build this module.
304 </para>
305
306 <note>
307 <para>
308 There are many options to <application>VLC</application>'s
309 <command>configure</command> command. Check the
310 <command>configure --help</command> output for a complete list.
311 </para>
312 </note>
313
314 </sect2>
315
316 <sect2 role="content">
317 <title>Contents</title>
318
319 <segmentedlist>
320 <segtitle>Installed Programs</segtitle>
321 <segtitle>Installed Libraries</segtitle>
322 <segtitle>Installed Directories</segtitle>
323
324 <seglistitem>
325 <seg>
326 cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
327 </seg>
328 <seg>
329 libvlccore.so, libvlc.so, and many plugins in
330 /usr/lib/vlc/plugins
331 </seg>
332 <seg>
333 /usr/{include,lib,share}/vlc,
334 /usr/share/kde4, and
335 /usr/share/doc/vlc-&vlc-version;
336 </seg>
337 </seglistitem>
338 </segmentedlist>
339
340 <variablelist>
341 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
342 <?dbfo list-presentation="list"?>
343 <?dbhtml list-presentation="table"?>
344
345 <varlistentry id="cvlc">
346 <term><command>cvlc</command></term>
347 <listitem>
348 <para>
349 is a script to run VLC with the dummy interface
350 </para>
351 <indexterm zone="vlc cvlc">
352 <primary sortas="b-cvlc">cvlc</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="nvlc">
358 <term><command>nvlc</command></term>
359 <listitem>
360 <para>
361 is a script to run VLC with the ncurses interface
362 </para>
363 <indexterm zone="vlc nvlc">
364 <primary sortas="b-nvlc">nvlc</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="qvlc">
370 <term><command>qvlc</command></term>
371 <listitem>
372 <para>
373 is a script to run <application>VLC</application> with the
374 <application>Qt</application> interface
375 </para>
376 <indexterm zone="vlc qvlc">
377 <primary sortas="b-qvlc">qvlc</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="rvlc">
383 <term><command>rvlc</command></term>
384 <listitem>
385 <para>
386 is a script to run <application>VLC</application> with a command
387 line interface
388 </para>
389 <indexterm zone="vlc rvlc">
390 <primary sortas="b-rvlc">rvlc</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="svlc">
396 <term><command>svlc</command></term>
397 <listitem>
398 <para>
399 is a script to run <application>VLC</application> with the skins
400 interface
401 </para>
402 <indexterm zone="vlc svlc">
403 <primary sortas="b-svlc">svlc</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="vlc-prog">
409 <term><command>vlc</command></term>
410 <listitem>
411 <para>
412 is the <application>VLC</application> media player
413 </para>
414 <indexterm zone="vlc vlc-prog">
415 <primary sortas="b-vlc">vlc</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="vlc-wrapper">
421 <term><command>vlc-wrapper</command></term>
422 <listitem>
423 <para>
424 is a wrapper to drop privileges with <application>VLC</application>
425 </para>
426 <indexterm zone="vlc vlc-wrapper">
427 <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 </variablelist>
433
434 </sect2>
435
436</sect1>
Note: See TracBrowser for help on using the repository browser.