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( 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 #   define _APPLE_C_SOURCE    1 /* Proper pthread semantics on OSX */
  57
  58 #   include <unistd.h> /* _POSIX_SPIN_LOCKS */
  59 #   include <pthread.h>
  60     /* Needed for pthread_cond_timedwait */
  61 #   include <errno.h>
  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( ST_INIT_IN_ST_H )
 131 typedef st_thread_t      vlc_thread_t;
 132 typedef struct
 133 {
 134     st_mutex_t mutex;
 135     vlc_object_t * p_this;
 136 } vlc_mutex_t;
 137 typedef struct
 138 {
 139     st_cond_t cond;
 140     vlc_object_t * p_this;
 141 } vlc_cond_t;
 142 typedef struct
 143 {
 144     int handle;
 145 } vlc_threadvar_t;
 146
 147 #elif defined( WIN32 ) || defined( UNDER_CE )
 148 typedef struct
 149 {
 150     /* thread id */
 151     DWORD  id;
 152     /*
 153     ** handle to created thread, needs be closed to dispose of it
 154     ** even after thread has exited
 155     */
 156     HANDLE hThread;
 157 } vlc_thread_t;
 158
 159 typedef BOOL (WINAPI *SIGNALOBJECTANDWAIT) ( HANDLE, HANDLE, DWORD, BOOL );
 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 typedef struct
 186 {
 187     DWORD   handle;
 188 } vlc_threadvar_t;
 189
 190 #elif defined( HAVE_KERNEL_SCHEDULER_H )
 191 /* This is the BeOS implementation of the vlc threads, note that the mutex is
 192  * not a real mutex and the cond_var is not like a pthread cond_var but it is
 193  * enough for what we need */
 194
 195 typedef thread_id vlc_thread_t;
 196
 197 typedef struct
 198 {
 199     int32_t         init;
 200     sem_id          lock;
 201
 202     vlc_object_t * p_this;
 203 } vlc_mutex_t;
 204
 205 typedef struct
 206 {
 207     int32_t         init;
 208     thread_id       thread;
 209
 210     vlc_object_t * p_this;
 211 } vlc_cond_t;
 212
 213 typedef struct
 214 {
 215 } vlc_threadvar_t;
 216
 217
 218 #elif defined( PTHREAD_COND_T_IN_PTHREAD_H )
 219 typedef pthread_t       vlc_thread_t;
 220 typedef struct
 221 {
 222     pthread_mutex_t mutex;
 223     vlc_object_t * p_this;
 224 } vlc_mutex_t;
 225 typedef struct
 226 {
 227     pthread_cond_t cond;
 228     vlc_object_t * p_this;
 229 } vlc_cond_t;
 230
 231 typedef struct
 232 {
 233     pthread_key_t handle;
 234 } vlc_threadvar_t;
 235
 236 #elif defined( HAVE_CTHREADS_H )
 237 typedef cthread_t       vlc_thread_t;
 238
 239 /* Those structs are the ones defined in /include/cthreads.h but we need
 240  * to handle (&foo) where foo is a (mutex_t) while they handle (foo) where
 241  * foo is a (mutex_t*) */
 242 typedef struct
 243 {
 244     spin_lock_t held;
 245     spin_lock_t lock;
 246     char *name;
 247     struct cthread_queue queue;
 248
 249     vlc_object_t * p_this;
 250 } vlc_mutex_t;
 251
 252 typedef struct
 253 {
 254     spin_lock_t lock;
 255     struct cthread_queue queue;
 256     char *name;
 257     struct cond_imp *implications;
 258
 259     vlc_object_t * p_this;
 260 } vlc_cond_t;
 261
 262 typedef struct
 263 {
 264     cthread_key_t handle;
 265 } vlc_threadvar_t;
 266
 267 #endif
 268
 269 #endif