source: multimedia/videoutils/vlc.xml@ 08de396

<?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
           "http://download.videolan.org/pub/videolan/vlc/&vlc-version;/vlc-&vlc-version;.tar.xz">
  <!ENTITY vlc-download-ftp
           "ftp://ftp.videolan.org/pub/videolan/vlc/&vlc-version;/vlc-&vlc-version;.tar.xz">
  <!ENTITY vlc-md5sum        "7ed67d22f7425011078772bfc62ac222">
  <!ENTITY vlc-size          "19 MB">
  <!ENTITY vlc-buildsize     "527 MB (additional 2 MB for the tests)">
  <!ENTITY vlc-time          "4.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <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 like files, network streams, capture device,
      desktops, or DVD, SVCD, VCD, and audio CD. It can play most audio and
      video codecs (MPEG 1/2/4, H264, VC-1, DivX, WMV, Vorbis, AC3, AAC, etc.),
      but can also convert to different formats and/or send streams through the
      network.
    </para>

    &lfs75_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="lua"/>,
      <xref linkend="libmad"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="liba52"/>,
      <xref linkend="x-window-system"/>,
      <xref linkend="alsa-lib"/>, and
      <xref linkend="libgcrypt"/>
    </para>

    <bridgehead renderas="sect4">Optional input plugins</bridgehead>
    <para role="optional">
      <ulink url="http://code.google.com/p/libproxy/">libproxy</ulink>,
      <ulink url="http://www.live555.com/">Live555</ulink>,
      <ulink url="http://sourceforge.net/projects/libdc1394/">libdc1394</ulink>,
      <xref linkend="libdv"/>,
      <xref linkend="libdvdread"/>,
      <xref linkend="libdvdnav"/>,
      <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
      <ulink url="http://sourceforge.net/projects/opencvlibrary/">OpenCV</ulink>,
      <xref linkend="samba"/>,
      <ulink url="http://linuxtv.org/downloads/v4l-utils/">Video4Linux</ulink>,
      <ulink url="http://www.gnu.org/software/vcdimager/">VCDImager</ulink>
      (requires <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>)
      and <ulink url="http://sourceforge.net/projects/libcddb/">libcddb</ulink>
    </para>

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

    <bridgehead renderas="sect4">Optional codec plugins</bridgehead>
    <para role="optional">
      <xref linkend="libva"/>,
      <ulink url="http://www.khronos.org/openmax/">OpenMAX</ulink>,
      <xref linkend="faad2"/>,
      <ulink url="http://www.twolame.org/">Twolame</ulink>,
      <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>,
      <xref linkend="flac"/>,
      <xref linkend="libmpeg2"/>,
      <xref linkend="libvorbis"/>,
      <ulink url="http://wiki.xiph.org/Tremor">Tremor</ulink>,
      <xref linkend="speex"/>,
      <xref linkend="opus"/>,
      <xref linkend="libtheora"/>,
      <ulink url="http://diracvideo.org/download/dirac-research/">Dirac</ulink>,
      <ulink url="http://diracvideo.org/download/schroedinger/">Schroedinger</ulink>,
      <xref linkend="libpng"/>,
      <xref linkend="x264"/>,
      <ulink url="http://sourceforge.net/projects/fluidsynth/">FluidSynth</ulink>,
      <ulink url="http://sourceforge.net/projects/zapping/">Zapping VBI</ulink>,
      <xref linkend="libass"/>,
      <ulink url="http://code.google.com/p/libkate/">libkate</ulink> and
      <ulink url="http://code.google.com/p/libtiger/">libtiger</ulink>
    </para>

    <bridgehead renderas="sect4">Optional video plugins</bridgehead>
    <para role="optional">
      <xref linkend="libvdpau"/>,
      <xref linkend="sdl"/>
      (with <ulink url="http://www.libsdl.org/projects/SDL_image/">SDL_image</ulink>),
      <xref linkend="freetype2"/>,
      <xref linkend="fontconfig"/>,
      <xref linkend="fribidi"/>,
      <xref linkend="librsvg"/>,
      <xref linkend="aalib"/> and
      <ulink url="http://caca.zoy.org/">libcaca</ulink>
    </para>

    <bridgehead renderas="sect4">Optional audio plugins</bridgehead>
    <para role="optional">
      <xref linkend="pulseaudio"/>,
      <ulink url="http://jackaudio.org/">JACK</ulink>, and
      <xref linkend="libsamplerate"/>
    </para>

    <bridgehead renderas="sect4">Optional interface plugins</bridgehead>
    <para role="optional">
      <xref linkend="qt4"/> (required for the graphical user interface),
      <ulink url="http://www.lirc.org/">LIRC</ulink>, and
      <!--<ulink url="http://www.feep.net/libtar/">libtar</ulink>-->
      <ulink url="http://pkgbuild.com/~giovanni/libtar/">libtar</ulink>
    </para>

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

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

    <bridgehead renderas="sect4">Miscellaneous options</bridgehead>
    <para role="optional">
      <xref linkend="gnutls"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="taglib"/>,
      <xref linkend="libnotify"/>, and
      <xref linkend="xdg-utils"/> (runtime)
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/vlc"/>
    </para>
  </sect2>

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

    <para>
      Install <application>VLC</application> by running the following commands:
    </para>

<screen><userinput>sed -i 's:libsmbclient.h:samba-4.0/&amp;:' modules/access/smb.c &amp;&amp;
./bootstrap                                                 &amp;&amp;
./configure --prefix=/usr                                   &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>

    <note>
      <para>
        If the XORG_PREFIX is not /usr, make sure the LIBRARY_PATH
        environment variable is set properly when doing the install, For example:
        <command>sudo make LIBRARY_PATH=$XORG_PREFIX/lib ... install</command>.
      </para>
    </note>

<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>

    <para>
      <command>sed -i ...</command>: This sed fixes compilation with
      <application>Samba</application> 4.
    </para>

    <para>
      <command>./bootstrap</command>: This command calls autoreconf to generate
      m4 macros and prepare Makefiles.
    </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>- -enable-shine</option>: Use this option if you wish to build the
      <application>Shine</application> plugin.
    </para>

    <para>
      <option>- -enable-tremor</option>: Use this option if you have
      <application>Tremor</application> installed and wish to build the
      <application>Tremor</application> plugin.
    </para>

    <para>
      <option>- -enable-aa</option>: Use this option if you have
      <application>AAlib</application> installed and wish to build the
      <application>AAlib</application> plugin.
    </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 several plugins in
          /usr/lib/vlc/plugins
        </seg>
        <seg>
          /usr/include/vlc,
          /usr/lib/vlc,
          /usr/share/vlc 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>