vlc_block.h 11.4 KB
Newer Older
1
/*****************************************************************************
Gildas Bazin's avatar
 
Gildas Bazin committed
2
 * vlc_block.h: Data blocks management functions
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2003 VLC authors and VideoLAN
5
 * $Id$
6 7 8
 *
 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
 *
Jean-Baptiste Kempf's avatar
LGPL  
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
LGPL  
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
LGPL  
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_H
#define VLC_BLOCK_H 1
26

27 28 29 30 31 32
/**
 * \file
 * This file implements functions and structures to handle blocks of data in vlc
 *
 */

33 34
#include <sys/types.h>  /* for ssize_t */

35 36 37 38 39 40
/****************************************************************************
 * block:
 ****************************************************************************
 * - 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.
41
 * - i_dts/i_pts could be VLC_TS_INVALID, it means no pts/dts
42 43 44 45 46 47 48 49 50
 * - i_length: length in microseond of the packet, can be null except in the
 *      sout where it is mandatory.
 *
 * - 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
51
 *   optimised for preheader/postdatas increase)
52
 ****************************************************************************/
53

54
/** The content doesn't follow the last block, or is probably broken */
55
#define BLOCK_FLAG_DISCONTINUITY 0x0001
56
/** Intra frame */
57
#define BLOCK_FLAG_TYPE_I        0x0002
58
/** Inter frame with backward reference only */
59
#define BLOCK_FLAG_TYPE_P        0x0004
60
/** Inter frame with backward and forward reference */
61
#define BLOCK_FLAG_TYPE_B        0x0008
62
/** For inter frame when you don't know the real type */
63
#define BLOCK_FLAG_TYPE_PB       0x0010
Antoine Cellerier's avatar
Antoine Cellerier committed
64
/** Warn that this block is a header one */
65
#define BLOCK_FLAG_HEADER        0x0020
66 67
/** This is the last block of the frame */
#define BLOCK_FLAG_END_OF_FRAME  0x0040
68
/** This is not a key frame for bitrate shaping */
69
#define BLOCK_FLAG_NO_KEYFRAME   0x0080
70 71
/** This block contains the last part of a sequence  */
#define BLOCK_FLAG_END_OF_SEQUENCE 0x0100
72 73 74 75
/** 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
76 77 78 79
/** 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
80 81 82 83 84 85 86 87
/** This block contains an interlaced picture with top field first */
#define BLOCK_FLAG_TOP_FIELD_FIRST 0x2000
/** This block contains an interlaced picture with bottom field first */
#define BLOCK_FLAG_BOTTOM_FIELD_FIRST 0x4000

/** This block contains an interlaced picture */
#define BLOCK_FLAG_INTERLACED_MASK \
    (BLOCK_FLAG_TOP_FIELD_FIRST|BLOCK_FLAG_BOTTOM_FIELD_FIRST)
88

89 90 91
#define BLOCK_FLAG_TYPE_MASK \
    (BLOCK_FLAG_TYPE_I|BLOCK_FLAG_TYPE_P|BLOCK_FLAG_TYPE_B|BLOCK_FLAG_TYPE_PB)

92 93 94 95 96 97 98
/* These are for input core private usage only */
#define BLOCK_FLAG_CORE_PRIVATE_MASK  0x00ff0000
#define BLOCK_FLAG_CORE_PRIVATE_SHIFT 16

/* These are for module private usage only */
#define BLOCK_FLAG_PRIVATE_MASK  0xff000000
#define BLOCK_FLAG_PRIVATE_SHIFT 24
99

100 101
typedef void (*block_free_t) (block_t *);

102 103
struct block_t
{
104
    block_t    *p_next;
105

106 107 108 109
    uint8_t    *p_buffer; /**< Payload start */
    size_t      i_buffer; /**< Payload length */
    uint8_t    *p_start; /**< Buffer start */
    size_t      i_size; /**< Buffer total size */
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
110

111
    uint32_t    i_flags;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
112
    unsigned    i_nb_samples; /* Used for audio */
113

114 115
    mtime_t     i_pts;
    mtime_t     i_dts;
Gildas Bazin's avatar
 
Gildas Bazin committed
116
    mtime_t     i_length;
117

118 119
    /* Rudimentary support for overloading block (de)allocation. */
    block_free_t pf_release;
120 121
};

122 123 124
/****************************************************************************
 * Blocks functions:
 ****************************************************************************
125
 * - block_Alloc : create a new block with the requested size ( >= 0 ), return
126
 *      NULL for failure.
127
 * - block_Release : release a block allocated with block_Alloc.
128 129 130 131 132 133 134 135 136 137
 * - 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.
 ****************************************************************************/
138
VLC_API void block_Init( block_t *, void *, size_t );
139 140
VLC_API block_t *block_Alloc( size_t ) VLC_USED VLC_MALLOC;
VLC_API block_t *block_Realloc( block_t *, ssize_t i_pre, size_t i_body ) VLC_USED;
141

142 143 144 145 146 147 148 149 150
static inline void block_CopyProperties( block_t *dst, block_t *src )
{
    dst->i_flags   = src->i_flags;
    dst->i_nb_samples = src->i_nb_samples;
    dst->i_dts     = src->i_dts;
    dst->i_pts     = src->i_pts;
    dst->i_length  = src->i_length;
}

151
VLC_USED
152
static inline block_t *block_Duplicate( block_t *p_block )
153
{
154
    block_t *p_dup = block_Alloc( p_block->i_buffer );
155 156
    if( p_dup == NULL )
        return NULL;
157

158
    block_CopyProperties( p_dup, p_block );
159
    memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
160

161 162
    return p_dup;
}
163

164 165 166 167
static inline void block_Release( block_t *p_block )
{
    p_block->pf_release( p_block );
}
168

169 170
VLC_API block_t *block_heap_Alloc(void *, size_t) VLC_USED VLC_MALLOC;
VLC_API block_t *block_mmap_Alloc(void *addr, size_t length) VLC_USED VLC_MALLOC;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
171
VLC_API block_t * block_shm_Alloc(void *addr, size_t length) VLC_USED VLC_MALLOC;
172
VLC_API block_t *block_File(int fd) VLC_USED VLC_MALLOC;
173
VLC_API block_t *block_FilePath(const char *) VLC_USED VLC_MALLOC;
174

175 176 177 178 179 180
static inline void block_Cleanup (void *block)
{
    block_Release ((block_t *)block);
}
#define block_cleanup_push( block ) vlc_cleanup_push (block_Cleanup, block)

181 182 183
/****************************************************************************
 * Chains of blocks functions helper
 ****************************************************************************
184
 * - block_ChainAppend : append a block to the last block of a chain. Try to
185
 *      avoid using with a lot of data as it's really slow, prefer
186
 *      block_ChainLastAppend, p_block can be NULL
187 188 189 190
 * - 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
191
 * - block_ChainGather : gather a chain, free it and return one block.
192 193
 ****************************************************************************/
static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
194
{
195 196 197 198 199 200 201 202 203 204 205
    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;
    }
206
}
207

208
static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block )
209
{
210 211 212 213 214 215
    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;
216
}
217 218

static inline void block_ChainRelease( block_t *p_block )
219
{
220 221 222 223 224 225 226
    while( p_block )
    {
        block_t *p_next = p_block->p_next;
        block_Release( p_block );
        p_block = p_next;
    }
}
227 228

static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
229
{
230
    size_t  i_total = 0;
231 232
    uint8_t *p = (uint8_t*)p_data;

233
    while( p_list && i_max )
234
    {
235 236 237 238 239 240 241
        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;
242 243
    }
    return i_total;
244
}
245

246 247 248 249
static inline void block_ChainProperties( block_t *p_list, int *pi_count, size_t *pi_size, mtime_t *pi_length )
{
    size_t i_size = 0;
    mtime_t i_length = 0;
250
    int i_count = 0;
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268

    while( p_list )
    {
        i_size += p_list->i_buffer;
        i_length += p_list->i_length;
        i_count++;

        p_list = p_list->p_next;
    }

    if( pi_size )
        *pi_size = i_size;
    if( pi_length )
        *pi_length = i_length;
    if( pi_count )
        *pi_count = i_count;
}

269 270
static inline block_t *block_ChainGather( block_t *p_list )
{
271
    size_t  i_total = 0;
272
    mtime_t i_length = 0;
273
    block_t *g;
274 275 276 277

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

278
    block_ChainProperties( p_list, NULL, &i_total, &i_length );
279

280
    g = block_Alloc( i_total );
281 282 283 284 285
    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;
286
    g->i_length = i_length;
287 288 289 290 291 292 293 294 295 296 297

    /* 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.
Nick Briggs's avatar
Nick Briggs committed
298
 * - block_FifoPace : wait for a fifo to drain to a specified number of packets or total data size
299 300 301 302
 * - 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
303
 *      needed), be carefull, you can use it ONLY if you are sure to be the
304
 *      only one getting data from the fifo.
305
 * - block_FifoCount : how many packets are waiting in the fifo
306 307
 *
 * block_FifoGet and block_FifoShow are cancellation points.
308 309
 ****************************************************************************/

310
VLC_API block_fifo_t *block_FifoNew( void ) VLC_USED VLC_MALLOC;
311 312 313 314
VLC_API void block_FifoRelease( block_fifo_t * );
VLC_API void block_FifoPace( block_fifo_t *fifo, size_t max_depth, size_t max_size );
VLC_API void block_FifoEmpty( block_fifo_t * );
VLC_API size_t block_FifoPut( block_fifo_t *, block_t * );
315
void block_FifoWake( block_fifo_t * );
316
VLC_API block_t * block_FifoGet( block_fifo_t * ) VLC_USED;
317
VLC_API block_t * block_FifoShow( block_fifo_t * );
318 319
size_t block_FifoSize( const block_fifo_t *p_fifo ) VLC_USED;
VLC_API size_t block_FifoCount( const block_fifo_t *p_fifo ) VLC_USED;
320

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