summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefano.sabatini-lala@poste.it>2011-05-27 01:34:35 +0200
committerStefano Sabatini <stefano.sabatini-lala@poste.it>2011-05-28 19:17:14 +0200
commitb2a6f25c67cca644257f008c8de83e4939f87196 (patch)
tree4fb4b79a29419a9c99bb3e61866f2ff4ee70c681 /doc
parente71f26086ab899be7df1efb30b33e0a11973fd8e (diff)
downloadffmpeg-b2a6f25c67cca644257f008c8de83e4939f87196.tar.gz
lavdev: add SDL output device
Diffstat (limited to 'doc')
-rw-r--r--doc/outdevs.texi43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/outdevs.texi b/doc/outdevs.texi
index fbb312363c..9985900afc 100644
--- a/doc/outdevs.texi
+++ b/doc/outdevs.texi
@@ -26,6 +26,49 @@ ALSA (Advanced Linux Sound Architecture) output device.
OSS (Open Sound System) output device.
+@section sdl
+
+SDL (Simple Directmedia Layer) output device.
+
+This output devices allows to show a video stream in an SDL
+window. Only one SDL window is allowed per application, so you can
+have only one instance of this output device in an application.
+
+To enable this output device you need libsdl installed on your system
+when configuring your build.
+
+For more information about SDL, check:
+@url{http://www.libsdl.org/}
+
+@subsection Options
+
+@table @option
+
+@item window_title
+Set the SDL window title, if not specified default to "SDL video
+outdev".
+
+@item icon_title
+Set the name of the iconified SDL window, if not specified it is set
+to the same value of @var{window_title}.
+
+@item window_size
+Set the SDL window size, can be a string of the form
+@var{width}x@var{height} or a video size abbreviation.
+If not specified it defaults to the size of the input video.
+@end table
+
+@subsection Examples
+
+The following command shows the @file{ffmpeg} output is an
+SDL window, forcing its size to the qcif format:
+@example
+ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl none
+@end example
+
+Note that the name specified for the output device is ignored, so it
+can be set to an arbitrary value ("none" in the above example).
+
@section sndio
sndio audio output device.