Skip to content
Snippets Groups Projects
Commit 9806dda8 authored by Stefano Sabatini's avatar Stefano Sabatini
Browse files

ffprobe: create a dedicated "Writers" section in the manual

Also update documentation related to the output format.
parent eff7684b
No related branches found
No related tags found
No related merge requests found
...@@ -42,18 +42,11 @@ for specifying which information to display, and for setting how ...@@ -42,18 +42,11 @@ for specifying which information to display, and for setting how
ffprobe will show it. ffprobe will show it.
ffprobe output is designed to be easily parsable by a textual filter, ffprobe output is designed to be easily parsable by a textual filter,
and consists of one or more sections of the form: and consists of one or more sections of a form defined by the selected
@example writer, which is specified by the @option{print_format} option.
[SECTION]
key1=val1
...
keyN=valN
[/SECTION]
@end example
Metadata tags stored in the container or in the streams are recognized Metadata tags stored in the container or in the streams are recognized
and printed in the corresponding "FORMAT" or "STREAM" section, and and printed in the corresponding "FORMAT" or "STREAM" section.
are prefixed by the string "TAG:".
@c man end @c man end
...@@ -89,7 +82,14 @@ options "-unit -prefix -byte_binary_prefix -sexagesimal". ...@@ -89,7 +82,14 @@ options "-unit -prefix -byte_binary_prefix -sexagesimal".
@item -print_format @var{format} @item -print_format @var{format}
Set the output printing format. Set the output printing format.
Current available formats are "default" and "json".
For example for printing the output in JSON format, specify:
@example
-print_format json
@end example
For more details on the available output printing formats, see the
Writers section below.
@item -show_format @item -show_format
Show information about the container format of the input multimedia Show information about the container format of the input multimedia
...@@ -118,6 +118,41 @@ Read @var{input_file}. ...@@ -118,6 +118,41 @@ Read @var{input_file}.
@end table @end table
@c man end @c man end
@chapter Writers
@c man begin WRITERS
A writer defines the output format adopted by @file{ffprobe}, and will be
used for printing all the parts of the output.
A writer may accept one or more arguments, which specify the options to
adopt.
A description of the currently available writers follows.
@section default
Default format.
Print each section in the form:
@example
[SECTION]
key1=val1
...
keyN=valN
[/SECTION]
@end example
Metadata tags are printed as a line in the corresponding FORMAT or
STREAM section, and are prefixed by the string "TAG:".
@section json
JSON based format.
Each section is printed using JSON notation.
For more information about JSON, see @url{http://www.json.org/}.
@c man end WRITERS
@include decoders.texi @include decoders.texi
@include demuxers.texi @include demuxers.texi
@include protocols.texi @include protocols.texi
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment