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 -x @var{width}
  37 force displayed width
  38 @item -y @var{height}
  39 force displayed height
  40 @item -s @var{size}
  41 Set frame size (WxH or abbreviation), needed for videos which don't
  42 contain a header with the framesize like raw YUV.
  43 @item -an
  44 disable audio
  45 @item -vn
  46 disable video
  47 @item -ss @var{pos}
  48 seek to a given position in seconds
  49 @item -bytes
  50 seek by bytes
  51 @item -nodisp
  52 disable graphical display
  53 @item -f @var{fmt}
  54 force format
  55 @end table
  56
  57 @section Advanced options
  58 @table @option
  59 @item -pix_fmt @var{format}
  60 set pixel format
  61 @item -stats
  62 Show the stream duration, the codec parameters, the current position in
  63 the stream and the audio/video synchronisation drift.
  64 @item -debug
  65 print specific debug info
  66 @item -bug
  67 work around bugs
  68 @item -vismv
  69 visualize motion vectors
  70 @item -fast
  71 non-spec-compliant optimizations
  72 @item -genpts
  73 generate pts
  74 @item -rtp_tcp
  75 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
  76 if you are streaming with the RTSP protocol.
  77 @item -sync @var{type}
  78 Set the master clock to audio (@code{type=audio}), video
  79 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
  80 master clock is used to control audio-video synchronization. Most media
  81 players use audio as master clock, but in some cases (streaming or high
  82 quality broadcast) it is necessary to change that. This option is mainly
  83 used for debugging purposes.
  84 @item -threads @var{count}
  85 thread count
  86 @end table
  87
  88 @section While playing
  89
  90 @table @key
  91 @item q, ESC
  92 quit
  93
  94 @item f
  95 toggle full screen
  96
  97 @item p, SPC
  98 pause
  99
 100 @item a
 101 cycle audio channel
 102
 103 @item v
 104 cycle video channel
 105
 106 @item w
 107 show audio waves
 108
 109 @item left/right
 110 seek backward/forward 10 seconds
 111
 112 @item down/up
 113 seek backward/forward 1 minute
 114
 115 @item mouse click
 116 seek to percentage in file corresponding to fraction of width
 117
 118 @end table
 119
 120 @c man end
 121
 122 @ignore
 123
 124 @setfilename ffplay
 125 @settitle FFplay media player
 126
 127 @c man begin SEEALSO
 128 ffmpeg(1), ffserver(1) and the html documentation of @file{ffmpeg}.
 129 @c man end
 130
 131 @c man begin AUTHOR
 132 Fabrice Bellard
 133 @c man end
 134
 135 @end ignore
 136
 137 @bye