vlc_bits.h 6.12 KB
Newer Older
1
/*****************************************************************************
Pere Orga's avatar
Pere Orga committed
2
 * vlc_bits.h : Bit handling helpers
3
 *****************************************************************************
4
 * Copyright (C) 2001, 2002, 2003, 2006, 2015 VLC authors and VideoLAN
5
 * $Id$
6 7
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 9
 *          Gildas Bazin <gbazin at videolan dot org>
 *          Rafaël Carré <funman at videolan dot org>
10
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
11 12 13
 * 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
14 15 16 17
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
18 19
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
20
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
21 22 23
 * 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.
24
 *****************************************************************************/
25 26
#ifndef VLC_BITS_H
#define VLC_BITS_H 1
27

28
#include <vlc_common.h>
29

30 31 32 33 34
/**
 * \file
 * This file defines functions, structures for handling streams of bits in vlc
 */

35 36 37 38 39 40
typedef struct bs_s
{
    uint8_t *p_start;
    uint8_t *p;
    uint8_t *p_end;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
41
    ssize_t  i_left;    /* i_count number of available bits */
42
    bool     b_read_only;
43 44 45 46

     /* forward read modifier (p_start, p_end, p_fwpriv, count) */
    uint8_t *(*pf_forward)(uint8_t *, uint8_t *, void *, size_t);
    void    *p_fwpriv;
47
} bs_t;
48

49
static inline void bs_write_init( bs_t *s, void *p_data, size_t i_data )
50
{
51
    s->p_start = (uint8_t *)p_data;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
52 53
    s->p       = s->p_start;
    s->p_end   = s->p_start + i_data;
54
    s->i_left  = 8;
55
    s->b_read_only = false;
56 57
    s->p_fwpriv = NULL;
    s->pf_forward = NULL;
58 59 60 61 62 63
}

static inline void bs_init( bs_t *s, const void *p_data, size_t i_data )
{
    bs_write_init( s, (void*) p_data, i_data );
    s->b_read_only = true;
64
}
65

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
66
static inline int bs_pos( const bs_t *s )
67 68 69
{
    return( 8 * ( s->p - s->p_start ) + 8 - s->i_left );
}
70

71 72 73 74 75 76 77 78
static inline int bs_remain( const bs_t *s )
{
    if( s->p >= s->p_end )
        return 0;
    else
    return( 8 * ( s->p_end - s->p ) - 8 + s->i_left );
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
79
static inline int bs_eof( const bs_t *s )
80 81 82
{
    return( s->p >= s->p_end ? 1: 0 );
}
83

84 85 86
#define bs_forward( s, i ) \
    s->p = s->pf_forward ? s->pf_forward( s->p, s->p_end, s->p_fwpriv, i ) : s->p + i

87 88
static inline uint32_t bs_read( bs_t *s, int i_count )
{
89
     static const uint32_t i_mask[33] =
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
     {  0x00,
        0x01,      0x03,      0x07,      0x0f,
        0x1f,      0x3f,      0x7f,      0xff,
        0x1ff,     0x3ff,     0x7ff,     0xfff,
        0x1fff,    0x3fff,    0x7fff,    0xffff,
        0x1ffff,   0x3ffff,   0x7ffff,   0xfffff,
        0x1fffff,  0x3fffff,  0x7fffff,  0xffffff,
        0x1ffffff, 0x3ffffff, 0x7ffffff, 0xfffffff,
        0x1fffffff,0x3fffffff,0x7fffffff,0xffffffff};
    int      i_shr;
    uint32_t i_result = 0;

    while( i_count > 0 )
    {
        if( s->p >= s->p_end )
        {
            break;
        }

        if( ( i_shr = s->i_left - i_count ) >= 0 )
        {
            /* more in the buffer than requested */
            i_result |= ( *s->p >> i_shr )&i_mask[i_count];
            s->i_left -= i_count;
            if( s->i_left == 0 )
            {
116
                bs_forward( s, 1 );
117 118 119 120 121 122 123 124 125
                s->i_left = 8;
            }
            return( i_result );
        }
        else
        {
            /* less in the buffer than requested */
           i_result |= (*s->p&i_mask[s->i_left]) << -i_shr;
           i_count  -= s->i_left;
126
           bs_forward( s, 1);
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
           s->i_left = 8;
        }
    }

    return( i_result );
}

static inline uint32_t bs_read1( bs_t *s )
{
    if( s->p < s->p_end )
    {
        unsigned int i_result;

        s->i_left--;
        i_result = ( *s->p >> s->i_left )&0x01;
        if( s->i_left == 0 )
        {
144
            bs_forward( s, 1 );
145 146 147 148 149 150 151 152 153 154 155 156 157 158
            s->i_left = 8;
        }
        return i_result;
    }

    return 0;
}

static inline uint32_t bs_show( bs_t *s, int i_count )
{
    bs_t     s_tmp = *s;
    return bs_read( &s_tmp, i_count );
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
159
static inline void bs_skip( bs_t *s, ssize_t i_count )
160 161 162
{
    s->i_left -= i_count;

Laurent Aimar's avatar
Laurent Aimar committed
163
    if( s->i_left <= 0 )
164
    {
165
        const size_t i_bytes = 1 + s->i_left / -8;
166
        bs_forward( s, i_bytes );
167 168 169 170
        if( i_bytes * 8 < i_bytes /* ofw */ )
            s->i_left = i_bytes;
        else
            s->i_left += 8 * i_bytes;
171 172 173
    }
}

174
static inline void bs_write( bs_t *s, int i_count, uint32_t i_bits )
175
{
176 177 178
    if( s->b_read_only )
        return;

179 180 181
    while( i_count > 0 )
    {
        if( s->p >= s->p_end )
182
        {
183
            break;
184
        }
185 186 187 188

        i_count--;

        if( ( i_bits >> i_count )&0x01 )
189
        {
190
            *s->p |= 1 << ( s->i_left - 1 );
191
        }
192
        else
193
        {
194
            *s->p &= ~( 1 << ( s->i_left - 1 ) );
195
        }
196 197 198
        s->i_left--;
        if( s->i_left == 0 )
        {
199
            bs_forward( s, 1 );
200 201 202 203 204
            s->i_left = 8;
        }
    }
}

205 206 207 208 209
static inline bool bs_aligned( bs_t *s )
{
    return s->i_left % 8 == 0;
}

210
static inline void bs_align( bs_t *s )
211 212 213 214 215 216 217
{
    if( s->i_left != 8 )
    {
        s->i_left = 8;
        s->p++;
    }
}
218

219
static inline void bs_align_0( bs_t *s )
220 221
{
    if( s->i_left != 8 )
222 223 224
    {
        bs_write( s, s->i_left, 0 );
    }
225
}
226

227
static inline void bs_align_1( bs_t *s )
228
{
229
    while( !s->b_read_only && s->i_left != 8 )
230 231 232
    {
        bs_write( s, 1, 1 );
    }
233 234
}

235
/* Read unsigned Exp-Golomb code */
236
static inline uint_fast32_t bs_read_ue( bs_t * bs )
237
{
238
    unsigned i = 0;
239

240
    while( bs_read1( bs ) == 0 && bs->p < bs->p_end && i < 31 )
241 242
        i++;

243
    return (1U << i) - 1 + bs_read( bs, i );
244 245 246
}

/* Read signed Exp-Golomb code */
247
static inline int_fast32_t bs_read_se( bs_t *s )
248
{
249
    uint_fast32_t val = bs_read_ue( s );
250

251 252
    return (val & 0x01) ? (int_fast32_t)((val + 1) / 2)
                        : -(int_fast32_t)(val / 2);
253 254
}

255 256
#undef bs_forward

257
#endif