[FFmpeg-devel] [PATCH] doc/indevs: add various missing options

[Ganesh Ajjanagadde]

On Tue, Aug 18, 2015 at 9:46 PM, Lou Logan <lou at lrcd.com> wrote:
> Signed-off-by: Lou Logan <lou at lrcd.com>
> ---
>  doc/indevs.texi | 161 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-
>  1 file changed, 160 insertions(+), 1 deletion(-)
>
> diff --git a/doc/indevs.texi b/doc/indevs.texi
> index 6f47504..9c81b82 100644
> --- a/doc/indevs.texi
> +++ b/doc/indevs.texi
> @@ -51,6 +51,18 @@ ffmpeg -f alsa -i hw:0 alsaout.wav
>  For more information see:
>  @url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}
>
> + at subsection Options
> +
> + at table @option
> +
> + at item sample_rate
> +Set the sample rate in Hz. Default is 48000.
> +
> + at item channels
> +Set the number of channels. Default is 2.
> +
> + at end table
> +
>  @section avfoundation
>
>  AVFoundation input device.
> @@ -114,6 +126,19 @@ und the first one in this list is used instead. Available pixel formats are:
>   bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
>   yuv420p, nv12, yuyv422, gray}
>
> + at item -framerate
> +Set grabbing frame rate. Default is @code{ntsc}, corresponding to a
> +frame rate of @code{30000/1001}.

minor nit on article usage: set grabbing frame rate -> set the
grabbing frame rate.
I mention this since it is mostly correct and helps consistency.

> +
> + at item -video_size
> +Set the video frame size.
> +
> + at item -capture_cursor
> +Capture the mouse pointer. Default is 0.
> +
> + at item -capture_mouse_clicks
> +Capture the screen mouse clicks. Default is 0.
> +
>  @end table
>
>  @subsection Examples
> @@ -150,6 +175,36 @@ $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
>
>  BSD video input device.
>
> + at subsection Options
> +
> + at table @option
> +
> + at item framerate
> +Set the frame rate.
> +
> + at item video_size
> +Set the video frame size. Default is @code{vga}.
> +
> + at item standard
> +
> +Available values are:
> + at table @samp
> + at item pal
> +
> + at item ntsc
> +
> + at item secam
> +
> + at item paln
> +
> + at item palm
> +
> + at item ntscj
> +
> + at end table
> +
> + at end table
> +
>  @section decklink
>
>  The decklink input device provides capture capabilities for Blackmagic
> @@ -429,6 +484,27 @@ $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_numbe
>
>  Linux DV 1394 input device.
>
> + at subsection Options
> +
> + at table @option
> +
> + at item framerate
> +Set the frame rate. Default is 25.
> +
> + at item standard
> +
> +Available values are:
> + at table @samp
> + at item pal
> +
> + at item ntsc
> +
> + at end table
> +
> +Default value is @code{ntsc}.
> +
> + at end table
> +
>  @section fbdev
>
>  Linux framebuffer input device.
> @@ -441,6 +517,8 @@ console. It is accessed through a file device node, usually
>  For more detailed information read the file
>  Documentation/fb/framebuffer.txt included in the Linux source tree.
>
> +See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).

Sourceforge has run into trouble with ad blockers/malware heuristics
due to the crapware that comes
loaded on a bunch of stuff there:
https://news.ycombinator.com/item?id=9738305
Ideally one would like a non Sourceforge link, but I can't find a
better link for this purpose.
Thus it is fine with me unless someone can find a better link.

> +
>  To record from the framebuffer device @file{/dev/fb0} with
>  @command{ffmpeg}:
>  @example
> @@ -452,7 +530,14 @@ You can take a single screenshot image with the command:
>  ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
>  @end example
>
> -See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
> + at subsection Options
> +
> + at table @option
> +
> + at item framerate
> +Set the frame rate. Default is 25.
> +
> + at end table
>
>  @section gdigrab
>
> @@ -638,6 +723,15 @@ $ jack_connect metro:120_bpm ffmpeg:input_1
>  For more information read:
>  @url{http://jackaudio.org/}
>
> + at subsection Options
> +
> + at table @option
> +
> + at item channels
> +Set number of channels. Default is 2.

minor nit on article usage: Set number of channels -> Set the number of channels

> +
> + at end table
> +
>  @section lavfi
>
>  Libavfilter input virtual device.
> @@ -678,6 +772,9 @@ Set the filename of the filtergraph to be read and sent to the other
>  filters. Syntax of the filtergraph is the same as the one specified by
>  the option @var{graph}.
>
> + at item dumpgraph
> +Dump graph to stderr.
> +
>  @end table
>
>  @subsection Examples
> @@ -879,6 +976,19 @@ ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
>  For more information about OSS see:
>  @url{http://manuals.opensound.com/usersguide/dsp.html}
>
> + at subsection Options
> +
> + at table @option
> +
> + at item sample_rate
> +Set the sample rate in Hz. Default is 48000.
> +
> + at item channels
> +Set the number of channels. Default is 2.
> +
> + at end table
> +
> +
>  @section pulse
>
>  PulseAudio input device.
> @@ -919,6 +1029,10 @@ Specify the number of bytes per frame, by default it is set to 1024.
>  @item fragment_size
>  Specify the minimal buffering fragment in PulseAudio, it will affect the
>  audio latency. By default it is unset.
> +
> + at item wallclock
> +Set the initial PTS using the current time. Default is 1.
> +
>  @end table
>
>  @subsection Examples
> @@ -954,6 +1068,22 @@ ffmpeg -f qtkit -i "default" out.mpg
>  ffmpeg -f qtkit -list_devices true -i ""
>  @end example
>
> + at subsection Options
> +
> + at table @option
> +
> + at item frame_rate
> +Set frame rate. Default is 30.

article usage: Set frame rate -> Set the frame rate
> +
> + at item list_devices
> +If set to @code{true}, print a list of devices and exit. Default is
> + at code{false}.
> +
> + at item video_device_index
> +Select video device by index for devices with same name (starts at 0).

article usage: Select video device -> Select the video device
with same name -> with the same name

> +
> + at end table
> +
>  @section sndio
>
>  sndio input device.
> @@ -971,6 +1101,18 @@ command:
>  ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
>  @end example
>
> + at subsection Options
> +
> + at table @option
> +
> + at item sample_rate
> +Set the sample rate in Hz. Default is 48000.
> +
> + at item channels
> +Set the number of channels. Default is 2.
> +
> + at end table
> +
>  @section video4linux2, v4l2
>
>  Video4Linux2 input video device.
> @@ -1093,6 +1235,10 @@ Force conversion from monotonic to absolute timestamps.
>  @end table
>
>  Default value is @code{default}.
> +
> + at item use_libv4l2
> +Use libv4l2 (v4l-utils) conversion functions. Default is 0.
> +
>  @end table
>
>  @section vfwcap
> @@ -1103,6 +1249,19 @@ The filename passed as input is the capture driver number, ranging from
>  0 to 9. You may use "list" as filename to print a list of drivers. Any
>  other filename will be interpreted as device number 0.
>
> + at subsection Options
> +
> + at table @option
> +
> + at item video_size
> +Set the video frame size.
> +
> + at item framerate
> +Set the grabbing frame rate. Default value is @code{ntsc},
> +corresponding to a frame rate of @code{30000/1001}.
> +
> + at end table
> +
>  @section x11grab

Note that I have not checked the technical content of this patch.

>
>  X11 video input device.
> --
> 2.5.0
>
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel at ffmpeg.org
> http://ffmpeg.org/mailman/listinfo/ffmpeg-devel