[FFmpeg-cvslog] doc/devices: order alphabetically and add missing v4l2 outdev
Lou Logan
git at videolan.org
Wed Jun 13 22:32:42 EEST 2018
ffmpeg | branch: master | Lou Logan <lou at lrcd.com> | Wed Jun 13 11:21:12 2018 -0800| [30af29a712b820e8e28c4963fab0160128c23d3d] | committer: Lou Logan
doc/devices: order alphabetically and add missing v4l2 outdev
Signed-off-by: Lou Logan <lou at lrcd.com>
> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=30af29a712b820e8e28c4963fab0160128c23d3d
---
doc/indevs.texi | 221 +++++++++++++++++++++++++++----------------------------
doc/outdevs.texi | 62 ++++++++--------
2 files changed, 143 insertions(+), 140 deletions(-)
diff --git a/doc/indevs.texi b/doc/indevs.texi
index 632d1e4743..5d4c02c597 100644
--- a/doc/indevs.texi
+++ b/doc/indevs.texi
@@ -408,116 +408,6 @@ ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder'
@end itemize
- at section kmsgrab
-
-KMS video input device.
-
-Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
-DRM object that can be passed to other hardware functions.
-
-Requires either DRM master or CAP_SYS_ADMIN to run.
-
-If you don't understand what all of that means, you probably don't want this. Look at
- at option{x11grab} instead.
-
- at subsection Options
-
- at table @option
-
- at item device
-DRM device to capture on. Defaults to @option{/dev/dri/card0}.
-
- at item format
-Pixel format of the framebuffer. Defaults to @option{bgr0}.
-
- at item format_modifier
-Format modifier to signal on output frames. This is necessary to import correctly into
-some APIs, but can't be autodetected. See the libdrm documentation for possible values.
-
- at item crtc_id
-KMS CRTC ID to define the capture source. The first active plane on the given CRTC
-will be used.
-
- at item plane_id
-KMS plane ID to define the capture source. Defaults to the first active plane found if
-neither @option{crtc_id} nor @option{plane_id} are specified.
-
- at item framerate
-Framerate to capture at. This is not synchronised to any page flipping or framebuffer
-changes - it just defines the interval at which the framebuffer is sampled. Sampling
-faster than the framebuffer update rate will generate independent frames with the same
-content. Defaults to @code{30}.
-
- at end table
-
- at subsection Examples
-
- at itemize
-
- at item
-Capture from the first active plane, download the result to normal frames and encode.
-This will only work if the framebuffer is both linear and mappable - if not, the result
-may be scrambled or fail to download.
- at example
-ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
- at end example
-
- at item
-Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
- at example
-ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
- at end example
-
- at end itemize
-
- at section libndi_newtek
-
-The libndi_newtek input device provides capture capabilities for using NDI (Network
-Device Interface, standard created by NewTek).
-
-Input filename is a NDI source name that could be found by sending -find_sources 1
-to command line - it has no specific syntax but human-readable formatted.
-
-To enable this input device, you need the NDI SDK and you
-need to configure with the appropriate @code{--extra-cflags}
-and @code{--extra-ldflags}.
-
- at subsection Options
-
- at table @option
-
- at item find_sources
-If set to @option{true}, print a list of found/available NDI sources and exit.
-Defaults to @option{false}.
-
- at item wait_sources
-Override time to wait until the number of online sources have changed.
-Defaults to @option{0.5}.
-
- at item allow_video_fields
-When this flag is @option{false}, all video that you receive will be progressive.
-Defaults to @option{true}.
-
- at end table
-
- at subsection Examples
-
- at itemize
-
- at item
-List input devices:
- at example
-ffmpeg -f libndi_newtek -find_sources 1 -i dummy
- at end example
-
- at item
-Restream to NDI:
- at example
-ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
- at end example
-
- at end itemize
-
@section dshow
Windows DirectShow input device.
@@ -945,6 +835,68 @@ Set the number of channels. Default is 2.
@end table
+ at section kmsgrab
+
+KMS video input device.
+
+Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
+DRM object that can be passed to other hardware functions.
+
+Requires either DRM master or CAP_SYS_ADMIN to run.
+
+If you don't understand what all of that means, you probably don't want this. Look at
+ at option{x11grab} instead.
+
+ at subsection Options
+
+ at table @option
+
+ at item device
+DRM device to capture on. Defaults to @option{/dev/dri/card0}.
+
+ at item format
+Pixel format of the framebuffer. Defaults to @option{bgr0}.
+
+ at item format_modifier
+Format modifier to signal on output frames. This is necessary to import correctly into
+some APIs, but can't be autodetected. See the libdrm documentation for possible values.
+
+ at item crtc_id
+KMS CRTC ID to define the capture source. The first active plane on the given CRTC
+will be used.
+
+ at item plane_id
+KMS plane ID to define the capture source. Defaults to the first active plane found if
+neither @option{crtc_id} nor @option{plane_id} are specified.
+
+ at item framerate
+Framerate to capture at. This is not synchronised to any page flipping or framebuffer
+changes - it just defines the interval at which the framebuffer is sampled. Sampling
+faster than the framebuffer update rate will generate independent frames with the same
+content. Defaults to @code{30}.
+
+ at end table
+
+ at subsection Examples
+
+ at itemize
+
+ at item
+Capture from the first active plane, download the result to normal frames and encode.
+This will only work if the framebuffer is both linear and mappable - if not, the result
+may be scrambled or fail to download.
+ at example
+ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
+ at end example
+
+ at item
+Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
+ at example
+ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
+ at end example
+
+ at end itemize
+
@section lavfi
Libavfilter input virtual device.
@@ -1083,6 +1035,54 @@ IIDC1394 input device, based on libdc1394 and libraw1394.
Requires the configure option @code{--enable-libdc1394}.
+ at section libndi_newtek
+
+The libndi_newtek input device provides capture capabilities for using NDI (Network
+Device Interface, standard created by NewTek).
+
+Input filename is a NDI source name that could be found by sending -find_sources 1
+to command line - it has no specific syntax but human-readable formatted.
+
+To enable this input device, you need the NDI SDK and you
+need to configure with the appropriate @code{--extra-cflags}
+and @code{--extra-ldflags}.
+
+ at subsection Options
+
+ at table @option
+
+ at item find_sources
+If set to @option{true}, print a list of found/available NDI sources and exit.
+Defaults to @option{false}.
+
+ at item wait_sources
+Override time to wait until the number of online sources have changed.
+Defaults to @option{0.5}.
+
+ at item allow_video_fields
+When this flag is @option{false}, all video that you receive will be progressive.
+Defaults to @option{true}.
+
+ at end table
+
+ at subsection Examples
+
+ at itemize
+
+ at item
+List input devices:
+ at example
+ffmpeg -f libndi_newtek -find_sources 1 -i dummy
+ at end example
+
+ at item
+Restream to NDI:
+ at example
+ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
+ at end example
+
+ at end itemize
+
@section openal
The OpenAL input device provides audio capture on all systems with a
@@ -1201,7 +1201,6 @@ Set the number of channels. Default is 2.
@end table
-
@section pulse
PulseAudio input device.
diff --git a/doc/outdevs.texi b/doc/outdevs.texi
index c2906b9371..30d376d793 100644
--- a/doc/outdevs.texi
+++ b/doc/outdevs.texi
@@ -182,6 +182,35 @@ ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 -s 720x486 -r 24000/1001 'DeckLi
@end itemize
+ at section fbdev
+
+Linux framebuffer output device.
+
+The Linux framebuffer is a graphic hardware-independent abstraction
+layer to show graphics on a computer monitor, typically on the
+console. It is accessed through a file device node, usually
+ at file{/dev/fb0}.
+
+For more detailed information read the file
+ at file{Documentation/fb/framebuffer.txt} included in the Linux source tree.
+
+ at subsection Options
+ at table @option
+
+ at item xoffset
+ at item yoffset
+Set x/y coordinate of top left corner. Default is 0.
+ at end table
+
+ at subsection Examples
+Play a file on framebuffer device @file{/dev/fb0}.
+Required pixel format depends on current framebuffer settings.
+ at example
+ffmpeg -re -i INPUT -c:v rawvideo -pix_fmt bgra -f fbdev /dev/fb0
+ at end example
+
+See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
+
@section libndi_newtek
The libndi_newtek output device provides playback capabilities for using NDI (Network
@@ -227,35 +256,6 @@ ffmpeg -i "udp://@@239.1.1.1:10480?fifo_size=1000000&overrun_nonfatal=1" -vf "sc
@end itemize
- at section fbdev
-
-Linux framebuffer output device.
-
-The Linux framebuffer is a graphic hardware-independent abstraction
-layer to show graphics on a computer monitor, typically on the
-console. It is accessed through a file device node, usually
- at file{/dev/fb0}.
-
-For more detailed information read the file
- at file{Documentation/fb/framebuffer.txt} included in the Linux source tree.
-
- at subsection Options
- at table @option
-
- at item xoffset
- at item yoffset
-Set x/y coordinate of top left corner. Default is 0.
- at end table
-
- at subsection Examples
-Play a file on framebuffer device @file{/dev/fb0}.
-Required pixel format depends on current framebuffer settings.
- at example
-ffmpeg -re -i INPUT -c:v rawvideo -pix_fmt bgra -f fbdev /dev/fb0
- at end example
-
-See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
-
@section opengl
OpenGL output device.
@@ -425,6 +425,10 @@ ffmpeg -i INPUT -c:v rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL out
sndio audio output device.
+ at section v4l2
+
+Video4Linux2 output device.
+
@section xv
XV (XVideo) output device.
More information about the ffmpeg-cvslog
mailing list