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 -version
  35 Show version.
  36 @item -L
  37 Show license.
  38 @item -formats
  39 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 @end table
  60
  61 @section Advanced options
  62 @table @option
  63 @item -pix_fmt @var{format}
  64 Set pixel format.
  65 @item -stats
  66 Show the stream duration, the codec parameters, the current position in
  67 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
  79 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
  80 if you are streaming with the RTSP protocol.
  81 @item -sync @var{type}
  82 Set the master clock to audio (@code{type=audio}), video
  83 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
  84 master clock is used to control audio-video synchronization. Most media
  85 players use audio as master clock, but in some cases (streaming or high
  86 quality broadcast) it is necessary to change that. This option is mainly
  87 used for debugging purposes.
  88 @item -threads @var{count}
  89 Set the thread count.
  90 @end table
  91
  92 @section While playing
  93
  94 @table @key
  95 @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 @end table
 123
 124 @c man end
 125
 126 @ignore
 127
 128 @setfilename ffplay
 129 @settitle FFplay media player
 130
 131 @c man begin SEEALSO
 132 ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
 133 @c man end
 134
 135 @c man begin AUTHOR
 136 Fabrice Bellard
 137 @c man end
 138
 139 @end ignore
 140
 141 @bye