[FFmpeg-cvslog] r10255 - in trunk: Makefile doc/ffmpeg-doc.texi doc/general.texi
diego
subversion
Tue Aug 28 08:22:57 CEST 2007
Author: diego
Date: Tue Aug 28 08:22:57 2007
New Revision: 10255
Log:
Split FFmpeg documentation into general documentation and the documentation
of the ffmpeg command line program.
Added:
trunk/doc/general.texi
- copied, changed from r10214, /trunk/doc/ffmpeg-doc.texi
Modified:
trunk/Makefile
trunk/doc/ffmpeg-doc.texi
Modified: trunk/Makefile
==============================================================================
--- trunk/Makefile (original)
+++ trunk/Makefile Tue Aug 28 08:22:57 2007
@@ -124,7 +124,8 @@ vhook/%.o: vhook/%.c
$(CC) $(CFLAGS) -c -o $@ $<
documentation: $(addprefix doc/, ffmpeg-doc.html faq.html ffserver-doc.html \
- ffplay-doc.html hooks.html $(ALLMANPAGES))
+ ffplay-doc.html general.html hooks.html \
+ $(ALLMANPAGES))
doc/%.html: doc/%.texi
texi2html -monolithic -number $<
Modified: trunk/doc/ffmpeg-doc.texi
==============================================================================
--- trunk/doc/ffmpeg-doc.texi (original)
+++ trunk/doc/ffmpeg-doc.texi Tue Aug 28 08:22:57 2007
@@ -850,958 +850,4 @@ It allows almost lossless encoding.
@end itemize
-
- at chapter external libraries
-
-FFmpeg can be hooked up with a number of external libraries to add support
-for more formats. None of them are used by default, their use has to be
-explicitly requested by passing the appropriate flags to @file{./configure}.
-
- at section AMR
-
-AMR comes in two different flavors, WB and NB. FFmpeg can make use of the
-AMR WB (floating-point mode) and the AMR NB (floating-point mode) reference
-decoders and encoders.
-
-Go to @url{http://www.penguin.cz/~utx/amr} and follow the instructions for
-installing the libraries. Then pass @code{--enable-libamr-nb} and/or
- at code{--enable-libamr-wb} to configure to enable the libraries.
-
-
- at chapter Supported File Formats and Codecs
-
-You can use the @code{-formats} option to have an exhaustive list.
-
- at section File Formats
-
-FFmpeg supports the following file formats through the @code{libavformat}
-library:
-
- at multitable @columnfractions .4 .1 .1 .4
- at item Supported File Format @tab Encoding @tab Decoding @tab Comments
- at item MPEG audio @tab X @tab X
- at item MPEG-1 systems @tab X @tab X
- at tab muxed audio and video
- at item MPEG-2 PS @tab X @tab X
- at tab also known as @code{VOB} file
- at item MPEG-2 TS @tab @tab X
- at tab also known as DVB Transport Stream
- at item ASF at tab X @tab X
- at item AVI at tab X @tab X
- at item WAV at tab X @tab X
- at item Macromedia Flash at tab X @tab X
- at tab Only embedded audio is decoded.
- at item FLV @tab X @tab X
- at tab Macromedia Flash video files
- at item Real Audio and Video @tab X @tab X
- at item Raw AC3 @tab X @tab X
- at item Raw MJPEG @tab X @tab X
- at item Raw MPEG video @tab X @tab X
- at item Raw PCM8/16 bits, mulaw/Alaw at tab X @tab X
- at item Raw CRI ADX audio @tab X @tab X
- at item Raw Shorten audio @tab @tab X
- at item SUN AU format @tab X @tab X
- at item NUT @tab X @tab X @tab NUT Open Container Format
- at item QuickTime @tab X @tab X
- at item MPEG-4 @tab X @tab X
- at tab MPEG-4 is a variant of QuickTime.
- at item Raw MPEG4 video @tab X @tab X
- at item DV @tab X @tab X
- at item 4xm @tab @tab X
- at tab 4X Technologies format, used in some games.
- at item Playstation STR @tab @tab X
- at item Id RoQ @tab X @tab X
- at tab Used in Quake III, Jedi Knight 2, other computer games.
- at item Interplay MVE @tab @tab X
- at tab Format used in various Interplay computer games.
- at item WC3 Movie @tab @tab X
- at tab Multimedia format used in Origin's Wing Commander III computer game.
- at item Sega FILM/CPK @tab @tab X
- at tab Used in many Sega Saturn console games.
- at item Westwood Studios VQA/AUD @tab @tab X
- at tab Multimedia formats used in Westwood Studios games.
- at item Id Cinematic (.cin) @tab @tab X
- at tab Used in Quake II.
- at item FLIC format @tab @tab X
- at tab .fli/.flc files
- at item Sierra VMD @tab @tab X
- at tab Used in Sierra CD-ROM games.
- at item Sierra Online @tab @tab X
- at tab .sol files used in Sierra Online games.
- at item Matroska @tab @tab X
- at item Electronic Arts Multimedia @tab @tab X
- at tab Used in various EA games; files have extensions like WVE and UV2.
- at item Nullsoft Video (NSV) format @tab @tab X
- at item ADTS AAC audio @tab X @tab X
- at item Creative VOC @tab X @tab X @tab Created for the Sound Blaster Pro.
- at item American Laser Games MM @tab @tab X
- at tab Multimedia format used in games like Mad Dog McCree
- at item AVS @tab @tab X
- at tab Multimedia format used by the Creature Shock game.
- at item Smacker @tab @tab X
- at tab Multimedia format used by many games.
- at item GXF @tab X @tab X
- at tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley playout servers.
- at item CIN @tab @tab X
- at tab Multimedia format used by Delphine Software games.
- at item MXF @tab @tab X
- at tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
- at item SEQ @tab @tab X
- at tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
- at item DXA @tab @tab X
- at tab This format is used in non-Windows version of Feeble Files game and
-different game cutscenes repacked for use with ScummVM.
- at item THP @tab @tab X
- at tab Used on the Nintendo GameCube.
- at item C93 @tab @tab X
- at tab Used in the game Cyberia from Interplay.
- at item Bethsoft VID @tab @tab X
- at tab Used in some games from Bethesda Softworks.
- at item CRYO APC @tab @tab X
- at tab Audio format used in some games by CRYO Interactive Entertainment.
- at end multitable
-
- at code{X} means that encoding (resp. decoding) is supported.
-
- at section Image Formats
-
-FFmpeg can read and write images for each frame of a video sequence. The
-following image formats are supported:
-
- at multitable @columnfractions .4 .1 .1 .4
- at item Supported Image Format @tab Encoding @tab Decoding @tab Comments
- at item PGM, PPM @tab X @tab X
- at item PAM @tab X @tab X @tab PAM is a PNM extension with alpha support.
- at item PGMYUV @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
- at item JPEG @tab X @tab X @tab Progressive JPEG is not supported.
- at item .Y.U.V @tab X @tab X @tab one raw file per component
- at item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
- at item PNG @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
- at item Targa @tab @tab X @tab Targa (.TGA) image format.
- at item TIFF @tab X @tab X @tab YUV, JPEG and some extension is not supported yet.
- at item SGI @tab X @tab X @tab SGI RGB image format
- at item PTX @tab @tab X @tab V.Flash PTX format
- at end multitable
-
- at code{X} means that encoding (resp. decoding) is supported.
-
- at section Video Codecs
-
- at multitable @columnfractions .4 .1 .1 .4
- at item Supported Codec @tab Encoding @tab Decoding @tab Comments
- at item MPEG-1 video @tab X @tab X
- at item MPEG-2 video @tab X @tab X
- at item MPEG-4 @tab X @tab X
- at item MSMPEG4 V1 @tab X @tab X
- at item MSMPEG4 V2 @tab X @tab X
- at item MSMPEG4 V3 @tab X @tab X
- at item WMV7 @tab X @tab X
- at item WMV8 @tab X @tab X @tab not completely working
- at item WMV9 @tab @tab X @tab not completely working
- at item VC1 @tab @tab X
- at item H.261 @tab X @tab X
- at item H.263(+) @tab X @tab X @tab also known as RealVideo 1.0
- at item H.264 @tab @tab X
- at item RealVideo 1.0 @tab X @tab X
- at item RealVideo 2.0 @tab X @tab X
- at item MJPEG @tab X @tab X
- at item lossless MJPEG @tab X @tab X
- at item JPEG-LS @tab X @tab X @tab fourcc: MJLS, lossless and near-lossless is supported
- at item Apple MJPEG-B @tab @tab X
- at item Sunplus MJPEG @tab @tab X @tab fourcc: SP5X
- at item DV @tab X @tab X
- at item HuffYUV @tab X @tab X
- at item FFmpeg Video 1 @tab X @tab X @tab experimental lossless codec (fourcc: FFV1)
- at item FFmpeg Snow @tab X @tab X @tab experimental wavelet codec (fourcc: SNOW)
- at item Asus v1 @tab X @tab X @tab fourcc: ASV1
- at item Asus v2 @tab X @tab X @tab fourcc: ASV2
- at item Creative YUV @tab @tab X @tab fourcc: CYUV
- at item Sorenson Video 1 @tab X @tab X @tab fourcc: SVQ1
- at item Sorenson Video 3 @tab @tab X @tab fourcc: SVQ3
- at item On2 VP3 @tab @tab X @tab still experimental
- at item On2 VP5 @tab @tab X @tab fourcc: VP50
- at item On2 VP6 @tab @tab X @tab fourcc: VP60,VP61,VP62
- at item Theora @tab X @tab X @tab still experimental
- at item Intel Indeo 3 @tab @tab X
- at item FLV @tab X @tab X @tab Sorenson H.263 used in Flash
- at item Flash Screen Video @tab X @tab X @tab fourcc: FSV1
- at item ATI VCR1 @tab @tab X @tab fourcc: VCR1
- at item ATI VCR2 @tab @tab X @tab fourcc: VCR2
- at item Cirrus Logic AccuPak @tab @tab X @tab fourcc: CLJR
- at item 4X Video @tab @tab X @tab Used in certain computer games.
- at item Sony Playstation MDEC @tab @tab X
- at item Id RoQ @tab X @tab X @tab Used in Quake III, Jedi Knight 2, other computer games.
- at item Xan/WC3 @tab @tab X @tab Used in Wing Commander III .MVE files.
- at item Interplay Video @tab @tab X @tab Used in Interplay .MVE files.
- at item Apple Animation @tab X @tab X @tab fourcc: 'rle '
- at item Apple Graphics @tab @tab X @tab fourcc: 'smc '
- at item Apple Video @tab @tab X @tab fourcc: rpza
- at item Apple QuickDraw @tab @tab X @tab fourcc: qdrw
- at item Cinepak @tab @tab X
- at item Microsoft RLE @tab @tab X
- at item Microsoft Video-1 @tab @tab X
- at item Westwood VQA @tab @tab X
- at item Id Cinematic Video @tab @tab X @tab Used in Quake II.
- at item Planar RGB @tab @tab X @tab fourcc: 8BPS
- at item FLIC video @tab @tab X
- at item Duck TrueMotion v1 @tab @tab X @tab fourcc: DUCK
- at item Duck TrueMotion v2 @tab @tab X @tab fourcc: TM20
- at item VMD Video @tab @tab X @tab Used in Sierra VMD files.
- at item MSZH @tab @tab X @tab Part of LCL
- at item ZLIB @tab X @tab X @tab Part of LCL, encoder experimental
- at item TechSmith Camtasia @tab @tab X @tab fourcc: TSCC
- at item IBM Ultimotion @tab @tab X @tab fourcc: ULTI
- at item Miro VideoXL @tab @tab X @tab fourcc: VIXL
- at item QPEG @tab @tab X @tab fourccs: QPEG, Q1.0, Q1.1
- at item LOCO @tab @tab X @tab
- at item Winnov WNV1 @tab @tab X @tab
- at item Autodesk Animator Studio Codec @tab @tab X @tab fourcc: AASC
- at item Fraps FPS1 @tab @tab X @tab
- at item CamStudio @tab @tab X @tab fourcc: CSCD
- at item American Laser Games Video @tab @tab X @tab Used in games like Mad Dog McCree
- at item ZMBV @tab X @tab X @tab Encoder works only on PAL8
- at item AVS Video @tab @tab X @tab Video encoding used by the Creature Shock game.
- at item Smacker Video @tab @tab X @tab Video encoding used in Smacker.
- at item RTjpeg @tab @tab X @tab Video encoding used in NuppelVideo files.
- at item KMVC @tab @tab X @tab Codec used in Worms games.
- at item VMware Video @tab @tab X @tab Codec used in videos captured by VMware.
- at item Cin Video @tab @tab X @tab Codec used in Delphine Software games.
- at item Tiertex Seq Video @tab @tab X @tab Codec used in DOS CDROM FlashBack game.
- at item DXA Video @tab @tab X @tab Codec originally used in Feeble Files game.
- at item AVID DNxHD @tab @tab X @tab aka SMPTE VC3
- at item C93 Video @tab @tab X @tab Codec used in Cyberia game.
- at item THP @tab @tab X @tab Used on the Nintendo GameCube.
- at item Bethsoft VID @tab @tab X @tab Used in some games from Bethesda Softworks.
- at item Renderware TXD @tab @tab X @tab Texture dictionaries used by the Renderware Engine.
- at end multitable
-
- at code{X} means that encoding (resp. decoding) is supported.
-
- at section Audio Codecs
-
- at multitable @columnfractions .4 .1 .1 .1 .7
- at item Supported Codec @tab Encoding @tab Decoding @tab Comments
- at item MPEG audio layer 2 @tab IX @tab IX
- at item MPEG audio layer 1/3 @tab IX @tab IX
- at tab MP3 encoding is supported through the external library LAME.
- at item AC3 @tab IX @tab IX
- at tab liba52 is used internally for decoding.
- at item Vorbis @tab X @tab X
- at item WMA V1/V2 @tab X @tab X
- at item AAC @tab X @tab X
- at tab Supported through the external library libfaac/libfaad.
- at item Microsoft ADPCM @tab X @tab X
- at item MS IMA ADPCM @tab X @tab X
- at item QT IMA ADPCM @tab @tab X
- at item 4X IMA ADPCM @tab @tab X
- at item G.726 ADPCM @tab X @tab X
- at item Duck DK3 IMA ADPCM @tab @tab X
- at tab Used in some Sega Saturn console games.
- at item Duck DK4 IMA ADPCM @tab @tab X
- at tab Used in some Sega Saturn console games.
- at item Westwood Studios IMA ADPCM @tab @tab X
- at tab Used in Westwood Studios games like Command and Conquer.
- at item SMJPEG IMA ADPCM @tab @tab X
- at tab Used in certain Loki game ports.
- at item CD-ROM XA ADPCM @tab @tab X
- at item CRI ADX ADPCM @tab X @tab X
- at tab Used in Sega Dreamcast games.
- at item Electronic Arts ADPCM @tab @tab X
- at tab Used in various EA titles.
- at item Creative ADPCM @tab @tab X
- at tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
- at item THP ADPCM @tab @tab X
- at tab Used on the Nintendo GameCube.
- at item RA144 @tab @tab X
- at tab Real 14400 bit/s codec
- at item RA288 @tab @tab X
- at tab Real 28800 bit/s codec
- at item RADnet @tab X @tab IX
- at tab Real low bitrate AC3 codec, liba52 is used for decoding.
- at item AMR-NB @tab X @tab X
- at tab Supported through an external library.
- at item AMR-WB @tab X @tab X
- at tab Supported through an external library.
- at item DV audio @tab @tab X
- at item Id RoQ DPCM @tab X @tab X
- at tab Used in Quake III, Jedi Knight 2, other computer games.
- at item Interplay MVE DPCM @tab @tab X
- at tab Used in various Interplay computer games.
- at item Xan DPCM @tab @tab X
- at tab Used in Origin's Wing Commander IV AVI files.
- at item Sierra Online DPCM @tab @tab X
- at tab Used in Sierra Online game audio files.
- at item Apple MACE 3 @tab @tab X
- at item Apple MACE 6 @tab @tab X
- at item FLAC lossless audio @tab X @tab X
- at item Shorten lossless audio @tab @tab X
- at item Apple lossless audio @tab @tab X
- at tab QuickTime fourcc 'alac'
- at item FFmpeg Sonic @tab X @tab X
- at tab experimental lossy/lossless codec
- at item Qdesign QDM2 @tab @tab X
- at tab there are still some distortions
- at item Real COOK @tab @tab X
- at tab All versions except 5.1 are supported
- at item DSP Group TrueSpeech @tab @tab X
- at item True Audio (TTA) @tab @tab X
- at item Smacker Audio @tab @tab X
- at item WavPack Audio @tab @tab X
- at item Cin Audio @tab @tab X
- at tab Codec used in Delphine Software games.
- at item Intel Music Coder @tab @tab X
- at item Musepack @tab @tab X
- at tab Only SV7 is supported
- at item DT$ Coherent Audio @tab @tab X
- at item ATRAC 3 @tab @tab X
- at end multitable
-
- at code{X} means that encoding (resp. decoding) is supported.
-
- at code{I} means that an integer-only version is available, too (ensures high
-performance on systems without hardware floating point support).
-
- at chapter Platform Specific information
-
- at section BSD
-
-BSD make will not build FFmpeg, you need to install and use GNU Make
-(@file{gmake}).
-
- at section Windows
-
-To get help and instructions for using FFmpeg under Windows, check out
-the FFmpeg Windows Help Forum at
- at url{http://arrozcru.no-ip.org/ffmpeg/}.
-
- at subsection Native Windows compilation
-
- at itemize
- at item Install the current versions of MSYS and MinGW from
- at url{http://www.mingw.org/}. You can find detailed installation
-instructions in the download section and the FAQ.
-
-NOTE: Use at least bash 3.1. Older versions are known to be failing on the
-configure script.
-
- at item If you want to test the FFplay, also download
-the MinGW development library of SDL 1.2.x
-(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
- at url{http://www.libsdl.org}. Unpack it in a temporary directory, and
-unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
-directory. Edit the @file{sdl-config} script so that it gives the
-correct SDL directory when invoked.
-
- at item If you want to use vhooks, you must have a POSIX compliant libdl in your
-MinGW system. Get dlfcn-win32 from @url{http://code.google.com/p/dlfcn-win32}.
-
- at item Extract the current version of FFmpeg.
-
- at item Start the MSYS shell (file @file{msys.bat}).
-
- at item Change to the FFmpeg directory and follow
- the instructions of how to compile FFmpeg (file
- at file{INSTALL}). Usually, launching @file{./configure} and @file{make}
-suffices. If you have problems using SDL, verify that
- at file{sdl-config} can be launched from the MSYS command line.
-
- at item You can install FFmpeg in @file{Program Files/FFmpeg} by typing
- at file{make install}. Do not forget to copy @file{SDL.dll} to the place
-you launch @file{ffplay} from.
-
- at end itemize
-
-Notes:
- at itemize
-
- at item The target @file{make wininstaller} can be used to create a
-Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
-must be copied to the FFmpeg directory in order to build the
-installer.
-
- at item By using @code{./configure --enable-shared} when configuring FFmpeg,
-you can build @file{avcodec.dll} and @file{avformat.dll}. With
- at code{make install} you install the FFmpeg DLLs and the associated
-headers in @file{Program Files/FFmpeg}.
-
- at item Visual C++ compatibility: If you used @code{./configure --enable-shared}
-when configuring FFmpeg, FFmpeg tries to use the Microsoft Visual
-C++ @code{lib} tool to build @code{avcodec.lib} and
- at code{avformat.lib}. With these libraries you can link your Visual C++
-code directly with the FFmpeg DLLs (see below).
-
- at end itemize
-
- at subsection Visual C++ compatibility
-
-FFmpeg will not compile under Visual C++ -- and it has too many
-dependencies on the GCC compiler to make a port viable. However,
-if you want to use the FFmpeg libraries in your own applications,
-you can still compile those applications using Visual C++. An
-important restriction to this is that you have to use the
-dynamically linked versions of the FFmpeg libraries (i.e. the
-DLLs), and you have to make sure that Visual-C++-compatible
-import libraries are created during the FFmpeg build process.
-
-This description of how to use the FFmpeg libraries with Visual C++ is
-based on Visual C++ 2005 Express Edition Beta 2. If you have a different
-version, you might have to modify the procedures slightly.
-
-Here are the step-by-step instructions for building the FFmpeg libraries
-so they can be used with Visual C++:
-
- at enumerate
-
- at item Install Visual C++ (if you have not done so already).
-
- at item Install MinGW and MSYS as described above.
-
- at item Add a call to @file{vcvars32.bat} (which sets up the environment
-variables for the Visual C++ tools) as the first line of
- at file{msys.bat}. The standard location for @file{vcvars32.bat} is
- at file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
-and the standard location for @file{msys.bat} is
- at file{C:\msys\1.0\msys.bat}. If this corresponds to your setup, add the
-following line as the first line of @file{msys.bat}:
-
- at code{call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"}
-
- at item Start the MSYS shell (file @file{msys.bat}) and type @code{link.exe}.
-If you get a help message with the command line options of @code{link.exe},
-this means your environment variables are set up correctly, the
-Microsoft linker is on the path and will be used by FFmpeg to
-create Visual-C++-compatible import libraries.
-
- at item Extract the current version of FFmpeg and change to the FFmpeg directory.
-
- at item Type the command
- at code{./configure --enable-shared --disable-static --enable-memalign-hack}
-to configure and, if that did not produce any errors,
-type @code{make} to build FFmpeg.
-
- at item The subdirectories @file{libavformat}, @file{libavcodec}, and
- at file{libavutil} should now contain the files @file{avformat.dll},
- at file{avformat.lib}, @file{avcodec.dll}, @file{avcodec.lib},
- at file{avutil.dll}, and @file{avutil.lib}, respectively. Copy the three
-DLLs to your System32 directory (typically @file{C:\Windows\System32}).
-
- at end enumerate
-
-And here is how to use these libraries with Visual C++:
-
- at enumerate
-
- at item Create a new console application ("File / New / Project") and then
-select "Win32 Console Application". On the appropriate page of the
-Application Wizard, uncheck the "Precompiled headers" option.
-
- at item Write the source code for your application, or, for testing, just
-copy the code from an existing sample application into the source file
-that Visual C++ has already created for you. (Note that your source
-filehas to have a @code{.cpp} extension; otherwise, Visual C++ will not
-compile the FFmpeg headers correctly because in C mode, it does not
-recognize the @code{inline} keyword.) For example, you can copy
- at file{output_example.c} from the FFmpeg distribution (but you will
-have to make minor modifications so the code will compile under
-C++, see below).
-
- at item Open the "Project / Properties" dialog box. In the "Configuration"
-combo box, select "All Configurations" so that the changes you make will
-affect both debug and release builds. In the tree view on the left hand
-side, select "C/C++ / General", then edit the "Additional Include
-Directories" setting to contain the complete paths to the
- at file{libavformat}, @file{libavcodec}, and @file{libavutil}
-subdirectories of your FFmpeg directory. Note that the directories have
-to be separated using semicolons. Now select "Linker / General" from the
-tree view and edit the "Additional Library Directories" setting to
-contain the same three directories.
-
- at item Still in the "Project / Properties" dialog box, select "Linker / Input"
-from the tree view, then add the files @file{avformat.lib},
- at file{avcodec.lib}, and @file{avutil.lib} to the end of the "Additional
-Dependencies". Note that the names of the libraries have to be separated
-using spaces.
-
- at item Now, select "C/C++ / Code Generation" from the tree view. Select
-"Debug" in the "Configuration" combo box. Make sure that "Runtime
-Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
-the "Configuration" combo box and make sure that "Runtime Library" is
-set to "Multi-threaded DLL".
-
- at item Click "OK" to close the "Project / Properties" dialog box and build
-the application. Hopefully, it should compile and run cleanly. If you
-used @file{output_example.c} as your sample application, you will get a
-few compiler errors, but they are easy to fix. The first type of error
-occurs because Visual C++ does not allow an @code{int} to be converted to
-an @code{enum} without a cast. To solve the problem, insert the required
-casts (this error occurs once for a @code{CodecID} and once for a
- at code{CodecType}). The second type of error occurs because C++ requires
-the return value of @code{malloc} to be cast to the exact type of the
-pointer it is being assigned to. Visual C++ will complain that, for
-example, @code{(void *)} is being assigned to @code{(uint8_t *)} without
-an explicit cast. So insert an explicit cast in these places to silence
-the compiler. The third type of error occurs because the @code{snprintf}
-library function is called @code{_snprintf} under Visual C++. So just
-add an underscore to fix the problem. With these changes,
- at file{output_example.c} should compile under Visual C++, and the
-resulting executable should produce valid video files.
-
- at end enumerate
-
- at subsection Cross compilation for Windows with Linux
-
-You must use the MinGW cross compilation tools available at
- at url{http://www.mingw.org/}.
-
-Then configure FFmpeg with the following options:
- at example
-./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
- at end example
-(you can change the cross-prefix according to the prefix chosen for the
-MinGW tools).
-
-Then you can easily test FFmpeg with Wine
-(@url{http://www.winehq.com/}).
-
- at subsection Compilation under Cygwin
-
-Cygwin works very much like Unix.
-
-Just install your Cygwin with all the "Base" packages, plus the
-following "Devel" ones:
- at example
-binutils, gcc-core, make, subversion
- at end example
-
-Do not install binutils-20060709-1 (they are buggy on shared builds);
-use binutils-20050610-1 instead.
-
-Then run
-
- at example
-./configure --enable-static --disable-shared
- at end example
-
-to make a static build or
-
- at example
-./configure --enable-shared --disable-static
- at end example
-
-to build shared libraries.
-
-If you want to build FFmpeg with additional libraries, download Cygwin
-"Devel" packages for Ogg and Vorbis from any Cygwin packages repository
-and/or SDL, xvid, faac, faad2 packages from Cygwin Ports,
-(@url{http://cygwinports.dotsrc.org/}).
-
- at subsection Crosscompilation for Windows under Cygwin
-
-With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
-
-Just install your Cygwin as explained before, plus these additional
-"Devel" packages:
- at example
-gcc-mingw-core, mingw-runtime, mingw-zlib
- at end example
-
-and add some special flags to your configure invocation.
-
-For a static build run
- at example
-./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
- at end example
-
-and for a build with shared libraries
- at example
-./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
- at end example
-
- at section BeOS
-
-The configure script should guess the configuration itself.
-Networking support is currently not finished.
-errno issues fixed by Andrew Bachmann.
-
-Old stuff:
-
-Fran?ois Revol - revol at free dot fr - April 2002
-
-The configure script should guess the configuration itself,
-however I still did not test building on the net_server version of BeOS.
-
-FFserver is broken (needs poll() implementation).
-
-There are still issues with errno codes, which are negative in BeOS, and
-that FFmpeg negates when returning. This ends up turning errors into
-valid results, then crashes.
-(To be fixed)
-
- at chapter Developers Guide
-
- at section API
- at itemize @bullet
- at item libavcodec is the library containing the codecs (both encoding and
-decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
-
- at item libavformat is the library containing the file format handling (mux and
-demux code for several formats). Look at @file{ffplay.c} to use it in a
-player. See @file{output_example.c} to use it to generate audio or video
-streams.
-
- at end itemize
-
- at section Integrating libavcodec or libavformat in your program
-
-You can integrate all the source code of the libraries to link them
-statically to avoid any version problem. All you need is to provide a
-'config.mak' and a 'config.h' in the parent directory. See the defines
-generated by ./configure to understand what is needed.
-
-You can use libavcodec or libavformat in your commercial program, but
- at emph{any patch you make must be published}. The best way to proceed is
-to send your patches to the FFmpeg mailing list.
-
- at node Coding Rules
- at section Coding Rules
-
-FFmpeg is programmed in the ISO C90 language with a few additional
-features from ISO C99, namely:
- at itemize @bullet
- at item
-the @samp{inline} keyword;
- at item
- at samp{//} comments;
- at item
-designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
- at item
-compound literals (@samp{x = (struct s) @{ 17, 23 @};})
- at end itemize
-
-These features are supported by all compilers we care about, so we will not
-accept patches to remove their use unless they absolutely do not impair
-clarity and performance.
-
-All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
-compiles with several other compilers, such as the Compaq ccc compiler
-or Sun Studio 9, and we would like to keep it that way unless it would
-be exceedingly involved. To ensure compatibility, please do not use any
-additional C99 features or GCC extensions. Especially watch out for:
- at itemize @bullet
- at item
-mixing statements and declarations;
- at item
- at samp{long long} (use @samp{int64_t} instead);
- at item
- at samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
- at item
-GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
- at end itemize
-
-Indent size is 4.
-The presentation is the one specified by 'indent -i4 -kr -nut'.
-The TAB character is forbidden outside of Makefiles as is any
-form of trailing whitespace. Commits containing either will be
-rejected by the Subversion repository.
-
-The main priority in FFmpeg is simplicity and small code size in order to
-minimize the bug count.
-
-Comments: Use the JavaDoc/Doxygen
-format (see examples below) so that code documentation
-can be generated automatically. All nontrivial functions should have a comment
-above them explaining what the function does, even if it is just one sentence.
-All structures and their member variables should be documented, too.
- at example
-/**
- * @@file mpeg.c
- * MPEG codec.
- * @@author ...
- */
-
-/**
- * Summary sentence.
- * more text ...
- * ...
- */
-typedef struct Foobar@{
- int var1; /**< var1 description */
- int var2; ///< var2 description
- /** var3 description */
- int var3;
-@} Foobar;
-
-/**
- * Summary sentence.
- * more text ...
- * ...
- * @@param my_parameter description of my_parameter
- * @@return return value description
- */
-int myfunc(int my_parameter)
-...
- at end example
-
-fprintf and printf are forbidden in libavformat and libavcodec,
-please use av_log() instead.
-
-Casts should be used only when necessary. Unneeded parentheses
-should also be avoided if they don't make the code easier to understand.
-
- at section Development Policy
-
- at enumerate
- at item
- Contributions should be licensed under the LGPL 2.1, including an
- "or any later version" clause, or the MIT license. GPL 2 including
- an "or any later version" clause is also acceptable, but LGPL is
- preferred.
- at item
- You must not commit code which breaks FFmpeg! (Meaning unfinished but
- enabled code which breaks compilation or compiles but does not work or
- breaks the regression tests)
- You can commit unfinished stuff (for testing etc), but it must be disabled
- (#ifdef etc) by default so it does not interfere with other developers'
- work.
- at item
- You do not have to over-test things. If it works for you, and you think it
- should work for others, then commit. If your code has problems
- (portability, triggers compiler bugs, unusual environment etc) they will be
- reported and eventually fixed.
- at item
- Do not commit unrelated changes together, split them into self-contained
- pieces. Also do not forget that if part B depends on part A, but A does not
- depend on B, then A can and should be committed first and separate from B.
- Keeping changes well split into self-contained parts makes reviewing and
- understanding them on the commit log mailing list easier. This also helps
- in case of debugging later on.
- Also if you have doubts about splitting or not splitting, do not hesitate to
- ask/discuss it on the developer mailing list.
- at item
- Do not change behavior of the program (renaming options etc) without
- first discussing it on the ffmpeg-devel mailing list. Do not remove
- functionality from the code. Just improve!
-
- Note: Redundant code can be removed.
- at item
- Do not commit changes to the build system (Makefiles, configure script)
- which change behavior, defaults etc, without asking first. The same
- applies to compiler warning fixes, trivial looking fixes and to code
- maintained by other developers. We usually have a reason for doing things
- the way we do. Send your changes as patches to the ffmpeg-devel mailing
- list, and if the code maintainers say OK, you may commit. This does not
- apply to files you wrote and/or maintain.
- at item
- We refuse source indentation and other cosmetic changes if they are mixed
- with functional changes, such commits will be rejected and removed. Every
- developer has his own indentation style, you should not change it. Of course
- if you (re)write something, you can use your own style, even though we would
- prefer if the indentation throughout FFmpeg was consistent (Many projects
- force a given indentation style - we do not.). If you really need to make
- indentation changes (try to avoid this), separate them strictly from real
- changes.
-
- NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
- then either do NOT change the indentation of the inner part within (do not
- move it to the right)! or do so in a separate commit
- at item
- Always fill out the commit log message. Describe in a few lines what you
- changed and why. You can refer to mailing list postings if you fix a
- particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
- at item
- If you apply a patch by someone else, include the name and email address in
- the log message. Since the ffmpeg-cvslog mailing list is publicly
- archived you should add some SPAM protection to the email address. Send an
- answer to ffmpeg-devel (or wherever you got the patch from) saying that
- you applied the patch.
- at item
- When applying patches that have been discussed (at length) on the mailing
- list, reference the thread in the log message.
- at item
- Do NOT commit to code actively maintained by others without permission.
- Send a patch to ffmpeg-devel instead. If no one answers within a reasonable
- timeframe (12h for build failures and security fixes, 3 days small changes,
- 1 week for big patches) then commit your patch if you think it is OK.
- Also note, the maintainer can simply ask for more time to review!
- at item
- Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
- are sent there and reviewed by all the other developers. Bugs and possible
- improvements or general questions regarding commits are discussed there. We
- expect you to react if problems with your code are uncovered.
- at item
- Update the documentation if you change behavior or add features. If you are
- unsure how best to do this, send a patch to ffmpeg-devel, the documentation
- maintainer(s) will review and commit your stuff.
- at item
- Try to keep important discussions and requests (also) on the public
- developer mailing list, so that all developers can benefit from them.
- at item
- Never write to unallocated memory, never write over the end of arrays,
- always check values read from some untrusted source before using them
- as array index or other risky things.
- at item
- Remember to check if you need to bump versions for the specific libav
- parts (libavutil, libavcodec, libavformat) you are changing. You need
- to change the version integer and the version string.
- Incrementing the first component means no backward compatibility to
- previous versions (e.g. removal of a function from the public API).
- Incrementing the second component means backward compatible change
- (e.g. addition of a function to the public API).
- Incrementing the third component means a noteworthy binary compatible
- change (e.g. encoder bug fix that matters for the decoder).
- at item
- If you add a new codec, remember to update the changelog, add it to
- the supported codecs table in the documentation and bump the second
- component of the @file{libavcodec} version number appropriately. If
- it has a fourcc, add it to @file{libavformat/avienc.c}, even if it
- is only a decoder.
- at item
- Do not change code to hide warnings without ensuring that the underlying
- logic is correct and thus the warning was inappropriate.
- at item
- If you add a new file, give it a proper license header. Do not copy and
- paste it from a random place, use an existing file as template.
- at end enumerate
-
-We think our rules are not too hard. If you have comments, contact us.
-
-Note, these rules are mostly borrowed from the MPlayer project.
-
- at section Submitting patches
-
-First, (@pxref{Coding Rules}) above if you did not yet.
-
-When you submit your patch, try to send a unified diff (diff '-up'
-option). We cannot read other diffs :-)
-
-Also please do not submit a patch which contains several unrelated changes.
-Split it into separate, self-contained pieces. This does not mean splitting
-file by file. Instead, make the patch as small as possible while still
-keeping it as a logical unit that contains an individual change, even
-if it spans multiple files. This makes reviewing your patches much easier
-for us and greatly increases your chances of getting your patch applied.
-
-Run the regression tests before submitting a patch so that you can
-verify that there are no big problems.
-
-Patches should be posted as base64 encoded attachments (or any other
-encoding which ensures that the patch will not be trashed during
-transmission) to the ffmpeg-devel mailing list, see
- at url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
-
-It also helps quite a bit if you tell us what the patch does (for example
-'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
-and has no lrint()')
-
-Also please if you send several patches, send each patch as a separate mail,
-do not attach several unrelated patches to the same mail.
-
- at section patch submission checklist
-
- at enumerate
- at item
- Do the regression tests pass with the patch applied?
- at item
- Is the patch a unified diff?
- at item
- Is the patch against latest FFmpeg SVN?
- at item
- Are you subscribed to ffmpeg-dev?
- (the list is subscribers only due to spam)
- at item
- Have you checked that the changes are minimal, so that the same cannot be
- achieved with a smaller patch and/or simpler final code?
- at item
- If the change is to speed critical code, did you benchmark it?
- at item
- If you did any benchmarks, did you provide them in the mail?
- at item
- Have you checked that the patch does not introduce buffer overflows or
- other security issues?
- at item
- Is the patch created from the root of the source tree, so it can be
- applied with @code{patch -p0}?
- at item
- Does the patch not mix functional and cosmetic changes?
- at item
- Did you add tabs or trailing whitespace to the code? Both are forbidden.
- at item
- Is the patch attached to the email you send?
- at item
- Is the mime type of the patch correct? It should be text/x-diff or
- text/x-patch or at least text/plain and not application/octet-stream.
- at item
- If the patch fixes a bug, did you provide a verbose analysis of the bug?
- at item
- If the patch fixes a bug, did you provide enough information, including
- a sample, so the bug can be reproduced and the fix can be verified?
- Note please do not attach samples >100k to mails but rather provide a
- URL, you can upload to ftp://upload.mplayerhq.hu
- at item
- Did you provide a verbose summary about what the patch does change?
- at item
- Did you provide a verbose explanation why it changes things like it does?
- at item
- Did you provide a verbose summary of the user visible advantages and
- disadvantages if the patch is applied?
- at item
- Did you provide an example so we can verify the new feature added by the
- patch easily?
- at item
- If you added a new file, did you insert a license header? It should be
- taken from FFmpeg, not randomly copied and pasted from somewhere else.
- at item
- You should maintain alphabetical order in alphabetically ordered lists as
- long as doing so does not break API/ABI compatibility.
- at item
- Lines with similar content should be aligned vertically when doing so
- improves readability.
- at item
- Did you provide a suggestion for a clear commit log message?
- at end enumerate
-
- at section Patch review process
-
-All patches posted to ffmpeg-devel will be reviewed, unless they contain a
-clear note that the patch is not for SVN.
-Reviews and comments will be posted as replies to the patch on the
-mailing list. The patch submitter then has to take care of every comment,
-that can be by resubmitting a changed patch or by discussion. Resubmitted
-patches will themselves be reviewed like any other patch. If at some point
-a patch passes review with no comments then it is approved, that can for
-simple and small patches happen immediately while large patches will generally
-have to be changed and reviewed many times before they are approved.
-After a patch is approved it will be committed to the repository.
-
-We will review all submitted patches, but sometimes we are quite busy so
-especially for large patches this can take several weeks.
-
-When resubmitting patches, please do not make any significant changes
-not related to the comments received during review. Such patches will
-be rejected. Instead, submit significant changes or new features as
-separate patches.
-
- at section Regression tests
-
-Before submitting a patch (or committing to the repository), you should at least
-test that you did not break anything.
-
-The regression tests build a synthetic video stream and a synthetic
-audio stream. These are then encoded and decoded with all codecs or
-formats. The CRC (or MD5) of each generated file is recorded in a
-result file. A 'diff' is launched to compare the reference results and
-the result file.
-
-The regression tests then go on to test the FFserver code with a
-limited set of streams. It is important that this step runs correctly
-as well.
-
-Run 'make test' to test all the codecs and formats.
-
-Run 'make fulltest' to test all the codecs, formats and FFserver.
-
-[Of course, some patches may change the results of the regression tests. In
-this case, the reference results of the regression tests shall be modified
-accordingly].
-
@bye
Copied: trunk/doc/general.texi (from r10214, /trunk/doc/ffmpeg-doc.texi)
==============================================================================
--- /trunk/doc/ffmpeg-doc.texi (original)
+++ trunk/doc/general.texi Tue Aug 28 08:22:57 2007
@@ -1,856 +1,13 @@
\input texinfo @c -*- texinfo -*-
- at settitle FFmpeg Documentation
+ at settitle General Documentation
@titlepage
@sp 7
- at center @titlefont{FFmpeg Documentation}
+ at center @titlefont{General Documentation}
@sp 3
@end titlepage
- at chapter Introduction
-
-FFmpeg is a very fast video and audio converter. It can also grab from
-a live audio/video source.
-
-The command line interface is designed to be intuitive, in the sense
-that FFmpeg tries to figure out all parameters that can possibly be
-derived automatically. You usually only have to specify the target
-bitrate you want.
-
-FFmpeg can also convert from any sample rate to any other, and resize
-video on the fly with a high quality polyphase filter.
-
- at chapter Quick Start
-
- at c man begin EXAMPLES
- at section Video and Audio grabbing
-
-FFmpeg can grab video and audio from devices given that you specify the input
-format and device.
-
- at example
-ffmpeg -f audio_device -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
- at end example
-
-Note that you must activate the right video source and channel before
-launching FFmpeg with any TV viewer such as xawtv
-(@url{http://bytesex.org/xawtv/}) by Gerd Knorr. You also
-have to set the audio recording levels correctly with a
-standard mixer.
-
- at section X11 grabbing
-
-FFmpeg can grab the X11 display.
-
- at example
-ffmpeg -f x11grab -s cif -i :0.0 /tmp/out.mpg
- at end example
-
-0.0 is display.screen number of your X11 server, same as
-the DISPLAY environment variable.
-
- at example
-ffmpeg -f x11grab -s cif -i :0.0+10,20 /tmp/out.mpg
- at end example
-
-0.0 is display.screen number of your X11 server, same as the DISPLAY environment
-variable. 10 is the x-offset and 20 the y-offset for the grabbing.
-
- at section Video and Audio file format conversion
-
-* FFmpeg can use any supported file format and protocol as input:
-
-Examples:
-
-* You can use YUV files as input:
-
- at example
-ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
- at end example
-
-It will use the files:
- at example
-/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
-/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
- at end example
-
-The Y files use twice the resolution of the U and V files. They are
-raw files, without header. They can be generated by all decent video
-decoders. You must specify the size of the image with the @option{-s} option
-if FFmpeg cannot guess it.
-
-* You can input from a raw YUV420P file:
-
- at example
-ffmpeg -i /tmp/test.yuv /tmp/out.avi
- at end example
-
-test.yuv is a file containing raw YUV planar data. Each frame is composed
-of the Y plane followed by the U and V planes at half vertical and
-horizontal resolution.
-
-* You can output to a raw YUV420P file:
-
- at example
-ffmpeg -i mydivx.avi hugefile.yuv
- at end example
-
-* You can set several input files and output files:
-
- at example
-ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
- at end example
-
-Converts the audio file a.wav and the raw YUV video file a.yuv
-to MPEG file a.mpg.
-
-* You can also do audio and video conversions at the same time:
-
- at example
-ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
- at end example
-
-Converts a.wav to MPEG audio at 22050Hz sample rate.
-
-* You can encode to several formats at the same time and define a
-mapping from input stream to output streams:
-
- at example
-ffmpeg -i /tmp/a.wav -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
- at end example
-
-Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
-file:index' specifies which input stream is used for each output
-stream, in the order of the definition of output streams.
-
-* You can transcode decrypted VOBs
-
- at example
-ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
- at end example
-
-This is a typical DVD ripping example; the input is a VOB file, the
-output an AVI file with MPEG-4 video and MP3 audio. Note that in this
-command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
-GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
-input video. Furthermore, the audio stream is MP3-encoded so you need
-to enable LAME support by passing @code{--enable-libmp3lame} to configure.
-The mapping is particularly useful for DVD transcoding
-to get the desired audio language.
-
-NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
- at c man end
-
- at chapter Invocation
-
- at section Syntax
-
-The generic syntax is:
-
- at example
- at c man begin SYNOPSIS
-ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
- at c man end
- at end example
- at c man begin DESCRIPTION
-As a general rule, options are applied to the next specified
-file. Therefore, order is important, and you can have the same
-option on the command line multiple times. Each occurrence is
-then applied to the next input or output file.
-
-* To set the video bitrate of the output file to 64kbit/s:
- at example
-ffmpeg -i input.avi -b 64k output.avi
- at end example
-
-* To force the frame rate of the input and output file to 24 fps:
- at example
-ffmpeg -r 24 -i input.avi output.avi
- at end example
-
-* To force the frame rate of the output file to 24 fps:
- at example
-ffmpeg -i input.avi -r 24 output.avi
- at end example
-
-* To force the frame rate of input file to 1 fps and the output file to 24 fps:
- at example
-ffmpeg -r 1 -i input.avi -r 24 output.avi
- at end example
-
-The format option may be needed for raw input files.
-
-By default, FFmpeg tries to convert as losslessly as possible: It
-uses the same audio and video parameters for the outputs as the one
-specified for the inputs.
- at c man end
-
- at c man begin OPTIONS
- at section Main options
-
- at table @option
- at item -L
-Show license.
-
- at item -h
-Show help.
-
- at item -version
-Show version.
-
- at item -formats
-Show available formats, codecs, protocols, ...
-
- at item -f fmt
-Force format.
-
- at item -i filename
-input filename
-
- at item -y
-Overwrite output files.
-
- at item -t duration
-Restrict the transcoded/captured video sequence
-to the duration specified in seconds.
- at code{hh:mm:ss[.xxx]} syntax is also supported.
-
- at item -fs limit_size
-Set the file size limit.
-
- at item -ss position
-Seek to given time position in seconds.
- at code{hh:mm:ss[.xxx]} syntax is also supported.
-
- at item -itsoffset offset
-Set the input time offset in seconds.
- at code{[-]hh:mm:ss[.xxx]} syntax is also supported.
-This option affects all the input files that follow it.
-The offset is added to the timestamps of the input files.
-Specifying a positive offset means that the corresponding
-streams are delayed by 'offset' seconds.
-
- at item -title string
-Set the title.
-
- at item -timestamp time
-Set the timestamp.
-
- at item -author string
-Set the author.
-
- at item -copyright string
-Set the copyright.
-
- at item -comment string
-Set the comment.
-
- at item -album string
-Set the album.
-
- at item -track number
-Set the track.
-
- at item -year number
-Set the year.
-
- at item -v verbose
-Control amount of logging.
-
- at item -target type
-Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
-"ntsc-svcd", ... ). All the format options (bitrate, codecs,
-buffer sizes) are then set automatically. You can just type:
-
- at example
-ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
- at end example
-
-Nevertheless you can specify additional options as long as you know
-they do not conflict with the standard, as in:
-
- at example
-ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
- at end example
-
- at item -dframes number
-Set the number of data frames to record.
-
- at item -scodec codec
-Force subtitle codec ('copy' to copy stream).
-
- at item -newsubtitle
-Add a new subtitle stream to the current output stream.
-
- at item -slang code
-Set the ISO 639 language code (3 letters) of the current subtitle stream.
-
- at end table
-
- at section Video Options
-
- at table @option
- at item -b bitrate
-Set the video bitrate in bit/s (default = 200 kb/s).
- at item -vframes number
-Set the number of video frames to record.
- at item -r fps
-Set frame rate (Hz value, fraction or abbreviation), (default = 25).
- at item -s size
-Set frame size. The format is @samp{wxh} (ffserver default = 160x128, ffmpeg default = same as source).
-The following abbreviations are recognized:
- at table @samp
- at item sqcif
-128x96
- at item qcif
-176x144
- at item cif
-352x288
- at item 4cif
-704x576
- at item qqvga
-160x120
- at item qvga
-320x240
- at item vga
-640x480
- at item svga
-800x600
- at item xga
-1024x768
- at item uxga
-1600x1200
- at item qxga
-2048x1536
- at item sxga
-1280x1024
- at item qsxga
-2560x2048
- at item hsxga
-5120x4096
- at item wvga
-852x480
- at item wxga
-1366x768
- at item wsxga
-1600x1024
- at item wuxga
-1920x1200
- at item woxga
-2560x1600
- at item wqsxga
-3200x2048
- at item wquxga
-3840x2400
- at item whsxga
-6400x4096
- at item whuxga
-7680x4800
- at item cga
-320x200
- at item ega
-640x350
- at item hd480
-852x480
- at item hd720
-1280x720
- at item hd1080
-1920x1080
- at end table
-
- at item -aspect aspect
-Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
- at item -croptop size
-Set top crop band size (in pixels).
- at item -cropbottom size
-Set bottom crop band size (in pixels).
- at item -cropleft size
-Set left crop band size (in pixels).
- at item -cropright size
-Set right crop band size (in pixels).
- at item -padtop size
-Set top pad band size (in pixels).
- at item -padbottom size
-Set bottom pad band size (in pixels).
- at item -padleft size
-Set left pad band size (in pixels).
- at item -padright size
-Set right pad band size (in pixels).
- at item -padcolor (hex color)
-Set color of padded bands. The value for padcolor is expressed
-as a six digit hexadecimal number where the first two digits
-represent red, the middle two digits green and last two digits
-blue (default = 000000 (black)).
- at item -vn
-Disable video recording.
- at item -bt tolerance
-Set video bitrate tolerance (in bit/s).
- at item -maxrate bitrate
-Set max video bitrate (in bit/s).
- at item -minrate bitrate
-Set min video bitrate (in bit/s).
- at item -bufsize size
-Set video buffer verifier buffer size (in bits).
- at item -vcodec codec
-Force video codec to @var{codec}. Use the @code{copy} special value to
-tell that the raw codec data must be copied as is.
- at item -sameq
-Use same video quality as source (implies VBR).
-
- at item -pass n
-Select the pass number (1 or 2). It is useful to do two pass
-encoding. The statistics of the video are recorded in the first
-pass and the video is generated at the exact requested bitrate
-in the second pass.
-
- at item -passlogfile file
-Set two pass logfile name to @var{file}.
-
- at item -newvideo
-Add a new video stream to the current output stream.
-
- at end table
-
- at section Advanced Video Options
-
- at table @option
- at item -pix_fmt format
-Set pixel format. Use 'list' as parameter to show all the supported
-pixel formats.
- at item -sws_flags flags
-Set SwScaler flags (only available when compiled with SwScaler support).
- at item -g gop_size
-Set the group of pictures size.
- at item -intra
-Use only intra frames.
- at item -vdt n
-Discard threshold.
- at item -qscale q
-Use fixed video quantizer scale (VBR).
- at item -qmin q
-minimum video quantizer scale (VBR)
- at item -qmax q
-maximum video quantizer scale (VBR)
- at item -qdiff q
-maximum difference between the quantizer scales (VBR)
- at item -qblur blur
-video quantizer scale blur (VBR)
- at item -qcomp compression
-video quantizer scale compression (VBR)
-
- at item -lmin lambda
-minimum video lagrange factor (VBR)
- at item -lmax lambda
-max video lagrange factor (VBR)
- at item -mblmin lambda
-minimum macroblock quantizer scale (VBR)
- at item -mblmax lambda
-maximum macroblock quantizer scale (VBR)
-
-These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
-but you may use the QP2LAMBDA constant to easily convert from 'q' units:
- at example
-ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
- at end example
-
- at item -rc_init_cplx complexity
-initial complexity for single pass encoding
- at item -b_qfactor factor
-qp factor between P- and B-frames
- at item -i_qfactor factor
-qp factor between P- and I-frames
- at item -b_qoffset offset
-qp offset between P- and B-frames
- at item -i_qoffset offset
-qp offset between P- and I-frames
- at item -rc_eq equation
-Set rate control equation (@pxref{FFmpeg formula
-evaluator}) (default = @code{tex^qComp}).
- at item -rc_override override
-rate control override for specific intervals
- at item -me_method method
-Set motion estimation method to @var{method}.
-Available methods are (from lowest to best quality):
- at table @samp
- at item zero
-Try just the (0, 0) vector.
- at item phods
- at item log
- at item x1
- at item hex
- at item umh
- at item epzs
-(default method)
- at item full
-exhaustive search (slow and marginally better than epzs)
- at end table
-
- at item -dct_algo algo
-Set DCT algorithm to @var{algo}. Available values are:
- at table @samp
- at item 0
-FF_DCT_AUTO (default)
- at item 1
-FF_DCT_FASTINT
- at item 2
-FF_DCT_INT
- at item 3
-FF_DCT_MMX
- at item 4
-FF_DCT_MLIB
- at item 5
-FF_DCT_ALTIVEC
- at end table
-
- at item -idct_algo algo
-Set IDCT algorithm to @var{algo}. Available values are:
- at table @samp
- at item 0
-FF_IDCT_AUTO (default)
- at item 1
-FF_IDCT_INT
- at item 2
-FF_IDCT_SIMPLE
- at item 3
-FF_IDCT_SIMPLEMMX
- at item 4
-FF_IDCT_LIBMPEG2MMX
- at item 5
-FF_IDCT_PS2
- at item 6
-FF_IDCT_MLIB
- at item 7
-FF_IDCT_ARM
- at item 8
-FF_IDCT_ALTIVEC
- at item 9
-FF_IDCT_SH4
- at item 10
-FF_IDCT_SIMPLEARM
- at end table
-
- at item -er n
-Set error resilience to @var{n}.
- at table @samp
- at item 1
-FF_ER_CAREFUL (default)
- at item 2
-FF_ER_COMPLIANT
- at item 3
-FF_ER_AGGRESSIVE
- at item 4
-FF_ER_VERY_AGGRESSIVE
- at end table
-
- at item -ec bit_mask
-Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
-the following values:
- at table @samp
- at item 1
-FF_EC_GUESS_MVS (default = enabled)
- at item 2
-FF_EC_DEBLOCK (default = enabled)
- at end table
-
- at item -bf frames
-Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
- at item -mbd mode
-macroblock decision
- at table @samp
- at item 0
-FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
- at item 1
-FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
- at item 2
-FF_MB_DECISION_RD: rate distortion
- at end table
-
- at item -4mv
-Use four motion vector by macroblock (MPEG-4 only).
- at item -part
-Use data partitioning (MPEG-4 only).
- at item -bug param
-Work around encoder bugs that are not auto-detected.
- at item -strict strictness
-How strictly to follow the standards.
- at item -aic
-Enable Advanced intra coding (h263+).
- at item -umv
-Enable Unlimited Motion Vector (h263+)
-
- at item -deinterlace
-Deinterlace pictures.
- at item -ilme
-Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
-Use this option if your input file is interlaced and you want
-to keep the interlaced format for minimum losses.
-The alternative is to deinterlace the input stream with
- at option{-deinterlace}, but deinterlacing introduces losses.
- at item -psnr
-Calculate PSNR of compressed frames.
- at item -vstats
-Dump video coding statistics to @file{vstats_HHMMSS.log}.
- at item -vstats_file file
-Dump video coding statistics to @var{file}.
- at item -vhook module
-Insert video processing @var{module}. @var{module} contains the module
-name and its parameters separated by spaces.
- at item -top n
-top=1/bottom=0/auto=-1 field first
- at item -dc precision
-Intra_dc_precision.
- at item -vtag fourcc/tag
-Force video tag/fourcc.
- at item -qphist
-Show QP histogram.
- at item -vbsf bitstream filter
-Bitstream filters available are "dump_extra", "remove_extra", "noise".
- at end table
-
- at section Audio Options
-
- at table @option
- at item -aframes number
-Set the number of audio frames to record.
- at item -ar freq
-Set the audio sampling frequency (default = 44100 Hz).
- at item -ab bitrate
-Set the audio bitrate in bit/s (default = 64k).
- at item -ac channels
-Set the number of audio channels (default = 1).
- at item -an
-Disable audio recording.
- at item -acodec codec
-Force audio codec to @var{codec}. Use the @code{copy} special value to
-specify that the raw codec data must be copied as is.
- at item -newaudio
-Add a new audio track to the output file. If you want to specify parameters,
-do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
-
-Mapping will be done automatically, if the number of output streams is equal to
-the number of input streams, else it will pick the first one that matches. You
-can override the mapping using @code{-map} as usual.
-
-Example:
- at example
-ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
- at end example
- at item -alang code
-Set the ISO 639 language code (3 letters) of the current audio stream.
- at end table
-
- at section Advanced Audio options:
-
- at table @option
- at item -atag fourcc/tag
-Force audio tag/fourcc.
- at item -absf bitstream filter
-Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
- at end table
-
- at section Subtitle options:
-
- at table @option
- at item -scodec codec
-Force subtitle codec ('copy' to copy stream).
- at item -newsubtitle
-Add a new subtitle stream to the current output stream.
- at item -slang code
-Set the ISO 639 language code (3 letters) of the current subtitle stream.
- at end table
-
- at section Audio/Video grab options
-
- at table @option
- at item -vc channel
-Set video grab channel (DV1394 only).
- at item -tvstd standard
-Set television standard (NTSC, PAL (SECAM)).
- at item -isync
-Synchronize read on input.
- at end table
-
- at section Advanced options
-
- at table @option
- at item -map input stream id[:input stream id]
-Set stream mapping from input streams to output streams.
-Just enumerate the input streams in the order you want them in the output.
-[input stream id] sets the (input) stream to sync against.
- at item -map_meta_data outfile:infile
-Set meta data information of outfile from infile.
- at item -debug
-Print specific debug info.
- at item -benchmark
-Add timings for benchmarking.
- at item -dump
-Dump each input packet.
- at item -hex
-When dumping packets, also dump the payload.
- at item -bitexact
-Only use bit exact algorithms (for codec testing).
- at item -ps size
-Set packet size in bits.
- at item -re
-Read input at native frame rate. Mainly used to simulate a grab device.
- at item -loop_input
-Loop over the input stream. Currently it works only for image
-streams. This option is used for automatic FFserver testing.
- at item -loop_output number_of_times
-Repeatedly loop output for formats that support looping such as animated GIF
-(0 will loop the output infinitely).
- at item -threads count
-Thread count.
- at item -vsync parameter
-Video sync method. Video will be stretched/squeezed to match the timestamps,
-it is done by duplicating and dropping frames. With -map you can select from
-which stream the timestamps should be taken. You can leave either video or
-audio unchanged and sync the remaining stream(s) to the unchanged one.
- at item -async samples_per_second
-Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
-the parameter is the maximum samples per second by which the audio is changed.
--async 1 is a special case where only the start of the audio stream is corrected
-without any later correction.
- at item -copyts
-Copy timestamps from input to output.
- at item -shortest
-Finish encoding when the shortest input stream ends.
- at item -dts_delta_threshold
-Timestamp discontinuity delta threshold.
- at item -muxdelay seconds
-Set the maximum demux-decode delay.
- at item -muxpreload seconds
-Set the initial demux-decode delay.
- at end table
-
- at node FFmpeg formula evaluator
- at section FFmpeg formula evaluator
-
-When evaluating a rate control string, FFmpeg uses an internal formula
-evaluator.
-
-The following binary operators are available: @code{+}, @code{-},
- at code{*}, @code{/}, @code{^}.
-
-The following unary operators are available: @code{+}, @code{-},
- at code{(...)}.
-
-The following functions are available:
- at table @var
- at item sinh(x)
- at item cosh(x)
- at item tanh(x)
- at item sin(x)
- at item cos(x)
- at item tan(x)
- at item exp(x)
- at item log(x)
- at item squish(x)
- at item gauss(x)
- at item abs(x)
- at item max(x, y)
- at item min(x, y)
- at item gt(x, y)
- at item lt(x, y)
- at item eq(x, y)
- at item bits2qp(bits)
- at item qp2bits(qp)
- at end table
-
-The following constants are available:
- at table @var
- at item PI
- at item E
- at item iTex
- at item pTex
- at item tex
- at item mv
- at item fCode
- at item iCount
- at item mcVar
- at item var
- at item isI
- at item isP
- at item isB
- at item avgQP
- at item qComp
- at item avgIITex
- at item avgPITex
- at item avgPPTex
- at item avgBPTex
- at item avgTex
- at end table
-
- at c man end
-
- at ignore
-
- at setfilename ffmpeg
- at settitle FFmpeg video converter
-
- at c man begin SEEALSO
-ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
- at c man end
-
- at c man begin AUTHOR
-Fabrice Bellard
- at c man end
-
- at end ignore
-
- at section Protocols
-
-The filename can be @file{-} to read from standard input or to write
-to standard output.
-
-FFmpeg also handles many protocols specified with an URL syntax.
-
-Use 'ffmpeg -formats' to see a list of the supported protocols.
-
-The protocol @code{http:} is currently used only to communicate with
-FFserver (see the FFserver documentation). When FFmpeg will be a
-video player it will also be used for streaming :-)
-
- at chapter Tips
-
- at itemize
- at item For streaming at very low bitrate application, use a low frame rate
-and a small GOP size. This is especially true for RealVideo where
-the Linux player does not seem to be very fast, so it can miss
-frames. An example is:
-
- at example
-ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
- at end example
-
- at item The parameter 'q' which is displayed while encoding is the current
-quantizer. The value 1 indicates that a very good quality could
-be achieved. The value 31 indicates the worst quality. If q=31 appears
-too often, it means that the encoder cannot compress enough to meet
-your bitrate. You must either increase the bitrate, decrease the
-frame rate or decrease the frame size.
-
- at item If your computer is not fast enough, you can speed up the
-compression at the expense of the compression ratio. You can use
-'-me zero' to speed up motion estimation, and '-intra' to disable
-motion estimation completely (you have only I-frames, which means it
-is about as good as JPEG compression).
-
- at item To have very low audio bitrates, reduce the sampling frequency
-(down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
-
- at item To have a constant quality (but a variable bitrate), use the option
-'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
-quality).
-
- at item When converting video files, you can use the '-sameq' option which
-uses the same quality factor in the encoder as in the decoder.
-It allows almost lossless encoding.
-
- at end itemize
-
-
@chapter external libraries
FFmpeg can be hooked up with a number of external libraries to add support
More information about the ffmpeg-cvslog
mailing list