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