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  * \file
  29  * This file implements functions and structures to handle blocks of data in vlc
  30  *
  31  */
  32
  33 /****************************************************************************
  34  * block:
  35  ****************************************************************************
  36  * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
  37  * - i_flags may not always be set (ie could be 0, even for a key frame
  38  *      it depends where you receive the buffer (before/after a packetizer
  39  *      and the demux/packetizer implementations.
  40  * - i_dts/i_pts could be VLC_TS_INVALID, it means no pts/dts
  41  * - i_length: length in microseond of the packet, can be null except in the
  42  *      sout where it is mandatory.
  43  * - i_rate 0 or a valid input rate, look at vlc_input.h
  44  *
  45  * - i_buffer number of valid data pointed by p_buffer
  46  *      you can freely decrease it but never increase it yourself
  47  *      (use block_Realloc)
  48  * - p_buffer: pointer over datas. You should never overwrite it, you can
  49  *   only incremment it to skip datas, in others cases use block_Realloc
  50  *   (don't duplicate yourself in a bigger buffer, block_Realloc is
  51  *   optimised for prehader/postdatas increase)
  52  ****************************************************************************/
  53 typedef struct block_sys_t block_sys_t;
  54
  55 /** The content doesn't follow the last block, or is probably broken */
  56 #define BLOCK_FLAG_DISCONTINUITY 0x0001
  57 /** Intra frame */
  58 #define BLOCK_FLAG_TYPE_I        0x0002
  59 /** Inter frame with backward reference only */
  60 #define BLOCK_FLAG_TYPE_P        0x0004
  61 /** Inter frame with backward and forward reference */
  62 #define BLOCK_FLAG_TYPE_B        0x0008
  63 /** For inter frame when you don't know the real type */
  64 #define BLOCK_FLAG_TYPE_PB       0x0010
  65 /** Warn that this block is a header one */
  66 #define BLOCK_FLAG_HEADER        0x0020
  67 /** This is the last block of the frame */
  68 #define BLOCK_FLAG_END_OF_FRAME  0x0040
  69 /** This is not a key frame for bitrate shaping */
  70 #define BLOCK_FLAG_NO_KEYFRAME   0x0080
  71 /** This block contains the last part of a sequence  */
  72 #define BLOCK_FLAG_END_OF_SEQUENCE 0x0100
  73 /** This block contains a clock reference */
  74 #define BLOCK_FLAG_CLOCK         0x0200
  75 /** This block is scrambled */
  76 #define BLOCK_FLAG_SCRAMBLED     0x0400
  77 /** This block has to be decoded but not be displayed */
  78 #define BLOCK_FLAG_PREROLL       0x0800
  79 /** This block is corrupted and/or there is data loss  */
  80 #define BLOCK_FLAG_CORRUPTED     0x1000
  81 /** This block contains an interlaced picture with top field first */
  82 #define BLOCK_FLAG_TOP_FIELD_FIRST 0x2000
  83 /** This block contains an interlaced picture with bottom field first */
  84 #define BLOCK_FLAG_BOTTOM_FIELD_FIRST 0x4000
  85
  86 /** This block contains an interlaced picture */
  87 #define BLOCK_FLAG_INTERLACED_MASK \
  88     (BLOCK_FLAG_TOP_FIELD_FIRST|BLOCK_FLAG_BOTTOM_FIELD_FIRST)
  89
  90 #define BLOCK_FLAG_TYPE_MASK \
  91     (BLOCK_FLAG_TYPE_I|BLOCK_FLAG_TYPE_P|BLOCK_FLAG_TYPE_B|BLOCK_FLAG_TYPE_PB)
  92
  93 /* These are for input core private usage only */
  94 #define BLOCK_FLAG_CORE_PRIVATE_MASK  0x00ff0000
  95 #define BLOCK_FLAG_CORE_PRIVATE_SHIFT 16
  96
  97 /* These are for module private usage only */
  98 #define BLOCK_FLAG_PRIVATE_MASK  0xff000000
  99 #define BLOCK_FLAG_PRIVATE_SHIFT 24
 100
 101 typedef void (*block_free_t) (block_t *);
 102
 103 struct block_t
 104 {
 105     block_t     *p_next;
 106
 107     uint32_t    i_flags;
 108
 109     mtime_t     i_pts;
 110     mtime_t     i_dts;
 111     mtime_t     i_length;
 112
 113     unsigned    i_nb_samples; /* Used for audio */
 114     int         i_rate;
 115
 116     size_t      i_buffer;
 117     uint8_t     *p_buffer;
 118
 119     /* Rudimentary support for overloading block (de)allocation. */
 120     block_free_t pf_release;
 121 };
 122
 123 /****************************************************************************
 124  * Blocks functions:
 125  ****************************************************************************
 126  * - block_Alloc : create a new block with the requested size ( >= 0 ), return
 127  *      NULL for failure.
 128  * - block_Release : release a block allocated with block_Alloc.
 129  * - block_Realloc : realloc a block,
 130  *      i_pre: how many bytes to insert before body if > 0, else how many
 131  *      bytes of body to skip (the latter can be done without using
 132  *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
 133  *      i_body (>= 0): the final size of the body (decreasing it can directly
 134  *      be done with i_buffer = i_body).
 135  *      with preheader and or body (increase
 136  *      and decrease are supported). Use it as it is optimised.
 137  * - block_Duplicate : create a copy of a block.
 138  ****************************************************************************/
 139 VLC_EXPORT( void,      block_Init,    ( block_t *, void *, size_t ) );
 140 VLC_EXPORT( block_t *, block_Alloc,   ( size_t ) LIBVLC_USED );
 141 VLC_EXPORT( block_t *, block_Realloc, ( block_t *, ssize_t i_pre, size_t i_body ) LIBVLC_USED );
 142
 143 #define block_New( dummy, size ) block_Alloc(size)
 144
 145 LIBVLC_USED
 146 static inline block_t *block_Duplicate( block_t *p_block )
 147 {
 148     block_t *p_dup = block_Alloc( p_block->i_buffer );
 149     if( p_dup == NULL )
 150         return NULL;
 151
 152     p_dup->i_dts     = p_block->i_dts;
 153     p_dup->i_pts     = p_block->i_pts;
 154     p_dup->i_flags   = p_block->i_flags;
 155     p_dup->i_length  = p_block->i_length;
 156     p_dup->i_rate    = p_block->i_rate;
 157     p_dup->i_nb_samples = p_block->i_nb_samples;
 158     memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
 159
 160     return p_dup;
 161 }
 162
 163 static inline void block_Release( block_t *p_block )
 164 {
 165     p_block->pf_release( p_block );
 166 }
 167
 168 VLC_EXPORT( block_t *, block_heap_Alloc, (void *, void *, size_t) LIBVLC_USED );
 169 VLC_EXPORT( block_t *, block_mmap_Alloc, (void *addr, size_t length) LIBVLC_USED );
 170 VLC_EXPORT( block_t *, block_File, (int fd) LIBVLC_USED );
 171
 172 static inline void block_Cleanup (void *block)
 173 {
 174     block_Release ((block_t *)block);
 175 }
 176 #define block_cleanup_push( block ) vlc_cleanup_push (block_Cleanup, block)
 177
 178 /****************************************************************************
 179  * Chains of blocks functions helper
 180  ****************************************************************************
 181  * - block_ChainAppend : append a block to the last block of a chain. Try to
 182  *      avoid using with a lot of data as it's really slow, prefer
 183  *      block_ChainLastAppend
 184  * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
 185  *      and update it.
 186  * - block_ChainRelease : release a chain of block
 187  * - block_ChainExtract : extract data from a chain, return real bytes counts
 188  * - block_ChainGather : gather a chain, free it and return one block.
 189  ****************************************************************************/
 190 static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
 191 {
 192     if( *pp_list == NULL )
 193     {
 194         *pp_list = p_block;
 195     }
 196     else
 197     {
 198         block_t *p = *pp_list;
 199
 200         while( p->p_next ) p = p->p_next;
 201         p->p_next = p_block;
 202     }
 203 }
 204
 205 static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block )
 206 {
 207     block_t *p_last = p_block;
 208
 209     **ppp_last = p_block;
 210
 211     while( p_last->p_next ) p_last = p_last->p_next;
 212     *ppp_last = &p_last->p_next;
 213 }
 214
 215 static inline void block_ChainRelease( block_t *p_block )
 216 {
 217     while( p_block )
 218     {
 219         block_t *p_next = p_block->p_next;
 220         block_Release( p_block );
 221         p_block = p_next;
 222     }
 223 }
 224
 225 static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
 226 {
 227     size_t  i_total = 0;
 228     uint8_t *p = (uint8_t*)p_data;
 229
 230     while( p_list && i_max )
 231     {
 232         size_t i_copy = __MIN( i_max, p_list->i_buffer );
 233         memcpy( p, p_list->p_buffer, i_copy );
 234         i_max   -= i_copy;
 235         i_total += i_copy;
 236         p       += i_copy;
 237
 238         p_list = p_list->p_next;
 239     }
 240     return i_total;
 241 }
 242
 243 static inline void block_ChainProperties( block_t *p_list, int *pi_count, size_t *pi_size, mtime_t *pi_length )
 244 {
 245     size_t i_size = 0;
 246     mtime_t i_length = 0;
 247     int i_count = 0;
 248
 249     while( p_list )
 250     {
 251         i_size += p_list->i_buffer;
 252         i_length += p_list->i_length;
 253         i_count++;
 254
 255         p_list = p_list->p_next;
 256     }
 257
 258     if( pi_size )
 259         *pi_size = i_size;
 260     if( pi_length )
 261         *pi_length = i_length;
 262     if( pi_count )
 263         *pi_count = i_count;
 264 }
 265
 266 static inline block_t *block_ChainGather( block_t *p_list )
 267 {
 268     size_t  i_total = 0;
 269     mtime_t i_length = 0;
 270     block_t *g;
 271
 272     if( p_list->p_next == NULL )
 273         return p_list;  /* Already gathered */
 274
 275     block_ChainProperties( p_list, NULL, &i_total, &i_length );
 276
 277     g = block_Alloc( i_total );
 278     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
 279
 280     g->i_flags = p_list->i_flags;
 281     g->i_pts   = p_list->i_pts;
 282     g->i_dts   = p_list->i_dts;
 283     g->i_length = i_length;
 284
 285     /* free p_list */
 286     block_ChainRelease( p_list );
 287     return g;
 288 }
 289
 290 /****************************************************************************
 291  * Fifos of blocks.
 292  ****************************************************************************
 293  * - block_FifoNew : create and init a new fifo
 294  * - block_FifoRelease : destroy a fifo and free all blocks in it.
 295  * - block_FifoPace : wait for a fifo to drain to a specified number of packets or total data size
 296  * - block_FifoEmpty : free all blocks in a fifo
 297  * - block_FifoPut : put a block
 298  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
 299  * - block_FifoShow : show the first packet of the fifo (and wait if
 300  *      needed), be carefull, you can use it ONLY if you are sure to be the
 301  *      only one getting data from the fifo.
 302  * - block_FifoCount : how many packets are waiting in the fifo
 303  * - block_FifoWake : wake ups a thread with block_FifoGet() = NULL
 304  *   (this is used to wakeup a thread when there is no data to queue)
 305  *
 306  * block_FifoGet and block_FifoShow are cancellation points.
 307  ****************************************************************************/
 308
 309 VLC_EXPORT( block_fifo_t *, block_FifoNew,      ( void ) LIBVLC_USED );
 310 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
 311 VLC_EXPORT( void,           block_FifoPace,     ( block_fifo_t *fifo, size_t max_depth, size_t max_size ) );
 312 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
 313 VLC_EXPORT( size_t,         block_FifoPut,      ( block_fifo_t *, block_t * ) );
 314 VLC_EXPORT( void,           block_FifoWake,     ( block_fifo_t * ) );
 315 VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) LIBVLC_USED );
 316 VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
 317 size_t block_FifoSize( const block_fifo_t *p_fifo ) LIBVLC_USED;
 318 VLC_EXPORT( size_t,         block_FifoCount,    ( const block_fifo_t *p_fifo ) LIBVLC_USED );
 319
 320 #endif /* VLC_BLOCK_H */