ffplay-doc.texi 2.5 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 33 34 35 36 37
@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
show help
@item -x width
force displayed width
@item -y height
force displayed height
38 39 40
@item -s size
Set frame size (WxH or abbreviation), needed for videos which don't
contain a header with the framesize like raw YUV.
41 42 43 44
@item -an
disable audio
@item -vn
disable video
45 46 47 48
@item -ss pos
seek to a given position in seconds
@item -bytes
seek by bytes
49 50 51 52 53 54 55 56
@item -nodisp
disable graphical display
@item -f fmt
force format
@end table

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

@section While playing

@table @key
@item q, ESC
quit

@item f
toggle full screen

@item p, SPC
pause

@item a
cycle audio channel

@item v
cycle video channel

@item w
show audio waves
106 107 108 109 110 111 112 113 114 115

@item left/right
seek backward/forward 10 seconds

@item down/up
seek backward/forward 1 minute

@item mouse click
seek to percentage in file corresponding to fraction of width

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
@end table

@c man end

@ignore

@setfilename ffplay
@settitle FFplay media player

@c man begin SEEALSO
ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore

@bye