1 /* Debug and Helper Functions
3 * Copyright (C) 2004 Rok Mandeljc
4 * Copyright (C) 2004 Raphael Junqueira
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
24 #include "wine/port.h"
36 #include "wine/debug.h"
37 #include "wine/unicode.h"
46 WINE_DEFAULT_DEBUG_CHANNEL(dmusic
);
47 WINE_DECLARE_DEBUG_CHANNEL(dmfile
);
49 HRESULT
IDirectMusicUtils_IPersistStream_ParseDescGeneric (DMUS_PRIVATE_CHUNK
* pChunk
, IStream
* pStm
, LPDMUS_OBJECTDESC pDesc
) {
51 switch (pChunk
->fccID
) {
52 case DMUS_FOURCC_GUID_CHUNK
: {
53 TRACE_(dmfile
)(": GUID chunk\n");
54 pDesc
->dwValidData
|= DMUS_OBJ_OBJECT
;
55 IStream_Read (pStm
, &pDesc
->guidObject
, pChunk
->dwSize
, NULL
);
58 case DMUS_FOURCC_DATE_CHUNK
: {
59 TRACE_(dmfile
)(": file date chunk\n");
60 pDesc
->dwValidData
|= DMUS_OBJ_DATE
;
61 IStream_Read (pStm
, &pDesc
->ftDate
, pChunk
->dwSize
, NULL
);
64 case DMUS_FOURCC_NAME_CHUNK
: {
65 TRACE_(dmfile
)(": name chunk\n");
66 pDesc
->dwValidData
|= DMUS_OBJ_NAME
;
67 IStream_Read (pStm
, pDesc
->wszName
, pChunk
->dwSize
, NULL
);
70 case DMUS_FOURCC_FILE_CHUNK
: {
71 TRACE_(dmfile
)(": file name chunk\n");
72 pDesc
->dwValidData
|= DMUS_OBJ_FILENAME
;
73 IStream_Read (pStm
, pDesc
->wszFileName
, pChunk
->dwSize
, NULL
);
76 case DMUS_FOURCC_VERSION_CHUNK
: {
77 TRACE_(dmfile
)(": version chunk\n");
78 pDesc
->dwValidData
|= DMUS_OBJ_VERSION
;
79 IStream_Read (pStm
, &pDesc
->vVersion
, pChunk
->dwSize
, NULL
);
82 case DMUS_FOURCC_CATEGORY_CHUNK
: {
83 TRACE_(dmfile
)(": category chunk\n");
84 pDesc
->dwValidData
|= DMUS_OBJ_CATEGORY
;
85 IStream_Read (pStm
, pDesc
->wszCategory
, pChunk
->dwSize
, NULL
);
96 HRESULT
IDirectMusicUtils_IPersistStream_ParseUNFOGeneric (DMUS_PRIVATE_CHUNK
* pChunk
, IStream
* pStm
, LPDMUS_OBJECTDESC pDesc
) {
98 LARGE_INTEGER liMove
; /* used when skipping chunks */
101 * don't ask me why, but M$ puts INFO elements in UNFO list sometimes
102 * (though strings seem to be valid unicode)
104 switch (pChunk
->fccID
) {
106 case mmioFOURCC('I','N','A','M'):
107 case DMUS_FOURCC_UNAM_CHUNK
: {
108 TRACE_(dmfile
)(": name chunk\n");
109 pDesc
->dwValidData
|= DMUS_OBJ_NAME
;
110 IStream_Read (pStm
, pDesc
->wszName
, pChunk
->dwSize
, NULL
);
111 TRACE_(dmfile
)(" - wszName: %s\n", debugstr_w(pDesc
->wszName
));
115 case mmioFOURCC('I','A','R','T'):
116 case DMUS_FOURCC_UART_CHUNK
: {
117 TRACE_(dmfile
)(": artist chunk (ignored)\n");
118 liMove
.QuadPart
= pChunk
->dwSize
;
119 IStream_Seek (pStm
, liMove
, STREAM_SEEK_CUR
, NULL
);
122 case mmioFOURCC('I','C','O','P'):
123 case DMUS_FOURCC_UCOP_CHUNK
: {
124 TRACE_(dmfile
)(": copyright chunk (ignored)\n");
125 liMove
.QuadPart
= pChunk
->dwSize
;
126 IStream_Seek (pStm
, liMove
, STREAM_SEEK_CUR
, NULL
);
129 case mmioFOURCC('I','S','B','J'):
130 case DMUS_FOURCC_USBJ_CHUNK
: {
131 TRACE_(dmfile
)(": subject chunk (ignored)\n");
132 liMove
.QuadPart
= pChunk
->dwSize
;
133 IStream_Seek (pStm
, liMove
, STREAM_SEEK_CUR
, NULL
);
136 case mmioFOURCC('I','C','M','T'):
137 case DMUS_FOURCC_UCMT_CHUNK
: {
138 TRACE_(dmfile
)(": comment chunk (ignored)\n");
139 liMove
.QuadPart
= pChunk
->dwSize
;
140 IStream_Seek (pStm
, liMove
, STREAM_SEEK_CUR
, NULL
);
151 HRESULT
IDirectMusicUtils_IPersistStream_ParseReference (LPPERSISTSTREAM iface
, DMUS_PRIVATE_CHUNK
* pChunk
, IStream
* pStm
, IDirectMusicObject
** ppObject
) {
152 DMUS_PRIVATE_CHUNK Chunk
;
153 DWORD ListSize
[3], ListCount
[3];
154 LARGE_INTEGER liMove
; /* used when skipping chunks */
157 DMUS_IO_REFERENCE ref
;
158 DMUS_OBJECTDESC ref_desc
;
160 memset(&ref
, 0, sizeof(ref
));
161 memset(&ref_desc
, 0, sizeof(ref_desc
));
163 if (pChunk
->fccID
!= DMUS_FOURCC_REF_LIST
) {
164 ERR_(dmfile
)(": %s chunk should be a REF list\n", debugstr_fourcc (pChunk
->fccID
));
168 ListSize
[0] = pChunk
->dwSize
- sizeof(FOURCC
);
172 IStream_Read (pStm
, &Chunk
, sizeof(FOURCC
)+sizeof(DWORD
), NULL
);
173 ListCount
[0] += sizeof(FOURCC
) + sizeof(DWORD
) + Chunk
.dwSize
;
174 TRACE_(dmfile
)(": %s chunk (size = %d)", debugstr_fourcc (Chunk
.fccID
), Chunk
.dwSize
);
176 hr
= IDirectMusicUtils_IPersistStream_ParseDescGeneric(&Chunk
, pStm
, &ref_desc
);
177 if (FAILED(hr
)) return hr
;
180 switch (Chunk
.fccID
) {
181 case DMUS_FOURCC_REF_CHUNK
: {
182 TRACE_(dmfile
)(": Reference chunk\n");
183 if (Chunk
.dwSize
!= sizeof(DMUS_IO_REFERENCE
)) return E_FAIL
;
184 IStream_Read (pStm
, &ref
, sizeof(DMUS_IO_REFERENCE
), NULL
);
185 TRACE_(dmfile
)(" - guidClassID: %s\n", debugstr_dmguid(&ref
.guidClassID
));
186 TRACE_(dmfile
)(" - dwValidData: %u\n", ref
.dwValidData
);
190 TRACE_(dmfile
)(": unknown chunk (irrevelant & skipping)\n");
191 liMove
.QuadPart
= Chunk
.dwSize
;
192 IStream_Seek (pStm
, liMove
, STREAM_SEEK_CUR
, NULL
);
197 TRACE_(dmfile
)(": ListCount[0] = %d < ListSize[0] = %d\n", ListCount
[0], ListSize
[0]);
198 } while (ListCount
[0] < ListSize
[0]);
200 ref_desc
.dwValidData
|= DMUS_OBJ_CLASS
;
201 ref_desc
.guidClass
= ref
.guidClassID
;
203 TRACE_(dmfile
)("** DM Reference Begin of Load ***\n");
204 TRACE_(dmfile
)("With Desc:\n");
205 debugstr_DMUS_OBJECTDESC(&ref_desc
);
208 LPDIRECTMUSICGETLOADER pGetLoader
= NULL
;
209 LPDIRECTMUSICLOADER pLoader
= NULL
;
211 IStream_QueryInterface (pStm
, &IID_IDirectMusicGetLoader
, (LPVOID
*)&pGetLoader
);
212 IDirectMusicGetLoader_GetLoader (pGetLoader
, &pLoader
);
213 IDirectMusicGetLoader_Release (pGetLoader
);
215 hr
= IDirectMusicLoader_GetObject (pLoader
, &ref_desc
, &IID_IDirectMusicObject
, (LPVOID
*)ppObject
);
216 IDirectMusicLoader_Release (pLoader
); /* release loader */
218 TRACE_(dmfile
)("** DM Reference End of Load ***\n");
223 /* FOURCC to string conversion for debug messages */
224 const char *debugstr_fourcc (DWORD fourcc
) {
225 if (!fourcc
) return "'null'";
226 return wine_dbg_sprintf ("\'%c%c%c%c\'",
227 (char)(fourcc
), (char)(fourcc
>> 8),
228 (char)(fourcc
>> 16), (char)(fourcc
>> 24));
231 /* DMUS_VERSION struct to string conversion for debug messages */
232 static const char *debugstr_dmversion (const DMUS_VERSION
*version
) {
233 if (!version
) return "'null'";
234 return wine_dbg_sprintf ("\'%i,%i,%i,%i\'",
235 HIWORD(version
->dwVersionMS
),LOWORD(version
->dwVersionMS
),
236 HIWORD(version
->dwVersionLS
), LOWORD(version
->dwVersionLS
));
239 /* month number into month name (for debugstr_filetime) */
240 static const char *debugstr_month (DWORD dwMonth
) {
242 case 1: return "January";
243 case 2: return "February";
244 case 3: return "March";
245 case 4: return "April";
246 case 5: return "May";
247 case 6: return "June";
248 case 7: return "July";
249 case 8: return "August";
250 case 9: return "September";
251 case 10: return "October";
252 case 11: return "November";
253 case 12: return "December";
254 default: return "Invalid";
258 /* FILETIME struct to string conversion for debug messages */
259 static const char *debugstr_filetime (const FILETIME
*time
) {
262 if (!time
) return "'null'";
264 FileTimeToSystemTime (time
, &sysTime
);
266 return wine_dbg_sprintf ("\'%02i. %s %04i %02i:%02i:%02i\'",
267 sysTime
.wDay
, debugstr_month(sysTime
.wMonth
), sysTime
.wYear
,
268 sysTime
.wHour
, sysTime
.wMinute
, sysTime
.wSecond
);
271 /* returns name of given GUID */
272 const char *debugstr_dmguid (const GUID
*id
) {
273 static const guid_info guids
[] = {
275 GE(CLSID_AudioVBScript
),
276 GE(CLSID_DirectMusic
),
277 GE(CLSID_DirectMusicAudioPath
),
278 GE(CLSID_DirectMusicAudioPathConfig
),
279 GE(CLSID_DirectMusicAuditionTrack
),
280 GE(CLSID_DirectMusicBand
),
281 GE(CLSID_DirectMusicBandTrack
),
282 GE(CLSID_DirectMusicChordMapTrack
),
283 GE(CLSID_DirectMusicChordMap
),
284 GE(CLSID_DirectMusicChordTrack
),
285 GE(CLSID_DirectMusicCollection
),
286 GE(CLSID_DirectMusicCommandTrack
),
287 GE(CLSID_DirectMusicComposer
),
288 GE(CLSID_DirectMusicContainer
),
289 GE(CLSID_DirectMusicGraph
),
290 GE(CLSID_DirectMusicLoader
),
291 GE(CLSID_DirectMusicLyricsTrack
),
292 GE(CLSID_DirectMusicMarkerTrack
),
293 GE(CLSID_DirectMusicMelodyFormulationTrack
),
294 GE(CLSID_DirectMusicMotifTrack
),
295 GE(CLSID_DirectMusicMuteTrack
),
296 GE(CLSID_DirectMusicParamControlTrack
),
297 GE(CLSID_DirectMusicPatternTrack
),
298 GE(CLSID_DirectMusicPerformance
),
299 GE(CLSID_DirectMusicScript
),
300 GE(CLSID_DirectMusicScriptAutoImpSegment
),
301 GE(CLSID_DirectMusicScriptAutoImpPerformance
),
302 GE(CLSID_DirectMusicScriptAutoImpSegmentState
),
303 GE(CLSID_DirectMusicScriptAutoImpAudioPathConfig
),
304 GE(CLSID_DirectMusicScriptAutoImpAudioPath
),
305 GE(CLSID_DirectMusicScriptAutoImpSong
),
306 GE(CLSID_DirectMusicScriptSourceCodeLoader
),
307 GE(CLSID_DirectMusicScriptTrack
),
308 GE(CLSID_DirectMusicSection
),
309 GE(CLSID_DirectMusicSegment
),
310 GE(CLSID_DirectMusicSegmentState
),
311 GE(CLSID_DirectMusicSegmentTriggerTrack
),
312 GE(CLSID_DirectMusicSegTriggerTrack
),
313 GE(CLSID_DirectMusicSeqTrack
),
314 GE(CLSID_DirectMusicSignPostTrack
),
315 GE(CLSID_DirectMusicSong
),
316 GE(CLSID_DirectMusicStyle
),
317 GE(CLSID_DirectMusicStyleTrack
),
318 GE(CLSID_DirectMusicSynth
),
319 GE(CLSID_DirectMusicSynthSink
),
320 GE(CLSID_DirectMusicSysExTrack
),
321 GE(CLSID_DirectMusicTemplate
),
322 GE(CLSID_DirectMusicTempoTrack
),
323 GE(CLSID_DirectMusicTimeSigTrack
),
324 GE(CLSID_DirectMusicWaveTrack
),
325 GE(CLSID_DirectSoundWave
),
327 GE(IID_IDirectMusic
),
328 GE(IID_IDirectMusic2
),
329 GE(IID_IDirectMusic8
),
330 GE(IID_IDirectMusicAudioPath
),
331 GE(IID_IDirectMusicBand
),
332 GE(IID_IDirectMusicBuffer
),
333 GE(IID_IDirectMusicChordMap
),
334 GE(IID_IDirectMusicCollection
),
335 GE(IID_IDirectMusicComposer
),
336 GE(IID_IDirectMusicContainer
),
337 GE(IID_IDirectMusicDownload
),
338 GE(IID_IDirectMusicDownloadedInstrument
),
339 GE(IID_IDirectMusicGetLoader
),
340 GE(IID_IDirectMusicGraph
),
341 GE(IID_IDirectMusicInstrument
),
342 GE(IID_IDirectMusicLoader
),
343 GE(IID_IDirectMusicLoader8
),
344 GE(IID_IDirectMusicObject
),
345 GE(IID_IDirectMusicPatternTrack
),
346 GE(IID_IDirectMusicPerformance
),
347 GE(IID_IDirectMusicPerformance2
),
348 GE(IID_IDirectMusicPerformance8
),
349 GE(IID_IDirectMusicPort
),
350 GE(IID_IDirectMusicPortDownload
),
351 GE(IID_IDirectMusicScript
),
352 GE(IID_IDirectMusicSegment
),
353 GE(IID_IDirectMusicSegment2
),
354 GE(IID_IDirectMusicSegment8
),
355 GE(IID_IDirectMusicSegmentState
),
356 GE(IID_IDirectMusicSegmentState8
),
357 GE(IID_IDirectMusicStyle
),
358 GE(IID_IDirectMusicStyle8
),
359 GE(IID_IDirectMusicSynth
),
360 GE(IID_IDirectMusicSynth8
),
361 GE(IID_IDirectMusicSynthSink
),
362 GE(IID_IDirectMusicThru
),
363 GE(IID_IDirectMusicTool
),
364 GE(IID_IDirectMusicTool8
),
365 GE(IID_IDirectMusicTrack
),
366 GE(IID_IDirectMusicTrack8
),
368 GE(IID_IPersistStream
),
370 GE(IID_IClassFactory
),
372 GE(GUID_DirectMusicAllTypes
),
373 GE(GUID_NOTIFICATION_CHORD
),
374 GE(GUID_NOTIFICATION_COMMAND
),
375 GE(GUID_NOTIFICATION_MEASUREANDBEAT
),
376 GE(GUID_NOTIFICATION_PERFORMANCE
),
377 GE(GUID_NOTIFICATION_RECOMPOSE
),
378 GE(GUID_NOTIFICATION_SEGMENT
),
381 GE(GUID_CommandParam
),
382 GE(GUID_CommandParam2
),
383 GE(GUID_CommandParamNext
),
384 GE(GUID_IDirectMusicBand
),
385 GE(GUID_IDirectMusicChordMap
),
386 GE(GUID_IDirectMusicStyle
),
388 GE(GUID_Play_Marker
),
389 GE(GUID_RhythmParam
),
391 GE(GUID_TimeSignature
),
392 GE(GUID_Valid_Start_Time
),
393 GE(GUID_Clear_All_Bands
),
394 GE(GUID_ConnectToDLSCollection
),
395 GE(GUID_Disable_Auto_Download
),
396 GE(GUID_DisableTempo
),
397 GE(GUID_DisableTimeSig
),
399 GE(GUID_DownloadToAudioPath
),
400 GE(GUID_Enable_Auto_Download
),
401 GE(GUID_EnableTempo
),
402 GE(GUID_EnableTimeSig
),
403 GE(GUID_IgnoreBankSelectForGM
),
404 GE(GUID_SeedVariations
),
405 GE(GUID_StandardMIDIFile
),
407 GE(GUID_UnloadFromAudioPath
),
409 GE(GUID_PerfMasterTempo
),
410 GE(GUID_PerfMasterVolume
),
411 GE(GUID_PerfMasterGrooveLevel
),
412 GE(GUID_PerfAutoDownload
),
413 GE(GUID_DefaultGMCollection
),
414 GE(GUID_Synth_Default
),
415 GE(GUID_Buffer_Reverb
),
416 GE(GUID_Buffer_EnvReverb
),
417 GE(GUID_Buffer_Stereo
),
418 GE(GUID_Buffer_3D_Dry
),
419 GE(GUID_Buffer_Mono
),
420 GE(GUID_DMUS_PROP_GM_Hardware
),
421 GE(GUID_DMUS_PROP_GS_Capable
),
422 GE(GUID_DMUS_PROP_GS_Hardware
),
423 GE(GUID_DMUS_PROP_DLS1
),
424 GE(GUID_DMUS_PROP_DLS2
),
425 GE(GUID_DMUS_PROP_Effects
),
426 GE(GUID_DMUS_PROP_INSTRUMENT2
),
427 GE(GUID_DMUS_PROP_LegacyCaps
),
428 GE(GUID_DMUS_PROP_MemorySize
),
429 GE(GUID_DMUS_PROP_SampleMemorySize
),
430 GE(GUID_DMUS_PROP_SamplePlaybackRate
),
431 GE(GUID_DMUS_PROP_SetSynthSink
),
432 GE(GUID_DMUS_PROP_SinkUsesDSound
),
433 GE(GUID_DMUS_PROP_SynthSink_DSOUND
),
434 GE(GUID_DMUS_PROP_SynthSink_WAVE
),
435 GE(GUID_DMUS_PROP_Volume
),
436 GE(GUID_DMUS_PROP_WavesReverb
),
437 GE(GUID_DMUS_PROP_WriteLatency
),
438 GE(GUID_DMUS_PROP_WritePeriod
),
439 GE(GUID_DMUS_PROP_XG_Capable
),
440 GE(GUID_DMUS_PROP_XG_Hardware
)
445 if (!id
) return "(null)";
446 for (i
= 0; i
< sizeof(guids
)/sizeof(guids
[0]); i
++) {
447 if (IsEqualGUID(id
, guids
[i
].guid
))
448 return guids
[i
].name
;
451 /* if we didn't find it, act like standard debugstr_guid */
452 return debugstr_guid(id
);
455 /* generic flag-dumping function */
456 static const char* debugstr_flags (DWORD flags
, const flag_info
* names
, size_t num_names
){
457 static char buffer
[128] = "", *ptr
= &buffer
[0];
459 int size
= sizeof(buffer
);
461 for (i
=0; i
< num_names
; i
++) {
462 if ((flags
& names
[i
].val
)) {
463 int cnt
= snprintf(ptr
, size
, "%s ", names
[i
].name
);
464 if (cnt
< 0 || cnt
>= size
) break;
474 /* dump DMUS_OBJ flags */
475 static const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask
) {
476 static const flag_info flags
[] = {
480 FE(DMUS_OBJ_CATEGORY
),
481 FE(DMUS_OBJ_FILENAME
),
482 FE(DMUS_OBJ_FULLPATH
),
484 FE(DMUS_OBJ_VERSION
),
490 return debugstr_flags (flagmask
, flags
, sizeof(flags
)/sizeof(flags
[0]));
493 const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc
) {
495 char buffer
[1024], *ptr
= buffer
;
497 ptr
+= sprintf(ptr
, "DMUS_OBJECTDESC (%p):\n", pDesc
);
498 ptr
+= sprintf(ptr
, " - dwSize = 0x%08X\n", pDesc
->dwSize
);
499 ptr
+= sprintf(ptr
, " - dwValidData = 0x%08X ( %s)\n", pDesc
->dwValidData
, debugstr_DMUS_OBJ_FLAGS (pDesc
->dwValidData
));
500 if (pDesc
->dwValidData
& DMUS_OBJ_CLASS
) ptr
+= sprintf(ptr
, " - guidClass = %s\n", debugstr_dmguid(&pDesc
->guidClass
));
501 if (pDesc
->dwValidData
& DMUS_OBJ_OBJECT
) ptr
+= sprintf(ptr
, " - guidObject = %s\n", debugstr_guid(&pDesc
->guidObject
));
502 if (pDesc
->dwValidData
& DMUS_OBJ_DATE
) ptr
+= sprintf(ptr
, " - ftDate = %s\n", debugstr_filetime (&pDesc
->ftDate
));
503 if (pDesc
->dwValidData
& DMUS_OBJ_VERSION
) ptr
+= sprintf(ptr
, " - vVersion = %s\n", debugstr_dmversion(&pDesc
->vVersion
));
504 if (pDesc
->dwValidData
& DMUS_OBJ_NAME
) ptr
+= sprintf(ptr
, " - wszName = %s\n", debugstr_w(pDesc
->wszName
));
505 if (pDesc
->dwValidData
& DMUS_OBJ_CATEGORY
) ptr
+= sprintf(ptr
, " - wszCategory = %s\n", debugstr_w(pDesc
->wszCategory
));
506 if (pDesc
->dwValidData
& DMUS_OBJ_FILENAME
) ptr
+= sprintf(ptr
, " - wszFileName = %s\n", debugstr_w(pDesc
->wszFileName
));
507 if (pDesc
->dwValidData
& DMUS_OBJ_MEMORY
) ptr
+= sprintf(ptr
, " - llMemLength = 0x%s\n - pbMemData = %p\n",
508 wine_dbgstr_longlong(pDesc
->llMemLength
), pDesc
->pbMemData
);
509 if (pDesc
->dwValidData
& DMUS_OBJ_STREAM
) ptr
+= sprintf(ptr
, " - pStream = %p\n", pDesc
->pStream
);
511 return wine_dbg_sprintf("%s", buffer
);
513 return wine_dbg_sprintf("(NULL)");