source: multimedia/libdriv/xine-lib.xml@ 6de7590

<?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 xine-lib-download-http
    "&sourceforge-repo;/xine/xine-lib-&xine-lib-version;.tar.xz">
  <!ENTITY xine-lib-download-ftp
    "&gentoo-ftp-repo;/xine-lib-&xine-lib-version;.tar.xz">
  <!ENTITY xine-lib-md5sum        "011def012e9db3dee06808b4580ccede">
  <!ENTITY xine-lib-size          "4.7 MB">
  <!ENTITY xine-lib-buildsize     "126 MB (additional 120 MB to install API documentation)">
  <!ENTITY xine-lib-time          "1.7 SBU">
]>

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

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

  <title>xine-lib-&xine-lib-version;</title>

  <indexterm zone="xine-lib">
    <primary sortas="a-Xine-Libraries">Xine Libraries</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Xine Libraries</title>

    <para>
      The <application>Xine Libraries</application> package contains xine
      libraries. These are useful for interfacing with external plug-ins that
      allow the flow of information from the source to the audio and video
      hardware.
    </para>

    &lfs74_checked;

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Required patch:
          <ulink url="&patch-root;/xine-lib-&xine-lib-version;-missing_include-1.patch"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Xine Libraries Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="x-window-system"/>,
      <xref linkend="ffmpeg"/>, and at least one of:
        <xref linkend="alsa"/>,
        <xref linkend='pulseaudio'/> or
        <ulink url="http://jackaudio.org/">JACK</ulink>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="liba52"/>,
      <xref linkend="aalib"/>,
      <ulink url="http://www.directfb.org">DirectFB</ulink>,
      <xref linkend="faad2"/>,
      <xref linkend="flac"/>,
      <xref linkend="gdk-pixbuf"/>,
      <xref linkend="imagemagick"/>,
      <ulink url="http://www.videolan.org/developers/libbluray.html">libbluray</ulink>,
      <ulink url="http://sam.zoy.org/projects/libcaca/">libcaca</ulink>,
      <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>,
      <xref linkend="libdvdnav"/>,
      <ulink url="http://fame.sourceforge.net">libFAME</ulink>,
      <xref linkend="libmad"/>,
      <xref linkend="libmng"/>,
      <xref linkend="libtheora"/>,
      <xref linkend="libva"/>,
      <xref linkend="libvdpau"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="mesalib"/>,
      <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
      <ulink url="http://www.musepack.net/">musepack</ulink>,
      <xref linkend="samba"/>,
      <xref linkend="sdl"/>,
      <xref linkend="speex"/>,
      <ulink url="http://ftp.gnu.org/gnu/vcdimager/">VCDImager</ulink>,
      <ulink url="http://linuxtv.org/downloads/v4l-utils/">Video4Linux</ulink>,
      <ulink url="http://www.wavpack.com/">WavPack</ulink>, and
      <xref linkend="doxygen"/> (to create the API documentation)
    </para>

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

  <sect2 role="installation">
    <title>Installation of Xine Libraries</title>

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

<screen><userinput>patch -Np1 -i ../xine-lib-&xine-lib-version;-missing_include-1.patch &amp;&amp;

./configure --prefix=/usr     \
            --disable-vcd     \
            --disable-modplug \
            --docdir=/usr/share/doc/xine-lib-&xine-lib-version; &amp;&amp;
make</userinput></screen>

    <para>To create the API documentation, <application>Doxygen</application>
    must be installed and issue the following command:</para>

<screen><userinput>doxygen doc/Doxyfile</userinput></screen>

    <para>This package does not come with a test suite.</para>

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

<screen role="root"><userinput>make install</userinput></screen>

    <note><para>
      When installing, the Makefile does some additional
      linking.  If you do not have Xorg in /usr, the LIBRARY_PATH
      variable needs to be defined for the root user.  If
      using sudo to assume root, use the -E option to pass
      your current envronment variables for the install process.
    </para></note>

    <para>If you built the API documentation, issue the following commands as
    the <systemitem class="username">root</systemitem> user to install it:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/xine-lib-&xine-lib-version;/api &amp;&amp;
install -v -m644    doc/api/* \
                    /usr/share/doc/xine-lib-&xine-lib-version;/api</userinput></screen>
  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>--disable-vcd</parameter>: This option is required to compile
      <application>Xine Lib</application> without
      <ulink url="http://ftp.gnu.org/gnu/vcdimager/">VCDImager</ulink>
      installed. Remove this option if you have installed VCDImager.
    </para>

    <para>
      <parameter>--disable-modplug</parameter>: This option is required to compile
      <application>Xine Lib</application> without
      <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>
      installed. Remove this option if you have installed libmodplug.
    </para>

    <para>
      <parameter>--docdir=/usr/share/xine-lib-&xine-lib-version;</parameter>: This
      switch causes the documentation to be installed into a versioned
      directory instead of the default
      <filename class="directory">/usr/share/doc/xine-lib</filename>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>xine-config and xine-list-1.2</seg>
        <seg>libxine.so and numerous plugin modules and video extensions</seg>
        <seg>
          Output display engine fonts located in /usr/share/xine-lib/fonts
        </seg>
        <seg>
          /usr/include/xine,
          /usr/lib/xine,
          /usr/share/xine-lib, and
          /usr/share/doc/xine-lib-&xine-lib-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xine-config">
        <term><command>xine-config</command></term>
        <listitem>
          <para>
            provides information to programs trying to link with the
            <application>xine</application> libraries.
          </para>
          <indexterm zone="xine-lib xine-config">
            <primary sortas="b-xine-config">xine-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xine-list-1.2">
        <term><command>xine-list-1.2</command></term>
        <listitem>
          <para>
            is used to get supported filetype information from
            <application>xine-lib</application>.
          </para>
          <indexterm zone="xine-lib xine-list-1.2">
            <primary sortas="b-xine-list-1.2">xine-list-1.2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxine">
        <term><filename class='libraryfile'>libxine.so</filename></term>
        <listitem>
          <para> provides the API for processing audio/video files.</para>
          <indexterm zone="xine-lib libxine">
            <primary sortas="c-libxine">libxine.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>