Remove Cthreads support
[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 #ifndef _VLC_THREADS_H_
33 #define _VLC_THREADS_H_
34
35 #include <stdio.h>
36
37 #if defined(DEBUG) && defined(HAVE_SYS_TIME_H)
38 #   include <sys/time.h>
39 #endif
40
41 #if defined( UNDER_CE )
42                                                                 /* WinCE API */
43 #elif defined( WIN32 )
44 #   include <process.h>                                         /* Win32 API */
45
46 #elif defined( HAVE_KERNEL_SCHEDULER_H )                             /* BeOS */
47 #   include <kernel/OS.h>
48 #   include <kernel/scheduler.h>
49 #   include <byteorder.h>
50
51 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )  /* pthreads (like Linux & BSD) */
52 #   define LIBVLC_USE_PTHREAD 1
53 #   define _APPLE_C_SOURCE    1 /* Proper pthread semantics on OSX */
54
55 #   include <unistd.h> /* _POSIX_SPIN_LOCKS */
56 #   include <pthread.h>
57     /* Needed for pthread_cond_timedwait */
58 #   include <errno.h>
59     /* This is not prototyped under Linux, though it exists. */
60     int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
61
62 #else
63 #   error no threads available on your system !
64
65 #endif
66
67 /*****************************************************************************
68  * Constants
69  *****************************************************************************/
70
71 /* Thread priorities */
72 #ifdef __APPLE__
73 #   define VLC_THREAD_PRIORITY_LOW (-47)
74 #   define VLC_THREAD_PRIORITY_INPUT 37
75 #   define VLC_THREAD_PRIORITY_AUDIO 37
76 #   define VLC_THREAD_PRIORITY_VIDEO (-47)
77 #   define VLC_THREAD_PRIORITY_OUTPUT 37
78 #   define VLC_THREAD_PRIORITY_HIGHEST 37
79
80 #elif defined(SYS_BEOS)
81 #   define VLC_THREAD_PRIORITY_LOW 5
82 #   define VLC_THREAD_PRIORITY_INPUT 10
83 #   define VLC_THREAD_PRIORITY_AUDIO 10
84 #   define VLC_THREAD_PRIORITY_VIDEO 5
85 #   define VLC_THREAD_PRIORITY_OUTPUT 15
86 #   define VLC_THREAD_PRIORITY_HIGHEST 15
87
88 #elif defined(PTHREAD_COND_T_IN_PTHREAD_H)
89 #   define VLC_THREAD_PRIORITY_LOW 0
90 #   define VLC_THREAD_PRIORITY_INPUT 20
91 #   define VLC_THREAD_PRIORITY_AUDIO 10
92 #   define VLC_THREAD_PRIORITY_VIDEO 0
93 #   define VLC_THREAD_PRIORITY_OUTPUT 30
94 #   define VLC_THREAD_PRIORITY_HIGHEST 40
95
96 #elif defined(WIN32) || defined(UNDER_CE)
97 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
98 #   define VLC_THREAD_PRIORITY_LOW 0
99 #   define VLC_THREAD_PRIORITY_INPUT \
100         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
101 #   define VLC_THREAD_PRIORITY_AUDIO \
102         (IS_WINNT ? THREAD_PRIORITY_HIGHEST : 0)
103 #   define VLC_THREAD_PRIORITY_VIDEO \
104         (IS_WINNT ? 0 : THREAD_PRIORITY_BELOW_NORMAL )
105 #   define VLC_THREAD_PRIORITY_OUTPUT \
106         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
107 #   define VLC_THREAD_PRIORITY_HIGHEST \
108         (IS_WINNT ? THREAD_PRIORITY_TIME_CRITICAL : 0)
109
110 #else
111 #   define VLC_THREAD_PRIORITY_LOW 0
112 #   define VLC_THREAD_PRIORITY_INPUT 0
113 #   define VLC_THREAD_PRIORITY_AUDIO 0
114 #   define VLC_THREAD_PRIORITY_VIDEO 0
115 #   define VLC_THREAD_PRIORITY_OUTPUT 0
116 #   define VLC_THREAD_PRIORITY_HIGHEST 0
117
118 #endif
119
120 /*****************************************************************************
121  * Type definitions
122  *****************************************************************************/
123
124 #if defined( WIN32 ) || defined( UNDER_CE )
125 typedef struct
126 {
127     /* thread id */
128     DWORD  id;
129     /*
130     ** handle to created thread, needs be closed to dispose of it
131     ** even after thread has exited
132     */
133     HANDLE hThread;
134 } vlc_thread_t;
135
136 typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL );
137
138 typedef struct
139 {
140     /* WinNT/2K/XP implementation */
141     HANDLE              mutex;
142     /* Win95/98/ME implementation */
143     CRITICAL_SECTION    csection;
144
145     vlc_object_t * p_this;
146 } vlc_mutex_t;
147
148 typedef struct
149 {
150     volatile int        i_waiting_threads;
151     /* WinNT/2K/XP implementation */
152     HANDLE              event;
153     SIGNALOBJECTANDWAIT SignalObjectAndWait;
154     /* Win95/98/ME implementation */
155     HANDLE              semaphore;
156     CRITICAL_SECTION    csection;
157     int                 i_win9x_cv;
158
159     vlc_object_t * p_this;
160 } vlc_cond_t;
161
162 typedef struct
163 {
164     DWORD   handle;
165 } vlc_threadvar_t;
166
167 #elif defined( HAVE_KERNEL_SCHEDULER_H )
168 /* This is the BeOS implementation of the vlc threads, note that the mutex is
169  * not a real mutex and the cond_var is not like a pthread cond_var but it is
170  * enough for what we need */
171
172 typedef thread_id vlc_thread_t;
173
174 typedef struct
175 {
176     int32_t         init;
177     sem_id          lock;
178
179     vlc_object_t * p_this;
180 } vlc_mutex_t;
181
182 typedef struct
183 {
184     int32_t         init;
185     thread_id       thread;
186
187     vlc_object_t * p_this;
188 } vlc_cond_t;
189
190 typedef struct
191 {
192 } vlc_threadvar_t;
193
194
195 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
196 typedef pthread_t       vlc_thread_t;
197 typedef struct
198 {
199     pthread_mutex_t mutex;
200     vlc_object_t * p_this;
201 } vlc_mutex_t;
202 typedef struct
203 {
204     pthread_cond_t cond;
205     vlc_object_t * p_this;
206 } vlc_cond_t;
207
208 typedef struct
209 {
210     pthread_key_t handle;
211 } vlc_threadvar_t;
212
213 #endif
214
215 #endif /* !_VLC_THREADS_H */