[FFmpeg-soc] [soc]: r5374 - wmapro/wmaprodec.c

[faust3]

Author: faust3
Date: Mon Aug 31 20:57:35 2009
New Revision: 5374

Log:
add some more doxygen comments to decode_tilehdr

Modified:
   wmapro/wmaprodec.c

Modified: wmapro/wmaprodec.c
==============================================================================
--- wmapro/wmaprodec.c	Mon Aug 31 20:35:11 2009	(r5373)
+++ wmapro/wmaprodec.c	Mon Aug 31 20:57:35 2009	(r5374)
@@ -502,11 +502,11 @@ static int decode_subframe_length(WMA3De
  */
 static int decode_tilehdr(WMA3DecodeContext *s)
 {
-    uint16_t num_samples[WMAPRO_MAX_CHANNELS];
-    uint8_t  contains_subframe[WMAPRO_MAX_CHANNELS];
-    int channels_for_cur_subframe = s->num_channels;
-    int fixed_channel_layout = 0;
-    int min_channel_len = 0;
+    uint16_t num_samples[WMAPRO_MAX_CHANNELS];        /** sum of samples for all currently known subframes of a channel */
+    uint8_t  contains_subframe[WMAPRO_MAX_CHANNELS];  /** flag indicating if a channel contains the current subframe */
+    int channels_for_cur_subframe = s->num_channels;  /** number of channels that contain the current subframe */
+    int fixed_channel_layout = 0;                     /** flag indicating that all channels use the same subframe offsets and sizes */
+    int min_channel_len = 0;                          /** smallest sum of samples (channels with this length will be processed first) */
     int c;
 
     /* Should never consume more than 3073 bits (256 iterations for the
@@ -540,7 +540,7 @@ static int decode_tilehdr(WMA3DecodeCont
                 contains_subframe[c] = 0;
         }
 
-        /** get subframe length */
+        /** get subframe length, subframe_len == 0 is not allowed */
         if ((subframe_len = decode_subframe_length(s, min_channel_len)) <= 0)
             return AVERROR_INVALIDDATA;