bitstream.h 8.29 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
Fiona Glaser's avatar
Fiona Glaser committed
2
 * bitstream.h: bitstream writing
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
Loren Merritt's avatar
Loren Merritt committed
4
 * Copyright (C) 2003-2013 x264 project
Fiona Glaser's avatar
Fiona Glaser committed
5 6 7 8
 *
 * Authors: Loren Merritt <lorenm@u.washington.edu>
 *          Fiona Glaser <fiona@x264.com>
 *          Laurent Aimar <fenrir@via.ecp.fr>
Laurent Aimar's avatar
Laurent Aimar committed
9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * 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
 * (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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
Fiona Glaser's avatar
Fiona Glaser committed
23 24 25
 *
 * This program is also available under a commercial proprietary license.
 * For more information, contact us at licensing@x264.com.
Laurent Aimar's avatar
Laurent Aimar committed
26 27
 *****************************************************************************/

28 29
#ifndef X264_BS_H
#define X264_BS_H
Laurent Aimar's avatar
Laurent Aimar committed
30

Loren Merritt's avatar
Loren Merritt committed
31 32 33 34 35 36
typedef struct
{
    uint8_t i_bits;
    uint8_t i_size;
} vlc_t;

37 38 39 40 41 42 43 44
typedef struct
{
    uint16_t i_bits;
    uint8_t  i_size;
    /* Next level table to use */
    uint8_t  i_next;
} vlc_large_t;

Laurent Aimar's avatar
Laurent Aimar committed
45 46 47 48 49 50
typedef struct bs_s
{
    uint8_t *p_start;
    uint8_t *p;
    uint8_t *p_end;

51
    uintptr_t cur_bits;
Laurent Aimar's avatar
Laurent Aimar committed
52
    int     i_left;    /* i_count number of available bits */
53
    int     i_bits_encoded; /* RD only */
Laurent Aimar's avatar
Laurent Aimar committed
54 55
} bs_t;

56 57 58
typedef struct
{
    int     last;
59
    int     mask;
60
    dctcoef level[16];
61 62
} x264_run_level_t;

Henrik Gramner's avatar
Henrik Gramner committed
63 64
extern const vlc_t x264_coeff0_token[6];
extern const vlc_t x264_coeff_token[6][16][4];
Loren Merritt's avatar
Loren Merritt committed
65
extern const vlc_t x264_total_zeros[15][16];
Henrik Gramner's avatar
Henrik Gramner committed
66 67
extern const vlc_t x264_total_zeros_2x2_dc[3][4];
extern const vlc_t x264_total_zeros_2x4_dc[7][8];
Loren Merritt's avatar
Loren Merritt committed
68

69 70 71 72 73 74 75
typedef struct
{
    uint8_t *(*nal_escape) ( uint8_t *dst, uint8_t *src, uint8_t *end );
} x264_bitstream_function_t;

void x264_bitstream_init( int cpu, x264_bitstream_function_t *pf );

76 77 78 79 80 81 82 83
/* A larger level table size theoretically could help a bit at extremely
 * high bitrates, but the cost in cache is usually too high for it to be
 * useful.
 * This size appears to be optimal for QP18 encoding on a Nehalem CPU.
 * FIXME: Do further testing? */
#define LEVEL_TABLE_SIZE 128
extern vlc_large_t x264_level_token[7][LEVEL_TABLE_SIZE];

84 85 86 87 88
/* The longest possible set of zero run codes sums to 25 bits.  This leaves
 * plenty of room for both the code (25 bits) and size (5 bits) in a uint32_t. */

extern uint32_t x264_run_before[1<<16];

Laurent Aimar's avatar
Laurent Aimar committed
89 90
static inline void bs_init( bs_t *s, void *p_data, int i_data )
{
91
    int offset = ((intptr_t)p_data & 3);
Fiona Glaser's avatar
Fiona Glaser committed
92 93
    s->p       = s->p_start = (uint8_t*)p_data - offset;
    s->p_end   = (uint8_t*)p_data + i_data;
94
    s->i_left  = (WORD_SIZE - offset)*8;
95
    s->cur_bits = endian_fix32( M32(s->p) );
96
    s->cur_bits >>= (4-offset)*8;
Laurent Aimar's avatar
Laurent Aimar committed
97 98 99
}
static inline int bs_pos( bs_t *s )
{
Fiona Glaser's avatar
Fiona Glaser committed
100 101 102
    return( 8 * (s->p - s->p_start) + (WORD_SIZE*8) - s->i_left );
}

103
/* Write the rest of cur_bits to the bitstream; results in a bitstream no longer 32-bit aligned. */
Fiona Glaser's avatar
Fiona Glaser committed
104 105
static inline void bs_flush( bs_t *s )
{
Fiona Glaser's avatar
Fiona Glaser committed
106
    M32( s->p ) = endian_fix32( s->cur_bits << (s->i_left&31) );
107
    s->p += WORD_SIZE - (s->i_left >> 3);
Fiona Glaser's avatar
Fiona Glaser committed
108
    s->i_left = WORD_SIZE*8;
Laurent Aimar's avatar
Laurent Aimar committed
109
}
110 111 112 113 114 115 116 117 118 119 120 121
/* The inverse of bs_flush: prepare the bitstream to be written to again. */
static inline void bs_realign( bs_t *s )
{
    int offset = ((intptr_t)s->p & 3);
    if( offset )
    {
        s->p       = (uint8_t*)s->p - offset;
        s->i_left  = (WORD_SIZE - offset)*8;
        s->cur_bits = endian_fix32( M32(s->p) );
        s->cur_bits >>= (4-offset)*8;
    }
}
Laurent Aimar's avatar
Laurent Aimar committed
122 123 124

static inline void bs_write( bs_t *s, int i_count, uint32_t i_bits )
{
Fiona Glaser's avatar
Fiona Glaser committed
125 126 127 128 129 130
    if( WORD_SIZE == 8 )
    {
        s->cur_bits = (s->cur_bits << i_count) | i_bits;
        s->i_left -= i_count;
        if( s->i_left <= 32 )
        {
Steven Walters's avatar
Steven Walters committed
131
#if WORDS_BIGENDIAN
Fiona Glaser's avatar
Fiona Glaser committed
132
            M32( s->p ) = s->cur_bits >> (32 - s->i_left);
133
#else
Fiona Glaser's avatar
Fiona Glaser committed
134
            M32( s->p ) = endian_fix( s->cur_bits << s->i_left );
135
#endif
Fiona Glaser's avatar
Fiona Glaser committed
136 137 138 139 140
            s->i_left += 32;
            s->p += 4;
        }
    }
    else
Laurent Aimar's avatar
Laurent Aimar committed
141
    {
Loren Merritt's avatar
Loren Merritt committed
142
        if( i_count < s->i_left )
Laurent Aimar's avatar
Laurent Aimar committed
143
        {
Fiona Glaser's avatar
Fiona Glaser committed
144
            s->cur_bits = (s->cur_bits << i_count) | i_bits;
Loren Merritt's avatar
Loren Merritt committed
145
            s->i_left -= i_count;
Laurent Aimar's avatar
Laurent Aimar committed
146 147 148
        }
        else
        {
Loren Merritt's avatar
Loren Merritt committed
149
            i_count -= s->i_left;
Fiona Glaser's avatar
Fiona Glaser committed
150
            s->cur_bits = (s->cur_bits << s->i_left) | (i_bits >> i_count);
Fiona Glaser's avatar
Fiona Glaser committed
151
            M32( s->p ) = endian_fix( s->cur_bits );
Fiona Glaser's avatar
Fiona Glaser committed
152 153 154
            s->p += 4;
            s->cur_bits = i_bits;
            s->i_left = 32 - i_count;
Laurent Aimar's avatar
Laurent Aimar committed
155 156 157 158
        }
    }
}

Fiona Glaser's avatar
Fiona Glaser committed
159 160 161 162 163 164 165 166
/* Special case to eliminate branch in normal bs_write. */
/* Golomb never writes an even-size code, so this is only used in slice headers. */
static inline void bs_write32( bs_t *s, uint32_t i_bits )
{
    bs_write( s, 16, i_bits >> 16 );
    bs_write( s, 16, i_bits );
}

Loren Merritt's avatar
Loren Merritt committed
167
static inline void bs_write1( bs_t *s, uint32_t i_bit )
Laurent Aimar's avatar
Laurent Aimar committed
168
{
Fiona Glaser's avatar
Fiona Glaser committed
169 170
    s->cur_bits <<= 1;
    s->cur_bits |= i_bit;
171
    s->i_left--;
Fiona Glaser's avatar
Fiona Glaser committed
172
    if( s->i_left == WORD_SIZE*8-32 )
Laurent Aimar's avatar
Laurent Aimar committed
173
    {
Fiona Glaser's avatar
Fiona Glaser committed
174
        M32( s->p ) = endian_fix32( s->cur_bits );
Fiona Glaser's avatar
Fiona Glaser committed
175 176
        s->p += 4;
        s->i_left = WORD_SIZE*8;
Laurent Aimar's avatar
Laurent Aimar committed
177 178 179
    }
}

Loren Merritt's avatar
Loren Merritt committed
180
static inline void bs_align_0( bs_t *s )
Laurent Aimar's avatar
Laurent Aimar committed
181
{
182
    bs_write( s, s->i_left&7, 0 );
Fiona Glaser's avatar
Fiona Glaser committed
183
    bs_flush( s );
Laurent Aimar's avatar
Laurent Aimar committed
184
}
Loren Merritt's avatar
Loren Merritt committed
185
static inline void bs_align_1( bs_t *s )
Laurent Aimar's avatar
Laurent Aimar committed
186
{
187
    bs_write( s, s->i_left&7, (1 << (s->i_left&7)) - 1 );
Fiona Glaser's avatar
Fiona Glaser committed
188
    bs_flush( s );
Laurent Aimar's avatar
Laurent Aimar committed
189
}
Fiona Glaser's avatar
Fiona Glaser committed
190 191 192 193 194
static inline void bs_align_10( bs_t *s )
{
    if( s->i_left&7 )
        bs_write( s, s->i_left&7, 1 << ( (s->i_left&7) - 1 ) );
}
Laurent Aimar's avatar
Laurent Aimar committed
195 196 197

/* golomb functions */

Loren Merritt's avatar
Loren Merritt committed
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
static const uint8_t x264_ue_size_tab[256] =
{
     1, 1, 3, 3, 5, 5, 5, 5, 7, 7, 7, 7, 7, 7, 7, 7,
     9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9,
    11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,
    11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,11,
    13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,
    13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,
    13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,
    13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,13,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
    15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,15,
Fiona Glaser's avatar
Fiona Glaser committed
216 217 218
};

static inline void bs_write_ue_big( bs_t *s, unsigned int val )
Laurent Aimar's avatar
Laurent Aimar committed
219
{
Loren Merritt's avatar
Loren Merritt committed
220 221 222
    int size = 0;
    int tmp = ++val;
    if( tmp >= 0x10000 )
Laurent Aimar's avatar
Laurent Aimar committed
223
    {
224
        size = 32;
Loren Merritt's avatar
Loren Merritt committed
225 226 227 228
        tmp >>= 16;
    }
    if( tmp >= 0x100 )
    {
229
        size += 16;
Loren Merritt's avatar
Loren Merritt committed
230
        tmp >>= 8;
Laurent Aimar's avatar
Laurent Aimar committed
231
    }
Loren Merritt's avatar
Loren Merritt committed
232
    size += x264_ue_size_tab[tmp];
233 234
    bs_write( s, size>>1, 0 );
    bs_write( s, (size>>1)+1, val );
Laurent Aimar's avatar
Laurent Aimar committed
235 236
}

Fiona Glaser's avatar
Fiona Glaser committed
237 238 239
/* Only works on values under 255. */
static inline void bs_write_ue( bs_t *s, int val )
{
Loren Merritt's avatar
Loren Merritt committed
240
    bs_write( s, x264_ue_size_tab[val+1], val+1 );
Fiona Glaser's avatar
Fiona Glaser committed
241 242
}

Laurent Aimar's avatar
Laurent Aimar committed
243 244
static inline void bs_write_se( bs_t *s, int val )
{
Loren Merritt's avatar
Loren Merritt committed
245
    int size = 0;
Fiona Glaser's avatar
Fiona Glaser committed
246 247 248 249 250 251
    /* Faster than (val <= 0 ? -val*2+1 : val*2) */
    /* 4 instructions on x86, 3 on ARM */
    int tmp = 1 - val*2;
    if( tmp < 0 ) tmp = val*2;
    val = tmp;

Loren Merritt's avatar
Loren Merritt committed
252
    if( tmp >= 0x100 )
Fiona Glaser's avatar
Fiona Glaser committed
253
    {
Loren Merritt's avatar
Loren Merritt committed
254 255
        size = 16;
        tmp >>= 8;
Fiona Glaser's avatar
Fiona Glaser committed
256
    }
Loren Merritt's avatar
Loren Merritt committed
257 258
    size += x264_ue_size_tab[tmp];
    bs_write( s, size, val );
Laurent Aimar's avatar
Laurent Aimar committed
259 260 261 262 263
}

static inline void bs_write_te( bs_t *s, int x, int val )
{
    if( x == 1 )
Fiona Glaser's avatar
Fiona Glaser committed
264
        bs_write1( s, 1^val );
Fiona Glaser's avatar
Fiona Glaser committed
265
    else //if( x > 1 )
Laurent Aimar's avatar
Laurent Aimar committed
266 267 268 269 270
        bs_write_ue( s, val );
}

static inline void bs_rbsp_trailing( bs_t *s )
{
Loren Merritt's avatar
Loren Merritt committed
271
    bs_write1( s, 1 );
272
    bs_write( s, s->i_left&7, 0  );
Laurent Aimar's avatar
Laurent Aimar committed
273 274
}

275
static ALWAYS_INLINE int bs_size_ue( unsigned int val )
Laurent Aimar's avatar
Laurent Aimar committed
276
{
Loren Merritt's avatar
Loren Merritt committed
277
    return x264_ue_size_tab[val+1];
Fiona Glaser's avatar
Fiona Glaser committed
278
}
Laurent Aimar's avatar
Laurent Aimar committed
279

280
static ALWAYS_INLINE int bs_size_ue_big( unsigned int val )
Fiona Glaser's avatar
Fiona Glaser committed
281
{
Laurent Aimar's avatar
Laurent Aimar committed
282
    if( val < 255 )
Loren Merritt's avatar
Loren Merritt committed
283
        return x264_ue_size_tab[val+1];
Laurent Aimar's avatar
Laurent Aimar committed
284
    else
Loren Merritt's avatar
Loren Merritt committed
285
        return x264_ue_size_tab[(val+1)>>8] + 16;
Laurent Aimar's avatar
Laurent Aimar committed
286 287
}

288
static ALWAYS_INLINE int bs_size_se( int val )
Laurent Aimar's avatar
Laurent Aimar committed
289
{
Fiona Glaser's avatar
Fiona Glaser committed
290 291 292 293 294 295
    int tmp = 1 - val*2;
    if( tmp < 0 ) tmp = val*2;
    if( tmp < 256 )
        return x264_ue_size_tab[tmp];
    else
        return x264_ue_size_tab[tmp>>8]+16;
Laurent Aimar's avatar
Laurent Aimar committed
296 297
}

298
static ALWAYS_INLINE int bs_size_te( int x, int val )
Laurent Aimar's avatar
Laurent Aimar committed
299 300 301
{
    if( x == 1 )
        return 1;
Fiona Glaser's avatar
Fiona Glaser committed
302
    else //if( x > 1 )
Loren Merritt's avatar
Loren Merritt committed
303
        return x264_ue_size_tab[val+1];
Laurent Aimar's avatar
Laurent Aimar committed
304 305 306
}

#endif