Remove the unused manager from block_t
[vlc.git] / 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 #if !defined( __LIBVLC__ )
25   #error You are not libvlc or one of its plugins. You cannot include this file
26 #endif
27
28 #ifndef _VLC_BLOCK_H
29 #define _VLC_BLOCK_H 1
30
31 /****************************************************************************
32  * block:
33  ****************************************************************************
34  * - block_sys_t is opaque and thus block_t->p_sys is PRIVATE
35  * - i_flags may not always be set (ie could be 0, even for a key frame
36  *      it depends where you receive the buffer (before/after a packetizer
37  *      and the demux/packetizer implementations.
38  * - i_dts/i_pts could be 0, it means no pts
39  * - i_length: length in microseond of the packet, can be null except in the
40  *      sout where it is mandatory.
41  * - i_rate 0 or a valid input rate, look at vlc_input.h
42  *
43  * - i_buffer number of valid data pointed by p_buffer
44  *      you can freely decrease it but never increase it yourself
45  *      (use block_Realloc)
46  * - p_buffer: pointer over datas. You should never overwrite it, you can
47  *   only incremment it to skip datas, in others cases use block_Realloc
48  *   (don't duplicate yourself in a bigger buffer, block_Realloc is
49  *   optimised for prehader/postdatas increase)
50  ****************************************************************************/
51 typedef struct block_sys_t block_sys_t;
52
53 /** The content doesn't follow the last block, or is probably broken */
54 #define BLOCK_FLAG_DISCONTINUITY 0x0001
55 /** Intra frame */
56 #define BLOCK_FLAG_TYPE_I        0x0002
57 /** Inter frame with backward reference only */
58 #define BLOCK_FLAG_TYPE_P        0x0004
59 /** Inter frame with backward and forward reference */
60 #define BLOCK_FLAG_TYPE_B        0x0008
61 /** For inter frame when you don't know the real type */
62 #define BLOCK_FLAG_TYPE_PB       0x0010
63 /** Warn that this block is a header one */
64 #define BLOCK_FLAG_HEADER        0x0020
65 /** This is the last block of the frame */
66 #define BLOCK_FLAG_END_OF_FRAME  0x0040
67 /** This is not a key frame for bitrate shaping */
68 #define BLOCK_FLAG_NO_KEYFRAME   0x0080
69 /** This block contains a clock reference */
70 #define BLOCK_FLAG_CLOCK         0x0200
71 /** This block is scrambled */
72 #define BLOCK_FLAG_SCRAMBLED     0x0400
73 /** This block has to be decoded but not be displayed */
74 #define BLOCK_FLAG_PREROLL       0x0800
75 /** This block is corrupted and/or there is data loss  */
76 #define BLOCK_FLAG_CORRUPTED     0x1000
77
78 #define BLOCK_FLAG_PRIVATE_MASK  0xffff0000
79 #define BLOCK_FLAG_PRIVATE_SHIFT 16
80
81 struct block_t
82 {
83     block_t     *p_next;
84     block_t     *p_prev;
85
86     uint32_t    i_flags;
87
88     mtime_t     i_pts;
89     mtime_t     i_dts;
90     mtime_t     i_length;
91
92     int         i_samples; /* Used for audio */
93     int         i_rate;
94
95     size_t      i_buffer;
96     uint8_t     *p_buffer;
97
98     /* This way the block_Release can be overloaded
99      * Don't mess with it now, if you need it the ask on ML
100      */
101     void        (*pf_release)   ( block_t * );
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 Subversion 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( NULL, b )
126 VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, size_t ) );
127 VLC_EXPORT( block_t *, block_Realloc,       ( block_t *, ssize_t i_pre, size_t i_body ) );
128
129 static inline block_t *block_Duplicate( block_t *p_block )
130 {
131     block_t *p_dup = block_New( NULL, p_block->i_buffer );
132     if( p_dup == NULL )
133         return NULL;
134
135     p_dup->i_dts     = p_block->i_dts;
136     p_dup->i_pts     = p_block->i_pts;
137     p_dup->i_flags   = p_block->i_flags;
138     p_dup->i_length  = p_block->i_length;
139     p_dup->i_rate    = p_block->i_rate;
140     p_dup->i_samples = p_block->i_samples;
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
197 static size_t block_ChainExtract( block_t *p_list, void *p_data, size_t i_max )
198 {
199     size_t  i_total = 0;
200     uint8_t *p = (uint8_t*)p_data;
201
202     while( p_list && i_max )
203     {
204         size_t i_copy = __MIN( i_max, p_list->i_buffer );
205         memcpy( p, p_list->p_buffer, i_copy );
206         i_max   -= i_copy;
207         i_total += i_copy;
208         p       += i_copy;
209
210         p_list = p_list->p_next;
211     }
212     return i_total;
213 }
214
215 static inline block_t *block_ChainGather( block_t *p_list )
216 {
217     size_t  i_total = 0;
218     mtime_t i_length = 0;
219     block_t *b, *g;
220
221     if( p_list->p_next == NULL )
222         return p_list;  /* Already gathered */
223
224     for( b = p_list; b != NULL; b = b->p_next )
225     {
226         i_total += b->i_buffer;
227         i_length += b->i_length;
228     }
229
230     g = block_New( NULL, i_total );
231     block_ChainExtract( p_list, g->p_buffer, g->i_buffer );
232
233     g->i_flags = p_list->i_flags;
234     g->i_pts   = p_list->i_pts;
235     g->i_dts   = p_list->i_dts;
236     g->i_length = i_length;
237
238     /* free p_list */
239     block_ChainRelease( p_list );
240     return g;
241 }
242
243
244 /****************************************************************************
245  * Fifos of blocks.
246  ****************************************************************************
247  * - block_FifoNew : create and init a new fifo
248  * - block_FifoRelease : destroy a fifo and free all blocks in it.
249  * - block_FifoEmpty : free all blocks in a fifo
250  * - block_FifoPut : put a block
251  * - block_FifoGet : get a packet from the fifo (and wait if it is empty)
252  * - block_FifoShow : show the first packet of the fifo (and wait if
253  *      needed), be carefull, you can use it ONLY if you are sure to be the
254  *      only one getting data from the fifo.
255  * - block_FifoCount : how many packets are waiting in the fifo
256  * - block_FifoSize : how many cumulated bytes are waiting in the fifo
257  * - block_FifoWake : wake ups a thread with block_FifoGet() = NULL
258  *   (this is used to wakeup a thread when there is no data to queue)
259  ****************************************************************************/
260
261 #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
262 VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
263 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
264 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
265 VLC_EXPORT( size_t,         block_FifoPut,      ( block_fifo_t *, block_t * ) );
266 VLC_EXPORT( void,           block_FifoWake,     ( block_fifo_t * ) );
267 VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
268 VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
269 VLC_EXPORT( size_t,         block_FifoSize,     ( const block_fifo_t *p_fifo ) );
270 VLC_EXPORT( size_t,         block_FifoCount,    ( const block_fifo_t *p_fifo ) );
271
272 #endif /* VLC_BLOCK_H */