changeset 793:9072135121e0 libavutil

Clarify relations between log2_chroma_w, log2_chroma_h and comp.
author stefano
date Wed, 18 Nov 2009 22:32:32 +0000
parents 57659b3ef05c
children 7044a7c771b6
files pixdesc.h
diffstat 1 files changed, 9 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/pixdesc.h	Wed Nov 18 17:15:17 2009 +0000
+++ b/pixdesc.h	Wed Nov 18 22:32:32 2009 +0000
@@ -62,6 +62,7 @@
      * For YV12 this is 1 for example.
      * chroma_width = -((-luma_width) >> log2_chroma_w)
      * The note above is needed to ensure rounding up.
+     * This value only refers to the chroma components.
      */
     uint8_t log2_chroma_w;      ///< chroma_width = -((-luma_width )>>log2_chroma_w)
 
@@ -70,10 +71,17 @@
      * For YV12 this is 1 for example.
      * chroma_height= -((-luma_height) >> log2_chroma_h)
      * The note above is needed to ensure rounding up.
+     * This value only refers to the chroma components.
      */
     uint8_t log2_chroma_h;
     uint8_t flags;
-    AVComponentDescriptor comp[4]; ///< parameters that describe how pixels are packed
+
+    /**
+     * Parameters that describe how pixels are packed. If the format
+     * has chroma components, they must be stored in comp[1] and
+     * comp[2].
+     */
+    AVComponentDescriptor comp[4];
 }AVPixFmtDescriptor;
 
 #define PIX_FMT_BE        1 ///< big-endian