source: multimedia/libdriv/xvid.xml@ f15e274

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

  <!ENTITY xvid-download-http "http://ed.gomez.free.fr/releases/xvid-&xvid-version;/xvidcore-&xvid-version;.tar.bz2">
  <!ENTITY xvid-download-ftp  " ">
  <!ENTITY xvid-md5sum       "1487c4dd4449aedeb695807467e69054">
  <!ENTITY xvid-size          "541 KB">
  <!ENTITY xvid-buildsize     "7.2 MB">
  <!ENTITY xvid-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">xvidcore-&xvid-version;.tar</keyword>
      <keyword role="ftpdir">xvidcore</keyword>
    </keywordset>
  </sect1info>

  <title>XviD-&xvid-version;</title>

  <indexterm zone="xvid">
    <primary sortas="a-XviD">XviD</primary>
  </indexterm>

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

<!--
OpenDivX or Xvid?

OpenDivX is a free implementation of the mpeg4-codec. Alas, the
developers at ProjectMayo didn't gratefully release their actual source
in compileable versions, so the displeasure of the users majority
canalized into a new project named Xvid.

Xvid development was interrupted in Autumn 2002 due to a code-theft
the developers at Sigma design committed but it is continued now.

For worse luck, OpenDivX and Xvid are using the same header file
names (an issue that wouldn't be resolved easily) and function
namespace, so you'll have to choose which one to use.

I personally vote for Xvid, because the installation from sources
is much smoother. If you use mencoder and transcode at the same time,
you may want to choose different codecs for each.
-->

    <para><application>XviD</application> is an MPEG-4
    compliant video CODEC.</para>

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="NASM"/></para>

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../xvidcore-&xvid-version;-gcc4-1.patch &amp;&amp;
cd build/generic &amp;&amp;
./configure --prefix=/usr &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 &amp;&amp;
chmod -v 644 /usr/lib/libxvidcore.a &amp;&amp;
ln -v -sf libxvidcore.so.4.0 /usr/lib/libxvidcore.so.4 &amp;&amp;
ln -v -sf libxvidcore.so.4 /usr/lib/libxvidcore.so &amp;&amp;
install -v -m755 -d /usr/share/doc/xvidcore-&xvid-version;/examples &amp;&amp;
install -v -m644 ../../examples/* \
    /usr/share/doc/xvidcore-&xvid-version;/examples</userinput></screen>

  </sect2>

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

    <para><command>ln -v -sf libxvidcore.so.4 /usr/lib/libxvidcore.so</command>:
    This command makes applications linked against
    <filename class="libraryfile">.so</filename> names, link to
    <filename class="libraryfile">.so.<replaceable>MAJOR</replaceable></filename>.
    This ensures better binary compatibility, as
    <application>XviD</application> developers take care not changing the
    <replaceable>MAJOR</replaceable> number until there is an incompatible
    ABI change.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>libxvidcore.[so,a]</seg>
        <seg>/usr/share/doc/xvidcore-&xvid-version;</seg>
      </seglistitem>
    </segmentedlist>

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

    <varlistentry id="libxvidcore">
      <term><filename class='libraryfile'>libxvidcore.[so,a]</filename></term>
      <listitem>
        <para>provides functions to encode and decode most
        MPEG-4 video data.</para>
        <indexterm zone="xvid libxvidcore">
          <primary sortas="c-libxvidcore">libxvidcore.[so,a]</primary>
        </indexterm>
      </listitem>
    </varlistentry>

    </variablelist>

<!--
<para>Following features of MPEG-4 are supported:</para>
<para><emphasis>I, P Frame encoding</emphasis></para>
<para>I-Frames are image frames, while P-Frames are Pattern Frames.
Image Frames contain full images. P-Frames contain patterns of what changes in
the image, thusly saving a lot of space.</para>
<para><emphasis>PMVFast and EPZS with diamond a sqare pattern motion
estimation</emphasis></para>
<para>Fast Motion detection that can refer a square or diamond
shaped pattern to different directions.</para>
<para><emphasis>inter4v mode</emphasis></para>
<para>Fast interpolation ability.</para>
<para><emphasis>fullpixel and halfpixel precision</emphasis></para>
<para>Even halfpixel movements can be encoded. Better precision
results in better compression at better quality.</para>
<para><emphasis>both MPEG-4 and H263 quantizations</emphasis></para>
<para>MPEG-4 is the standard DivX was derived from. H263 is a
slightly changed subset of that standard made by Microsoft. Quantization
means to map the quantity of color values to numbers.</para>
<para><emphasis>custom quant matrices</emphasis></para>
<para>The quantization can be done using custom matrices,
possibly giving better results if the matrix is made to suit the video
data. Every normal user should be fine with the default matrix that comes
with <application>XviD</application>.</para>
<para><emphasis>Adaptive quantization / Luminance masking</emphasis></para>
<para>Qantization and Luminance masking are variant, depending
on the input material, therefore providing better results on dark or very
contrasting images.</para>
-->

  </sect2>

</sect1>