summaryrefslogtreecommitdiff
path: root/libavutil/frame.h
diff options
context:
space:
mode:
authorReimar Döffinger <Reimar.Doeffinger@gmx.de>2016-02-26 18:38:19 +0100
committerReimar Döffinger <Reimar.Doeffinger@gmx.de>2016-02-28 13:33:14 +0100
commit4dd4d535313016cf934a187ba8f46e51b583cfb9 (patch)
tree9cc4cf77a540f13782400a73b0020637a54e72ba /libavutil/frame.h
parent45fa03b1f9b0475df666f7592f250c37763b7d64 (diff)
Document and validate AVFrame plane pointers.
Check that the required plane pointers and only those are set up. Currently does not enforce anything for the palette pointer of pseudopal formats as I am unsure about the requirements. Signed-off-by: Reimar Döffinger <Reimar.Doeffinger@gmx.de>
Diffstat (limited to 'libavutil/frame.h')
-rw-r--r--libavutil/frame.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/libavutil/frame.h b/libavutil/frame.h
index 56001a8798..76a8123dcb 100644
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -187,6 +187,9 @@ typedef struct AVFrame {
* see avcodec_align_dimensions2(). Some filters and swscale can read
* up to 16 bytes beyond the planes, if these filters are to be used,
* then 16 extra bytes must be allocated.
+ *
+ * NOTE: Except for hwaccel formats, pointers not needed by the format
+ * MUST be set to NULL.
*/
uint8_t *data[AV_NUM_DATA_POINTERS];