summaryrefslogtreecommitdiff
path: root/libavutil/pixdesc.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2015-01-15 20:56:07 +0100
committerMichael Niedermayer <michaelni@gmx.at>2015-01-24 14:07:00 +0100
commit1296dc6025dec85547006ffc60640153a1692b76 (patch)
tree94de73b68afb6c0ccd5a840e8ea339b9d61725c2 /libavutil/pixdesc.h
parentc651a1aaecb5cb7bb40cf40df27f5273e8bcd245 (diff)
avutil/pixdesc: rewrite AV_PIX_FMT_FLAG_PSEUDOPAL documentation
It seems many people do not understand its current documentation Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libavutil/pixdesc.h')
-rw-r--r--libavutil/pixdesc.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/libavutil/pixdesc.h b/libavutil/pixdesc.h
index a4376b2c0e..705377df8b 100644
--- a/libavutil/pixdesc.h
+++ b/libavutil/pixdesc.h
@@ -129,10 +129,14 @@ typedef struct AVPixFmtDescriptor {
* The pixel format contains RGB-like data (as opposed to YUV/grayscale).
*/
#define AV_PIX_FMT_FLAG_RGB (1 << 5)
+
/**
- * The pixel format is "pseudo-paletted". This means that FFmpeg treats it as
- * paletted internally, but the palette is generated by the decoder and is not
- * stored in the file.
+ * The pixel format is "pseudo-paletted". This means that it contains a
+ * fixed palette in the 2nd plane but the palette is fixed/constant for each
+ * PIX_FMT. This allows interpreting the data as if it was PAL8, which can
+ * in some cases be simpler. Or the data can be interpreted purely based on
+ * the pixel format without using the palette.
+ * An example of a pseudo-paletted format is AV_PIX_FMT_GRAY8
*/
#define AV_PIX_FMT_FLAG_PSEUDOPAL (1 << 6)
/**