summaryrefslogtreecommitdiff
path: root/libavutil/pixfmt.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2018-07-18 22:22:35 +0200
committerMichael Niedermayer <michael@niedermayer.cc>2018-07-20 13:13:52 +0200
commitbe0b77e6e83b61c2da338201b5ddfae1c9acedc5 (patch)
treeeb3a191e20c303af4d565dd7ee872c06baef285a /libavutil/pixfmt.h
parent9cb3d8fcb7eb5b9b12a87ed27a2d7c4fc5416f85 (diff)
downloadffmpeg-be0b77e6e83b61c2da338201b5ddfae1c9acedc5.tar.gz
avutil/pixfmt: Document chroma plane size for odd resolutions
Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavutil/pixfmt.h')
-rw-r--r--libavutil/pixfmt.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/libavutil/pixfmt.h b/libavutil/pixfmt.h
index aea008bbdc..2b3307845e 100644
--- a/libavutil/pixfmt.h
+++ b/libavutil/pixfmt.h
@@ -42,6 +42,10 @@
* This is stored as BGRA on little-endian CPU architectures and ARGB on
* big-endian CPUs.
*
+ * @note
+ * If the resolution is not a multiple of the chroma subsampling factor
+ * then the chroma plane resolution must be rounded up.
+ *
* @par
* When the pixel format is palettized RGB32 (AV_PIX_FMT_PAL8), the palettized
* image data is stored in AVFrame.data[0]. The palette is transported in