Merge remote-tracking branch 'qatar/master'

[coroid/ffmpeg_saccubus.git] / doc / ffplay.texi

diff --git a/doc/avplay.texi b/doc/ffplay.texi
similarity index 76%
rename from doc/avplay.texi
rename to doc/ffplay.texi
index 502580f..55ff211 100644 (file)
--- a/doc/avplay.texi
+++ b/doc/ffplay.texi
@@ -1,8 +1,8 @@
 \input texinfo @c -*- texinfo -*-
 
-@settitle avplay Documentation
+@settitle ffplay Documentation
 @titlepage
-@center @titlefont{avplay Documentation}
+@center @titlefont{ffplay Documentation}
 @end titlepage
 
 @top
@@ -13,16 +13,16 @@
 
 @example
 @c man begin SYNOPSIS
-avplay [options] @file{input_file}
+ffplay [options] [@file{input_file}]
 @c man end
 @end example
 
 @chapter Description
 @c man begin DESCRIPTION
 
-AVplay is a very simple and portable media player using the Libav
+FFplay is a very simple and portable media player using the FFmpeg
 libraries and the SDL library. It is mostly used as a testbed for the
-various Libav APIs.
+various FFmpeg APIs.
 @c man end
 
 @chapter Options
@@ -38,9 +38,9 @@ Force displayed width.
 @item -y @var{height}
 Force displayed height.
 @item -s @var{size}
-This option has been removed. Use private format options for specifying the
-input video size.  For example with the rawvideo demuxer you need to specify the
-option @var{video_size}.
+Set frame size (WxH or abbreviation), needed for videos which do
+not contain a header with the frame size like raw YUV.  This option
+has been deprecated in favor of private options, try -video_size.
 @item -an
 Disable audio.
 @item -vn
@@ -59,29 +59,44 @@ Force format.
 Set window title (default is the input filename).
 @item -loop @var{number}
 Loops movie playback <number> times. 0 means forever.
+@item -showmode @var{mode}
+Set the show mode to use.
+Available values for @var{mode} are:
+@table @samp
+@item 0, video
+show video
+@item 1, waves
+show audio waves
+@item 2, rdft
+show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
+@end table
+
+Default value is "video", if video is not present or cannot be played
+"rdft" is automatically selected.
+
+You can interactively cycle through the available show modes by
+pressing the key @key{w}.
+
 @item -vf @var{filter_graph}
 @var{filter_graph} is a description of the filter graph to apply to
 the input video.
 Use the option "-filters" to show all the available filters (including
 also sources and sinks).
 
+@item -i @var{input_file}
+Read @var{input_file}.
 @end table
 
 @section Advanced options
 @table @option
 @item -pix_fmt @var{format}
-This option has been removed. Use private options for specifying the
-input pixel format. For example with the rawvideo demuxer you need to specify
-the option @var{pixel_format}.
+Set pixel format.
+This option has been deprecated in favor of private options, try -pixel_format.
 @item -stats
 Show the stream duration, the codec parameters, the current position in
 the stream and the audio/video synchronisation drift.
-@item -debug
-Print specific debug info.
 @item -bug
 Work around bugs.
-@item -vismv
-Visualize motion vectors.
 @item -fast
 Non-spec-compliant optimizations.
 @item -genpts
@@ -159,6 +174,7 @@ Seek to percentage in file corresponding to fraction of width.
 @c man end
 
 @include eval.texi
+@include decoders.texi
 @include demuxers.texi
 @include muxers.texi
 @include indevs.texi
@@ -168,15 +184,15 @@ Seek to percentage in file corresponding to fraction of width.
 
 @ignore
 
-@setfilename avplay
-@settitle AVplay media player
+@setfilename ffplay
+@settitle FFplay media player
 
 @c man begin SEEALSO
-avconv(1), avprobe(1), avserver(1) and the Libav HTML documentation
+ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
 @c man end
 
 @c man begin AUTHORS
-The Libav developers
+The FFmpeg developers
 @c man end
 
 @end ignore