X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=blobdiff_plain;f=bitstream.h;h=5890d08c89d4033f7fefb9a19be525860a701d77;hp=5d6be3be2693a84f8107504f4a086dfa578c817b;hb=741c19c2a25c5d9e165cb99f7ff512209b7bade6;hpb=ffb2eaa90429f6d5c3d369509efcdf91c5463dad diff --git a/bitstream.h b/bitstream.h index 5d6be3be..5890d08c 100644 --- a/bitstream.h +++ b/bitstream.h @@ -11,9 +11,9 @@ /** Structure for bistream I/O. */ struct getbit_context { - /* Start of the internal buffer. */ + /** Start of the internal buffer. */ const uint8_t *buffer; - /* End of the internal buffer. */ + /** End of the internal buffer. */ const uint8_t *buffer_end; /** Bit counter. */ int index; @@ -69,11 +69,13 @@ static inline unsigned int get_bit(struct getbit_context *gbc) /** * Initialize a getbit_context structure. * - * \param buffer The bitstream buffer. It must be 4 bytes larger then the - * actual read bits because the bitstream reader might read 32 bits at once and - * could read over the end. + * \param gbc The structure to initialize. + * \param buffer The bitstream buffer. + * \param size The size of the buffer in bytes. * - * \param bit_size The size of the buffer in bytes. + * The bitstream buffer must be 4 bytes larger then the actual read bits + * because the bitstream reader might read 32 bits at once and could read over + * the end. */ static inline void init_get_bits(struct getbit_context *gbc, const uint8_t *buffer, int size) @@ -88,4 +90,3 @@ void init_vlc(struct vlc *vlc, int nb_bits, int nb_codes, const void *bits, void free_vlc(struct vlc *vlc); int get_vlc(struct getbit_context *gbc, VLC_TYPE(*table)[2], int bits, int max_depth); -