1 /*****************************************************************************
2 * vlc_block.h: Data blocks management functions
3 *****************************************************************************
4 * Copyright (C) 2003 VideoLAN
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
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.
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.
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 *****************************************************************************/
25 #define _VLC_BLOCK_H 1
30 typedef struct block_sys_t block_sys_t;
32 /** The content doesn't follow the last block, or is probably broken */
33 #define BLOCK_FLAG_DISCONTINUITY 0x0001
35 #define BLOCK_FLAG_TYPE_I 0x0002
36 /** Inter frame with backward reference only */
37 #define BLOCK_FLAG_TYPE_P 0x0004
38 /** Inter frame with backward and forward reference */
39 #define BLOCK_FLAG_TYPE_B 0x0008
40 /** For inter frame when you don't know the real type */
41 #define BLOCK_FLAG_TYPE_PB 0x0010
42 /** Warm that this block is a header one */
43 #define BLOCK_FLAG_HEADER 0x0020
44 /** This is the last block of the frame */
45 #define BLOCK_FLAG_END_OF_FRAME 0x0040
47 #define BLOCK_FLAG_PRIVATE_MASK 0xffff0000
48 #define BLOCK_FLAG_PRIVATE_SHIFT 16
65 void (*pf_release) ( block_t * );
67 block_t *(*pf_modify) ( block_t *, vlc_bool_t );
68 block_t *(*pf_duplicate) ( block_t * );
69 block_t *(*pf_realloc) ( block_t *, int i_prebody, int i_body );
71 /* Following fields are private, user should never touch it */
72 /* XXX never touch that OK !!! the first that access that will
73 * have cvs account removed ;) XXX */
75 /* It's an object that should be valid as long as the block_t is valid */
76 /* It should become a true block manager to reduce malloc/free */
77 vlc_object_t *p_manager;
79 /* private member for block_New, .... manager */
85 vlc_mutex_t lock; /* fifo data lock */
86 vlc_cond_t wait; /* fifo data conditional variable */
96 #define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
97 VLC_EXPORT( block_t *, __block_New, ( vlc_object_t *, int ) );
98 static inline void block_Release( block_t *p_block )
100 p_block->pf_release( p_block );
102 static inline block_t *block_Modify( block_t *p_block, vlc_bool_t b_willmodify )
104 return p_block->pf_modify( p_block, b_willmodify );
106 static inline block_t *block_Duplicate( block_t *p_block )
108 return p_block->pf_duplicate( p_block );
110 static inline block_t *block_Realloc( block_t *p_block, int i_pre, int i_body )
112 return p_block->pf_realloc( p_block, i_pre, i_body );
114 VLC_EXPORT( void, block_ChainAppend, ( block_t **, block_t * ) );
115 VLC_EXPORT( void, block_ChainLastAppend, ( block_t ***ppp_last, block_t * ) );
116 VLC_EXPORT( void, block_ChainRelease, ( block_t * ) );
117 VLC_EXPORT( int, block_ChainExtract, ( block_t *, void *, int ) );
118 VLC_EXPORT( block_t *, block_ChainGather, ( block_t * ) );
120 /* a bit special, only for new/other block manager */
121 VLC_EXPORT( block_t *, block_NewEmpty, ( void ) );
123 #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
124 VLC_EXPORT( block_fifo_t *, __block_FifoNew, ( vlc_object_t * ) );
125 VLC_EXPORT( void, block_FifoRelease, ( block_fifo_t * ) );
126 VLC_EXPORT( void, block_FifoEmpty, ( block_fifo_t * ) );
127 VLC_EXPORT( int, block_FifoPut, ( block_fifo_t *, block_t * ) );
128 VLC_EXPORT( block_t *, block_FifoGet, ( block_fifo_t * ) );
129 VLC_EXPORT( block_t *, block_FifoShow, ( block_fifo_t * ) );
131 #endif /* VLC_BLOCK_H */