source: multimedia/videoutils/vlc.xml@ b397566e

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY vlc-download-http "https://download.videolan.org/vlc/&vlc-version;/vlc-&vlc-version;.tar.xz">
  <!ENTITY vlc-download-ftp  " ">
  <!ENTITY vlc-md5sum        "e8337fcd2df92f3901dad091fb85f545">
  <!ENTITY vlc-size          "24 MB">
  <!ENTITY vlc-buildsize     "726 MB">
  <!ENTITY vlc-time          "1.9 SBU (using parallelism=4; with tests)">
]>

<sect1 id="vlc" xreflabel="VLC-&vlc-version;">
  <?dbhtml filename="vlc.html"?>


  <title>VLC-&vlc-version;</title>

  <indexterm zone="vlc">
    <primary sortas="a-VLC">VLC</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to VLC</title>

    <para>
      <application>VLC</application> is a media player, streamer, and encoder.
      It can play from many inputs, such as files, network streams, capture
      devices, desktops, or DVD, SVCD, VCD, and audio CD. It can use most audio
      and video codecs (MPEG 1/2/4, H264, VC-1, DivX, WMV, Vorbis, AC3, AAC,
      etc.), and it can also convert to different formats and/or send streams
      through the network.
    </para>

    &lfs120_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&vlc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&vlc-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &vlc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &vlc-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &vlc-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &vlc-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">VLC Dependencies</bridgehead>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="alsa-lib"/>,
      <xref linkend="desktop-file-utils"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="liba52"/>,
      <xref linkend="libgcrypt"/>
      <xref linkend="libmad"/>,
      <xref linkend="lua52"/>, and
      <xref linkend="x-window-system"/>
    </para>

    <bridgehead renderas="sect4">Optional features and packages</bridgehead>
    <para role="optional">
      <xref linkend="dbus"/>,
      <xref linkend="libidn"/>, and
      <xref linkend="libssh2"/>
    </para>

    <bridgehead renderas="sect4">Optional input plugins</bridgehead>
    <para role="optional">
      <xref linkend="libarchive"/>,
      <xref linkend="libcddb"/>,
      <xref linkend="libdv"/>,
      <xref linkend="libdvdcss"/>,
      <xref linkend="libdvdread"/>,
      <xref linkend="libdvdnav"/>,
      <xref linkend="opencv"/>,
      <xref linkend="samba"/>,
      <xref linkend="v4l-utils"/>,
      <ulink url="https://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
      <ulink url="https://sourceforge.net/projects/libdc1394/">libdc1394</ulink>,
      <ulink url="https://github.com/sahlberg/libnfs">libnfs</ulink>,
      <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>,
      <ulink url="https://sourceforge.net/projects/libraw1394/">libraw1394</ulink>,
      <ulink url="http://www.live555.com/">Live555</ulink>, and
      <ulink url="https://www.gnu.org/software/vcdimager/">VCDImager</ulink>
      (requires <xref linkend="libcdio"/>)
    </para>

    <bridgehead renderas="sect4">Optional mux/demux plugins</bridgehead>
    <para role="optional">
      <xref linkend="libogg"/>,
      <ulink url="https://github.com/kode54/Game_Music_Emu">Game Music Emu</ulink>,
      <ulink url="https://www.videolan.org/developers/libdvbpsi.html">libdvbpsi</ulink>,
      <ulink url="https://downloads.xiph.org/releases/libshout/">libshout</ulink>,
      <ulink url="https://dl.matroska.org/downloads/libmatroska/">libmatroska</ulink>
      (requires <ulink url="https://dl.matroska.org/downloads/libebml/">libebml</ulink>),
      <ulink url="https://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
      <ulink url="https://www.musepack.net/">Musepack</ulink>, and
      <ulink url="https://sourceforge.net/projects/sidplay2/">sidplay-libs</ulink>
    </para>

    <bridgehead renderas="sect4">Optional codec plugins</bridgehead>
    <para role="optional">
      <xref linkend="faad2"/>,
      <xref linkend="flac"/>,
      <xref linkend="libaom"/>,
      <xref linkend="libass"/>,
      <xref linkend="libmpeg2"/>,
      <xref linkend="libpng"/>,
      <xref linkend="libtheora"/>,
      <xref linkend="libva"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="opus"/>,
      <xref linkend="speex"/>,
      <xref linkend="libvpx"/>,
      <xref linkend="x264"/>,
      <!--<ulink url="https://aomedia.googlesource.com/aom/">aom</ulink>,-->
      <ulink url="https://github.com/nkoriyama/aribb24">aribb24</ulink>,
      <ulink url="https://code.videolan.org/videolan/dav1d">dav1d</ulink>,
      <ulink url="https://sourceforge.net/projects/dirac/">Dirac</ulink>,
      <ulink url="https://github.com/divideconcept/FluidLite">FluidLite</ulink>,
      <ulink url="https://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
      <ulink url="https://www.videolan.org/developers/libdca.html">libdca</ulink>,
      <ulink url="https://wiki.xiph.org/index.php/OggKate">libkate</ulink>,
      <ulink url="https://www.khronos.org/openmax/">OpenMAX</ulink>,
      <ulink url="https://sourceforge.net/projects/schrodinger/">Schroedinger</ulink>,
      <ulink url="https://github.com/toots/shine">Shine</ulink>,
      <ulink url="https://sourceforge.net/p/soxr/wiki/Home/">SoX</ulink>,
      <ulink url="https://wiki.xiph.org/Tremor">Tremor</ulink>,
      <ulink url="https://www.twolame.org/">Twolame</ulink>, and
      <ulink url="https://sourceforge.net/projects/zapping/">Zapping VBI</ulink>
    </para>

    <bridgehead renderas="sect4">Optional video plugins</bridgehead>
    <para role="optional">
      <xref linkend="aalib"/>,
      <xref linkend="fontconfig"/>,
      <xref linkend="freetype2"/>,
      <xref linkend="fribidi"/>,
      <!-- Using libplacebo is broken due to many API changes. The patch Arch
      has for this only works on a version of libplacebo from July. VLC has
      fixed this problem, but only for the upcoming VLC4.
      https://code.videolan.org/videolan/vlc/-/merge_requests/2233#top -->
      <xref linkend="libplacebo"/> (currently broken),
      <xref linkend="librsvg"/>,
      <xref linkend="libvdpau"/>,
      <xref linkend="sdl"/>,
      <ulink url="https://github.com/cacalabs/libcaca">libcaca</ulink>,
      <!--<ulink url="http://libplacebo.org/">libplacebo</ulink>, and-->
      <ulink url="https://github.com/Intel-Media-SDK/MediaSDK">libmfx</ulink>
    </para>

    <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
    <para role="optional">
      <xref linkend="pulseaudio"/>,
      <xref linkend="libsamplerate"/>,
      <ulink url="https://github.com/videolabs/libspatialaudio">spatialaudio</ulink>, and
      <ulink url="https://jackaudio.org/">JACK</ulink>
    </para>

    <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
    <para role="optional">
      &qt5-deps; (required for the graphical user interface),
      <ulink url="https://repo.or.cz/w/libtar.git/">libtar</ulink>,
      <ulink url="https://libvnc.github.io/">libvncclient</ulink>,
      <ulink url="https://www.lirc.org/">LIRC</ulink>, and
      <ulink url="https://www.freerdp.com/">freerdp</ulink>
    </para>

    <bridgehead renderas="sect4">Optional visualisations and video filter plugins</bridgehead>
    <para role="optional">
      <ulink url="https://sourceforge.net/projects/goom/">Goom</ulink>,
      <ulink url="https://www.vsxu.com">libvsxu</ulink>, and
      <ulink url="https://sourceforge.net/projects/projectm/">projectM</ulink>
    </para>

    <bridgehead renderas="sect4">Optional service discovery plugins</bridgehead>
    <para role="optional">
      <xref linkend="avahi"/>,
      <ulink url="https://sourceforge.net/projects/libmtp/">libmtp</ulink> and
      <ulink url="https://sourceforge.net/projects/pupnp/">libupnp</ulink>
    </para>

    <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
    <para role="optional">
      <xref linkend="gnutls"/>,
      <xref linkend="libnotify"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="taglib"/>,
      <xref role="runtime" linkend="xdg-utils"/> (runtime),
      <ulink url="https://www.team-mediaportal.com/extensions/mp2-plugins/atmolight">AtmoLight</ulink>,
      <ulink url="https://github.com/videolabs/libmicrodns">libmicrodns</ulink>,
      <ulink url="https://developers.google.com/protocol-buffers/">protobuf</ulink>, and
      <ulink url="https://github.com/Haivision/srt">Srt</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of VLC</title>

    <para>
      Install <application>VLC</application> by running the following commands:
    </para>
<!--
<screen><userinput>export LUAC=/usr/bin/luac5.2                          &amp;&amp;
export LUA_LIBS="$(pkg-config - -libs lua52)"          &amp;&amp;
export CPPFLAGS="$(pkg-config - -cflags lua52)"        &amp;&amp;
-->
<screen><userinput>BUILDCC=gcc ./configure --prefix=/usr --disable-libplacebo &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make docdir=/usr/share/doc/vlc-&vlc-version; install</userinput></screen>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/update-icons-and-desktop.xml"/>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>
    <!-- The export commands have been commented out
    <para>
      <command>export ...</command>: These commands ensure building with
      <xref linkend="lua52"/>.  Upstream does not support lua 5.4 yet.
    </para>-->
<!--  Using this causes problems.  Builds and works fine without this parameter.
    <para>
      <parameter>- -disable-libva</parameter>: This switch is required to disable
      video acceleration in VLC since it is incompatible with ffmpeg-5, and
      upstream has no plans to port it due to complexity.
    </para>
-->
    <para>
      <parameter>--disable-libplacebo</parameter>: This switch is required to
      disable support for using libplacebo as a rendering pipeling because VLC
      is incompatible with the latest version of libplacebo.
    </para>

    <para>
      <option>--disable-vpx</option>: Use this switch to disable
      <application>libvpx</application>.
    </para>

    <!--<para>
      <option>- -disable-lua</option>: Use this switch if you don't have
      <application>Lua</application> installed.
    </para>-->

    <para>
      <option>--disable-mad</option>: Use this switch if you don't
      have <application>libmad</application> installed.
    </para>

    <para>
      <option>--disable-avcodec --disable-swscale</option>: Use these switches
      if you don't have <application>FFmpeg</application> installed.
    </para>

    <para>
      <option>--disable-a52</option>: Use this switch if you don't have
      <application>liba52</application> installed.
    </para>

    <para>
      <option>--disable-xcb</option>: Use this switch if you don't have
      <application>X Window System</application> installed.
    </para>

    <para>
      <option>--disable-alsa</option>: Use this switch if you don't have
      <application>ALSA</application> installed.
    </para>

    <para>
      <option>--disable-libgcrypt</option>: Use this switch if you don't
      have <application>libgcrypt</application> installed.
    </para>

    <para>
      <option>--disable-sftp</option>: The default is to build the sftp
      module if <xref linkend="libssh2"/> is installed. Use this switch
      if you do not want to build this module.
    </para>

    <note>
      <para>
        There are many options to <application>VLC</application>'s
        <command>configure</command> command. Check the
        <command>configure --help</command> output for a complete list.
      </para>
    </note>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          cvlc, nvlc, qvlc, rvlc, svlc, vlc and vlc-wrapper
        </seg>
        <seg>
          libvlccore.so, libvlc.so, and many plugins in
          /usr/lib/vlc/plugins
        </seg>
        <seg>
          /usr/{include,lib,share}/vlc,
          /usr/share/kde4, and
          /usr/share/doc/vlc-&vlc-version;
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="cvlc">
        <term><command>cvlc</command></term>
        <listitem>
          <para>
            is a script to run VLC with the dummy interface
          </para>
          <indexterm zone="vlc cvlc">
            <primary sortas="b-cvlc">cvlc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nvlc">
        <term><command>nvlc</command></term>
        <listitem>
          <para>
            is a script to run VLC with the ncurses interface
          </para>
          <indexterm zone="vlc nvlc">
            <primary sortas="b-nvlc">nvlc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="qvlc">
        <term><command>qvlc</command></term>
        <listitem>
          <para>
            is a script to run <application>VLC</application> with the
            <application>Qt</application> interface
          </para>
          <indexterm zone="vlc qvlc">
            <primary sortas="b-qvlc">qvlc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="rvlc">
        <term><command>rvlc</command></term>
        <listitem>
          <para>
            is a script to run <application>VLC</application> with a command
            line interface
          </para>
          <indexterm zone="vlc rvlc">
            <primary sortas="b-rvlc">rvlc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="svlc">
        <term><command>svlc</command></term>
        <listitem>
          <para>
            is a script to run <application>VLC</application> with the skins
            interface
          </para>
          <indexterm zone="vlc svlc">
            <primary sortas="b-svlc">svlc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="vlc-prog">
        <term><command>vlc</command></term>
        <listitem>
          <para>
            is the <application>VLC</application> media player
          </para>
          <indexterm zone="vlc vlc-prog">
            <primary sortas="b-vlc">vlc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

       <varlistentry id="vlc-wrapper">
        <term><command>vlc-wrapper</command></term>
        <listitem>
          <para>
            is a wrapper to drop privileges with <application>VLC</application>
          </para>
          <indexterm zone="vlc vlc-wrapper">
            <primary sortas="b-vlc-wrapper">vlc-wrapper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>