dsound: Fix type conversion problems.
[wine] / dlls / dsound / mixer.c
1 /*                      DirectSound
2  *
3  * Copyright 1998 Marcus Meissner
4  * Copyright 1998 Rob Riggs
5  * Copyright 2000-2002 TransGaming Technologies, Inc.
6  * Copyright 2007 Peter Dons Tychsen
7  * Copyright 2007 Maarten Lankhorst
8  * Copyright 2011 Owen Rudge for CodeWeavers
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24
25 #include <assert.h>
26 #include <stdarg.h>
27 #include <math.h>       /* Insomnia - pow() function */
28
29 #define COBJMACROS
30 #define NONAMELESSSTRUCT
31 #define NONAMELESSUNION
32 #include "windef.h"
33 #include "winbase.h"
34 #include "mmsystem.h"
35 #include "wingdi.h"
36 #include "mmreg.h"
37 #include "winternl.h"
38 #include "wine/debug.h"
39 #include "dsound.h"
40 #include "ks.h"
41 #include "ksmedia.h"
42 #include "dsound_private.h"
43
44 WINE_DEFAULT_DEBUG_CHANNEL(dsound);
45
46 void DSOUND_RecalcVolPan(PDSVOLUMEPAN volpan)
47 {
48         double temp;
49         TRACE("(%p)\n",volpan);
50
51         TRACE("Vol=%d Pan=%d\n", volpan->lVolume, volpan->lPan);
52         /* the AmpFactors are expressed in 16.16 fixed point */
53         volpan->dwVolAmpFactor = (ULONG) (pow(2.0, volpan->lVolume / 600.0) * 0xffff);
54         /* FIXME: dwPan{Left|Right}AmpFactor */
55
56         /* FIXME: use calculated vol and pan ampfactors */
57         temp = (double) (volpan->lVolume - (volpan->lPan > 0 ? volpan->lPan : 0));
58         volpan->dwTotalLeftAmpFactor = (ULONG) (pow(2.0, temp / 600.0) * 0xffff);
59         temp = (double) (volpan->lVolume + (volpan->lPan < 0 ? volpan->lPan : 0));
60         volpan->dwTotalRightAmpFactor = (ULONG) (pow(2.0, temp / 600.0) * 0xffff);
61
62         TRACE("left = %x, right = %x\n", volpan->dwTotalLeftAmpFactor, volpan->dwTotalRightAmpFactor);
63 }
64
65 void DSOUND_AmpFactorToVolPan(PDSVOLUMEPAN volpan)
66 {
67     double left,right;
68     TRACE("(%p)\n",volpan);
69
70     TRACE("left=%x, right=%x\n",volpan->dwTotalLeftAmpFactor,volpan->dwTotalRightAmpFactor);
71     if (volpan->dwTotalLeftAmpFactor==0)
72         left=-10000;
73     else
74         left=600 * log(((double)volpan->dwTotalLeftAmpFactor) / 0xffff) / log(2);
75     if (volpan->dwTotalRightAmpFactor==0)
76         right=-10000;
77     else
78         right=600 * log(((double)volpan->dwTotalRightAmpFactor) / 0xffff) / log(2);
79     if (left<right)
80     {
81         volpan->lVolume=right;
82         volpan->dwVolAmpFactor=volpan->dwTotalRightAmpFactor;
83     }
84     else
85     {
86         volpan->lVolume=left;
87         volpan->dwVolAmpFactor=volpan->dwTotalLeftAmpFactor;
88     }
89     if (volpan->lVolume < -10000)
90         volpan->lVolume=-10000;
91     volpan->lPan=right-left;
92     if (volpan->lPan < -10000)
93         volpan->lPan=-10000;
94
95     TRACE("Vol=%d Pan=%d\n", volpan->lVolume, volpan->lPan);
96 }
97
98 /** Convert a primary buffer position to a pointer position for device->mix_buffer
99  * device: DirectSoundDevice for which to calculate
100  * pos: Primary buffer position to converts
101  * Returns: Offset for mix_buffer
102  */
103 DWORD DSOUND_bufpos_to_mixpos(const DirectSoundDevice* device, DWORD pos)
104 {
105     DWORD ret = pos * 32 / device->pwfx->wBitsPerSample;
106     if (device->pwfx->wBitsPerSample == 32)
107         ret *= 2;
108     return ret;
109 }
110
111 /* NOTE: Not all secpos have to always be mapped to a bufpos, other way around is always the case
112  * DWORD64 is used here because a single DWORD wouldn't be big enough to fit the freqAcc for big buffers
113  */
114 /** This function converts a 'native' sample pointer to a resampled pointer that fits for primary
115  * secmixpos is used to decide which freqAcc is needed
116  * overshot tells what the 'actual' secpos is now (optional)
117  */
118 DWORD DSOUND_secpos_to_bufpos(const IDirectSoundBufferImpl *dsb, DWORD secpos, DWORD secmixpos, DWORD* overshot)
119 {
120         DWORD64 framelen = secpos / dsb->pwfx->nBlockAlign;
121         DWORD64 freqAdjust = dsb->freqAdjust;
122         DWORD64 acc, freqAcc;
123
124         if (secpos < secmixpos)
125                 freqAcc = dsb->freqAccNext;
126         else freqAcc = dsb->freqAcc;
127         acc = (framelen << DSOUND_FREQSHIFT) + (freqAdjust - 1 - freqAcc);
128         acc /= freqAdjust;
129         if (overshot)
130         {
131                 DWORD64 oshot = acc * freqAdjust + freqAcc;
132                 assert(oshot >= framelen << DSOUND_FREQSHIFT);
133                 oshot -= framelen << DSOUND_FREQSHIFT;
134                 *overshot = (DWORD)oshot;
135                 assert(*overshot < dsb->freqAdjust);
136         }
137         return (DWORD)acc * dsb->device->pwfx->nBlockAlign;
138 }
139
140 /** Convert a resampled pointer that fits for primary to a 'native' sample pointer
141  * freqAccNext is used here rather than freqAcc: In case the app wants to fill up to
142  * the play position it won't overwrite it
143  */
144 static DWORD DSOUND_bufpos_to_secpos(const IDirectSoundBufferImpl *dsb, DWORD bufpos)
145 {
146         DWORD oAdv = dsb->device->pwfx->nBlockAlign, iAdv = dsb->pwfx->nBlockAlign, pos;
147         DWORD64 framelen;
148         DWORD64 acc;
149
150         framelen = bufpos/oAdv;
151         acc = framelen * (DWORD64)dsb->freqAdjust + (DWORD64)dsb->freqAccNext;
152         acc = acc >> DSOUND_FREQSHIFT;
153         pos = (DWORD)acc * iAdv;
154         if (pos >= dsb->buflen)
155                 /* Because of differences between freqAcc and freqAccNext, this might happen */
156                 pos = dsb->buflen - iAdv;
157         TRACE("Converted %d/%d to %d/%d\n", bufpos, dsb->tmp_buffer_len, pos, dsb->buflen);
158         return pos;
159 }
160
161 /**
162  * Move freqAccNext to freqAcc, and find new values for buffer length and freqAccNext
163  */
164 static void DSOUND_RecalcFreqAcc(IDirectSoundBufferImpl *dsb)
165 {
166         if (!dsb->freqneeded) return;
167         dsb->freqAcc = dsb->freqAccNext;
168         dsb->tmp_buffer_len = DSOUND_secpos_to_bufpos(dsb, dsb->buflen, 0, &dsb->freqAccNext);
169         TRACE("New freqadjust: %04x, new buflen: %d\n", dsb->freqAccNext, dsb->tmp_buffer_len);
170 }
171
172 /**
173  * Recalculate the size for temporary buffer, and new writelead
174  * Should be called when one of the following things occur:
175  * - Primary buffer format is changed
176  * - This buffer format (frequency) is changed
177  *
178  * After this, DSOUND_MixToTemporary(dsb, 0, dsb->buflen) should
179  * be called to refill the temporary buffer with data.
180  */
181 void DSOUND_RecalcFormat(IDirectSoundBufferImpl *dsb)
182 {
183         BOOL needremix = TRUE, needresample = (dsb->freq != dsb->device->pwfx->nSamplesPerSec);
184         DWORD bAlign = dsb->pwfx->nBlockAlign, pAlign = dsb->device->pwfx->nBlockAlign;
185         WAVEFORMATEXTENSIBLE *pwfxe;
186         BOOL ieee = FALSE;
187
188         TRACE("(%p)\n",dsb);
189
190         pwfxe = (WAVEFORMATEXTENSIBLE *) dsb->pwfx;
191
192         if ((pwfxe->Format.wFormatTag == WAVE_FORMAT_IEEE_FLOAT) || ((pwfxe->Format.wFormatTag == WAVE_FORMAT_EXTENSIBLE)
193             && (IsEqualGUID(&pwfxe->SubFormat, &KSDATAFORMAT_SUBTYPE_IEEE_FLOAT))))
194                 ieee = TRUE;
195
196         /* calculate the 10ms write lead */
197         dsb->writelead = (dsb->freq / 100) * dsb->pwfx->nBlockAlign;
198
199         if ((dsb->pwfx->wBitsPerSample == dsb->device->pwfx->wBitsPerSample) &&
200             (dsb->pwfx->nChannels == dsb->device->pwfx->nChannels) && !needresample && !ieee)
201                 needremix = FALSE;
202         HeapFree(GetProcessHeap(), 0, dsb->tmp_buffer);
203         dsb->tmp_buffer = NULL;
204         dsb->max_buffer_len = dsb->freqAcc = dsb->freqAccNext = 0;
205         dsb->freqneeded = needresample;
206
207         if (ieee)
208                 dsb->convert = convertbpp[4][dsb->device->pwfx->wBitsPerSample/8 - 1];
209         else
210                 dsb->convert = convertbpp[dsb->pwfx->wBitsPerSample/8 - 1][dsb->device->pwfx->wBitsPerSample/8 - 1];
211
212         dsb->resampleinmixer = FALSE;
213
214         if (needremix)
215         {
216                 if (needresample)
217                         DSOUND_RecalcFreqAcc(dsb);
218                 else
219                         dsb->tmp_buffer_len = dsb->buflen / bAlign * pAlign;
220                 dsb->max_buffer_len = dsb->tmp_buffer_len;
221                 if ((dsb->max_buffer_len <= dsb->device->buflen || dsb->max_buffer_len < ds_snd_shadow_maxsize * 1024 * 1024) && ds_snd_shadow_maxsize >= 0)
222                         dsb->tmp_buffer = HeapAlloc(GetProcessHeap(), 0, dsb->max_buffer_len);
223                 if (dsb->tmp_buffer)
224                         FillMemory(dsb->tmp_buffer, dsb->tmp_buffer_len, dsb->device->pwfx->wBitsPerSample == 8 ? 128 : 0);
225                 else
226                         dsb->resampleinmixer = TRUE;
227         }
228         else dsb->max_buffer_len = dsb->tmp_buffer_len = dsb->buflen;
229         dsb->buf_mixpos = DSOUND_secpos_to_bufpos(dsb, dsb->sec_mixpos, 0, NULL);
230 }
231
232 /**
233  * Check for application callback requests for when the play position
234  * reaches certain points.
235  *
236  * The offsets that will be triggered will be those between the recorded
237  * "last played" position for the buffer (i.e. dsb->playpos) and "len" bytes
238  * beyond that position.
239  */
240 void DSOUND_CheckEvent(const IDirectSoundBufferImpl *dsb, DWORD playpos, int len)
241 {
242         int                     i;
243         DWORD                   offset;
244         LPDSBPOSITIONNOTIFY     event;
245         TRACE("(%p,%d)\n",dsb,len);
246
247         if (dsb->nrofnotifies == 0)
248                 return;
249
250         TRACE("(%p) buflen = %d, playpos = %d, len = %d\n",
251                 dsb, dsb->buflen, playpos, len);
252         for (i = 0; i < dsb->nrofnotifies ; i++) {
253                 event = dsb->notifies + i;
254                 offset = event->dwOffset;
255                 TRACE("checking %d, position %d, event = %p\n",
256                         i, offset, event->hEventNotify);
257                 /* DSBPN_OFFSETSTOP has to be the last element. So this is */
258                 /* OK. [Inside DirectX, p274] */
259                 /* Windows does not seem to enforce this, and some apps rely */
260                 /* on that, so we can't stop there. */
261                 /*  */
262                 /* This also means we can't sort the entries by offset, */
263                 /* because DSBPN_OFFSETSTOP == -1 */
264                 if (offset == DSBPN_OFFSETSTOP) {
265                         if (dsb->state == STATE_STOPPED) {
266                                 SetEvent(event->hEventNotify);
267                                 TRACE("signalled event %p (%d)\n", event->hEventNotify, i);
268                         }
269                         continue;
270                 }
271                 if ((playpos + len) >= dsb->buflen) {
272                         if ((offset < ((playpos + len) % dsb->buflen)) ||
273                             (offset >= playpos)) {
274                                 TRACE("signalled event %p (%d)\n", event->hEventNotify, i);
275                                 SetEvent(event->hEventNotify);
276                         }
277                 } else {
278                         if ((offset >= playpos) && (offset < (playpos + len))) {
279                                 TRACE("signalled event %p (%d)\n", event->hEventNotify, i);
280                                 SetEvent(event->hEventNotify);
281                         }
282                 }
283         }
284 }
285
286 /**
287  * Copy a single frame from the given input buffer to the given output buffer.
288  * Translate 8 <-> 16 bits and mono <-> stereo
289  */
290 static inline void cp_fields(const IDirectSoundBufferImpl *dsb, const BYTE *ibuf, BYTE *obuf,
291         UINT istride, UINT ostride, UINT count, UINT freqAcc, UINT adj)
292 {
293     DirectSoundDevice *device = dsb->device;
294     INT istep = dsb->pwfx->wBitsPerSample / 8, ostep = device->pwfx->wBitsPerSample / 8;
295
296     if (device->pwfx->nChannels == dsb->pwfx->nChannels ||
297         (device->pwfx->nChannels == 2 && dsb->pwfx->nChannels == 6) ||
298         (device->pwfx->nChannels == 8 && dsb->pwfx->nChannels == 2) ||
299         (device->pwfx->nChannels == 6 && dsb->pwfx->nChannels == 2)) {
300         dsb->convert(ibuf, obuf, istride, ostride, count, freqAcc, adj);
301         if (device->pwfx->nChannels == 2 || dsb->pwfx->nChannels == 2)
302             dsb->convert(ibuf + istep, obuf + ostep, istride, ostride, count, freqAcc, adj);
303         return;
304     }
305
306     if (device->pwfx->nChannels == 1 && dsb->pwfx->nChannels == 2)
307     {
308         dsb->convert(ibuf, obuf, istride, ostride, count, freqAcc, adj);
309         return;
310     }
311
312     if (device->pwfx->nChannels == 2 && dsb->pwfx->nChannels == 1)
313     {
314         dsb->convert(ibuf, obuf, istride, ostride, count, freqAcc, adj);
315         dsb->convert(ibuf, obuf + ostep, istride, ostride, count, freqAcc, adj);
316         return;
317     }
318
319     WARN("Unable to remap channels: device=%u, buffer=%u\n", device->pwfx->nChannels,
320             dsb->pwfx->nChannels);
321 }
322
323 /**
324  * Calculate the distance between two buffer offsets, taking wraparound
325  * into account.
326  */
327 static inline DWORD DSOUND_BufPtrDiff(DWORD buflen, DWORD ptr1, DWORD ptr2)
328 {
329 /* If these asserts fail, the problem is not here, but in the underlying code */
330         assert(ptr1 < buflen);
331         assert(ptr2 < buflen);
332         if (ptr1 >= ptr2) {
333                 return ptr1 - ptr2;
334         } else {
335                 return buflen + ptr1 - ptr2;
336         }
337 }
338 /**
339  * Mix at most the given amount of data into the allocated temporary buffer
340  * of the given secondary buffer, starting from the dsb's first currently
341  * unsampled frame (writepos), translating frequency (pitch), stereo/mono
342  * and bits-per-sample so that it is ideal for the primary buffer.
343  * Doesn't perform any mixing - this is a straight copy/convert operation.
344  *
345  * dsb = the secondary buffer
346  * writepos = Starting position of changed buffer
347  * len = number of bytes to resample from writepos
348  *
349  * NOTE: writepos + len <= buflen. When called by mixer, MixOne makes sure of this.
350  */
351 void DSOUND_MixToTemporary(const IDirectSoundBufferImpl *dsb, DWORD writepos, DWORD len, BOOL inmixer)
352 {
353         INT     size;
354         BYTE    *ibp, *obp, *obp_begin;
355         INT     iAdvance = dsb->pwfx->nBlockAlign;
356         INT     oAdvance = dsb->device->pwfx->nBlockAlign;
357         DWORD freqAcc, target_writepos = 0, overshot, maxlen;
358
359         /* We resample only when needed */
360         if ((dsb->tmp_buffer && inmixer) || (!dsb->tmp_buffer && !inmixer) || dsb->resampleinmixer != inmixer)
361                 return;
362
363         assert(writepos + len <= dsb->buflen);
364         if (inmixer && writepos + len < dsb->buflen)
365                 len += dsb->pwfx->nBlockAlign;
366
367         maxlen = DSOUND_secpos_to_bufpos(dsb, len, 0, NULL);
368
369         ibp = dsb->buffer->memory + writepos;
370         if (!inmixer)
371                 obp_begin = dsb->tmp_buffer;
372         else if (dsb->device->tmp_buffer_len < maxlen || !dsb->device->tmp_buffer)
373         {
374                 dsb->device->tmp_buffer_len = maxlen;
375                 if (dsb->device->tmp_buffer)
376                         dsb->device->tmp_buffer = HeapReAlloc(GetProcessHeap(), 0, dsb->device->tmp_buffer, maxlen);
377                 else
378                         dsb->device->tmp_buffer = HeapAlloc(GetProcessHeap(), 0, maxlen);
379                 obp_begin = dsb->device->tmp_buffer;
380         }
381         else
382                 obp_begin = dsb->device->tmp_buffer;
383
384         TRACE("(%p, %p)\n", dsb, ibp);
385         size = len / iAdvance;
386
387         /* Check for same sample rate */
388         if (dsb->freq == dsb->device->pwfx->nSamplesPerSec) {
389                 TRACE("(%p) Same sample rate %d = primary %d\n", dsb,
390                         dsb->freq, dsb->device->pwfx->nSamplesPerSec);
391                 obp = obp_begin;
392                 if (!inmixer)
393                          obp += writepos/iAdvance*oAdvance;
394
395                 cp_fields(dsb, ibp, obp, iAdvance, oAdvance, size, 0, 1 << DSOUND_FREQSHIFT);
396                 return;
397         }
398
399         /* Mix in different sample rates */
400         TRACE("(%p) Adjusting frequency: %d -> %d\n", dsb, dsb->freq, dsb->device->pwfx->nSamplesPerSec);
401
402         target_writepos = DSOUND_secpos_to_bufpos(dsb, writepos, dsb->sec_mixpos, &freqAcc);
403         overshot = freqAcc >> DSOUND_FREQSHIFT;
404         if (overshot)
405         {
406                 if (overshot >= size)
407                         return;
408                 size -= overshot;
409                 writepos += overshot * iAdvance;
410                 if (writepos >= dsb->buflen)
411                         return;
412                 ibp = dsb->buffer->memory + writepos;
413                 freqAcc &= (1 << DSOUND_FREQSHIFT) - 1;
414                 TRACE("Overshot: %d, freqAcc: %04x\n", overshot, freqAcc);
415         }
416
417         if (!inmixer)
418                 obp = obp_begin + target_writepos;
419         else obp = obp_begin;
420
421         /* FIXME: Small problem here when we're overwriting buf_mixpos, it then STILL uses old freqAcc, not sure if it matters or not */
422         cp_fields(dsb, ibp, obp, iAdvance, oAdvance, size, freqAcc, dsb->freqAdjust);
423 }
424
425 /** Apply volume to the given soundbuffer from (primary) position writepos and length len
426  * Returns: NULL if no volume needs to be applied
427  * or else a memory handle that holds 'len' volume adjusted buffer */
428 static LPBYTE DSOUND_MixerVol(const IDirectSoundBufferImpl *dsb, INT len)
429 {
430         INT     i;
431         BYTE    *bpc;
432         INT16   *bps, *mems;
433         DWORD vLeft, vRight;
434         INT nChannels = dsb->device->pwfx->nChannels;
435         LPBYTE mem = (dsb->tmp_buffer ? dsb->tmp_buffer : dsb->buffer->memory) + dsb->buf_mixpos;
436
437         if (dsb->resampleinmixer)
438                 mem = dsb->device->tmp_buffer;
439
440         TRACE("(%p,%d)\n",dsb,len);
441         TRACE("left = %x, right = %x\n", dsb->volpan.dwTotalLeftAmpFactor,
442                 dsb->volpan.dwTotalRightAmpFactor);
443
444         if ((!(dsb->dsbd.dwFlags & DSBCAPS_CTRLPAN) || (dsb->volpan.lPan == 0)) &&
445             (!(dsb->dsbd.dwFlags & DSBCAPS_CTRLVOLUME) || (dsb->volpan.lVolume == 0)) &&
446              !(dsb->dsbd.dwFlags & DSBCAPS_CTRL3D))
447                 return NULL; /* Nothing to do */
448
449         if (nChannels != 1 && nChannels != 2)
450         {
451                 FIXME("There is no support for %d channels\n", nChannels);
452                 return NULL;
453         }
454
455         if (dsb->device->pwfx->wBitsPerSample != 8 && dsb->device->pwfx->wBitsPerSample != 16)
456         {
457                 FIXME("There is no support for %d bpp\n", dsb->device->pwfx->wBitsPerSample);
458                 return NULL;
459         }
460
461         if (dsb->device->tmp_buffer_len < len || !dsb->device->tmp_buffer)
462         {
463                 /* If we just resampled in DSOUND_MixToTemporary, we shouldn't need to resize here */
464                 assert(!dsb->resampleinmixer);
465                 dsb->device->tmp_buffer_len = len;
466                 if (dsb->device->tmp_buffer)
467                         dsb->device->tmp_buffer = HeapReAlloc(GetProcessHeap(), 0, dsb->device->tmp_buffer, len);
468                 else
469                         dsb->device->tmp_buffer = HeapAlloc(GetProcessHeap(), 0, len);
470         }
471
472         bpc = dsb->device->tmp_buffer;
473         bps = (INT16 *)bpc;
474         mems = (INT16 *)mem;
475         vLeft = dsb->volpan.dwTotalLeftAmpFactor;
476         if (nChannels > 1)
477                 vRight = dsb->volpan.dwTotalRightAmpFactor;
478         else
479                 vRight = vLeft;
480
481         switch (dsb->device->pwfx->wBitsPerSample) {
482         case 8:
483                 /* 8-bit WAV is unsigned, but we need to operate */
484                 /* on signed data for this to work properly */
485                 for (i = 0; i < len-1; i+=2) {
486                         *(bpc++) = (((*(mem++) - 128) * vLeft) >> 16) + 128;
487                         *(bpc++) = (((*(mem++) - 128) * vRight) >> 16) + 128;
488                 }
489                 if (len % 2 == 1 && nChannels == 1)
490                         *(bpc++) = (((*(mem++) - 128) * vLeft) >> 16) + 128;
491                 break;
492         case 16:
493                 /* 16-bit WAV is signed -- much better */
494                 for (i = 0; i < len-3; i += 4) {
495                         *(bps++) = (*(mems++) * vLeft) >> 16;
496                         *(bps++) = (*(mems++) * vRight) >> 16;
497                 }
498                 if (len % 4 == 2 && nChannels == 1)
499                         *(bps++) = ((INT)*(mems++) * vLeft) >> 16;
500                 break;
501         }
502         return dsb->device->tmp_buffer;
503 }
504
505 /**
506  * Mix (at most) the given number of bytes into the given position of the
507  * device buffer, from the secondary buffer "dsb" (starting at the current
508  * mix position for that buffer).
509  *
510  * Returns the number of bytes actually mixed into the device buffer. This
511  * will match fraglen unless the end of the secondary buffer is reached
512  * (and it is not looping).
513  *
514  * dsb  = the secondary buffer to mix from
515  * writepos = position (offset) in device buffer to write at
516  * fraglen = number of bytes to mix
517  */
518 static DWORD DSOUND_MixInBuffer(IDirectSoundBufferImpl *dsb, DWORD writepos, DWORD fraglen)
519 {
520         INT len = fraglen, ilen;
521         BYTE *ibuf = (dsb->tmp_buffer ? dsb->tmp_buffer : dsb->buffer->memory) + dsb->buf_mixpos, *volbuf;
522         DWORD oldpos, mixbufpos;
523
524         TRACE("buf_mixpos=%d/%d sec_mixpos=%d/%d\n", dsb->buf_mixpos, dsb->tmp_buffer_len, dsb->sec_mixpos, dsb->buflen);
525         TRACE("(%p,%d,%d)\n",dsb,writepos,fraglen);
526
527         assert(dsb->buf_mixpos + len <= dsb->tmp_buffer_len);
528
529         if (len % dsb->device->pwfx->nBlockAlign) {
530                 INT nBlockAlign = dsb->device->pwfx->nBlockAlign;
531                 ERR("length not a multiple of block size, len = %d, block size = %d\n", len, nBlockAlign);
532                 len -= len % nBlockAlign; /* data alignment */
533         }
534
535         /* Resample buffer to temporary buffer specifically allocated for this purpose, if needed */
536         DSOUND_MixToTemporary(dsb, dsb->sec_mixpos, DSOUND_bufpos_to_secpos(dsb, dsb->buf_mixpos+len) - dsb->sec_mixpos, TRUE);
537         if (dsb->resampleinmixer)
538                 ibuf = dsb->device->tmp_buffer;
539
540         /* Apply volume if needed */
541         volbuf = DSOUND_MixerVol(dsb, len);
542         if (volbuf)
543                 ibuf = volbuf;
544
545         mixbufpos = DSOUND_bufpos_to_mixpos(dsb->device, writepos);
546         /* Now mix the temporary buffer into the devices main buffer */
547         if ((writepos + len) <= dsb->device->buflen)
548                 dsb->device->mixfunction(ibuf, dsb->device->mix_buffer + mixbufpos, len);
549         else
550         {
551                 DWORD todo = dsb->device->buflen - writepos;
552                 dsb->device->mixfunction(ibuf, dsb->device->mix_buffer + mixbufpos, todo);
553                 dsb->device->mixfunction(ibuf + todo, dsb->device->mix_buffer, len - todo);
554         }
555
556         oldpos = dsb->sec_mixpos;
557         dsb->buf_mixpos += len;
558
559         if (dsb->buf_mixpos >= dsb->tmp_buffer_len) {
560                 if (dsb->buf_mixpos > dsb->tmp_buffer_len)
561                         ERR("Mixpos (%u) past buflen (%u), capping...\n", dsb->buf_mixpos, dsb->tmp_buffer_len);
562                 if (dsb->playflags & DSBPLAY_LOOPING) {
563                         dsb->buf_mixpos -= dsb->tmp_buffer_len;
564                 } else if (dsb->buf_mixpos >= dsb->tmp_buffer_len) {
565                         dsb->buf_mixpos = dsb->sec_mixpos = 0;
566                         dsb->state = STATE_STOPPED;
567                 }
568                 DSOUND_RecalcFreqAcc(dsb);
569         }
570
571         dsb->sec_mixpos = DSOUND_bufpos_to_secpos(dsb, dsb->buf_mixpos);
572         ilen = DSOUND_BufPtrDiff(dsb->buflen, dsb->sec_mixpos, oldpos);
573         /* check for notification positions */
574         if (dsb->dsbd.dwFlags & DSBCAPS_CTRLPOSITIONNOTIFY &&
575             dsb->state != STATE_STARTING) {
576                 DSOUND_CheckEvent(dsb, oldpos, ilen);
577         }
578
579         /* increase mix position */
580         dsb->primary_mixpos += len;
581         if (dsb->primary_mixpos >= dsb->device->buflen)
582                 dsb->primary_mixpos -= dsb->device->buflen;
583         return len;
584 }
585
586 /**
587  * Mix some frames from the given secondary buffer "dsb" into the device
588  * primary buffer.
589  *
590  * dsb = the secondary buffer
591  * playpos = the current play position in the device buffer (primary buffer)
592  * writepos = the current safe-to-write position in the device buffer
593  * mixlen = the maximum number of bytes in the primary buffer to mix, from the
594  *          current writepos.
595  *
596  * Returns: the number of bytes beyond the writepos that were mixed.
597  */
598 static DWORD DSOUND_MixOne(IDirectSoundBufferImpl *dsb, DWORD writepos, DWORD mixlen)
599 {
600         /* The buffer's primary_mixpos may be before or after the device
601          * buffer's mixpos, but both must be ahead of writepos. */
602         DWORD primary_done;
603
604         TRACE("(%p,%d,%d)\n",dsb,writepos,mixlen);
605         TRACE("writepos=%d, buf_mixpos=%d, primary_mixpos=%d, mixlen=%d\n", writepos, dsb->buf_mixpos, dsb->primary_mixpos, mixlen);
606         TRACE("looping=%d, leadin=%d, buflen=%d\n", dsb->playflags, dsb->leadin, dsb->tmp_buffer_len);
607
608         /* If leading in, only mix about 20 ms, and 'skip' mixing the rest, for more fluid pointer advancement */
609         if (dsb->leadin && dsb->state == STATE_STARTING)
610         {
611                 if (mixlen > 2 * dsb->device->fraglen)
612                 {
613                         dsb->primary_mixpos += mixlen - 2 * dsb->device->fraglen;
614                         dsb->primary_mixpos %= dsb->device->buflen;
615                 }
616         }
617         dsb->leadin = FALSE;
618
619         /* calculate how much pre-buffering has already been done for this buffer */
620         primary_done = DSOUND_BufPtrDiff(dsb->device->buflen, dsb->primary_mixpos, writepos);
621
622         /* sanity */
623         if(mixlen < primary_done)
624         {
625                 /* Should *NEVER* happen */
626                 ERR("Fatal error. Under/Overflow? primary_done=%d, mixpos=%d/%d (%d/%d), primary_mixpos=%d, writepos=%d, mixlen=%d\n", primary_done,dsb->buf_mixpos,dsb->tmp_buffer_len,dsb->sec_mixpos, dsb->buflen, dsb->primary_mixpos, writepos, mixlen);
627                 dsb->primary_mixpos = writepos + mixlen;
628                 dsb->primary_mixpos %= dsb->device->buflen;
629                 return mixlen;
630         }
631
632         /* take into account already mixed data */
633         mixlen -= primary_done;
634
635         TRACE("primary_done=%d, mixlen (primary) = %i\n", primary_done, mixlen);
636
637         if (!mixlen)
638                 return primary_done;
639
640         /* First try to mix to the end of the buffer if possible
641          * Theoretically it would allow for better optimization
642         */
643         if (mixlen + dsb->buf_mixpos >= dsb->tmp_buffer_len)
644         {
645                 DWORD newmixed, mixfirst = dsb->tmp_buffer_len - dsb->buf_mixpos;
646                 newmixed = DSOUND_MixInBuffer(dsb, dsb->primary_mixpos, mixfirst);
647                 mixlen -= newmixed;
648
649                 if (dsb->playflags & DSBPLAY_LOOPING)
650                         while (newmixed && mixlen)
651                         {
652                                 mixfirst = (dsb->tmp_buffer_len < mixlen ? dsb->tmp_buffer_len : mixlen);
653                                 newmixed = DSOUND_MixInBuffer(dsb, dsb->primary_mixpos, mixfirst);
654                                 mixlen -= newmixed;
655                         }
656         }
657         else DSOUND_MixInBuffer(dsb, dsb->primary_mixpos, mixlen);
658
659         /* re-calculate the primary done */
660         primary_done = DSOUND_BufPtrDiff(dsb->device->buflen, dsb->primary_mixpos, writepos);
661
662         TRACE("new primary_mixpos=%d, total mixed data=%d\n", dsb->primary_mixpos, primary_done);
663
664         /* Report back the total prebuffered amount for this buffer */
665         return primary_done;
666 }
667
668 /**
669  * For a DirectSoundDevice, go through all the currently playing buffers and
670  * mix them in to the device buffer.
671  *
672  * writepos = the current safe-to-write position in the primary buffer
673  * mixlen = the maximum amount to mix into the primary buffer
674  *          (beyond the current writepos)
675  * recover = true if the sound device may have been reset and the write
676  *           position in the device buffer changed
677  * all_stopped = reports back if all buffers have stopped
678  *
679  * Returns:  the length beyond the writepos that was mixed to.
680  */
681
682 static DWORD DSOUND_MixToPrimary(const DirectSoundDevice *device, DWORD writepos, DWORD mixlen, BOOL recover, BOOL *all_stopped)
683 {
684         INT i, len;
685         DWORD minlen = 0;
686         IDirectSoundBufferImpl  *dsb;
687
688         /* unless we find a running buffer, all have stopped */
689         *all_stopped = TRUE;
690
691         TRACE("(%d,%d,%d)\n", writepos, mixlen, recover);
692         for (i = 0; i < device->nrofbuffers; i++) {
693                 dsb = device->buffers[i];
694
695                 TRACE("MixToPrimary for %p, state=%d\n", dsb, dsb->state);
696
697                 if (dsb->buflen && dsb->state) {
698                         TRACE("Checking %p, mixlen=%d\n", dsb, mixlen);
699                         RtlAcquireResourceShared(&dsb->lock, TRUE);
700                         /* if buffer is stopping it is stopped now */
701                         if (dsb->state == STATE_STOPPING) {
702                                 dsb->state = STATE_STOPPED;
703                                 DSOUND_CheckEvent(dsb, 0, 0);
704                         } else if (dsb->state != STATE_STOPPED) {
705
706                                 /* if recovering, reset the mix position */
707                                 if ((dsb->state == STATE_STARTING) || recover) {
708                                         dsb->primary_mixpos = writepos;
709                                 }
710
711                                 /* if the buffer was starting, it must be playing now */
712                                 if (dsb->state == STATE_STARTING)
713                                         dsb->state = STATE_PLAYING;
714
715                                 /* mix next buffer into the main buffer */
716                                 len = DSOUND_MixOne(dsb, writepos, mixlen);
717
718                                 if (!minlen) minlen = len;
719
720                                 /* record the minimum length mixed from all buffers */
721                                 /* we only want to return the length which *all* buffers have mixed */
722                                 else if (len) minlen = (len < minlen) ? len : minlen;
723
724                                 *all_stopped = FALSE;
725                         }
726                         RtlReleaseResource(&dsb->lock);
727                 }
728         }
729
730         TRACE("Mixed at least %d from all buffers\n", minlen);
731         return minlen;
732 }
733
734 /**
735  * Add buffers to the emulated wave device system.
736  *
737  * device = The current dsound playback device
738  * force = If TRUE, the function will buffer up as many frags as possible,
739  *         even though and will ignore the actual state of the primary buffer.
740  *
741  * Returns:  None
742  */
743
744 static void DSOUND_WaveQueue(DirectSoundDevice *device, BOOL force)
745 {
746         DWORD prebuf_frames, buf_offs_bytes, wave_fragpos;
747         int prebuf_frags;
748         BYTE *buffer;
749         HRESULT hr;
750
751         TRACE("(%p)\n", device);
752
753         /* calculate the current wave frag position */
754         wave_fragpos = (device->pwplay + device->pwqueue) % device->helfrags;
755
756         /* calculate the current wave write position */
757         buf_offs_bytes = wave_fragpos * device->fraglen;
758
759         TRACE("wave_fragpos = %i, buf_offs_bytes = %i, pwqueue = %i, prebuf = %i\n",
760                 wave_fragpos, buf_offs_bytes, device->pwqueue, device->prebuf);
761
762         if (!force)
763         {
764                 /* check remaining prebuffered frags */
765                 prebuf_frags = device->mixpos / device->fraglen;
766                 if (prebuf_frags == device->helfrags)
767                         --prebuf_frags;
768                 TRACE("wave_fragpos = %d, mixpos_frags = %d\n", wave_fragpos, prebuf_frags);
769                 if (prebuf_frags < wave_fragpos)
770                         prebuf_frags += device->helfrags;
771                 prebuf_frags -= wave_fragpos;
772                 TRACE("wanted prebuf_frags = %d\n", prebuf_frags);
773         }
774         else
775                 /* buffer the maximum amount of frags */
776                 prebuf_frags = device->prebuf;
777
778         /* limit to the queue we have left */
779         if ((prebuf_frags + device->pwqueue) > device->prebuf)
780                 prebuf_frags = device->prebuf - device->pwqueue;
781
782         TRACE("prebuf_frags = %i\n", prebuf_frags);
783
784         if(!prebuf_frags)
785                 return;
786
787         /* adjust queue */
788         device->pwqueue += prebuf_frags;
789
790         prebuf_frames = ((prebuf_frags + wave_fragpos > device->helfrags) ?
791                         (device->helfrags - wave_fragpos) :
792                         (prebuf_frags)) * device->fraglen / device->pwfx->nBlockAlign;
793
794         hr = IAudioRenderClient_GetBuffer(device->render, prebuf_frames, &buffer);
795         if(FAILED(hr)){
796                 WARN("GetBuffer failed: %08x\n", hr);
797                 return;
798         }
799
800         memcpy(buffer, device->buffer + buf_offs_bytes,
801                         prebuf_frames * device->pwfx->nBlockAlign);
802
803         hr = IAudioRenderClient_ReleaseBuffer(device->render, prebuf_frames, 0);
804         if(FAILED(hr)){
805                 WARN("ReleaseBuffer failed: %08x\n", hr);
806                 return;
807         }
808
809         /* check if anything wrapped */
810         prebuf_frags = prebuf_frags + wave_fragpos - device->helfrags;
811         if(prebuf_frags > 0){
812                 prebuf_frames = prebuf_frags * device->fraglen / device->pwfx->nBlockAlign;
813
814                 hr = IAudioRenderClient_GetBuffer(device->render, prebuf_frames, &buffer);
815                 if(FAILED(hr)){
816                         WARN("GetBuffer failed: %08x\n", hr);
817                         return;
818                 }
819
820                 memcpy(buffer, device->buffer, prebuf_frames * device->pwfx->nBlockAlign);
821
822                 hr = IAudioRenderClient_ReleaseBuffer(device->render, prebuf_frames, 0);
823                 if(FAILED(hr)){
824                         WARN("ReleaseBuffer failed: %08x\n", hr);
825                         return;
826                 }
827         }
828
829         TRACE("queue now = %i\n", device->pwqueue);
830 }
831
832 /**
833  * Perform mixing for a Direct Sound device. That is, go through all the
834  * secondary buffers (the sound bites currently playing) and mix them in
835  * to the primary buffer (the device buffer).
836  */
837 static void DSOUND_PerformMix(DirectSoundDevice *device)
838 {
839         UINT64 clock_pos, clock_freq, pos_bytes;
840         UINT delta_frags;
841         HRESULT hr;
842
843         TRACE("(%p)\n", device);
844
845         /* **** */
846         EnterCriticalSection(&device->mixlock);
847
848         hr = IAudioClock_GetFrequency(device->clock, &clock_freq);
849         if(FAILED(hr)){
850                 WARN("GetFrequency failed: %08x\n", hr);
851         LeaveCriticalSection(&device->mixlock);
852                 return;
853         }
854
855         hr = IAudioClock_GetPosition(device->clock, &clock_pos, NULL);
856         if(FAILED(hr)){
857                 WARN("GetCurrentPadding failed: %08x\n", hr);
858         LeaveCriticalSection(&device->mixlock);
859                 return;
860         }
861
862         pos_bytes = (clock_pos * device->pwfx->nBlockAlign * clock_freq) /
863         device->pwfx->nSamplesPerSec;
864
865         delta_frags = (pos_bytes - device->last_pos_bytes) / device->fraglen;
866         if(delta_frags > 0){
867                 device->pwplay += delta_frags;
868                 device->pwplay %= device->helfrags;
869                 device->pwqueue -= delta_frags;
870                 device->last_pos_bytes = pos_bytes - (pos_bytes % device->fraglen);
871         }
872
873         if (device->priolevel != DSSCL_WRITEPRIMARY) {
874                 BOOL recover = FALSE, all_stopped = FALSE;
875                 DWORD playpos, writepos, writelead, maxq, frag, prebuff_max, prebuff_left, size1, size2, mixplaypos, mixplaypos2;
876                 LPVOID buf1, buf2;
877                 int nfiller;
878
879                 /* the sound of silence */
880                 nfiller = device->pwfx->wBitsPerSample == 8 ? 128 : 0;
881
882                 /* get the position in the primary buffer */
883                 if (DSOUND_PrimaryGetPosition(device, &playpos, &writepos) != 0){
884                         LeaveCriticalSection(&(device->mixlock));
885                         return;
886                 }
887
888                 TRACE("primary playpos=%d, writepos=%d, clrpos=%d, mixpos=%d, buflen=%d\n",
889                         playpos,writepos,device->playpos,device->mixpos,device->buflen);
890                 assert(device->playpos < device->buflen);
891
892                 mixplaypos = DSOUND_bufpos_to_mixpos(device, device->playpos);
893                 mixplaypos2 = DSOUND_bufpos_to_mixpos(device, playpos);
894
895                 /* calc maximum prebuff */
896                 prebuff_max = (device->prebuf * device->fraglen);
897                 if (playpos + prebuff_max >= device->helfrags * device->fraglen)
898                         prebuff_max += device->buflen - device->helfrags * device->fraglen;
899
900                 /* check how close we are to an underrun. It occurs when the writepos overtakes the mixpos */
901                 prebuff_left = DSOUND_BufPtrDiff(device->buflen, device->mixpos, playpos);
902                 writelead = DSOUND_BufPtrDiff(device->buflen, writepos, playpos);
903
904                 /* check for underrun. underrun occurs when the write position passes the mix position
905                  * also wipe out just-played sound data */
906                 if((prebuff_left > prebuff_max) || (device->state == STATE_STOPPED) || (device->state == STATE_STARTING)){
907                         if (device->state == STATE_STOPPING || device->state == STATE_PLAYING)
908                                 WARN("Probable buffer underrun\n");
909                         else TRACE("Buffer starting or buffer underrun\n");
910
911                         /* recover mixing for all buffers */
912                         recover = TRUE;
913
914                         /* reset mix position to write position */
915                         device->mixpos = writepos;
916
917                         ZeroMemory(device->mix_buffer, device->mix_buffer_len);
918                         ZeroMemory(device->buffer, device->buflen);
919                 } else if (playpos < device->playpos) {
920                         buf1 = device->buffer + device->playpos;
921                         buf2 = device->buffer;
922                         size1 = device->buflen - device->playpos;
923                         size2 = playpos;
924                         FillMemory(device->mix_buffer + mixplaypos, device->mix_buffer_len - mixplaypos, 0);
925                         FillMemory(device->mix_buffer, mixplaypos2, 0);
926                         FillMemory(buf1, size1, nfiller);
927                         if (playpos && (!buf2 || !size2))
928                                 FIXME("%d: (%d, %d)=>(%d, %d) There should be an additional buffer here!!\n", __LINE__, device->playpos, device->mixpos, playpos, writepos);
929                         FillMemory(buf2, size2, nfiller);
930                 } else {
931                         buf1 = device->buffer + device->playpos;
932                         buf2 = NULL;
933                         size1 = playpos - device->playpos;
934                         size2 = 0;
935                         FillMemory(device->mix_buffer + mixplaypos, mixplaypos2 - mixplaypos, 0);
936                         FillMemory(buf1, size1, nfiller);
937                 }
938                 device->playpos = playpos;
939
940                 /* find the maximum we can prebuffer from current write position */
941                 maxq = (writelead < prebuff_max) ? (prebuff_max - writelead) : 0;
942
943                 TRACE("prebuff_left = %d, prebuff_max = %dx%d=%d, writelead=%d\n",
944                         prebuff_left, device->prebuf, device->fraglen, prebuff_max, writelead);
945
946                 /* do the mixing */
947                 frag = DSOUND_MixToPrimary(device, writepos, maxq, recover, &all_stopped);
948
949                 if (frag + writepos > device->buflen)
950                 {
951                         DWORD todo = device->buflen - writepos;
952                         device->normfunction(device->mix_buffer + DSOUND_bufpos_to_mixpos(device, writepos), device->buffer + writepos, todo);
953                         device->normfunction(device->mix_buffer, device->buffer, frag - todo);
954                 }
955                 else
956                         device->normfunction(device->mix_buffer + DSOUND_bufpos_to_mixpos(device, writepos), device->buffer + writepos, frag);
957
958                 /* update the mix position, taking wrap-around into account */
959                 device->mixpos = writepos + frag;
960                 device->mixpos %= device->buflen;
961
962                 /* update prebuff left */
963                 prebuff_left = DSOUND_BufPtrDiff(device->buflen, device->mixpos, playpos);
964
965                 /* check if have a whole fragment */
966                 if (prebuff_left >= device->fraglen){
967
968                         /* update the wave queue */
969                         DSOUND_WaveQueue(device, FALSE);
970
971                         /* buffers are full. start playing if applicable */
972                         if(device->state == STATE_STARTING){
973                                 TRACE("started primary buffer\n");
974                                 if(DSOUND_PrimaryPlay(device) != DS_OK){
975                                         WARN("DSOUND_PrimaryPlay failed\n");
976                                 }
977                                 else{
978                                         /* we are playing now */
979                                         device->state = STATE_PLAYING;
980                                 }
981                         }
982
983                         /* buffers are full. start stopping if applicable */
984                         if(device->state == STATE_STOPPED){
985                                 TRACE("restarting primary buffer\n");
986                                 if(DSOUND_PrimaryPlay(device) != DS_OK){
987                                         WARN("DSOUND_PrimaryPlay failed\n");
988                                 }
989                                 else{
990                                         /* start stopping again. as soon as there is no more data, it will stop */
991                                         device->state = STATE_STOPPING;
992                                 }
993                         }
994                 }
995
996                 /* if device was stopping, its for sure stopped when all buffers have stopped */
997                 else if((all_stopped == TRUE) && (device->state == STATE_STOPPING)){
998                         TRACE("All buffers have stopped. Stopping primary buffer\n");
999                         device->state = STATE_STOPPED;
1000
1001                         /* stop the primary buffer now */
1002                         DSOUND_PrimaryStop(device);
1003                 }
1004
1005         } else {
1006
1007                 DSOUND_WaveQueue(device, TRUE);
1008
1009                 /* in the DSSCL_WRITEPRIMARY mode, the app is totally in charge... */
1010                 if (device->state == STATE_STARTING) {
1011                         if (DSOUND_PrimaryPlay(device) != DS_OK)
1012                                 WARN("DSOUND_PrimaryPlay failed\n");
1013                         else
1014                                 device->state = STATE_PLAYING;
1015                 }
1016                 else if (device->state == STATE_STOPPING) {
1017                         if (DSOUND_PrimaryStop(device) != DS_OK)
1018                                 WARN("DSOUND_PrimaryStop failed\n");
1019                         else
1020                                 device->state = STATE_STOPPED;
1021                 }
1022         }
1023
1024         LeaveCriticalSection(&(device->mixlock));
1025         /* **** */
1026 }
1027
1028 void CALLBACK DSOUND_timer(UINT timerID, UINT msg, DWORD_PTR dwUser,
1029                            DWORD_PTR dw1, DWORD_PTR dw2)
1030 {
1031         DirectSoundDevice * device = (DirectSoundDevice*)dwUser;
1032         DWORD start_time =  GetTickCount();
1033         DWORD end_time;
1034         TRACE("(%d,%d,0x%lx,0x%lx,0x%lx)\n",timerID,msg,dwUser,dw1,dw2);
1035         TRACE("entering at %d\n", start_time);
1036
1037         RtlAcquireResourceShared(&(device->buffer_list_lock), TRUE);
1038
1039         if (device->ref)
1040                 DSOUND_PerformMix(device);
1041
1042         RtlReleaseResource(&(device->buffer_list_lock));
1043
1044         end_time = GetTickCount();
1045         TRACE("completed processing at %d, duration = %d\n", end_time, end_time - start_time);
1046 }