fix probe, patch by Andreas Oman, andreas at olebyn dot nu
[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 -an
39 disable audio
40 @item -vn
41 disable video
42 @item -nodisp
43 disable graphical display
44 @item -f fmt
45 force format
46 @item -img img_fmt
47 This option is used to force a given image format
48 when playing image sequences. Example:
49 @example
50 ffplay -img pgmyuv tests/vsynth1/%d.pgm
51 @end example
52 @end table
53
54 @section Advanced options
55 @table @option
56 @item -stats
57 Show the stream duration, the codec parameters, the current position in
58 the stream and the audio/video synchronisation drift.
59 @item -rtp_tcp
60 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
61 if you are streaming with the RTSP protocol.
62 @item -sync type
63 Set the master clock to audio (@code{type=audio}), video
64 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
65 master clock is used to control audio-video synchronization. Most media
66 players use audio as master clock, but in some cases (streaming or high
67 quality broadcast) it is necessary to change that. This option is mainly
68 used for debugging purposes.
69 @end table
70
71 @section While playing
72
73 @table @key
74 @item q, ESC
75 quit
76
77 @item f
78 toggle full screen
79
80 @item p, SPC
81 pause
82
83 @item a
84 cycle audio channel
85
86 @item v
87 cycle video channel
88
89 @item w
90 show audio waves
91 @end table
92
93 @c man end
94
95 @ignore
96
97 @setfilename ffplay
98 @settitle FFplay media player
99
100 @c man begin SEEALSO
101 ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
102 @c man end
103
104 @c man begin AUTHOR
105 Fabrice Bellard
106 @c man end
107
108 @end ignore
109
110 @bye