[FFmpeg-devel] [PATCH] doc: merge eval.texi and syntax.texi to utils.texi

Stefano Sabatini stefasab at gmail.com
Wed Apr 10 18:18:08 CEST 2013


---
 doc/all-components.texi       |    3 +-
 doc/ffmpeg-utils.texi         |    3 +-
 doc/syntax.texi               |  258 ----------------------------------------
 doc/{eval.texi => utils.texi} |  259 +++++++++++++++++++++++++++++++++++++++++
 4 files changed, 261 insertions(+), 262 deletions(-)
 delete mode 100644 doc/syntax.texi
 rename doc/{eval.texi => utils.texi} (61%)

diff --git a/doc/all-components.texi b/doc/all-components.texi
index a0f1134..177cf10 100644
--- a/doc/all-components.texi
+++ b/doc/all-components.texi
@@ -1,8 +1,7 @@
 @include config.texi
 
 @ifset config-avutil
- at include syntax.texi
- at include eval.texi
+ at include utils.texi
 @end ifset
 
 @ifset config-avcodec
diff --git a/doc/ffmpeg-utils.texi b/doc/ffmpeg-utils.texi
index c5822a8..581e2ea 100644
--- a/doc/ffmpeg-utils.texi
+++ b/doc/ffmpeg-utils.texi
@@ -17,8 +17,7 @@ by the libavutil library.
 
 @c man end DESCRIPTION
 
- at include syntax.texi
- at include eval.texi
+ at include utils.texi
 
 @chapter See Also
 
diff --git a/doc/syntax.texi b/doc/syntax.texi
deleted file mode 100644
index af22d6c..0000000
--- a/doc/syntax.texi
+++ /dev/null
@@ -1,258 +0,0 @@
- at chapter Syntax
- at c man begin SYNTAX
-
-This section documents the syntax and formats employed by the FFmpeg
-libraries and tools.
-
- at anchor{quoting_and_escaping}
- at section Quoting and escaping
-
-FFmpeg adopts the following quoting and escaping mechanism, unless
-explicitly specified. The following rules are applied:
-
- at itemize
- at item
- at code{'} and @code{\} are special characters (respectively used for
-quoting and escaping). In addition to them, there might be other
-special characters depending on the specific syntax where the escaping
-and quoting are employed.
-
- at item
-A special character is escaped by prefixing it with a '\'.
-
- at item
-All characters enclosed between '' are included literally in the
-parsed string. The quote character @code{'} itself cannot be quoted,
-so you may need to close the quote and escape it.
-
- at item
-Leading and trailing whitespaces, unless escaped or quoted, are
-removed from the parsed string.
- at end itemize
-
-Note that you may need to add a second level of escaping when using
-the command line or a script, which depends on the syntax of the
-adopted shell language.
-
-The function @code{av_get_token} defined in
- at file{libavutil/avstring.h} can be used to parse a token quoted or
-escaped according to the rules defined above.
-
-The tool @file{tools/ffescape} in the FFmpeg source tree can be used
-to automatically quote or escape a string in a script.
-
- at subsection Examples
-
- at itemize
- at item
-Escape the string @code{Crime d'Amour} containing the @code{'} special
-character:
- at example
-Crime d\'Amour
- at end example
-
- at item
-The string above contains a quote, so the @code{'} needs to be escaped
-when quoting it:
- at example
-'Crime d'\''Amour'
- at end example
-
- at item
-Include leading or trailing whitespaces using quoting:
- at example
-'  this string starts and ends with whitespaces  '
- at end example
-
- at item
-Escaping and quoting can be mixed together:
- at example
-' The string '\'string\'' is a string '
- at end example
-
- at item
-To include a literal @code{\} you can use either escaping or quoting:
- at example
-'c:\foo' can be written as c:\\foo
- at end example
- at end itemize
-
- at anchor{date syntax}
- at section Date
-
-The accepted syntax is:
- at example
-[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
-now
- at end example
-
-If the value is "now" it takes the current time.
-
-Time is local time unless Z is appended, in which case it is
-interpreted as UTC.
-If the year-month-day part is not specified it takes the current
-year-month-day.
-
- at anchor{time duration syntax}
- at section Time duration
-
-The accepted syntax is:
- at example
-[-][HH:]MM:SS[.m...]
-[-]S+[.m...]
- at end example
-
- at var{HH} expresses the number of hours, @var{MM} the number a of minutes
-and @var{SS} the number of seconds.
-
- at anchor{video size syntax}
- at section Video size
-Specify the size of the sourced video, it may be a string of the form
- at var{width}x at var{height}, or the name of a size abbreviation.
-
-The following abbreviations are recognized:
- at table @samp
- at item ntsc
-720x480
- at item pal
-720x576
- at item qntsc
-352x240
- at item qpal
-352x288
- at item sntsc
-640x480
- at item spal
-768x576
- at item film
-352x240
- at item ntsc-film
-352x240
- at item sqcif
-128x96
- at item qcif
-176x144
- at item cif
-352x288
- at item 4cif
-704x576
- at item 16cif
-1408x1152
- at item qqvga
-160x120
- at item qvga
-320x240
- at item vga
-640x480
- at item svga
-800x600
- at item xga
-1024x768
- at item uxga
-1600x1200
- at item qxga
-2048x1536
- at item sxga
-1280x1024
- at item qsxga
-2560x2048
- at item hsxga
-5120x4096
- at item wvga
-852x480
- at item wxga
-1366x768
- at item wsxga
-1600x1024
- at item wuxga
-1920x1200
- at item woxga
-2560x1600
- at item wqsxga
-3200x2048
- at item wquxga
-3840x2400
- at item whsxga
-6400x4096
- at item whuxga
-7680x4800
- at item cga
-320x200
- at item ega
-640x350
- at item hd480
-852x480
- at item hd720
-1280x720
- at item hd1080
-1920x1080
- at item 2k
-2048x1080
- at item 2kflat
-1998x1080
- at item 2kscope
-2048x858
- at item 4k
-4096x2160
- at item 4kflat
-3996x2160
- at item 4kscope
-4096x1716
- at end table
-
- at anchor{video rate syntax}
- at section Video rate
-
-Specify the frame rate of a video, expressed as the number of frames
-generated per second. It has to be a string in the format
- at var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
-number or a valid video frame rate abbreviation.
-
-The following abbreviations are recognized:
- at table @samp
- at item ntsc
-30000/1001
- at item pal
-25/1
- at item qntsc
-30000/1001
- at item qpal
-25/1
- at item sntsc
-30000/1001
- at item spal
-25/1
- at item film
-24/1
- at item ntsc-film
-24000/1001
- at end table
-
- at anchor{ratio syntax}
- at section Ratio
-
-A ratio can be expressed as an expression, or in the form
- at var{numerator}:@var{denominator}.
-
-Note that a ratio with infinite (1/0) or negative value is
-considered valid, so you should check on the returned value if you
-want to exclude those values.
-
-The undefined value can be expressed using the "0:0" string.
-
- at anchor{color syntax}
- at section Color
-
-It can be the name of a color (case insensitive match) or a
-[0x|#]RRGGBB[AA] sequence, possibly followed by "@@" and a string
-representing the alpha component.
-
-The alpha component may be a string composed by "0x" followed by an
-hexadecimal number or a decimal number between 0.0 and 1.0, which
-represents the opacity value (0x00/0.0 means completely transparent,
-0xff/1.0 completely opaque).
-If the alpha component is not specified then 0xff is assumed.
-
-The string "random" will result in a random color.
-
- at c man end SYNTAX
diff --git a/doc/eval.texi b/doc/utils.texi
similarity index 61%
rename from doc/eval.texi
rename to doc/utils.texi
index 24db3b8..8b823ae 100644
--- a/doc/eval.texi
+++ b/doc/utils.texi
@@ -1,3 +1,262 @@
+ at chapter Syntax
+ at c man begin SYNTAX
+
+This section documents the syntax and formats employed by the FFmpeg
+libraries and tools.
+
+ at anchor{quoting_and_escaping}
+ at section Quoting and escaping
+
+FFmpeg adopts the following quoting and escaping mechanism, unless
+explicitly specified. The following rules are applied:
+
+ at itemize
+ at item
+ at code{'} and @code{\} are special characters (respectively used for
+quoting and escaping). In addition to them, there might be other
+special characters depending on the specific syntax where the escaping
+and quoting are employed.
+
+ at item
+A special character is escaped by prefixing it with a '\'.
+
+ at item
+All characters enclosed between '' are included literally in the
+parsed string. The quote character @code{'} itself cannot be quoted,
+so you may need to close the quote and escape it.
+
+ at item
+Leading and trailing whitespaces, unless escaped or quoted, are
+removed from the parsed string.
+ at end itemize
+
+Note that you may need to add a second level of escaping when using
+the command line or a script, which depends on the syntax of the
+adopted shell language.
+
+The function @code{av_get_token} defined in
+ at file{libavutil/avstring.h} can be used to parse a token quoted or
+escaped according to the rules defined above.
+
+The tool @file{tools/ffescape} in the FFmpeg source tree can be used
+to automatically quote or escape a string in a script.
+
+ at subsection Examples
+
+ at itemize
+ at item
+Escape the string @code{Crime d'Amour} containing the @code{'} special
+character:
+ at example
+Crime d\'Amour
+ at end example
+
+ at item
+The string above contains a quote, so the @code{'} needs to be escaped
+when quoting it:
+ at example
+'Crime d'\''Amour'
+ at end example
+
+ at item
+Include leading or trailing whitespaces using quoting:
+ at example
+'  this string starts and ends with whitespaces  '
+ at end example
+
+ at item
+Escaping and quoting can be mixed together:
+ at example
+' The string '\'string\'' is a string '
+ at end example
+
+ at item
+To include a literal @code{\} you can use either escaping or quoting:
+ at example
+'c:\foo' can be written as c:\\foo
+ at end example
+ at end itemize
+
+ at anchor{date syntax}
+ at section Date
+
+The accepted syntax is:
+ at example
+[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
+now
+ at end example
+
+If the value is "now" it takes the current time.
+
+Time is local time unless Z is appended, in which case it is
+interpreted as UTC.
+If the year-month-day part is not specified it takes the current
+year-month-day.
+
+ at anchor{time duration syntax}
+ at section Time duration
+
+The accepted syntax is:
+ at example
+[-][HH:]MM:SS[.m...]
+[-]S+[.m...]
+ at end example
+
+ at var{HH} expresses the number of hours, @var{MM} the number a of minutes
+and @var{SS} the number of seconds.
+
+ at anchor{video size syntax}
+ at section Video size
+Specify the size of the sourced video, it may be a string of the form
+ at var{width}x at var{height}, or the name of a size abbreviation.
+
+The following abbreviations are recognized:
+ at table @samp
+ at item ntsc
+720x480
+ at item pal
+720x576
+ at item qntsc
+352x240
+ at item qpal
+352x288
+ at item sntsc
+640x480
+ at item spal
+768x576
+ at item film
+352x240
+ at item ntsc-film
+352x240
+ at item sqcif
+128x96
+ at item qcif
+176x144
+ at item cif
+352x288
+ at item 4cif
+704x576
+ at item 16cif
+1408x1152
+ at item qqvga
+160x120
+ at item qvga
+320x240
+ at item vga
+640x480
+ at item svga
+800x600
+ at item xga
+1024x768
+ at item uxga
+1600x1200
+ at item qxga
+2048x1536
+ at item sxga
+1280x1024
+ at item qsxga
+2560x2048
+ at item hsxga
+5120x4096
+ at item wvga
+852x480
+ at item wxga
+1366x768
+ at item wsxga
+1600x1024
+ at item wuxga
+1920x1200
+ at item woxga
+2560x1600
+ at item wqsxga
+3200x2048
+ at item wquxga
+3840x2400
+ at item whsxga
+6400x4096
+ at item whuxga
+7680x4800
+ at item cga
+320x200
+ at item ega
+640x350
+ at item hd480
+852x480
+ at item hd720
+1280x720
+ at item hd1080
+1920x1080
+ at item 2k
+2048x1080
+ at item 2kflat
+1998x1080
+ at item 2kscope
+2048x858
+ at item 4k
+4096x2160
+ at item 4kflat
+3996x2160
+ at item 4kscope
+4096x1716
+ at end table
+
+ at anchor{video rate syntax}
+ at section Video rate
+
+Specify the frame rate of a video, expressed as the number of frames
+generated per second. It has to be a string in the format
+ at var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
+number or a valid video frame rate abbreviation.
+
+The following abbreviations are recognized:
+ at table @samp
+ at item ntsc
+30000/1001
+ at item pal
+25/1
+ at item qntsc
+30000/1001
+ at item qpal
+25/1
+ at item sntsc
+30000/1001
+ at item spal
+25/1
+ at item film
+24/1
+ at item ntsc-film
+24000/1001
+ at end table
+
+ at anchor{ratio syntax}
+ at section Ratio
+
+A ratio can be expressed as an expression, or in the form
+ at var{numerator}:@var{denominator}.
+
+Note that a ratio with infinite (1/0) or negative value is
+considered valid, so you should check on the returned value if you
+want to exclude those values.
+
+The undefined value can be expressed using the "0:0" string.
+
+ at anchor{color syntax}
+ at section Color
+
+It can be the name of a color (case insensitive match) or a
+[0x|#]RRGGBB[AA] sequence, possibly followed by "@@" and a string
+representing the alpha component.
+
+The alpha component may be a string composed by "0x" followed by an
+hexadecimal number or a decimal number between 0.0 and 1.0, which
+represents the opacity value (0x00/0.0 means completely transparent,
+0xff/1.0 completely opaque).
+If the alpha component is not specified then 0xff is assumed.
+
+The string "random" will result in a random color.
+
+ at c man end SYNTAX
+
 @chapter Expression Evaluation
 @c man begin EXPRESSION EVALUATION
 
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list