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 @item -loglevel @var{loglevel}
  60 Set the logging level used by the library.
  61 @var{loglevel} is a number or a string containing one of the following values:
  62 @table @samp
  63 @item quiet
  64 @item panic
  65 @item fatal
  66 @item error
  67 @item warning
  68 @item info
  69 @item verbose
  70 @item debug
  71 @end table
  72 @end table
  73
  74 @section Advanced options
  75 @table @option
  76 @item -pix_fmt @var{format}
  77 Set pixel format.
  78 @item -stats
  79 Show the stream duration, the codec parameters, the current position in
  80 the stream and the audio/video synchronisation drift.
  81 @item -debug
  82 Print specific debug info.
  83 @item -bug
  84 Work around bugs.
  85 @item -vismv
  86 Visualize motion vectors.
  87 @item -fast
  88 Non-spec-compliant optimizations.
  89 @item -genpts
  90 Generate pts.
  91 @item -rtp_tcp
  92 Force RTP/TCP protocol usage instead of RTP/UDP. It is only meaningful
  93 if you are streaming with the RTSP protocol.
  94 @item -sync @var{type}
  95 Set the master clock to audio (@code{type=audio}), video
  96 (@code{type=video}) or external (@code{type=ext}). Default is audio. The
  97 master clock is used to control audio-video synchronization. Most media
  98 players use audio as master clock, but in some cases (streaming or high
  99 quality broadcast) it is necessary to change that. This option is mainly
 100 used for debugging purposes.
 101 @item -threads @var{count}
 102 Set the thread count.
 103 @item -ast @var{audio_stream_number}
 104 Select the desired audio stream number, counting from 0. The number
 105 refers to the list of all the input audio streams. If it is greater
 106 than the number of audio streams minus one, then the last one is
 107 selected, if it is negative the audio playback is disabled.
 108 @item -vst @var{video_stream_number}
 109 Select the desired video stream number, counting from 0. The number
 110 refers to the list of all the input video streams. If it is greater
 111 than the number of video streams minus one, then the last one is
 112 selected, if it is negative the video playback is disabled.
 113 @item -sst @var{subtitle_stream_number}
 114 Select the desired subtitle stream number, counting from 0. The number
 115 refers to the list of all the input subtitle streams. If it is greater
 116 than the number of subtitle streams minus one, then the last one is
 117 selected, if it is negative the subtitle rendering is disabled.
 118 @end table
 119
 120 @section While playing
 121
 122 @table @key
 123 @item q, ESC
 124 Quit.
 125
 126 @item f
 127 Toggle full screen.
 128
 129 @item p, SPC
 130 Pause.
 131
 132 @item a
 133 Cycle audio channel.
 134
 135 @item v
 136 Cycle video channel.
 137
 138 @item t
 139 Cycle subtitle channel.
 140
 141 @item w
 142 Show audio waves.
 143
 144 @item left/right
 145 Seek backward/forward 10 seconds.
 146
 147 @item down/up
 148 Seek backward/forward 1 minute.
 149
 150 @item mouse click
 151 Seek to percentage in file corresponding to fraction of width.
 152
 153 @end table
 154
 155 @c man end
 156
 157 @ignore
 158
 159 @setfilename ffplay
 160 @settitle FFplay media player
 161
 162 @c man begin SEEALSO
 163 ffmpeg(1), ffserver(1) and the HTML documentation of @file{ffmpeg}.
 164 @c man end
 165
 166 @c man begin AUTHOR
 167 Fabrice Bellard
 168 @c man end
 169
 170 @end ignore
 171
 172 @bye