1 /* -*- tab-width: 8; c-basic-offset: 4 -*- */
4 * MMSYTEM time functions
6 * Copyright 1993 Martin Ayotte
13 #include "multimedia.h"
16 #include "debugtools.h"
18 DEFAULT_DEBUG_CHANNEL(mmtime
)
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!
26 #define MMSYSTIME_MININTERVAL /* (1) */ (10)
27 #define MMSYSTIME_MAXINTERVAL (65535)
29 static void TIME_TriggerCallBack(LPWINE_TIMERENTRY lpTimer
, DWORD dwCurrent
)
31 TRACE("before CallBack (%lu)!\n", dwCurrent
);
32 TRACE("lpFunc=%p wTimerID=%04X dwUser=%08lX !\n",
33 lpTimer
->lpFunc
, lpTimer
->wTimerID
, lpTimer
->dwUser
);
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.
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);
45 Callbacks
->CallTimeFuncProc(lpTimer
->lpFunc
,
47 lpTimer
->dwUser
, 0, 0);
49 case TIME_CALLBACK_EVENT_SET
:
50 SetEvent((HANDLE
)lpTimer
->lpFunc
);
52 case TIME_CALLBACK_EVENT_PULSE
:
53 PulseEvent((HANDLE
)lpTimer
->lpFunc
);
56 FIXME("Unknown callback type 0x%04x for mmtime callback (%p), ignored.\n", lpTimer
->wFlags
, lpTimer
->lpFunc
);
59 TRACE("after CallBack !\n");
62 /**************************************************************************
63 * TIME_MMSysTimeCallback
65 static void CALLBACK
TIME_MMSysTimeCallback(ULONG_PTR ptr_
)
67 LPWINE_TIMERENTRY lpTimer
, lpNextTimer
;
68 LPWINE_MM_IDATA iData
= (LPWINE_MM_IDATA
)ptr_
;
71 iData
->mmSysTimeMS
+= MMSYSTIME_MININTERVAL
;
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
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...
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)
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,
102 ++iData
->nSizeLpTimers
* sizeof(WINE_TIMERENTRY
));
104 iData
->lpTimers
[idx
++] = *lpTimer
;
106 if (lpTimer
->wFlags
& TIME_ONESHOT
)
107 timeKillEvent(lpTimer
->wTimerID
);
109 lpTimer
->wCurTime
-= MMSYSTIME_MININTERVAL
;
111 lpTimer
= lpNextTimer
;
113 LeaveCriticalSection(&iData
->cs
);
116 TIME_TriggerCallBack(iData
->lpTimers
+ --idx
, iData
->mmSysTimeMS
);
120 /**************************************************************************
121 * MULTIMEDIA_MMTimeStart [internal]
123 static LPWINE_MM_IDATA
MULTIMEDIA_MMTimeStart(void)
125 LPWINE_MM_IDATA iData
= MULTIMEDIA_GetIData();
127 if (!iData
|| IsBadWritePtr(iData
, sizeof(WINE_MM_IDATA
))) {
128 ERR("iData is not correctly set, please report. Expect failure.\n");
131 /* FIXME: the service timer is never killed, even when process is
132 * detached from this DLL
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.
138 if (!iData
->hMMTimer
) {
139 iData
->mmSysTimeMS
= GetTickCount();
140 iData
->lpTimerList
= NULL
;
141 iData
->hMMTimer
= SERVICE_AddTimer(MMSYSTIME_MININTERVAL
*1000L, TIME_MMSysTimeCallback
, (DWORD
)iData
);
147 /**************************************************************************
148 * timeGetSystemTime [WINMM.140]
150 MMRESULT WINAPI
timeGetSystemTime(LPMMTIME lpTime
, UINT wSize
)
152 LPWINE_MM_IDATA iData
;
154 TRACE("(%p, %u);\n", lpTime
, wSize
);
156 if (wSize
>= sizeof(*lpTime
)) {
157 iData
= MULTIMEDIA_MMTimeStart();
159 return MMSYSERR_NOMEM
;
160 lpTime
->wType
= TIME_MS
;
161 lpTime
->u
.ms
= iData
->mmSysTimeMS
;
163 TRACE("=> %lu\n", iData
->mmSysTimeMS
);
169 /**************************************************************************
170 * timeGetSystemTime [MMSYSTEM.601]
172 MMRESULT16 WINAPI
timeGetSystemTime16(LPMMTIME16 lpTime
, UINT16 wSize
)
174 LPWINE_MM_IDATA iData
;
176 TRACE("(%p, %u);\n", lpTime
, wSize
);
178 if (wSize
>= sizeof(*lpTime
)) {
179 iData
= MULTIMEDIA_MMTimeStart();
181 return MMSYSERR_NOMEM
;
182 lpTime
->wType
= TIME_MS
;
183 lpTime
->u
.ms
= iData
->mmSysTimeMS
;
185 TRACE("=> %lu\n", iData
->mmSysTimeMS
);
191 /**************************************************************************
192 * timeSetEventInternal [internal]
194 static WORD
timeSetEventInternal(UINT wDelay
, UINT wResol
,
195 FARPROC16 lpFunc
, DWORD dwUser
, UINT wFlags
)
198 LPWINE_TIMERENTRY lpNewTimer
;
199 LPWINE_TIMERENTRY lpTimer
;
200 LPWINE_MM_IDATA iData
;
202 TRACE("(%u, %u, %p, %08lX, %04X);\n", wDelay
, wResol
, lpFunc
, dwUser
, wFlags
);
204 lpNewTimer
= (LPWINE_TIMERENTRY
)HeapAlloc(GetProcessHeap(), 0, sizeof(WINE_TIMERENTRY
));
205 if (lpNewTimer
== NULL
)
208 if (wDelay
< MMSYSTIME_MININTERVAL
|| wDelay
> MMSYSTIME_MAXINTERVAL
)
211 iData
= MULTIMEDIA_MMTimeStart();
216 lpNewTimer
->wCurTime
= wDelay
;
217 lpNewTimer
->wDelay
= wDelay
;
218 lpNewTimer
->wResol
= wResol
;
219 lpNewTimer
->lpFunc
= lpFunc
;
220 lpNewTimer
->dwUser
= dwUser
;
221 lpNewTimer
->wFlags
= wFlags
;
223 TRACE("lpFunc=0x%08lx !\n", (DWORD
)lpFunc
);
225 EnterCriticalSection(&iData
->cs
);
227 for (lpTimer
= iData
->lpTimerList
; lpTimer
!= NULL
; lpTimer
= lpTimer
->lpNext
) {
228 wNewID
= MAX(wNewID
, lpTimer
->wTimerID
);
231 lpNewTimer
->lpNext
= iData
->lpTimerList
;
232 iData
->lpTimerList
= lpNewTimer
;
233 lpNewTimer
->wTimerID
= wNewID
+ 1;
235 LeaveCriticalSection(&iData
->cs
);
240 /**************************************************************************
241 * timeSetEvent [MMSYSTEM.602]
243 MMRESULT WINAPI
timeSetEvent(UINT wDelay
, UINT wResol
, LPTIMECALLBACK lpFunc
,
244 DWORD dwUser
, UINT wFlags
)
246 if (wFlags
& WINE_TIMER_IS32
)
247 WARN("Unknown windows flag... wine internally used.. ooch\n");
249 return timeSetEventInternal(wDelay
, wResol
, (FARPROC16
)lpFunc
,
250 dwUser
, wFlags
|WINE_TIMER_IS32
);
253 /**************************************************************************
254 * timeSetEvent [MMSYSTEM.602]
256 MMRESULT16 WINAPI
timeSetEvent16(UINT16 wDelay
, UINT16 wResol
, LPTIMECALLBACK16 lpFunc
,
257 DWORD dwUser
, UINT16 wFlags
)
259 if (wFlags
& WINE_TIMER_IS32
)
260 WARN("Unknown windows flag... wine internally used.. ooch\n");
262 return timeSetEventInternal(wDelay
, wResol
, (FARPROC16
)lpFunc
,
263 dwUser
, wFlags
& ~WINE_TIMER_IS32
);
266 /**************************************************************************
267 * timeKillEvent [WINMM.142]
269 MMRESULT WINAPI
timeKillEvent(UINT wID
)
271 LPWINE_TIMERENTRY
* lpTimer
;
272 LPWINE_MM_IDATA iData
= MULTIMEDIA_GetIData();
273 MMRESULT ret
= MMSYSERR_INVALPARAM
;
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
;
283 LeaveCriticalSection(&iData
->cs
);
286 HeapFree(GetProcessHeap(), 0, *lpTimer
);
287 ret
= TIMERR_NOERROR
;
293 /**************************************************************************
294 * timeKillEvent [MMSYSTEM.603]
296 MMRESULT16 WINAPI
timeKillEvent16(UINT16 wID
)
298 return timeKillEvent(wID
);
301 /**************************************************************************
302 * timeGetDevCaps [WINMM.139]
304 MMRESULT WINAPI
timeGetDevCaps(LPTIMECAPS lpCaps
, UINT wSize
)
306 TRACE("(%p, %u) !\n", lpCaps
, wSize
);
308 lpCaps
->wPeriodMin
= MMSYSTIME_MININTERVAL
;
309 lpCaps
->wPeriodMax
= MMSYSTIME_MAXINTERVAL
;
313 /**************************************************************************
314 * timeGetDevCaps [MMSYSTEM.604]
316 MMRESULT16 WINAPI
timeGetDevCaps16(LPTIMECAPS16 lpCaps
, UINT16 wSize
)
318 TRACE("(%p, %u) !\n", lpCaps
, wSize
);
320 lpCaps
->wPeriodMin
= MMSYSTIME_MININTERVAL
;
321 lpCaps
->wPeriodMax
= MMSYSTIME_MAXINTERVAL
;
325 /**************************************************************************
326 * timeBeginPeriod [WINMM.137]
328 MMRESULT WINAPI
timeBeginPeriod(UINT wPeriod
)
330 TRACE("(%u) !\n", wPeriod
);
332 if (wPeriod
< MMSYSTIME_MININTERVAL
|| wPeriod
> MMSYSTIME_MAXINTERVAL
)
333 return TIMERR_NOCANDO
;
337 /**************************************************************************
338 * timeBeginPeriod16 [MMSYSTEM.605]
340 MMRESULT16 WINAPI
timeBeginPeriod16(UINT16 wPeriod
)
342 TRACE("(%u) !\n", wPeriod
);
344 if (wPeriod
< MMSYSTIME_MININTERVAL
|| wPeriod
> MMSYSTIME_MAXINTERVAL
)
345 return TIMERR_NOCANDO
;
349 /**************************************************************************
350 * timeEndPeriod [WINMM.138]
352 MMRESULT WINAPI
timeEndPeriod(UINT wPeriod
)
354 TRACE("(%u) !\n", wPeriod
);
356 if (wPeriod
< MMSYSTIME_MININTERVAL
|| wPeriod
> MMSYSTIME_MAXINTERVAL
)
357 return TIMERR_NOCANDO
;
361 /**************************************************************************
362 * timeEndPeriod16 [MMSYSTEM.606]
364 MMRESULT16 WINAPI
timeEndPeriod16(UINT16 wPeriod
)
366 TRACE("(%u) !\n", wPeriod
);
368 if (wPeriod
< MMSYSTIME_MININTERVAL
|| wPeriod
> MMSYSTIME_MAXINTERVAL
)
369 return TIMERR_NOCANDO
;
373 /**************************************************************************
374 * timeGetTime [MMSYSTEM.607][WINMM.141]
376 DWORD WINAPI
timeGetTime(void)
378 return MULTIMEDIA_MMTimeStart()->mmSysTimeMS
;