Browse code

Run documentation through ispell, plus some minor fixes.

Originally committed as revision 13670 to svn://svn.ffmpeg.org/ffmpeg/trunk

Diego Biurrun authored on 2008/06/06 16:51:36
Showing 5 changed files
... ...
@@ -38,7 +38,7 @@ No. Windows DLLs are not portable, bloated and often slow.
38 38
 Moreover FFmpeg strives to support all codecs natively.
39 39
 A DLL loader is not conducive to that goal.
40 40
 
41
-@section My bugreport/mail to ffmpeg-devel/user has not received any replies.
41
+@section My bug report/mail to ffmpeg-devel/user has not received any replies.
42 42
 
43 43
 Likely reasons
44 44
 @itemize
... ...
@@ -69,7 +69,7 @@ documentation.
69 69
 @section Which codecs are supported by Windows?
70 70
 
71 71
 Windows does not support standard formats like MPEG very well, unless you
72
-install some additional codecs
72
+install some additional codecs.
73 73
 
74 74
 The following list of video codecs should work on most Windows systems:
75 75
 @table @option
... ...
@@ -82,7 +82,7 @@ The following list of video codecs should work on most Windows systems:
82 82
 @item wmv2
83 83
 .asf only
84 84
 @item mpeg4
85
-only if you have some MPEG-4 codec installed like ffdshow or Xvid
85
+Only if you have some MPEG-4 codec like ffdshow or Xvid installed.
86 86
 @item mpeg1
87 87
 .mpg only
88 88
 @end table
... ...
@@ -96,8 +96,9 @@ The following list of audio codecs should work on most Windows systems:
96 96
 @item adpcm_ima_wav
97 97
 @item adpcm_ms
98 98
 @item pcm
99
+always
99 100
 @item mp3
100
-if some MP3 codec like LAME is installed
101
+If some MP3 codec like LAME is installed.
101 102
 @end table
102 103
 
103 104
 
... ...
@@ -111,12 +112,12 @@ the gcc developers. Note that we will not add workarounds for gcc bugs.
111 111
 
112 112
 @chapter Usage
113 113
 
114
-@section ffmpeg does not work; What is wrong?
114
+@section ffmpeg does not work; what is wrong?
115 115
 
116 116
 Try a @code{make distclean} in the ffmpeg source directory before the build. If this does not help see
117 117
 (@url{http://ffmpeg.org/bugreports.html}).
118 118
 
119
-@section How do I encode single pictures to movies?
119
+@section How do I encode single pictures into movies?
120 120
 
121 121
 First, rename your pictures to follow a numerical sequence.
122 122
 For example, img1.jpg, img2.jpg, img3.jpg,...
... ...
@@ -160,7 +161,8 @@ Beware that there is no "jpeg" codec. Use "mjpeg" instead.
160 160
 
161 161
 @section I get "Unsupported codec (id=86043) for input stream #0.1". What is the problem?
162 162
 
163
-This is the Qcelp codec, FFmpeg has no support for that codec currently. Try mencoder/mplayer it might work.
163
+This is the Qcelp codec, FFmpeg has no support for that codec currently.
164
+Try MEncoder/MPlayer, it might work.
164 165
 
165 166
 @section Why do I see a slight quality degradation with multithreaded MPEG* encoding?
166 167
 
... ...
@@ -170,7 +172,7 @@ quite logical that there is a small reduction of quality. This is not a bug.
170 170
 
171 171
 @section How can I read from the standard input or write to the standard output?
172 172
 
173
-Use @file{-} as filename.
173
+Use @file{-} as file name.
174 174
 
175 175
 @section Why does FFmpeg not decode audio in VOB files?
176 176
 
... ...
@@ -206,7 +208,7 @@ Choose a different codec with the -vcodec command line option.
206 206
 
207 207
 Both Xvid and DivX (version 4+) are implementations of the ISO MPEG-4
208 208
 standard (note that there are many other coding formats that use this
209
-same standard). Thus, use '-vcodec mpeg4' to encode these formats. The
209
+same standard). Thus, use '-vcodec mpeg4' to encode in these formats. The
210 210
 default fourcc stored in an MPEG-4-coded file will be 'FMP4'. If you want
211 211
 a different fourcc, use the '-vtag' option. E.g., '-vtag xvid' will
212 212
 force the fourcc 'xvid' to be stored as the video fourcc rather than the
... ...
@@ -362,7 +364,7 @@ examining all of the vbv_delay values and making complicated computations."
362 362
 
363 363
 Yes. Read the Developers Guide of the FFmpeg documentation. Alternatively,
364 364
 examine the source code for one of the many open source projects that
365
-already incorporate ffmpeg at (@url{projects.html}).
365
+already incorporate FFmpeg at (@url{projects.html}).
366 366
 
367 367
 @section Can you support my C compiler XXX?
368 368
 
... ...
@@ -404,7 +406,7 @@ No. These tools are too bloated and they complicate the build.
404 404
 
405 405
 @section Why not rewrite ffmpeg in object-oriented C++?
406 406
 
407
-ffmpeg is already organized in a highly modular manner and does not need to
407
+FFmpeg is already organized in a highly modular manner and does not need to
408 408
 be rewritten in a formal object language. Further, many of the developers
409 409
 favor straight C; it works for them. For more arguments on this matter,
410 410
 read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
... ...
@@ -412,14 +414,14 @@ read "Programming Religion" at (@url{http://www.tux.org/lkml/#s15}).
412 412
 @section Why are the ffmpeg programs devoid of debugging symbols?
413 413
 
414 414
 The build process creates ffmpeg_g, ffplay_g, etc. which contain full debug
415
-information. Those binaries are strip'd to create ffmpeg, ffplay, etc. If
415
+information. Those binaries are stripped to create ffmpeg, ffplay, etc. If
416 416
 you need the debug information, used the *_g versions.
417 417
 
418 418
 @section I do not like the LGPL, can I contribute code under the GPL instead?
419 419
 
420 420
 Yes, as long as the code is optional and can easily and cleanly be placed
421 421
 under #ifdef CONFIG_GPL without breaking anything. So for example a new codec
422
-or filter would be OK under GPL while a bugfix to LGPL code would not.
422
+or filter would be OK under GPL while a bug fix to LGPL code would not.
423 423
 
424 424
 @section I want to compile xyz.c alone but my compiler produced many errors.
425 425
 
... ...
@@ -124,7 +124,7 @@ Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
124 124
 file:index' specifies which input stream is used for each output
125 125
 stream, in the order of the definition of output streams.
126 126
 
127
-* You can transcode decrypted VOBs
127
+* You can transcode decrypted VOBs:
128 128
 
129 129
 @example
130 130
 ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec libmp3lame -ab 128k snatch.avi
... ...
@@ -206,7 +206,7 @@ Show available formats, codecs, protocols, ...
206 206
 Force format.
207 207
 
208 208
 @item -i @var{filename}
209
-input filename
209
+input file name
210 210
 
211 211
 @item -y
212 212
 Overwrite output files.
... ...
@@ -419,7 +419,7 @@ Add a new video stream to the current output stream.
419 419
 Set pixel format. Use 'list' as parameter to show all the supported
420 420
 pixel formats.
421 421
 @item -sws_flags @var{flags}
422
-Set SwScaler flags (only available when compiled with SwScaler support).
422
+Set SwScaler flags (only available when compiled with swscale support).
423 423
 @item -g @var{gop_size}
424 424
 Set the group of pictures size.
425 425
 @item -intra
... ...
@@ -801,7 +801,7 @@ Fabrice Bellard
801 801
 
802 802
 @section Protocols
803 803
 
804
-The filename can be @file{-} to read from standard input or to write
804
+The file name can be @file{-} to read from standard input or to write
805 805
 to standard output.
806 806
 
807 807
 FFmpeg also handles many protocols specified with an URL syntax.
... ...
@@ -43,7 +43,7 @@ Force displayed width.
43 43
 Force displayed height.
44 44
 @item -s @var{size}
45 45
 Set frame size (WxH or abbreviation), needed for videos which don't
46
-contain a header with the framesize like raw YUV.
46
+contain a header with the frame size like raw YUV.
47 47
 @item -an
48 48
 Disable audio.
49 49
 @item -vn
... ...
@@ -129,7 +129,7 @@ Seek to percentage in file corresponding to fraction of width.
129 129
 @settitle FFplay media player
130 130
 
131 131
 @c man begin SEEALSO
132
-ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
132
+ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
133 133
 @c man end
134 134
 
135 135
 @c man begin AUTHOR
... ...
@@ -22,7 +22,7 @@ etc. are not covered here. Read @file{ffmpeg-doc.html} for more
22 22
 information.
23 23
 @c man end
24 24
 
25
-@chapter QuickStart
25
+@chapter Quick Start
26 26
 
27 27
 [Contributed by Philip Gladstone, philip-ffserver at gladstonefamily dot net]
28 28
 
... ...
@@ -211,7 +211,7 @@ Use @file{configfile} instead of @file{/etc/ffserver.conf}.
211 211
 
212 212
 @ignore
213 213
 
214
-@setfilename ffsserver
214
+@setfilename ffserver
215 215
 @settitle FFserver video server
216 216
 
217 217
 @c man begin SEEALSO
... ...
@@ -72,8 +72,8 @@ library:
72 72
 @item DV               @tab  X @tab  X
73 73
 @item 4xm              @tab    @tab X
74 74
 @tab 4X Technologies format, used in some games.
75
-@item Playstation STR  @tab    @tab X
76
-@item Id RoQ           @tab X  @tab X
75
+@item PlayStation STR  @tab    @tab X
76
+@item id RoQ           @tab X  @tab X
77 77
 @tab Used in Quake III, Jedi Knight 2, other computer games.
78 78
 @item Interplay MVE    @tab    @tab X
79 79
 @tab Format used in various Interplay computer games.
... ...
@@ -83,7 +83,7 @@ library:
83 83
 @tab Used in many Sega Saturn console games.
84 84
 @item Westwood Studios VQA/AUD  @tab    @tab X
85 85
 @tab Multimedia formats used in Westwood Studios games.
86
-@item Id Cinematic (.cin) @tab    @tab X
86
+@item id Cinematic (.cin) @tab    @tab X
87 87
 @tab Used in Quake II.
88 88
 @item FLIC format      @tab    @tab X
89 89
 @tab .fli/.flc files
... ...
@@ -112,7 +112,7 @@ library:
112 112
 @item MXF @tab    @tab X
113 113
 @tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
114 114
 @item SEQ @tab    @tab X
115
-@tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
115
+@tab Tiertex .seq files used in the DOS CD-ROM version of the game Flashback.
116 116
 @item DXA @tab    @tab X
117 117
 @tab This format is used in non-Windows version of Feeble Files game and
118 118
 different game cutscenes repacked for use with ScummVM.
... ...
@@ -211,8 +211,8 @@ following image formats are supported:
211 211
 @item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
212 212
 @item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
213 213
 @item 4X Video               @tab     @tab  X @tab Used in certain computer games.
214
-@item Sony Playstation MDEC  @tab     @tab  X
215
-@item Id RoQ                 @tab  X  @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
214
+@item Sony PlayStation MDEC  @tab     @tab  X
215
+@item id RoQ                 @tab  X  @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
216 216
 @item Xan/WC3                @tab     @tab  X @tab Used in Wing Commander III .MVE files.
217 217
 @item Interplay Video        @tab     @tab  X @tab Used in Interplay .MVE files.
218 218
 @item Apple Animation        @tab  X  @tab  X @tab fourcc: 'rle '
... ...
@@ -223,7 +223,7 @@ following image formats are supported:
223 223
 @item Microsoft RLE          @tab     @tab  X
224 224
 @item Microsoft Video-1      @tab     @tab  X
225 225
 @item Westwood VQA           @tab     @tab  X
226
-@item Id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
226
+@item id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
227 227
 @item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
228 228
 @item FLIC video             @tab     @tab  X
229 229
 @item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
... ...
@@ -248,7 +248,7 @@ following image formats are supported:
248 248
 @item KMVC                   @tab     @tab  X @tab Codec used in Worms games.
249 249
 @item VMware Video           @tab     @tab  X @tab Codec used in videos captured by VMware.
250 250
 @item Cin Video              @tab     @tab  X @tab Codec used in Delphine Software games.
251
-@item Tiertex Seq Video      @tab     @tab  X @tab Codec used in DOS CDROM FlashBack game.
251
+@item Tiertex Seq Video      @tab     @tab  X @tab Codec used in DOS CD-ROM FlashBack game.
252 252
 @item DXA Video              @tab     @tab  X @tab Codec originally used in Feeble Files game.
253 253
 @item AVID DNxHD             @tab   X @tab  X @tab aka SMPTE VC3
254 254
 @item C93 Video              @tab     @tab  X @tab Codec used in Cyberia game.
... ...
@@ -311,7 +311,7 @@ following image formats are supported:
311 311
 @item AMR-WB                 @tab X    @tab X
312 312
 @tab Supported through an external library.
313 313
 @item DV audio               @tab      @tab X
314
-@item Id RoQ DPCM            @tab X    @tab X
314
+@item id RoQ DPCM            @tab X    @tab X
315 315
 @tab Used in Quake III, Jedi Knight 2, other computer games.
316 316
 @item Interplay MVE DPCM     @tab      @tab X
317 317
 @tab Used in various Interplay computer games.
... ...
@@ -340,7 +340,7 @@ following image formats are supported:
340 340
 @item Intel Music Coder      @tab      @tab X
341 341
 @item Musepack               @tab      @tab X
342 342
 @tab SV7 and SV8 are supported
343
-@item DT$ Coherent Audio     @tab      @tab X
343
+@item DTS Coherent Audio     @tab      @tab X
344 344
 @item ATRAC 3                @tab      @tab X
345 345
 @item Monkey's Audio         @tab      @tab X @tab Only versions 3.97-3.99 are supported
346 346
 @item Nellymoser ASAO        @tab      @tab X