* block: added
[vlc.git] / include / vlc_block.h
1 /*****************************************************************************
2  * vlc_block.h: Data blocks management functions
3  *****************************************************************************
4  * Copyright (C) 2003 VideoLAN
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., 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  * - 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 /** Warm 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 is the last block of the GOP */
66 #define BLOCK_FLAG_END_OF_GOP    0x0100
67 /** This block contains a clock reference */
68 #define BLOCK_FLAG_CLOCK         0x0200
69 /** This block is scrambled */
70 #define BLOCK_FLAG_SCRAMBLED     0x0400
71 /** This block has to be decoded but not be displayed */
72 #define BLOCK_FLAG_PREROLL       0x0800
73 /** This block is corrupted and/or there is data loss  */
74 #define BLOCK_FLAG_CORRUPTED     0x1000
75
76 #define BLOCK_FLAG_PRIVATE_MASK  0xffff0000
77 #define BLOCK_FLAG_PRIVATE_SHIFT 16
78
79 struct block_t
80 {
81     block_t     *p_next;
82
83     uint32_t    i_flags;
84
85     mtime_t     i_pts;
86     mtime_t     i_dts;
87     mtime_t     i_length;
88
89     int         i_samples; /* Used for audio */
90     int         i_rate;
91
92     int         i_buffer;
93     uint8_t     *p_buffer;
94
95     /* This way the block_Release can be overloaded
96      * Don't mess with it now, if you need it the ask on ML
97      */
98     void        (*pf_release)   ( block_t * );
99
100     /* It's an object that should be valid as long as the block_t is valid */
101     /* It should become a true block manager to reduce malloc/free */
102     vlc_object_t    *p_manager;
103
104     /* Following fields are private, user should never touch it */
105     /* XXX never touch that OK !!! the first that access that will
106      * have cvs account removed ;) XXX */
107     block_sys_t *p_sys;
108 };
109
110 /****************************************************************************
111  * Blocks functions:
112  ****************************************************************************
113  * - block_New : create a new block with the requested size ( >= 0 ), return
114  *      NULL for failure.
115  * - block_Release : release a block allocated with block_New.
116  * - block_Realloc : realloc a block,
117  *      i_pre: how many bytes to insert before body if > 0, else how many
118  *      bytes of body to skip (the latter can be done without using
119  *      block_Realloc i_buffer -= -i_pre, p_buffer += -i_pre as i_pre < 0)
120  *      i_body (>= 0): the final size of the body (decreasing it can directly
121  *      be done with i_buffer = i_body).
122  *      with preheader and or body (increase
123  *      and decrease are supported). Use it as it is optimised.
124  * - block_Duplicate : create a copy of a block.
125  ****************************************************************************/
126 #define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
127 VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, int ) );
128 VLC_EXPORT( block_t *, block_Realloc,       ( block_t *, int i_pre, int i_body ) );
129
130 static inline block_t *block_Duplicate( block_t *p_block )
131 {
132     block_t *p_dup = block_New( p_block->p_manager, p_block->i_buffer );
133
134     p_dup->i_dts     = p_block->i_dts;
135     p_dup->i_pts     = p_block->i_pts;
136     p_dup->i_flags   = p_block->i_flags;
137     p_dup->i_length  = p_block->i_length;
138     p_dup->i_rate    = p_block->i_rate;
139     p_dup->i_samples = p_block->i_samples;
140
141     if( p_dup && p_block->i_buffer > 0 )
142         memcpy( p_dup->p_buffer, p_block->p_buffer, p_block->i_buffer );
143
144     return p_dup;
145 }
146 static inline void block_Release( block_t *p_block )
147 {
148     p_block->pf_release( p_block );
149 }
150
151 /****************************************************************************
152  * Chains of blocks functions helper
153  ****************************************************************************
154  * - block_ChainAppend : append a block the the last block of a chain. Try to
155  *      avoid using with a lot of data as it's really slow, prefer
156  *      block_ChainLastAppend
157  * - block_ChainLastAppend : use a pointer over a pointer to the next blocks,
158  *      and update it.
159  * - block_ChainRelease : release a chain of block
160  * - block_ChainExtract : extract data from a chain, return real bytes counts
161  * - block_ChainGather : gather a chain, free it and return a block.
162  ****************************************************************************/
163 static inline void block_ChainAppend( block_t **pp_list, block_t *p_block )
164 {
165     if( *pp_list == NULL )
166     {
167         *pp_list = p_block;
168     }
169     else
170     {
171         block_t *p = *pp_list;
172
173         while( p->p_next ) p = p->p_next;
174         p->p_next = p_block;
175     }
176 }
177
178 static inline void block_ChainLastAppend( block_t ***ppp_last, block_t *p_block  )
179 {
180     block_t *p_last = p_block;
181
182     **ppp_last = p_block;
183
184     while( p_last->p_next ) p_last = p_last->p_next;
185     *ppp_last = &p_last->p_next;
186 }
187
188 static inline void block_ChainRelease( block_t *p_block )
189 {
190     while( p_block )
191     {
192         block_t *p_next = p_block->p_next;
193         block_Release( p_block );
194         p_block = p_next;
195     }
196 }
197 static int block_ChainExtract( block_t *p_list, void *p_data, int i_max )
198 {
199     block_t *b;
200     int     i_total = 0;
201     uint8_t *p = (uint8_t*)p_data;
202
203     for( b = p_list; b != NULL; b = b->p_next )
204     {
205         int i_copy = __MIN( i_max, b->i_buffer );
206         if( i_copy > 0 )
207         {
208             memcpy( p, b->p_buffer, i_copy );
209             i_max   -= i_copy;
210             i_total += i_copy;
211             p       += i_copy;
212
213             if( i_max == 0 )
214                 return i_total;
215         }
216     }
217     return i_total;
218 }
219
220 static inline block_t *block_ChainGather( block_t *p_list )
221 {
222     int     i_total = 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         i_total += b->i_buffer;
230
231     g = block_New( p_list->p_manager, i_total );
232     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
233
234     g->i_flags = p_list->i_flags;
235     g->i_pts   = p_list->i_pts;
236     g->i_dts   = p_list->i_dts;
237
238     /* free p_list */
239     block_ChainRelease( p_list );
240     return g;
241 }
242
243
244 /****************************************************************************
245  * Fifos of blocks.
246  ****************************************************************************
247  * Avoid touching block_fifo_t unless you really know what you are doing.
248  * ( Some race conditions has to be correctly handled, like in win32 ;)
249  * - block_FifoNew : create and init a new fifo
250  * - block_FifoRelease : destroy a fifo and free all blocks in it.
251  * - block_FifoEmpty : free all blocks in a fifo
252  * - block_FifoPut : put a block
253  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
254  * - block_FifoShow : show the first packet of the fifo (and wait if
255  *      needed), becarefull, you can use it ONLY if you are sure to be the
256  *      only one getting data from the fifo.
257  ****************************************************************************/
258 struct block_fifo_t
259 {
260     vlc_mutex_t         lock;                         /* fifo data lock */
261     vlc_cond_t          wait;         /* fifo data conditional variable */
262
263     int                 i_depth;
264     block_t             *p_first;
265     block_t             **pp_last;
266     int                 i_size;
267 };
268
269
270 #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
271 VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
272 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
273 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
274 VLC_EXPORT( int,            block_FifoPut,      ( block_fifo_t *, block_t * ) );
275 VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
276 VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
277
278 #endif /* VLC_BLOCK_H */