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 Modes
  21 NUT has some variants signaled by using the flags field in its main header.
  22
  23 @multitable @columnfractions .4 .4
  24 @item BROADCAST   @tab Extend the syncpoint to report the sender wallclock
  25 @item PIPE        @tab Omit completely the syncpoint
  26 @end multitable
  27
  28 @section BROADCAST
  29
  30 The BROADCAST variant provides a secondary time reference to facilitate
  31 detecting endpoint latency and network delays.
  32 It assumes all the endpoint clocks are synchronized.
  33 To be used in real-time scenarios.
  34
  35 @section PIPE
  36
  37 The PIPE variant assumes NUT is used as non-seekable intermediate container,
  38 by not using syncpoint removes unneeded overhead and reduces the overall
  39 memory usage.
  40
  41 @chapter Container-specific codec tags
  42
  43 @section Generic raw YUVA formats
  44
  45 Since many exotic planar YUVA pixel formats are not considered by
  46 the AVI/QuickTime FourCC lists, the following scheme is adopted for
  47 representing them.
  48
  49 The first two bytes can contain the values:
  50 Y1 = only Y
  51 Y2 = Y+A
  52 Y3 = YUV
  53 Y4 = YUVA
  54
  55 The third byte represents the width and height chroma subsampling
  56 values for the UV planes, that is the amount to shift the luma
  57 width/height right to find the chroma width/height.
  58
  59 The fourth byte is the number of bits used (8, 16, ...).
  60
  61 If the order of bytes is inverted, that means that each component has
  62 to be read big-endian.
  63
  64 @section Raw Audio
  65
  66 @multitable @columnfractions .4 .4
  67 @item ALAW  @tab A-LAW
  68 @item ULAW  @tab MU-LAW
  69 @item P<type><interleaving><bits> @tab little-endian PCM
  70 @item <bits><interleaving><type>P @tab big-endian PCM
  71 @end multitable
  72
  73 <type> is S for signed integer, U for unsigned integer, F for IEEE float
  74 <interleaving> is D for default, P is for planar.
  75 <bits> is 8/16/24/32
  76
  77 @example
  78 PFD[32]   would for example be signed 32 bit little-endian IEEE float
  79 @end example
  80
  81 @section Subtitles
  82
  83 @multitable @columnfractions .4 .4
  84 @item UTF8   @tab Raw UTF-8
  85 @item SSA[0] @tab SubStation Alpha
  86 @item DVDS   @tab DVD subtitles
  87 @item DVBS   @tab DVB subtitles
  88 @end multitable
  89
  90 @section Raw Data
  91
  92 @multitable @columnfractions .4 .4
  93 @item UTF8   @tab Raw UTF-8
  94 @end multitable
  95
  96 @section Codecs
  97
  98 @multitable @columnfractions .4 .4
  99 @item 3IV1 @tab non-compliant MPEG-4 generated by old 3ivx
 100 @item ASV1 @tab Asus Video
 101 @item ASV2 @tab Asus Video 2
 102 @item CVID @tab Cinepak
 103 @item CYUV @tab Creative YUV
 104 @item DIVX @tab non-compliant MPEG-4 generated by old DivX
 105 @item DUCK @tab Truemotion 1
 106 @item FFV1 @tab FFmpeg video 1
 107 @item FFVH @tab FFmpeg Huffyuv
 108 @item H261 @tab ITU H.261
 109 @item H262 @tab ITU H.262
 110 @item H263 @tab ITU H.263
 111 @item H264 @tab ITU H.264
 112 @item HFYU @tab Huffyuv
 113 @item I263 @tab Intel H.263
 114 @item IV31 @tab Indeo 3.1
 115 @item IV32 @tab Indeo 3.2
 116 @item IV50 @tab Indeo 5.0
 117 @item LJPG @tab ITU JPEG (lossless)
 118 @item MJLS @tab ITU JPEG-LS
 119 @item MJPG @tab ITU JPEG
 120 @item MPG4 @tab MS MPEG-4v1 (not ISO MPEG-4)
 121 @item MP42 @tab MS MPEG-4v2
 122 @item MP43 @tab MS MPEG-4v3
 123 @item MP4V @tab ISO MPEG-4 Part 2 Video (from old encoders)
 124 @item mpg1 @tab ISO MPEG-1 Video
 125 @item mpg2 @tab ISO MPEG-2 Video
 126 @item MRLE @tab MS RLE
 127 @item MSVC @tab MS Video 1
 128 @item RT21 @tab Indeo 2.1
 129 @item RV10 @tab RealVideo 1.0
 130 @item RV20 @tab RealVideo 2.0
 131 @item RV30 @tab RealVideo 3.0
 132 @item RV40 @tab RealVideo 4.0
 133 @item SVQ1 @tab Sorenson Video 1
 134 @item SVQ3 @tab Sorenson Video 3
 135 @item theo @tab Xiph Theora
 136 @item TM20 @tab Truemotion 2.0
 137 @item UMP4 @tab non-compliant MPEG-4 generated by UB Video MPEG-4
 138 @item VCR1 @tab ATI VCR1
 139 @item VP30 @tab VP 3.0
 140 @item VP31 @tab VP 3.1
 141 @item VP50 @tab VP 5.0
 142 @item VP60 @tab VP 6.0
 143 @item VP61 @tab VP 6.1
 144 @item VP62 @tab VP 6.2
 145 @item VP70 @tab VP 7.0
 146 @item WMV1 @tab MS WMV7
 147 @item WMV2 @tab MS WMV8
 148 @item WMV3 @tab MS WMV9
 149 @item WV1F @tab non-compliant MPEG-4 generated by ?
 150 @item WVC1 @tab VC-1
 151 @item XVID @tab non-compliant MPEG-4 generated by old Xvid
 152 @item XVIX @tab non-compliant MPEG-4 generated by old Xvid with interlacing bug
 153 @end multitable
 154