git.sesse.net Git - vlc/blob - include/vlc_block.h

   1 /*****************************************************************************
   2  * vlc_block.h: Data blocks management functions
   3  *****************************************************************************
   4  * Copyright (C) 2003 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_BLOCK_H
  25 #define _VLC_BLOCK_H 1
  26
  27 /****************************************************************************
  28  * block:
  29  ****************************************************************************
  30  * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
  31  * - i_flags may not always be set (ie could be 0, even for a key frame
  32  *      it depends where you receive the buffer (before/after a packetizer
  33  *      and the demux/packetizer implementations.
  34  * - i_dts/i_pts could be 0, it means no pts
  35  * - i_length: length in microseond of the packet, can be null except in the
  36  *      sout where it is mandatory.
  37  * - i_rate 0 or a valid input rate, look at vlc_input.h
  38  *
  39  * - i_buffer number of valid data pointed by p_buffer
  40  *      you can freely decrease it but never increase it yourself
  41  *      (use block_Realloc)
  42  * - p_buffer: pointer over datas. You should never overwrite it, you can
  43  *   only incremment it to skip datas, in others cases use block_Realloc
  44  *   (don't duplicate yourself in a bigger buffer, block_Realloc is
  45  *   optimised for prehader/postdatas increase)
  46  ****************************************************************************/
  47 typedef struct block_sys_t block_sys_t;
  48
  49 /** The content doesn't follow the last block, or is probably broken */
  50 #define BLOCK_FLAG_DISCONTINUITY 0x0001
  51 /** Intra frame */
  52 #define BLOCK_FLAG_TYPE_I        0x0002
  53 /** Inter frame with backward reference only */
  54 #define BLOCK_FLAG_TYPE_P        0x0004
  55 /** Inter frame with backward and forward reference */
  56 #define BLOCK_FLAG_TYPE_B        0x0008
  57 /** For inter frame when you don't know the real type */
  58 #define BLOCK_FLAG_TYPE_PB       0x0010
  59 /** Warn that this block is a header one */
  60 #define BLOCK_FLAG_HEADER        0x0020
  61 /** This is the last block of the frame */
  62 #define BLOCK_FLAG_END_OF_FRAME  0x0040
  63 /** This is not a key frame for bitrate shaping */
  64 #define BLOCK_FLAG_NO_KEYFRAME   0x0080
  65 /** This block contains a clock reference */
  66 #define BLOCK_FLAG_CLOCK         0x0200
  67 /** This block is scrambled */
  68 #define BLOCK_FLAG_SCRAMBLED     0x0400
  69 /** This block has to be decoded but not be displayed */
  70 #define BLOCK_FLAG_PREROLL       0x0800
  71 /** This block is corrupted and/or there is data loss  */
  72 #define BLOCK_FLAG_CORRUPTED     0x1000
  73
  74 #define BLOCK_FLAG_PRIVATE_MASK  0xffff0000
  75 #define BLOCK_FLAG_PRIVATE_SHIFT 16
  76
  77 struct block_t
  78 {
  79     block_t     *p_next;
  80     block_t     *p_prev;
  81
  82     uint32_t    i_flags;
  83
  84     mtime_t     i_pts;
  85     mtime_t     i_dts;
  86     mtime_t     i_length;
  87
  88     int         i_samples; /* Used for audio */
  89     int         i_rate;
  90
  91     int         i_buffer;
  92     uint8_t     *p_buffer;
  93
  94     /* This way the block_Release can be overloaded
  95      * Don't mess with it now, if you need it the ask on ML
  96      */
  97     void        (*pf_release)   ( block_t * );
  98
  99     /* It's an object that should be valid as long as the block_t is valid */
 100     /* It should become a true block manager to reduce malloc/free */
 101     vlc_object_t    *p_manager;
 102
 103     /* Following fields are private, user should never touch it */
 104     /* XXX never touch that OK !!! the first that access that will
 105      * have cvs account removed ;) XXX */
 106     block_sys_t *p_sys;
 107 };
 108
 109 /****************************************************************************
 110  * Blocks functions:
 111  ****************************************************************************
 112  * - block_New : create a new block with the requested size ( >= 0 ), return
 113  *      NULL for failure.
 114  * - block_Release : release a block allocated with block_New.
 115  * - block_Realloc : realloc a block,
 116  *      i_pre: how many bytes to insert before body if > 0, else how many
 117  *      bytes of body to skip (the latter can be done without using
 118  *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
 119  *      i_body (>= 0): the final size of the body (decreasing it can directly
 120  *      be done with i_buffer = i_body).
 121  *      with preheader and or body (increase
 122  *      and decrease are supported). Use it as it is optimised.
 123  * - block_Duplicate : create a copy of a block.
 124  ****************************************************************************/
 125 #define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
 126 VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, int ) );
 127 VLC_EXPORT( block_t *, block_Realloc,       ( block_t *, int i_pre, int i_body ) );
 128
 129 static inline block_t *block_Duplicate( block_t *p_block )
 130 {
 131     block_t *p_dup = block_New( p_block->p_manager, p_block->i_buffer );
 132
 133     p_dup->i_dts     = p_block->i_dts;
 134     p_dup->i_pts     = p_block->i_pts;
 135     p_dup->i_flags   = p_block->i_flags;
 136     p_dup->i_length  = p_block->i_length;
 137     p_dup->i_rate    = p_block->i_rate;
 138     p_dup->i_samples = p_block->i_samples;
 139
 140     if( p_dup && p_block->i_buffer > 0 )
 141         memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
 142
 143     return p_dup;
 144 }
 145 static inline void block_Release( block_t *p_block )
 146 {
 147     p_block->pf_release( p_block );
 148 }
 149
 150 /****************************************************************************
 151  * Chains of blocks functions helper
 152  ****************************************************************************
 153  * - block_ChainAppend : append a block the the last block of a chain. Try to
 154  *      avoid using with a lot of data as it's really slow, prefer
 155  *      block_ChainLastAppend
 156  * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
 157  *      and update it.
 158  * - block_ChainRelease : release a chain of block
 159  * - block_ChainExtract : extract data from a chain, return real bytes counts
 160  * - block_ChainGather : gather a chain, free it and return a block.
 161  ****************************************************************************/
 162 static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
 163 {
 164     if( *pp_list == NULL )
 165     {
 166         *pp_list = p_block;
 167     }
 168     else
 169     {
 170         block_t *p = *pp_list;
 171
 172         while( p->p_next ) p = p->p_next;
 173         p->p_next = p_block;
 174     }
 175 }
 176
 177 static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block  )
 178 {
 179     block_t *p_last = p_block;
 180
 181     **ppp_last = p_block;
 182
 183     while( p_last->p_next ) p_last = p_last->p_next;
 184     *ppp_last = &p_last->p_next;
 185 }
 186
 187 static inline void block_ChainRelease( block_t *p_block )
 188 {
 189     while( p_block )
 190     {
 191         block_t *p_next = p_block->p_next;
 192         block_Release( p_block );
 193         p_block = p_next;
 194     }
 195 }
 196 static int block_ChainExtract( block_t *p_list, void *p_data, int i_max )
 197 {
 198     block_t *b;
 199     int     i_total = 0;
 200     uint8_t *p = (uint8_t*)p_data;
 201
 202     for( b = p_list; b != NULL; b = b->p_next )
 203     {
 204         int i_copy = __MIN( i_max, b->i_buffer );
 205         if( i_copy > 0 )
 206         {
 207             memcpy( p, b->p_buffer, i_copy );
 208             i_max   -= i_copy;
 209             i_total += i_copy;
 210             p       += i_copy;
 211
 212             if( i_max == 0 )
 213                 return i_total;
 214         }
 215     }
 216     return i_total;
 217 }
 218
 219 static inline block_t *block_ChainGather( block_t *p_list )
 220 {
 221     int     i_total = 0;
 222     mtime_t i_length = 0;
 223     block_t *b, *g;
 224
 225     if( p_list->p_next == NULL )
 226         return p_list;  /* Already gathered */
 227
 228     for( b = p_list; b != NULL; b = b->p_next )
 229     {
 230         i_total += b->i_buffer;
 231         i_length += b->i_length;
 232     }
 233
 234     g = block_New( p_list->p_manager, i_total );
 235     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
 236
 237     g->i_flags = p_list->i_flags;
 238     g->i_pts   = p_list->i_pts;
 239     g->i_dts   = p_list->i_dts;
 240     g->i_length = i_length;
 241
 242     /* free p_list */
 243     block_ChainRelease( p_list );
 244     return g;
 245 }
 246
 247
 248 /****************************************************************************
 249  * Fifos of blocks.
 250  ****************************************************************************
 251  * Avoid touching block_fifo_t unless you really know what you are doing.
 252  * ( Some race conditions has to be correctly handled, like in win32 ;)
 253  * - block_FifoNew : create and init a new fifo
 254  * - block_FifoRelease : destroy a fifo and free all blocks in it.
 255  * - block_FifoEmpty : free all blocks in a fifo
 256  * - block_FifoPut : put a block
 257  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
 258  * - block_FifoShow : show the first packet of the fifo (and wait if
 259  *      needed), be carefull, you can use it ONLY if you are sure to be the
 260  *      only one getting data from the fifo.
 261  ****************************************************************************/
 262 struct block_fifo_t
 263 {
 264     vlc_mutex_t         lock;                         /* fifo data lock */
 265     vlc_cond_t          wait;         /* fifo data conditional variable */
 266
 267     int                 i_depth;
 268     block_t             *p_first;
 269     block_t             **pp_last;
 270     int                 i_size;
 271 };
 272
 273
 274 #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
 275 VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
 276 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
 277 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
 278 VLC_EXPORT( int,            block_FifoPut,      ( block_fifo_t *, block_t * ) );
 279 VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
 280 VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
 281
 282 #endif /* VLC_BLOCK_H */