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