[FFmpeg-cvslog] doc: initial nut documentation

[Luca Barbato]

ffmpeg | branch: master | Luca Barbato <lu_zero at gentoo.org> | Tue Dec 13 23:50:20 2011 +0100| [175d0d94da11b5a50f37d271650f040d8d2e1086] | committer: Luca Barbato

doc: initial nut documentation

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=175d0d94da11b5a50f37d271650f040d8d2e1086
---

 doc/Makefile |    1 +
 doc/nut.texi |  128 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 129 insertions(+)

diff --git a/doc/Makefile b/doc/Makefile
index 8f90674..6353034 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -7,6 +7,7 @@ HTMLPAGES   = $(PROGS-yes:%=doc/%.html)                                 \
               doc/general.html                                          \
               doc/git-howto.html                                        \
               doc/libavfilter.html                                      \
+              doc/nut.html                                              \
               doc/platform.html                                         \
 
 DOCS = $(HTMLPAGES) $(MANPAGES) $(PODPAGES)
diff --git a/doc/nut.texi b/doc/nut.texi
new file mode 100644
index 0000000..dafbb39
--- /dev/null
+++ b/doc/nut.texi
@@ -0,0 +1,128 @@
+\input texinfo @c -*- texinfo -*-
+
+ at settitle NUT
+
+ at titlepage
+ at center @titlefont{NUT}
+ at end titlepage
+
+ at top
+
+ at contents
+
+ at chapter Description
+NUT is a low overhead generic container format. It stores audio, video,
+subtitle and user-defined streams in a simple, yet efficient, way.
+
+It was created by a group of FFmpeg and MPlayer developers in 2003
+and was finalized in 2008.
+
+ at chapter Container-specific codec tags
+
+ at section Generic raw YUVA formats
+
+Since many exotic planar YUVA pixel formats are not considered by
+the AVI/QuickTime FourCC lists, the following scheme is adopted for
+representing them.
+
+The first two bytes can contain the values:
+Y1 = only Y
+Y2 = Y+A
+Y3 = YUV
+Y4 = YUVA
+
+The third byte represents the width and height chroma subsampling
+values for the UV planes, that is the amount to shift the luma
+width/height right to find the chroma width/height.
+
+The fourth byte is the number of bits used (8, 16, ...).
+
+If the order of bytes is inverted, that means that each component has
+to be read big-endian.
+
+ at section Raw Audio
+
+ at multitable @columnfractions .4 .4
+ at item ALAW  @tab A-LAW
+ at item ULAW  @tab MU-LAW
+ at item P<type><interleaving><bits> @tab little-endian PCM
+ at item <bits><interleaving><type>P @tab big-endian PCM
+ at end multitable
+
+<type> is S for signed integer, U for unsigned integer, F for IEEE float
+<interleaving> is D for default, as a historical artefact.
+<bits> is 8/16/24/32
+
+ at example
+PFD[32]   would for example be signed 32 bit little-endian IEEE float
+ at end example
+
+ at section Subtitles
+
+ at multitable @columnfractions .4 .4
+ at item UTF8   @tab Raw UTF-8
+ at item SSA[0] @tab SubStation Alpha
+ at item DVDS   @tab DVD subtitles
+ at item DVBS   @tab DVB subtitles
+ at end multitable
+
+ at section Codecs
+
+ at multitable @columnfractions .4 .4
+ at item 3IV1 @tab non-compliant MPEG-4 generated by old 3ivx
+ at item ASV1 @tab Asus Video
+ at item ASV2 @tab Asus Video 2
+ at item CVID @tab Cinepak
+ at item CYUV @tab Creative YUV
+ at item DIVX @tab non-compliant MPEG-4 generated by old DivX
+ at item DUCK @tab Truemotion 1
+ at item FFV1 @tab FFmpeg video 1
+ at item FFVH @tab FFmpeg Huffyuv
+ at item H261 @tab ITU H.261
+ at item H262 @tab ITU H.262
+ at item H263 @tab ITU H.263
+ at item H264 @tab ITU H.264
+ at item HFYU @tab Huffyuv
+ at item I263 @tab Intel H.263
+ at item IV31 @tab Indeo 3.1
+ at item IV32 @tab Indeo 3.2
+ at item IV50 @tab Indeo 5.0
+ at item LJPG @tab ITU JPEG (lossless)
+ at item MJLS @tab ITU JPEG-LS
+ at item MJPG @tab ITU JPEG
+ at item MPG4 @tab MS MPEG-4v1 (not ISO MPEG-4)
+ at item MP42 @tab MS MPEG-4v2
+ at item MP43 @tab MS MPEG-4v3
+ at item MP4V @tab ISO MPEG-4 Part 2 Video (from old encoders)
+ at item mpg1 @tab ISO MPEG-1 Video
+ at item mpg2 @tab ISO MPEG-2 Video
+ at item MRLE @tab MS RLE
+ at item MSVC @tab MS Video 1
+ at item RT21 @tab Indeo 2.1
+ at item RV10 @tab RealVideo 1.0
+ at item RV20 @tab RealVideo 2.0
+ at item RV30 @tab RealVideo 3.0
+ at item RV40 @tab RealVideo 4.0
+ at item SNOW @tab FFmpeg Snow
+ at item SVQ1 @tab Sorenson Video 1
+ at item SVQ3 @tab Sorenson Video 3
+ at item theo @tab Xiph Theora
+ at item TM20 @tab Truemotion 2.0
+ at item UMP4 @tab non-compliant MPEG-4 generated by UB Video MPEG-4
+ at item VCR1 @tab ATI VCR1
+ at item VP30 @tab VP 3.0
+ at item VP31 @tab VP 3.1
+ at item VP50 @tab VP 5.0
+ at item VP60 @tab VP 6.0
+ at item VP61 @tab VP 6.1
+ at item VP62 @tab VP 6.2
+ at item VP70 @tab VP 7.0
+ at item WMV1 @tab MS WMV7
+ at item WMV2 @tab MS WMV8
+ at item WMV3 @tab MS WMV9
+ at item WV1F @tab non-compliant MPEG-4 generated by ?
+ at item WVC1 @tab VC-1
+ at item XVID @tab non-compliant MPEG-4 generated by old Xvid
+ at item XVIX @tab non-compliant MPEG-4 generated by old Xvid with interlacing bug
+ at end multitable
+