git.sesse.net Git - vlc/blob - 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( PTH_INIT_IN_PTH_H )                                  /* GNU Pth */
  42 #   include <pth.h>
  43
  44 #elif defined( ST_INIT_IN_ST_H )                            /* State threads */
  45 #   include <st.h>
  46
  47 #elif defined( UNDER_CE )
  48                                                                 /* WinCE API */
  49 #elif defined( WIN32 )
  50 #   include <process.h>                                         /* Win32 API */
  51
  52 #elif defined( HAVE_KERNEL_SCHEDULER_H )                             /* BeOS */
  53 #   include <kernel/OS.h>
  54 #   include <kernel/scheduler.h>
  55 #   include <byteorder.h>
  56
  57 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )  /* pthreads (like Linux & BSD) */
  58 #   define LIBVLC_USE_PTHREAD 1
  59
  60 #   include <pthread.h>
  61 #   ifdef DEBUG
  62         /* Needed for pthread_cond_timedwait */
  63 #       include <errno.h>
  64 #   endif
  65     /* This is not prototyped under Linux, though it exists. */
  66     int pthread_mutexattr_setkind_np( pthread_mutexattr_t *attr, int kind );
  67
  68 #elif defined( HAVE_CTHREADS_H )                                  /* GNUMach */
  69 #   include <cthreads.h>
  70
  71 #else
  72 #   error no threads available on your system !
  73
  74 #endif
  75
  76 /*****************************************************************************
  77  * Constants
  78  *****************************************************************************/
  79
  80 /* Thread priorities */
  81 #ifdef __APPLE__
  82 #   define VLC_THREAD_PRIORITY_LOW (-47)
  83 #   define VLC_THREAD_PRIORITY_INPUT 37
  84 #   define VLC_THREAD_PRIORITY_AUDIO 37
  85 #   define VLC_THREAD_PRIORITY_VIDEO (-47)
  86 #   define VLC_THREAD_PRIORITY_OUTPUT 37
  87 #   define VLC_THREAD_PRIORITY_HIGHEST 37
  88
  89 #elif defined(SYS_BEOS)
  90 #   define VLC_THREAD_PRIORITY_LOW 5
  91 #   define VLC_THREAD_PRIORITY_INPUT 10
  92 #   define VLC_THREAD_PRIORITY_AUDIO 10
  93 #   define VLC_THREAD_PRIORITY_VIDEO 5
  94 #   define VLC_THREAD_PRIORITY_OUTPUT 15
  95 #   define VLC_THREAD_PRIORITY_HIGHEST 15
  96
  97 #elif defined(PTHREAD_COND_T_IN_PTHREAD_H)
  98 #   define VLC_THREAD_PRIORITY_LOW 0
  99 #   define VLC_THREAD_PRIORITY_INPUT 20
 100 #   define VLC_THREAD_PRIORITY_AUDIO 10
 101 #   define VLC_THREAD_PRIORITY_VIDEO 0
 102 #   define VLC_THREAD_PRIORITY_OUTPUT 30
 103 #   define VLC_THREAD_PRIORITY_HIGHEST 40
 104
 105 #elif defined(WIN32) || defined(UNDER_CE)
 106 /* Define different priorities for WinNT/2K/XP and Win9x/Me */
 107 #   define VLC_THREAD_PRIORITY_LOW 0
 108 #   define VLC_THREAD_PRIORITY_INPUT \
 109         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
 110 #   define VLC_THREAD_PRIORITY_AUDIO \
 111         (IS_WINNT ? THREAD_PRIORITY_HIGHEST : 0)
 112 #   define VLC_THREAD_PRIORITY_VIDEO \
 113         (IS_WINNT ? 0 : THREAD_PRIORITY_BELOW_NORMAL )
 114 #   define VLC_THREAD_PRIORITY_OUTPUT \
 115         (IS_WINNT ? THREAD_PRIORITY_ABOVE_NORMAL : 0)
 116 #   define VLC_THREAD_PRIORITY_HIGHEST \
 117         (IS_WINNT ? THREAD_PRIORITY_TIME_CRITICAL : 0)
 118
 119 #else
 120 #   define VLC_THREAD_PRIORITY_LOW 0
 121 #   define VLC_THREAD_PRIORITY_INPUT 0
 122 #   define VLC_THREAD_PRIORITY_AUDIO 0
 123 #   define VLC_THREAD_PRIORITY_VIDEO 0
 124 #   define VLC_THREAD_PRIORITY_OUTPUT 0
 125 #   define VLC_THREAD_PRIORITY_HIGHEST 0
 126
 127 #endif
 128
 129 /*****************************************************************************
 130  * Type definitions
 131  *****************************************************************************/
 132
 133 #if defined( PTH_INIT_IN_PTH_H )
 134 typedef pth_t            vlc_thread_t;
 135 typedef struct
 136 {
 137     pth_mutex_t mutex;
 138     vlc_object_t * p_this;
 139 } vlc_mutex_t;
 140 typedef struct
 141 {
 142     pth_cond_t cond;
 143     vlc_object_t * p_this;
 144 } vlc_cond_t;
 145 typedef struct
 146 {
 147     int handle;
 148 } vlc_threadvar_t;
 149
 150 #elif defined( ST_INIT_IN_ST_H )
 151 typedef st_thread_t      vlc_thread_t;
 152 typedef struct
 153 {
 154     st_mutex_t mutex;
 155     vlc_object_t * p_this;
 156 } vlc_mutex_t;
 157 typedef struct
 158 {
 159     st_cond_t cond;
 160     vlc_object_t * p_this;
 161 } vlc_cond_t;
 162 typedef struct
 163 {
 164     int handle;
 165 } vlc_threadvar_t;
 166
 167 #elif defined( WIN32 ) || defined( UNDER_CE )
 168 typedef HANDLE vlc_thread_t;
 169 typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL );
 170 typedef unsigned (WINAPI *PTHREAD_START) (void *);
 171
 172 typedef struct
 173 {
 174     /* WinNT/2K/XP implementation */
 175     HANDLE              mutex;
 176     /* Win95/98/ME implementation */
 177     CRITICAL_SECTION    csection;
 178
 179     vlc_object_t * p_this;
 180 } vlc_mutex_t;
 181
 182 typedef struct
 183 {
 184     volatile int        i_waiting_threads;
 185     /* WinNT/2K/XP implementation */
 186     HANDLE              event;
 187     SIGNALOBJECTANDWAIT SignalObjectAndWait;
 188     /* Win95/98/ME implementation */
 189     HANDLE              semaphore;
 190     CRITICAL_SECTION    csection;
 191     int                 i_win9x_cv;
 192
 193     vlc_object_t * p_this;
 194 } vlc_cond_t;
 195
 196 typedef struct
 197 {
 198     DWORD   handle;
 199 } vlc_threadvar_t;
 200
 201 #elif defined( HAVE_KERNEL_SCHEDULER_H )
 202 /* This is the BeOS implementation of the vlc threads, note that the mutex is
 203  * not a real mutex and the cond_var is not like a pthread cond_var but it is
 204  * enough for what wee need */
 205
 206 typedef thread_id vlc_thread_t;
 207
 208 typedef struct
 209 {
 210     int32_t         init;
 211     sem_id          lock;
 212
 213     vlc_object_t * p_this;
 214 } vlc_mutex_t;
 215
 216 typedef struct
 217 {
 218     int32_t         init;
 219     thread_id       thread;
 220
 221     vlc_object_t * p_this;
 222 } vlc_cond_t;
 223
 224 typedef struct
 225 {
 226 } vlc_threadvar_t;
 227
 228
 229 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
 230 typedef pthread_t       vlc_thread_t;
 231 typedef struct
 232 {
 233     pthread_mutex_t mutex;
 234     vlc_object_t * p_this;
 235 } vlc_mutex_t;
 236 typedef struct
 237 {
 238     pthread_cond_t cond;
 239     vlc_object_t * p_this;
 240 } vlc_cond_t;
 241
 242 typedef struct
 243 {
 244     pthread_key_t handle;
 245 } vlc_threadvar_t;
 246
 247 #elif defined( HAVE_CTHREADS_H )
 248 typedef cthread_t       vlc_thread_t;
 249
 250 /* Those structs are the ones defined in /include/cthreads.h but we need
 251  * to handle (&foo) where foo is a (mutex_t) while they handle (foo) where
 252  * foo is a (mutex_t*) */
 253 typedef struct
 254 {
 255     spin_lock_t held;
 256     spin_lock_t lock;
 257     char *name;
 258     struct cthread_queue queue;
 259
 260     vlc_object_t * p_this;
 261 } vlc_mutex_t;
 262
 263 typedef struct
 264 {
 265     spin_lock_t lock;
 266     struct cthread_queue queue;
 267     char *name;
 268     struct cond_imp *implications;
 269
 270     vlc_object_t * p_this;
 271 } vlc_cond_t;
 272
 273 typedef struct
 274 {
 275     cthread_key_t handle;
 276 } vlc_threadvar_t;
 277
 278 #endif
 279
 280 #endif