* configure.ac : added --enable-goom and --with-goom-tree. Btw, I use a
[vlc.git] / include / vlc_block.h
1 /*****************************************************************************
2  * block.h
3  *****************************************************************************
4  * Copyright (C) 2003 VideoLAN
5  * $Id: vlc_block.h,v 1.1 2003/08/23 22:49:50 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 _BLOCK_H
25 #define _BLOCK_H 1
26
27
28 /*
29  * block
30  */
31 typedef struct block_sys_t block_sys_t;
32
33 struct block_t
34 {
35     block_t     *p_next;
36
37     vlc_bool_t  b_frame_display;
38     vlc_bool_t  b_frame_start;
39     mtime_t     i_pts;
40     mtime_t     i_dts;
41
42     int         i_buffer;
43     uint8_t     *p_buffer;
44
45     void        (*pf_release)   ( block_t * );
46
47     block_t    *(*pf_modify)    ( block_t *, vlc_bool_t );
48     block_t    *(*pf_duplicate) ( block_t * );
49     block_t    *(*pf_realloc)   ( block_t *, int i_prebody, int i_body );
50
51     /* Following fields are private, user should never touch it */
52     /* XXX never touch that OK !!! the first that access that will
53      * have cvs account removed ;) XXX */
54
55     /* It's an object that should be valid as long as the block_t is valid */
56     /* It should become a true block manager to reduce malloc/free */
57     vlc_object_t    *p_manager;
58
59     /* private member for block_New, .... manager */
60     block_sys_t *p_sys;
61 };
62
63 struct block_fifo_t
64 {
65     vlc_mutex_t         lock;                         /* fifo data lock */
66     vlc_cond_t          wait;         /* fifo data conditional variable */
67
68     int                 i_depth;
69     block_t             *p_first;
70     block_t             **pp_last;
71 };
72
73 /*
74  * block
75  */
76 #define block_New( a, b ) __block_New( VLC_OBJECT(a), b )
77 VLC_EXPORT( block_t *,  __block_New,        ( vlc_object_t *, int ) );
78 static inline void block_Release( block_t *p_block )
79 {
80     p_block->pf_release( p_block );
81 }
82 static inline block_t *block_Modify( block_t *p_block, vlc_bool_t b_willmodify )
83 {
84     return p_block->pf_modify( p_block, b_willmodify );
85 }
86 static inline block_t *block_Duplicate( block_t *p_block )
87 {
88     return p_block->pf_duplicate( p_block );
89 }
90 static inline block_t *block_Realloc( block_t *p_block, int i_pre, int i_body )
91 {
92     return p_block->pf_realloc( p_block, i_pre, i_body );
93 }
94 VLC_EXPORT( void,       block_ChainAppend,  ( block_t **, block_t * ) );
95 VLC_EXPORT( void,       block_ChainRelease, ( block_t * ) );
96 VLC_EXPORT( int,        block_ChainExtract, ( block_t *, void *, int ) );
97 VLC_EXPORT( block_t *,  block_ChainGather,  ( block_t * ) );
98
99 /* a bit special, only for new/other block manager */
100 VLC_EXPORT( block_t *,  block_NewEmpty,     ( void ) );
101
102 #define block_FifoNew( a ) __block_FifoNew( VLC_OBJECT(a) )
103 VLC_EXPORT( block_fifo_t *, __block_FifoNew,    ( vlc_object_t * ) );
104 VLC_EXPORT( void,           block_FifoRelease,  ( block_fifo_t * ) );
105 VLC_EXPORT( void,           block_FifoEmpty,    ( block_fifo_t * ) );
106 VLC_EXPORT( int,            block_FifoPut,      ( block_fifo_t *, block_t * ) );
107 VLC_EXPORT( block_t *,      block_FifoGet,      ( block_fifo_t * ) );
108 VLC_EXPORT( block_t *,      block_FifoGetFrame, ( block_fifo_t * ) );
109 VLC_EXPORT( block_t *,      block_FifoShow,     ( block_fifo_t * ) );
110
111 #endif