source: multimedia/libdriv/xine-lib.xml@ efcf979

<?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        "acfb6e08188fd60ad88ff83831d592d7">
  <!ENTITY xine-lib-size          "5.7 MB">
  <!ENTITY xine-lib-buildsize     "118 MB (without the API documentation)">
  <!ENTITY xine-lib-time          "1.5 SBU">
]>

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

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

  <title>Xine Libraries-&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 screen and
    speakers.</para>

    &lfs70_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">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="esound"/>, 
        OSS,
        <xref linkend="arts"/>,
        <xref linkend='pulseaudio'/> or
        <ulink url="http://jackaudio.org/">JACK</ulink>
    </para>

    <!-- <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="pkgconfig"/></para> -->

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="flac"/>,
      <xref linkend="libtheora"/>, 
      <xref linkend="libvorbis"/>,
      <xref linkend="sdl"/>, 
      <xref linkend="speex"/>, 
      <xref linkend="libfame"/>,
      <xref linkend="libmng"/>, 
      <xref linkend="gnome-vfs"/>,
      <xref linkend="libmad"/> 
      <xref linkend="samba3"/>, 
      <xref linkend="imagemagick"/>,
      <ulink url="http://www.directfb.org/">DirectFB</ulink>, 
      <ulink url="http://sourceforge.net/projects/dvd/">libdvdnav</ulink>, 
      <ulink url="http://sam.zoy.org/projects/libcaca/">libcaca</ulink>,
      <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
      <xref linkend="aalib"/>, 
      <xref linkend="liba52"/>, 
      libdts (now <ulink url="http://www.videolan.org/developers/libdca.html">libdca</ulink>),
      <ulink url="http://www.wavpack.com/">WavPack</ulink>, and
      <ulink url="http://dxr3.sourceforge.net/">libdxr3</ulink>
    </para>

    <para>If the following packages are not found on the system, versions
    of their libraries from the internal source tree will be used:
    <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>,
    <ulink url="http://www.vcdimager.org/">VCDImager</ulink> and
    <ulink url="http://www.musepack.net/">libmpcdec</ulink>.</para>

    <para>The following are needed to build the API documentation:
    <ulink url="http://sourceforge.net/projects/sgmltools-lite/">sgmltools-lite</ulink>
    and <ulink url="http://www.xfig.org/">Transfig</ulink></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>./configure --prefix=/usr          \
            --with-external-ffmpeg \
            --docdir=/usr/share/doc/xine-lib-&xine-lib-version; &amp;&amp;

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

  </sect2>

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

    <para><option>--with-external-ffmpeg</option>:
    The internal version of <application>ffmpeg</application> fails.
    This switch forces the use of the external version.
    </para>

    <para><option>--docdir=/usr/share/xine-lib-&xine-lib-version;</option>:
    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>

    <para><option>--with-xv-path=/path/to/somewhere</option>: if
    <filename>libXv.so</filename> is not installed in
    <filename class="directory">/usr/X11R6/lib</filename> nor in
    <filename class="directory">/usr/lib</filename> you will need to tell
    the <command>configure</command> command where to find it.</para>

    <para><option>--with-external-a52dec</option>: use this option to force the
    <filename>xineplug_decode_a52.so</filename> plugin to link against the
    system installed liba52.</para>

    <para><option>--with-external-libmad</option>: use this option to force the
    <filename>xineplug_decode_mad.so</filename> plugin to link against the
    system installed libmad.</para>

    <para><option>--with-external-dvdnav</option>: use this option to force the
    <filename>xineplug_decode_dxr3_spu.so</filename>,
    <filename>xineplug_decode_spu.so</filename> and
    <filename>xineplug_inp_dvd.so</filename> plugins to link against the
    system installed libdvdnav and libdvdread</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.1</seg>
        <seg>libxine.so and numerous plugin modules and video extensions</seg>
        <seg>Output display engine fonts located in
        /usr/share/xine/libxine1/fonts</seg>
        <seg>/usr/include/xine, /usr/lib/xine, 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.1">
        <term><command>xine-list-1.1</command></term>
        <listitem>
          <para>is used to get supported filetype information from
          <application>xine-lib</application>.</para>
          <indexterm zone="xine-lib xine-list-1.1">
            <primary sortas="b-xine-list-1.1">xine-list-1.1</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>