doc: add ffmpeg-bitstream-filters.texi file
authorStefano Sabatini <stefasab@gmail.com>
Mon, 26 Nov 2012 22:58:40 +0000 (23:58 +0100)
committerStefano Sabatini <stefasab@gmail.com>
Wed, 28 Nov 2012 22:51:12 +0000 (23:51 +0100)
doc/Makefile
doc/ffmpeg-bitstream-filters.texi [new file with mode: 0644]
doc/libavcodec.texi

index 180a85f..6635454 100644 (file)
@@ -6,7 +6,7 @@ DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
 DOCLIBS-$(CONFIG_AVDEVICE) += libavdevice
 DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
 
-COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-protocols ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
+COMPONENTS=$(PROGS-yes) ffmpeg-bitstream-filters ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-protocols ffmpeg-resampler ffmpeg-scaler ffmpeg-formats ffmpeg-utils
 
 MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
 PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
diff --git a/doc/ffmpeg-bitstream-filters.texi b/doc/ffmpeg-bitstream-filters.texi
new file mode 100644 (file)
index 0000000..b1fdac2
--- /dev/null
@@ -0,0 +1,40 @@
+\input texinfo @c -*- texinfo -*-
+
+@settitle FFmpeg Bitstream Filters Documentation
+@titlepage
+@center @titlefont{FFmpeg Bitstream Filters Documentation}
+@end titlepage
+
+@top
+
+@contents
+
+@chapter Description
+@c man begin DESCRIPTION
+
+This document describes the bitstream filters provided by the
+libavcodec library.
+
+A bitstream filter operates on the encoded stream data, and performs
+bitstream level modifications without performing decoding.
+
+@c man end DESCRIPTION
+
+@include bitstream_filters.texi
+
+@ignore
+
+@setfilename ffmpeg-bitstream-filters
+@settitle FFmpeg bistream filters
+
+@c man begin SEEALSO
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavcodec(3)
+@c man end
+
+@c man begin AUTHORS
+See Git history (git://source.ffmpeg.org/ffmpeg)
+@c man end
+
+@end ignore
+
+@bye
index 9c7f02e..1fd1cf8 100644 (file)
@@ -14,7 +14,7 @@
 
 The libavcodec library provides a generic encoding/decoding framework
 and contains multiple decoders and encoders for audio, video and
-subtitle streams.
+subtitle streams, and several bitstream filters.
 
 The shared architecture provides various services ranging from bit
 stream I/O to DSP optimizations, and makes it suitable for
@@ -26,7 +26,8 @@ implementing robust and fast codecs as well as for experimentation.
 @settitle media streams decoding and encoding library
 
 @c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-codecs(1), libavutil(3)
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), ffmpeg-codecs(1),
+ffmpeg-bistream-filters(1), libavutil(3)
 @c man end
 
 @c man begin AUTHORS