[FFmpeg-devel] [PATCH] doc: add libavformat.texi and ffmpeg-formats.texi files

Clément Bœsch ubitux at gmail.com
Tue Nov 27 15:46:26 CET 2012


On Mon, Nov 26, 2012 at 11:34:39AM +0100, Stefano Sabatini wrote:
[...]
> From 443b822f3e56be0135b531c5814b35d35e16cf30 Mon Sep 17 00:00:00 2001
> From: Stefano Sabatini <stefasab at gmail.com>
> Date: Sun, 18 Nov 2012 13:39:18 +0100
> Subject: [PATCH] doc: add libavformat.texi and ffmpeg-formats.texi files
> 
> ---
>  doc/Makefile            |    3 +-
>  doc/ffmpeg-formats.texi |  161 +++++++++++++++++++++++++++++++++++++++++++++++
>  doc/libavformat.texi    |   40 ++++++++++++
>  3 files changed, 203 insertions(+), 1 deletion(-)
>  create mode 100644 doc/ffmpeg-formats.texi
>  create mode 100644 doc/libavformat.texi
> 
> diff --git a/doc/Makefile b/doc/Makefile
> index 85ca978..1dea375 100644
> --- a/doc/Makefile
> +++ b/doc/Makefile
> @@ -2,9 +2,10 @@ DOCLIBS-$(CONFIG_AVUTIL)  += libavutil
>  DOCLIBS-$(CONFIG_SWSCALE) += libswscale
>  DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample
>  DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
> +DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
>  DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
>  
> -COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler ffmpeg-scaler
> +COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler ffmpeg-scaler ffmpeg-formats
>  
>  MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
>  PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
> diff --git a/doc/ffmpeg-formats.texi b/doc/ffmpeg-formats.texi
> new file mode 100644
> index 0000000..d7f0192
> --- /dev/null
> +++ b/doc/ffmpeg-formats.texi
> @@ -0,0 +1,161 @@
> +\input texinfo @c -*- texinfo -*-
> +
> + at settitle FFmpeg Formats Documentation
> + at titlepage
> + at center @titlefont{FFmpeg Formats Documentation}
> + at end titlepage
> +
> + at top
> +
> + at contents
> +
> + at chapter Description
> + at c man begin DESCRIPTION
> +
> +This document describes the supported formats (muxers and demuxers)
> +provided by the libavformat library.
> +

libavformat(3)?

> + at c man end DESCRIPTION
> +
> + at chapter Format Options
> + at c man begin FORMAT OPTIONS
> +
> +The libavformat library provides some generic global options, which
> +can be set on all the muxers and demuxers. In addition each muxer or
> +demuxer may support so-called private options, which are specific for
> +that component.
> +
> +Options may be set by specifying - at var{option} @var{value} in the
> +FFmpeg tools, or by setting the value explicitly in the
> + at code{AVFormatContext} options or using the @file{libavutil/opt.h} API
> +for programmatic use.
> +
> +The list of supported options follows:
> +
> + at table @option
> + at item avioflags @var{flags} (@emph{input/output})
> +Possible values:
> + at table @samp
> + at item direct
> +Reduce buffering.
> + at end table
> +
> + at item probesize @var{integer} (@emph{input})
> +Set probing size.
> +
> + at item packetsize @var{integer} (@emph{output})
> +Set packet size.
> +
> + at item fflags @var{flags} (@emph{input/output})
> +Set format flags.
> +
> +Possible values:
> + at table @samp
> + at item ignidx
> +Ignore index.
> + at item genpts
> +Generate PTS.
> + at item nofillin
> +Do not fill in missing values that can be exactly calculated.
> + at item noparse
> +Disable AVParsers, this needs @code{+nofillin} too.
> + at item igndts
> +Ignore DTS.
> + at item discardcorrupt
> +Discard corrupted frames.
> + at item sortdts
> +Try to interleave output packets by DTS.
> + at item keepside
> +Do not merge side data.
> + at item latm
> +Enable RTP MP4A-LATM payload.
> + at item nobuffer
> +Reduce the latency introduced by optional buffering
> + at end table
> +
> + at item analyzeduration @var{integer} (@emph{input})
> +Specify how many microseconds are analyzed to estimate duration.
> +
> + at item cryptokey @var{hexadecimal string} (@emph{input})
> +Set decryption key.
> +
> + at item indexmem @var{integer} (@emph{input})
> +Set max memory used for timestamp index (per stream).
> +
> + at item rtbufsize @var{integer} (@emph{input})
> +Set max memory used for buffering real-time frames.
> +
> + at item fdebug @var{flags} (@emph{input/output})
> +Print specific debug info.
> +
> +Possible values:
> + at table @samp
> + at item ts
> + at end table
> +
> + at item max_delay @var{integer} (@emph{input/output})
> +Set maximum muxing or demuxing delay in microseconds.
> +
> + at item fpsprobesize @var{integer} (@emph{input})
> +Set number of frames used to probe fps.
> +
> + at item audio_preload @var{integer} (@emph{output})
> +Set microseconds by which audio packets should be interleaved earlier.
> +
> + at item chunk_duration @var{integer} (@emph{output})
> +Set microseconds for each chunk.
> +
> + at item chunk_size @var{integer} (@emph{output})
> +Set size in bytes for each chunk.
> +
> + at item err_detect, f_err_detect @var{flags} (@emph{input})
> +Set error detection flags. @code{f_err_detect} is deprecated and
> +should be used only via the @command{ffmpeg} tool.
> +
> +Possible values:
> + at table @samp
> + at item crccheck
> +Verify embedded CRCs.
> + at item bitstream
> +Detect bitstream specification deviations.
> + at item buffer
> +Detect improper bitstream length.
> + at item explode
> +Abort decoding on minor error detection.
> + at item careful
> +Consider things that violate the spec and have not been seen in the
> +wild as errors.
> + at item compliant
> +Consider all spec non compliancies as errors.
> + at item aggressive
> +Consider things that a sane encoder should not do as an error.
> + at end table
> +
> + at item use_wallclock_as_timestamps @var{integer} (@emph{input})
> +Use wallclock as timestamps.
> +
> + at item avoid_negative_ts @var{integer} (@emph{output})
> +Avoid negative timestamps.
> + at end table
> +
> + at c man end FORMAT OPTIONS
> +
> + at include demuxers.texi
> + at include muxers.texi
> +
> + at ignore
> +
> + at setfilename ffmpeg-formats
> + at settitle FFmpeg formats
> +
> + at c man begin SEEALSO
> +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3)
> + at c man end
> +
> + at c man begin AUTHORS
> +See Git history (git://source.ffmpeg.org/ffmpeg)
> + at c man end
> +
> + at end ignore
> +
> + at bye
> diff --git a/doc/libavformat.texi b/doc/libavformat.texi
> new file mode 100644
> index 0000000..38757c2
> --- /dev/null
> +++ b/doc/libavformat.texi
> @@ -0,0 +1,40 @@
> +\input texinfo @c -*- texinfo -*-
> +
> + at settitle Libavformat Documentation
> + at titlepage
> + at center @titlefont{Libavformat Documentation}
> + at end titlepage
> +
> + at top
> +
> + at contents
> +
> + at chapter Description
> + at c man begin DESCRIPTION
> +
> +The libavformat library provides a generic framework for multiplexing
> +and demultiplexing (muxing and demuxing) audio, video and subtitle
> +streams. It encompasses multiple muxers and demuxers for multimedia
> +container formats.
> +
> +It also supports several input and output protocols to access a media
> +resource.
> +
> + at c man end DESCRIPTION
> +
> + at ignore
> +
> + at setfilename libavformat
> + at settitle multimedia muxing and demuxing library
> +
> + at c man begin SEEALSO
> +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3), libavcodec(3), ffmpeg-formats(1)
> + at c man end
> +
> + at c man begin AUTHORS
> +See Git history (git://source.ffmpeg.org/ffmpeg)
> + at c man end
> +
> + at end ignore
> +
> + at bye

LGTM

-- 
Clément B.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 490 bytes
Desc: not available
URL: <http://ffmpeg.org/pipermail/ffmpeg-devel/attachments/20121127/55b08531/attachment.asc>


More information about the ffmpeg-devel mailing list