version: Fix typo in comment.
[wine] / dlls / mmdevapi / tests / capture.c
1 /*
2  * Copyright 2010 Maarten Lankhorst for Codeweavers
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
17  */
18
19 /* This test is for audio capture specific mechanisms
20  * Tests:
21  * - IAudioClient with eCapture and IAudioCaptureClient
22  */
23
24 #include "wine/test.h"
25
26 #define CINTERFACE
27 #define COBJMACROS
28
29 #ifdef STANDALONE
30 #include "initguid.h"
31 #endif
32
33 #include "unknwn.h"
34 #include "uuids.h"
35 #include "mmdeviceapi.h"
36 #include "audioclient.h"
37
38 static void test_uninitialized(IAudioClient *ac)
39 {
40     HRESULT hr;
41     UINT32 num;
42     REFERENCE_TIME t1;
43
44     HANDLE handle = CreateEventW(NULL, FALSE, FALSE, NULL);
45     IUnknown *unk;
46
47     hr = IAudioClient_GetBufferSize(ac, &num);
48     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized GetBufferSize call returns %08x\n", hr);
49
50     hr = IAudioClient_GetStreamLatency(ac, &t1);
51     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized GetStreamLatency call returns %08x\n", hr);
52
53     hr = IAudioClient_GetCurrentPadding(ac, &num);
54     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized GetCurrentPadding call returns %08x\n", hr);
55
56     hr = IAudioClient_Start(ac);
57     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized Start call returns %08x\n", hr);
58
59     hr = IAudioClient_Stop(ac);
60     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized Stop call returns %08x\n", hr);
61
62     hr = IAudioClient_Reset(ac);
63     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized Reset call returns %08x\n", hr);
64
65     hr = IAudioClient_SetEventHandle(ac, handle);
66     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized SetEventHandle call returns %08x\n", hr);
67
68     hr = IAudioClient_GetService(ac, &IID_IAudioStreamVolume, (void**)&unk);
69     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Uninitialized GetService call returns %08x\n", hr);
70
71     CloseHandle(handle);
72 }
73
74 static void test_capture(IAudioClient *ac, HANDLE handle, WAVEFORMATEX *wfx)
75 {
76     IAudioCaptureClient *acc;
77     HRESULT hr;
78     UINT32 frames = 0;
79     BYTE *data = NULL;
80     DWORD flags;
81     UINT64 devpos, qpcpos;
82
83     hr = IAudioClient_GetService(ac, &IID_IAudioCaptureClient, (void**)&acc);
84     ok(hr == S_OK, "IAudioClient_GetService(IID_IAudioCaptureClient) returns %08x\n", hr);
85     if (hr != S_OK)
86         return;
87
88     hr = IAudioCaptureClient_GetNextPacketSize(acc, NULL);
89     ok(hr == E_POINTER, "IAudioCaptureClient_GetNextPacketSize(NULL) returns %08x\n", hr);
90
91     ok(WaitForSingleObject(handle, 1000) == WAIT_OBJECT_0, "Waiting on event handle failed!\n");
92
93     /* frames can be 0 if no data is available yet.. */
94     hr = IAudioCaptureClient_GetNextPacketSize(acc, &frames);
95     ok(hr == S_OK, "IAudioCaptureClient_GetNextPacketSize returns %08x\n", hr);
96
97     data = (BYTE*)(DWORD_PTR)0xdeadbeef;
98     hr = IAudioCaptureClient_GetBuffer(acc, &data, NULL, NULL, NULL, NULL);
99     ok(hr == E_POINTER, "IAudioCaptureClient_GetBuffer(data, NULL, NULL) returns %08x\n", hr);
100     ok((DWORD_PTR)data == 0xdeadbeef, "data is reset to %p\n", data);
101
102     frames = 0xdeadbeef;
103     hr = IAudioCaptureClient_GetBuffer(acc, NULL, &frames, NULL, NULL, NULL);
104     ok(hr == E_POINTER, "IAudioCaptureClient_GetBuffer(NULL, &frames, NULL) returns %08x\n", hr);
105     ok(frames == 0xdeadbeef, "frames is reset to %08x\n", frames);
106
107     flags = 0xdeadbeef;
108     hr = IAudioCaptureClient_GetBuffer(acc, NULL, NULL, &flags, NULL, NULL);
109     ok(hr == E_POINTER, "IAudioCaptureClient_GetBuffer(NULL, NULL, &flags) returns %08x\n", hr);
110     ok(flags == 0xdeadbeef, "flags is reset to %08x\n", flags);
111
112     hr = IAudioCaptureClient_GetBuffer(acc, &data, &frames, NULL, NULL, NULL);
113     ok(hr == E_POINTER, "IAudioCaptureClient_GetBuffer(&ata, &frames, NULL) returns %08x\n", hr);
114
115     hr = IAudioCaptureClient_GetBuffer(acc, &data, &frames, &flags, &devpos, &qpcpos);
116     ok(hr == S_OK || hr == AUDCLNT_S_BUFFER_EMPTY, "Valid IAudioCaptureClient_GetBuffer returns %08x\n", hr);
117     if (hr == S_OK)
118         ok(frames, "Amount of frames locked is 0!\n");
119     else if (hr == AUDCLNT_S_BUFFER_EMPTY)
120         ok(!frames, "Amount of frames locked with empty buffer is %u!\n", frames);
121     else
122         ok(0, "GetBuffer returned %08x\n", hr);
123     trace("Device position is at %u, amount of frames locked: %u\n", (DWORD)devpos, frames);
124
125     if (frames) {
126         hr = IAudioCaptureClient_GetBuffer(acc, &data, &frames, &flags, &devpos, &qpcpos);
127         ok(hr == AUDCLNT_E_OUT_OF_ORDER, "Out of order IAudioCaptureClient_GetBuffer returns %08x\n", hr);
128     }
129
130     hr = IAudioCaptureClient_ReleaseBuffer(acc, frames);
131     ok(hr == S_OK, "Releasing buffer returns %08x\n", hr);
132
133     if (frames) {
134         hr = IAudioCaptureClient_ReleaseBuffer(acc, frames);
135         ok(hr == AUDCLNT_E_OUT_OF_ORDER, "Releasing buffer twice returns %08x\n", hr);
136     }
137
138     IUnknown_Release(acc);
139 }
140
141 static void test_audioclient(IAudioClient *ac)
142 {
143     IUnknown *unk;
144     HRESULT hr;
145     ULONG ref;
146     WAVEFORMATEX *pwfx, *pwfx2;
147     REFERENCE_TIME t1, t2;
148
149     HANDLE handle = CreateEventW(NULL, FALSE, FALSE, NULL);
150
151     hr = IAudioClient_QueryInterface(ac, &IID_IUnknown, NULL);
152     ok(hr == E_POINTER, "QueryInterface(NULL) returned %08x\n", hr);
153
154     unk = (void*)(LONG_PTR)0x12345678;
155     hr = IAudioClient_QueryInterface(ac, &IID_NULL, (void**)&unk);
156     ok(hr == E_NOINTERFACE, "QueryInterface(IID_NULL) returned %08x\n", hr);
157     ok(!unk, "QueryInterface(IID_NULL) returned non-null pointer %p\n", unk);
158
159     hr = IAudioClient_QueryInterface(ac, &IID_IUnknown, (void**)&unk);
160     ok(hr == S_OK, "QueryInterface(IID_IUnknown) returned %08x\n", hr);
161     if (unk)
162     {
163         ref = IUnknown_Release(unk);
164         ok(ref == 1, "Released count is %u\n", ref);
165     }
166
167     hr = IAudioClient_QueryInterface(ac, &IID_IAudioClient, (void**)&unk);
168     ok(hr == S_OK, "QueryInterface(IID_IAudioClient) returned %08x\n", hr);
169     if (unk)
170     {
171         ref = IUnknown_Release(unk);
172         ok(ref == 1, "Released count is %u\n", ref);
173     }
174
175     hr = IAudioClient_GetDevicePeriod(ac, NULL, NULL);
176     ok(hr == E_POINTER, "Invalid GetDevicePeriod call returns %08x\n", hr);
177
178     hr = IAudioClient_GetDevicePeriod(ac, &t1, NULL);
179     ok(hr == S_OK, "Valid GetDevicePeriod call returns %08x\n", hr);
180
181     hr = IAudioClient_GetDevicePeriod(ac, NULL, &t2);
182     ok(hr == S_OK, "Valid GetDevicePeriod call returns %08x\n", hr);
183
184     hr = IAudioClient_GetDevicePeriod(ac, &t1, &t2);
185     ok(hr == S_OK, "Valid GetDevicePeriod call returns %08x\n", hr);
186     trace("Returned periods: %u.%05u ms %u.%05u ms\n",
187           (UINT)(t1/10000), (UINT)(t1 % 10000),
188           (UINT)(t2/10000), (UINT)(t2 % 10000));
189
190     hr = IAudioClient_GetMixFormat(ac, NULL);
191     ok(hr == E_POINTER, "GetMixFormat returns %08x\n", hr);
192
193     hr = IAudioClient_GetMixFormat(ac, &pwfx);
194     ok(hr == S_OK, "Valid GetMixFormat returns %08x\n", hr);
195
196     trace("Tag: %04x\n", pwfx->wFormatTag);
197     trace("bits: %u\n", pwfx->wBitsPerSample);
198     trace("chan: %u\n", pwfx->nChannels);
199     trace("rate: %u\n", pwfx->nSamplesPerSec);
200     trace("align: %u\n", pwfx->nBlockAlign);
201     trace("extra: %u\n", pwfx->cbSize);
202     ok(pwfx->wFormatTag == WAVE_FORMAT_EXTENSIBLE, "wFormatTag is %x\n", pwfx->wFormatTag);
203     if (pwfx->wFormatTag == WAVE_FORMAT_EXTENSIBLE)
204     {
205         WAVEFORMATEXTENSIBLE *pwfxe = (void*)pwfx;
206         trace("Res: %u\n", pwfxe->Samples.wReserved);
207         trace("Mask: %x\n", pwfxe->dwChannelMask);
208         trace("Alg: %s\n",
209               IsEqualGUID(&pwfxe->SubFormat, &KSDATAFORMAT_SUBTYPE_PCM)?"PCM":
210               (IsEqualGUID(&pwfxe->SubFormat,
211                            &KSDATAFORMAT_SUBTYPE_IEEE_FLOAT)?"FLOAT":"Other"));
212     }
213
214     if (hr == S_OK)
215     {
216         hr = IAudioClient_IsFormatSupported(ac, AUDCLNT_SHAREMODE_SHARED, pwfx, &pwfx2);
217         ok(hr == S_OK, "Valid IsFormatSupported(Shared) call returns %08x\n", hr);
218         ok(pwfx2 == NULL, "pwfx2 is non-null\n");
219         CoTaskMemFree(pwfx2);
220
221         hr = IAudioClient_IsFormatSupported(ac, AUDCLNT_SHAREMODE_SHARED, NULL, NULL);
222         ok(hr == E_POINTER, "IsFormatSupported(NULL) call returns %08x\n", hr);
223
224         hr = IAudioClient_IsFormatSupported(ac, AUDCLNT_SHAREMODE_SHARED, pwfx, NULL);
225         ok(hr == E_POINTER, "IsFormatSupported(Shared,NULL) call returns %08x\n", hr);
226
227         hr = IAudioClient_IsFormatSupported(ac, AUDCLNT_SHAREMODE_EXCLUSIVE, pwfx, NULL);
228         ok(hr == S_OK || hr == AUDCLNT_E_UNSUPPORTED_FORMAT, "IsFormatSupported(Exclusive) call returns %08x\n", hr);
229
230         hr = IAudioClient_IsFormatSupported(ac, AUDCLNT_SHAREMODE_EXCLUSIVE, pwfx, &pwfx2);
231         ok(hr == S_OK || hr == AUDCLNT_E_UNSUPPORTED_FORMAT, "IsFormatSupported(Exclusive) call returns %08x\n", hr);
232         ok(pwfx2 == NULL, "pwfx2 non-null on exclusive IsFormatSupported\n");
233
234         hr = IAudioClient_IsFormatSupported(ac, 0xffffffff, pwfx, NULL);
235         ok(hr == E_INVALIDARG, "IsFormatSupported(0xffffffff) call returns %08x\n", hr);
236     }
237
238     test_uninitialized(ac);
239
240     hr = IAudioClient_Initialize(ac, 3, 0, 5000000, 0, pwfx, NULL);
241     ok(hr == AUDCLNT_E_NOT_INITIALIZED, "Initialize with invalid sharemode returns %08x\n", hr);
242
243     hr = IAudioClient_Initialize(ac, AUDCLNT_SHAREMODE_SHARED, 0xffffffff, 5000000, 0, pwfx, NULL);
244     ok(hr == E_INVALIDARG, "Initialize with invalid flags returns %08x\n", hr);
245
246     /* It seems that if length > 2s or periodicity != 0 the length is ignored and call succeeds
247      * Since we can only initialize succesfully once skip those tests
248      */
249     hr = IAudioClient_Initialize(ac, AUDCLNT_SHAREMODE_SHARED, 0, 5000000, 0, NULL, NULL);
250     ok(hr == E_POINTER, "Initialize with null format returns %08x\n", hr);
251
252     hr = IAudioClient_Initialize(ac, AUDCLNT_SHAREMODE_SHARED, AUDCLNT_STREAMFLAGS_EVENTCALLBACK, 5000000, 0, pwfx, NULL);
253     ok(hr == S_OK, "Valid Initialize returns %08x\n", hr);
254
255     if (hr != S_OK)
256     {
257         skip("Cannot initialize %08x, remainder of tests is useless\n", hr);
258         CoTaskMemFree(pwfx);
259         return;
260     }
261
262     hr = IAudioClient_GetStreamLatency(ac, NULL);
263     ok(hr == E_POINTER, "GetStreamLatency(NULL) call returns %08x\n", hr);
264
265     hr = IAudioClient_GetStreamLatency(ac, &t1);
266     ok(hr == S_OK, "Valid GetStreamLatency call returns %08x\n", hr);
267     trace("Returned latency: %u.%05u ms\n",
268           (UINT)(t1/10000), (UINT)(t1 % 10000));
269
270     hr = IAudioClient_Initialize(ac, AUDCLNT_SHAREMODE_SHARED, 0, 5000000, 0, pwfx, NULL);
271     ok(hr == AUDCLNT_E_ALREADY_INITIALIZED, "Calling Initialize twice returns %08x\n", hr);
272
273     hr = IAudioClient_SetEventHandle(ac, NULL);
274     ok(hr == E_INVALIDARG, "SetEventHandle(NULL) returns %08x\n", hr);
275
276     hr = IAudioClient_Start(ac);
277     ok(hr == AUDCLNT_E_EVENTHANDLE_NOT_SET, "Start before SetEventHandle returns %08x\n", hr);
278
279     hr = IAudioClient_SetEventHandle(ac, handle);
280     ok(hr == S_OK, "SetEventHandle returns %08x\n", hr);
281
282     hr = IAudioClient_Reset(ac);
283     ok(hr == S_OK, "Reset on a resetted stream returns %08x\n", hr);
284
285     hr = IAudioClient_Stop(ac);
286     ok(hr == S_FALSE, "Stop on a stopped stream returns %08x\n", hr);
287
288     hr = IAudioClient_Start(ac);
289     ok(hr == S_OK, "Start on a stopped stream returns %08x\n", hr);
290
291     test_capture(ac, handle, pwfx);
292
293     CloseHandle(handle);
294     CoTaskMemFree(pwfx);
295 }
296
297 START_TEST(capture)
298 {
299     HRESULT hr;
300     IMMDeviceEnumerator *mme = NULL;
301     IMMDevice *dev = NULL;
302     IAudioClient *ac = NULL;
303
304     CoInitializeEx(NULL, COINIT_MULTITHREADED);
305     hr = CoCreateInstance(&CLSID_MMDeviceEnumerator, NULL, CLSCTX_INPROC_SERVER, &IID_IMMDeviceEnumerator, (void**)&mme);
306     if (FAILED(hr))
307     {
308         skip("mmdevapi not available: 0x%08x\n", hr);
309         goto cleanup;
310     }
311
312     hr = IMMDeviceEnumerator_GetDefaultAudioEndpoint(mme, eCapture, eMultimedia, &dev);
313     ok(hr == S_OK || hr == E_NOTFOUND, "GetDefaultAudioEndpoint failed: 0x%08x\n", hr);
314     if (hr != S_OK || !dev)
315     {
316         if (hr == E_NOTFOUND)
317             skip("No sound card available\n");
318         else
319             skip("GetDefaultAudioEndpoint returns 0x%08x\n", hr);
320         goto cleanup;
321     }
322
323     hr = IMMDevice_Activate(dev, &IID_IAudioClient, CLSCTX_INPROC_SERVER, NULL, (void**)&ac);
324     ok(hr == S_OK, "Activation failed with %08x\n", hr);
325     if (ac)
326     {
327         test_audioclient(ac);
328         IAudioClient_Release(ac);
329     }
330     IMMDevice_Release(dev);
331
332 cleanup:
333     if (mme)
334         IMMDeviceEnumerator_Release(mme);
335     CoUninitialize();
336 }