[FFmpeg-soc] [soc]: r2916 - aac/aac.c

[superdump]

Author: superdump
Date: Wed Jul 30 13:56:58 2008
New Revision: 2916

Log:
Add doxygen comments to DynamicRangeControl struct


Modified:
   aac/aac.c

Modified: aac/aac.c
==============================================================================
--- aac/aac.c	(original)
+++ aac/aac.c	Wed Jul 30 13:56:58 2008
@@ -276,15 +276,18 @@ typedef struct {
  * Dynamic Range Control - decoded from the bitstream but not processed further.
  */
 typedef struct {
-    int pce_instance_tag;
-    int dyn_rng_sgn[17];
-    int dyn_rng_ctl[17];
-    int exclude_mask[MAX_CHANNELS];
-    int additional_excluded_chns[MAX_CHANNELS];
-    int band_incr;
-    int interpolation_scheme;
-    int band_top[17];
-    int prog_ref_level;
+    int pce_instance_tag;                           ///< Indicates with which program the DRC info is associated.
+    int dyn_rng_sgn[17];                            ///< DRC sign information; 0 - positive, 1 - negative
+    int dyn_rng_ctl[17];                            ///< DRC magnitude information
+    int exclude_mask[MAX_CHANNELS];                 ///< Channels to be excluded from DRC processing.
+    int additional_excluded_chns[MAX_CHANNELS];     /**< The exclude_mask bits are
+                                                        coded in groups of 7 with 1 bit preceeding each group (except the first)
+                                                        indicating that 7 more mask bits are coded. */
+    int band_incr;                                  ///< Number of DRC bands greater than 1 having DRC info.
+    int interpolation_scheme;                       ///< Indicates the interpolation scheme used in the SBR QMF domain.
+    int band_top[17];                               ///< Indicates the top of the i-th DRC band in units of 4 spectral lines.
+    int prog_ref_level;                             /**< A reference level for the long-term program audio level for all
+                                                        channels combined. */
 } DynamicRangeControl;
 
 /**