source: multimedia/videoutils/ffmpeg.xml@ 2af644ac

<!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 ffmpeg-download-http "http://prdownloads.sourceforge.net/ffmpeg/ffmpeg-&ffmpeg-version;.tar.gz">
  <!ENTITY ffmpeg-download-ftp  " ">
  <!ENTITY ffmpeg-size          "1.3 MB">
  <!ENTITY ffmpeg-buildsize     "31 MB">
  <!ENTITY ffmpeg-time          "0.89 SBU">
]>

<sect1 id="ffmpeg" xreflabel="FFmpeg-&ffmpeg-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="ffmpeg.html"?>
<title>FFmpeg-&ffmpeg-version;</title>

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

<para><application>FFmpeg</application> is a solution to record, convert and 
stream audio and video. Due to heavy development, not all of these functions 
will work.</para>

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

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Required Patch: <ulink 
url="&patch-root;/ffmpeg-&ffmpeg-version;-gcc34-1.patch"/></para>
</listitem></itemizedlist>
</sect3>

<sect3><title><application>FFmpeg</application> dependencies</title>
<sect4><title>Optional</title>
<para><xref linkend="libvorbis"/>, <xref linkend="lame"/>, 
<xref linkend="liba52"/>, <xref linkend="imlib2"/>, 
X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>), 
<xref linkend="SDL"/>, <xref linkend="freetype2"/>, 
<ulink url="http://www.audiocoding.com/modules/mydownloads/">FAAC</ulink> and 
<ulink url="http://www.audiocoding.com/modules/mydownloads/">FAAD</ulink></para>
</sect4>
</sect3>

</sect2>

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

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

<note><para>The package maintainers recommend compiling without any
optimizations.</para></note>

<screen><userinput><command>patch -Np1 -i ../ffmpeg-&ffmpeg-version;-gcc34-1.patch &amp;&amp;
./configure --prefix=/usr --enable-shared &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

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

<para><parameter>--enable-shared</parameter>: This switch is needed to
build the <filename class="libraryfile">libavcodec</filename> and 
<filename class="libraryfile">libavformat</filename> shared 
libraries.</para>

<para><option>--enable-mp3lame</option>: Link against
<filename class="libraryfile">libmp3lame</filename>.</para>

<para><option>--enable-vorbis</option>: Link against
<filename class="libraryfile">libvorbis</filename>.</para>

<para><option>--disable-ffplay</option>: Only installs the server part.
<command>ffplay</command> requires <application>X</application> for 
building.</para>

<note><para>Linking the <application>liba52</application> library using the 
<option>--enable-a52</option> parameter to <command>configure</command> is 
known to break the build.</para></note>

</sect2>

<sect2>
<title>Configuring <application>FFmpeg</application></title>

<sect3><title>Config files</title>

<para><filename>~/.ffmpeg/ffserver-config</filename></para>

<para>You'll find a sample ffserver configuration file at
<ulink url="http://ffmpeg.sourceforge.net/sample.html"/></para>

</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>FFmpeg</application> package contains 
<command>ffmpeg</command>, <command>ffserver</command>, 
<command>ffplay</command>, 
<filename class="libraryfile">libavcodec</filename> and 
<filename class="libraryfile">libavformat</filename>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>ffmpeg</title>
<para><command>ffmpeg</command> is a command-line tool to convert video files, 
network streams and input from a TV card to several video formats.</para>
</sect3>

<sect3><title>ffserver</title>
<para><command>ffserver</command> is a streaming server for everything
that <command>ffmpeg</command> could use as input (files, streams, TV card 
input, webcam, etc.).</para></sect3>

<sect3><title>ffplay</title>
<para><command>ffplay</command> is a very simple and portable media 
player using the <filename>ffmpeg</filename> libraries and the 
<acronym>SDL</acronym> library.</para></sect3>

<sect3><title>libavcodec/libavformat</title>
<para><filename class="libraryfile">libavcodec</filename> and 
<filename class="libraryfile">libavformats</filename> are libraries for 
encoding/decoding video streams and putting them into files or network 
packets. Since they're well documented, you can easily include them in your 
software, like some other packages already do.</para></sect3>

</sect2>

</sect1>