source: multimedia/videoutils/vlc.xml@ 20a4741

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 20a4741 was 20a4741, checked in by Douglas R. Reno <renodr@…>, 7 months ago

VLC: Remove an extra newline

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