summaryrefslogtreecommitdiff
path: root/doc/filters.texi
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2011-04-23 20:55:34 +0200
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2011-04-27 11:12:45 +0200
commit31d8467d82d41d9a6720d4b4bd7bf60eab547d5e (patch)
tree6ae8e4dcdb3e484da69020b7b786e0deb4428e6b /doc/filters.texi
parentf7bdffb09da597c5d6afff5359523370470ad072 (diff)
lavfi: add showinfo filter
Diffstat (limited to 'doc/filters.texi')
-rw-r--r--doc/filters.texi59
1 files changed, 59 insertions, 0 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index b38abf308d..a2557403b3 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -1309,6 +1309,65 @@ settb=2*intb
settb=AVTB
@end example
+@section showinfo
+
+Show a line containing various information for each input video frame.
+The input video is not modified.
+
+The shown line contains a sequence of key/value pairs of the form
+@var{key}:@var{value}.
+
+A description of each shown parameter follows:
+
+@table @option
+@item n
+sequential number of the input frame, starting from 0
+
+@item pts
+Presentation TimeStamp of the input frame, expressed as a number of
+time base units. The time base unit depends on the filter input pad.
+
+@item pts_time
+Presentation TimeStamp of the input frame, expressed as a number of
+seconds
+
+@item pos
+position of the frame in the input stream, -1 if this information in
+unavailable and/or meanigless (for example in case of synthetic video)
+
+@item fmt
+pixel format name
+
+@item sar
+sample aspect ratio of the input frame, expressed in the form
+@var{num}/@var{den}
+
+@item s
+size of the input frame, expressed in the form
+@var{width}x@var{height}
+
+@item i
+interlaced mode ("P" for "progressive", "T" for top field first, "B"
+for bottom field first)
+
+@item iskey
+1 if the frame is a key frame, 0 otherwise
+
+@item type
+picture type of the input frame ("I" for an I-frame, "P" for a
+P-frame, "B" for a B-frame, "?" for unknown type).
+Check also the documentation of the @code{AVPictureType} enum and of
+the @code{av_get_picture_type_char} function defined in
+@file{libavutil/avutil.h}.
+
+@item crc
+Adler-32 CRC of the input frame
+
+@item plane_crc
+Adler-32 CRC of each plane of the input frame, expressed in the form
+"[@var{crc0} @var{crc1} @var{crc2} @var{crc3}]"
+@end table
+
@section slicify
Pass the images of input video on to next video filter as multiple