diff options
| author | Tim Redfern <tim@eclectronics.org> | 2013-12-29 12:19:38 +0000 |
|---|---|---|
| committer | Tim Redfern <tim@eclectronics.org> | 2013-12-29 12:19:38 +0000 |
| commit | f7813a5324be39d13ab536c245d15dfc602a7849 (patch) | |
| tree | fad99148b88823d34a5df2f0a25881a002eb291b /ffmpeg/doc/ffprobe.texi | |
| parent | b7a5a477b8ff4d4e3028b9dfb9a9df0a41463f92 (diff) | |
basic type mechanism working
Diffstat (limited to 'ffmpeg/doc/ffprobe.texi')
| -rw-r--r-- | ffmpeg/doc/ffprobe.texi | 167 |
1 files changed, 158 insertions, 9 deletions
diff --git a/ffmpeg/doc/ffprobe.texi b/ffmpeg/doc/ffprobe.texi index 6e30b2f..75d1e72 100644 --- a/ffmpeg/doc/ffprobe.texi +++ b/ffmpeg/doc/ffprobe.texi @@ -44,14 +44,15 @@ name (which may be shared by other sections), and an unique name. See the output of @option{sections}. Metadata tags stored in the container or in the streams are recognized -and printed in the corresponding "FORMAT" or "STREAM" section. +and printed in the corresponding "FORMAT", "STREAM" or "PROGRAM_STREAM" +section. @c man end @chapter Options @c man begin OPTIONS -@include avtools-common-opts.texi +@include fftools-common-opts.texi @section Main options @@ -112,7 +113,7 @@ ffprobe -show_packets -select_streams v:1 INPUT @end example @item -show_data -Show payload data, as an hexadecimal and ASCII dump. Coupled with +Show payload data, as a hexadecimal and ASCII dump. Coupled with @option{-show_packets}, it will dump the packets' data. Coupled with @option{-show_streams}, it will dump the codec extradata. @@ -196,11 +197,11 @@ The information for each single packet is printed within a dedicated section with name "PACKET". @item -show_frames -Show information about each frame contained in the input multimedia -stream. +Show information about each frame and subtitle contained in the input +multimedia stream. The information for each single frame is printed within a dedicated -section with name "FRAME". +section with name "FRAME" or "SUBTITLE". @item -show_streams Show information about each media stream contained in the input @@ -209,6 +210,18 @@ multimedia stream. Each media stream information is printed within a dedicated section with name "STREAM". +@item -show_programs +Show information about programs and their streams contained in the input +multimedia stream. + +Each media stream information is printed within a dedicated section +with name "PROGRAM_STREAM". + +@item -show_chapters +Show information about chapters stored in the format. + +Each chapter is printed within a dedicated section with name "CHAPTER". + @item -count_frames Count the number of frames per stream and report it in the corresponding stream section. @@ -217,6 +230,70 @@ corresponding stream section. Count the number of packets per stream and report it in the corresponding stream section. +@item -read_intervals @var{read_intervals} + +Read only the specified intervals. @var{read_intervals} must be a +sequence of interval specifications separated by ",". +@command{ffprobe} will seek to the interval starting point, and will +continue reading from that. + +Each interval is specified by two optional parts, separated by "%". + +The first part specifies the interval start position. It is +interpreted as an abolute position, or as a relative offset from the +current position if it is preceded by the "+" character. If this first +part is not specified, no seeking will be performed when reading this +interval. + +The second part specifies the interval end position. It is interpreted +as an absolute position, or as a relative offset from the current +position if it is preceded by the "+" character. If the offset +specification starts with "#", it is interpreted as the number of +packets to read (not including the flushing packets) from the interval +start. If no second part is specified, the program will read until the +end of the input. + +Note that seeking is not accurate, thus the actual interval start +point may be different from the specified position. Also, when an +interval duration is specified, the absolute end time will be computed +by adding the duration to the interval start point found by seeking +the file, rather than to the specified start value. + +The formal syntax is given by: +@example +@var{INTERVAL} ::= [@var{START}|+@var{START_OFFSET}][%[@var{END}|+@var{END_OFFSET}]] +@var{INTERVALS} ::= @var{INTERVAL}[,@var{INTERVALS}] +@end example + +A few examples follow. +@itemize +@item +Seek to time 10, read packets until 20 seconds after the found seek +point, then seek to position @code{01:30} (1 minute and thirty +seconds) and read packets until position @code{01:45}. +@example +10%+20,01:30%01:45 +@end example + +@item +Read only 42 packets after seeking to position @code{01:23}: +@example +01:23%+#42 +@end example + +@item +Read only the first 20 seconds from the start: +@example +%+20 +@end example + +@item +Read from the start until position @code{02:30}: +@example +%02:30 +@end example +@end itemize + @item -show_private_data, -private Show private data, that is data depending on the format of the particular shown element. @@ -260,6 +337,39 @@ A writer may accept one or more arguments, which specify the options to adopt. The options are specified as a list of @var{key}=@var{value} pairs, separated by ":". +All writers support the following options: + +@table @option +@item string_validation, sv +Set string validation mode. + +The following values are accepted. +@table @samp +@item fail +The writer will fail immediately in case an invalid string (UTF-8) +sequence or code point is found in the input. This is especially +useful to validate input metadata. + +@item ignore +Any validation error will be ignored. This will result in possibly +broken output, especially with the json or xml writer. + +@item replace +The writer will substitute invalid UTF-8 sequences or code points with +the string specified with the @option{string_validation_replacement}. +@end table + +Default value is @samp{replace}. + +@item string_validation_replacement, svr +Set replacement string to use in case @option{string_validation} is +set to @samp{replace}. + +In case the option is not specified, the writer will assume the empty +string, that is it will remove the invalid sequences from the input +strings. +@end table + A description of the currently available writers follows. @section default @@ -274,8 +384,8 @@ 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:". +Metadata tags are printed as a line in the corresponding FORMAT, STREAM or +PROGRAM_STREAM section, and are prefixed by the string "TAG:". A description of the accepted options follows. @@ -487,10 +597,43 @@ DV, GXF and AVI timecodes are available in format metadata @end itemize @c man end TIMECODE +@include config.texi +@ifset config-all +@ifset config-avutil +@include utils.texi +@end ifset +@ifset config-avcodec +@include codecs.texi +@include bitstream_filters.texi +@end ifset +@ifset config-avformat +@include formats.texi +@include protocols.texi +@end ifset +@ifset config-avdevice +@include devices.texi +@end ifset +@ifset config-swresample +@include resampler.texi +@end ifset +@ifset config-swscale +@include scaler.texi +@end ifset +@ifset config-avfilter +@include filters.texi +@end ifset +@end ifset + @chapter See Also @ifhtml -@url{ffplay.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver}, +@ifset config-all +@url{ffprobe.html,ffprobe}, +@end ifset +@ifset config-not-all +@url{ffprobe-all.html,ffprobe-all}, +@end ifset +@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffserver.html,ffserver}, @url{ffmpeg-utils.html,ffmpeg-utils}, @url{ffmpeg-scaler.html,ffmpeg-scaler}, @url{ffmpeg-resampler.html,ffmpeg-resampler}, @@ -503,6 +646,12 @@ DV, GXF and AVI timecodes are available in format metadata @end ifhtml @ifnothtml +@ifset config-all +ffprobe(1), +@end ifset +@ifset config-not-all +ffprobe-all(1), +@end ifset ffmpeg(1), ffplay(1), ffserver(1), ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1), ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1), |
