Browse code

doc: fix various typos and grammar errors

Signed-off-by: Moritz Barsnick <barsnick@gmx.net>
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>

Moritz Barsnick authored on 2016/10/10 03:51:57
Showing 10 changed files
... ...
@@ -1226,7 +1226,7 @@ Set to 1 to disable processing alpha (transparency). This works like the
1226 1226
 instead of alpha. Default is 0.
1227 1227
 
1228 1228
 @item codec_whitelist @var{list} (@emph{input})
1229
-"," separated List of allowed decoders. By default all are allowed.
1229
+"," separated list of allowed decoders. By default all are allowed.
1230 1230
 
1231 1231
 @item dump_separator @var{string} (@emph{input})
1232 1232
 Separator used to separate the fields printed on the command line about the
... ...
@@ -72,7 +72,7 @@ Do not try to resynchronize by looking for a certain optional start code.
72 72
 Virtual concatenation script demuxer.
73 73
 
74 74
 This demuxer reads a list of files and other directives from a text file and
75
-demuxes them one after the other, as if all their packet had been muxed
75
+demuxes them one after the other, as if all their packets had been muxed
76 76
 together.
77 77
 
78 78
 The timestamps in the files are adjusted so that the first file starts at 0
... ...
@@ -107,7 +107,7 @@ Identify the script type and version. It also sets the @option{safe} option
107 107
 to 1 if it was -1.
108 108
 
109 109
 To make FFmpeg recognize the format automatically, this directive must
110
-appears exactly as is (no extra space or byte-order-mark) on the very first
110
+appear exactly as is (no extra space or byte-order-mark) on the very first
111 111
 line of the script.
112 112
 
113 113
 @item @code{duration @var{dur}}
... ...
@@ -1008,7 +1008,7 @@ Dump each input packet to stderr.
1008 1008
 @item -hex (@emph{global})
1009 1009
 When dumping packets, also dump the payload.
1010 1010
 @item -re (@emph{input})
1011
-Read input at native frame rate. Mainly used to simulate a grab device.
1011
+Read input at native frame rate. Mainly used to simulate a grab device,
1012 1012
 or live input stream (e.g. when reading from a file). Should not be used
1013 1013
 with actual grab devices or live input streams (where it can cause packet
1014 1014
 loss).
... ...
@@ -176,10 +176,10 @@ loglevel will be used. If multiple loglevel parameters are given, using
176 176
 Show nothing at all; be silent.
177 177
 @item panic, 0
178 178
 Only show fatal errors which could lead the process to crash, such as
179
-and assert failure. This is not currently used for anything.
179
+an assertion failure. This is not currently used for anything.
180 180
 @item fatal, 8
181 181
 Only show fatal errors. These are errors after which the process absolutely
182
-cannot continue after.
182
+cannot continue.
183 183
 @item error, 16
184 184
 Show all errors, including ones which can be recovered from.
185 185
 @item warning, 24
... ...
@@ -195,13 +195,13 @@ Show everything, including debugging information.
195 195
 @item trace, 56
196 196
 @end table
197 197
 
198
-By default the program logs to stderr, if coloring is supported by the
198
+By default the program logs to stderr. If coloring is supported by the
199 199
 terminal, colors are used to mark errors and warnings. Log coloring
200 200
 can be disabled setting the environment variable
201 201
 @env{AV_LOG_FORCE_NOCOLOR} or @env{NO_COLOR}, or can be forced setting
202 202
 the environment variable @env{AV_LOG_FORCE_COLOR}.
203 203
 The use of the environment variable @env{NO_COLOR} is deprecated and
204
-will be dropped in a following FFmpeg version.
204
+will be dropped in a future FFmpeg version.
205 205
 
206 206
 @item -report
207 207
 Dump full command line and console output to a file named
... ...
@@ -911,14 +911,14 @@ A gate is mainly used to reduce lower parts of a signal. This kind of signal
911 911
 processing reduces disturbing noise between useful signals.
912 912
 
913 913
 Gating is done by detecting the volume below a chosen level @var{threshold}
914
-and divide it by the factor set with @var{ratio}. The bottom of the noise
914
+and dividing it by the factor set with @var{ratio}. The bottom of the noise
915 915
 floor is set via @var{range}. Because an exact manipulation of the signal
916 916
 would cause distortion of the waveform the reduction can be levelled over
917 917
 time. This is done by setting @var{attack} and @var{release}.
918 918
 
919 919
 @var{attack} determines how long the signal has to fall below the threshold
920 920
 before any reduction will occur and @var{release} sets the time the signal
921
-has to raise above the threshold to reduce the reduction again.
921
+has to rise above the threshold to reduce the reduction again.
922 922
 Shorter signals than the chosen attack time will be left untouched.
923 923
 
924 924
 @table @option
... ...
@@ -935,7 +935,7 @@ If a signal rises above this level the gain reduction is released.
935 935
 Default is 0.125. Allowed range is from 0 to 1.
936 936
 
937 937
 @item ratio
938
-Set a ratio about which the signal is reduced.
938
+Set a ratio by which the signal is reduced.
939 939
 Default is 2. Allowed range is from 1 to 9000.
940 940
 
941 941
 @item attack
... ...
@@ -958,19 +958,19 @@ Default is 2.828427125. Allowed range is from 1 to 8.
958 958
 
959 959
 @item detection
960 960
 Choose if exact signal should be taken for detection or an RMS like one.
961
-Default is rms. Can be peak or rms.
961
+Default is @code{rms}. Can be @code{peak} or @code{rms}.
962 962
 
963 963
 @item link
964 964
 Choose if the average level between all channels or the louder channel affects
965 965
 the reduction.
966
-Default is average. Can be average or maximum.
966
+Default is @code{average}. Can be @code{average} or @code{maximum}.
967 967
 @end table
968 968
 
969 969
 @section alimiter
970 970
 
971
-The limiter prevents input signal from raising over a desired threshold.
971
+The limiter prevents an input signal from rising over a desired threshold.
972 972
 This limiter uses lookahead technology to prevent your signal from distorting.
973
-It means that there is a small delay after signal is processed. Keep in mind
973
+It means that there is a small delay after the signal is processed. Keep in mind
974 974
 that the delay it produces is the attack time you set.
975 975
 
976 976
 The filter accepts the following options:
... ...
@@ -1453,7 +1453,7 @@ Set the number of samples per each output audio frame.
1453 1453
 
1454 1454
 The last output packet may contain a different number of samples, as
1455 1455
 the filter will flush all the remaining samples when the input audio
1456
-signal its end.
1456
+signals its end.
1457 1457
 
1458 1458
 The filter accepts the following options:
1459 1459
 
... ...
@@ -2559,7 +2559,7 @@ filtering with large delay. Default is disabled.
2559 2559
 Enable multichannels evaluation on gain. Default is disabled.
2560 2560
 
2561 2561
 @item zero_phase
2562
-Enable zero phase mode by substracting timestamp to compensate delay.
2562
+Enable zero phase mode by subtracting timestamp to compensate delay.
2563 2563
 Default is disabled.
2564 2564
 @end table
2565 2565
 
... ...
@@ -3388,7 +3388,7 @@ Can be specified in dB (in case "dB" is appended to the specified value)
3388 3388
 or amplitude ratio. Default value is @code{0}.
3389 3389
 
3390 3390
 @item leave_silence
3391
-This indicate that @var{stop_duration} length of audio should be left intact
3391
+This indicates that @var{stop_duration} length of audio should be left intact
3392 3392
 at the beginning of each period of silence.
3393 3393
 For example, if you want to remove long pauses between words but do not want
3394 3394
 to remove the pauses completely. Default value is @code{0}.
... ...
@@ -6721,10 +6721,10 @@ This option does not exist, please see the timeline system
6721 6721
 
6722 6722
 @item alpha
6723 6723
 Draw the text applying alpha blending. The value can
6724
-be either a number between 0.0 and 1.0
6725
-The expression accepts the same variables @var{x, y} do.
6724
+be a number between 0.0 and 1.0.
6725
+The expression accepts the same variables @var{x, y} as well.
6726 6726
 The default value is 1.
6727
-Please see fontcolor_expr
6727
+Please see @var{fontcolor_expr}.
6728 6728
 
6729 6729
 @item fontsize
6730 6730
 The font size to be used for drawing text.
... ...
@@ -6907,7 +6907,7 @@ the following expansion mechanism is used.
6907 6907
 The backslash character @samp{\}, followed by any character, always expands to
6908 6908
 the second character.
6909 6909
 
6910
-Sequence of the form @code{%@{...@}} are expanded. The text between the
6910
+Sequences of the form @code{%@{...@}} are expanded. The text between the
6911 6911
 braces is a function name, possibly followed by arguments separated by ':'.
6912 6912
 If the arguments contain special characters or delimiters (':' or '@}'),
6913 6913
 they should be escaped.
... ...
@@ -8854,8 +8854,8 @@ By default value is 0.
8854 8854
 
8855 8855
 Detect video interlacing type.
8856 8856
 
8857
-This filter tries to detect if the input frames as interlaced, progressive,
8858
-top or bottom field first. It will also try and detect fields that are
8857
+This filter tries to detect if the input frames are interlaced, progressive,
8858
+top or bottom field first. It will also try to detect fields that are
8859 8859
 repeated between adjacent frames (a sign of telecine).
8860 8860
 
8861 8861
 Single frame detection considers only immediately adjacent frames when classifying each frame.
... ...
@@ -8922,7 +8922,7 @@ Set progressive threshold.
8922 8922
 Threshold for repeated field detection.
8923 8923
 @item half_life
8924 8924
 Number of frames after which a given frame's contribution to the
8925
-statistics is halved (i.e., it contributes only 0.5 to it's
8925
+statistics is halved (i.e., it contributes only 0.5 to its
8926 8926
 classification). The default of 0 means that all frames seen are given
8927 8927
 full weight of 1.0 forever.
8928 8928
 @item analyze_interlaced_flag
... ...
@@ -14822,7 +14822,7 @@ syntax is deprecated:
14822 14822
 Create a pattern generated by an elementary cellular automaton.
14823 14823
 
14824 14824
 The initial state of the cellular automaton can be defined through the
14825
-@option{filename}, and @option{pattern} options. If such options are
14825
+@option{filename} and @option{pattern} options. If such options are
14826 14826
 not specified an initial state is created randomly.
14827 14827
 
14828 14828
 At each new frame a new row in the video is filled with the result of
... ...
@@ -15993,7 +15993,7 @@ Temporally interleave frames from several inputs.
15993 15993
 These filters read frames from several inputs and send the oldest
15994 15994
 queued frame to the output.
15995 15995
 
15996
-Input streams must have a well defined, monotonically increasing frame
15996
+Input streams must have well defined, monotonically increasing frame
15997 15997
 timestamp values.
15998 15998
 
15999 15999
 In order to submit one frame to output, these filters need to enqueue
... ...
@@ -16001,9 +16001,9 @@ at least one frame for each input, so they cannot work in case one
16001 16001
 input is not yet terminated and will not receive incoming frames.
16002 16002
 
16003 16003
 For example consider the case when one input is a @code{select} filter
16004
-which always drop input frames. The @code{interleave} filter will keep
16004
+which always drops input frames. The @code{interleave} filter will keep
16005 16005
 reading from that input, but it will never be able to send new frames
16006
-to output until the input will send an end-of-stream signal.
16006
+to output until the input sends an end-of-stream signal.
16007 16007
 
16008 16008
 Also, depending on inputs synchronization, the filters will drop
16009 16009
 frames in case one input receives more frames than the other ones, and
... ...
@@ -199,7 +199,7 @@ delayed bt the time duration specified in @var{offset}. Default value
199 199
 is @code{0} (meaning that no offset is applied).
200 200
 
201 201
 @item format_whitelist @var{list} (@emph{input})
202
-"," separated List of allowed demuxers. By default all are allowed.
202
+"," separated list of allowed demuxers. By default all are allowed.
203 203
 
204 204
 @item dump_separator @var{string} (@emph{input})
205 205
 Separator used to separate the fields printed on the command line about the
... ...
@@ -678,7 +678,7 @@ is an exact value. For HDV, it is not frame exact, since HDV does
678 678
 not have a fixed frame size.
679 679
 
680 680
 @item dvguid
681
-Select the capture device by specifying it's GUID. Capturing will only
681
+Select the capture device by specifying its GUID. Capturing will only
682 682
 be performed from the specified device and fails if no device with the
683 683
 given GUID is found. This is useful to select the input if multiple
684 684
 devices are connected at the same time.
... ...
@@ -1341,7 +1341,7 @@ ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1341 1341
 
1342 1342
 @table @option
1343 1343
 @item draw_mouse
1344
-Specify whether to draw the mouse pointer. A value of @code{0} specify
1344
+Specify whether to draw the mouse pointer. A value of @code{0} specifies
1345 1345
 not to draw the pointer. Default value is @code{1}.
1346 1346
 
1347 1347
 @item follow_mouse
... ...
@@ -295,14 +295,14 @@ the loops:
295 295
 ffmpeg -i INPUT -loop 10 -final_delay 500 out.gif
296 296
 @end example
297 297
 
298
-Note 1: if you wish to extract the frames in separate GIF files, you need to
298
+Note 1: if you wish to extract the frames into separate GIF files, you need to
299 299
 force the @ref{image2} muxer:
300 300
 @example
301 301
 ffmpeg -i INPUT -c:v gif -f image2 "out%d.gif"
302 302
 @end example
303 303
 
304
-Note 2: the GIF format has a very small time base: the delay between two frames
305
-can not be smaller than one centi second.
304
+Note 2: the GIF format has a very large time base: the delay between two frames
305
+can therefore not be smaller than one centi second.
306 306
 
307 307
 @anchor{hash}
308 308
 @section hash
... ...
@@ -173,7 +173,7 @@ earlier, place @code{c99wrap.exe} and @code{c99conv.exe} somewhere in your
173 173
 Next, make sure any other headers and libs you want to use, such as zlib, are
174 174
 located in a spot that the compiler can see. Do so by modifying the @code{LIB}
175 175
 and @code{INCLUDE} environment variables to include the @strong{Windows-style}
176
-paths to these directories. Alternatively, you can try and use the
176
+paths to these directories. Alternatively, you can try to use the
177 177
 @code{--extra-cflags}/@code{--extra-ldflags} configure options. If using MSVC
178 178
 2012 or earlier, place @code{inttypes.h} somewhere the compiler can see too.
179 179
 
... ...
@@ -357,7 +357,7 @@ autodetection in the future.
357 357
 If set to 1 enables experimental HTTP server. This can be used to send data when
358 358
 used as an output option, or read data from a client with HTTP POST when used as
359 359
 an input option.
360
-If set to 2 enables experimental mutli-client HTTP server. This is not yet implemented
360
+If set to 2 enables experimental multi-client HTTP server. This is not yet implemented
361 361
 in ffmpeg.c or ffserver.c and thus must not be used as a command line option.
362 362
 @example
363 363
 # Server side (sending):