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

   1 /*****************************************************************************
   2  * vlc_block.h: Data blocks management functions
   3  *****************************************************************************
   4  * Copyright (C) 2003 VideoLAN
   5  * $Id: vlc_block.h,v 1.6 2004/02/25 17:48:52 fenrir Exp $
   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., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  22  *****************************************************************************/
  23
  24 #ifndef _VLC_BLOCK_H
  25 #define _VLC_BLOCK_H 1
  26
  27 /*
  28  * block
  29  */
  30 typedef struct block_sys_t block_sys_t;
  31
  32 /* BLOCK_FLAG_DISCONTINUITY: the content doesn't follow the last block, or is probably broken */
  33 #define BLOCK_FLAG_DISCONTINUITY 0x0001
  34 /* BLOCK_FLAG_TYPE_I: Intra frame */
  35 #define BLOCK_FLAG_TYPE_I        0x0002
  36 /* BLOCK_FLAG_TYPE_P: inter frame with backward reference only */
  37 #define BLOCK_FLAG_TYPE_P        0x0004
  38 /* BLOCK_FLAG_TYPE_B: inter frame with backward and forward reference */
  39 #define BLOCK_FLAG_TYPE_B        0x0008
  40 /* BLOCK_FLAG_TYPE_PB: for inter frame when you don't know the real type */
  41 #define BLOCK_FLAG_TYPE_PB       0x0010
  42
  43 struct block_t
  44 {
  45     block_t     *p_next;
  46
  47     uint32_t    i_flags;
  48
  49     mtime_t     i_pts;
  50     mtime_t     i_dts;
  51     mtime_t     i_length;
  52
  53     int         i_rate;
  54
  55     int         i_buffer;
  56     uint8_t     *p_buffer;
  57
  58     void        (*pf_release)   ( block_t * );
  59
  60     block_t    *(*pf_modify)    ( block_t *, vlc_bool_t );
  61     block_t    *(*pf_duplicate) ( block_t * );
  62     block_t    *(*pf_realloc)   ( block_t *, int i_prebody, int i_body );
  63
  64     /* Following fields are private, user should never touch it */
  65     /* XXX never touch that OK !!! the first that access that will
  66      * have cvs account removed ;) XXX */
  67
  68     /* It's an object that should be valid as long as the block_t is valid */
  69     /* It should become a true block manager to reduce malloc/free */
  70     vlc_object_t    *p_manager;
  71
  72     /* private member for block_New, .... manager */
  73     block_sys_t *p_sys;
  74 };
  75
  76 struct block_fifo_t
  77 {
  78     vlc_mutex_t         lock;                         /* fifo data lock */
  79     vlc_cond_t          wait;         /* fifo data conditional variable */
  80
  81     int                 i_depth;
  82     block_t             *p_first;
  83     block_t             **pp_last;
  84 };
  85
  86 /*
  87  * block
  88  */
  89 #define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
  90 VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, int ) );
  91 static inline void block_Release( block_t *p_block )
  92 {
  93     p_block->pf_release( p_block );
  94 }
  95 static inline block_t *block_Modify( block_t *p_block, vlc_bool_t b_willmodify )
  96 {
  97     return p_block->pf_modify( p_block, b_willmodify );
  98 }
  99 static inline block_t *block_Duplicate( block_t *p_block )
 100 {
 101     return p_block->pf_duplicate( p_block );
 102 }
 103 static inline block_t *block_Realloc( block_t *p_block, int i_pre, int i_body )
 104 {
 105     return p_block->pf_realloc( p_block, i_pre, i_body );
 106 }
 107 VLC_EXPORT( void,       block_ChainAppend,  ( block_t **, block_t * ) );
 108 VLC_EXPORT( void,       block_ChainRelease, ( block_t * ) );
 109 VLC_EXPORT( int,        block_ChainExtract, ( block_t *, void *, int ) );
 110 VLC_EXPORT( block_t *,  block_ChainGather,  ( block_t * ) );
 111
 112 /* a bit special, only for new/other block manager */
 113 VLC_EXPORT( block_t *,  block_NewEmpty,     ( void ) );
 114
 115 #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
 116 VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
 117 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
 118 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
 119 VLC_EXPORT( int,            block_FifoPut,      ( block_fifo_t *, block_t * ) );
 120 VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
 121 VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
 122
 123 #endif /* VLC_BLOCK_H */