1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
/*
* Base IDirectMusicObject Implementation
* Keep in sync with the master in dlls/dmusic/dmobject.c
*
* Copyright (C) 2003-2004 Rok Mandeljc
* Copyright (C) 2014 Michael Stefaniuc
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
*/
#define COBJMACROS
#include <assert.h>
#include "objbase.h"
#include "dmusici.h"
#include "dmusicf.h"
#include "dmobject.h"
#include "wine/debug.h"
WINE_DEFAULT_DEBUG_CHANNEL(dmobj);
WINE_DECLARE_DEBUG_CHANNEL(dmfile);
/* RIFF format parsing */
#define CHUNK_HDR_SIZE (sizeof(FOURCC) + sizeof(DWORD))
static inline const char *debugstr_fourcc(DWORD fourcc)
{
if (!fourcc) return "''";
return wine_dbg_sprintf("'%c%c%c%c'", (char)(fourcc), (char)(fourcc >> 8),
(char)(fourcc >> 16), (char)(fourcc >> 24));
}
const char *debugstr_chunk(const struct chunk_entry *chunk)
{
const char *type = "";
if (!chunk)
return "(null)";
if (chunk->id == FOURCC_RIFF || chunk->id == FOURCC_LIST)
type = wine_dbg_sprintf("type %s, ", debugstr_fourcc(chunk->type));
return wine_dbg_sprintf("%s chunk, %ssize %u", debugstr_fourcc(chunk->id), type, chunk->size);
}
static HRESULT stream_read(IStream *stream, void *data, ULONG size)
{
ULONG read;
HRESULT hr;
hr = IStream_Read(stream, data, size, &read);
if (FAILED(hr))
TRACE_(dmfile)("IStream_Read failed: %08x\n", hr);
else if (!read && read < size) {
/* All or nothing: Handle a partial read due to end of stream as an error */
TRACE_(dmfile)("Short read: %u < %u\n", read, size);
return E_FAIL;
}
return hr;
}
HRESULT stream_get_chunk(IStream *stream, struct chunk_entry *chunk)
{
static const LARGE_INTEGER zero;
ULONGLONG ck_end = 0, p_end = 0;
HRESULT hr;
hr = IStream_Seek(stream, zero, STREAM_SEEK_CUR, &chunk->offset);
if (FAILED(hr))
return hr;
assert(!(chunk->offset.QuadPart & 1));
if (chunk->parent) {
p_end = chunk->parent->offset.QuadPart + CHUNK_HDR_SIZE + ((chunk->parent->size + 1) & ~1);
if (chunk->offset.QuadPart == p_end)
return S_FALSE;
ck_end = chunk->offset.QuadPart + CHUNK_HDR_SIZE;
if (ck_end > p_end) {
WARN_(dmfile)("No space for sub-chunk header in parent chunk: ends at offset %s > %s\n",
wine_dbgstr_longlong(ck_end), wine_dbgstr_longlong(p_end));
return E_FAIL;
}
}
hr = stream_read(stream, chunk, CHUNK_HDR_SIZE);
if (hr != S_OK)
return hr;
if (chunk->parent) {
ck_end += (chunk->size + 1) & ~1;
if (ck_end > p_end) {
WARN_(dmfile)("No space for sub-chunk data in parent chunk: ends at offset %s > %s\n",
wine_dbgstr_longlong(ck_end), wine_dbgstr_longlong(p_end));
return E_FAIL;
}
}
if (chunk->id == FOURCC_LIST || chunk->id == FOURCC_RIFF) {
hr = stream_read(stream, &chunk->type, sizeof(FOURCC));
if (hr != S_OK)
return hr != S_FALSE ? hr : E_FAIL;
}
TRACE_(dmfile)("Returning %s\n", debugstr_chunk(chunk));
return S_OK;
}
HRESULT stream_skip_chunk(IStream *stream, struct chunk_entry *chunk)
{
LARGE_INTEGER end;
end.QuadPart = (chunk->offset.QuadPart + CHUNK_HDR_SIZE + chunk->size + 1) & ~(ULONGLONG)1;
return IStream_Seek(stream, end, STREAM_SEEK_SET, NULL);
}
HRESULT stream_next_chunk(IStream *stream, struct chunk_entry *chunk)
{
HRESULT hr;
if (chunk->id) {
hr = stream_skip_chunk(stream, chunk);
if (FAILED(hr))
return hr;
}
return stream_get_chunk(stream, chunk);
}
HRESULT stream_chunk_get_data(IStream *stream, const struct chunk_entry *chunk, void *data,
ULONG size)
{
if (chunk->size != size) {
WARN_(dmfile)("Chunk %s (size %u, offset %s) doesn't contains the expected data size %u\n",
debugstr_fourcc(chunk->id), chunk->size,
wine_dbgstr_longlong(chunk->offset.QuadPart), size);
return E_FAIL;
}
return stream_read(stream, data, size);
}
HRESULT stream_chunk_get_wstr(IStream *stream, const struct chunk_entry *chunk, WCHAR *str,
ULONG size)
{
ULONG len;
HRESULT hr;
hr = IStream_Read(stream, str, min(chunk->size, size), &len);
if (FAILED(hr))
return hr;
/* Don't assume the string is properly zero terminated */
str[min(len, size - 1)] = 0;
if (len < chunk->size)
return S_FALSE;
return S_OK;
}
/* Generic IDirectMusicObject methods */
static inline struct dmobject *impl_from_IDirectMusicObject(IDirectMusicObject *iface)
{
return CONTAINING_RECORD(iface, struct dmobject, IDirectMusicObject_iface);
}
HRESULT WINAPI dmobj_IDirectMusicObject_QueryInterface(IDirectMusicObject *iface, REFIID riid,
void **ret_iface)
{
struct dmobject *This = impl_from_IDirectMusicObject(iface);
return IUnknown_QueryInterface(This->outer_unk, riid, ret_iface);
}
ULONG WINAPI dmobj_IDirectMusicObject_AddRef(IDirectMusicObject *iface)
{
struct dmobject *This = impl_from_IDirectMusicObject(iface);
return IUnknown_AddRef(This->outer_unk);
}
ULONG WINAPI dmobj_IDirectMusicObject_Release(IDirectMusicObject *iface)
{
struct dmobject *This = impl_from_IDirectMusicObject(iface);
return IUnknown_Release(This->outer_unk);
}
HRESULT WINAPI dmobj_IDirectMusicObject_GetDescriptor(IDirectMusicObject *iface,
DMUS_OBJECTDESC *desc)
{
struct dmobject *This = impl_from_IDirectMusicObject(iface);
TRACE("(%p/%p)->(%p)\n", iface, This, desc);
if (!desc)
return E_POINTER;
memcpy(desc, &This->desc, This->desc.dwSize);
return S_OK;
}
HRESULT WINAPI dmobj_IDirectMusicObject_SetDescriptor(IDirectMusicObject *iface,
DMUS_OBJECTDESC *desc)
{
struct dmobject *This = impl_from_IDirectMusicObject(iface);
HRESULT ret = S_OK;
TRACE("(%p, %p)\n", iface, desc);
if (!desc)
return E_POINTER;
/* Immutable property */
if (desc->dwValidData & DMUS_OBJ_CLASS)
{
desc->dwValidData &= ~DMUS_OBJ_CLASS;
ret = S_FALSE;
}
/* Set only valid fields */
if (desc->dwValidData & DMUS_OBJ_OBJECT)
This->desc.guidObject = desc->guidObject;
if (desc->dwValidData & DMUS_OBJ_NAME)
lstrcpynW(This->desc.wszName, desc->wszName, DMUS_MAX_NAME);
if (desc->dwValidData & DMUS_OBJ_CATEGORY)
lstrcpynW(This->desc.wszCategory, desc->wszCategory, DMUS_MAX_CATEGORY);
if (desc->dwValidData & DMUS_OBJ_FILENAME)
lstrcpynW(This->desc.wszFileName, desc->wszFileName, DMUS_MAX_FILENAME);
if (desc->dwValidData & DMUS_OBJ_VERSION)
This->desc.vVersion = desc->vVersion;
if (desc->dwValidData & DMUS_OBJ_DATE)
This->desc.ftDate = desc->ftDate;
if (desc->dwValidData & DMUS_OBJ_MEMORY) {
This->desc.llMemLength = desc->llMemLength;
memcpy(This->desc.pbMemData, desc->pbMemData, desc->llMemLength);
}
if (desc->dwValidData & DMUS_OBJ_STREAM)
IStream_Clone(desc->pStream, &This->desc.pStream);
This->desc.dwValidData |= desc->dwValidData;
return ret;
}
/* Helper for IDirectMusicObject::ParseDescriptor */
static inline void info_get_name(IStream *stream, const struct chunk_entry *info,
DMUS_OBJECTDESC *desc)
{
struct chunk_entry chunk = {.parent = info};
char name[DMUS_MAX_NAME];
ULONG len;
HRESULT hr = E_FAIL;
while (stream_next_chunk(stream, &chunk) == S_OK)
if (chunk.id == mmioFOURCC('I','N','A','M'))
hr = IStream_Read(stream, name, min(chunk.size, sizeof(name)), &len);
if (SUCCEEDED(hr)) {
len = MultiByteToWideChar(CP_ACP, 0, name, len, desc->wszName, sizeof(desc->wszName));
desc->wszName[min(len, sizeof(desc->wszName) - 1)] = 0;
desc->dwValidData |= DMUS_OBJ_NAME;
}
}
static inline void unfo_get_name(IStream *stream, const struct chunk_entry *unfo,
DMUS_OBJECTDESC *desc, BOOL inam)
{
struct chunk_entry chunk = {.parent = unfo};
while (stream_next_chunk(stream, &chunk) == S_OK)
if (chunk.id == DMUS_FOURCC_UNAM_CHUNK || (inam && chunk.id == mmioFOURCC('I','N','A','M')))
if (stream_chunk_get_wstr(stream, &chunk, desc->wszName, sizeof(desc->wszName)) == S_OK)
desc->dwValidData |= DMUS_OBJ_NAME;
}
HRESULT dmobj_parsedescriptor(IStream *stream, const struct chunk_entry *riff,
DMUS_OBJECTDESC *desc, DWORD supported)
{
struct chunk_entry chunk = {.parent = riff};
HRESULT hr;
TRACE("Looking for %#x in %p: %s\n", supported, stream, debugstr_chunk(riff));
desc->dwValidData = 0;
desc->dwSize = sizeof(*desc);
while ((hr = stream_next_chunk(stream, &chunk)) == S_OK) {
switch (chunk.id) {
case DMUS_FOURCC_GUID_CHUNK:
if ((supported & DMUS_OBJ_OBJECT) && stream_chunk_get_data(stream, &chunk,
&desc->guidObject, sizeof(desc->guidObject)) == S_OK)
desc->dwValidData |= DMUS_OBJ_OBJECT;
break;
case DMUS_FOURCC_CATEGORY_CHUNK:
if ((supported & DMUS_OBJ_CATEGORY) && stream_chunk_get_wstr(stream, &chunk,
desc->wszCategory, sizeof(desc->wszCategory)) == S_OK)
desc->dwValidData |= DMUS_OBJ_CATEGORY;
break;
case DMUS_FOURCC_VERSION_CHUNK:
if ((supported & DMUS_OBJ_VERSION) && stream_chunk_get_data(stream, &chunk,
&desc->vVersion, sizeof(desc->vVersion)) == S_OK)
desc->dwValidData |= DMUS_OBJ_VERSION;
break;
case FOURCC_LIST:
if (chunk.type == DMUS_FOURCC_UNFO_LIST && (supported & DMUS_OBJ_NAME))
unfo_get_name(stream, &chunk, desc, supported & DMUS_OBJ_NAME_INAM);
else if (chunk.type == DMUS_FOURCC_INFO_LIST && (supported & DMUS_OBJ_NAME_INFO))
info_get_name(stream, &chunk, desc);
break;
}
}
TRACE("Found %#x\n", desc->dwValidData);
return hr;
}
/* Generic IPersistStream methods */
static inline struct dmobject *impl_from_IPersistStream(IPersistStream *iface)
{
return CONTAINING_RECORD(iface, struct dmobject, IPersistStream_iface);
}
HRESULT WINAPI dmobj_IPersistStream_QueryInterface(IPersistStream *iface, REFIID riid,
void **ret_iface)
{
struct dmobject *This = impl_from_IPersistStream(iface);
return IUnknown_QueryInterface(This->outer_unk, riid, ret_iface);
}
ULONG WINAPI dmobj_IPersistStream_AddRef(IPersistStream *iface)
{
struct dmobject *This = impl_from_IPersistStream(iface);
return IUnknown_AddRef(This->outer_unk);
}
ULONG WINAPI dmobj_IPersistStream_Release(IPersistStream *iface)
{
struct dmobject *This = impl_from_IPersistStream(iface);
return IUnknown_Release(This->outer_unk);
}
HRESULT WINAPI dmobj_IPersistStream_GetClassID(IPersistStream *iface, CLSID *class)
{
struct dmobject *This = impl_from_IPersistStream(iface);
TRACE("(%p, %p)\n", This, class);
if (!class)
return E_POINTER;
*class = This->desc.guidClass;
return S_OK;
}
/* IPersistStream methods not implemented in native */
HRESULT WINAPI unimpl_IPersistStream_GetClassID(IPersistStream *iface, CLSID *class)
{
TRACE("(%p, %p): method not implemented\n", iface, class);
return E_NOTIMPL;
}
HRESULT WINAPI unimpl_IPersistStream_IsDirty(IPersistStream *iface)
{
TRACE("(%p): method not implemented, always returning S_FALSE\n", iface);
return S_FALSE;
}
HRESULT WINAPI unimpl_IPersistStream_Save(IPersistStream *iface, IStream *stream,
BOOL clear_dirty)
{
TRACE("(%p, %p, %d): method not implemented\n", iface, stream, clear_dirty);
return E_NOTIMPL;
}
HRESULT WINAPI unimpl_IPersistStream_GetSizeMax(IPersistStream *iface, ULARGE_INTEGER *size)
{
TRACE("(%p, %p): method not implemented\n", iface, size);
return E_NOTIMPL;
}
void dmobject_init(struct dmobject *dmobj, const GUID *class, IUnknown *outer_unk)
{
dmobj->outer_unk = outer_unk;
dmobj->desc.dwSize = sizeof(dmobj->desc);
dmobj->desc.dwValidData = DMUS_OBJ_CLASS;
dmobj->desc.guidClass = *class;
}