multimedia/time.c

   1 /* -*- tab-width: 8; c-basic-offset: 4 -*- */
   2
   3 /*
   4  * MMSYTEM time functions
   5  *
   6  * Copyright 1993 Martin Ayotte
   7  */
   8
   9 #include <time.h>
  10 #include <sys/time.h>
  11 #include "winbase.h"
  12 #include "callback.h"
  13 #include "multimedia.h"
  14 #include "services.h"
  15 #include "syslevel.h"
  16 #include "debugtools.h"
  17
  18 DEFAULT_DEBUG_CHANNEL(mmtime)
  19
  20 /*
  21  * FIXME
  22  * We're using "1" as the mininum resolution to the timer,
  23  * as Windows 95 does, according to the docs. Maybe it should
  24  * depend on the computers resources!
  25  */
  26 #define MMSYSTIME_MININTERVAL /* (1) */ (10)
  27 #define MMSYSTIME_MAXINTERVAL (65535)
  28
  29 static  void    TIME_TriggerCallBack(LPWINE_TIMERENTRY lpTimer, DWORD dwCurrent)
  30 {
  31     TRACE("before CallBack (%lu)!\n", dwCurrent);
  32     TRACE("lpFunc=%p wTimerID=%04X dwUser=%08lX !\n",
  33           lpTimer->lpFunc, lpTimer->wTimerID, lpTimer->dwUser);
  34
  35     /* - TimeProc callback that is called here is something strange, under Windows 3.1x it is called
  36      *          during interrupt time,  is allowed to execute very limited number of API calls (like
  37      *          PostMessage), and must reside in DLL (therefore uses stack of active application). So I
  38      *       guess current implementation via SetTimer has to be improved upon.
  39      */
  40     switch (lpTimer->wFlags & 0x30) {
  41     case TIME_CALLBACK_FUNCTION:
  42         if (lpTimer->wFlags & WINE_TIMER_IS32)
  43             ((LPTIMECALLBACK)lpTimer->lpFunc)(lpTimer->wTimerID, 0, lpTimer->dwUser, 0, 0);
  44         else
  45             Callbacks->CallTimeFuncProc(lpTimer->lpFunc,
  46                                         lpTimer->wTimerID, 0,
  47                                         lpTimer->dwUser, 0, 0);
  48         break;
  49     case TIME_CALLBACK_EVENT_SET:
  50         SetEvent((HANDLE)lpTimer->lpFunc);
  51         break;
  52     case TIME_CALLBACK_EVENT_PULSE:
  53         PulseEvent((HANDLE)lpTimer->lpFunc);
  54         break;
  55     default:
  56         FIXME("Unknown callback type 0x%04x for mmtime callback (%p), ignored.\n", lpTimer->wFlags, lpTimer->lpFunc);
  57         break;
  58     }
  59     TRACE("after CallBack !\n");
  60 }
  61
  62 /**************************************************************************
  63  *           TIME_MMSysTimeCallback
  64  */
  65 static void CALLBACK TIME_MMSysTimeCallback(ULONG_PTR ptr_)
  66 {
  67     LPWINE_TIMERENTRY   lpTimer, lpNextTimer;
  68     LPWINE_MM_IDATA     iData = (LPWINE_MM_IDATA)ptr_;
  69     int                 idx;
  70
  71     iData->mmSysTimeMS += MMSYSTIME_MININTERVAL;
  72
  73     /* since timeSetEvent() and timeKillEvent() can be called
  74      * from 16 bit code, there are cases where win16 lock is
  75      * locked upon entering timeSetEvent(), and then the mm timer
  76      * critical section is locked. This function cannot call the
  77      * timer callback with the crit sect locked (because callback
  78      * may need to acquire Win16 lock, thus providing a deadlock
  79      * situation).
  80      * To cope with that, we just copy the WINE_TIMERENTRY struct
  81      * that need to trigger the callback, and call it without the
  82      * mm timer crit sect locked. The bad side of this
  83      * implementation is that, in some cases, the callback may be
  84      * invoked *after* a timer has been destroyed...
  85      * EPP 99/07/13
  86      */
  87     idx = 0;
  88
  89     EnterCriticalSection(&iData->cs);
  90     for (lpTimer = iData->lpTimerList; lpTimer != NULL; ) {
  91         lpNextTimer = lpTimer->lpNext;
  92         if (lpTimer->wCurTime < MMSYSTIME_MININTERVAL) {
  93             /* since lpTimer->wDelay is >= MININTERVAL, wCurTime value
  94              * shall be correct (>= 0)
  95              */
  96             lpTimer->wCurTime += lpTimer->wDelay - MMSYSTIME_MININTERVAL;
  97             if (lpTimer->lpFunc) {
  98                 if (idx == iData->nSizeLpTimers) {
  99                     iData->lpTimers = (LPWINE_TIMERENTRY)
 100                         HeapReAlloc(GetProcessHeap(), 0,
 101                                     iData->lpTimers,
 102                                     ++iData->nSizeLpTimers * sizeof(WINE_TIMERENTRY));
 103                 }
 104                 iData->lpTimers[idx++] = *lpTimer;
 105             }
 106             if (lpTimer->wFlags & TIME_ONESHOT)
 107                 timeKillEvent(lpTimer->wTimerID);
 108         } else {
 109             lpTimer->wCurTime -= MMSYSTIME_MININTERVAL;
 110         }
 111         lpTimer = lpNextTimer;
 112     }
 113     LeaveCriticalSection(&iData->cs);
 114
 115     while (idx > 0) {
 116         TIME_TriggerCallBack(iData->lpTimers + --idx, iData->mmSysTimeMS);
 117     }
 118 }
 119
 120 /**************************************************************************
 121  *                              MULTIMEDIA_MMTimeStart          [internal]
 122  */
 123 static  LPWINE_MM_IDATA MULTIMEDIA_MMTimeStart(void)
 124 {
 125     LPWINE_MM_IDATA     iData = MULTIMEDIA_GetIData();
 126
 127     if (!iData || IsBadWritePtr(iData, sizeof(WINE_MM_IDATA))) {
 128         ERR("iData is not correctly set, please report. Expect failure.\n");
 129         return 0;
 130     }
 131     /* FIXME: the service timer is never killed, even when process is
 132      * detached from this DLL
 133      */
 134     /* one could think it's possible to stop the service thread activity when no more
 135      * mm timers are active, but this would require to keep mmSysTimeMS up-to-date
 136      * without being incremented within the service thread callback.
 137      */
 138     if (!iData->hMMTimer) {
 139         iData->mmSysTimeMS = GetTickCount();
 140         iData->lpTimerList = NULL;
 141         iData->hMMTimer = SERVICE_AddTimer(MMSYSTIME_MININTERVAL*1000L, TIME_MMSysTimeCallback, (DWORD)iData);
 142     }
 143
 144     return iData;
 145 }
 146
 147 /**************************************************************************
 148  *                              timeGetSystemTime       [WINMM.140]
 149  */
 150 MMRESULT WINAPI timeGetSystemTime(LPMMTIME lpTime, UINT wSize)
 151 {
 152     LPWINE_MM_IDATA     iData;
 153
 154     TRACE("(%p, %u);\n", lpTime, wSize);
 155
 156     if (wSize >= sizeof(*lpTime)) {
 157         iData = MULTIMEDIA_MMTimeStart();
 158         if (!iData)
 159             return MMSYSERR_NOMEM;
 160         lpTime->wType = TIME_MS;
 161         lpTime->u.ms = iData->mmSysTimeMS;
 162
 163         TRACE("=> %lu\n", iData->mmSysTimeMS);
 164     }
 165
 166     return 0;
 167 }
 168
 169 /**************************************************************************
 170  *                              timeGetSystemTime       [MMSYSTEM.601]
 171  */
 172 MMRESULT16 WINAPI timeGetSystemTime16(LPMMTIME16 lpTime, UINT16 wSize)
 173 {
 174     LPWINE_MM_IDATA     iData;
 175
 176     TRACE("(%p, %u);\n", lpTime, wSize);
 177
 178     if (wSize >= sizeof(*lpTime)) {
 179         iData = MULTIMEDIA_MMTimeStart();
 180         if (!iData)
 181             return MMSYSERR_NOMEM;
 182         lpTime->wType = TIME_MS;
 183         lpTime->u.ms = iData->mmSysTimeMS;
 184
 185         TRACE("=> %lu\n", iData->mmSysTimeMS);
 186     }
 187
 188     return 0;
 189 }
 190
 191 /**************************************************************************
 192  *                              timeSetEventInternal    [internal]
 193  */
 194 static  WORD    timeSetEventInternal(UINT wDelay, UINT wResol,
 195                                      FARPROC16 lpFunc, DWORD dwUser, UINT wFlags)
 196 {
 197     WORD                wNewID = 0;
 198     LPWINE_TIMERENTRY   lpNewTimer;
 199     LPWINE_TIMERENTRY   lpTimer;
 200     LPWINE_MM_IDATA     iData;
 201
 202     TRACE("(%u, %u, %p, %08lX, %04X);\n", wDelay, wResol, lpFunc, dwUser, wFlags);
 203
 204     lpNewTimer = (LPWINE_TIMERENTRY)HeapAlloc(GetProcessHeap(), 0, sizeof(WINE_TIMERENTRY));
 205     if (lpNewTimer == NULL)
 206         return 0;
 207
 208     if (wDelay < MMSYSTIME_MININTERVAL || wDelay > MMSYSTIME_MAXINTERVAL)
 209         return 0;
 210
 211     iData = MULTIMEDIA_MMTimeStart();
 212
 213     if (!iData)
 214         return 0;
 215
 216     lpNewTimer->wCurTime = wDelay;
 217     lpNewTimer->wDelay = wDelay;
 218     lpNewTimer->wResol = wResol;
 219     lpNewTimer->lpFunc = lpFunc;
 220     lpNewTimer->dwUser = dwUser;
 221     lpNewTimer->wFlags = wFlags;
 222
 223     TRACE("lpFunc=0x%08lx !\n", (DWORD)lpFunc);
 224
 225     EnterCriticalSection(&iData->cs);
 226
 227     for (lpTimer = iData->lpTimerList; lpTimer != NULL; lpTimer = lpTimer->lpNext) {
 228         wNewID = MAX(wNewID, lpTimer->wTimerID);
 229     }
 230
 231     lpNewTimer->lpNext = iData->lpTimerList;
 232     iData->lpTimerList = lpNewTimer;
 233     lpNewTimer->wTimerID = wNewID + 1;
 234
 235     LeaveCriticalSection(&iData->cs);
 236
 237     return wNewID + 1;
 238 }
 239
 240 /**************************************************************************
 241  *                              timeSetEvent            [MMSYSTEM.602]
 242  */
 243 MMRESULT WINAPI timeSetEvent(UINT wDelay, UINT wResol, LPTIMECALLBACK lpFunc,
 244                              DWORD dwUser, UINT wFlags)
 245 {
 246     if (wFlags & WINE_TIMER_IS32)
 247         WARN("Unknown windows flag... wine internally used.. ooch\n");
 248
 249     return timeSetEventInternal(wDelay, wResol, (FARPROC16)lpFunc,
 250                                 dwUser, wFlags|WINE_TIMER_IS32);
 251 }
 252
 253 /**************************************************************************
 254  *                              timeSetEvent            [MMSYSTEM.602]
 255  */
 256 MMRESULT16 WINAPI timeSetEvent16(UINT16 wDelay, UINT16 wResol, LPTIMECALLBACK16 lpFunc,
 257                                  DWORD dwUser, UINT16 wFlags)
 258 {
 259     if (wFlags & WINE_TIMER_IS32)
 260         WARN("Unknown windows flag... wine internally used.. ooch\n");
 261
 262     return timeSetEventInternal(wDelay, wResol, (FARPROC16)lpFunc,
 263                                 dwUser, wFlags & ~WINE_TIMER_IS32);
 264 }
 265
 266 /**************************************************************************
 267  *                              timeKillEvent           [WINMM.142]
 268  */
 269 MMRESULT WINAPI timeKillEvent(UINT wID)
 270 {
 271     LPWINE_TIMERENTRY*  lpTimer;
 272     LPWINE_MM_IDATA     iData = MULTIMEDIA_GetIData();
 273     MMRESULT            ret = MMSYSERR_INVALPARAM;
 274
 275     EnterCriticalSection(&iData->cs);
 276     /* remove WINE_TIMERENTRY from list */
 277     for (lpTimer = &iData->lpTimerList; *lpTimer; lpTimer = &((*lpTimer)->lpNext)) {
 278         if (wID == (*lpTimer)->wTimerID) {
 279             *lpTimer = (*lpTimer)->lpNext;
 280             break;
 281         }
 282     }
 283     LeaveCriticalSection(&iData->cs);
 284
 285     if (*lpTimer) {
 286         HeapFree(GetProcessHeap(), 0, *lpTimer);
 287         ret = TIMERR_NOERROR;
 288     }
 289
 290     return ret;
 291 }
 292
 293 /**************************************************************************
 294  *                              timeKillEvent           [MMSYSTEM.603]
 295  */
 296 MMRESULT16 WINAPI timeKillEvent16(UINT16 wID)
 297 {
 298     return timeKillEvent(wID);
 299 }
 300
 301 /**************************************************************************
 302  *                              timeGetDevCaps          [WINMM.139]
 303  */
 304 MMRESULT WINAPI timeGetDevCaps(LPTIMECAPS lpCaps, UINT wSize)
 305 {
 306     TRACE("(%p, %u) !\n", lpCaps, wSize);
 307
 308     lpCaps->wPeriodMin = MMSYSTIME_MININTERVAL;
 309     lpCaps->wPeriodMax = MMSYSTIME_MAXINTERVAL;
 310     return 0;
 311 }
 312
 313 /**************************************************************************
 314  *                              timeGetDevCaps          [MMSYSTEM.604]
 315  */
 316 MMRESULT16 WINAPI timeGetDevCaps16(LPTIMECAPS16 lpCaps, UINT16 wSize)
 317 {
 318     TRACE("(%p, %u) !\n", lpCaps, wSize);
 319
 320     lpCaps->wPeriodMin = MMSYSTIME_MININTERVAL;
 321     lpCaps->wPeriodMax = MMSYSTIME_MAXINTERVAL;
 322     return 0;
 323 }
 324
 325 /**************************************************************************
 326  *                              timeBeginPeriod         [WINMM.137]
 327  */
 328 MMRESULT WINAPI timeBeginPeriod(UINT wPeriod)
 329 {
 330     TRACE("(%u) !\n", wPeriod);
 331
 332     if (wPeriod < MMSYSTIME_MININTERVAL || wPeriod > MMSYSTIME_MAXINTERVAL)
 333         return TIMERR_NOCANDO;
 334     return 0;
 335 }
 336
 337 /**************************************************************************
 338  *                              timeBeginPeriod16       [MMSYSTEM.605]
 339  */
 340 MMRESULT16 WINAPI timeBeginPeriod16(UINT16 wPeriod)
 341 {
 342     TRACE("(%u) !\n", wPeriod);
 343
 344     if (wPeriod < MMSYSTIME_MININTERVAL || wPeriod > MMSYSTIME_MAXINTERVAL)
 345         return TIMERR_NOCANDO;
 346     return 0;
 347 }
 348
 349 /**************************************************************************
 350  *                              timeEndPeriod           [WINMM.138]
 351  */
 352 MMRESULT WINAPI timeEndPeriod(UINT wPeriod)
 353 {
 354     TRACE("(%u) !\n", wPeriod);
 355
 356     if (wPeriod < MMSYSTIME_MININTERVAL || wPeriod > MMSYSTIME_MAXINTERVAL)
 357         return TIMERR_NOCANDO;
 358     return 0;
 359 }
 360
 361 /**************************************************************************
 362  *                              timeEndPeriod16         [MMSYSTEM.606]
 363  */
 364 MMRESULT16 WINAPI timeEndPeriod16(UINT16 wPeriod)
 365 {
 366     TRACE("(%u) !\n", wPeriod);
 367
 368     if (wPeriod < MMSYSTIME_MININTERVAL || wPeriod > MMSYSTIME_MAXINTERVAL)
 369         return TIMERR_NOCANDO;
 370     return 0;
 371 }
 372
 373 /**************************************************************************
 374  *                              timeGetTime    [MMSYSTEM.607][WINMM.141]
 375  */
 376 DWORD WINAPI timeGetTime(void)
 377 {
 378     return MULTIMEDIA_MMTimeStart()->mmSysTimeMS;
 379 }