[01062dd] | 1 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
| 2 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 3 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 4 | %general-entities;
|
---|
[560e14cf] | 5 |
|
---|
[01062dd] | 6 | <!ENTITY ffmpeg-download-http "http://prdownloads.sourceforge.net/ffmpeg/ffmpeg-&ffmpeg-version;.tar.gz">
|
---|
| 7 | <!ENTITY ffmpeg-download-ftp " ">
|
---|
[8a9da37] | 8 | <!ENTITY ffmpeg-size "1.6 MB">
|
---|
| 9 | <!ENTITY ffmpeg-buildsize "49 MB">
|
---|
| 10 | <!ENTITY ffmpeg-time "0.87 SBU">
|
---|
[01062dd] | 11 | ]>
|
---|
| 12 |
|
---|
[0b5a693] | 13 | <sect1 id="ffmpeg" xreflabel="FFmpeg-&ffmpeg-version;">
|
---|
[a0f03b0] | 14 | <sect1info>
|
---|
[5cd0959d] | 15 | <othername>$LastChangedBy$</othername>
|
---|
| 16 | <date>$Date$</date>
|
---|
[a0f03b0] | 17 | </sect1info>
|
---|
[dd3f20f0] | 18 | <?dbhtml filename="ffmpeg.html"?>
|
---|
[d374b41] | 19 | <title>FFmpeg-&ffmpeg-version;</title>
|
---|
[0b5a693] | 20 | <indexterm zone="ffmpeg">
|
---|
[65a0209] | 21 | <primary sortas="a-FFmpeg">FFmpeg</primary></indexterm>
|
---|
[49e5372] | 22 |
|
---|
[01062dd] | 23 | <sect2>
|
---|
| 24 | <title>Introduction to <application>FFmpeg</application></title>
|
---|
| 25 |
|
---|
[560e14cf] | 26 | <para><application>FFmpeg</application> is a solution to record, convert and
|
---|
[8a9da37] | 27 | stream audio and video. It is a very fast video and audio converter and it can
|
---|
| 28 | also acquire from a live audio/video source. Designed to be intuitive, the
|
---|
| 29 | command-line interface (<command>ffmpeg</command>) tries to figure out all the
|
---|
| 30 | parameters, when possible. <application>FFmpeg</application> can also convert
|
---|
| 31 | from any sample rate to any other, and resize video on the fly with a high
|
---|
| 32 | quality polyphase filter. <application>FFmpeg</application> can use a
|
---|
| 33 | video4linux compatible video source and any Open Sound System audio
|
---|
| 34 | source.</para>
|
---|
[01062dd] | 35 |
|
---|
| 36 | <sect3><title>Package information</title>
|
---|
| 37 | <itemizedlist spacing='compact'>
|
---|
[0598344] | 38 | <listitem><para>Download (HTTP):
|
---|
| 39 | <ulink url="&ffmpeg-download-http;"/></para></listitem>
|
---|
| 40 | <listitem><para>Download (FTP):
|
---|
| 41 | <ulink url="&ffmpeg-download-ftp;"/></para></listitem>
|
---|
[01062dd] | 42 | <listitem><para>Download size: &ffmpeg-size;</para></listitem>
|
---|
[0598344] | 43 | <listitem><para>Estimated disk space required:
|
---|
| 44 | &ffmpeg-buildsize;</para></listitem>
|
---|
| 45 | <listitem><para>Estimated build time:
|
---|
| 46 | &ffmpeg-time;</para></listitem></itemizedlist>
|
---|
[01062dd] | 47 | </sect3>
|
---|
| 48 |
|
---|
| 49 | <sect3><title><application>FFmpeg</application> dependencies</title>
|
---|
| 50 | <sect4><title>Optional</title>
|
---|
[8a9da37] | 51 | <para><xref linkend="libvorbis"/>,
|
---|
[5db3785e] | 52 | <xref linkend="lame"/>,
|
---|
[8a9da37] | 53 | <xref linkend="liba52"/>,
|
---|
| 54 | <xref linkend="imlib2"/>,
|
---|
[560e14cf] | 55 | X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
|
---|
[68ad918] | 56 | <xref linkend="sdl"/>,
|
---|
[8a9da37] | 57 | <xref linkend="freetype2"/>,
|
---|
[13f51afc] | 58 | <ulink url="http://www.audiocoding.com/modules/mydownloads/">FAAC</ulink>,
|
---|
| 59 | <ulink url="http://www.audiocoding.com/modules/mydownloads/">FAAD</ulink> and
|
---|
| 60 | <xref linkend="tex"/> (to build <acronym>HTML</acronym> documentation)</para>
|
---|
[560e14cf] | 61 | </sect4>
|
---|
[01062dd] | 62 | </sect3>
|
---|
| 63 |
|
---|
| 64 | </sect2>
|
---|
| 65 |
|
---|
| 66 | <sect2>
|
---|
| 67 | <title>Installation of <application>FFmpeg</application></title>
|
---|
| 68 |
|
---|
| 69 | <para>Install <application>FFmpeg</application> by running the following
|
---|
| 70 | commands:</para>
|
---|
| 71 |
|
---|
[8a9da37] | 72 | <note><para>Review the <filename>doc/optimization.txt</filename> file in the
|
---|
| 73 | source tree for information about optimizing the build.</para></note>
|
---|
[01062dd] | 74 |
|
---|
[8a9da37] | 75 | <!-- <screen><userinput><command>patch -Np1 -i ../ffmpeg-&ffmpeg-version;-gcc34-1.patch && -->
|
---|
[65a0209] | 76 | <screen><userinput><command>./configure --prefix=/usr --enable-shared \
|
---|
| 77 | --enable-pthreads --disable-ffplay &&
|
---|
[01062dd] | 78 | make &&
|
---|
[65a0209] | 79 | make -C doc {ffmpeg,ffserver,ffplay}.1</command></userinput></screen>
|
---|
| 80 |
|
---|
| 81 | <para>Now, as the root user:</para>
|
---|
| 82 |
|
---|
[13f51afc] | 83 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
| 84 |
|
---|
| 85 | <para>If you have <application>TeX</application> installed and you wish to
|
---|
| 86 | install the <acronym>HTML</acronym> documentation, run the following
|
---|
| 87 | command as an unprivileged user:</para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput><command>make -C doc</command></userinput></screen>
|
---|
| 90 |
|
---|
| 91 | <para>Now, as the root user:</para>
|
---|
| 92 |
|
---|
| 93 | <screen><userinput role='root'><command>install -v -d -m755 /usr/share/doc/ffmpeg-&ffmpeg-version; &&
|
---|
[65a0209] | 94 | install -v -m644 doc/*.html /usr/share/doc/ffmpeg-&ffmpeg-version;</command></userinput></screen>
|
---|
[01062dd] | 95 |
|
---|
| 96 | </sect2>
|
---|
| 97 |
|
---|
| 98 | <sect2>
|
---|
| 99 | <title>Command explanations</title>
|
---|
| 100 |
|
---|
[560e14cf] | 101 | <para><parameter>--enable-shared</parameter>: This switch is needed to
|
---|
| 102 | build the <filename class="libraryfile">libavcodec</filename> and
|
---|
| 103 | <filename class="libraryfile">libavformat</filename> shared
|
---|
| 104 | libraries.</para>
|
---|
[01062dd] | 105 |
|
---|
[8a9da37] | 106 | <para><parameter>--enable-pthreads</parameter>: This switch enables the
|
---|
| 107 | build to link against the Posix threads library.</para>
|
---|
[01062dd] | 108 |
|
---|
[65a0209] | 109 | <para><option>--disable-ffplay</option>: Only installs the server part.
|
---|
| 110 | <command>ffplay</command> requires <application>X</application> for
|
---|
| 111 | building. Remove this option if <application>X</application> is
|
---|
| 112 | installed.</para>
|
---|
| 113 |
|
---|
[8a9da37] | 114 | <para><option>--enable-<replaceable>[codec]</replaceable></option>: Review
|
---|
| 115 | the available options and codecs using the
|
---|
| 116 | <command>./configure --help</command> command.</para>
|
---|
[01062dd] | 117 |
|
---|
[8a9da37] | 118 | <para><command>make -C doc {ffmpeg,ffserver,ffplay}.1</command>: This builds
|
---|
| 119 | the man pages which are installed by <command>make install</command>.</para>
|
---|
| 120 |
|
---|
[560e14cf] | 121 | <note><para>Linking the <application>liba52</application> library using the
|
---|
| 122 | <option>--enable-a52</option> parameter to <command>configure</command> is
|
---|
| 123 | known to break the build.</para></note>
|
---|
[01062dd] | 124 |
|
---|
| 125 | </sect2>
|
---|
| 126 |
|
---|
| 127 | <sect2>
|
---|
| 128 | <title>Configuring <application>FFmpeg</application></title>
|
---|
| 129 |
|
---|
[65a0209] | 130 | <sect3 id="ffmpeg-config"><title>Config files</title>
|
---|
[01062dd] | 131 |
|
---|
[8a9da37] | 132 | <para><filename>/etc/ffserver.conf</filename> and
|
---|
| 133 | <filename>~/.ffmpeg/ffserver-config</filename></para>
|
---|
[01062dd] | 134 |
|
---|
[0b5a693] | 135 | <indexterm zone="ffmpeg ffmpeg-config">
|
---|
[65a0209] | 136 | <primary
|
---|
| 137 | sortas="e-AA.ffmpeg-ffserver-config">~/.ffmpeg/ffserver-config</primary>
|
---|
| 138 | </indexterm>
|
---|
[0b5a693] | 139 | <indexterm zone="ffmpeg ffmpeg-config">
|
---|
[65a0209] | 140 | <primary sortas="e-etc-ffserver.conf">/etc/ffserver.conf</primary>
|
---|
| 141 | </indexterm>
|
---|
| 142 |
|
---|
[01062dd] | 143 | <para>You'll find a sample ffserver configuration file at
|
---|
[8a9da37] | 144 | <ulink url="http://ffmpeg.sourceforge.net/sample.html"/> (also
|
---|
| 145 | <filename>doc/ffserver.conf</filename> in the source tree).</para>
|
---|
[01062dd] | 146 | </sect3>
|
---|
| 147 |
|
---|
| 148 | </sect2>
|
---|
| 149 |
|
---|
| 150 | <sect2>
|
---|
| 151 | <title>Contents</title>
|
---|
| 152 |
|
---|
[65a0209] | 153 | <segmentedlist>
|
---|
| 154 | <segtitle>Installed Programs</segtitle>
|
---|
| 155 | <segtitle>Installed Libraries</segtitle>
|
---|
| 156 | <segtitle>Installed Directories</segtitle>
|
---|
| 157 | <seglistitem>
|
---|
| 158 | <seg>ffmpeg, ffserver and optionally, ffplay</seg>
|
---|
| 159 | <seg>libavcodec.so, libavformat.so and video hook modules</seg>
|
---|
| 160 | <seg>/usr/include/ffmpeg, /usr/lib/vhook and
|
---|
| 161 | /usr/share/doc/ffmpeg-&ffmpeg-version;</seg>
|
---|
| 162 | </seglistitem>
|
---|
| 163 | </segmentedlist>
|
---|
| 164 |
|
---|
| 165 | <variablelist>
|
---|
| 166 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 167 | <?dbfo list-presentation="list"?>
|
---|
| 168 |
|
---|
[0b5a693] | 169 | <varlistentry id="ffmpeg-prog">
|
---|
[65a0209] | 170 | <term><command>ffmpeg</command></term>
|
---|
| 171 | <listitem><para>is a command-line tool to convert video files, network streams
|
---|
| 172 | and input from a <acronym>TV</acronym> card to several video formats.</para>
|
---|
[0b5a693] | 173 | <indexterm zone="ffmpeg ffmpeg-prog">
|
---|
[65a0209] | 174 | <primary sortas="b-ffmpeg">ffmpeg</primary></indexterm>
|
---|
| 175 | </listitem>
|
---|
| 176 | </varlistentry>
|
---|
| 177 |
|
---|
| 178 | <varlistentry id="ffplay">
|
---|
| 179 | <term><command>ffplay</command></term>
|
---|
| 180 | <listitem><para>is a very simple and portable media player using the
|
---|
| 181 | <filename>ffmpeg</filename> libraries and the <acronym>SDL</acronym>
|
---|
| 182 | library.</para>
|
---|
[0b5a693] | 183 | <indexterm zone="ffmpeg ffplay">
|
---|
[65a0209] | 184 | <primary sortas="b-ffplay">ffplay</primary></indexterm>
|
---|
| 185 | </listitem>
|
---|
| 186 | </varlistentry>
|
---|
| 187 |
|
---|
| 188 | <varlistentry id="ffserver">
|
---|
| 189 | <term><command>ffserver</command></term>
|
---|
| 190 | <listitem><para>is a streaming server for everything that
|
---|
| 191 | <command>ffmpeg</command> could use as input (files, streams, TV card input,
|
---|
| 192 | webcam, etc.).</para>
|
---|
[0b5a693] | 193 | <indexterm zone="ffmpeg ffserver">
|
---|
[65a0209] | 194 | <primary sortas="b-ffserver">ffserver</primary></indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
| 198 | <varlistentry id="libavcodec">
|
---|
| 199 | <term><filename class='libraryfile'>libavcodec.so</filename></term>
|
---|
| 200 | <listitem><para>is a library containing the <application>FFmpeg</application>
|
---|
| 201 | codecs (both encoding and decoding).</para>
|
---|
[0b5a693] | 202 | <indexterm zone="ffmpeg libavcodec">
|
---|
[65a0209] | 203 | <primary sortas="c-libavcodec">libavcodec.so</primary></indexterm>
|
---|
| 204 | </listitem>
|
---|
| 205 | </varlistentry>
|
---|
| 206 |
|
---|
| 207 | <varlistentry id="libavformat">
|
---|
| 208 | <term><filename class='libraryfile'>libavformat.so</filename></term>
|
---|
| 209 | <listitem><para>is a library containing the file formats handling (mux and
|
---|
| 210 | demux code for several formats) used by <command>ffplay</command> as well as
|
---|
| 211 | allowing the generation of audio or video streams.</para>
|
---|
[0b5a693] | 212 | <indexterm zone="ffmpeg libavformat">
|
---|
[65a0209] | 213 | <primary sortas="c-libavformat">libavformat.so</primary></indexterm>
|
---|
| 214 | </listitem>
|
---|
| 215 | </varlistentry>
|
---|
| 216 | </variablelist>
|
---|
[01062dd] | 217 |
|
---|
| 218 | </sect2>
|
---|
[49e5372] | 219 |
|
---|
| 220 | </sect1>
|
---|
| 221 |
|
---|