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