[FFmpeg-devel] [PATCH 2/5] Use @verbatim instead of @example for ASCII arts
Timothy Gu
timothygu99 at gmail.com
Mon Mar 23 04:47:17 CET 2015
Partially fixes #3869.
---
doc/ffmpeg.texi | 20 ++++++++++----------
doc/ffserver.texi | 6 ++++--
doc/filters.texi | 4 ++--
3 files changed, 16 insertions(+), 14 deletions(-)
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 1dde682..5a979d5 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -80,7 +80,7 @@ The format option may be needed for raw input files.
The transcoding process in @command{ffmpeg} for each output can be described by
the following diagram:
- at example
+ at verbatim
_______ ______________
| | | |
| input | demuxer | encoded data | decoder
@@ -99,7 +99,7 @@ the following diagram:
|________| |______________|
- at end example
+ at end verbatim
@command{ffmpeg} calls the libavformat library (containing demuxers) to read
input files and get packets containing encoded data from them. When there are
@@ -124,7 +124,7 @@ Simple filtergraphs are those that have exactly one input and output, both of
the same type. In the above diagram they can be represented by simply inserting
an additional step between decoding and encoding:
- at example
+ at verbatim
_________ ______________
| | | |
| decoded | | encoded data |
@@ -136,19 +136,19 @@ an additional step between decoding and encoding:
| frames |
|__________|
- at end example
+ at end verbatim
Simple filtergraphs are configured with the per-stream @option{-filter} option
(with @option{-vf} and @option{-af} aliases for video and audio respectively).
A simple filtergraph for video can look for example like this:
- at example
+ at verbatim
_______ _____________ _______ ________
| | | | | | | |
| input | ---> | deinterlace | ---> | scale | ---> | output |
|_______| |_____________| |_______| |________|
- at end example
+ at end verbatim
Note that some filters change frame properties but not frame contents. E.g. the
@code{fps} filter in the example above changes number of frames, but does not
@@ -161,7 +161,7 @@ processing chain applied to one stream. This is the case, for example, when the
more than one input and/or output, or when output stream type is different from
input. They can be represented with the following diagram:
- at example
+ at verbatim
_________
| |
| input 0 |\ __________
@@ -179,7 +179,7 @@ input. They can be represented with the following diagram:
| input 2 |/
|_________|
- at end example
+ at end verbatim
Complex filtergraphs are configured with the @option{-filter_complex} option.
Note that this option is global, since a complex filtergraph, by its nature,
@@ -198,14 +198,14 @@ step for the specified stream, so it does only demuxing and muxing. It is useful
for changing the container format or modifying container-level metadata. The
diagram above will, in this case, simplify to this:
- at example
+ at verbatim
_______ ______________ ________
| | | | | |
| input | demuxer | encoded data | muxer | output |
| file | ---------> | packets | -------> | file |
|_______| |______________| |________|
- at end example
+ at end verbatim
Since there is no decoding or encoding, it is very fast and there is no quality
loss. However, it might not work in some cases because of many factors. Applying
diff --git a/doc/ffserver.texi b/doc/ffserver.texi
index 336cec1..ad48f47 100644
--- a/doc/ffserver.texi
+++ b/doc/ffserver.texi
@@ -118,7 +118,8 @@ Multiple streams can be connected to the same feed.
For example, you can have a situation described by the following
graph:
- at example
+
+ at verbatim
_________ __________
| | | |
ffmpeg 1 -----| feed 1 |-----| stream 1 |
@@ -143,7 +144,8 @@ ffmpeg 2 -----| feed 3 |-----| stream 4 |
| | | |
| file 1 |-----| stream 5 |
|_________| |__________|
- at end example
+
+ at end verbatim
@anchor{FFM}
@section FFM, FFM2 formats
diff --git a/doc/filters.texi b/doc/filters.texi
index 0654531..aea7272 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -8,13 +8,13 @@ outputs.
To illustrate the sorts of things that are possible, we consider the
following filtergraph.
- at example
+ at verbatim
[main]
input --> split ---------------------> overlay --> output
| ^
|[tmp] [flip]|
+-----> crop --> vflip -------+
- at end example
+ at end verbatim
This filtergraph splits the input stream in two streams, then sends one
stream through the crop filter and the vflip filter, before merging it
--
1.9.1
More information about the ffmpeg-devel
mailing list