summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVittorio Giovara <vittorio.giovara@gmail.com>2016-04-27 13:45:23 -0400
committerDiego Biurrun <diego@biurrun.de>2016-05-04 18:16:21 +0200
commit41ed7ab45fc693f7d7fc35664c0233f4c32d69bb (patch)
tree146a086cf7c1881d55f9261b58138983e13af21c /doc
parent5c31eaa9998b2185e0aa04d11adff128498dc14a (diff)
cosmetics: Fix spelling mistakes
Signed-off-by: Diego Biurrun <diego@biurrun.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/APIchanges6
-rw-r--r--doc/avconv.texi4
-rw-r--r--doc/avplay.texi4
-rw-r--r--doc/avtools-common-opts.texi2
-rw-r--r--doc/avutil.txt2
-rw-r--r--doc/developer.texi4
-rw-r--r--doc/encoders.texi4
-rw-r--r--doc/examples/avcodec.c20
-rw-r--r--doc/examples/output.c2
-rw-r--r--doc/fate.texi6
-rw-r--r--doc/filters.texi10
-rw-r--r--doc/git-howto.texi2
-rw-r--r--doc/indevs.texi2
-rw-r--r--doc/nut.texi2
-rw-r--r--doc/optimization.txt4
-rw-r--r--doc/platform.texi4
-rw-r--r--doc/swscale.txt4
-rw-r--r--doc/viterbi.txt14
18 files changed, 48 insertions, 48 deletions
diff --git a/doc/APIchanges b/doc/APIchanges
index c3b81faf36..b83c5aede4 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -23,7 +23,7 @@ API changes, most recent first:
2016-xx-xx - xxxxxxx - lavc 57.15.0 - avcodec.h
Add a new bitstream filtering API working with AVPackets.
- Deprecate the old bistream filtering API.
+ Deprecate the old bitstream filtering API.
2016-xx-xx - xxxxxxx - lavfi 6.3.0 - avfilter.h
Add AVFilterContext.hw_device_ctx.
@@ -501,7 +501,7 @@ API changes, most recent first:
2013-08-05 - f824535 - lavc 55.13.0 - avcodec.h
Deprecate the bitstream-related members from struct AVVDPAUContext.
- The bistream buffers no longer need to be explicitly freed.
+ The bitstream buffers no longer need to be explicitly freed.
2013-08-05 - 549294f - lavc 55.12.0 - avcodec.h
Deprecate the CODEC_CAP_HWACCEL_VDPAU codec capability. Use CODEC_CAP_HWACCEL
@@ -591,7 +591,7 @@ lavd 54.0.0, lavfi 3.5.0
* base -- is now stored in AVBufferRef
* reference, type, buffer_hints -- are unnecessary in the new API
* hwaccel_picture_private, owner, thread_opaque -- should not
- have been acessed from outside of lavc
+ have been accessed from outside of lavc
* qscale_table, qstride, qscale_type, mbskip_table, motion_val,
mb_type, dct_coeff, ref_index -- mpegvideo-specific tables,
which are not exported anymore.
diff --git a/doc/avconv.texi b/doc/avconv.texi
index 6aaf445d55..cdfef55478 100644
--- a/doc/avconv.texi
+++ b/doc/avconv.texi
@@ -641,7 +641,7 @@ For DXVA2, this option should contain the number of the display adapter to use.
If this option is not specified, the default adapter is used.
@item qsv
-For QSV, this option corresponds to the valus of MFX_IMPL_* . Allowed values
+For QSV, this option corresponds to the values of MFX_IMPL_* . Allowed values
are:
@table @option
@item auto
@@ -886,7 +886,7 @@ avconv -i infile -streamid 0:33 -streamid 1:36 out.ts
@end example
@item -bsf[:@var{stream_specifier}] @var{bitstream_filters} (@emph{output,per-stream})
-Set bitstream filters for matching streams. @var{bistream_filters} is
+Set bitstream filters for matching streams. @var{bitstream_filters} is
a comma-separated list of bitstream filters. Use the @code{-bsfs} option
to get the list of bitstream filters.
@example
diff --git a/doc/avplay.texi b/doc/avplay.texi
index d143f75201..0f72cfd984 100644
--- a/doc/avplay.texi
+++ b/doc/avplay.texi
@@ -20,7 +20,7 @@ avplay [options] @file{input_file}
@chapter Description
@c man begin DESCRIPTION
-AVplay is a very simple and portable media player using the Libav
+avplay is a very simple and portable media player using the Libav
libraries and the SDL library. It is mostly used as a testbed for the
various Libav APIs.
@c man end
@@ -171,7 +171,7 @@ Seek to percentage in file corresponding to fraction of width.
@ignore
@setfilename avplay
-@settitle AVplay media player
+@settitle avplay media player
@c man begin SEEALSO
avconv(1), avprobe(1) and the Libav HTML documentation
diff --git a/doc/avtools-common-opts.texi b/doc/avtools-common-opts.texi
index 79f764b58c..a7b0e03460 100644
--- a/doc/avtools-common-opts.texi
+++ b/doc/avtools-common-opts.texi
@@ -19,7 +19,7 @@ are used to precisely specify which stream(s) does a given option belong to.
A stream specifier is a string generally appended to the option name and
separated from it by a colon. E.g. @code{-codec:a:1 ac3} option contains
-@code{a:1} stream specifer, which matches the second audio stream. Therefore it
+@code{a:1} stream specifier, which matches the second audio stream. Therefore it
would select the ac3 codec for the second audio stream.
A stream specifier can match several stream, the option is then applied to all
diff --git a/doc/avutil.txt b/doc/avutil.txt
index 0847683d1d..b8e5ca5b92 100644
--- a/doc/avutil.txt
+++ b/doc/avutil.txt
@@ -15,7 +15,7 @@ md5.c MD5 Message-Digest Algorithm
rational.c code to perform exact calculations with rational numbers
tree.c generic AVL tree
crc.c generic CRC checksumming code
-integer.c 128bit integer math
+integer.c 128-bit integer math
lls.c
mathematics.c greatest common divisor, integer sqrt, integer log2, ...
mem.c memory allocation routines with guaranteed alignment
diff --git a/doc/developer.texi b/doc/developer.texi
index 5051d333bf..31c2bafbe4 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -23,7 +23,7 @@ player. See @file{doc/examples/output.c} to use it to generate
audio or video streams.
@end itemize
-@section Integrating libav in your program
+@section Integrating Libav in your program
Shared libraries should be used whenever is possible in order to reduce
the effort distributors have to pour to support programs and to ensure
@@ -617,7 +617,7 @@ least make sure that it does not break anything.
If the code changed has already a test present in FATE you should run it,
otherwise it is advised to add it.
-Improvements to codec or demuxer might change the FATE results. Make sure
+Improvements to a codec or demuxer might change the FATE results. Make sure
to commit the update reference with the change and to explain in the comment
why the expected result changed.
diff --git a/doc/encoders.texi b/doc/encoders.texi
index 315c901ecb..bc5b33660e 100644
--- a/doc/encoders.texi
+++ b/doc/encoders.texi
@@ -803,8 +803,8 @@ Use @var{0} to disable alpha plane coding.
@subsection Speed considerations
In the default mode of operation the encoder has to honor frame constraints
-(i.e. not produc frames with size bigger than requested) while still making
-output picture as good as possible.
+(i.e. not produce frames with a size larger than requested) while still making
+the output picture as good as possible.
A frame containing a lot of small details is harder to compress and the encoder
would spend more time searching for appropriate quantizers for each slice.
diff --git a/doc/examples/avcodec.c b/doc/examples/avcodec.c
index df0af4b1ea..f8d043facf 100644
--- a/doc/examples/avcodec.c
+++ b/doc/examples/avcodec.c
@@ -23,9 +23,9 @@
* libavcodec API use example.
*
* @example avcodec.c
- * Note that this library only handles codecs (mpeg, mpeg4, etc...),
- * not file formats (avi, vob, etc...). See library 'libavformat' for the
- * format handling
+ * Note that this library only handles codecs (MPEG, MPEG-4, etc...),
+ * not file formats (AVI, VOB, etc...). See library 'libavformat' for the
+ * format handling.
*/
#include <stdlib.h>
@@ -234,7 +234,7 @@ static void audio_decode_example(const char *outfilename, const char *filename)
printf("Audio decoding\n");
- /* find the mpeg audio decoder */
+ /* find the MPEG audio decoder */
codec = avcodec_find_decoder(AV_CODEC_ID_MP2);
if (!codec) {
fprintf(stderr, "codec not found\n");
@@ -325,7 +325,7 @@ static void video_encode_example(const char *filename)
printf("Video encoding\n");
- /* find the mpeg1 video encoder */
+ /* find the mpeg1video encoder */
codec = avcodec_find_encoder(AV_CODEC_ID_MPEG1VIDEO);
if (!codec) {
fprintf(stderr, "codec not found\n");
@@ -424,7 +424,7 @@ static void video_encode_example(const char *filename)
}
}
- /* add sequence end code to have a real mpeg file */
+ /* add sequence end code to have a real MPEG file */
fwrite(endcode, 1, sizeof(endcode), f);
fclose(f);
@@ -465,12 +465,12 @@ static void video_decode_example(const char *outfilename, const char *filename)
av_init_packet(&avpkt);
- /* set end of buffer to 0 (this ensures that no overreading happens for damaged mpeg streams) */
+ /* set end of buffer to 0 (this ensures that no overreading happens for damaged MPEG streams) */
memset(inbuf + INBUF_SIZE, 0, AV_INPUT_BUFFER_PADDING_SIZE);
printf("Video decoding\n");
- /* find the mpeg1 video decoder */
+ /* find the MPEG-1 video decoder */
codec = avcodec_find_decoder(AV_CODEC_ID_MPEG1VIDEO);
if (!codec) {
fprintf(stderr, "codec not found\n");
@@ -545,9 +545,9 @@ static void video_decode_example(const char *outfilename, const char *filename)
}
}
- /* some codecs, such as MPEG, transmit the I and P frame with a
+ /* Some codecs, such as MPEG, transmit the I- and P-frame with a
latency of one frame. You must do the following to have a
- chance to get the last frame of the video */
+ chance to get the last frame of the video. */
avpkt.data = NULL;
avpkt.size = 0;
len = avcodec_decode_video2(c, picture, &got_picture, &avpkt);
diff --git a/doc/examples/output.c b/doc/examples/output.c
index cc2cbb1bae..44a55f5645 100644
--- a/doc/examples/output.c
+++ b/doc/examples/output.c
@@ -365,7 +365,7 @@ static void add_video_stream(OutputStream *ost, AVFormatContext *oc,
c->gop_size = 12; /* emit one intra frame every twelve frames at most */
c->pix_fmt = STREAM_PIX_FMT;
if (c->codec_id == AV_CODEC_ID_MPEG2VIDEO) {
- /* just for testing, we also add B frames */
+ /* just for testing, we also add B-frames */
c->max_b_frames = 2;
}
if (c->codec_id == AV_CODEC_ID_MPEG1VIDEO) {
diff --git a/doc/fate.texi b/doc/fate.texi
index d6beaa5c24..ae326fe749 100644
--- a/doc/fate.texi
+++ b/doc/fate.texi
@@ -11,7 +11,7 @@
@chapter Introduction
-FATE provides a regression testsuite embedded within the Libav build system.
+FATE provides a regression test suite embedded within the Libav build system.
It can be run locally and optionally configured to send reports to a web
aggregator and viewer @url{http://fate.libav.org}.
@@ -24,7 +24,7 @@ and provide new tests when submitting patches to add additional features.
In order to run, FATE needs a large amount of data (samples and references)
that is provided separately from the actual source distribution.
-To inform the build system about the testsuite location, pass
+To inform the build system about the test suite location, pass
@option{--samples=<path to the samples>} to @command{configure} or set the
@var{SAMPLES} Make variable or the @var{LIBAV_SAMPLES} environment variable
to a suitable value.
@@ -57,7 +57,7 @@ Specific Makefile targets and Makefile variables are available:
List all fate/regression test targets.
@item fate-rsync
-Shortcut to download the fate test samples to the specified testsuite location.
+Shortcut to download the fate test samples to the specified test suite location.
@item fate
Run the FATE test suite (requires the fate-suite dataset).
diff --git a/doc/filters.texi b/doc/filters.texi
index 23e4286da8..2651f170a0 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -1541,7 +1541,7 @@ For more information, see
@section gradfun
Fix the banding artifacts that are sometimes introduced into nearly flat
-regions by truncation to 8bit colordepth.
+regions by truncation to 8-bit colordepth.
Interpolate the gradients that should go where the bands are, and
dither them.
@@ -1900,7 +1900,7 @@ libopencv function @code{cvSmooth}.
Overlay one video on top of another.
It takes two inputs and has one output. The first input is the "main"
-video on which the second input is overlayed.
+video on which the second input is overlaid.
It accepts the following parameters:
@@ -2327,7 +2327,7 @@ select='not(mod(n\,100))'
# Select only frames contained in the 10-20 time interval
select='gte(t\,10)*lte(t\,20)'
-# Select only I frames contained in the 10-20 time interval
+# Select only I-frames contained in the 10-20 time interval
select='gte(t\,10)*lte(t\,20)*eq(pict_type\,I)'
# Select frames with a minimum distance of 10 seconds
@@ -2957,7 +2957,7 @@ number or a valid video frame rate abbreviation. The default value is
The following graph description will generate a red source
with an opacity of 0.2, with size "qcif" and a frame rate of 10
-frames per second, which will be overlayed over the source connected
+frames per second, which will be overlaid over the source connected
to the pad with identifier "in":
@example
@@ -3070,7 +3070,7 @@ A '|'-separated list of parameters to pass to the frei0r source.
An example:
@example
# Generate a frei0r partik0l source with size 200x200 and framerate 10
-# which is overlayed on the overlay filter main input
+# which is overlaid on the overlay filter's main input
frei0r_src=size=200x200:framerate=10:filter_name=partik0l:filter_params=1234 [overlay]; [in][overlay] overlay
@end example
diff --git a/doc/git-howto.texi b/doc/git-howto.texi
index 5a8e2a3823..a746b1ae49 100644
--- a/doc/git-howto.texi
+++ b/doc/git-howto.texi
@@ -399,7 +399,7 @@ to ensure no local changes still need to be committed and that no local
changes may have thrown off the results of your testing.
@end itemize
-Next let the code pass through a full run of our testsuite. Before you do,
+Next let the code pass through a full run of our test suite. Before you do,
the command @command{make fate-rsync} will update the test samples. Changes
to the samples set are not very common and commits depending on samples
changes are delayed for at least 24 hours to allow the new samples to
diff --git a/doc/indevs.texi b/doc/indevs.texi
index 30427905ff..a08c7a5f6b 100644
--- a/doc/indevs.texi
+++ b/doc/indevs.texi
@@ -369,7 +369,7 @@ The syntax is:
-grab_x @var{x_offset} -grab_y @var{y_offset}
@end example
-Set the grabing region coordinates. The are expressed as offset from the top left
+Set the grabbing region coordinates. The are expressed as offset from the top left
corner of the X11 window. The default value is 0.
@c man end INPUT DEVICES
diff --git a/doc/nut.texi b/doc/nut.texi
index 042c88a3ab..1b02c6393c 100644
--- a/doc/nut.texi
+++ b/doc/nut.texi
@@ -29,7 +29,7 @@ NUT has some variants signaled by using the flags field in its main header.
The BROADCAST variant provides a secondary time reference to facilitate
detecting endpoint latency and network delays.
-It assumes all the endpoint clocks are syncronized.
+It assumes all the endpoint clocks are synchronized.
To be used in real-time scenarios.
@section PIPE
diff --git a/doc/optimization.txt b/doc/optimization.txt
index b3dca645a8..9847dcf20a 100644
--- a/doc/optimization.txt
+++ b/doc/optimization.txt
@@ -7,7 +7,7 @@ If you plan to do non-x86 architecture specific optimizations (SIMD normally),
then take a look in the x86/ directory, as most important functions are
already optimized for MMX.
-If you want to do x86 optimizations then you can either try to finetune the
+If you want to do x86 optimizations then you can either try to fine-tune the
stuff in the x86 directory or find some other functions in the C source to
optimize, but there aren't many left.
@@ -163,7 +163,7 @@ general x86 registers (e.g. eax) as well as XMM registers. This last one is
particularly important on Win64, where xmm6-15 are callee-save, and not
restoring their contents leads to undefined results. In external asm (e.g.
yasm), you do this by using:
-cglobal functon_name, num_args, num_regs, num_xmm_regs
+cglobal function_name, num_args, num_regs, num_xmm_regs
In inline asm, you specify clobbered registers at the end of your asm:
__asm__(".." ::: "%eax").
If gcc is not set to support sse (-msse) it will not accept xmm registers
diff --git a/doc/platform.texi b/doc/platform.texi
index 9c2b9bb067..4feb50f7ec 100644
--- a/doc/platform.texi
+++ b/doc/platform.texi
@@ -62,7 +62,7 @@ bash ./configure
@section Darwin (OS X, iPhone)
The toolchain provided with Xcode is sufficient to build the basic
-unacelerated code.
+unaccelerated code.
OS X on PowerPC or ARM (iPhone) requires a preprocessor from
@url{git://git.libav.org/gas-preprocessor.git} to build the optimized
@@ -137,7 +137,7 @@ pacman -S make pkgconf diffutils
pacman -S mingw-w64-x86_64-yasm mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL
@end example
-To target 32bit replace the @code{x86_64} with @code{i686} in the command above.
+To target 32 bits replace @code{x86_64} with @code{i686} in the command above.
@section Microsoft Visual C++ or Intel C++ Compiler for Windows
diff --git a/doc/swscale.txt b/doc/swscale.txt
index 206600976c..dbb4e2901e 100644
--- a/doc/swscale.txt
+++ b/doc/swscale.txt
@@ -10,12 +10,12 @@ Current (simplified) Architecture:
/ \
special converter [Input to YUV converter]
| |
- | (8bit YUV 4:4:4 / 4:2:2 / 4:2:0 / 4:0:0 )
+ | (8-bit YUV 4:4:4 / 4:2:2 / 4:2:0 / 4:0:0 )
| |
| v
| Horizontal scaler
| |
- | (15bit YUV 4:4:4 / 4:2:2 / 4:2:0 / 4:1:1 / 4:0:0 )
+ | (15-bit YUV 4:4:4 / 4:2:2 / 4:2:0 / 4:1:1 / 4:0:0 )
| |
| v
| Vertical scaler and output converter
diff --git a/doc/viterbi.txt b/doc/viterbi.txt
index 97825462cc..712fc4b150 100644
--- a/doc/viterbi.txt
+++ b/doc/viterbi.txt
@@ -1,7 +1,7 @@
-This is a quick description of the viterbi aka dynamic programing
-algorthm.
+This is a quick description of the Viterbi aka dynamic programming
+algorithm.
-Its reason for existence is that wikipedia has become very poor on
+Its reason for existence is that Wikipedia has become very poor on
describing algorithms in a way that makes it useable for understanding
them or anything else actually. It tends now to describe the very same
algorithm under 50 different names and pages with few understandable
@@ -41,7 +41,7 @@ readable)
Our goal is to find a path from left to right through it which
minimizes the sum of the score of all edges.
(and of course left/right is just a convention here it could be top down too)
-Similarly the minimum could be the maximum by just fliping the sign,
+Similarly the minimum could be the maximum by just flipping the sign,
Example of a path with scores:
O O O O O O O
@@ -53,7 +53,7 @@ Example of a path with scores:
O O O O O O-1-O---> (sum here is 24)
-The viterbi algorthm now solves this simply column by column
+The Viterbi algorithm now solves this simply column by column
For the previous column each point has a best path and a associated
score:
@@ -100,10 +100,10 @@ trivial given we know the previous column best paths and scores:
O 0 4
-the viterbi algorthm continues exactly like this column for column until the
+the Viterbi algorithm continues exactly like this column for column until the
end and then just picks the path with the best score (above that would be the
one with score 3)
-Author: Michael niedermayer
+Author: Michael Niedermayer
Copyright LGPL