Statistics
| Branch: | Revision:

ffmpeg / doc / ffmpeg-doc.texi @ f4888b83

History | View | Annotate | Download (32.1 KB)

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

    
13
FFmpeg is a very fast video and audio converter. It can also grab from
14
a live audio/video source.
15
  
16
The command line interface is designed to be intuitive, in the sense
17
that ffmpeg tries to figure out all the parameters, when
18
possible. You have usually to give only the target bitrate you want.
19

    
20
FFmpeg can also convert from any sample rate to any other, and resize
21
video on the fly with a high quality polyphase filter.
22

    
23
@chapter Quick Start
24

    
25
@c man begin EXAMPLES
26
@section Video and Audio grabbing
27

    
28
FFmpeg can use a video4linux compatible video source and any Open Sound
29
System audio source:
30

    
31
@example
32
ffmpeg /tmp/out.mpg 
33
@end example
34

    
35
Note that you must activate the right video source and channel before
36
launching ffmpeg. You can use any TV viewer such as xawtv
37
(@url{http://bytesex.org/xawtv/}) by Gerd Knorr which I find very
38
good. You must also set correctly the audio recording levels with a
39
standard mixer.
40

    
41
@section Video and Audio file format conversion
42

    
43
* ffmpeg can use any supported file format and protocol as input: 
44

    
45
Examples:
46

    
47
* You can input from YUV files:
48

    
49
@example
50
ffmpeg -i /tmp/test%d.Y /tmp/out.mpg 
51
@end example
52

    
53
It will use the files: 
54
@example
55
/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
56
/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
57
@end example
58

    
59
The Y files use twice the resolution of the U and V files. They are
60
raw files, without header. They can be generated by all decent video
61
decoders. You must specify the size of the image with the @option{-s} option
62
if ffmpeg cannot guess it.
63

    
64
* You can input from a RAW YUV420P file:
65

    
66
@example
67
ffmpeg -i /tmp/test.yuv /tmp/out.avi
68
@end example
69

    
70
The RAW YUV420P is a file containing RAW YUV planar, for each frame first
71
come the Y plane followed by U and V planes, which are half vertical and
72
horizontal resolution.
73

    
74
* You can output to a RAW YUV420P file:
75

    
76
@example
77
ffmpeg -i mydivx.avi -o hugefile.yuv
78
@end example
79

    
80
* You can set several input files and output files:
81

    
82
@example
83
ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
84
@end example
85

    
86
Convert the audio file a.wav and the raw yuv video file a.yuv
87
to mpeg file a.mpg
88

    
89
* You can also do audio and video conversions at the same time:
90

    
91
@example
92
ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
93
@end example
94

    
95
Convert the sample rate of a.wav to 22050 Hz and encode it to MPEG audio.
96

    
97
* You can encode to several formats at the same time and define a
98
mapping from input stream to output streams:
99

    
100
@example
101
ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
102
@end example
103

    
104
Convert a.wav to a.mp2 at 64 kbits and b.mp2 at 128 kbits. '-map
105
file:index' specify which input stream is used for each output
106
stream, in the order of the definition of output streams.
107

    
108
* You can transcode decrypted VOBs
109

    
110
@example
111
ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800 -g 300 -bf 2 -acodec mp3 -ab 128 snatch.avi
112
@end example
113

    
114
This is a typical DVD ripper example, input from a VOB file, output
115
to an AVI file with MPEG-4 video and MP3 audio, note that in this
116
command we use B frames so the MPEG-4 stream is DivX5 compatible, GOP
117
size is 300 that means an INTRA frame every 10 seconds for 29.97 fps
118
input video.  Also the audio stream is MP3 encoded so you need LAME
119
support which is enabled using @code{--enable-mp3lame} when
120
configuring.  The mapping is particularly useful for DVD transcoding
121
to get the desired audio language.
122

    
123
NOTE: to see the supported input formats, use @code{ffmpeg -formats}.
124
@c man end
125

    
126
@chapter Invocation
127

    
128
@section Syntax
129

    
130
The generic syntax is:
131

    
132
@example 
133
@c man begin SYNOPSIS
134
ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
135
@c man end
136
@end example
137
@c man begin DESCRIPTION
138
If no input file is given, audio/video grabbing is done.
139

    
140
As a general rule, options are applied to the next specified
141
file. For example, if you give the @option{-b 64} option, it sets the video
142
bitrate of the next file. Format option may be needed for raw input
143
files.
144

    
145
By default, ffmpeg tries to convert as losslessly as possible: it
146
uses the same audio and video parameter for the outputs as the one
147
specified for the inputs.
148
@c man end
149

    
150
@c man begin OPTIONS
151
@section Main options
152

    
153
@table @option
154
@item -L
155
show license
156

    
157
@item -h
158
show help
159

    
160
@item -formats
161
show available formats, codecs, protocols, ...
162

    
163
@item -f fmt              
164
force format
165

    
166
@item -i filename         
167
input file name
168

    
169
@item -y                  
170
overwrite output files
171

    
172
@item -t duration         
173
set the recording time in seconds. @code{hh:mm:ss[.xxx]} syntax is also
174
supported.
175

    
176
@item -ss position
177
seek to given time position. @code{hh:mm:ss[.xxx]} syntax is also
178
supported.
179

    
180
@item -title string       
181
set the title
182

    
183
@item -author string      
184
set the author
185

    
186
@item -copyright string   
187
set the copyright
188

    
189
@item -comment string     
190
set the comment
191

    
192
@item -target type
193
specify target file type ("vcd", "svcd" or "dvd"). All the format
194
options (bitrate, codecs, buffer sizes) are automatically set by this
195
option. You can just type:
196

    
197
@example
198
ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
199
@end example
200

    
201
@item -hq
202
activate high quality settings
203

    
204
@item -itsoffset offset
205
set the input time offset in seconds. @code{[-]hh:mm:ss[.xxx]} syntax
206
is also supported.  This option affects all the input files that
207
follow it.  The offset is added to the input files' timestamps;
208
specifying a positive offset means that the corresponding streams are
209
delayed by 'offset' seconds.
210

    
211
@end table
212

    
213
@section Video Options
214

    
215
@table @option
216
@item -b bitrate
217
set the video bitrate in kbit/s (default = 200 kb/s)
218
@item -r fps           
219
set frame rate (default = 25)
220
@item -s size             
221
set frame size. The format is @samp{WxH} (default 160x128).  The
222
following abbreviations are recognized:
223
@table @samp
224
@item sqcif
225
128x96
226
@item qcif
227
176x144
228
@item cif
229
352x288
230
@item 4cif
231
704x576
232
@end table
233

    
234
@item -aspect aspect
235
set aspect ratio (4:3, 16:9 or 1.3333, 1.7777)
236
@item -croptop size
237
set top crop band size (in pixels)
238
@item -cropbottom size
239
set bottom crop band size (in pixels)
240
@item -cropleft size
241
set left crop band size (in pixels)
242
@item -cropright size
243
set right crop band size (in pixels)
244
@item -padtop size
245
set top pad band size (in pixels)
246
@item -padbottom size
247
set bottom pad band size (in pixels)
248
@item -padleft size
249
set left pad band size (in pixels)
250
@item -padright size
251
set right pad band size (in pixels)
252
@item -padcolor (hex color)
253
set color of padded bands. The value for pad color is expressed 
254
as a six digit hexidecimal number where the first two digits represent red, 
255
middle two digits green and last two digits blue. Defaults to 000000 (black)
256
@item -vn
257
disable video recording
258
@item -bt tolerance       
259
set video bitrate tolerance (in kbit/s)
260
@item -maxrate bitrate
261
set max video bitrate tolerance (in kbit/s)
262
@item -minrate bitrate
263
set min video bitrate tolerance (in kbit/s)
264
@item -bufsize size
265
set ratecontrol buffere size (in kbit)
266
@item -vcodec codec       
267
force video codec to @var{codec}. Use the @code{copy} special value to
268
tell that the raw codec data must be copied as is.
269
@item -sameq
270
use same video quality as source (implies VBR)
271

    
272
@item -pass n  
273
select the pass number (1 or 2). It is useful to do two pass
274
encoding. The statistics of the video are recorded in the first pass and
275
the video at the exact requested bit rate is generated in the second
276
pass.
277

    
278
@item -passlogfile file   
279
select two pass log file name to @var{file}.
280

    
281
@end table
282

    
283
@section Advanced Video Options
284

    
285
@table @option
286
@item -g gop_size         
287
set the group of picture size
288
@item -intra              
289
use only intra frames
290
@item -qscale q           
291
use fixed video quantiser scale (VBR)
292
@item -qmin q             
293
min video quantiser scale (VBR)
294
@item -qmax q             
295
max video quantiser scale (VBR)
296
@item -qdiff q            
297
max difference between the quantiser scale (VBR)
298
@item -qblur blur         
299
video quantiser scale blur (VBR)
300
@item -qcomp compression  
301
video quantiser scale compression (VBR)
302

    
303
@item -rc_init_cplx complexity
304
initial complexity for 1-pass encoding
305
@item -b_qfactor factor
306
qp factor between p and b frames
307
@item -i_qfactor factor
308
qp factor between p and i frames
309
@item -b_qoffset offset
310
qp offset between p and b frames
311
@item -i_qoffset offset
312
qp offset between p and i frames
313
@item -rc_eq equation
314
set rate control equation (@pxref{FFmpeg formula
315
evaluator}). Default is @code{tex^qComp}.
316
@item -rc_override override
317
rate control override for specific intervals
318
@item -me method
319
set motion estimation method to @var{method}. Available methods are
320
(from lower to best quality):
321
@table @samp
322
@item zero
323
Try just the (0, 0) vector.
324
@item phods
325
@item log
326
@item x1
327
@item epzs
328
(default method)
329
@item full
330
exhaustive search (slow and marginally better than epzs)
331
@end table
332

    
333
@item -dct_algo algo
334
set dct algorithm to @var{algo}. Available values are:
335
@table @samp
336
@item 0
337
FF_DCT_AUTO (default)
338
@item 1
339
FF_DCT_FASTINT
340
@item 2
341
FF_DCT_INT
342
@item 3
343
FF_DCT_MMX
344
@item 4
345
FF_DCT_MLIB
346
@item 5
347
FF_DCT_ALTIVEC
348
@end table
349

    
350
@item -idct_algo algo
351
set idct algorithm to @var{algo}. Available values are:
352
@table @samp
353
@item 0
354
FF_IDCT_AUTO (default)
355
@item 1
356
FF_IDCT_INT          
357
@item 2
358
FF_IDCT_SIMPLE       
359
@item 3
360
FF_IDCT_SIMPLEMMX    
361
@item 4
362
FF_IDCT_LIBMPEG2MMX  
363
@item 5
364
FF_IDCT_PS2          
365
@item 6
366
FF_IDCT_MLIB         
367
@item 7
368
FF_IDCT_ARM          
369
@item 8
370
FF_IDCT_ALTIVEC      
371
@item 9
372
FF_IDCT_SH4          
373
@item 10
374
FF_IDCT_SIMPLEARM    
375
@end table
376

    
377
@item -er n
378
set error resilience to @var{n}.
379
@table @samp
380
@item 1 
381
FF_ER_CAREFULL (default)
382
@item 2
383
FF_ER_COMPLIANT
384
@item 3
385
FF_ER_AGGRESSIVE
386
@item 4
387
FF_ER_VERY_AGGRESSIVE
388
@end table
389

    
390
@item -ec bit_mask
391
set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
392
the following values:
393
@table @samp
394
@item 1
395
FF_EC_GUESS_MVS (default=enabled)
396
@item 2
397
FF_EC_DEBLOCK (default=enabled)
398
@end table
399

    
400
@item -bf frames
401
use 'frames' B frames (supported for MPEG-1, MPEG-2 and MPEG-4)
402
@item -mbd mode
403
macroblock decision
404
@table @samp
405
@item 0
406
FF_MB_DECISION_SIMPLE: use mb_cmp (cannot change it yet in ffmpeg)
407
@item 1
408
FF_MB_DECISION_BITS: chooses the one which needs the fewest bits
409
@item 2
410
FF_MB_DECISION_RD: rate distoration
411
@end table
412

    
413
@item -4mv
414
use four motion vector by macroblock (only MPEG-4)
415
@item -part
416
use data partitioning (only MPEG-4)
417
@item -bug param
418
workaround not auto detected encoder bugs
419
@item -strict strictness
420
how strictly to follow the standarts
421
@item -aic
422
enable Advanced intra coding (h263+)
423
@item -umv
424
enable Unlimited Motion Vector (h263+)
425

    
426
@item -deinterlace
427
deinterlace pictures
428
@item -interlace
429
force interlacing support in encoder (only MPEG-2 and MPEG-4). Use this option
430
if your input file is interlaced and if you want to keep the interlaced
431
format for minimum losses. The alternative is to deinterlace the input
432
stream with @option{-deinterlace}, but deinterlacing introduces more
433
losses.
434
@item -psnr
435
calculate PSNR of compressed frames
436
@item -vstats
437
dump video coding statistics to @file{vstats_HHMMSS.log}.
438
@item -vhook module
439
insert video processing @var{module}. @var{module} contains the module
440
name and its parameters separated by spaces.
441
@end table
442

    
443
@section Audio Options
444

    
445
@table @option
446
@item -ar freq    
447
set the audio sampling freq (default = 44100 Hz)
448
@item -ab bitrate 
449
set the audio bitrate in kbit/s (default = 64)
450
@item -ac channels
451
set the number of audio channels (default = 1)
452
@item -an
453
disable audio recording
454
@item -acodec codec
455
force audio codec to @var{codec}. Use the @code{copy} special value to
456
tell that the raw codec data must be copied as is.
457
@end table
458

    
459
@section Audio/Video grab options
460

    
461
@table @option
462
@item -vd device
463
set video grab device (e.g. @file{/dev/video0})
464
@item -vc channel
465
set video grab channel (DV1394 only)
466
@item -tvstd standard
467
set television standard (NTSC, PAL (SECAM))
468
@item -dv1394
469
set DV1394 grab
470
@item -ad device
471
set audio device (e.g. @file{/dev/dsp})
472
@end table
473

    
474
@section Advanced options
475

    
476
@table @option
477
@item -map file:stream    
478
set input stream mapping
479
@item -debug
480
print specific debug info
481
@item -benchmark          
482
add timings for benchmarking
483
@item -hex                
484
dump each input packet
485
@item -bitexact
486
only use bit exact algorithms (for codec testing)
487
@item -ps size
488
set packet size in bits
489
@item -re
490
read input at native frame rate. Mainly used to simulate a grab device.
491
@item -loop
492
loop over the input stream. Currently it works only for image
493
streams. This option is used for ffserver automatic testing.
494
@end table
495

    
496
@node FFmpeg formula evaluator
497
@section FFmpeg formula evaluator
498

    
499
When evaluating a rate control string, FFmpeg uses an internal formula
500
evaluator. 
501

    
502
The following binary operators are available: @code{+}, @code{-},
503
@code{*}, @code{/}, @code{^}.
504

    
505
The following unary operators are available: @code{+}, @code{-},
506
@code{(...)}.
507

    
508
The following functions are available:
509
@table @var
510
@item sinh(x)
511
@item cosh(x)
512
@item tanh(x)
513
@item sin(x)
514
@item cos(x)
515
@item tan(x)
516
@item exp(x)
517
@item log(x)
518
@item squish(x)
519
@item gauss(x)
520
@item abs(x)
521
@item max(x, y)
522
@item min(x, y)
523
@item gt(x, y)
524
@item lt(x, y)
525
@item eq(x, y)
526
@item bits2qp(bits)
527
@item qp2bits(qp)
528
@end table
529

    
530
The following constants are available:
531
@table @var
532
@item PI
533
@item E
534
@item iTex
535
@item pTex
536
@item tex
537
@item mv
538
@item fCode
539
@item iCount
540
@item mcVar
541
@item var
542
@item isI
543
@item isP
544
@item isB
545
@item avgQP
546
@item qComp
547
@item avgIITex
548
@item avgPITex
549
@item avgPPTex
550
@item avgBPTex
551
@item avgTex
552
@end table
553

    
554
@c man end
555

    
556
@ignore
557

    
558
@setfilename ffmpeg
559
@settitle FFmpeg video converter
560

    
561
@c man begin SEEALSO
562
ffserver(1), ffplay(1) and the html documentation of @file{ffmpeg}.
563
@c man end
564

    
565
@c man begin AUTHOR
566
Fabrice Bellard
567
@c man end
568

    
569
@end ignore
570

    
571
@section Protocols
572

    
573
The filename can be @file{-} to read from the standard input or to write
574
to the standard output.
575

    
576
ffmpeg handles also many protocols specified with the URL syntax.
577

    
578
Use 'ffmpeg -formats' to have a list of the supported protocols.
579

    
580
The protocol @code{http:} is currently used only to communicate with
581
ffserver (see the ffserver documentation). When ffmpeg will be a
582
video player it will also be used for streaming :-)
583

    
584
@chapter Tips
585

    
586
@itemize
587
@item For streaming at very low bit rate application, use a low frame rate
588
and a small gop size. This is especially true for real video where
589
the Linux player does not seem to be very fast, so it can miss
590
frames. An example is:
591

    
592
@example
593
ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
594
@end example
595

    
596
@item  The parameter 'q' which is displayed while encoding is the current
597
quantizer. The value of 1 indicates that a very good quality could
598
be achieved. The value of 31 indicates the worst quality. If q=31
599
too often, it means that the encoder cannot compress enough to meet
600
your bit rate. You must either increase the bit rate, decrease the
601
frame rate or decrease the frame size.
602

    
603
@item If your computer is not fast enough, you can speed up the
604
compression at the expense of the compression ratio. You can use
605
'-me zero' to speed up motion estimation, and '-intra' to disable
606
completely motion estimation (you have only I frames, which means it
607
is about as good as JPEG compression).
608

    
609
@item To have very low bitrates in audio, reduce the sampling frequency
610
(down to 22050 kHz for mpeg audio, 22050 or 11025 for ac3).
611

    
612
@item To have a constant quality (but a variable bitrate), use the option
613
'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
614
quality).
615

    
616
@item When converting video files, you can use the '-sameq' option which
617
uses in the encoder the same quality factor than in the decoder. It
618
allows to be almost lossless in encoding.
619

    
620
@end itemize
621

    
622
@chapter Supported File Formats and Codecs
623

    
624
You can use the @code{-formats} option to have an exhaustive list.
625

    
626
@section File Formats
627

    
628
FFmpeg supports the following file formats through the @code{libavformat}
629
library:
630

    
631
@multitable @columnfractions .4 .1 .1
632
@item Supported File Format @tab Encoding @tab Decoding @tab Comments
633
@item MPEG audio @tab X @tab X
634
@item MPEG1 systems @tab X  @tab  X 
635
@tab muxed audio and video
636
@item MPEG2 PS @tab X  @tab  X 
637
@tab also known as @code{VOB} file
638
@item MPEG2 TS @tab    @tab  X 
639
@tab also known as DVB Transport Stream
640
@item ASF@tab X @tab X 
641
@item AVI@tab X @tab X 
642
@item WAV@tab X @tab X 
643
@item Macromedia Flash@tab X @tab X
644
@tab Only embedded audio is decoded
645
@item FLV              @tab  X @tab X
646
@tab Macromedia Flash video files
647
@item Real Audio and Video @tab X @tab X 
648
@item Raw AC3 @tab X  @tab  X 
649
@item Raw MJPEG @tab X  @tab  X 
650
@item Raw MPEG video @tab X  @tab  X 
651
@item Raw PCM8/16 bits, mulaw/Alaw@tab X  @tab  X 
652
@item Raw CRI ADX audio @tab X  @tab  X 
653
@item SUN AU format @tab X  @tab  X 
654
@item NUT @tab X @tab X @tab NUT Open Container Format
655
@item Quicktime        @tab X @tab  X 
656
@item MPEG4            @tab X @tab  X 
657
@tab MPEG4 is a variant of Quicktime
658
@item Raw MPEG4 video  @tab  X @tab  X 
659
@item DV               @tab  X @tab  X
660
@item 4xm              @tab    @tab X
661
@tab 4X Technologies format, used in some games
662
@item Playstation STR  @tab    @tab X
663
@item Id RoQ           @tab    @tab X
664
@tab used in Quake III, Jedi Knight 2, other computer games
665
@item Interplay MVE    @tab    @tab X
666
@tab format used in various Interplay computer games
667
@item WC3 Movie        @tab    @tab X
668
@tab multimedia format used in Origin's Wing Commander III computer game
669
@item Sega FILM/CPK    @tab    @tab X
670
@tab used in many Sega Saturn console games
671
@item Westwood Studios VQA/AUD  @tab    @tab X
672
@tab Multimedia formats used in Westwood Studios games
673
@item Id Cinematic (.cin) @tab    @tab X
674
@tab Used in Quake II
675
@item FLIC format      @tab    @tab X
676
@tab .fli/.flc files
677
@item Sierra VMD       @tab    @tab X
678
@tab used in Sierra CD-ROM games
679
@item Matroska         @tab    @tab X
680
@end multitable
681

    
682
@code{X} means that the encoding (resp. decoding) is supported.
683

    
684
@section Image Formats
685

    
686
FFmpeg can read and write images for each frame of a video sequence. The
687
following image formats are supported:
688

    
689
@multitable @columnfractions .4 .1 .1
690
@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
691
@item PGM, PPM     @tab X @tab X 
692
@item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support
693
@item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
694
@item JPEG         @tab X @tab X @tab Progressive JPEG is not supported
695
@item .Y.U.V       @tab X @tab X @tab One raw file per component
696
@item Animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated
697
@item PNG          @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet
698
@item SGI          @tab X @tab X @tab SGI RGB image format
699
@end multitable
700

    
701
@code{X} means that the encoding (resp. decoding) is supported.
702

    
703
@section Video Codecs
704

    
705
@multitable @columnfractions .4 .1 .1 .7
706
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
707
@item MPEG1 video            @tab  X  @tab  X
708
@item MPEG2 video            @tab  X  @tab  X 
709
@item MPEG4                  @tab  X  @tab  X @tab Also known as DIVX4/5
710
@item MSMPEG4 V1             @tab  X  @tab  X
711
@item MSMPEG4 V2             @tab  X  @tab  X
712
@item MSMPEG4 V3             @tab  X  @tab  X @tab Also known as DIVX3
713
@item WMV7                   @tab  X  @tab  X
714
@item WMV8                   @tab  X  @tab  X @tab Not completely working
715
@item H263(+)                @tab  X  @tab  X @tab Also known as Real Video 1.0
716
@item MJPEG                  @tab  X  @tab  X 
717
@item Lossless MJPEG         @tab  X  @tab  X
718
@item Apple MJPEG-B          @tab     @tab  X
719
@item Sunplus MJPEG          @tab     @tab  X @tab fourcc: SP5X
720
@item DV                     @tab  X  @tab  X 
721
@item Huff YUV               @tab  X  @tab  X
722
@item FFmpeg Video 1         @tab  X  @tab  X @tab Lossless codec (fourcc: FFV1)
723
@item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
724
@item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
725
@item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
726
@item H.264                  @tab     @tab  X
727
@item Sorenson Video 1       @tab  X  @tab  X @tab fourcc: SVQ1
728
@item Sorenson Video 3       @tab     @tab  X @tab fourcc: SVQ3
729
@item On2 VP3                @tab     @tab  X @tab still experimental
730
@item Theora                 @tab     @tab  X @tab still experimental
731
@item Intel Indeo 3          @tab     @tab  X @tab only works on i386 right now
732
@item FLV                    @tab  X  @tab  X @tab Flash H263 variant
733
@item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
734
@item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
735
@item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
736
@item 4X Video               @tab     @tab  X @tab used in certain computer games
737
@item Sony Playstation MDEC  @tab     @tab  X 
738
@item Id RoQ                 @tab     @tab  X @tab used in Quake III, Jedi Knight 2, other computer games
739
@item Xan/WC3                @tab     @tab  X @tab used in Wing Commander III .MVE files
740
@item Interplay Video        @tab     @tab  X @tab used in Interplay .MVE files
741
@item Apple Animation        @tab     @tab  X @tab fourcc: 'rle '
742
@item Apple Graphics         @tab     @tab  X @tab fourcc: 'smc '
743
@item Apple Video            @tab     @tab  X @tab fourcc: rpza
744
@item Cinepak                @tab     @tab  X
745
@item Microsoft RLE          @tab     @tab  X
746
@item Microsoft Video-1      @tab     @tab  X
747
@item Westwood VQA           @tab     @tab  X
748
@item Id Cinematic Video     @tab     @tab  X @tab used in Quake II
749
@item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
750
@item FLIC video             @tab     @tab  X
751
@item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
752
@item VMD Video              @tab     @tab  X @tab used in Sierra VMD files
753
@item MSZH                   @tab     @tab  X @tab Part of LCL
754
@item ZLIB                   @tab  X  @tab  X @tab Part of LCL, encoder experimental
755
@end multitable
756

    
757
@code{X} means that the encoding (resp. decoding) is supported.
758

    
759
Check at @url{http://www.mplayerhq.hu/~michael/codec-features.html} to
760
get a precise comparison of FFmpeg MPEG4 codec compared to the other
761
solutions.
762

    
763
@section Audio Codecs
764

    
765
@multitable @columnfractions .4 .1 .1 .1 .7
766
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
767
@item MPEG audio layer 2     @tab  IX  @tab  IX 
768
@item MPEG audio layer 1/3   @tab IX   @tab  IX
769
@tab MP3 encoding is supported through the external library LAME
770
@item AC3                    @tab  IX  @tab  IX
771
@tab liba52 is used internally for decoding
772
@item Vorbis                 @tab  X   @tab  X
773
@tab supported through the external library libvorbis
774
@item WMA V1/V2              @tab      @tab X
775
@item AAC                    @tab X    @tab X
776
@tab supported through the external library libfaac/libfaad
777
@item Microsoft ADPCM        @tab X    @tab X
778
@item MS IMA ADPCM           @tab X    @tab X
779
@item QT IMA ADPCM           @tab      @tab X
780
@item 4X IMA ADPCM           @tab      @tab X
781
@item G.726  ADPCM           @tab X    @tab X
782
@item Duck DK3 IMA ADPCM     @tab      @tab X
783
@tab used in some Sega Saturn console games
784
@item Duck DK4 IMA ADPCM     @tab      @tab X
785
@tab used in some Sega Saturn console games
786
@item Westwood Studios IMA ADPCM @tab      @tab X
787
@tab used in Westwood Studios games like Command and Conquer
788
@item SMJPEG IMA ADPCM       @tab      @tab X
789
@tab used in certain Loki game ports
790
@item CD-ROM XA ADPCM        @tab      @tab X
791
@item CRI ADX ADPCM          @tab X    @tab X
792
@tab used in Sega Dreamcast games
793
@item Electronic Arts ADPCM  @tab      @tab X
794
@tab used in various EA titles
795
@item RA144                  @tab      @tab X
796
@tab Real 14400 bit/s codec
797
@item RA288                  @tab      @tab X
798
@tab Real 28800 bit/s codec
799
@item RADnet                 @tab X    @tab IX
800
@tab Real lowbitrate AC3 codec, liba52 is used for decoding
801
@item AMR-NB                 @tab X    @tab X
802
@tab supported through an external library
803
@item AMR-WB                 @tab X    @tab X
804
@tab supported through an external library
805
@item DV audio               @tab      @tab X
806
@item Id RoQ DPCM            @tab      @tab X
807
@tab used in Quake III, Jedi Knight 2, other computer games
808
@item Interplay MVE DPCM     @tab      @tab X
809
@tab used in various Interplay computer games
810
@item Xan DPCM               @tab      @tab X
811
@tab used in Origin's Wing Commander IV AVI files
812
@item Apple MACE 3           @tab      @tab X
813
@item Apple MACE 6           @tab      @tab X
814
@item FLAC                   @tab      @tab X
815
@end multitable
816

    
817
@code{X} means that the encoding (resp. decoding) is supported.
818

    
819
@code{I} means that an integer only version is available too (ensures highest
820
performances on systems without hardware floating point support).
821

    
822
@chapter Platform Specific information
823

    
824
@section Linux
825

    
826
ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
827
preferred compiler now for ffmpeg. All future optimizations will depend on
828
features only found in GCC 3.2.
829

    
830
@section BSD
831

    
832
@section Windows
833

    
834
@subsection Native Windows compilation
835

    
836
@itemize
837
@item Install the current versions of MSYS and MinGW from
838
@url{http://www.mingw.org/}. You can find detailed installation
839
instructions in the download section and the FAQ.
840

    
841
@item If you want to test the FFmpeg Simple Media Player, also download 
842
the MinGW development library of SDL 1.2.x
843
(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
844
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
845
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
846
directory. Edit the @file{sdl-config} script so that it gives the
847
correct SDL directory when invoked.
848

    
849
@item Extract the current version of FFmpeg (the latest release version or the current CVS snapshot whichever is recommended).
850
 
851
@item Start the MSYS shell (file @file{msys.bat}).
852

    
853
@item Change to the FFMPEG directory and follow
854
 the instructions of how to compile ffmpeg (file
855
@file{INSTALL}). Usually, launching @file{./configure} and @file{make}
856
suffices. If you have problems using SDL, verify that
857
@file{sdl-config} can be launched from the MSYS command line.
858

    
859
@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing @file{make install}. Don't forget to copy @file{SDL.dll} at the place you launch 
860
@file{ffplay}.
861

    
862
@end itemize
863

    
864
Notes: 
865
@itemize
866

    
867
@item The target @file{make wininstaller} can be used to create a
868
Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
869
must be copied in the ffmpeg directory in order to build the
870
installer.
871

    
872
@item By using @code{./configure --enable-shared} when configuring ffmpeg, 
873
you can build @file{avcodec.dll} and @file{avformat.dll}. With
874
@code{make install} you install the FFmpeg DLLs and the associated
875
headers in @file{Program Files/FFmpeg}. 
876

    
877
@item Visual C++ compatibility: if you used @code{./configure --enable-shared} 
878
when configuring FFmpeg, then FFmpeg tries to use the Microsoft Visual
879
C++ @code{lib} tool to build @code{avcodec.lib} and
880
@code{avformat.lib}. With these libraries, you can link your Visual C++
881
code directly with the FFmpeg DLLs.
882

    
883
@end itemize
884

    
885
@subsection Cross compilation for Windows with Linux
886

    
887
You must use the MinGW cross compilation tools available at
888
@url{http://www.mingw.org/}.
889

    
890
Then configure ffmpeg with the following options:
891
@example
892
./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
893
@end example
894
(you can change the cross-prefix according to the prefix choosen for the
895
MinGW tools).
896

    
897
Then you can easily test ffmpeg with wine
898
(@url{http://www.winehq.com/}).
899

    
900
@section MacOS X
901

    
902
@section BeOS
903

    
904
The configure script should guess the configuration itself.
905
Networking support is currently not finished.
906
errno issues fixed by Andrew Bachmann.
907

    
908
Old stuff:
909

    
910
Fran?ois Revol - revol at free dot fr - April 2002
911

    
912
The configure script should guess the configuration itself, 
913
however I still didn't tested building on net_server version of BeOS.
914

    
915
ffserver is broken (needs poll() implementation).
916

    
917
There is still issues with errno codes, which are negative in BeOs, and
918
that ffmpeg negates when returning. This ends up turning errors into 
919
valid results, then crashes.
920
(To be fixed)
921

    
922
@chapter Developers Guide
923

    
924
@section API
925
@itemize
926
@item libavcodec is the library containing the codecs (both encoding and
927
  decoding). See @file{libavcodec/apiexample.c} to see how to use it.
928

    
929
@item libavformat is the library containing the file formats handling (mux and
930
  demux code for several formats). See @file{ffplay.c} to use it in a
931
player. See @file{output_example.c} to use it to generate audio or video
932
streams.
933

    
934
@end itemize
935

    
936
@section Integrating libavcodec or libavformat in your program
937

    
938
You can integrate all the source code of the libraries to link them
939
statically to avoid any version problem. All you need is to provide a
940
'config.mak' and a 'config.h' in the parent directory. See the defines
941
generated by ./configure to understand what is needed.
942

    
943
You can use libavcodec or libavformat in your commercial program, but
944
@emph{any patch you make must be published}. The best way to proceed is
945
to send your patches to the ffmpeg mailing list.
946

    
947
@node Coding Rules
948
@section Coding Rules
949

    
950
ffmpeg is programmed in the ISO C90 language with a few additional
951
features from ISO C99, namely:
952
@itemize @bullet
953
@item
954
the @samp{inline} keyword;
955
@item
956
@samp{//} comments;
957
@item
958
designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
959
@item
960
compound literals (@samp{x = (struct s) { 17, 23 @};})
961
@end itemize
962

    
963
These features are supported by all compilers we care about, so we won't
964
accept patches to remove their use unless they absolutely don't impair
965
clarity and performance.
966

    
967
All code must compile with gcc 2.95 and gcc 3.3. Currently, ffmpeg also
968
compiles with several other compilers, such as the Compaq ccc compiler
969
or Sun Studio 9, and we would like to keep it that way unless it would
970
be exceedingly involved. To ensure compatibility, please don't use any
971
additional C99 features or gcc extensions. Watch out especially for:
972
@itemize @bullet
973
@item
974
mixing statements and declarations;
975
@item
976
@samp{long long} (use @samp{int64_t} instead);
977
@item
978
@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
979
@item
980
gcc statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
981
@end itemize
982

    
983
Indent size is 4. The TAB character should not be used.
984
The presentation is the one specified by 'indent -i4 -kr'.
985

    
986
Main priority in ffmpeg is simplicity and small code size (=less
987
bugs).
988

    
989
Comments: use the JavaDoc/Doxygen 
990
format (see examples below) so that a documentation
991
can be generated automatically. All non trivial functions should have a comment
992
above it explaining what the function does, even if its just one sentance.
993
All Structures and their member variables should be documented too.
994
@example
995
/**
996
?* @file mpeg.c
997
?* mpeg codec.
998
?* @author ...
999
?*/
1000

    
1001
/**
1002
?* Summary sentance.
1003
?* more text ...
1004
?* ...
1005
?*/
1006
typedef struct Foobar{
1007
? ? int var1; /**< var1 description */
1008
? ? int var2; ///< var2 description
1009
? ? /** var3 description */
1010
? ? int var3;
1011
} Foobar;
1012

    
1013
/**
1014
?* Summary sentance.
1015
?* more text ...
1016
?* ...
1017
?* @param my_parameter description of my_parameter
1018
?* @return return value description
1019
?*/
1020
int myfunc(int my_parameter)
1021
...
1022
@end example
1023

    
1024
fprintf and printf are forbidden in libavformat and libavcodec, 
1025
please use av_log() instead.
1026

    
1027
@section Submitting patches
1028

    
1029
First, (@pxref{Coding Rules}) above if you didn't yet.
1030

    
1031
When you submit your patch, try to send a unified diff (diff '-up'
1032
option). I cannot read other diffs :-)
1033

    
1034
Run the regression tests before submitting a patch so that you can
1035
verify that there are no big problems.
1036

    
1037
Patches should be posted as base64 encoded attachments (or any other
1038
encoding which ensures that the patch wont be trashed during 
1039
transmission) to the ffmpeg-devel mailinglist, see 
1040
@url{http://lists.sourceforge.net/lists/listinfo/ffmpeg-devel}
1041

    
1042
It also helps quite a bit if you tell us what the patch does (for example
1043
'replaces lrint by lrintf') , and why (for example '*bsd isnt c99 compliant
1044
and has no lrint()')
1045

    
1046
@section Regression tests
1047

    
1048
Before submitting a patch (or committing with CVS), you should at least
1049
test that you did not break anything.
1050

    
1051
The regression test build a synthetic video stream and a synthetic
1052
audio stream. Then these are encoded then decoded with all codecs or
1053
formats. The CRC (or MD5) of each generated file is recorded in a
1054
result file. Then a 'diff' is launched with the reference results and
1055
the result file.
1056

    
1057
The regression test then goes on to test the ffserver code with a 
1058
limited set of streams. It is important that this step runs correctly
1059
as well.
1060

    
1061
Run 'make test' to test all the codecs and formats.
1062

    
1063
Run 'make fulltest' to test all the codecs, formats and ffserver.
1064

    
1065
[Of course, some patches may change the regression tests results. In
1066
this case, the regression tests reference results shall be modified
1067
accordingly].
1068

    
1069
@bye