comparison flacdec.c @ 8711:f284b60e2bc5 libavcodec

cosmetics: add some documentation to FLACContext
author jbr
date Sat, 31 Jan 2009 02:10:43 +0000
parents bb7f9053df83
children eae97a6f2553
comparison
equal deleted inserted replaced
8710:eaae57fe72b2 8711:f284b60e2bc5
56 }; 56 };
57 57
58 typedef struct FLACContext { 58 typedef struct FLACContext {
59 FLACSTREAMINFO 59 FLACSTREAMINFO
60 60
61 AVCodecContext *avctx; 61 AVCodecContext *avctx; ///< parent AVCodecContext
62 GetBitContext gb; 62 GetBitContext gb; ///< GetBitContext initialized to start at the current frame
63 63
64 int blocksize/*, last_blocksize*/; 64 int blocksize; ///< number of samples in the current frame
65 int curr_bps; 65 int curr_bps; ///< bps for current subframe, adjusted for channel correlation and wasted bits
66 int sample_shift; /* shift required to make output samples 16-bit or 32-bit */ 66 int sample_shift; /* shift required to make output samples 16-bit or 32-bit */
67 int is32; /* flag to indicate if output should be 32-bit instead of 16-bit */ 67 int is32; /* flag to indicate if output should be 32-bit instead of 16-bit */
68 enum decorrelation_type decorrelation; 68 enum decorrelation_type decorrelation; ///< channel decorrelation type in the current frame
69 69
70 int32_t *decoded[MAX_CHANNELS]; 70 int32_t *decoded[MAX_CHANNELS]; ///< decoded samples
71 uint8_t *bitstream; 71 uint8_t *bitstream;
72 unsigned int bitstream_size; 72 unsigned int bitstream_size;
73 unsigned int bitstream_index; 73 unsigned int bitstream_index;
74 unsigned int allocated_bitstream_size; 74 unsigned int allocated_bitstream_size;
75 } FLACContext; 75 } FLACContext;