Assorted typo, spelling, wording and case fixes.
[wine] / dlls / dsound / dsound_private.h
1 /*                      DirectSound
2  *
3  * Copyright 1998 Marcus Meissner
4  * Copyright 1998 Rob Riggs
5  * Copyright 2000-2001 TransGaming Technologies, Inc.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20  */
21
22 /* Linux does not support better timing than 10ms */
23 #define DS_TIME_RES 2  /* Resolution of multimedia timer */
24 #define DS_TIME_DEL 10  /* Delay of multimedia timer callback, and duration of HEL fragment */
25
26 #include "wingdi.h"
27 #include "mmdeviceapi.h"
28 #include "audioclient.h"
29 #include "mmsystem.h"
30
31 #include "wine/list.h"
32
33 extern int ds_hel_buflen DECLSPEC_HIDDEN;
34 extern int ds_snd_queue_max DECLSPEC_HIDDEN;
35 extern int ds_snd_shadow_maxsize DECLSPEC_HIDDEN;
36 extern int ds_default_sample_rate DECLSPEC_HIDDEN;
37 extern int ds_default_bits_per_sample DECLSPEC_HIDDEN;
38
39 /*****************************************************************************
40  * Predeclare the interface implementation structures
41  */
42 typedef struct IDirectSoundImpl              IDirectSoundImpl;
43 typedef struct IDirectSound_IUnknown         IDirectSound_IUnknown;
44 typedef struct IDirectSound_IDirectSound     IDirectSound_IDirectSound;
45 typedef struct IDirectSound8_IUnknown        IDirectSound8_IUnknown;
46 typedef struct IDirectSound8_IDirectSound    IDirectSound8_IDirectSound;
47 typedef struct IDirectSound8_IDirectSound8   IDirectSound8_IDirectSound8;
48 typedef struct IDirectSoundBufferImpl        IDirectSoundBufferImpl;
49 typedef struct IDirectSoundCaptureImpl       IDirectSoundCaptureImpl;
50 typedef struct IDirectSoundCaptureBufferImpl IDirectSoundCaptureBufferImpl;
51 typedef struct DirectSoundDevice             DirectSoundDevice;
52 typedef struct DirectSoundCaptureDevice      DirectSoundCaptureDevice;
53
54 /* dsound_convert.h */
55 typedef float (*bitsgetfunc)(const IDirectSoundBufferImpl *, DWORD, DWORD);
56 typedef void (*bitsputfunc)(const IDirectSoundBufferImpl *, DWORD, DWORD, float);
57 extern const bitsgetfunc getbpp[5] DECLSPEC_HIDDEN;
58 void putieee32(const IDirectSoundBufferImpl *dsb, DWORD pos, DWORD channel, float value) DECLSPEC_HIDDEN;
59 void mixieee32(float *src, float *dst, unsigned samples) DECLSPEC_HIDDEN;
60 typedef void (*normfunc)(const void *, void *, unsigned);
61 extern const normfunc normfunctions[5] DECLSPEC_HIDDEN;
62
63 typedef struct _DSVOLUMEPAN
64 {
65     DWORD       dwTotalLeftAmpFactor;
66     DWORD       dwTotalRightAmpFactor;
67     LONG        lVolume;
68     DWORD       dwVolAmpFactor;
69     LONG        lPan;
70     DWORD       dwPanLeftAmpFactor;
71     DWORD       dwPanRightAmpFactor;
72 } DSVOLUMEPAN,*PDSVOLUMEPAN;
73
74 /*****************************************************************************
75  * IDirectSoundDevice implementation structure
76  */
77 struct DirectSoundDevice
78 {
79     LONG                        ref;
80
81     GUID                        guid;
82     DSCAPS                      drvcaps;
83     DWORD                       priolevel;
84     PWAVEFORMATEX               pwfx;
85     UINT                        timerID, playing_offs_bytes, in_mmdev_bytes, prebuf, helfrags;
86     UINT64                      last_pos_bytes;
87     DWORD                       fraglen;
88     LPBYTE                      buffer;
89     DWORD                       writelead, buflen, state, playpos, mixpos;
90     int                         nrofbuffers;
91     IDirectSoundBufferImpl**    buffers;
92     RTL_RWLOCK                  buffer_list_lock;
93     CRITICAL_SECTION            mixlock;
94     IDirectSoundBufferImpl     *primary;
95     DWORD                       speaker_config;
96     float *mix_buffer, *tmp_buffer;
97     DWORD                       tmp_buffer_len, mix_buffer_len;
98
99     DSVOLUMEPAN                 volpan;
100
101     normfunc normfunction;
102
103     /* DirectSound3DListener fields */
104     DS3DLISTENER                ds3dl;
105     BOOL                        ds3dl_need_recalc;
106
107     IMMDevice *mmdevice;
108     IAudioClient *client;
109     IAudioClock *clock;
110     IAudioStreamVolume *volume;
111     IAudioRenderClient *render;
112
113     struct list entry;
114 };
115
116 /* reference counted buffer memory for duplicated buffer memory */
117 typedef struct BufferMemory
118 {
119     LONG                        ref;
120     LPBYTE                      memory;
121     struct list buffers;
122 } BufferMemory;
123
124 ULONG DirectSoundDevice_Release(DirectSoundDevice * device) DECLSPEC_HIDDEN;
125 HRESULT DirectSoundDevice_Initialize(
126     DirectSoundDevice ** ppDevice,
127     LPCGUID lpcGUID) DECLSPEC_HIDDEN;
128 HRESULT DirectSoundDevice_AddBuffer(
129     DirectSoundDevice * device,
130     IDirectSoundBufferImpl * pDSB) DECLSPEC_HIDDEN;
131 HRESULT DirectSoundDevice_RemoveBuffer(
132     DirectSoundDevice * device,
133     IDirectSoundBufferImpl * pDSB) DECLSPEC_HIDDEN;
134 HRESULT DirectSoundDevice_GetCaps(DirectSoundDevice * device, LPDSCAPS lpDSCaps) DECLSPEC_HIDDEN;
135 HRESULT DirectSoundDevice_CreateSoundBuffer(
136     DirectSoundDevice * device,
137     LPCDSBUFFERDESC dsbd,
138     LPLPDIRECTSOUNDBUFFER ppdsb,
139     LPUNKNOWN lpunk,
140     BOOL from8) DECLSPEC_HIDDEN;
141 HRESULT DirectSoundDevice_DuplicateSoundBuffer(
142     DirectSoundDevice * device,
143     LPDIRECTSOUNDBUFFER psb,
144     LPLPDIRECTSOUNDBUFFER ppdsb) DECLSPEC_HIDDEN;
145 HRESULT DirectSoundDevice_SetCooperativeLevel(
146     DirectSoundDevice * devcie,
147     HWND hwnd,
148     DWORD level) DECLSPEC_HIDDEN;
149 HRESULT DirectSoundDevice_Compact(DirectSoundDevice * device) DECLSPEC_HIDDEN;
150 HRESULT DirectSoundDevice_GetSpeakerConfig(
151     DirectSoundDevice * device,
152     LPDWORD lpdwSpeakerConfig) DECLSPEC_HIDDEN;
153 HRESULT DirectSoundDevice_SetSpeakerConfig(
154     DirectSoundDevice * device,
155     DWORD config) DECLSPEC_HIDDEN;
156 HRESULT DirectSoundDevice_VerifyCertification(DirectSoundDevice * device,
157     LPDWORD pdwCertified) DECLSPEC_HIDDEN;
158
159 /*****************************************************************************
160  * IDirectSoundBuffer implementation structure
161  */
162 struct IDirectSoundBufferImpl
163 {
164     IDirectSoundBuffer8         IDirectSoundBuffer8_iface;
165     IDirectSoundNotify          IDirectSoundNotify_iface;
166     IDirectSound3DListener      IDirectSound3DListener_iface; /* only primary buffer */
167     IDirectSound3DBuffer        IDirectSound3DBuffer_iface; /* only secondary buffer */
168     IKsPropertySet              IKsPropertySet_iface;
169     LONG                        numIfaces; /* "in use interfaces" refcount */
170     LONG                        ref, refn, ref3D, refiks;
171     /* IDirectSoundBufferImpl fields */
172     DirectSoundDevice*          device;
173     RTL_RWLOCK                  lock;
174     PWAVEFORMATEX               pwfx;
175     BufferMemory*               buffer;
176     DWORD                       playflags,state,leadin;
177     DWORD                       writelead,buflen;
178     DWORD                       nAvgBytesPerSec;
179     DWORD                       freq;
180     DSVOLUMEPAN                 volpan;
181     DSBUFFERDESC                dsbd;
182     /* used for frequency conversion (PerfectPitch) */
183     ULONG                       freqneeded;
184     DWORD                       firstep;
185     float freqAcc, freqAdjust, firgain;
186     /* used for mixing */
187     DWORD                       sec_mixpos;
188
189     /* IDirectSoundNotify fields */
190     LPDSBPOSITIONNOTIFY         notifies;
191     int                         nrofnotifies;
192     /* DirectSound3DBuffer fields */
193     DS3DBUFFER                  ds3db_ds3db;
194     LONG                        ds3db_lVolume;
195     BOOL                        ds3db_need_recalc;
196     /* Used for bit depth conversion */
197     int                         mix_channels;
198     bitsgetfunc get, get_aux;
199     bitsputfunc put, put_aux;
200
201     struct list entry;
202 };
203
204 float get_mono(const IDirectSoundBufferImpl *dsb, DWORD pos, DWORD channel) DECLSPEC_HIDDEN;
205 void put_mono2stereo(const IDirectSoundBufferImpl *dsb, DWORD pos, DWORD channel, float value) DECLSPEC_HIDDEN;
206
207 HRESULT IDirectSoundBufferImpl_Create(
208     DirectSoundDevice *device,
209     IDirectSoundBufferImpl **ppdsb,
210     LPCDSBUFFERDESC dsbd) DECLSPEC_HIDDEN;
211 HRESULT IDirectSoundBufferImpl_Duplicate(
212     DirectSoundDevice *device,
213     IDirectSoundBufferImpl **ppdsb,
214     IDirectSoundBufferImpl *pdsb) DECLSPEC_HIDDEN;
215 void secondarybuffer_destroy(IDirectSoundBufferImpl *This) DECLSPEC_HIDDEN;
216 const IDirectSound3DListenerVtbl ds3dlvt DECLSPEC_HIDDEN;
217 const IDirectSound3DBufferVtbl ds3dbvt DECLSPEC_HIDDEN;
218 const IKsPropertySetVtbl iksbvt DECLSPEC_HIDDEN;
219
220 /*****************************************************************************
221  * DirectSoundCaptureDevice implementation structure
222  */
223 struct DirectSoundCaptureDevice
224 {
225     GUID                               guid;
226     LONG                               ref;
227
228     DSCCAPS                            drvcaps;
229
230     LPBYTE                             buffer;
231     DWORD                              buflen, write_pos_bytes;
232
233     PWAVEFORMATEX                      pwfx;
234
235     IDirectSoundCaptureBufferImpl*     capture_buffer;
236     DWORD                              state;
237     UINT timerID;
238     CRITICAL_SECTION                   lock;
239
240     IMMDevice *mmdevice;
241     IAudioClient *client;
242     IAudioCaptureClient *capture;
243
244     struct list entry;
245 };
246
247 /*****************************************************************************
248  * IDirectSoundCaptureBuffer implementation structure
249  */
250 struct IDirectSoundCaptureBufferImpl
251 {
252     IDirectSoundCaptureBuffer8          IDirectSoundCaptureBuffer8_iface;
253     IDirectSoundNotify                  IDirectSoundNotify_iface;
254     LONG                                numIfaces; /* "in use interfaces" refcount */
255     LONG                                ref, refn;
256     /* IDirectSoundCaptureBuffer fields */
257     DirectSoundCaptureDevice*           device;
258     LPDSCBUFFERDESC                     pdscbd;
259     DWORD                               flags;
260     /* IDirectSoundNotify fields */
261     LPDSBPOSITIONNOTIFY                 notifies;
262     int                                 nrofnotifies;
263 };
264
265 HRESULT IKsPrivatePropertySetImpl_Create(REFIID riid, IKsPropertySet **piks) DECLSPEC_HIDDEN;
266
267 /*******************************************************************************
268  */
269
270 /* dsound.c */
271
272 HRESULT DSOUND_Create(REFIID riid, LPDIRECTSOUND *ppDS) DECLSPEC_HIDDEN;
273 HRESULT DSOUND_Create8(REFIID riid, LPDIRECTSOUND8 *ppDS) DECLSPEC_HIDDEN;
274
275 /* primary.c */
276
277 HRESULT DSOUND_PrimaryCreate(DirectSoundDevice *device) DECLSPEC_HIDDEN;
278 HRESULT DSOUND_PrimaryDestroy(DirectSoundDevice *device) DECLSPEC_HIDDEN;
279 HRESULT DSOUND_PrimaryPlay(DirectSoundDevice *device) DECLSPEC_HIDDEN;
280 HRESULT DSOUND_PrimaryStop(DirectSoundDevice *device) DECLSPEC_HIDDEN;
281 HRESULT DSOUND_PrimaryGetPosition(DirectSoundDevice *device, LPDWORD playpos, LPDWORD writepos) DECLSPEC_HIDDEN;
282 LPWAVEFORMATEX DSOUND_CopyFormat(LPCWAVEFORMATEX wfex) DECLSPEC_HIDDEN;
283 HRESULT DSOUND_ReopenDevice(DirectSoundDevice *device, BOOL forcewave) DECLSPEC_HIDDEN;
284 HRESULT primarybuffer_create(DirectSoundDevice *device, IDirectSoundBufferImpl **ppdsb,
285     const DSBUFFERDESC *dsbd) DECLSPEC_HIDDEN;
286 void primarybuffer_destroy(IDirectSoundBufferImpl *This) DECLSPEC_HIDDEN;
287 HRESULT primarybuffer_SetFormat(DirectSoundDevice *device, LPCWAVEFORMATEX wfex) DECLSPEC_HIDDEN;
288 LONG capped_refcount_dec(LONG *ref) DECLSPEC_HIDDEN;
289
290 /* duplex.c */
291  
292 HRESULT DSOUND_FullDuplexCreate(REFIID riid, LPDIRECTSOUNDFULLDUPLEX* ppDSFD) DECLSPEC_HIDDEN;
293
294 /* mixer.c */
295 void DSOUND_CheckEvent(const IDirectSoundBufferImpl *dsb, DWORD playpos, int len) DECLSPEC_HIDDEN;
296 void DSOUND_RecalcVolPan(PDSVOLUMEPAN volpan) DECLSPEC_HIDDEN;
297 void DSOUND_AmpFactorToVolPan(PDSVOLUMEPAN volpan) DECLSPEC_HIDDEN;
298 void DSOUND_RecalcFormat(IDirectSoundBufferImpl *dsb) DECLSPEC_HIDDEN;
299 DWORD DSOUND_secpos_to_bufpos(const IDirectSoundBufferImpl *dsb, DWORD secpos, DWORD secmixpos, float *overshot) DECLSPEC_HIDDEN;
300
301 void CALLBACK DSOUND_timer(UINT timerID, UINT msg, DWORD_PTR dwUser, DWORD_PTR dw1, DWORD_PTR dw2) DECLSPEC_HIDDEN;
302
303 /* sound3d.c */
304
305 void DSOUND_Calc3DBuffer(IDirectSoundBufferImpl *dsb) DECLSPEC_HIDDEN;
306
307 /* capture.c */
308  
309 HRESULT DSOUND_CaptureCreate(REFIID riid, LPDIRECTSOUNDCAPTURE *ppDSC) DECLSPEC_HIDDEN;
310 HRESULT DSOUND_CaptureCreate8(REFIID riid, LPDIRECTSOUNDCAPTURE8 *ppDSC8) DECLSPEC_HIDDEN;
311
312 #define STATE_STOPPED   0
313 #define STATE_STARTING  1
314 #define STATE_PLAYING   2
315 #define STATE_CAPTURING 2
316 #define STATE_STOPPING  3
317
318 extern CRITICAL_SECTION DSOUND_renderers_lock DECLSPEC_HIDDEN;
319 extern CRITICAL_SECTION DSOUND_capturers_lock DECLSPEC_HIDDEN;
320 extern struct list DSOUND_capturers DECLSPEC_HIDDEN;
321 extern struct list DSOUND_renderers DECLSPEC_HIDDEN;
322
323 extern GUID DSOUND_renderer_guids[MAXWAVEDRIVERS] DECLSPEC_HIDDEN;
324 extern GUID DSOUND_capture_guids[MAXWAVEDRIVERS] DECLSPEC_HIDDEN;
325
326 extern WCHAR wine_vxd_drv[] DECLSPEC_HIDDEN;
327
328 void setup_dsound_options(void) DECLSPEC_HIDDEN;
329 const char * dumpCooperativeLevel(DWORD level) DECLSPEC_HIDDEN;
330
331 HRESULT get_mmdevice(EDataFlow flow, const GUID *tgt, IMMDevice **device) DECLSPEC_HIDDEN;
332
333 BOOL DSOUND_check_supported(IAudioClient *client, DWORD rate,
334         DWORD depth, WORD channels) DECLSPEC_HIDDEN;
335 UINT DSOUND_create_timer(LPTIMECALLBACK cb, DWORD_PTR user) DECLSPEC_HIDDEN;
336 HRESULT enumerate_mmdevices(EDataFlow flow, GUID *guids,
337         LPDSENUMCALLBACKW cb, void *user) DECLSPEC_HIDDEN;