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