ffplay.texi 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. \input texinfo @c -*- texinfo -*-
  2. @documentencoding UTF-8
  3. @settitle ffplay Documentation
  4. @titlepage
  5. @center @titlefont{ffplay Documentation}
  6. @end titlepage
  7. @top
  8. @contents
  9. @chapter Synopsis
  10. ffplay [@var{options}] [@file{input_url}]
  11. @chapter Description
  12. @c man begin DESCRIPTION
  13. FFplay is a very simple and portable media player using the FFmpeg
  14. libraries and the SDL library. It is mostly used as a testbed for the
  15. various FFmpeg APIs.
  16. @c man end
  17. @chapter Options
  18. @c man begin OPTIONS
  19. @include fftools-common-opts.texi
  20. @section Main options
  21. @table @option
  22. @item -x @var{width}
  23. Force displayed width.
  24. @item -y @var{height}
  25. Force displayed height.
  26. @item -fs
  27. Start in fullscreen mode.
  28. @item -an
  29. Disable audio.
  30. @item -vn
  31. Disable video.
  32. @item -sn
  33. Disable subtitles.
  34. @item -ss @var{pos}
  35. Seek to @var{pos}. Note that in most formats it is not possible to seek
  36. exactly, so @command{ffplay} will seek to the nearest seek point to
  37. @var{pos}.
  38. @var{pos} must be a time duration specification,
  39. see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  40. @item -t @var{duration}
  41. Play @var{duration} seconds of audio/video.
  42. @var{duration} must be a time duration specification,
  43. see @ref{time duration syntax,,the Time duration section in the ffmpeg-utils(1) manual,ffmpeg-utils}.
  44. @item -bytes
  45. Seek by bytes.
  46. @item -seek_interval
  47. Set custom interval, in seconds, for seeking using left/right keys. Default is 10 seconds.
  48. @item -nodisp
  49. Disable graphical display.
  50. @item -noborder
  51. Borderless window.
  52. @item -alwaysontop
  53. Window always on top. Available on: X11 with SDL >= 2.0.5, Windows SDL >= 2.0.6.
  54. @item -volume
  55. Set the startup volume. 0 means silence, 100 means no volume reduction or
  56. amplification. Negative values are treated as 0, values above 100 are treated
  57. as 100.
  58. @item -f @var{fmt}
  59. Force format.
  60. @item -window_title @var{title}
  61. Set window title (default is the input filename).
  62. @item -left @var{title}
  63. Set the x position for the left of the window (default is a centered window).
  64. @item -top @var{title}
  65. Set the y position for the top of the window (default is a centered window).
  66. @item -loop @var{number}
  67. Loops movie playback <number> times. 0 means forever.
  68. @item -showmode @var{mode}
  69. Set the show mode to use.
  70. Available values for @var{mode} are:
  71. @table @samp
  72. @item 0, video
  73. show video
  74. @item 1, waves
  75. show audio waves
  76. @item 2, rdft
  77. show audio frequency band using RDFT ((Inverse) Real Discrete Fourier Transform)
  78. @end table
  79. Default value is "video", if video is not present or cannot be played
  80. "rdft" is automatically selected.
  81. You can interactively cycle through the available show modes by
  82. pressing the key @key{w}.
  83. @item -vf @var{filtergraph}
  84. Create the filtergraph specified by @var{filtergraph} and use it to
  85. filter the video stream.
  86. @var{filtergraph} is a description of the filtergraph to apply to
  87. the stream, and must have a single video input and a single video
  88. output. In the filtergraph, the input is associated to the label
  89. @code{in}, and the output to the label @code{out}. See the
  90. ffmpeg-filters manual for more information about the filtergraph
  91. syntax.
  92. You can specify this parameter multiple times and cycle through the specified
  93. filtergraphs along with the show modes by pressing the key @key{w}.
  94. @item -af @var{filtergraph}
  95. @var{filtergraph} is a description of the filtergraph to apply to
  96. the input audio.
  97. Use the option "-filters" to show all the available filters (including
  98. sources and sinks).
  99. @item -i @var{input_url}
  100. Read @var{input_url}.
  101. @end table
  102. @section Advanced options
  103. @table @option
  104. @item -stats
  105. Print several playback statistics, in particular show the stream
  106. duration, the codec parameters, the current position in the stream and
  107. the audio/video synchronisation drift. It is shown by default, unless the
  108. log level is lower than @code{info}. Its display can be forced by manually
  109. specifying this option. To disable it, you need to specify @code{-nostats}.
  110. @item -fast
  111. Non-spec-compliant optimizations.
  112. @item -genpts
  113. Generate pts.
  114. @item -sync @var{type}
  115. Set the master clock to audio (@code{type=audio}), video
  116. (@code{type=video}) or external (@code{type=ext}). Default is audio. The
  117. master clock is used to control audio-video synchronization. Most media
  118. players use audio as master clock, but in some cases (streaming or high
  119. quality broadcast) it is necessary to change that. This option is mainly
  120. used for debugging purposes.
  121. @item -ast @var{audio_stream_specifier}
  122. Select the desired audio stream using the given stream specifier. The stream
  123. specifiers are described in the @ref{Stream specifiers} chapter. If this option
  124. is not specified, the "best" audio stream is selected in the program of the
  125. already selected video stream.
  126. @item -vst @var{video_stream_specifier}
  127. Select the desired video stream using the given stream specifier. The stream
  128. specifiers are described in the @ref{Stream specifiers} chapter. If this option
  129. is not specified, the "best" video stream is selected.
  130. @item -sst @var{subtitle_stream_specifier}
  131. Select the desired subtitle stream using the given stream specifier. The stream
  132. specifiers are described in the @ref{Stream specifiers} chapter. If this option
  133. is not specified, the "best" subtitle stream is selected in the program of the
  134. already selected video or audio stream.
  135. @item -autoexit
  136. Exit when video is done playing.
  137. @item -exitonkeydown
  138. Exit if any key is pressed.
  139. @item -exitonmousedown
  140. Exit if any mouse button is pressed.
  141. @item -codec:@var{media_specifier} @var{codec_name}
  142. Force a specific decoder implementation for the stream identified by
  143. @var{media_specifier}, which can assume the values @code{a} (audio),
  144. @code{v} (video), and @code{s} subtitle.
  145. @item -acodec @var{codec_name}
  146. Force a specific audio decoder.
  147. @item -vcodec @var{codec_name}
  148. Force a specific video decoder.
  149. @item -scodec @var{codec_name}
  150. Force a specific subtitle decoder.
  151. @item -autorotate
  152. Automatically rotate the video according to file metadata. Enabled by
  153. default, use @option{-noautorotate} to disable it.
  154. @item -framedrop
  155. Drop video frames if video is out of sync. Enabled by default if the master
  156. clock is not set to video. Use this option to enable frame dropping for all
  157. master clock sources, use @option{-noframedrop} to disable it.
  158. @item -infbuf
  159. Do not limit the input buffer size, read as much data as possible from the
  160. input as soon as possible. Enabled by default for realtime streams, where data
  161. may be dropped if not read in time. Use this option to enable infinite buffers
  162. for all inputs, use @option{-noinfbuf} to disable it.
  163. @item -filter_threads @var{nb_threads}
  164. Defines how many threads are used to process a filter pipeline. Each pipeline
  165. will produce a thread pool with this many threads available for parallel
  166. processing. The default is 0 which means that the thread count will be
  167. determined by the number of available CPUs.
  168. @end table
  169. @section While playing
  170. @table @key
  171. @item q, ESC
  172. Quit.
  173. @item f
  174. Toggle full screen.
  175. @item p, SPC
  176. Pause.
  177. @item m
  178. Toggle mute.
  179. @item 9, 0
  180. @item /, *
  181. Decrease and increase volume respectively.
  182. @item a
  183. Cycle audio channel in the current program.
  184. @item v
  185. Cycle video channel.
  186. @item t
  187. Cycle subtitle channel in the current program.
  188. @item c
  189. Cycle program.
  190. @item w
  191. Cycle video filters or show modes.
  192. @item s
  193. Step to the next frame.
  194. Pause if the stream is not already paused, step to the next video
  195. frame, and pause.
  196. @item left/right
  197. Seek backward/forward 10 seconds.
  198. @item down/up
  199. Seek backward/forward 1 minute.
  200. @item page down/page up
  201. Seek to the previous/next chapter.
  202. or if there are no chapters
  203. Seek backward/forward 10 minutes.
  204. @item right mouse click
  205. Seek to percentage in file corresponding to fraction of width.
  206. @item left mouse double-click
  207. Toggle full screen.
  208. @end table
  209. @c man end
  210. @include config.texi
  211. @ifset config-all
  212. @set config-readonly
  213. @ifset config-avutil
  214. @include utils.texi
  215. @end ifset
  216. @ifset config-avcodec
  217. @include codecs.texi
  218. @include bitstream_filters.texi
  219. @end ifset
  220. @ifset config-avformat
  221. @include formats.texi
  222. @include protocols.texi
  223. @end ifset
  224. @ifset config-avdevice
  225. @include devices.texi
  226. @end ifset
  227. @ifset config-swresample
  228. @include resampler.texi
  229. @end ifset
  230. @ifset config-swscale
  231. @include scaler.texi
  232. @end ifset
  233. @ifset config-avfilter
  234. @include filters.texi
  235. @end ifset
  236. @include general_contents.texi
  237. @end ifset
  238. @chapter See Also
  239. @ifhtml
  240. @ifset config-all
  241. @url{ffplay.html,ffplay},
  242. @end ifset
  243. @ifset config-not-all
  244. @url{ffplay-all.html,ffmpeg-all},
  245. @end ifset
  246. @url{ffmpeg.html,ffmpeg}, @url{ffprobe.html,ffprobe},
  247. @url{ffmpeg-utils.html,ffmpeg-utils},
  248. @url{ffmpeg-scaler.html,ffmpeg-scaler},
  249. @url{ffmpeg-resampler.html,ffmpeg-resampler},
  250. @url{ffmpeg-codecs.html,ffmpeg-codecs},
  251. @url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
  252. @url{ffmpeg-formats.html,ffmpeg-formats},
  253. @url{ffmpeg-devices.html,ffmpeg-devices},
  254. @url{ffmpeg-protocols.html,ffmpeg-protocols},
  255. @url{ffmpeg-filters.html,ffmpeg-filters}
  256. @end ifhtml
  257. @ifnothtml
  258. @ifset config-all
  259. ffplay(1),
  260. @end ifset
  261. @ifset config-not-all
  262. ffplay-all(1),
  263. @end ifset
  264. ffmpeg(1), ffprobe(1),
  265. ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
  266. ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
  267. ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
  268. @end ifnothtml
  269. @include authors.texi
  270. @ignore
  271. @setfilename ffplay
  272. @settitle FFplay media player
  273. @end ignore
  274. @bye