fix filename self-references
[vlc.git] / include / vlc_bits.h
index 5f3414a..6c29151 100644 (file)
@@ -1,28 +1,33 @@
 /*****************************************************************************
- * bits.h :
+ * vlc_bits.h : Bit handling helpers
  *****************************************************************************
- * Copyright (C) 2003 VideoLAN
+ * Copyright (C) 2003 VLC authors and VideoLAN
  * $Id$
  *
  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#ifndef _VLC_BITS_H
-#define _VLC_BITS_H 1
+#ifndef VLC_BITS_H
+#define VLC_BITS_H 1
+
+/**
+ * \file
+ * This file defines functions, structures for handling streams of bits in vlc
+ */
 
 typedef struct bs_s
 {
@@ -30,27 +35,30 @@ typedef struct bs_s
     uint8_t *p;
     uint8_t *p_end;
 
-    int     i_left;    /* i_count number of available bits */
+    ssize_t  i_left;    /* i_count number of available bits */
 } bs_t;
 
-static inline void bs_init( bs_t *s, void *p_data, int i_data )
+static inline void bs_init( bs_t *s, const void *p_data, size_t i_data )
 {
-    s->p_start = p_data;
-    s->p       = p_data;
-    s->p_end   = s->p + i_data;
+    s->p_start = (void *)p_data;
+    s->p       = s->p_start;
+    s->p_end   = s->p_start + i_data;
     s->i_left  = 8;
 }
-static inline int bs_pos( bs_t *s )
+
+static inline int bs_pos( const bs_t *s )
 {
     return( 8 * ( s->p - s->p_start ) + 8 - s->i_left );
 }
-static inline int bs_eof( bs_t *s )
+
+static inline int bs_eof( const bs_t *s )
 {
     return( s->p >= s->p_end ? 1: 0 );
 }
+
 static inline uint32_t bs_read( bs_t *s, int i_count )
 {
-     static uint32_t i_mask[33] =
+     static const uint32_t i_mask[33] =
      {  0x00,
         0x01,      0x03,      0x07,      0x0f,
         0x1f,      0x3f,      0x7f,      0xff,
@@ -120,14 +128,16 @@ static inline uint32_t bs_show( bs_t *s, int i_count )
     return bs_read( &s_tmp, i_count );
 }
 
-static inline void bs_skip( bs_t *s, int i_count )
+static inline void bs_skip( bs_t *s, ssize_t i_count )
 {
     s->i_left -= i_count;
 
-    while( s->i_left <= 0 )
+    if( s->i_left <= 0 )
     {
-        s->p++;
-        s->i_left += 8;
+        const int i_bytes = ( -s->i_left + 8 ) / 8;
+
+        s->p += i_bytes;
+        s->i_left += 8 * i_bytes;
     }
 }
 
@@ -167,6 +177,7 @@ static inline void bs_align( bs_t *s )
         s->p++;
     }
 }
+
 static inline void bs_align_0( bs_t *s )
 {
     if( s->i_left != 8 )
@@ -174,6 +185,7 @@ static inline void bs_align_0( bs_t *s )
         bs_write( s, s->i_left, 0 );
     }
 }
+
 static inline void bs_align_1( bs_t *s )
 {
     while( s->i_left != 8 )