From 8ddeae5ae7b83fec9185af32bb191ec249ef96bd Mon Sep 17 00:00:00 2001 From: Stefano Sabatini 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 85ca978629..1dea3759b3 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 0000000000..d7f01929a9 --- /dev/null +++ b/doc/ffmpeg-formats.texi @@ -0,0 +1,161 @@ +\input texinfo @c -*- texinfo -*- + +@settitle FFmpeg Formats Documentation +@titlepage +@center @titlefont{FFmpeg Formats Documentation} +@end titlepage + +@top + +@contents + +@chapter Description +@c man begin DESCRIPTION + +This document describes the supported formats (muxers and demuxers) +provided by the libavformat library. + +@c man end DESCRIPTION + +@chapter Format Options +@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 -@var{option} @var{value} in the +FFmpeg tools, or by setting the value explicitly in the +@code{AVFormatContext} options or using the @file{libavutil/opt.h} API +for programmatic use. + +The list of supported options follows: + +@table @option +@item avioflags @var{flags} (@emph{input/output}) +Possible values: +@table @samp +@item direct +Reduce buffering. +@end table + +@item probesize @var{integer} (@emph{input}) +Set probing size. + +@item packetsize @var{integer} (@emph{output}) +Set packet size. + +@item fflags @var{flags} (@emph{input/output}) +Set format flags. + +Possible values: +@table @samp +@item ignidx +Ignore index. +@item genpts +Generate PTS. +@item nofillin +Do not fill in missing values that can be exactly calculated. +@item noparse +Disable AVParsers, this needs @code{+nofillin} too. +@item igndts +Ignore DTS. +@item discardcorrupt +Discard corrupted frames. +@item sortdts +Try to interleave output packets by DTS. +@item keepside +Do not merge side data. +@item latm +Enable RTP MP4A-LATM payload. +@item nobuffer +Reduce the latency introduced by optional buffering +@end table + +@item analyzeduration @var{integer} (@emph{input}) +Specify how many microseconds are analyzed to estimate duration. + +@item cryptokey @var{hexadecimal string} (@emph{input}) +Set decryption key. + +@item indexmem @var{integer} (@emph{input}) +Set max memory used for timestamp index (per stream). + +@item rtbufsize @var{integer} (@emph{input}) +Set max memory used for buffering real-time frames. + +@item fdebug @var{flags} (@emph{input/output}) +Print specific debug info. + +Possible values: +@table @samp +@item ts +@end table + +@item max_delay @var{integer} (@emph{input/output}) +Set maximum muxing or demuxing delay in microseconds. + +@item fpsprobesize @var{integer} (@emph{input}) +Set number of frames used to probe fps. + +@item audio_preload @var{integer} (@emph{output}) +Set microseconds by which audio packets should be interleaved earlier. + +@item chunk_duration @var{integer} (@emph{output}) +Set microseconds for each chunk. + +@item chunk_size @var{integer} (@emph{output}) +Set size in bytes for each chunk. + +@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: +@table @samp +@item crccheck +Verify embedded CRCs. +@item bitstream +Detect bitstream specification deviations. +@item buffer +Detect improper bitstream length. +@item explode +Abort decoding on minor error detection. +@item careful +Consider things that violate the spec and have not been seen in the +wild as errors. +@item compliant +Consider all spec non compliancies as errors. +@item aggressive +Consider things that a sane encoder should not do as an error. +@end table + +@item use_wallclock_as_timestamps @var{integer} (@emph{input}) +Use wallclock as timestamps. + +@item avoid_negative_ts @var{integer} (@emph{output}) +Avoid negative timestamps. +@end table + +@c man end FORMAT OPTIONS + +@include demuxers.texi +@include muxers.texi + +@ignore + +@setfilename ffmpeg-formats +@settitle FFmpeg formats + +@c man begin SEEALSO +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3) +@c man end + +@c man begin AUTHORS +See Git history (git://source.ffmpeg.org/ffmpeg) +@c man end + +@end ignore + +@bye diff --git a/doc/libavformat.texi b/doc/libavformat.texi new file mode 100644 index 0000000000..38757c29c0 --- /dev/null +++ b/doc/libavformat.texi @@ -0,0 +1,40 @@ +\input texinfo @c -*- texinfo -*- + +@settitle Libavformat Documentation +@titlepage +@center @titlefont{Libavformat Documentation} +@end titlepage + +@top + +@contents + +@chapter Description +@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. + +@c man end DESCRIPTION + +@ignore + +@setfilename libavformat +@settitle multimedia muxing and demuxing library + +@c man begin SEEALSO +ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3), libavcodec(3), ffmpeg-formats(1) +@c man end + +@c man begin AUTHORS +See Git history (git://source.ffmpeg.org/ffmpeg) +@c man end + +@end ignore + +@bye