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