added ffplay documentation - added automatic man page generation for ffmpeg, ffserver...
[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 test bench for the
16 various APIs of FFmpeg.
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 @end table
47
48 @section Advanced options
49 @table @option
50 @item -stats
51 show the stream duration, the codec parameters, the current position in
52 the stream, and the audio/video synchronisation drift.
53 @item -rtp_tcp
54 force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
55 if you are doing stream with the RTSP protocol.
56 @item -sync type
57 set the master clock to audio (@code{type=audio}), video
58 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
59 master clock is used to control audio-video synchronization. Most media
60 players use audio as master clock, but in some cases (streaming or high
61 quality broadcast) it is necessary to change that. This option is mainly
62 used for debugging purposes.
63 @end table
64
65 @section While playing
66
67 @table @key
68 @item q, ESC
69 quit
70
71 @item f
72 toggle full screen
73
74 @item p, SPC
75 pause
76
77 @item a
78 cycle audio channel
79
80 @item v
81 cycle video channel
82
83 @item w
84 show audio waves
85 @end table
86
87 @c man end
88
89 @ignore
90
91 @setfilename ffplay
92 @settitle FFplay media player
93
94 @c man begin SEEALSO
95 ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
96 @c man end
97
98 @c man begin AUTHOR
99 Fabrice Bellard
100 @c man end
101
102 @end ignore
103
104 @bye