Merge commit 'a2fc8dbae85339d1b418d296f2982b6c04c53c57'
[ffmpeg.git] / doc / nut.texi
index 39a22ff..f9b18f5 100644 (file)
@@ -1,4 +1,5 @@
 \input texinfo @c -*- texinfo -*-
+@documentencoding UTF-8
 
 @settitle NUT
 
@@ -17,6 +18,31 @@ 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.
 
+The official nut specification is at svn://svn.mplayerhq.hu/nut
+In case of any differences between this text and the official specification,
+the official specification shall prevail.
+
+@chapter Modes
+NUT has some variants signaled by using the flags field in its main header.
+
+@multitable @columnfractions .4 .4
+@item BROADCAST   @tab Extend the syncpoint to report the sender wallclock
+@item PIPE        @tab Omit completely the syncpoint
+@end multitable
+
+@section BROADCAST
+
+The BROADCAST variant provides a secondary time reference to facilitate
+detecting endpoint latency and network delays.
+It assumes all the endpoint clocks are synchronized.
+To be used in real-time scenarios.
+
+@section PIPE
+
+The PIPE variant assumes NUT is used as non-seekable intermediate container,
+by not using syncpoint removes unneeded overhead and reduces the overall
+memory usage.
+
 @chapter Container-specific codec tags
 
 @section Generic raw YUVA formats
@@ -109,6 +135,7 @@ PFD[32]   would for example be signed 32 bit little-endian IEEE float
 @item RV20 @tab RealVideo 2.0
 @item RV30 @tab RealVideo 3.0
 @item RV40 @tab RealVideo 4.0
+@item SNOW @tab FFmpeg Snow
 @item SVQ1 @tab Sorenson Video 1
 @item SVQ3 @tab Sorenson Video 3
 @item theo @tab Xiph Theora