ffplay-doc.texi 2.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
\input texinfo @c -*- texinfo -*-

@settitle FFplay Documentation
@titlepage
@sp 7
@center @titlefont{FFplay Documentation}
@sp 3
@end titlepage


@chapter Introduction

@c man begin DESCRIPTION
FFplay is a very simple and portable media player using the FFmpeg
Diego Biurrun's avatar
Diego Biurrun committed
15 16
libraries and the SDL library. It is mostly used as a testbed for the
various FFmpeg APIs.
17 18 19 20 21
@c man end

@chapter Invocation

@section Syntax
22
@example
23 24 25 26 27 28 29 30 31 32
@c man begin SYNOPSIS
ffplay [options] @file{input_file}
@c man end
@end example

@c man begin OPTIONS
@section Main options

@table @option
@item -h
33
Show help.
34
@item -version
35
Show version.
Stefano Sabatini's avatar
Stefano Sabatini committed
36
@item -L
37
Show license.
38 39
@item -formats
Show available formats, codecs, protocols, ...
40
@item -x @var{width}
41
Force displayed width.
42
@item -y @var{height}
43
Force displayed height.
44
@item -s @var{size}
45
Set frame size (WxH or abbreviation), needed for videos which don't
46
contain a header with the frame size like raw YUV.
47
@item -an
48
Disable audio.
49
@item -vn
50
Disable video.
51
@item -ss @var{pos}
52
Seek to a given position in seconds.
53
@item -bytes
54
Seek by bytes.
55
@item -nodisp
56
Disable graphical display.
57
@item -f @var{fmt}
58
Force format.
59 60 61 62
@end table

@section Advanced options
@table @option
63
@item -pix_fmt @var{format}
64
Set pixel format.
65
@item -stats
Diego Biurrun's avatar
Diego Biurrun committed
66 67
Show the stream duration, the codec parameters, the current position in
the stream and the audio/video synchronisation drift.
68
@item -debug
69
Print specific debug info.
70
@item -bug
71
Work around bugs.
72
@item -vismv
73
Visualize motion vectors.
74
@item -fast
75
Non-spec-compliant optimizations.
76
@item -genpts
77
Generate pts.
78
@item -rtp_tcp
Diego Biurrun's avatar
Diego Biurrun committed
79 80
Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
if you are streaming with the RTSP protocol.
81
@item -sync @var{type}
Diego Biurrun's avatar
Diego Biurrun committed
82
Set the master clock to audio (@code{type=audio}), video
83 84 85 86 87
(@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.
88
@item -threads @var{count}
89
Set the thread count.
90 91 92 93 94 95
@end table

@section While playing

@table @key
@item q, ESC
96
Quit.
97 98

@item f
99
Toggle full screen.
100 101

@item p, SPC
102
Pause.
103 104

@item a
105
Cycle audio channel.
106 107

@item v
108
Cycle video channel.
109 110

@item w
111
Show audio waves.
112 113

@item left/right
114
Seek backward/forward 10 seconds.
115 116

@item down/up
117
Seek backward/forward 1 minute.
118 119

@item mouse click
120
Seek to percentage in file corresponding to fraction of width.
121

122 123 124 125 126 127 128 129 130 131
@end table

@c man end

@ignore

@setfilename ffplay
@settitle FFplay media player

@c man begin SEEALSO
132
ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
133 134 135 136 137 138 139 140 141
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore

@bye