doc: initial nut documentation
[ffmpeg.git] / doc / nut.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle NUT
4
5 @titlepage
6 @center @titlefont{NUT}
7 @end titlepage
8
9 @top
10
11 @contents
12
13 @chapter Description
14 NUT is a low overhead generic container format. It stores audio, video,
15 subtitle and user-defined streams in a simple, yet efficient, way.
16
17 It was created by a group of FFmpeg and MPlayer developers in 2003
18 and was finalized in 2008.
19
20 @chapter Container-specific codec tags
21
22 @section Generic raw YUVA formats
23
24 Since many exotic planar YUVA pixel formats are not considered by
25 the AVI/QuickTime FourCC lists, the following scheme is adopted for
26 representing them.
27
28 The first two bytes can contain the values:
29 Y1 = only Y
30 Y2 = Y+A
31 Y3 = YUV
32 Y4 = YUVA
33
34 The third byte represents the width and height chroma subsampling
35 values for the UV planes, that is the amount to shift the luma
36 width/height right to find the chroma width/height.
37
38 The fourth byte is the number of bits used (8, 16, ...).
39
40 If the order of bytes is inverted, that means that each component has
41 to be read big-endian.
42
43 @section Raw Audio
44
45 @multitable @columnfractions .4 .4
46 @item ALAW  @tab A-LAW
47 @item ULAW  @tab MU-LAW
48 @item P<type><interleaving><bits> @tab little-endian PCM
49 @item <bits><interleaving><type>P @tab big-endian PCM
50 @end multitable
51
52 <type> is S for signed integer, U for unsigned integer, F for IEEE float
53 <interleaving> is D for default, as a historical artefact.
54 <bits> is 8/16/24/32
55
56 @example
57 PFD[32]   would for example be signed 32 bit little-endian IEEE float
58 @end example
59
60 @section Subtitles
61
62 @multitable @columnfractions .4 .4
63 @item UTF8   @tab Raw UTF-8
64 @item SSA[0] @tab SubStation Alpha
65 @item DVDS   @tab DVD subtitles
66 @item DVBS   @tab DVB subtitles
67 @end multitable
68
69 @section Codecs
70
71 @multitable @columnfractions .4 .4
72 @item 3IV1 @tab non-compliant MPEG-4 generated by old 3ivx
73 @item ASV1 @tab Asus Video
74 @item ASV2 @tab Asus Video 2
75 @item CVID @tab Cinepak
76 @item CYUV @tab Creative YUV
77 @item DIVX @tab non-compliant MPEG-4 generated by old DivX
78 @item DUCK @tab Truemotion 1
79 @item FFV1 @tab FFmpeg video 1
80 @item FFVH @tab FFmpeg Huffyuv
81 @item H261 @tab ITU H.261
82 @item H262 @tab ITU H.262
83 @item H263 @tab ITU H.263
84 @item H264 @tab ITU H.264
85 @item HFYU @tab Huffyuv
86 @item I263 @tab Intel H.263
87 @item IV31 @tab Indeo 3.1
88 @item IV32 @tab Indeo 3.2
89 @item IV50 @tab Indeo 5.0
90 @item LJPG @tab ITU JPEG (lossless)
91 @item MJLS @tab ITU JPEG-LS
92 @item MJPG @tab ITU JPEG
93 @item MPG4 @tab MS MPEG-4v1 (not ISO MPEG-4)
94 @item MP42 @tab MS MPEG-4v2
95 @item MP43 @tab MS MPEG-4v3
96 @item MP4V @tab ISO MPEG-4 Part 2 Video (from old encoders)
97 @item mpg1 @tab ISO MPEG-1 Video
98 @item mpg2 @tab ISO MPEG-2 Video
99 @item MRLE @tab MS RLE
100 @item MSVC @tab MS Video 1
101 @item RT21 @tab Indeo 2.1
102 @item RV10 @tab RealVideo 1.0
103 @item RV20 @tab RealVideo 2.0
104 @item RV30 @tab RealVideo 3.0
105 @item RV40 @tab RealVideo 4.0
106 @item SNOW @tab FFmpeg Snow
107 @item SVQ1 @tab Sorenson Video 1
108 @item SVQ3 @tab Sorenson Video 3
109 @item theo @tab Xiph Theora
110 @item TM20 @tab Truemotion 2.0
111 @item UMP4 @tab non-compliant MPEG-4 generated by UB Video MPEG-4
112 @item VCR1 @tab ATI VCR1
113 @item VP30 @tab VP 3.0
114 @item VP31 @tab VP 3.1
115 @item VP50 @tab VP 5.0
116 @item VP60 @tab VP 6.0
117 @item VP61 @tab VP 6.1
118 @item VP62 @tab VP 6.2
119 @item VP70 @tab VP 7.0
120 @item WMV1 @tab MS WMV7
121 @item WMV2 @tab MS WMV8
122 @item WMV3 @tab MS WMV9
123 @item WV1F @tab non-compliant MPEG-4 generated by ?
124 @item WVC1 @tab VC-1
125 @item XVID @tab non-compliant MPEG-4 generated by old Xvid
126 @item XVIX @tab non-compliant MPEG-4 generated by old Xvid with interlacing bug
127 @end multitable
128