e36a07cdf08f27c32b21070e7e9c86339a854bfe
[vlc.git] / include / vlc_threads.h
1 /*****************************************************************************
2  * vlc_threads.h : threads implementation for the VideoLAN client
3  * This header provides portable declarations for mutexes & conditions
4  *****************************************************************************
5  * Copyright (C) 1999, 2002 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Jean-Marc Dressler <polux@via.ecp.fr>
9  *          Samuel Hocevar <sam@via.ecp.fr>
10  *          Gildas Bazin <gbazin@netcourrier.com>
11  *          Christophe Massiot <massiot@via.ecp.fr>
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software
25  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
26  *****************************************************************************/
27
28 #if !defined( __LIBVLC__ )
29   #error You are not libvlc or one of its plugins. You cannot include this file
30 #endif
31
32 #include <stdio.h>
33
34 #if defined(DEBUG) && defined(HAVE_SYS_TIME_H)
35 #   include <sys/time.h>
36 #endif
37
38 #if defined( PTH_INIT_IN_PTH_H )                                  /* GNU Pth */
39 #   include <pth.h>
40
41 #elif defined( ST_INIT_IN_ST_H )                            /* State threads */
42 #   include <st.h>
43
44 #elif defined( UNDER_CE )
45                                                                 /* WinCE API */
46 #elif defined( WIN32 )
47 #   include <process.h>                                         /* Win32 API */
48
49 #elif defined( HAVE_KERNEL_SCHEDULER_H )                             /* BeOS */
50 #   include <kernel/OS.h>
51 #   include <kernel/scheduler.h>
52 #   include <byteorder.h>
53
54 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )  /* pthreads (like Linux & BSD) */
55 #   define LIBVLC_USE_PTHREAD 1
56
57 #   include <pthread.h>
58 #   ifdef DEBUG
59         /* Needed for pthread_cond_timedwait */
60 #       include <errno.h>
61 #   endif
62     /* This is not prototyped under Linux, though it exists. */
63     int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
64
65 #elif defined( HAVE_CTHREADS_H )                                  /* GNUMach */
66 #   include <cthreads.h>
67
68 #else
69 #   error no threads available on your system !
70
71 #endif
72
73 /*****************************************************************************
74  * Constants
75  *****************************************************************************/
76
77 /* Thread priorities */
78 #ifdef __APPLE__
79 #   define VLC_THREAD_PRIORITY_LOW (-47)
80 #   define VLC_THREAD_PRIORITY_INPUT 37
81 #   define VLC_THREAD_PRIORITY_AUDIO 37
82 #   define VLC_THREAD_PRIORITY_VIDEO (-47)
83 #   define VLC_THREAD_PRIORITY_OUTPUT 37
84 #   define VLC_THREAD_PRIORITY_HIGHEST 37
85
86 #elif defined(SYS_BEOS)
87 #   define VLC_THREAD_PRIORITY_LOW 5
88 #   define VLC_THREAD_PRIORITY_INPUT 10
89 #   define VLC_THREAD_PRIORITY_AUDIO 10
90 #   define VLC_THREAD_PRIORITY_VIDEO 5
91 #   define VLC_THREAD_PRIORITY_OUTPUT 15
92 #   define VLC_THREAD_PRIORITY_HIGHEST 15
93
94 #elif defined(PTHREAD_COND_T_IN_PTHREAD_H)
95 #   define VLC_THREAD_PRIORITY_LOW 0
96 #   define VLC_THREAD_PRIORITY_INPUT 20
97 #   define VLC_THREAD_PRIORITY_AUDIO 10
98 #   define VLC_THREAD_PRIORITY_VIDEO 0
99 #   define VLC_THREAD_PRIORITY_OUTPUT 30
100 #   define VLC_THREAD_PRIORITY_HIGHEST 40
101
102 #elif defined(WIN32) || defined(UNDER_CE)
103 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
104 #   define VLC_THREAD_PRIORITY_LOW 0
105 #   define VLC_THREAD_PRIORITY_INPUT \
106         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
107 #   define VLC_THREAD_PRIORITY_AUDIO \
108         (IS_WINNT ? THREAD_PRIORITY_HIGHEST : 0)
109 #   define VLC_THREAD_PRIORITY_VIDEO \
110         (IS_WINNT ? 0 : THREAD_PRIORITY_BELOW_NORMAL )
111 #   define VLC_THREAD_PRIORITY_OUTPUT \
112         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
113 #   define VLC_THREAD_PRIORITY_HIGHEST \
114         (IS_WINNT ? THREAD_PRIORITY_TIME_CRITICAL : 0)
115
116 #else
117 #   define VLC_THREAD_PRIORITY_LOW 0
118 #   define VLC_THREAD_PRIORITY_INPUT 0
119 #   define VLC_THREAD_PRIORITY_AUDIO 0
120 #   define VLC_THREAD_PRIORITY_VIDEO 0
121 #   define VLC_THREAD_PRIORITY_OUTPUT 0
122 #   define VLC_THREAD_PRIORITY_HIGHEST 0
123
124 #endif
125
126 /*****************************************************************************
127  * Type definitions
128  *****************************************************************************/
129
130 #if defined( PTH_INIT_IN_PTH_H )
131 typedef pth_t            vlc_thread_t;
132 typedef struct
133 {
134     pth_mutex_t mutex;
135     vlc_object_t * p_this;
136 } vlc_mutex_t;
137 typedef struct
138 {
139     pth_cond_t cond;
140     vlc_object_t * p_this;
141 } vlc_cond_t;
142
143 #elif defined( ST_INIT_IN_ST_H )
144 typedef st_thread_t      vlc_thread_t;
145 typedef struct
146 {
147     st_mutex_t mutex;
148     vlc_object_t * p_this;
149 } vlc_mutex_t;
150 typedef struct
151 {
152     st_cond_t cond;
153     vlc_object_t * p_this;
154 } vlc_cond_t;
155
156 #elif defined( WIN32 ) || defined( UNDER_CE )
157 typedef HANDLE vlc_thread_t;
158 typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL );
159 typedef unsigned (WINAPI *PTHREAD_START) (void *);
160
161 typedef struct
162 {
163     /* WinNT/2K/XP implementation */
164     HANDLE              mutex;
165     /* Win95/98/ME implementation */
166     CRITICAL_SECTION    csection;
167
168     vlc_object_t * p_this;
169 } vlc_mutex_t;
170
171 typedef struct
172 {
173     volatile int        i_waiting_threads;
174     /* WinNT/2K/XP implementation */
175     HANDLE              event;
176     SIGNALOBJECTANDWAIT SignalObjectAndWait;
177     /* Win95/98/ME implementation */
178     HANDLE              semaphore;
179     CRITICAL_SECTION    csection;
180     int                 i_win9x_cv;
181
182     vlc_object_t * p_this;
183 } vlc_cond_t;
184
185 #elif defined( HAVE_KERNEL_SCHEDULER_H )
186 /* This is the BeOS implementation of the vlc threads, note that the mutex is
187  * not a real mutex and the cond_var is not like a pthread cond_var but it is
188  * enough for what wee need */
189
190 typedef thread_id vlc_thread_t;
191
192 typedef struct
193 {
194     int32_t         init;
195     sem_id          lock;
196
197     vlc_object_t * p_this;
198 } vlc_mutex_t;
199
200 typedef struct
201 {
202     int32_t         init;
203     thread_id       thread;
204
205     vlc_object_t * p_this;
206 } vlc_cond_t;
207
208 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
209 typedef pthread_t       vlc_thread_t;
210 typedef struct
211 {
212     pthread_mutex_t mutex;
213     vlc_object_t * p_this;
214 } vlc_mutex_t;
215 typedef struct
216 {
217     pthread_cond_t cond;
218     vlc_object_t * p_this;
219 } vlc_cond_t;
220
221 #elif defined( HAVE_CTHREADS_H )
222 typedef cthread_t       vlc_thread_t;
223
224 /* Those structs are the ones defined in /include/cthreads.h but we need
225  * to handle (&foo) where foo is a (mutex_t) while they handle (foo) where
226  * foo is a (mutex_t*) */
227 typedef struct
228 {
229     spin_lock_t held;
230     spin_lock_t lock;
231     char *name;
232     struct cthread_queue queue;
233
234     vlc_object_t * p_this;
235 } vlc_mutex_t;
236
237 typedef struct
238 {
239     spin_lock_t lock;
240     struct cthread_queue queue;
241     char *name;
242     struct cond_imp *implications;
243
244     vlc_object_t * p_this;
245 } vlc_cond_t;
246
247 #endif
248