vlc_block.h 9.83 KB
Newer Older
1
/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
2
 * vlc_block.h: Data blocks management functions
3
 *****************************************************************************
4
 * Copyright (C) 2003 the VideoLAN team
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * 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
 * (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
Antoine Cellerier's avatar
Antoine Cellerier committed
21
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 23
 *****************************************************************************/

24 25 26 27
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

Gildas Bazin's avatar
 
Gildas Bazin committed
28 29
#ifndef _VLC_BLOCK_H
#define _VLC_BLOCK_H 1
30

31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
/****************************************************************************
 * block:
 ****************************************************************************
 * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
 * - i_flags may not always be set (ie could be 0, even for a key frame
 *      it depends where you receive the buffer (before/after a packetizer
 *      and the demux/packetizer implementations.
 * - i_dts/i_pts could be 0, it means no pts
 * - i_length: length in microseond of the packet, can be null except in the
 *      sout where it is mandatory.
 * - i_rate 0 or a valid input rate, look at vlc_input.h
 *
 * - i_buffer number of valid data pointed by p_buffer
 *      you can freely decrease it but never increase it yourself
 *      (use block_Realloc)
 * - p_buffer: pointer over datas. You should never overwrite it, you can
 *   only incremment it to skip datas, in others cases use block_Realloc
 *   (don't duplicate yourself in a bigger buffer, block_Realloc is
 *   optimised for prehader/postdatas increase)
 ****************************************************************************/
51 52
typedef struct block_sys_t block_sys_t;

53
/** The content doesn't follow the last block, or is probably broken */
54
#define BLOCK_FLAG_DISCONTINUITY 0x0001
55
/** Intra frame */
56
#define BLOCK_FLAG_TYPE_I        0x0002
57
/** Inter frame with backward reference only */
58
#define BLOCK_FLAG_TYPE_P        0x0004
59
/** Inter frame with backward and forward reference */
60
#define BLOCK_FLAG_TYPE_B        0x0008
61
/** For inter frame when you don't know the real type */
62
#define BLOCK_FLAG_TYPE_PB       0x0010
Antoine Cellerier's avatar
Antoine Cellerier committed
63
/** Warn that this block is a header one */
64
#define BLOCK_FLAG_HEADER        0x0020
65 66
/** This is the last block of the frame */
#define BLOCK_FLAG_END_OF_FRAME  0x0040
67
/** This is not a key frame for bitrate shaping */
68
#define BLOCK_FLAG_NO_KEYFRAME   0x0080
69 70 71 72
/** This block contains a clock reference */
#define BLOCK_FLAG_CLOCK         0x0200
/** This block is scrambled */
#define BLOCK_FLAG_SCRAMBLED     0x0400
Laurent Aimar's avatar
Laurent Aimar committed
73 74 75 76
/** This block has to be decoded but not be displayed */
#define BLOCK_FLAG_PREROLL       0x0800
/** This block is corrupted and/or there is data loss  */
#define BLOCK_FLAG_CORRUPTED     0x1000
77 78 79

#define BLOCK_FLAG_PRIVATE_MASK  0xffff0000
#define BLOCK_FLAG_PRIVATE_SHIFT 16
80

81 82 83
struct block_t
{
    block_t     *p_next;
84
    block_t     *p_prev;
85

86 87
    uint32_t    i_flags;

88 89
    mtime_t     i_pts;
    mtime_t     i_dts;
Gildas Bazin's avatar
 
Gildas Bazin committed
90
    mtime_t     i_length;
91

92
    int         i_samples; /* Used for audio */
Gildas Bazin's avatar
 
Gildas Bazin committed
93
    int         i_rate;
Gildas Bazin's avatar
 
Gildas Bazin committed
94

95
    size_t      i_buffer;
96 97
    uint8_t     *p_buffer;

98 99 100
    /* This way the block_Release can be overloaded
     * Don't mess with it now, if you need it the ask on ML
     */
101 102 103
    void        (*pf_release)   ( block_t * );
};

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
/****************************************************************************
 * Blocks functions:
 ****************************************************************************
 * - block_New : create a new block with the requested size ( >= 0 ), return
 *      NULL for failure.
 * - block_Release : release a block allocated with block_New.
 * - block_Realloc : realloc a block,
 *      i_pre: how many bytes to insert before body if > 0, else how many
 *      bytes of body to skip (the latter can be done without using
 *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
 *      i_body (>= 0): the final size of the body (decreasing it can directly
 *      be done with i_buffer = i_body).
 *      with preheader and or body (increase
 *      and decrease are supported). Use it as it is optimised.
 * - block_Duplicate : create a copy of a block.
 ****************************************************************************/
120
#define block_New( a, b ) __block_New( NULL, b )
121 122
VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, size_t ) );
VLC_EXPORT( block_t *, block_Realloc,       ( block_t *, ssize_t i_pre, size_t i_body ) );
123 124

static inline block_t *block_Duplicate( block_t *p_block )
125
{
126
    block_t *p_dup = block_New( NULL, p_block->i_buffer );
127 128
    if( p_dup == NULL )
        return NULL;
129

130 131 132 133 134 135
    p_dup->i_dts     = p_block->i_dts;
    p_dup->i_pts     = p_block->i_pts;
    p_dup->i_flags   = p_block->i_flags;
    p_dup->i_length  = p_block->i_length;
    p_dup->i_rate    = p_block->i_rate;
    p_dup->i_samples = p_block->i_samples;
136
    memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
137

138 139
    return p_dup;
}
140 141 142 143
static inline void block_Release( block_t *p_block )
{
    p_block->pf_release( p_block );
}
144 145 146 147 148 149 150 151 152 153 154 155 156 157

/****************************************************************************
 * Chains of blocks functions helper
 ****************************************************************************
 * - block_ChainAppend : append a block the the last block of a chain. Try to
 *      avoid using with a lot of data as it's really slow, prefer
 *      block_ChainLastAppend
 * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
 *      and update it.
 * - block_ChainRelease : release a chain of block
 * - block_ChainExtract : extract data from a chain, return real bytes counts
 * - block_ChainGather : gather a chain, free it and return a block.
 ****************************************************************************/
static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
158
{
159 160 161 162 163 164 165 166 167 168 169
    if( *pp_list == NULL )
    {
        *pp_list = p_block;
    }
    else
    {
        block_t *p = *pp_list;

        while( p->p_next ) p = p->p_next;
        p->p_next = p_block;
    }
170
}
171 172

static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block  )
173
{
174 175 176 177 178 179
    block_t *p_last = p_block;

    **ppp_last = p_block;

    while( p_last->p_next ) p_last = p_last->p_next;
    *ppp_last = &p_last->p_next;
180
}
181 182

static inline void block_ChainRelease( block_t *p_block )
183
{
184 185 186 187 188 189 190
    while( p_block )
    {
        block_t *p_next = p_block->p_next;
        block_Release( p_block );
        p_block = p_next;
    }
}
191 192

static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
193
{
194
    size_t  i_total = 0;
195 196
    uint8_t *p = (uint8_t*)p_data;

197
    while( p_list && i_max )
198
    {
199 200 201 202 203 204 205
        size_t i_copy = __MIN( i_max, p_list->i_buffer );
        memcpy( p, p_list->p_buffer, i_copy );
        i_max   -= i_copy;
        i_total += i_copy;
        p       += i_copy;

        p_list = p_list->p_next;
206 207
    }
    return i_total;
208
}
209 210 211

static inline block_t *block_ChainGather( block_t *p_list )
{
212
    size_t  i_total = 0;
213
    mtime_t i_length = 0;
214 215 216 217 218 219
    block_t *b, *g;

    if( p_list->p_next == NULL )
        return p_list;  /* Already gathered */

    for( b = p_list; b != NULL; b = b->p_next )
220
    {
221
        i_total += b->i_buffer;
222 223
        i_length += b->i_length;
    }
224

225
    g = block_New( NULL, i_total );
226 227 228 229 230
    block_ChainExtract( p_list, g->p_buffer, g->i_buffer );

    g->i_flags = p_list->i_flags;
    g->i_pts   = p_list->i_pts;
    g->i_dts   = p_list->i_dts;
231
    g->i_length = i_length;
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247

    /* free p_list */
    block_ChainRelease( p_list );
    return g;
}


/****************************************************************************
 * Fifos of blocks.
 ****************************************************************************
 * - block_FifoNew : create and init a new fifo
 * - block_FifoRelease : destroy a fifo and free all blocks in it.
 * - block_FifoEmpty : free all blocks in a fifo
 * - block_FifoPut : put a block
 * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
 * - block_FifoShow : show the first packet of the fifo (and wait if
248
 *      needed), be carefull, you can use it ONLY if you are sure to be the
249
 *      only one getting data from the fifo.
250 251
 * - block_FifoCount : how many packets are waiting in the fifo
 * - block_FifoSize : how many cumulated bytes are waiting in the fifo
252 253
 * - block_FifoWake : wake ups a thread with block_FifoGet() = NULL
 *   (this is used to wakeup a thread when there is no data to queue)
254 255
 ****************************************************************************/

256 257 258 259
#define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
260
VLC_EXPORT( size_t,         block_FifoPut,      ( block_fifo_t *, block_t * ) );
261
VLC_EXPORT( void,           block_FifoWake,     ( block_fifo_t * ) );
262 263
VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
264 265
VLC_EXPORT( size_t,         block_FifoSize,     ( const block_fifo_t *p_fifo ) );
VLC_EXPORT( size_t,         block_FifoCount,    ( const block_fifo_t *p_fifo ) );
266

Gildas Bazin's avatar
 
Gildas Bazin committed
267
#endif /* VLC_BLOCK_H */