From 266463daff7bbd4c3a8a26ff11b1131df0fd5520 Mon Sep 17 00:00:00 2001 From: Anton Khirnov Date: Tue, 26 Jul 2011 17:51:34 +0200 Subject: Rename ffplay to avplay. --- doc/avplay.texi | 182 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/demuxers.texi | 2 +- doc/developer.texi | 2 +- doc/ffmpeg.texi | 2 +- doc/ffplay.texi | 182 --------------------------------------------------- doc/ffprobe.texi | 2 +- doc/ffserver.texi | 2 +- doc/general.texi | 2 +- doc/indevs.texi | 4 +- doc/libavfilter.texi | 4 +- doc/protocols.texi | 28 ++++---- 11 files changed, 206 insertions(+), 206 deletions(-) create mode 100644 doc/avplay.texi delete mode 100644 doc/ffplay.texi (limited to 'doc') diff --git a/doc/avplay.texi b/doc/avplay.texi new file mode 100644 index 0000000000..0c74c59a3d --- /dev/null +++ b/doc/avplay.texi @@ -0,0 +1,182 @@ +\input texinfo @c -*- texinfo -*- + +@settitle avplay Documentation +@titlepage +@center @titlefont{avplay Documentation} +@end titlepage + +@top + +@contents + +@chapter Synopsis + +@example +@c man begin SYNOPSIS +avplay [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 +libraries and the SDL library. It is mostly used as a testbed for the +various Libav APIs. +@c man end + +@chapter Options +@c man begin OPTIONS + +@include fftools-common-opts.texi + +@section Main options + +@table @option +@item -x @var{width} +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. +@item -an +Disable audio. +@item -vn +Disable video. +@item -ss @var{pos} +Seek to a given position in seconds. +@item -t @var{duration} +play seconds of audio/video +@item -bytes +Seek by bytes. +@item -nodisp +Disable graphical display. +@item -f @var{fmt} +Force format. +@item -window_title @var{title} +Set window title (default is the input filename). +@item -loop @var{number} +Loops movie playback times. 0 means forever. +@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). + +@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. +@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 +Generate pts. +@item -rtp_tcp +Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful +if you are streaming with the RTSP protocol. +@item -sync @var{type} +Set the master clock to audio (@code{type=audio}), video +(@code{type=video}) or external (@code{type=ext}). Default is audio. The +master clock is used to control audio-video synchronization. Most media +players use audio as master clock, but in some cases (streaming or high +quality broadcast) it is necessary to change that. This option is mainly +used for debugging purposes. +@item -threads @var{count} +Set the thread count. +@item -ast @var{audio_stream_number} +Select the desired audio stream number, counting from 0. The number +refers to the list of all the input audio streams. If it is greater +than the number of audio streams minus one, then the last one is +selected, if it is negative the audio playback is disabled. +@item -vst @var{video_stream_number} +Select the desired video stream number, counting from 0. The number +refers to the list of all the input video streams. If it is greater +than the number of video streams minus one, then the last one is +selected, if it is negative the video playback is disabled. +@item -sst @var{subtitle_stream_number} +Select the desired subtitle stream number, counting from 0. The number +refers to the list of all the input subtitle streams. If it is greater +than the number of subtitle streams minus one, then the last one is +selected, if it is negative the subtitle rendering is disabled. +@item -autoexit +Exit when video is done playing. +@item -exitonkeydown +Exit if any key is pressed. +@item -exitonmousedown +Exit if any mouse button is pressed. +@end table + +@section While playing + +@table @key +@item q, ESC +Quit. + +@item f +Toggle full screen. + +@item p, SPC +Pause. + +@item a +Cycle audio channel. + +@item v +Cycle video channel. + +@item t +Cycle subtitle channel. + +@item w +Show audio waves. + +@item left/right +Seek backward/forward 10 seconds. + +@item down/up +Seek backward/forward 1 minute. + +@item mouse click +Seek to percentage in file corresponding to fraction of width. + +@end table + +@c man end + +@include eval.texi +@include demuxers.texi +@include muxers.texi +@include indevs.texi +@include outdevs.texi +@include protocols.texi +@include filters.texi + +@ignore + +@setfilename avplay +@settitle AVplay media player + +@c man begin SEEALSO +ffmpeg(1), ffprobe(1), ffserver(1) and the Libav HTML documentation +@c man end + +@c man begin AUTHORS +The Libav developers +@c man end + +@end ignore + +@bye diff --git a/doc/demuxers.texi b/doc/demuxers.texi index 98f9fdeff8..fc03459417 100644 --- a/doc/demuxers.texi +++ b/doc/demuxers.texi @@ -70,7 +70,7 @@ Apple HTTP Live Streaming demuxer. This demuxer presents all AVStreams from all variant streams. The id field is set to the bitrate variant index number. By setting -the discard flags on AVStreams (by pressing 'a' or 'v' in ffplay), +the discard flags on AVStreams (by pressing 'a' or 'v' in avplay), the caller can decide which variant streams to actually receive. The total bitrate of the variant that the stream belongs to is available in a metadata key named "variant_bitrate". diff --git a/doc/developer.texi b/doc/developer.texi index 208c119753..d75471cb29 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -17,7 +17,7 @@ decoding). Look at @file{libavcodec/apiexample.c} to see how to use it. @item libavformat is the library containing the file format handling (mux and -demux code for several formats). Look at @file{ffplay.c} to use it in a +demux code for several formats). Look at @file{avplay.c} to use it in a player. See @file{libavformat/output-example.c} to use it to generate audio or video streams. diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi index ca801d31e4..6393516c6d 100644 --- a/doc/ffmpeg.texi +++ b/doc/ffmpeg.texi @@ -1079,7 +1079,7 @@ file to which you want to add them. @settitle ffmpeg video converter @c man begin SEEALSO -ffplay(1), ffprobe(1), ffserver(1) and the Libav HTML documentation +avplay(1), ffprobe(1), ffserver(1) and the Libav HTML documentation @c man end @c man begin AUTHORS diff --git a/doc/ffplay.texi b/doc/ffplay.texi deleted file mode 100644 index d60852603a..0000000000 --- a/doc/ffplay.texi +++ /dev/null @@ -1,182 +0,0 @@ -\input texinfo @c -*- texinfo -*- - -@settitle ffplay Documentation -@titlepage -@center @titlefont{ffplay Documentation} -@end titlepage - -@top - -@contents - -@chapter Synopsis - -@example -@c man begin SYNOPSIS -ffplay [options] @file{input_file} -@c man end -@end example - -@chapter Description -@c man begin DESCRIPTION - -FFplay is a very simple and portable media player using the Libav -libraries and the SDL library. It is mostly used as a testbed for the -various Libav APIs. -@c man end - -@chapter Options -@c man begin OPTIONS - -@include fftools-common-opts.texi - -@section Main options - -@table @option -@item -x @var{width} -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. -@item -an -Disable audio. -@item -vn -Disable video. -@item -ss @var{pos} -Seek to a given position in seconds. -@item -t @var{duration} -play seconds of audio/video -@item -bytes -Seek by bytes. -@item -nodisp -Disable graphical display. -@item -f @var{fmt} -Force format. -@item -window_title @var{title} -Set window title (default is the input filename). -@item -loop @var{number} -Loops movie playback times. 0 means forever. -@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). - -@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. -@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 -Generate pts. -@item -rtp_tcp -Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful -if you are streaming with the RTSP protocol. -@item -sync @var{type} -Set the master clock to audio (@code{type=audio}), video -(@code{type=video}) or external (@code{type=ext}). Default is audio. The -master clock is used to control audio-video synchronization. Most media -players use audio as master clock, but in some cases (streaming or high -quality broadcast) it is necessary to change that. This option is mainly -used for debugging purposes. -@item -threads @var{count} -Set the thread count. -@item -ast @var{audio_stream_number} -Select the desired audio stream number, counting from 0. The number -refers to the list of all the input audio streams. If it is greater -than the number of audio streams minus one, then the last one is -selected, if it is negative the audio playback is disabled. -@item -vst @var{video_stream_number} -Select the desired video stream number, counting from 0. The number -refers to the list of all the input video streams. If it is greater -than the number of video streams minus one, then the last one is -selected, if it is negative the video playback is disabled. -@item -sst @var{subtitle_stream_number} -Select the desired subtitle stream number, counting from 0. The number -refers to the list of all the input subtitle streams. If it is greater -than the number of subtitle streams minus one, then the last one is -selected, if it is negative the subtitle rendering is disabled. -@item -autoexit -Exit when video is done playing. -@item -exitonkeydown -Exit if any key is pressed. -@item -exitonmousedown -Exit if any mouse button is pressed. -@end table - -@section While playing - -@table @key -@item q, ESC -Quit. - -@item f -Toggle full screen. - -@item p, SPC -Pause. - -@item a -Cycle audio channel. - -@item v -Cycle video channel. - -@item t -Cycle subtitle channel. - -@item w -Show audio waves. - -@item left/right -Seek backward/forward 10 seconds. - -@item down/up -Seek backward/forward 1 minute. - -@item mouse click -Seek to percentage in file corresponding to fraction of width. - -@end table - -@c man end - -@include eval.texi -@include demuxers.texi -@include muxers.texi -@include indevs.texi -@include outdevs.texi -@include protocols.texi -@include filters.texi - -@ignore - -@setfilename ffplay -@settitle FFplay media player - -@c man begin SEEALSO -ffmpeg(1), ffprobe(1), ffserver(1) and the Libav HTML documentation -@c man end - -@c man begin AUTHORS -The Libav developers -@c man end - -@end ignore - -@bye diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi index 5e856e6645..079cf659d7 100644 --- a/doc/ffprobe.texi +++ b/doc/ffprobe.texi @@ -122,7 +122,7 @@ with name "STREAM". @settitle ffprobe media prober @c man begin SEEALSO -ffmpeg(1), ffplay(1), ffserver(1) and the Libav HTML documentation +ffmpeg(1), avplay(1), ffserver(1) and the Libav HTML documentation @c man end @c man begin AUTHORS diff --git a/doc/ffserver.texi b/doc/ffserver.texi index d247016bbc..3d64b79377 100644 --- a/doc/ffserver.texi +++ b/doc/ffserver.texi @@ -265,7 +265,7 @@ rather than as a daemon. @c man begin SEEALSO -ffmpeg(1), ffplay(1), ffprobe(1), the @file{ffmpeg/doc/ffserver.conf} +ffmpeg(1), avplay(1), ffprobe(1), the @file{ffmpeg/doc/ffserver.conf} example and the Libav HTML documentation @c man end diff --git a/doc/general.texi b/doc/general.texi index c9919390d6..98065093b5 100644 --- a/doc/general.texi +++ b/doc/general.texi @@ -837,7 +837,7 @@ speed up is close to non-existent for normal one-off builds and is only noticeable when running make for a second time (for example in @code{make install}). -@item In order to compile FFplay, you must have the MinGW development library +@item In order to compile AVplay, you must have the MinGW development library of @uref{http://www.libsdl.org/, SDL}. Edit the @file{bin/sdl-config} script so that it points to the correct prefix where SDL was installed. Verify that @file{sdl-config} can be launched from diff --git a/doc/indevs.texi b/doc/indevs.texi index fa21c099d5..e1c058b8a6 100644 --- a/doc/indevs.texi +++ b/doc/indevs.texi @@ -199,10 +199,10 @@ tools. @example # Grab and show the input of a video4linux device, frame rate is set # to the default of 25/1. -ffplay -s 320x240 -f video4linux /dev/video0 +avplay -s 320x240 -f video4linux /dev/video0 # Grab and show the input of a video4linux2 device, autoadjust size. -ffplay -f video4linux2 /dev/video0 +avplay -f video4linux2 /dev/video0 # Grab and record the input of a video4linux2 device, autoadjust size, # frame rate value defaults to 0/0 so it is read from the video4linux2 diff --git a/doc/libavfilter.texi b/doc/libavfilter.texi index 1c1220541c..172b7fc4d0 100644 --- a/doc/libavfilter.texi +++ b/doc/libavfilter.texi @@ -24,7 +24,7 @@ some directory of your choice by: @end example And then read the README file in the top directory to learn how to -integrate it into ffmpeg and ffplay. +integrate it into ffmpeg and avplay. But note that there may still be serious bugs in the code and its API and ABI should not be considered stable yet! @@ -56,7 +56,7 @@ result will be that in output the top half of the video is mirrored onto the bottom half. Video filters are loaded using the @var{-vf} option passed to -ffmpeg or to ffplay. Filters in the same linear chain are separated by +ffmpeg or to avplay. Filters in the same linear chain are separated by commas. In our example, @var{split, fifo, overlay} are in one linear chain, and @var{fifo, crop, vflip} are in another. The points where the linear chains join are labeled by names enclosed in square diff --git a/doc/protocols.texi b/doc/protocols.texi index 59906312fa..cc35982e77 100644 --- a/doc/protocols.texi +++ b/doc/protocols.texi @@ -52,10 +52,10 @@ resource to be concatenated, each one possibly specifying a distinct protocol. For example to read a sequence of files @file{split1.mpeg}, -@file{split2.mpeg}, @file{split3.mpeg} with @file{ffplay} use the +@file{split2.mpeg}, @file{split3.mpeg} with @file{avplay} use the command: @example -ffplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg +avplay concat:split1.mpeg\|split2.mpeg\|split3.mpeg @end example Note that you may need to escape the character "|" which is special for @@ -183,10 +183,10 @@ application specified in @var{app}, may be prefixed by "mp4:". @end table -For example to read with @file{ffplay} a multimedia resource named +For example to read with @file{avplay} a multimedia resource named "sample" from the application "vod" from an RTMP server "myserver": @example -ffplay rtmp://myserver/vod/sample +avplay rtmp://myserver/vod/sample @end example @section rtmp, rtmpe, rtmps, rtmpt, rtmpte @@ -224,9 +224,9 @@ For example, to stream a file in real-time to an RTMP server using ffmpeg -re -i myfile -f flv rtmp://myserver/live/mystream @end example -To play the same stream using @file{ffplay}: +To play the same stream using @file{avplay}: @example -ffplay "rtmp://myserver/live/mystream live=1" +avplay "rtmp://myserver/live/mystream live=1" @end example @section rtp @@ -281,7 +281,7 @@ When receiving data over UDP, the demuxer tries to reorder received packets order for this to be enabled, a maximum delay must be specified in the @code{max_delay} field of AVFormatContext. -When watching multi-bitrate Real-RTSP streams with @file{ffplay}, the +When watching multi-bitrate Real-RTSP streams with @file{avplay}, the streams to display can be chosen with @code{-vst} @var{n} and @code{-ast} @var{n} for video and audio respectively, and can be switched on the fly by pressing @code{v} and @code{a}. @@ -291,13 +291,13 @@ Example command lines: To watch a stream over UDP, with a max reordering delay of 0.5 seconds: @example -ffplay -max_delay 500000 rtsp://server/video.mp4?udp +avplay -max_delay 500000 rtsp://server/video.mp4?udp @end example To watch a stream tunneled over HTTP: @example -ffplay rtsp://server/video.mp4?http +avplay rtsp://server/video.mp4?http @end example To send a stream in realtime to a RTSP server, for others to watch: @@ -358,13 +358,13 @@ To broadcast a stream on the local subnet, for watching in VLC: ffmpeg -re -i @var{input} -f sap sap://224.0.0.255?same_port=1 @end example -Similarly, for watching in ffplay: +Similarly, for watching in avplay: @example ffmpeg -re -i @var{input} -f sap sap://224.0.0.255 @end example -And for watching in ffplay, over IPv6: +And for watching in avplay, over IPv6: @example ffmpeg -re -i @var{input} -f sap sap://[ff0e::1:2:3:4] @@ -389,13 +389,13 @@ Example command lines follow. To play back the first stream announced on the normal SAP multicast address: @example -ffplay sap:// +avplay sap:// @end example To play back the first stream announced on one the default IPv6 SAP multicast address: @example -ffplay sap://[ff0e::2:7ffe] +avplay sap://[ff0e::2:7ffe] @end example @section tcp @@ -414,7 +414,7 @@ Listen for an incoming connection @example ffmpeg -i @var{input} -f @var{format} tcp://@var{hostname}:@var{port}?listen -ffplay tcp://@var{hostname}:@var{port} +avplay tcp://@var{hostname}:@var{port} @end example @end table -- cgit v1.2.3