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