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