Mercurial > libavcodec.hg

changeset 8711:f284b60e2bc5 libavcodec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
cosmetics: add some documentation to FLACContext
author jbr
date Sat, 31 Jan 2009 02:10:43 +0000
parents eaae57fe72b2
children eae97a6f2553
files flacdec.c
diffstat 1 files changed, 6 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/flacdec.c	Sat Jan 31 01:50:18 2009 +0000
+++ b/flacdec.c	Sat Jan 31 02:10:43 2009 +0000
@@ -58,16 +58,16 @@
 typedef struct FLACContext {
     FLACSTREAMINFO
 
-    AVCodecContext *avctx;
-    GetBitContext gb;
+    AVCodecContext *avctx;                  ///< parent AVCodecContext
+    GetBitContext gb;                       ///< GetBitContext initialized to start at the current frame
 
-    int blocksize/*, last_blocksize*/;
-    int curr_bps;
+    int blocksize;                          ///< number of samples in the current frame
+    int curr_bps;                           ///< bps for current subframe, adjusted for channel correlation and wasted bits
     int sample_shift;   /* shift required to make output samples 16-bit or 32-bit */
     int is32;           /* flag to indicate if output should be 32-bit instead of 16-bit */
-    enum decorrelation_type decorrelation;
+    enum decorrelation_type decorrelation;  ///< channel decorrelation type in the current frame
 
-    int32_t *decoded[MAX_CHANNELS];
+    int32_t *decoded[MAX_CHANNELS];         ///< decoded samples
     uint8_t *bitstream;
     unsigned int bitstream_size;
     unsigned int bitstream_index;