sunrast: Document the different Sun Raster file format types.
authorAneesh Dogra <lionaneesh@gmail.com>
Fri, 27 Jan 2012 18:15:58 +0000 (23:45 +0530)
committerJustin Ruggles <justin.ruggles@gmail.com>
Fri, 27 Jan 2012 18:21:46 +0000 (13:21 -0500)
Signed-off-by: Justin Ruggles <justin.ruggles@gmail.com>
libavcodec/sunrast.c

index 6da57d1..a471aee 100644 (file)
 #include "libavutil/imgutils.h"
 #include "avcodec.h"
 
+/* The Old and Standard format types indicate that the image data is
+ * uncompressed. There is no difference between the two formats. */
 #define RT_OLD          0
 #define RT_STANDARD     1
+
+/* The Byte-Encoded format type indicates that the image data is compressed
+ * using a run-length encoding scheme. */
 #define RT_BYTE_ENCODED 2
+
+/* The RGB format type indicates that the image is uncompressed with reverse
+ * component order from Old and Standard (RGB vs BGR). */
 #define RT_FORMAT_RGB   3
+
+/* The TIFF and IFF format types indicate that the raster file was originally
+ * converted from either of these file formats. We do not have any samples or
+ * documentation of the format details. */
 #define RT_FORMAT_TIFF  4
 #define RT_FORMAT_IFF   5
+
+/* The Experimental format type is implementation-specific and is generally an
+ * indication that the image file does not conform to the Sun Raster file
+ * format specification. */
 #define RT_EXPERIMENTAL 0xffff
 
 typedef struct SUNRASTContext {