Merge branch 't/cmd_improvements'

[paraslash.git] / bitstream.c

diff --git a/bitstream.c b/bitstream.c
index d9d5233a9cde81ad2265ab06fe425f549ab85c51..ddad67bb177211b3909f88d3be9dcb3d5c381238 100644 (file)
--- a/bitstream.c
+++ b/bitstream.c
@@ -27,6 +27,7 @@
 #include "wma.h"
 #include "bitstream.h"
 
+/** Read an 8, 16, or 32 bit entity from a VLC table. */
 #define GET_DATA(v, table, i, size) \
 {\
        const uint8_t *ptr = (const uint8_t *)table + i * size; \
@@ -132,10 +133,11 @@ static int build_table(struct vlc *vlc, int table_nb_bits, int nb_codes,
 /**
  * Build VLC decoding tables suitable for use with get_vlc().
  *
- * \param nb_bits Set the decoding table size (2^nb_bits)
- * entries. The bigger it is, the faster is the decoding. But
- * it should not be too big to save memory and L1 cache. '9'
- * is a good compromise.
+ * \param vlc The structure to be initialized.
+ *
+ * \param nb_bits Set the decoding table size (2^nb_bits) entries. The bigger
+ * it is, the faster is the decoding. But it should not be too big to save
+ * memory and L1 cache. '9' is a good compromise.
  *
  * \param nb_codes Number of vlcs codes.
  *
@@ -159,6 +161,14 @@ void init_vlc(struct vlc *vlc, int nb_bits, int nb_codes, const void *bits,
        build_table(vlc, nb_bits, nb_codes, bits, codes, codes_size, 0, 0);
 }
 
+/**
+ * Deallocate all resources of a VLC table.
+ *
+ * \param vlc Pointer to an initialized vlc structure.
+ *
+ * The table given by \a vlc must have been initialized earlier via \ref
+ * init_vlc().
+ */
 void free_vlc(struct vlc *vlc)
 {
        freep(&vlc->table);
@@ -169,6 +179,8 @@ void free_vlc(struct vlc *vlc)
  *
  * \param gbc The getbit context structure.
  *
+ * \param table The vlc tables to use.
+ *
  * \param bits The number of bits which will be read at once, must be
  * identical to nb_bits in init_vlc().
  *
@@ -200,5 +212,5 @@ int get_vlc(struct getbit_context *gbc, VLC_TYPE(*table)[2], int bits,
                }
        }
        skip_bits(gbc, n);
-       return code;
+       return code >= 0? code : -E_VLC;
 }