typo
[libav.git] / doc / ffmpeg-doc.texi
CommitLineData
9181577c
FB
1\input texinfo @c -*- texinfo -*-
2
3@settitle FFmpeg Documentation
4@titlepage
5@sp 7
6@center @titlefont{FFmpeg Documentation}
7@sp 3
8@end titlepage
9
10
11@chapter Introduction
12
13FFmpeg is a very fast video and audio converter. It can also grab from
14a live audio/video source.
115329f1 15
9181577c 16The command line interface is designed to be intuitive, in the sense
4c5f7207
DB
17that FFmpeg tries to figure out all parameters that can possibly be
18derived automatically. You usually only have to specify the target
19bitrate you want.
9181577c
FB
20
21FFmpeg can also convert from any sample rate to any other, and resize
22video on the fly with a high quality polyphase filter.
23
24@chapter Quick Start
25
e99c4e10 26@c man begin EXAMPLES
9181577c
FB
27@section Video and Audio grabbing
28
e99c4e10
FB
29FFmpeg can use a video4linux compatible video source and any Open Sound
30System audio source:
31
9181577c 32@example
115329f1 33ffmpeg /tmp/out.mpg
9181577c
FB
34@end example
35
e99c4e10 36Note that you must activate the right video source and channel before
4c5f7207
DB
37launching FFmpeg with any TV viewer such as xawtv
38(@url{http://bytesex.org/xawtv/}) by Gerd Knorr. You also
39have to set the audio recording levels correctly with a
e99c4e10 40standard mixer.
9181577c 41
6bf40f39 42@section Video and Audio file format conversion
9181577c 43
4c5f7207 44* FFmpeg can use any supported file format and protocol as input:
9181577c
FB
45
46Examples:
47
4c5f7207 48* You can use YUV files as input:
9181577c
FB
49
50@example
115329f1 51ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
9181577c
FB
52@end example
53
115329f1 54It will use the files:
9181577c 55@example
e99c4e10
FB
56/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
57/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
9181577c
FB
58@end example
59
e99c4e10
FB
60The Y files use twice the resolution of the U and V files. They are
61raw files, without header. They can be generated by all decent video
62decoders. You must specify the size of the image with the @option{-s} option
4c5f7207 63if FFmpeg cannot guess it.
9181577c 64
4c5f7207 65* You can input from a raw YUV420P file:
9181577c
FB
66
67@example
e99c4e10 68ffmpeg -i /tmp/test.yuv /tmp/out.avi
9181577c
FB
69@end example
70
4c5f7207
DB
71test.yuv is a file containing raw YUV planar data. Each frame is composed
72of the Y plane followed by the U and V planes at half vertical and
e99c4e10 73horizontal resolution.
9181577c 74
4c5f7207 75* You can output to a raw YUV420P file:
9181577c
FB
76
77@example
f926cbe7 78ffmpeg -i mydivx.avi hugefile.yuv
9181577c
FB
79@end example
80
81* You can set several input files and output files:
82
83@example
e99c4e10 84ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
9181577c
FB
85@end example
86
4c5f7207
DB
87Converts the audio file a.wav and the raw YUV video file a.yuv
88to MPEG file a.mpg.
9181577c 89
6bf40f39 90* You can also do audio and video conversions at the same time:
9181577c
FB
91
92@example
e99c4e10 93ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
9181577c
FB
94@end example
95
4c5f7207 96Converts a.wav to MPEG audio at 22050Hz sample rate.
9181577c
FB
97
98* You can encode to several formats at the same time and define a
e99c4e10 99mapping from input stream to output streams:
9181577c
FB
100
101@example
e99c4e10 102ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
9181577c
FB
103@end example
104
4c5f7207
DB
105Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
106file:index' specifies which input stream is used for each output
e99c4e10 107stream, in the order of the definition of output streams.
9181577c
FB
108
109* You can transcode decrypted VOBs
110
111@example
3c0ba870 112ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec mp3 -ab 128 snatch.avi
9181577c
FB
113@end example
114
4c5f7207
DB
115This is a typical DVD ripping example; the input is a VOB file, the
116output an AVI file with MPEG-4 video and MP3 audio. Note that in this
117command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
118GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
119input video. Furthermore, the audio stream is MP3-encoded so you need
120to enable LAME support by passing @code{--enable-mp3lame} to configure.
121The mapping is particularly useful for DVD transcoding
e99c4e10 122to get the desired audio language.
9181577c 123
4c5f7207 124NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
e99c4e10 125@c man end
9181577c
FB
126
127@chapter Invocation
128
129@section Syntax
130
e99c4e10 131The generic syntax is:
9181577c 132
115329f1 133@example
e99c4e10 134@c man begin SYNOPSIS
28f88dc8 135ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
e99c4e10 136@c man end
9181577c 137@end example
e99c4e10
FB
138@c man begin DESCRIPTION
139If no input file is given, audio/video grabbing is done.
9181577c 140
e99c4e10 141As a general rule, options are applied to the next specified
699e77b1 142file. Therefore, order is important, and you can have the same
8cc62264 143option on the command line multiple times. Each occurrence is
699e77b1
VP
144then applied to the next input or output file.
145
eb10acec 146* To set the video bitrate of the output file to 64kbit/s:
699e77b1
VP
147@example
148ffmpeg -i input.avi -b 64k output.avi
149@end example
150
151* To force the frame rate of the input and output file to 24 fps:
152@example
153ffmpeg -r 24 -i input.avi output.avi
154@end example
155
156* To force the frame rate of the output file to 24 fps:
157@example
158ffmpeg -i input.avi -r 24 output.avi
159@end example
160
161* To force the frame rate of input file to 1 fps and the output file to 24 fps:
162@example
163ffmpeg -r 1 -i input.avi -r 24 output.avi
164@end example
165
166The format option may be needed for raw input files.
9181577c 167
4c5f7207
DB
168By default, FFmpeg tries to convert as losslessly as possible: It
169uses the same audio and video parameters for the outputs as the one
e99c4e10
FB
170specified for the inputs.
171@c man end
9181577c 172
e99c4e10 173@c man begin OPTIONS
9181577c
FB
174@section Main options
175
e99c4e10 176@table @option
9181577c 177@item -L
4c5f7207 178Show license.
18bff752 179
9181577c 180@item -h
4c5f7207 181Show help.
18bff752 182
4386f941
DB
183@item -version
184Show version.
185
e99c4e10 186@item -formats
4c5f7207 187Show available formats, codecs, protocols, ...
18bff752 188
115329f1 189@item -f fmt
4c5f7207 190Force format.
18bff752 191
115329f1 192@item -i filename
4c5f7207 193input filename
9181577c 194
115329f1 195@item -y
4c5f7207 196Overwrite output files.
9181577c 197
115329f1 198@item -t duration
4c5f7207
DB
199Set the recording time in seconds.
200@code{hh:mm:ss[.xxx]} syntax is also supported.
9181577c 201
4386f941
DB
202@item -fs limit_size
203Set the file size limit.
204
e83a84ac 205@item -ss position
4c5f7207
DB
206Seek to given time position in seconds.
207@code{hh:mm:ss[.xxx]} syntax is also supported.
e83a84ac 208
4386f941
DB
209@item -itsoffset offset
210Set the input time offset in seconds.
211@code{[-]hh:mm:ss[.xxx]} syntax is also supported.
212This option affects all the input files that follow it.
213The offset is added to the timestamps of the input files.
214Specifying a positive offset means that the corresponding
215streams are delayed by 'offset' seconds.
216
115329f1 217@item -title string
4c5f7207 218Set the title.
9181577c 219
4386f941
DB
220@item -timestamp time
221Set the timestamp.
222
115329f1 223@item -author string
4c5f7207 224Set the author.
9181577c 225
115329f1 226@item -copyright string
4c5f7207 227Set the copyright.
9181577c 228
115329f1 229@item -comment string
4c5f7207 230Set the comment.
9181577c 231
4386f941
DB
232@item -album string
233Set the album.
234
ec1b10f4
PI
235@item -track number
236Set the track.
237
238@item -year number
239Set the year.
240
4386f941
DB
241@item -v verbose
242Control amount of logging.
243
99db6420 244@item -target type
4386f941 245Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
4c5f7207
DB
246"ntsc-svcd", ... ). All the format options (bitrate, codecs,
247buffer sizes) are then set automatically. You can just type:
99db6420
FB
248
249@example
250ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
251@end example
252
4c5f7207
DB
253Nevertheless you can specify additional options as long as you know
254they do not conflict with the standard, as in:
791d8d1d
MB
255
256@example
257ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
258@end example
259
4386f941
DB
260@item -dframes number
261Set the number of data frames to record.
262
263@item -scodec codec
264Force subtitle codec ('copy' to copy stream).
265
266@item -newsubtitle
267Add a new subtitle stream to the current output stream.
268
269@item -slang code
270Set the ISO 639 language code (3 letters) of the current subtitle stream.
401fbdde 271
9181577c
FB
272@end table
273
274@section Video Options
275
e99c4e10 276@table @option
9181577c 277@item -b bitrate
3c0ba870 278Set the video bitrate in bit/s (default = 200 kb/s).
4386f941
DB
279@item -vframes number
280Set the number of video frames to record.
115329f1 281@item -r fps
4386f941 282Set frame rate (Hz value, fraction or abbreviation), (default = 25).
115329f1 283@item -s size
4c5f7207
DB
284Set frame size. The format is @samp{wxh} (default = 160x128).
285The following abbreviations are recognized:
5ee03c86 286@table @samp
18bff752
FB
287@item sqcif
288128x96
289@item qcif
290176x144
291@item cif
292352x288
293@item 4cif
294704x576
295@end table
296
297@item -aspect aspect
4c5f7207 298Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
18bff752 299@item -croptop size
4c5f7207 300Set top crop band size (in pixels).
18bff752 301@item -cropbottom size
4c5f7207 302Set bottom crop band size (in pixels).
18bff752 303@item -cropleft size
4c5f7207 304Set left crop band size (in pixels).
18bff752 305@item -cropright size
4c5f7207 306Set right crop band size (in pixels).
1ff93ffc 307@item -padtop size
4c5f7207 308Set top pad band size (in pixels).
1ff93ffc 309@item -padbottom size
4c5f7207 310Set bottom pad band size (in pixels).
1ff93ffc 311@item -padleft size
4c5f7207 312Set left pad band size (in pixels).
1ff93ffc 313@item -padright size
4c5f7207 314Set right pad band size (in pixels).
5b79a73e 315@item -padcolor (hex color)
4c5f7207
DB
316Set color of padded bands. The value for padcolor is expressed
317as a six digit hexadecimal number where the first two digits
318represent red, the middle two digits green and last two digits
319blue (default = 000000 (black)).
9181577c 320@item -vn
4c5f7207 321Disable video recording.
115329f1 322@item -bt tolerance
dc5ee8bc 323Set video bitrate tolerance (in bit/s).
18bff752 324@item -maxrate bitrate
a5515106 325Set max video bitrate tolerance (in bit/s).
18bff752 326@item -minrate bitrate
a5515106 327Set min video bitrate tolerance (in bit/s).
18bff752 328@item -bufsize size
81d0618f 329Set rate control buffer size (in bits).
115329f1 330@item -vcodec codec
4c5f7207 331Force video codec to @var{codec}. Use the @code{copy} special value to
5ee03c86 332tell that the raw codec data must be copied as is.
18bff752 333@item -sameq
4c5f7207 334Use same video quality as source (implies VBR).
9181577c 335
115329f1 336@item -pass n
4c5f7207
DB
337Select the pass number (1 or 2). It is useful to do two pass
338encoding. The statistics of the video are recorded in the first
339pass and the video is generated at the exact requested bitrate
340in the second pass.
9181577c 341
115329f1 342@item -passlogfile file
4c5f7207 343Set two pass logfile name to @var{file}.
9181577c 344
4386f941
DB
345@item -newvideo
346Add a new video stream to the current output stream.
347
9181577c
FB
348@end table
349
18bff752 350@section Advanced Video Options
9181577c 351
e99c4e10 352@table @option
4386f941
DB
353@item -pix_fmt format
354Set pixel format.
115329f1 355@item -g gop_size
4c5f7207 356Set the group of pictures size.
115329f1 357@item -intra
4c5f7207 358Use only intra frames.
4386f941
DB
359@item -vdt n
360Discard threshold.
115329f1 361@item -qscale q
4bef236b 362Use fixed video quantizer scale (VBR).
115329f1 363@item -qmin q
4bef236b 364minimum video quantizer scale (VBR)
115329f1 365@item -qmax q
4bef236b 366maximum video quantizer scale (VBR)
115329f1 367@item -qdiff q
4bef236b 368maximum difference between the quantizer scales (VBR)
115329f1 369@item -qblur blur
4bef236b 370video quantizer scale blur (VBR)
115329f1 371@item -qcomp compression
4bef236b 372video quantizer scale compression (VBR)
18bff752 373
9ae711e1
VP
374@item -lmin lambda
375minimum video lagrange factor (VBR)
376@item -lmax lambda
377max video lagrange factor (VBR)
378@item -mblmin lambda
379minimum macroblock quantizer scale (VBR)
380@item -mblmax lambda
381maximum macroblock quantizer scale (VBR)
382
383These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
384but you may use the QP2LAMBDA constant to easily convert from 'q' units:
385@example
386ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
387@end example
388
18bff752 389@item -rc_init_cplx complexity
4c5f7207 390initial complexity for single pass encoding
18bff752 391@item -b_qfactor factor
4c5f7207 392qp factor between P- and B-frames
18bff752 393@item -i_qfactor factor
4c5f7207 394qp factor between P- and I-frames
18bff752 395@item -b_qoffset offset
4c5f7207 396qp offset between P- and B-frames
18bff752 397@item -i_qoffset offset
4c5f7207 398qp offset between P- and I-frames
18bff752 399@item -rc_eq equation
4c5f7207
DB
400Set rate control equation (@pxref{FFmpeg formula
401evaluator}) (default = @code{tex^qComp}).
5ee03c86
FB
402@item -rc_override override
403rate control override for specific intervals
18bff752 404@item -me method
4c5f7207
DB
405Set motion estimation method to @var{method}.
406Available methods are (from lowest to best quality):
18bff752
FB
407@table @samp
408@item zero
5ee03c86 409Try just the (0, 0) vector.
18bff752
FB
410@item phods
411@item log
412@item x1
413@item epzs
414(default method)
415@item full
416exhaustive search (slow and marginally better than epzs)
417@end table
418
419@item -dct_algo algo
4c5f7207 420Set DCT algorithm to @var{algo}. Available values are:
18bff752
FB
421@table @samp
422@item 0
423FF_DCT_AUTO (default)
424@item 1
425FF_DCT_FASTINT
426@item 2
427FF_DCT_INT
428@item 3
429FF_DCT_MMX
430@item 4
431FF_DCT_MLIB
432@item 5
433FF_DCT_ALTIVEC
434@end table
435
436@item -idct_algo algo
4c5f7207 437Set IDCT algorithm to @var{algo}. Available values are:
18bff752
FB
438@table @samp
439@item 0
440FF_IDCT_AUTO (default)
441@item 1
115329f1 442FF_IDCT_INT
18bff752 443@item 2
115329f1 444FF_IDCT_SIMPLE
18bff752 445@item 3
115329f1 446FF_IDCT_SIMPLEMMX
18bff752 447@item 4
115329f1 448FF_IDCT_LIBMPEG2MMX
18bff752 449@item 5
115329f1 450FF_IDCT_PS2
18bff752 451@item 6
115329f1 452FF_IDCT_MLIB
18bff752 453@item 7
115329f1 454FF_IDCT_ARM
18bff752 455@item 8
115329f1 456FF_IDCT_ALTIVEC
18bff752 457@item 9
115329f1 458FF_IDCT_SH4
18bff752 459@item 10
115329f1 460FF_IDCT_SIMPLEARM
18bff752
FB
461@end table
462
463@item -er n
4c5f7207 464Set error resilience to @var{n}.
18bff752 465@table @samp
115329f1 466@item 1
1471c6c2 467FF_ER_CAREFUL (default)
18bff752 468@item 2
5ee03c86 469FF_ER_COMPLIANT
18bff752
FB
470@item 3
471FF_ER_AGGRESSIVE
472@item 4
473FF_ER_VERY_AGGRESSIVE
474@end table
475
5ee03c86 476@item -ec bit_mask
4c5f7207 477Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
5ee03c86 478the following values:
18bff752
FB
479@table @samp
480@item 1
4c5f7207 481FF_EC_GUESS_MVS (default = enabled)
18bff752 482@item 2
4c5f7207 483FF_EC_DEBLOCK (default = enabled)
18bff752
FB
484@end table
485
486@item -bf frames
4c5f7207 487Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
18bff752
FB
488@item -mbd mode
489macroblock decision
490@table @samp
491@item 0
4c5f7207 492FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
18bff752 493@item 1
4c5f7207 494FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
18bff752 495@item 2
019c8838 496FF_MB_DECISION_RD: rate distortion
18bff752
FB
497@end table
498
499@item -4mv
4c5f7207 500Use four motion vector by macroblock (MPEG-4 only).
18bff752 501@item -part
4c5f7207 502Use data partitioning (MPEG-4 only).
18bff752 503@item -bug param
4c5f7207 504Work around encoder bugs that are not auto-detected.
18bff752 505@item -strict strictness
4c5f7207 506How strictly to follow the standards.
5ee03c86 507@item -aic
4c5f7207 508Enable Advanced intra coding (h263+).
5ee03c86 509@item -umv
4c5f7207 510Enable Unlimited Motion Vector (h263+)
18bff752
FB
511
512@item -deinterlace
4c5f7207 513Deinterlace pictures.
3841e813 514@item -ilme
4c5f7207
DB
515Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
516Use this option if your input file is interlaced and you want
517to keep the interlaced format for minimum losses.
518The alternative is to deinterlace the input stream with
519@option{-deinterlace}, but deinterlacing introduces losses.
18bff752 520@item -psnr
4c5f7207 521Calculate PSNR of compressed frames.
18bff752 522@item -vstats
4c5f7207 523Dump video coding statistics to @file{vstats_HHMMSS.log}.
18bff752 524@item -vhook module
4c5f7207 525Insert video processing @var{module}. @var{module} contains the module
18bff752 526name and its parameters separated by spaces.
4386f941
DB
527@item -top n
528top=1/bottom=0/auto=-1 field first
529@item -dc precision
530Intra_dc_precision.
531@item -vtag fourcc/tag
532Force video tag/fourcc.
533@item -qphist
534Show QP histogram.
535@item -vbsf bitstream filter
536Bitstream filters available are "dump_extra", "remove_extra", "noise".
18bff752
FB
537@end table
538
539@section Audio Options
540
541@table @option
4386f941
DB
542@item -aframes number
543Set the number of audio frames to record.
115329f1 544@item -ar freq
4c5f7207 545Set the audio sampling frequency (default = 44100 Hz).
115329f1 546@item -ab bitrate
4c5f7207 547Set the audio bitrate in kbit/s (default = 64).
18bff752 548@item -ac channels
4c5f7207 549Set the number of audio channels (default = 1).
5ee03c86 550@item -an
4c5f7207 551Disable audio recording.
5ee03c86 552@item -acodec codec
4c5f7207
DB
553Force audio codec to @var{codec}. Use the @code{copy} special value to
554specify that the raw codec data must be copied as is.
de62a89d 555@item -newaudio
18fd519f
DB
556Add a new audio track to the output file. If you want to specify parameters,
557do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
de62a89d 558
18fd519f
DB
559Mapping will be done automatically, if the number of output streams is equal to
560the number of input streams, else it will pick the first one that matches. You
de62a89d
VP
561can override the mapping using @code{-map} as usual.
562
563Example:
564@example
565ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384 test.mpg -acodec mp2 -ab 192 -newaudio
566@end example
4386f941
DB
567@item -alang code
568Set the ISO 639 language code (3 letters) of the current audio stream.
569@end table
570
571@section Advanced Audio options:
572
573@table @option
574@item -atag fourcc/tag
575Force audio tag/fourcc.
576@item -absf bitstream filter
577Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
578@end table
579
580@section Subtitle options:
581
582@table @option
583@item -scodec codec
584Force subtitle codec ('copy' to copy stream).
585@item -newsubtitle
586Add a new subtitle stream to the current output stream.
587@item -slang code
588Set the ISO 639 language code (3 letters) of the current subtitle stream.
18bff752
FB
589@end table
590
591@section Audio/Video grab options
592
593@table @option
594@item -vd device
4c5f7207 595sEt video grab device (e.g. @file{/dev/video0}).
18bff752 596@item -vc channel
4c5f7207 597Set video grab channel (DV1394 only).
18bff752 598@item -tvstd standard
4c5f7207 599Set television standard (NTSC, PAL (SECAM)).
18bff752 600@item -dv1394
4c5f7207 601Set DV1394 grab.
18bff752 602@item -ad device
4c5f7207 603Set audio device (e.g. @file{/dev/dsp}).
4386f941
DB
604@item -grab format
605Request grabbing using.
606@item -gd device
607Set grab device.
18bff752
FB
608@end table
609
610@section Advanced options
611
612@table @option
e645a733
BL
613@item -map input stream id[:input stream id]
614Set stream mapping from input streams to output streams.
615Just enumerate the input streams in the order you want them in the output.
616[input stream id] sets the (input) stream to sync against.
4386f941
DB
617@item -map_meta_data outfile:infile
618Set meta data information of outfile from infile.
18bff752 619@item -debug
4c5f7207 620Print specific debug info.
115329f1 621@item -benchmark
4c5f7207 622Add timings for benchmarking.
4386f941 623@item -dump
4c5f7207 624Dump each input packet.
4386f941
DB
625@item -hex
626When dumping packets, also dump the payload.
18bff752 627@item -bitexact
4c5f7207 628Only use bit exact algorithms (for codec testing).
18bff752 629@item -ps size
4c5f7207 630Set packet size in bits.
5ee03c86 631@item -re
4c5f7207 632Read input at native frame rate. Mainly used to simulate a grab device.
4386f941 633@item -loop_input
4c5f7207
DB
634Loop over the input stream. Currently it works only for image
635streams. This option is used for automatic FFserver testing.
8108551a 636@item -loop_output number_of_times
019c8838 637Repeatedly loop output for formats that support looping such as animated GIF
4c5f7207 638(0 will loop the output infinitely).
4386f941
DB
639@item -threads count
640Thread count.
c52e13f1 641@item -vsync parameter
29c9183c
DB
642Video sync method. Video will be stretched/squeezed to match the timestamps,
643it is done by duplicating and dropping frames. With -map you can select from
644which stream the timestamps should be taken. You can leave either video or
c52e13f1
BL
645audio unchanged and sync the remaining stream(s) to the unchanged one.
646@item -async samples_per_second
29c9183c 647Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
c52e13f1
BL
648the parameter is the maximum samples per second by which the audio is changed.
649-async 1 is a special case where only the start of the audio stream is corrected
650without any later correction.
9181577c 651@end table
18bff752
FB
652
653@node FFmpeg formula evaluator
654@section FFmpeg formula evaluator
655
656When evaluating a rate control string, FFmpeg uses an internal formula
115329f1 657evaluator.
18bff752
FB
658
659The following binary operators are available: @code{+}, @code{-},
660@code{*}, @code{/}, @code{^}.
661
662The following unary operators are available: @code{+}, @code{-},
663@code{(...)}.
664
665The following functions are available:
666@table @var
667@item sinh(x)
668@item cosh(x)
669@item tanh(x)
670@item sin(x)
671@item cos(x)
672@item tan(x)
673@item exp(x)
674@item log(x)
675@item squish(x)
676@item gauss(x)
677@item abs(x)
678@item max(x, y)
679@item min(x, y)
680@item gt(x, y)
681@item lt(x, y)
682@item eq(x, y)
683@item bits2qp(bits)
684@item qp2bits(qp)
685@end table
686
687The following constants are available:
688@table @var
689@item PI
690@item E
691@item iTex
692@item pTex
693@item tex
694@item mv
695@item fCode
696@item iCount
697@item mcVar
698@item var
699@item isI
700@item isP
701@item isB
702@item avgQP
703@item qComp
704@item avgIITex
705@item avgPITex
706@item avgPPTex
707@item avgBPTex
708@item avgTex
709@end table
710
e99c4e10
FB
711@c man end
712
713@ignore
714
715@setfilename ffmpeg
716@settitle FFmpeg video converter
717
718@c man begin SEEALSO
019c8838 719ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
e99c4e10
FB
720@c man end
721
722@c man begin AUTHOR
723Fabrice Bellard
724@c man end
725
726@end ignore
9181577c
FB
727
728@section Protocols
729
4c5f7207
DB
730The filename can be @file{-} to read from standard input or to write
731to standard output.
9181577c 732
4c5f7207 733FFmpeg also handles many protocols specified with an URL syntax.
9181577c 734
4c5f7207 735Use 'ffmpeg -formats' to see a list of the supported protocols.
9181577c 736
e99c4e10 737The protocol @code{http:} is currently used only to communicate with
4c5f7207 738FFserver (see the FFserver documentation). When FFmpeg will be a
e99c4e10 739video player it will also be used for streaming :-)
9181577c
FB
740
741@chapter Tips
742
743@itemize
4c5f7207
DB
744@item For streaming at very low bitrate application, use a low frame rate
745and a small GOP size. This is especially true for RealVideo where
e99c4e10
FB
746the Linux player does not seem to be very fast, so it can miss
747frames. An example is:
9181577c
FB
748
749@example
3c0ba870 750ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
9181577c
FB
751@end example
752
753@item The parameter 'q' which is displayed while encoding is the current
4c5f7207
DB
754quantizer. The value 1 indicates that a very good quality could
755be achieved. The value 31 indicates the worst quality. If q=31 appears
e99c4e10 756too often, it means that the encoder cannot compress enough to meet
4c5f7207 757your bitrate. You must either increase the bitrate, decrease the
e99c4e10 758frame rate or decrease the frame size.
9181577c
FB
759
760@item If your computer is not fast enough, you can speed up the
e99c4e10
FB
761compression at the expense of the compression ratio. You can use
762'-me zero' to speed up motion estimation, and '-intra' to disable
4c5f7207 763motion estimation completely (you have only I-frames, which means it
e99c4e10 764is about as good as JPEG compression).
9181577c 765
4c5f7207 766@item To have very low audio bitrates, reduce the sampling frequency
019c8838 767(down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
9181577c
FB
768
769@item To have a constant quality (but a variable bitrate), use the option
e99c4e10
FB
770'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
771quality).
9181577c
FB
772
773@item When converting video files, you can use the '-sameq' option which
4c5f7207
DB
774uses the same quality factor in the encoder as in the decoder.
775It allows almost lossless encoding.
9181577c
FB
776
777@end itemize
778
47404f9f
DB
779
780@chapter external libraries
781
782FFmpeg can be hooked up with a number of external libraries to add support
783for more formats.
784
785@section AMR
786
787AMR comes in two different flavors, WB and NB. FFmpeg can make use of the
788AMR WB (floating-point mode) and the AMR NB (both floating-point and
789fixed-point mode) reference decoders and encoders.
790
791@itemize
792
793@item For AMR WB floating-point download TS26.204 V5.1.0 from
794@url{http://www.3gpp.org/ftp/Specs/archive/26_series/26.204/26204-510.zip}
795and extract the source to @file{libavcodec/amrwb_float/}.
796
797@item For AMR NB floating-point download TS26.104 REL-5 V5.1.0 from
798@url{http://www.3gpp.org/ftp/Specs/archive/26_series/26.104/26104-510.zip}
799and extract the source to @file{libavcodec/amr_float/}.
800If you try this on Alpha, you may need to change @code{Word32} to
801@code{int} in @file{amr/typedef.h}.
802
803@item For AMR NB fixed-point download TS26.073 REL-5 V5.1.0 from
804@url{http://www.3gpp.org/ftp/Specs/archive/26_series/26.073/26073-510.zip}
805and extract the source to @file{libavcodec/amr}.
806You must also add @code{-DMMS_IO} and remove @code{-pedantic-errors}
807to/from @code{CFLAGS} in @file{libavcodec/amr/makefile}, i.e.
808``@code{CFLAGS = -Wall -I. \$(CFLAGS_\$(MODE)) -D\$(VAD) -DMMS_IO}''.
809
810@end itemize
811
812
9181577c
FB
813@chapter Supported File Formats and Codecs
814
815You can use the @code{-formats} option to have an exhaustive list.
816
817@section File Formats
818
6bf40f39 819FFmpeg supports the following file formats through the @code{libavformat}
0699d2fe 820library:
9181577c 821
3fc9e78f 822@multitable @columnfractions .4 .1 .1 .4
9181577c
FB
823@item Supported File Format @tab Encoding @tab Decoding @tab Comments
824@item MPEG audio @tab X @tab X
4c5f7207 825@item MPEG-1 systems @tab X @tab X
9181577c 826@tab muxed audio and video
4c5f7207 827@item MPEG-2 PS @tab X @tab X
9181577c 828@tab also known as @code{VOB} file
4c5f7207 829@item MPEG-2 TS @tab @tab X
9181577c 830@tab also known as DVB Transport Stream
115329f1
DB
831@item ASF@tab X @tab X
832@item AVI@tab X @tab X
833@item WAV@tab X @tab X
9181577c 834@item Macromedia Flash@tab X @tab X
4c5f7207 835@tab Only embedded audio is decoded.
2eb5d024
FB
836@item FLV @tab X @tab X
837@tab Macromedia Flash video files
115329f1
DB
838@item Real Audio and Video @tab X @tab X
839@item Raw AC3 @tab X @tab X
840@item Raw MJPEG @tab X @tab X
841@item Raw MPEG video @tab X @tab X
842@item Raw PCM8/16 bits, mulaw/Alaw@tab X @tab X
843@item Raw CRI ADX audio @tab X @tab X
844@item Raw Shorten audio @tab @tab X
845@item SUN AU format @tab X @tab X
7fe4c823 846@item NUT @tab X @tab X @tab NUT Open Container Format
115329f1 847@item QuickTime @tab X @tab X
4c5f7207
DB
848@item MPEG-4 @tab X @tab X
849@tab MPEG-4 is a variant of QuickTime.
115329f1 850@item Raw MPEG4 video @tab X @tab X
4fa1c4fa 851@item DV @tab X @tab X
701b603d 852@item 4xm @tab @tab X
4c5f7207 853@tab 4X Technologies format, used in some games.
4d3b1f8d
MM
854@item Playstation STR @tab @tab X
855@item Id RoQ @tab @tab X
4c5f7207 856@tab Used in Quake III, Jedi Knight 2, other computer games.
4d3b1f8d 857@item Interplay MVE @tab @tab X
4c5f7207 858@tab Format used in various Interplay computer games.
b17e9c99 859@item WC3 Movie @tab @tab X
4c5f7207 860@tab Multimedia format used in Origin's Wing Commander III computer game.
2fdf638b 861@item Sega FILM/CPK @tab @tab X
4c5f7207 862@tab Used in many Sega Saturn console games.
2fdf638b 863@item Westwood Studios VQA/AUD @tab @tab X
4c5f7207 864@tab Multimedia formats used in Westwood Studios games.
4120a53a 865@item Id Cinematic (.cin) @tab @tab X
4c5f7207 866@tab Used in Quake II.
42cad81a
MM
867@item FLIC format @tab @tab X
868@tab .fli/.flc files
da00f30e 869@item Sierra VMD @tab @tab X
4c5f7207 870@tab Used in Sierra CD-ROM games.
d08d7142 871@item Sierra Online @tab @tab X
4c5f7207 872@tab .sol files used in Sierra Online games.
38088adf 873@item Matroska @tab @tab X
ad81a9fe 874@item Electronic Arts Multimedia @tab @tab X
4c5f7207 875@tab Used in various EA games; files have extensions like WVE and UV2.
353147ed 876@item Nullsoft Video (NSV) format @tab @tab X
4accd1fd 877@item ADTS AAC audio @tab X @tab X
ea395e8c 878@item Creative VOC @tab X @tab X @tab Created for the Sound Blaster Pro.
4e114829
MM
879@item American Laser Games MM @tab @tab X
880@tab Multimedia format used in games like Mad Dog McCree
26376701
MM
881@item AVS @tab @tab X
882@tab Multimedia format used by the Creature Shock game.
348efc18
KS
883@item Smacker @tab @tab X
884@tab Multimedia format used by many games.
d7a3a783
BC
885@item GXF @tab X @tab X
886@tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley playout servers.
dc56e0de
BC
887@item CIN @tab @tab X
888@tab Multimedia format used by Delphine Software games.
f3239539
BC
889@item MXF @tab @tab X
890@tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
29f86228
BC
891@item SEQ @tab @tab X
892@tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
353147ed 893@end multitable
9181577c 894
4c5f7207 895@code{X} means that encoding (resp. decoding) is supported.
9181577c 896
0699d2fe
FB
897@section Image Formats
898
899FFmpeg can read and write images for each frame of a video sequence. The
900following image formats are supported:
901
3fc9e78f 902@multitable @columnfractions .4 .1 .1 .4
0699d2fe 903@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
115329f1 904@item PGM, PPM @tab X @tab X
4c5f7207 905@item PAM @tab X @tab X @tab PAM is a PNM extension with alpha support.
2eb5d024 906@item PGMYUV @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
4c5f7207
DB
907@item JPEG @tab X @tab X @tab Progressive JPEG is not supported.
908@item .Y.U.V @tab X @tab X @tab one raw file per component
909@item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
910@item PNG @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
3689cf16 911@item Targa @tab @tab X @tab Targa (.TGA) image format.
a991b1fe 912@item TIFF @tab @tab X @tab Only 24 bit/pixel images are supported.
6a91ec51 913@item SGI @tab X @tab X @tab SGI RGB image format
0699d2fe
FB
914@end multitable
915
4c5f7207 916@code{X} means that encoding (resp. decoding) is supported.
0699d2fe 917
9181577c
FB
918@section Video Codecs
919
3fc9e78f 920@multitable @columnfractions .4 .1 .1 .4
9181577c 921@item Supported Codec @tab Encoding @tab Decoding @tab Comments
4c5f7207
DB
922@item MPEG-1 video @tab X @tab X
923@item MPEG-2 video @tab X @tab X
2bc5da7b 924@item MPEG-4 @tab X @tab X
9181577c
FB
925@item MSMPEG4 V1 @tab X @tab X
926@item MSMPEG4 V2 @tab X @tab X
2bc5da7b 927@item MSMPEG4 V3 @tab X @tab X
9181577c 928@item WMV7 @tab X @tab X
4c5f7207 929@item WMV8 @tab X @tab X @tab not completely working
17a21f3c
DB
930@item WMV9 @tab @tab X @tab not completely working
931@item VC1 @tab @tab X
b06b45c4 932@item H.261 @tab X @tab X
4c5f7207 933@item H.263(+) @tab X @tab X @tab also known as RealVideo 1.0
b06b45c4 934@item H.264 @tab @tab X
e839a994
DB
935@item RealVideo 1.0 @tab X @tab X
936@item RealVideo 2.0 @tab X @tab X
115329f1 937@item MJPEG @tab X @tab X
4c5f7207 938@item lossless MJPEG @tab X @tab X
26d6d032 939@item JPEG-LS @tab X @tab X @tab fourcc: MJLS, lossless and near-lossless is supported
d6896c49
AB
940@item Apple MJPEG-B @tab @tab X
941@item Sunplus MJPEG @tab @tab X @tab fourcc: SP5X
115329f1 942@item DV @tab X @tab X
4c5f7207
DB
943@item HuffYUV @tab X @tab X
944@item FFmpeg Video 1 @tab X @tab X @tab experimental lossless codec (fourcc: FFV1)
945@item FFmpeg Snow @tab X @tab X @tab experimental wavelet codec (fourcc: SNOW)
701b603d 946@item Asus v1 @tab X @tab X @tab fourcc: ASV1
4d3b1f8d 947@item Asus v2 @tab X @tab X @tab fourcc: ASV2
701b603d 948@item Creative YUV @tab @tab X @tab fourcc: CYUV
d2bfadc0 949@item Sorenson Video 1 @tab X @tab X @tab fourcc: SVQ1
701b603d
MM
950@item Sorenson Video 3 @tab @tab X @tab fourcc: SVQ3
951@item On2 VP3 @tab @tab X @tab still experimental
5ce117c3
AJ
952@item On2 VP5 @tab @tab X @tab fourcc: VP50
953@item On2 VP6 @tab @tab X @tab fourcc: VP62
d6896c49 954@item Theora @tab @tab X @tab still experimental
cdb2c1ca 955@item Intel Indeo 3 @tab @tab X
9303d49c 956@item FLV @tab X @tab X @tab Sorenson H.263 used in Flash
0919e788 957@item Flash Screen Video @tab @tab X @tab fourcc: FSV1
4d3b1f8d 958@item ATI VCR1 @tab @tab X @tab fourcc: VCR1
7fe4c823 959@item ATI VCR2 @tab @tab X @tab fourcc: VCR2
4d3b1f8d 960@item Cirrus Logic AccuPak @tab @tab X @tab fourcc: CLJR
4c5f7207 961@item 4X Video @tab @tab X @tab Used in certain computer games.
115329f1 962@item Sony Playstation MDEC @tab @tab X
4c5f7207
DB
963@item Id RoQ @tab @tab X @tab Used in Quake III, Jedi Knight 2, other computer games.
964@item Xan/WC3 @tab @tab X @tab Used in Wing Commander III .MVE files.
965@item Interplay Video @tab @tab X @tab Used in Interplay .MVE files.
070ed1bc 966@item Apple Animation @tab @tab X @tab fourcc: 'rle '
42cad81a 967@item Apple Graphics @tab @tab X @tab fourcc: 'smc '
2fdf638b 968@item Apple Video @tab @tab X @tab fourcc: rpza
d08d7142 969@item Apple QuickDraw @tab @tab X @tab fourcc: qdrw
2fdf638b
MM
970@item Cinepak @tab @tab X
971@item Microsoft RLE @tab @tab X
972@item Microsoft Video-1 @tab @tab X
4120a53a 973@item Westwood VQA @tab @tab X
4c5f7207 974@item Id Cinematic Video @tab @tab X @tab Used in Quake II.
1dc1ed99 975@item Planar RGB @tab @tab X @tab fourcc: 8BPS
42cad81a 976@item FLIC video @tab @tab X
9a4117d5 977@item Duck TrueMotion v1 @tab @tab X @tab fourcc: DUCK
dce76c20 978@item Duck TrueMotion v2 @tab @tab X @tab fourcc: TM20
4c5f7207 979@item VMD Video @tab @tab X @tab Used in Sierra VMD files.
a273bbfb
RT
980@item MSZH @tab @tab X @tab Part of LCL
981@item ZLIB @tab X @tab X @tab Part of LCL, encoder experimental
9d53d58e 982@item TechSmith Camtasia @tab @tab X @tab fourcc: TSCC
d0a0bbd2 983@item IBM Ultimotion @tab @tab X @tab fourcc: ULTI
ab711b3c 984@item Miro VideoXL @tab @tab X @tab fourcc: VIXL
acfd8f0f 985@item QPEG @tab @tab X @tab fourccs: QPEG, Q1.0, Q1.1
115329f1
DB
986@item LOCO @tab @tab X @tab
987@item Winnov WNV1 @tab @tab X @tab
589f8220 988@item Autodesk Animator Studio Codec @tab @tab X @tab fourcc: AASC
115329f1 989@item Fraps FPS1 @tab @tab X @tab
2b6c1d80 990@item CamStudio @tab @tab X @tab fourcc: CSCD
4e114829 991@item American Laser Games Video @tab @tab X @tab Used in games like Mad Dog McCree
9c8d8e84 992@item ZMBV @tab @tab X @tab
26376701 993@item AVS Video @tab @tab X @tab Video encoding used by the Creature Shock game.
348efc18 994@item Smacker Video @tab @tab X @tab Video encoding used in Smacker.
dfca23e3 995@item RTjpeg @tab @tab X @tab Video encoding used in NuppelVideo files.
fd7b1991 996@item KMVC @tab @tab X @tab Codec used in Worms games.
eb57c889 997@item VMware Video @tab @tab X @tab Codec used in videos captured by VMware.
dc56e0de 998@item Cin Video @tab @tab X @tab Codec used in Delphine Software games.
29f86228 999@item Tiertex Seq Video @tab @tab X @tab Codec used in DOS CDROM FlashBack game.
9181577c
FB
1000@end multitable
1001
4c5f7207 1002@code{X} means that encoding (resp. decoding) is supported.
9181577c
FB
1003
1004@section Audio Codecs
1005
1006@multitable @columnfractions .4 .1 .1 .1 .7
1007@item Supported Codec @tab Encoding @tab Decoding @tab Comments
115329f1 1008@item MPEG audio layer 2 @tab IX @tab IX
9181577c 1009@item MPEG audio layer 1/3 @tab IX @tab IX
4c5f7207 1010@tab MP3 encoding is supported through the external library LAME.
37776c3b 1011@item AC3 @tab IX @tab IX
4c5f7207 1012@tab liba52 is used internally for decoding.
34d7008d 1013@item Vorbis @tab X @tab X
4745b5bf 1014@item WMA V1/V2 @tab @tab X
f6fa7a6c 1015@item AAC @tab X @tab X
4c5f7207 1016@tab Supported through the external library libfaac/libfaad.
d4c3c5a6 1017@item Microsoft ADPCM @tab X @tab X
4d3b1f8d
MM
1018@item MS IMA ADPCM @tab X @tab X
1019@item QT IMA ADPCM @tab @tab X
1020@item 4X IMA ADPCM @tab @tab X
d4e437df 1021@item G.726 ADPCM @tab X @tab X
b17e9c99 1022@item Duck DK3 IMA ADPCM @tab @tab X
4c5f7207 1023@tab Used in some Sega Saturn console games.
b17e9c99 1024@item Duck DK4 IMA ADPCM @tab @tab X
4c5f7207 1025@tab Used in some Sega Saturn console games.
2fdf638b 1026@item Westwood Studios IMA ADPCM @tab @tab X
4c5f7207 1027@tab Used in Westwood Studios games like Command and Conquer.
7d8379f2 1028@item SMJPEG IMA ADPCM @tab @tab X
4c5f7207 1029@tab Used in certain Loki game ports.
42cad81a
MM
1030@item CD-ROM XA ADPCM @tab @tab X
1031@item CRI ADX ADPCM @tab X @tab X
4c5f7207 1032@tab Used in Sega Dreamcast games.
7d8379f2 1033@item Electronic Arts ADPCM @tab @tab X
4c5f7207 1034@tab Used in various EA titles.
b3bfb299 1035@item Creative ADPCM @tab @tab X
2433f24f 1036@tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
2eb5d024
FB
1037@item RA144 @tab @tab X
1038@tab Real 14400 bit/s codec
1039@item RA288 @tab @tab X
1040@tab Real 28800 bit/s codec
37776c3b 1041@item RADnet @tab X @tab IX
4c5f7207 1042@tab Real low bitrate AC3 codec, liba52 is used for decoding.
2eb5d024 1043@item AMR-NB @tab X @tab X
4c5f7207 1044@tab Supported through an external library.
d663a1fd 1045@item AMR-WB @tab X @tab X
4c5f7207 1046@tab Supported through an external library.
2eb5d024 1047@item DV audio @tab @tab X
4d3b1f8d 1048@item Id RoQ DPCM @tab @tab X
4c5f7207 1049@tab Used in Quake III, Jedi Knight 2, other computer games.
4d3b1f8d 1050@item Interplay MVE DPCM @tab @tab X
4c5f7207 1051@tab Used in various Interplay computer games.
b17e9c99 1052@item Xan DPCM @tab @tab X
4c5f7207 1053@tab Used in Origin's Wing Commander IV AVI files.
d08d7142 1054@item Sierra Online DPCM @tab @tab X
4c5f7207 1055@tab Used in Sierra Online game audio files.
d6896c49
AB
1056@item Apple MACE 3 @tab @tab X
1057@item Apple MACE 6 @tab @tab X
13dfd2b9
MM
1058@item FLAC lossless audio @tab @tab X
1059@item Shorten lossless audio @tab @tab X
f770ee03
MM
1060@item Apple lossless audio @tab @tab X
1061@tab QuickTime fourcc 'alac'
33a4d8b1 1062@item FFmpeg Sonic @tab X @tab X
4c5f7207 1063@tab experimental lossy/lossless codec
d9b1c197
RT
1064@item Qdesign QDM2 @tab @tab X
1065@tab there are still some distortions
440e7988
RT
1066@item Real COOK @tab @tab X
1067@tab All versions except 5.1 are supported
e839a994 1068@item DSP Group TrueSpeech @tab @tab X
3dc411c0 1069@item True Audio (TTA) @tab @tab X
348efc18 1070@item Smacker Audio @tab @tab X
730581f3 1071@item WavPack Audio @tab @tab X
dc56e0de
BC
1072@item Cin Audio @tab @tab X
1073@tab Codec used in Delphine Software games.
84ed36da 1074@item Intel Music Coder @tab @tab X
9181577c
FB
1075@end multitable
1076
4c5f7207 1077@code{X} means that encoding (resp. decoding) is supported.
9181577c 1078
4c5f7207
DB
1079@code{I} means that an integer-only version is available, too (ensures high
1080performance on systems without hardware floating point support).
9181577c 1081
47d944d2
FB
1082@chapter Platform Specific information
1083
1084@section Linux
1085
4c5f7207
DB
1086FFmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
1087preferred compiler now for FFmpeg. All future optimizations will depend on
47d944d2
FB
1088features only found in GCC 3.2.
1089
1090@section BSD
1091
21d1cb12
DB
1092BSD make will not build FFmpeg, you need to install and use GNU Make
1093(@file{gmake}).
1094
47d944d2
FB
1095@section Windows
1096
b030b284
FB
1097@subsection Native Windows compilation
1098
1099@itemize
1100@item Install the current versions of MSYS and MinGW from
1101@url{http://www.mingw.org/}. You can find detailed installation
1102instructions in the download section and the FAQ.
1103
4c5f7207 1104@item If you want to test the FFplay, also download
50f52fcd
FB
1105the MinGW development library of SDL 1.2.x
1106(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
4c5f7207 1107@url{http://www.libsdl.org}. Unpack it in a temporary directory, and
50f52fcd 1108unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
988a9f9e
FB
1109directory. Edit the @file{sdl-config} script so that it gives the
1110correct SDL directory when invoked.
50f52fcd 1111
e926e391 1112@item Extract the current version of FFmpeg.
115329f1 1113
b030b284
FB
1114@item Start the MSYS shell (file @file{msys.bat}).
1115
4c5f7207
DB
1116@item Change to the FFmpeg directory and follow
1117 the instructions of how to compile FFmpeg (file
50f52fcd
FB
1118@file{INSTALL}). Usually, launching @file{./configure} and @file{make}
1119suffices. If you have problems using SDL, verify that
1120@file{sdl-config} can be launched from the MSYS command line.
1121
4c5f7207
DB
1122@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing
1123@file{make install}. Don't forget to copy @file{SDL.dll} to the place
1124you launch @file{ffplay} from.
50f52fcd 1125
b030b284
FB
1126@end itemize
1127
115329f1 1128Notes:
988a9f9e 1129@itemize
50f52fcd 1130
988a9f9e
FB
1131@item The target @file{make wininstaller} can be used to create a
1132Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
4c5f7207 1133must be copied to the FFmpeg directory in order to build the
988a9f9e
FB
1134installer.
1135
4c5f7207 1136@item By using @code{./configure --enable-shared} when configuring FFmpeg,
988a9f9e
FB
1137you can build @file{avcodec.dll} and @file{avformat.dll}. With
1138@code{make install} you install the FFmpeg DLLs and the associated
115329f1 1139headers in @file{Program Files/FFmpeg}.
988a9f9e 1140
4c5f7207
DB
1141@item Visual C++ compatibility: If you used @code{./configure --enable-shared}
1142when configuring FFmpeg, FFmpeg tries to use the Microsoft Visual
988a9f9e 1143C++ @code{lib} tool to build @code{avcodec.lib} and
4c5f7207 1144@code{avformat.lib}. With these libraries you can link your Visual C++
be0efc0c 1145code directly with the FFmpeg DLLs (see below).
988a9f9e
FB
1146
1147@end itemize
b030b284 1148
be0efc0c
MB
1149@subsection Visual C++ compatibility
1150
1151FFmpeg will not compile under Visual C++ -- and it has too many
1152dependencies on the GCC compiler to make a port viable. However,
1153if you want to use the FFmpeg libraries in your own applications,
1154you can still compile those applications using Visual C++. An
1155important restriction to this is that you have to use the
1156dynamically linked versions of the FFmpeg libraries (i.e. the
1157DLLs), and you have to make sure that Visual-C++-compatible
1158import libraries are created during the FFmpeg build process.
1159
1160This description of how to use the FFmpeg libraries with Visual C++ is
1161based on Visual C++ 2005 Express Edition Beta 2. If you have a different
1162version, you might have to modify the procedures slightly.
1163
1164Here are the step-by-step instructions for building the FFmpeg libraries
1165so they can be used with Visual C++:
1166
1167@enumerate
1168
1169@item Install Visual C++ (if you haven't done so already).
1170
1171@item Install MinGW and MSYS as described above.
1172
1173@item Add a call to @file{vcvars32.bat} (which sets up the environment
1174variables for the Visual C++ tools) as the first line of
1175@file{msys.bat}. The standard location for @file{vcvars32.bat} is
1176@file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
1177and the standard location for @file{msys.bat} is
1178@file{C:\msys\1.0\msys.bat}. If this corresponds to your setup, add the
1179following line as the first line of @file{msys.bat}:
1180
1181@code{call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"}
1182
1183@item Start the MSYS shell (file @file{msys.bat}) and type @code{link.exe}.
1184If you get a help message with the command line options of @code{link.exe},
1185this means your environment variables are set up correctly, the
1186Microsoft linker is on the path and will be used by FFmpeg to
1187create Visual-C++-compatible import libraries.
1188
e926e391 1189@item Extract the current version of FFmpeg and change to the FFmpeg directory.
be0efc0c
MB
1190
1191@item Type the command
51d8321d
DB
1192@code{./configure --enable-shared --disable-static --enable-memalign-hack}
1193to configure and, if that didn't produce any errors,
1194type @code{make} to build FFmpeg.
be0efc0c
MB
1195
1196@item The subdirectories @file{libavformat}, @file{libavcodec}, and
1197@file{libavutil} should now contain the files @file{avformat.dll},
1198@file{avformat.lib}, @file{avcodec.dll}, @file{avcodec.lib},
1199@file{avutil.dll}, and @file{avutil.lib}, respectively. Copy the three
1200DLLs to your System32 directory (typically @file{C:\Windows\System32}).
1201
1202@end enumerate
1203
1204And here is how to use these libraries with Visual C++:
1205
1206@enumerate
1207
1208@item Create a new console application ("File / New / Project") and then
1209select "Win32 Console Application". On the appropriate page of the
1210Application Wizard, uncheck the "Precompiled headers" option.
1211
1212@item Write the source code for your application, or, for testing, just
1213copy the code from an existing sample application into the source file
1214that Visual C++ has already created for you. (Note that your source
1215filehas to have a @code{.cpp} extension; otherwise, Visual C++ won't
1216compile the FFmpeg headers correctly because in C mode, it doesn't
1217recognize the @code{inline} keyword.) For example, you can copy
1218@file{output_example.c} from the FFmpeg distribution (but you will
1219have to make minor modifications so the code will compile under
1220C++, see below).
1221
1222@item Open the "Project / Properties" dialog box. In the "Configuration"
1223combo box, select "All Configurations" so that the changes you make will
1224affect both debug and release builds. In the tree view on the left hand
1225side, select "C/C++ / General", then edit the "Additional Include
1226Directories" setting to contain the complete paths to the
1227@file{libavformat}, @file{libavcodec}, and @file{libavutil}
1228subdirectories of your FFmpeg directory. Note that the directories have
1229to be separated using semicolons. Now select "Linker / General" from the
1230tree view and edit the "Additional Library Directories" setting to
1231contain the same three directories.
1232
1233@item Still in the "Project / Properties" dialog box, select "Linker / Input"
1234from the tree view, then add the files @file{avformat.lib},
1235@file{avcodec.lib}, and @file{avutil.lib} to the end of the "Additional
1236Dependencies". Note that the names of the libraries have to be separated
1237using spaces.
1238
765c3440 1239@item Now, select "C/C++ / Code Generation" from the tree view. Select
be0efc0c
MB
1240"Debug" in the "Configuration" combo box. Make sure that "Runtime
1241Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
1242the "Configuration" combo box and make sure that "Runtime Library" is
1243set to "Multi-threaded DLL".
1244
1245@item Click "OK" to close the "Project / Properties" dialog box and build
1246the application. Hopefully, it should compile and run cleanly. If you
1247used @file{output_example.c} as your sample application, you will get a
1248few compiler errors, but they are easy to fix. The first type of error
1249occurs because Visual C++ doesn't allow an @code{int} to be converted to
1250an @code{enum} without a cast. To solve the problem, insert the required
1251casts (this error occurs once for a @code{CodecID} and once for a
1252@code{CodecType}). The second type of error occurs because C++ requires
1253the return value of @code{malloc} to be cast to the exact type of the
1254pointer it is being assigned to. Visual C++ will complain that, for
1255example, @code{(void *)} is being assigned to @code{(uint8_t *)} without
1256an explicit cast. So insert an explicit cast in these places to silence
1257the compiler. The third type of error occurs because the @code{snprintf}
1258library function is called @code{_snprintf} under Visual C++. So just
1259add an underscore to fix the problem. With these changes,
1260@file{output_example.c} should compile under Visual C++, and the
1261resulting executable should produce valid video files.
1262
1263@end enumerate
1264
b030b284
FB
1265@subsection Cross compilation for Windows with Linux
1266
1267You must use the MinGW cross compilation tools available at
1268@url{http://www.mingw.org/}.
1269
4c5f7207 1270Then configure FFmpeg with the following options:
b030b284
FB
1271@example
1272./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
1273@end example
019c8838 1274(you can change the cross-prefix according to the prefix chosen for the
b030b284
FB
1275MinGW tools).
1276
4c5f7207 1277Then you can easily test FFmpeg with Wine
b030b284
FB
1278(@url{http://www.winehq.com/}).
1279
30aee296
DB
1280@subsection Compilation under Cygwin
1281
1282Cygwin works very much like Unix.
1283
1284Just install your Cygwin with all the "Base" packages, plus the
1285following "Devel" ones:
1286@example
1287binutils, gcc-core, make, subversion
1288@end example
1289
1290Do not install binutils-20060709-1 (they are buggy on shared builds);
1291use binutils-20050610-1 instead.
1292
1293Then run
1294
1295@example
1296./configure --enable-static --disable-shared
1297@end example
1298
1299to make a static build or
1300
1301@example
1302./configure --enable-shared --disable-static
1303@end example
1304
1305to build shared libraries.
1306
1307If you want to build FFmpeg with additional libraries, download Cygwin
1308"Devel" packages for Ogg and Vorbis from any Cygwin packages repository
1309and/or SDL, xvid, faac, faad2 packages from Cygwin Ports,
1310(@url{http://cygwinports.dotsrc.org/}).
1311
1312@subsection Crosscompilation for Windows under Cygwin
1313
1314With Cygwin you can create Windows binaries that don't need the cygwin1.dll.
1315
1316Just install your Cygwin as explained before, plus these additional
1317"Devel" packages:
1318@example
1319gcc-mingw-core, mingw-runtime, mingw-zlib
1320@end example
1321
1322and add some special flags to your configure invocation.
1323
1324For a static build run
1325@example
1326./configure --enable-mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1327@end example
1328
1329and for a build with shared libraries
1330@example
1331./configure --enable-mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1332@end example
1333
47d944d2
FB
1334@section BeOS
1335
1336The configure script should guess the configuration itself.
1337Networking support is currently not finished.
1338errno issues fixed by Andrew Bachmann.
1339
1340Old stuff:
1341
7dd611c9 1342François Revol - revol at free dot fr - April 2002
47d944d2 1343
115329f1 1344The configure script should guess the configuration itself,
4c5f7207 1345however I still didn't test building on the net_server version of BeOS.
47d944d2 1346
4c5f7207 1347FFserver is broken (needs poll() implementation).
47d944d2 1348
4c5f7207 1349There are still issues with errno codes, which are negative in BeOS, and
115329f1 1350that FFmpeg negates when returning. This ends up turning errors into
47d944d2
FB
1351valid results, then crashes.
1352(To be fixed)
1353
34d7008d 1354@chapter Developers Guide
9181577c
FB
1355
1356@section API
a0b72f90 1357@itemize @bullet
9181577c 1358@item libavcodec is the library containing the codecs (both encoding and
4c5f7207 1359decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
9181577c 1360
4c5f7207
DB
1361@item libavformat is the library containing the file format handling (mux and
1362demux code for several formats). Look at @file{ffplay.c} to use it in a
a93b9dba
FB
1363player. See @file{output_example.c} to use it to generate audio or video
1364streams.
1365
9181577c
FB
1366@end itemize
1367
1368@section Integrating libavcodec or libavformat in your program
1369
1370You can integrate all the source code of the libraries to link them
1371statically to avoid any version problem. All you need is to provide a
1372'config.mak' and a 'config.h' in the parent directory. See the defines
1373generated by ./configure to understand what is needed.
1374
1375You can use libavcodec or libavformat in your commercial program, but
1376@emph{any patch you make must be published}. The best way to proceed is
4c5f7207 1377to send your patches to the FFmpeg mailing list.
9181577c 1378
80d1c272 1379@node Coding Rules
9181577c
FB
1380@section Coding Rules
1381
4c5f7207 1382FFmpeg is programmed in the ISO C90 language with a few additional
cb6e87c1
FH
1383features from ISO C99, namely:
1384@itemize @bullet
1385@item
1386the @samp{inline} keyword;
1387@item
1388@samp{//} comments;
1389@item
1390designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
1391@item
114afa9c 1392compound literals (@samp{x = (struct s) @{ 17, 23 @};})
cb6e87c1
FH
1393@end itemize
1394
1395These features are supported by all compilers we care about, so we won't
1396accept patches to remove their use unless they absolutely don't impair
1397clarity and performance.
1398
4c5f7207 1399All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
cb6e87c1
FH
1400compiles with several other compilers, such as the Compaq ccc compiler
1401or Sun Studio 9, and we would like to keep it that way unless it would
1402be exceedingly involved. To ensure compatibility, please don't use any
4c5f7207 1403additional C99 features or GCC extensions. Especially watch out for:
cb6e87c1
FH
1404@itemize @bullet
1405@item
1406mixing statements and declarations;
1407@item
1408@samp{long long} (use @samp{int64_t} instead);
1409@item
1410@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
1411@item
019c8838 1412GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
cb6e87c1 1413@end itemize
9181577c 1414
53862e0f 1415Indent size is 4.
b86e38a0 1416The presentation is the one specified by 'indent -i4 -kr -nut'.
53862e0f
DB
1417The TAB character is forbidden outside of Makefiles as is any
1418form of trailing whitespace. Commits containing either will be
1c1b5a40 1419rejected by the Subversion repository.
9181577c 1420
4c5f7207 1421Main priority in FFmpeg is simplicity and small code size (=less
9181577c
FB
1422bugs).
1423
4c5f7207
DB
1424Comments: Use the JavaDoc/Doxygen
1425format (see examples below) so that code documentation
1426can be generated automatically. All nontrivial functions should have a comment
1427above them explaining what the function does, even if it's just one sentence.
1428All structures and their member variables should be documented, too.
f4888b83
MN
1429@example
1430/**
2185824b
MR
1431 * @@file mpeg.c
1432 * MPEG codec.
1433 * @@author ...
1434 */
f4888b83
MN
1435
1436/**
2185824b
MR
1437 * Summary sentence.
1438 * more text ...
1439 * ...
1440 */
114afa9c 1441typedef struct Foobar@{
2185824b
MR
1442 int var1; /**< var1 description */
1443 int var2; ///< var2 description
1444 /** var3 description */
1445 int var3;
114afa9c 1446@} Foobar;
f4888b83
MN
1447
1448/**
2185824b
MR
1449 * Summary sentence.
1450 * more text ...
1451 * ...
1452 * @@param my_parameter description of my_parameter
1453 * @@return return value description
1454 */
f4888b83
MN
1455int myfunc(int my_parameter)
1456...
1457@end example
9181577c 1458
115329f1 1459fprintf and printf are forbidden in libavformat and libavcodec,
36d9b4e8
MN
1460please use av_log() instead.
1461
1c1b5a40 1462@section Development Policy
7a57b90c
MN
1463
1464@enumerate
115329f1 1465@item
7a57b90c 1466 You must not commit code which breaks FFmpeg! (Meaning unfinished but
4c5f7207 1467 enabled code which breaks compilation or compiles but does not work or
7a57b90c
MN
1468 breaks the regression tests)
1469 You can commit unfinished stuff (for testing etc), but it must be disabled
1470 (#ifdef etc) by default so it does not interfere with other developers'
1471 work.
115329f1 1472@item
7a57b90c 1473 You don't have to over-test things. If it works for you, and you think it
4c5f7207
DB
1474 should work for others, then commit. If your code has problems
1475 (portability, triggers compiler bugs, unusual environment etc) they will be
7a57b90c 1476 reported and eventually fixed.
115329f1 1477@item
7a57b90c
MN
1478 Do not commit unrelated changes together, split them into self-contained
1479 pieces.
1480@item
1481 Do not change behavior of the program (renaming options etc) without
019c8838 1482 first discussing it on the ffmpeg-devel mailing list. Do not remove
7a57b90c 1483 functionality from the code. Just improve!
115329f1 1484
4c5f7207 1485 Note: Redundant code can be removed.
7a57b90c
MN
1486@item
1487 Do not commit changes to the build system (Makefiles, configure script)
019c8838 1488 which change behavior, defaults etc, without asking first. The same
7a57b90c
MN
1489 applies to compiler warning fixes, trivial looking fixes and to code
1490 maintained by other developers. We usually have a reason for doing things
019c8838 1491 the way we do. Send your changes as patches to the ffmpeg-devel mailing
7a57b90c
MN
1492 list, and if the code maintainers say OK, you may commit. This does not
1493 apply to files you wrote and/or maintain.
1494@item
1495 We refuse source indentation and other cosmetic changes if they are mixed
1496 with functional changes, such commits will be rejected and removed. Every
1497 developer has his own indentation style, you should not change it. Of course
1498 if you (re)write something, you can use your own style, even though we would
4c5f7207
DB
1499 prefer if the indentation throughout FFmpeg was consistent (Many projects
1500 force a given indentation style - we don't.). If you really need to make
7a57b90c
MN
1501 indentation changes (try to avoid this), separate them strictly from real
1502 changes.
1503
114afa9c 1504 NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
115329f1 1505 then either do NOT change the indentation of the inner part within (don't
019c8838 1506 move it to the right)! or do so in a separate commit
7a57b90c
MN
1507@item
1508 Always fill out the commit log message. Describe in a few lines what you
1509 changed and why. You can refer to mailing list postings if you fix a
1510 particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
1511@item
1512 If you apply a patch by someone else, include the name and email address in
1c1b5a40 1513 the log message. Since the ffmpeg-cvslog mailing list is publicly
019c8838
DB
1514 archived you should add some SPAM protection to the email address. Send an
1515 answer to ffmpeg-devel (or wherever you got the patch from) saying that
7a57b90c
MN
1516 you applied the patch.
1517@item
5ab0f204
DB
1518 Do NOT commit to code actively maintained by others without permission.
1519 Send a patch to ffmpeg-devel instead. If noone answers within a reasonable
1520 timeframe (12h for build failures and security fixes, 3 days small changes,
1521 1 week for big patches) then commit your patch if you think it's OK.
1522 Also note, the maintainer can simply ask for more time to review!
7a57b90c 1523@item
1c1b5a40 1524 Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
7a57b90c
MN
1525 are sent there and reviewed by all the other developers. Bugs and possible
1526 improvements or general questions regarding commits are discussed there. We
1527 expect you to react if problems with your code are uncovered.
1528@item
1529 Update the documentation if you change behavior or add features. If you are
019c8838 1530 unsure how best to do this, send a patch to ffmpeg-devel, the documentation
7a57b90c
MN
1531 maintainer(s) will review and commit your stuff.
1532@item
4c5f7207
DB
1533 Never write to unallocated memory, never write over the end of arrays,
1534 always check values read from some untrusted source before using them
1535 as array index or other risky things.
76bec1d8
AS
1536@item
1537 Remember to check if you need to bump versions for the specific libav
f0efbde7 1538 parts (libavutil, libavcodec, libavformat) you are changing. You need
76bec1d8
AS
1539 to change the version integer and the version string.
1540 Incrementing the first component means no backward compatibility to
a940b428 1541 previous versions (e.g. removal of a function from the public API).
76bec1d8 1542 Incrementing the second component means backward compatible change
a940b428 1543 (e.g. addition of a function to the public API).
76bec1d8
AS
1544 Incrementing the third component means a noteworthy binary compatible
1545 change (e.g. encoder bug fix that matters for the decoder).
ebd32fd7 1546@item
3f1965c4
DB
1547 If you add a new codec, remember to update the changelog, add it to
1548 the supported codecs table in the documentation and bump the second
1549 component of the @file{libavcodec} version number appropriately. If
1550 it has a fourcc, add it to @file{libavformat/avienc.c}, even if it
1551 is only a decoder.
114afa9c 1552@end enumerate
7a57b90c
MN
1553
1554We think our rules are not too hard. If you have comments, contact us.
1555
1556Note, these rules are mostly borrowed from the MPlayer project.
1557
9181577c
FB
1558@section Submitting patches
1559
80d1c272
MN
1560First, (@pxref{Coding Rules}) above if you didn't yet.
1561
6a6810b1 1562When you submit your patch, try to send a unified diff (diff '-up'
9181577c
FB
1563option). I cannot read other diffs :-)
1564
6e5c1877 1565Also please do not submit patches which contain several unrelated changes.
115329f1 1566Split them into individual self-contained patches; this makes reviewing
7885603a
MN
1567them much easier.
1568
9181577c 1569Run the regression tests before submitting a patch so that you can
6bf40f39 1570verify that there are no big problems.
9181577c 1571
9181577c 1572Patches should be posted as base64 encoded attachments (or any other
4c5f7207 1573encoding which ensures that the patch won't be trashed during
115329f1 1574transmission) to the ffmpeg-devel mailing list, see
2b165e29 1575@url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
9181577c 1576
54fcf429 1577It also helps quite a bit if you tell us what the patch does (for example
4c5f7207 1578'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
54fcf429
MN
1579and has no lrint()')
1580
4c5f7207
DB
1581We reply to all submitted patches and either apply or reject with some
1582explanation why, but sometimes we are quite busy so it can take a week or two.
cf7f2b16 1583
9181577c
FB
1584@section Regression tests
1585
1c1b5a40 1586Before submitting a patch (or committing to the repository), you should at least
9181577c
FB
1587test that you did not break anything.
1588
4c5f7207
DB
1589The regression tests build a synthetic video stream and a synthetic
1590audio stream. These are then encoded and decoded with all codecs or
9181577c 1591formats. The CRC (or MD5) of each generated file is recorded in a
4c5f7207 1592result file. A 'diff' is launched to compare the reference results and
9181577c
FB
1593the result file.
1594
4c5f7207 1595The regression tests then go on to test the FFserver code with a
6bf40f39
PG
1596limited set of streams. It is important that this step runs correctly
1597as well.
1598
36d9b4e8 1599Run 'make test' to test all the codecs and formats.
9181577c 1600
4c5f7207 1601Run 'make fulltest' to test all the codecs, formats and FFserver.
9181577c 1602
4c5f7207
DB
1603[Of course, some patches may change the results of the regression tests. In
1604this case, the reference results of the regression tests shall be modified
9181577c
FB
1605accordingly].
1606
1607@bye