[FFmpeg-devel] [PATCH 3/3] ffplay: update documentation

Lou Logan lou at lrcd.com
Tue Oct 14 00:44:02 CEST 2014


Just some nits.

On Mon, 13 Oct 2014 23:41:43 +0200, Marton Balint wrote:

> Signed-off-by: Marton Balint <cus at passwd.hu>
> ---
>  doc/ffplay.texi | 24 +++++++++++++++++++-----
>  1 file changed, 19 insertions(+), 5 deletions(-)
> diff --git a/doc/ffplay.texi b/doc/ffplay.texi
> index 9bb040e..4c01e6c 100644
> --- a/doc/ffplay.texi
> +++ b/doc/ffplay.texi
> @@ -37,10 +37,14 @@ Force displayed height.
>  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.
> + at item -fs
> +Start in fullscreen mode.
>  @item -an
>  Disable audio.
>  @item -vn
>  Disable video.
> + at item -sn
> +Disable subtitling.

"Disable subtitles" sounds better to me.

>  @item -ss @var{pos}
>  Seek to a given position in seconds.
>  @item -t @var{duration}
> @@ -113,9 +117,6 @@ explicitly disable it you need to specify @code{-nostats}.
>  Non-spec-compliant optimizations.
>  @item -genpts
>  Generate pts.
> - at 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
> @@ -124,7 +125,8 @@ 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.
> +Set the thread count. By default, ffplay automatically detects a suitable
> +number of threads to use.

Alternatively you could use "@command{ffplay}" if you prefer, but either
is fine with me.

>  @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
> @@ -163,7 +165,19 @@ Force a specific subtitle decoder.
>  @item -autorotate
>  Automatically rotate the video according to presentation metadata. Set by
> -default, use -noautorotate to disable.
> +default, use @code{-noautorotate} to disable.
> +
> + at item -framedrop
> +Drop video frames if video is out of sync. Set by default, if sync mode is not
> +video. Set this option to enable frame dropping for all sync modes, set
> + at code{-noframedrop} to disable it.

I don't quite understand the "Set by default" sentence, but it doesn't
mean it's wrong.

> + at item -infbuf
> +Don't limit the input buffer size, read as much data as possible from the input
> +as soon as possible. Set by default for realtime streams, where data may be
> +dropped if not read in time. Set this option to enable infinite buffers for all
> +inputs, set @code{-noinfbuf} to disable it.

You can avoid the contraction with "Do not limit...".

More information about the ffmpeg-devel mailing list