Remove unused static function.
[ffmpeg.git] / doc / ffplay-doc.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFplay Documentation
4 @titlepage
5 @sp 7
6 @center @titlefont{FFplay Documentation}
7 @sp 3
8 @end titlepage
9
10
11 @chapter Introduction
12
13 @c man begin DESCRIPTION
14 FFplay is a very simple and portable media player using the FFmpeg
15 libraries and the SDL library. It is mostly used as a testbed for the
16 various FFmpeg APIs.
17 @c man end
18
19 @chapter Invocation
20
21 @section Syntax
22 @example
23 @c man begin SYNOPSIS
24 ffplay [options] @file{input_file}
25 @c man end
26 @end example
27
28 @c man begin OPTIONS
29 @section Main options
30
31 @table @option
32 @item -h
33 show help
34 @item -x width
35 force displayed width
36 @item -y height
37 force displayed height
38 @item -s size
39 Set frame size (WxH or abbreviation), needed for videos which don't
40 contain a header with the framesize like raw YUV.
41 @item -an
42 disable audio
43 @item -vn
44 disable video
45 @item -ss pos
46 seek to a given position in seconds
47 @item -bytes
48 seek by bytes
49 @item -nodisp
50 disable graphical display
51 @item -f fmt
52 force format
53 @end table
54
55 @section Advanced options
56 @table @option
57 @item -pix_fmt format
58 set pixel format
59 @item -stats
60 Show the stream duration, the codec parameters, the current position in
61 the stream and the audio/video synchronisation drift.
62 @item -debug
63 print specific debug info
64 @item -bug
65 work around bugs
66 @item -vismv
67 visualize motion vectors
68 @item -fast
69 non-spec-compliant optimizations
70 @item -genpts
71 generate pts
72 @item -rtp_tcp
73 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
74 if you are streaming with the RTSP protocol.
75 @item -sync type
76 Set the master clock to audio (@code{type=audio}), video
77 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
78 master clock is used to control audio-video synchronization. Most media
79 players use audio as master clock, but in some cases (streaming or high
80 quality broadcast) it is necessary to change that. This option is mainly
81 used for debugging purposes.
82 @item -threads count
83 thread count
84 @end table
85
86 @section While playing
87
88 @table @key
89 @item q, ESC
90 quit
91
92 @item f
93 toggle full screen
94
95 @item p, SPC
96 pause
97
98 @item a
99 cycle audio channel
100
101 @item v
102 cycle video channel
103
104 @item w
105 show audio waves
106
107 @item left/right
108 seek backward/forward 10 seconds
109
110 @item down/up
111 seek backward/forward 1 minute
112
113 @item mouse click
114 seek to percentage in file corresponding to fraction of width
115
116 @end table
117
118 @c man end
119
120 @ignore
121
122 @setfilename ffplay
123 @settitle FFplay media player
124
125 @c man begin SEEALSO
126 ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
127 @c man end
128
129 @c man begin AUTHOR
130 Fabrice Bellard
131 @c man end
132
133 @end ignore
134
135 @bye