vlc_block_helper.h 14.5 KB
Newer Older
1 2 3
/*****************************************************************************
 * vlc_block_helper.h: Helper functions for data blocks management.
 *****************************************************************************
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2003 VLC authors and VideoLAN
Sam Hocevar's avatar
Sam Hocevar committed
5
 * $Id$
6 7 8
 *
 * Authors: Gildas Bazin <gbazin@netcourrier.com>
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
9 10 11
 * 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
12 13 14 15
 * (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
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
Jean-Baptiste Kempf committed
19 20 21
 * 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.
22 23
 *****************************************************************************/

24 25
#ifndef VLC_BLOCK_HELPER_H
#define VLC_BLOCK_HELPER_H 1
26

27 28
#include <vlc_block.h>

29 30
typedef struct block_bytestream_t
{
31
    block_t *p_chain;  /**< byte stream head block */
32
    block_t **pp_last; /**< tail ppointer for appends */
33 34
    block_t *p_block;  /**< byte stream read pointer block */
    size_t   i_offset; /**< byte stream read pointer offset within block */
35 36 37 38 39
} block_bytestream_t;

/*****************************************************************************
 * block_bytestream_t management
 *****************************************************************************/
40
static inline void block_BytestreamInit( block_bytestream_t *p_bytestream )
41
{
42
    p_bytestream->p_chain = p_bytestream->p_block = NULL;
43
    p_bytestream->pp_last = &p_bytestream->p_chain;
44
    p_bytestream->i_offset = 0;
45 46
}

47 48
static inline void block_BytestreamRelease( block_bytestream_t *p_bytestream )
{
49
    block_ChainRelease( p_bytestream->p_chain );
50 51
}

52 53 54 55 56 57
/**
 * It flush all data (read and unread) from a block_bytestream_t.
 */
static inline void block_BytestreamEmpty( block_bytestream_t *p_bytestream )
{
    block_BytestreamRelease( p_bytestream );
58
    block_BytestreamInit( p_bytestream );
59 60 61 62 63
}

/**
 * It flushes all already read data from a block_bytestream_t.
 */
64
static inline void block_BytestreamFlush( block_bytestream_t *p_bytestream )
65
{
66 67 68
    block_t *block = p_bytestream->p_chain;

    while( block != p_bytestream->p_block )
69
    {
70 71 72 73
        block_t *p_next = block->p_next;

        block_Release( block );
        block = p_next;
74
    }
75 76

    while( block != NULL && block->i_buffer == p_bytestream->i_offset )
77
    {
78 79 80 81
        block_t *p_next = block->p_next;

        block_Release( block );
        block = p_next;
82 83
        p_bytestream->i_offset = 0;
    }
84 85

    p_bytestream->p_chain = p_bytestream->p_block = block;
86 87
    if( p_bytestream->p_chain == NULL )
        p_bytestream->pp_last = &p_bytestream->p_chain;
88 89 90 91 92
}

static inline void block_BytestreamPush( block_bytestream_t *p_bytestream,
                                         block_t *p_block )
{
93
    block_ChainLastAppend( &p_bytestream->pp_last, p_block );
94 95 96
    if( !p_bytestream->p_block ) p_bytestream->p_block = p_block;
}

97
VLC_USED
98 99 100 101 102 103 104
static inline block_t *block_BytestreamPop( block_bytestream_t *p_bytestream )
{
    block_t *p_block;

    block_BytestreamFlush( p_bytestream );

    p_block = p_bytestream->p_block;
105
    if( unlikely( p_block == NULL ) )
106 107 108 109 110 111 112 113 114
    {
        return NULL;
    }
    else if( !p_block->p_next )
    {
        p_block->p_buffer += p_bytestream->i_offset;
        p_block->i_buffer -= p_bytestream->i_offset;
        p_bytestream->i_offset = 0;
        p_bytestream->p_chain = p_bytestream->p_block = NULL;
115
        p_bytestream->pp_last = &p_bytestream->p_chain;
116 117
        return p_block;
    }
118

119 120 121
    while( p_block->p_next && p_block->p_next->p_next )
        p_block = p_block->p_next;

122 123 124
    block_t *p_block_old = p_block;
    p_block = p_block->p_next;
    p_block_old->p_next = NULL;
125
    p_bytestream->pp_last = &p_block_old->p_next;
126 127

    return p_block;
128 129 130 131 132
}

static inline int block_SkipByte( block_bytestream_t *p_bytestream )
{
    /* Most common case first */
133
    if( likely( p_bytestream->p_block->i_buffer - p_bytestream->i_offset ) )
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    {
        p_bytestream->i_offset++;
        return VLC_SUCCESS;
    }
    else
    {
        block_t *p_block;

        /* Less common case which is also slower */
        for( p_block = p_bytestream->p_block->p_next;
             p_block != NULL; p_block = p_block->p_next )
        {
            if( p_block->i_buffer )
            {
                p_bytestream->i_offset = 1;
                p_bytestream->p_block = p_block;
                return VLC_SUCCESS;
            }
        }
    }

    /* Not enough data, bail out */
    return VLC_EGENERIC;
}

static inline int block_PeekByte( block_bytestream_t *p_bytestream,
                                  uint8_t *p_data )
{
    /* Most common case first */
163
    if( likely( p_bytestream->p_block->i_buffer - p_bytestream->i_offset ) )
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
    {
        *p_data = p_bytestream->p_block->p_buffer[p_bytestream->i_offset];
        return VLC_SUCCESS;
    }
    else
    {
        block_t *p_block;

        /* Less common case which is also slower */
        for( p_block = p_bytestream->p_block->p_next;
             p_block != NULL; p_block = p_block->p_next )
        {
            if( p_block->i_buffer )
            {
                *p_data = p_block->p_buffer[0];
                return VLC_SUCCESS;
            }
        }
    }

    /* Not enough data, bail out */
    return VLC_EGENERIC;
}

static inline int block_GetByte( block_bytestream_t *p_bytestream,
                                 uint8_t *p_data )
{
    /* Most common case first */
192
    if( likely( p_bytestream->p_block->i_buffer - p_bytestream->i_offset ) )
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    {
        *p_data = p_bytestream->p_block->p_buffer[p_bytestream->i_offset];
        p_bytestream->i_offset++;
        return VLC_SUCCESS;
    }
    else
    {
        block_t *p_block;

        /* Less common case which is also slower */
        for( p_block = p_bytestream->p_block->p_next;
             p_block != NULL; p_block = p_block->p_next )
        {
            if( p_block->i_buffer )
            {
                *p_data = p_block->p_buffer[0];
                p_bytestream->i_offset = 1;
                p_bytestream->p_block = p_block;
                return VLC_SUCCESS;
            }
        }
    }

    /* Not enough data, bail out */
    return VLC_EGENERIC;
}

220
static inline int block_WaitBytes( block_bytestream_t *p_bytestream,
221
                                   size_t i_data )
222 223
{
    block_t *p_block;
224
    size_t i_offset, i_copy, i_size;
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246

    /* Check we have that much data */
    i_offset = p_bytestream->i_offset;
    i_size = i_data;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;
        i_offset = 0;

        if( !i_size ) break;
    }

    if( i_size )
    {
        /* Not enough data, bail out */
        return VLC_EGENERIC;
    }
    return VLC_SUCCESS;
}

247
static inline int block_SkipBytes( block_bytestream_t *p_bytestream,
248
                                   size_t i_data )
249 250
{
    block_t *p_block;
251
    size_t i_offset, i_copy;
252 253 254 255 256 257 258 259 260 261 262

    /* Check we have that much data */
    i_offset = p_bytestream->i_offset;
    i_copy = 0;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_data, p_block->i_buffer - i_offset );
        i_data -= i_copy;

        if( !i_data ) break;
263 264

        i_offset = 0;
265 266 267 268 269 270 271 272 273
    }

    if( i_data )
    {
        /* Not enough data, bail out */
        return VLC_EGENERIC;
    }

    p_bytestream->p_block = p_block;
274
    p_bytestream->i_offset = i_offset + i_copy;
275 276 277 278
    return VLC_SUCCESS;
}

static inline int block_PeekBytes( block_bytestream_t *p_bytestream,
279
                                   uint8_t *p_data, size_t i_data )
280 281
{
    block_t *p_block;
282
    size_t i_offset, i_copy, i_size;
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

    /* Check we have that much data */
    i_offset = p_bytestream->i_offset;
    i_size = i_data;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;
        i_offset = 0;

        if( !i_size ) break;
    }

    if( i_size )
    {
        /* Not enough data, bail out */
        return VLC_EGENERIC;
    }

    /* Copy the data */
    i_offset = p_bytestream->i_offset;
    i_size = i_data;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;

        if( i_copy )
        {
            memcpy( p_data, p_block->p_buffer + i_offset, i_copy );
            p_data += i_copy;
        }

        i_offset = 0;

        if( !i_size ) break;
    }

    return VLC_SUCCESS;
}

static inline int block_GetBytes( block_bytestream_t *p_bytestream,
327
                                  uint8_t *p_data, size_t i_data )
328 329
{
    block_t *p_block;
330
    size_t i_offset, i_copy, i_size;
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

    /* Check we have that much data */
    i_offset = p_bytestream->i_offset;
    i_size = i_data;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;
        i_offset = 0;

        if( !i_size ) break;
    }

    if( i_size )
    {
        /* Not enough data, bail out */
        return VLC_EGENERIC;
    }

    /* Copy the data */
    i_offset = p_bytestream->i_offset;
    i_size = i_data;
    i_copy = 0;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;

        if( i_copy )
        {
            memcpy( p_data, p_block->p_buffer + i_offset, i_copy );
            p_data += i_copy;
        }

        if( !i_size ) break;
368 369

        i_offset = 0;
370 371 372
    }

    p_bytestream->p_block = p_block;
373
    p_bytestream->i_offset = i_offset + i_copy;
374 375 376 377 378

    return VLC_SUCCESS;
}

static inline int block_PeekOffsetBytes( block_bytestream_t *p_bytestream,
379
    size_t i_peek_offset, uint8_t *p_data, size_t i_data )
380 381
{
    block_t *p_block;
382
    size_t i_offset, i_copy, i_size;
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413

    /* Check we have that much data */
    i_offset = p_bytestream->i_offset;
    i_size = i_data + i_peek_offset;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;
        i_offset = 0;

        if( !i_size ) break;
    }

    if( i_size )
    {
        /* Not enough data, bail out */
        return VLC_EGENERIC;
    }

    /* Find the right place */
    i_offset = p_bytestream->i_offset;
    i_size = i_peek_offset;
    i_copy = 0;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;

        if( !i_size ) break;
414 415

        i_offset = 0;
416 417 418
    }

    /* Copy the data */
419
    i_offset += i_copy;
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
    i_size = i_data;
    for( ; p_block != NULL; p_block = p_block->p_next )
    {
        i_copy = __MIN( i_size, p_block->i_buffer - i_offset );
        i_size -= i_copy;

        if( i_copy )
        {
            memcpy( p_data, p_block->p_buffer + i_offset, i_copy );
            p_data += i_copy;
        }

        i_offset = 0;

        if( !i_size ) break;
    }

    return VLC_SUCCESS;
}

440 441
typedef const uint8_t * (*block_startcode_helper_t)( const uint8_t *, const uint8_t * );

442
static inline int block_FindStartcodeFromOffset(
443
    block_bytestream_t *p_bytestream, size_t *pi_offset,
444 445
    const uint8_t *p_startcode, int i_startcode_length,
    block_startcode_helper_t p_startcode_helper )
446 447
{
    block_t *p_block, *p_block_backup = 0;
448 449
    int i_size = 0;
    size_t i_offset, i_offset_backup = 0;
450 451 452 453 454 455 456 457 458 459 460
    int i_caller_offset_backup = 0, i_match;

    /* Find the right place */
    i_size = *pi_offset + p_bytestream->i_offset;
    for( p_block = p_bytestream->p_block;
         p_block != NULL; p_block = p_block->p_next )
    {
        i_size -= p_block->i_buffer;
        if( i_size < 0 ) break;
    }

461
    if( unlikely( i_size >= 0 ) )
462 463 464 465 466 467
    {
        /* Not enough data, bail out */
        return VLC_EGENERIC;
    }

    /* Begin the search.
Sam Hocevar's avatar
Sam Hocevar committed
468
     * We first look for an occurrence of the 1st startcode byte and
469
     * if found, we do a more thorough check. */
470
    i_size += p_block->i_buffer;
471 472 473 474 475 476
    *pi_offset -= i_size;
    i_match = 0;
    for( ; p_block != NULL; p_block = p_block->p_next )
    {
        for( i_offset = i_size; i_offset < p_block->i_buffer; i_offset++ )
        {
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
            /* Use optimized helper when possible */
            if( p_startcode_helper && !i_match &&
               (p_block->i_buffer - i_offset) > ((size_t)i_startcode_length - 1) )
            {
                const uint8_t *p_res = p_startcode_helper( &p_block->p_buffer[i_offset],
                                                           &p_block->p_buffer[p_block->i_buffer] );
                if( p_res )
                {
                    *pi_offset += i_offset + (p_res - &p_block->p_buffer[i_offset]);
                    return VLC_SUCCESS;
                }
                /* Then parsing boundary with legacy code */
                i_offset = p_block->i_buffer - (i_startcode_length - 1);
            }

492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
            if( p_block->p_buffer[i_offset] == p_startcode[i_match] )
            {
                if( !i_match )
                {
                    p_block_backup = p_block;
                    i_offset_backup = i_offset;
                    i_caller_offset_backup = *pi_offset;
                }

                if( i_match + 1 == i_startcode_length )
                {
                    /* We have it */
                    *pi_offset += i_offset - i_match;
                    return VLC_SUCCESS;
                }

                i_match++;
            }
            else if ( i_match )
            {
                /* False positive */
                p_block = p_block_backup;
                i_offset = i_offset_backup;
                *pi_offset = i_caller_offset_backup;
                i_match = 0;
            }

        }
        i_size = 0;
        *pi_offset += i_offset;
    }

524
    *pi_offset -= i_match;
525 526 527
    return VLC_EGENERIC;
}

528
#endif /* VLC_BLOCK_HELPER_H */