source: multimedia/videoutils/vlc.xml@ e4a3789e

12.1 ken/TL2024 lazarus plabs/newcss rahul/power-profiles-daemon trunk xry111/llvm18
Last change on this file since e4a3789e was b0e89bc, checked in by Bruce Dubbs <bdubbs@…>, 7 months ago

Remove commented out and obsolete info in vlc.

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