aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorClément Bœsch <u@pkh.me>2016-06-21 21:55:20 +0200
committerClément Bœsch <u@pkh.me>2016-06-21 21:55:34 +0200
commit8ef57a0d6154119e1a616dd8c29e8c32e35808a0 (patch)
tree26c51bc5d99260b44ba3a2585091ca764559f939 /doc
parent373b82066cd4d0c7f42af9b03e8cdc1085e1a6e5 (diff)
parent41ed7ab45fc693f7d7fc35664c0233f4c32d69bb (diff)
downloadffmpeg-8ef57a0d6154119e1a616dd8c29e8c32e35808a0.tar.gz
Merge commit '41ed7ab45fc693f7d7fc35664c0233f4c32d69bb'
* commit '41ed7ab45fc693f7d7fc35664c0233f4c32d69bb': cosmetics: Fix spelling mistakes Merged-by: Clément Bœsch <u@pkh.me>
Diffstat (limited to 'doc')
-rw-r--r--doc/APIchanges2
-rw-r--r--doc/examples/decoding_encoding.c20
-rw-r--r--doc/examples/muxing.c2
-rw-r--r--doc/ffmpeg.texi2
-rw-r--r--doc/filters.texi6
-rw-r--r--doc/git-howto.texi4
-rw-r--r--doc/nut.texi2
-rw-r--r--doc/optimization.txt4
-rw-r--r--doc/platform.texi4
-rw-r--r--doc/swscale.txt4
10 files changed, 25 insertions, 25 deletions
diff --git a/doc/APIchanges b/doc/APIchanges
index bc5bb5bb2f..15d52feff7 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -1175,7 +1175,7 @@ lavd 54.4.100 / 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/examples/decoding_encoding.c b/doc/examples/decoding_encoding.c
index 06a98a630e..43a64c2d59 100644
--- a/doc/examples/decoding_encoding.c
+++ b/doc/examples/decoding_encoding.c
@@ -25,9 +25,9 @@
* libavcodec API use example.
*
* @example decoding_encoding.c
- * Note that libavcodec only handles codecs (mpeg, mpeg4, etc...),
- * not file formats (avi, vob, mp4, mov, mkv, mxf, flv, mpegts, mpegps, etc...). See library 'libavformat' for the
- * format handling
+ * Note that libavcodec only handles codecs (MPEG, MPEG-4, etc...),
+ * not file formats (AVI, VOB, MP4, MOV, MKV, MXF, FLV, MPEG-TS, MPEG-PS, etc...).
+ * See library 'libavformat' for the format handling
*/
#include <math.h>
@@ -253,7 +253,7 @@ static void audio_decode_example(const char *outfilename, const char *filename)
printf("Decode audio file %s to %s\n", filename, outfilename);
- /* 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");
@@ -356,7 +356,7 @@ static void video_encode_example(const char *filename, int codec_id)
printf("Encode video file %s\n", filename);
- /* find the mpeg1 video encoder */
+ /* find the video encoder */
codec = avcodec_find_encoder(codec_id);
if (!codec) {
fprintf(stderr, "Codec not found\n");
@@ -475,7 +475,7 @@ static void video_encode_example(const char *filename, int codec_id)
}
}
- /* 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);
@@ -543,12 +543,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("Decode video file %s to %s\n", filename, outfilename);
- /* 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");
@@ -613,9 +613,9 @@ static void video_decode_example(const char *outfilename, const char *filename)
exit(1);
}
- /* 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;
decode_write_frame(outfilename, c, frame, &frame_count, &avpkt, 1);
diff --git a/doc/examples/muxing.c b/doc/examples/muxing.c
index 2fc6f710ee..f1f5bb8239 100644
--- a/doc/examples/muxing.c
+++ b/doc/examples/muxing.c
@@ -161,7 +161,7 @@ static void add_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/ffmpeg.texi b/doc/ffmpeg.texi
index e02807cb47..7368cdbbbd 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -720,7 +720,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
diff --git a/doc/filters.texi b/doc/filters.texi
index f47b0ccbb8..7267b21874 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -5667,7 +5667,7 @@ It accepts the following parameters:
@item limit
Set higher black value threshold, which can be optionally specified
-from nothing (0) to everything (255 for 8bit based formats). An intensity
+from nothing (0) to everything (255 for 8-bit based formats). An intensity
value greater to the set value is considered non-black. It defaults to 24.
You can also specify a value between 0.0 and 1.0 which will be scaled depending
on the bitdepth of the pixel format.
@@ -8305,7 +8305,7 @@ geq=lum=255*gauss((X/W-0.5)*3)*gauss((Y/H-0.5)*3)/gauss(0)/gauss(0),format=gray
@section gradfun
Fix the banding artifacts that are sometimes introduced into nearly flat
-regions by truncation to 8bit color depth.
+regions by truncation to 8-bit color depth.
Interpolate the gradients that should go where the bands are, and
dither them.
@@ -15588,7 +15588,7 @@ select=between(t\,10\,20)
@end example
@item
-Select only I frames contained in the 10-20 time interval:
+Select only I-frames contained in the 10-20 time interval:
@example
select=between(t\,10\,20)*eq(pict_type\,I)
@end example
diff --git a/doc/git-howto.texi b/doc/git-howto.texi
index e5e3c81795..2b4fb80233 100644
--- a/doc/git-howto.texi
+++ b/doc/git-howto.texi
@@ -408,7 +408,7 @@ with @option{--dry-run} first. And then inspecting the commits listed with
@command{git log -p 1234567..987654}. The @command{git status} command
may help in finding local changes that have been forgotten to be added.
-Next let the code pass through a full run of our testsuite.
+Next let the code pass through a full run of our test suite.
@itemize
@item @command{make distclean}
@@ -418,7 +418,7 @@ Next let the code pass through a full run of our testsuite.
@end itemize
Make sure all your changes have been checked before pushing them, the
-testsuite only checks against regressions and that only to some extend. It does
+test suite only checks against regressions and that only to some extend. It does
obviously not check newly added features/code to be working unless you have
added a test for that (which is recommended).
diff --git a/doc/nut.texi b/doc/nut.texi
index a02f86ace0..f9b18f5660 100644
--- a/doc/nut.texi
+++ b/doc/nut.texi
@@ -34,7 +34,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 1a0b98cd0e..b4b0a064c3 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 f7ee456483..21b135f55d 100644
--- a/doc/platform.texi
+++ b/doc/platform.texi
@@ -63,7 +63,7 @@ bash ./configure
@section Darwin (Mac OS X, iPhone)
The toolchain provided with Xcode is sufficient to build the basic
-unacelerated code.
+unaccelerated code.
Mac OS X on PowerPC or ARM (iPhone) requires a preprocessor from
@url{https://github.com/FFmpeg/gas-preprocessor} or
@@ -144,7 +144,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