source: multimedia/videoutils/avifile.xml@ 5db3785e

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY avifile-main-version  "0.7">
  <!ENTITY avifile-download-http "http://prdownloads.sourceforge.net/avifile/avifile-&avifile-main-version;-&avifile-version;.tar.gz">
  <!ENTITY avifile-download-ftp  " ">
  <!ENTITY avifile-size          "3.4 MB">
  <!ENTITY avifile-buildsize     "48.2 MB">
  <!ENTITY avifile-time          "2.73 SBU">
  <!ENTITY codec-download        "http://prdownloads.sourceforge.net/avifile/binaries-011002.tgz">
  <!ENTITY codec-size            "4.4 MB">
  <!ENTITY codec-installsize     "13 MB">
]>

<sect1 id="avifile" xreflabel="Avifile-&avifile-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="avifile.html"?>
<title><application>Avifile</application>-&avifile-version;</title>
<indexterm zone="avifile">
<primary sortas="a-Avifile">Avifile</primary></indexterm>

<sect2>
<title>Introduction to <application>Avifile</application></title>

<para>The <application>Avifile</application> package contains an
<acronym>AVI</acronym> video file player, tools and support libraries. This is 
useful for viewing and editing <acronym>AVI</acronym> files.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): 
<ulink url="&avifile-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&avifile-download-ftp;"/></para></listitem>
<listitem><para>Download size: 
&avifile-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&avifile-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&avifile-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Required <acronym>CODEC</acronym>: 
<ulink url="&codec-download;"/></para></listitem>
<listitem><para>Download size: 
&codec-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&codec-installsize;</para></listitem>
</itemizedlist>
</sect3>

<sect3><title><application>Avifile</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="qt"/> and <xref linkend="sdl"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="pkgconfig"/>, 
<xref linkend="libjpeg"/>, 
<xref linkend="libogg"/>, 
<xref linkend="libvorbis"/>, 
<xref linkend="liba52"/>, 
<xref linkend="lame"/>, 
<xref linkend="libmad"/>, 
<xref linkend="xvid"/>, 
<ulink url="http://www.audiocoding.com/modules/mydownloads/">FAAD2</ulink>, 
<ulink url="http://www.divx.com/divx/linux/">DivX4Linux</ulink> and 
<ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Avifile</application></title>

<para>Install the required <acronym>CODEC</acronym> as the root user using 
the following commands:</para>

<screen><userinput role='root'><command>install -d -m755 /usr/lib/avifile-&avifile-main-version;/win32 &amp;&amp;
tar -zxf ../binaries-011002.tgz -C /usr/lib/avifile-&avifile-main-version;</command></userinput></screen>

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

<screen><userinput><command>./configure --prefix=/usr \
    --with-win32-path=/usr/lib/avifile-&avifile-main-version;/win32 &amp;&amp;
make &amp;&amp;
sed -i -e "s,include/avifile,&amp;-&avifile-main-version;," avifile.pc</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>sed -i -e "s,include/avifile,&amp;-&avifile-main-version;," 
avifile.pc</command>: The <application>pkgconfig</application> file is 
installed with an incorrect include directory definition. This command fixes 
the file.</para>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>avibench, avicap, avicat, avifile-config, avimake, aviplay, avirec, 
avirecompress, avitype, kv41setup and mmxnow-config</seg>
<seg>libaviplay.so, libaviplayavcodec.so, libaviplayavformat.so, 
libaviplaydha.so, libaviplayvidix and numerous <acronym>CODEC</acronym> 
plugins and video extensions.</seg>
<seg>/usr/include/avifile-&avifile-main-version;, 
/usr/lib/avifile-&avifile-main-version; and 
/usr/share/avifile-&avifile-main-version;</seg>
</seglistitem>
</segmentedlist>

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

<varlistentry id="avibench">
<term><command>avibench</command></term>
<listitem><para>performs a measurement of the <acronym>AVI</acronym> file 
support library's performance for a file.</para>
<indexterm zone="avifile avibench">
<primary sortas="b-avibench">avibench</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avicap">
<term><command>avicap</command></term>
<listitem><para>is a widget that displays acquired video from a Video For 
Windows (<acronym>VFW</acronym>) compatible device, like a webcam or a 
<acronym>TV</acronym>-tuner.</para>
<indexterm zone="avifile avicap">
<primary sortas="b-avicap">avicap</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avicat">
<term><command>avicat</command></term>
<listitem><para>takes a set of <acronym>AVI</acronym> files and combines them 
into a single file.</para>
<indexterm zone="avifile avicat">
<primary sortas="b-avicat">avicat</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avifile-config">
<term><command>avifile-config</command></term>
<listitem><para>is run by <command>configure</command> for programs wishing 
to link to the <application>Avifile</application> libraries.</para>
<indexterm zone="avifile avifile-config">
<primary sortas="b-avifile-config">avifile-config</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avimake">
<term><command>avimake</command></term>
<listitem><para>takes a set of <acronym>JPG</acronym> images and creates a 
movie.</para>
<indexterm zone="avifile avimake">
<primary sortas="b-avimake">avimake</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="aviplay">
<term><command>aviplay</command></term>
<listitem><para> manages the input formats, the <acronym>CODEC</acronym>s and 
the output formats to display <acronym>AVI</acronym> video files on your 
screen.</para>
<indexterm zone="avifile aviplay">
<primary sortas="b-aviplay">aviplay</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avirec">
<term><command>avirec</command></term>
<listitem><para>is a command-line video recording tool.</para>
<indexterm zone="avifile avirec">
<primary sortas="b-avirec">avirec</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avirecompress">
<term><command>avirecompress</command></term>
<listitem><para>is a widget that takes an input file of one 
<acronym>CODEC</acronym> type and converts it into a video file of 
another <acronym>CODEC</acronym>.</para>
<indexterm zone="avifile avirecompress">
<primary sortas="b-avirecompress">avirecompress</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="avitype">
<term><command>avitype</command></term>
<listitem><para>will read and display <acronym>AVI</acronym> file header 
information.</para>
<indexterm zone="avifile avitype">
<primary sortas="b-avitype">avitype</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="kv41setup">
<term><command>kv41setup</command></term>
<listitem><para>is a small tool which tells 
<application>video4linux</application> about the current video mode.</para>
<indexterm zone="avifile kv41setup">
<primary sortas="b-kv41setup">kv41setup</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="mmxnow-config">
<term><command>mmxnow-config</command></term>
<listitem><para>is run by <command>configure</command> for programs wishing 
to link to the mmxnow library.</para>
<indexterm zone="avifile mmxnow-config">
<primary sortas="b-mmxnow-config">mmxnow-config</primary></indexterm>
</listitem>
</varlistentry>

<varlistentry id="libaviplay">
<term><filename class='libraryfile'>libaviplay*.so</filename></term>
<listitem><para>libraries contain the functions required by the various 
<application>Avifile</application> programs for encoding, decoding and to 
interface with the various plugins and video extensions.</para>
<indexterm zone="avifile libaviplay">
<primary sortas="c-libaviplay">libaviplay*.so</primary></indexterm>
</listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>