The mp4 tagger.
[paraslash.git] / bitstream.h
index 0999414..5890d08 100644 (file)
@@ -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;
@@ -21,10 +21,16 @@ struct getbit_context {
 
 #define VLC_TYPE int16_t
 
+/** A variable length code table. */
 struct vlc {
+       /** Number of bits of the table. */
        int bits;
-       VLC_TYPE(*table)[2];    ///< code, bits
-       int table_size, table_allocated;
+       /** The code and the bits table. */
+       VLC_TYPE(*table)[2];
+       /** The size of the table. */
+       int table_size;
+       /** Amount of memory allocated so far. */
+       int table_allocated;
 };
 
 static inline uint32_t show_bits(struct getbit_context *gbc, int num)
@@ -63,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)
@@ -82,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);
-