wined3d: Properly reset the stateblock.
[wine/wine64.git] / dlls / dmstyle / dmutils.c
blob72014612e98cd0274cd55d1bdd38ead43aa61be6
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
21 #include <stdio.h>
22 #include <stdarg.h>
23 #include <string.h>
25 #define COBJMACROS
27 #include "windef.h"
28 #include "winbase.h"
29 #include "winnt.h"
30 #include "wingdi.h"
31 #include "winuser.h"
33 #include "wine/debug.h"
34 #include "wine/unicode.h"
35 #include "objbase.h"
37 #include "dmusici.h"
38 #include "dmusicf.h"
39 #include "dmusics.h"
41 #include "dmutils.h"
43 WINE_DEFAULT_DEBUG_CHANNEL(dmusic);
44 WINE_DECLARE_DEBUG_CHANNEL(dmfile);
46 HRESULT IDirectMusicUtils_IPersistStream_ParseDescGeneric (DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, LPDMUS_OBJECTDESC pDesc) {
48 switch (pChunk->fccID) {
49 case DMUS_FOURCC_GUID_CHUNK: {
50 TRACE_(dmfile)(": GUID chunk\n");
51 pDesc->dwValidData |= DMUS_OBJ_OBJECT;
52 IStream_Read (pStm, &pDesc->guidObject, pChunk->dwSize, NULL);
53 break;
55 case DMUS_FOURCC_DATE_CHUNK: {
56 TRACE_(dmfile)(": file date chunk\n");
57 pDesc->dwValidData |= DMUS_OBJ_DATE;
58 IStream_Read (pStm, &pDesc->ftDate, pChunk->dwSize, NULL);
59 break;
61 case DMUS_FOURCC_NAME_CHUNK: {
62 TRACE_(dmfile)(": name chunk\n");
63 pDesc->dwValidData |= DMUS_OBJ_NAME;
64 IStream_Read (pStm, pDesc->wszName, pChunk->dwSize, NULL);
65 break;
67 case DMUS_FOURCC_FILE_CHUNK: {
68 TRACE_(dmfile)(": file name chunk\n");
69 pDesc->dwValidData |= DMUS_OBJ_FILENAME;
70 IStream_Read (pStm, pDesc->wszFileName, pChunk->dwSize, NULL);
71 break;
73 case DMUS_FOURCC_VERSION_CHUNK: {
74 TRACE_(dmfile)(": version chunk\n");
75 pDesc->dwValidData |= DMUS_OBJ_VERSION;
76 IStream_Read (pStm, &pDesc->vVersion, pChunk->dwSize, NULL);
77 break;
79 case DMUS_FOURCC_CATEGORY_CHUNK: {
80 TRACE_(dmfile)(": category chunk\n");
81 pDesc->dwValidData |= DMUS_OBJ_CATEGORY;
82 IStream_Read (pStm, pDesc->wszCategory, pChunk->dwSize, NULL);
83 break;
85 default:
86 /* not handled */
87 return S_FALSE;
90 return S_OK;
93 HRESULT IDirectMusicUtils_IPersistStream_ParseUNFOGeneric (DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, LPDMUS_OBJECTDESC pDesc) {
95 LARGE_INTEGER liMove; /* used when skipping chunks */
97 /**
98 * don't ask me why, but M$ puts INFO elements in UNFO list sometimes
99 * (though strings seem to be valid unicode)
101 switch (pChunk->fccID) {
103 case mmioFOURCC('I','N','A','M'):
104 case DMUS_FOURCC_UNAM_CHUNK: {
105 TRACE_(dmfile)(": name chunk\n");
106 pDesc->dwValidData |= DMUS_OBJ_NAME;
107 IStream_Read (pStm, pDesc->wszName, pChunk->dwSize, NULL);
108 TRACE_(dmfile)(" - wszName: %s\n", debugstr_w(pDesc->wszName));
109 break;
112 case mmioFOURCC('I','A','R','T'):
113 case DMUS_FOURCC_UART_CHUNK: {
114 TRACE_(dmfile)(": artist chunk (ignored)\n");
115 liMove.QuadPart = pChunk->dwSize;
116 IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL);
117 break;
119 case mmioFOURCC('I','C','O','P'):
120 case DMUS_FOURCC_UCOP_CHUNK: {
121 TRACE_(dmfile)(": copyright chunk (ignored)\n");
122 liMove.QuadPart = pChunk->dwSize;
123 IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL);
124 break;
126 case mmioFOURCC('I','S','B','J'):
127 case DMUS_FOURCC_USBJ_CHUNK: {
128 TRACE_(dmfile)(": subject chunk (ignored)\n");
129 liMove.QuadPart = pChunk->dwSize;
130 IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL);
131 break;
133 case mmioFOURCC('I','C','M','T'):
134 case DMUS_FOURCC_UCMT_CHUNK: {
135 TRACE_(dmfile)(": comment chunk (ignored)\n");
136 liMove.QuadPart = pChunk->dwSize;
137 IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL);
138 break;
140 default:
141 /* not handled */
142 return S_FALSE;
145 return S_OK;
148 HRESULT IDirectMusicUtils_IPersistStream_ParseReference (LPPERSISTSTREAM iface, DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, IDirectMusicObject** ppObject) {
149 DMUS_PRIVATE_CHUNK Chunk;
150 DWORD ListSize[3], ListCount[3];
151 LARGE_INTEGER liMove; /* used when skipping chunks */
152 HRESULT hr;
154 DMUS_IO_REFERENCE ref;
155 DMUS_OBJECTDESC ref_desc;
157 memset(&ref, 0, sizeof(ref));
158 memset(&ref_desc, 0, sizeof(ref_desc));
160 if (pChunk->fccID != DMUS_FOURCC_REF_LIST) {
161 ERR_(dmfile)(": %s chunk should be a REF list\n", debugstr_fourcc (pChunk->fccID));
162 return E_FAIL;
165 ListSize[0] = pChunk->dwSize - sizeof(FOURCC);
166 ListCount[0] = 0;
168 do {
169 IStream_Read (pStm, &Chunk, sizeof(FOURCC)+sizeof(DWORD), NULL);
170 ListCount[0] += sizeof(FOURCC) + sizeof(DWORD) + Chunk.dwSize;
171 TRACE_(dmfile)(": %s chunk (size = %d)", debugstr_fourcc (Chunk.fccID), Chunk.dwSize);
173 hr = IDirectMusicUtils_IPersistStream_ParseDescGeneric(&Chunk, pStm, &ref_desc);
174 if (FAILED(hr)) return hr;
176 if (hr == S_FALSE) {
177 switch (Chunk.fccID) {
178 case DMUS_FOURCC_REF_CHUNK: {
179 TRACE_(dmfile)(": Reference chunk\n");
180 if (Chunk.dwSize != sizeof(DMUS_IO_REFERENCE)) return E_FAIL;
181 IStream_Read (pStm, &ref, sizeof(DMUS_IO_REFERENCE), NULL);
182 TRACE_(dmfile)(" - guidClassID: %s\n", debugstr_dmguid(&ref.guidClassID));
183 TRACE_(dmfile)(" - dwValidData: %u\n", ref.dwValidData);
184 break;
186 default: {
187 TRACE_(dmfile)(": unknown chunk (irrevelant & skipping)\n");
188 liMove.QuadPart = Chunk.dwSize;
189 IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL);
190 break;
194 TRACE_(dmfile)(": ListCount[0] = %d < ListSize[0] = %d\n", ListCount[0], ListSize[0]);
195 } while (ListCount[0] < ListSize[0]);
197 ref_desc.dwValidData |= DMUS_OBJ_CLASS;
198 ref_desc.guidClass = ref.guidClassID;
200 TRACE_(dmfile)("** DM Reference Begin of Load ***\n");
201 TRACE_(dmfile)("With Desc:\n");
202 debugstr_DMUS_OBJECTDESC(&ref_desc);
205 LPDIRECTMUSICGETLOADER pGetLoader = NULL;
206 LPDIRECTMUSICLOADER pLoader = NULL;
208 IStream_QueryInterface (pStm, &IID_IDirectMusicGetLoader, (LPVOID*)&pGetLoader);
209 IDirectMusicGetLoader_GetLoader (pGetLoader, &pLoader);
210 IDirectMusicGetLoader_Release (pGetLoader);
212 hr = IDirectMusicLoader_GetObject (pLoader, &ref_desc, &IID_IDirectMusicObject, (LPVOID*)ppObject);
213 IDirectMusicLoader_Release (pLoader); /* release loader */
215 TRACE_(dmfile)("** DM Reference End of Load ***\n");
217 return S_OK;
220 /* FOURCC to string conversion for debug messages */
221 const char *debugstr_fourcc (DWORD fourcc) {
222 if (!fourcc) return "'null'";
223 return wine_dbg_sprintf ("\'%c%c%c%c\'",
224 (char)(fourcc), (char)(fourcc >> 8),
225 (char)(fourcc >> 16), (char)(fourcc >> 24));
228 /* DMUS_VERSION struct to string conversion for debug messages */
229 static const char *debugstr_dmversion (const DMUS_VERSION *version) {
230 if (!version) return "'null'";
231 return wine_dbg_sprintf ("\'%i,%i,%i,%i\'",
232 HIWORD(version->dwVersionMS),LOWORD(version->dwVersionMS),
233 HIWORD(version->dwVersionLS), LOWORD(version->dwVersionLS));
236 /* month number into month name (for debugstr_filetime) */
237 static const char *debugstr_month (DWORD dwMonth) {
238 switch (dwMonth) {
239 case 1: return "January";
240 case 2: return "February";
241 case 3: return "March";
242 case 4: return "April";
243 case 5: return "May";
244 case 6: return "June";
245 case 7: return "July";
246 case 8: return "August";
247 case 9: return "September";
248 case 10: return "October";
249 case 11: return "November";
250 case 12: return "December";
251 default: return "Invalid";
255 /* FILETIME struct to string conversion for debug messages */
256 static const char *debugstr_filetime (const FILETIME *time) {
257 SYSTEMTIME sysTime;
259 if (!time) return "'null'";
261 FileTimeToSystemTime (time, &sysTime);
263 return wine_dbg_sprintf ("\'%02i. %s %04i %02i:%02i:%02i\'",
264 sysTime.wDay, debugstr_month(sysTime.wMonth), sysTime.wYear,
265 sysTime.wHour, sysTime.wMinute, sysTime.wSecond);
268 /* returns name of given GUID */
269 const char *debugstr_dmguid (const GUID *id) {
270 static const guid_info guids[] = {
271 /* CLSIDs */
272 GE(CLSID_AudioVBScript),
273 GE(CLSID_DirectMusic),
274 GE(CLSID_DirectMusicAudioPath),
275 GE(CLSID_DirectMusicAudioPathConfig),
276 GE(CLSID_DirectMusicAuditionTrack),
277 GE(CLSID_DirectMusicBand),
278 GE(CLSID_DirectMusicBandTrack),
279 GE(CLSID_DirectMusicChordMapTrack),
280 GE(CLSID_DirectMusicChordMap),
281 GE(CLSID_DirectMusicChordTrack),
282 GE(CLSID_DirectMusicCollection),
283 GE(CLSID_DirectMusicCommandTrack),
284 GE(CLSID_DirectMusicComposer),
285 GE(CLSID_DirectMusicContainer),
286 GE(CLSID_DirectMusicGraph),
287 GE(CLSID_DirectMusicLoader),
288 GE(CLSID_DirectMusicLyricsTrack),
289 GE(CLSID_DirectMusicMarkerTrack),
290 GE(CLSID_DirectMusicMelodyFormulationTrack),
291 GE(CLSID_DirectMusicMotifTrack),
292 GE(CLSID_DirectMusicMuteTrack),
293 GE(CLSID_DirectMusicParamControlTrack),
294 GE(CLSID_DirectMusicPatternTrack),
295 GE(CLSID_DirectMusicPerformance),
296 GE(CLSID_DirectMusicScript),
297 GE(CLSID_DirectMusicScriptAutoImpSegment),
298 GE(CLSID_DirectMusicScriptAutoImpPerformance),
299 GE(CLSID_DirectMusicScriptAutoImpSegmentState),
300 GE(CLSID_DirectMusicScriptAutoImpAudioPathConfig),
301 GE(CLSID_DirectMusicScriptAutoImpAudioPath),
302 GE(CLSID_DirectMusicScriptAutoImpSong),
303 GE(CLSID_DirectMusicScriptSourceCodeLoader),
304 GE(CLSID_DirectMusicScriptTrack),
305 GE(CLSID_DirectMusicSection),
306 GE(CLSID_DirectMusicSegment),
307 GE(CLSID_DirectMusicSegmentState),
308 GE(CLSID_DirectMusicSegmentTriggerTrack),
309 GE(CLSID_DirectMusicSegTriggerTrack),
310 GE(CLSID_DirectMusicSeqTrack),
311 GE(CLSID_DirectMusicSignPostTrack),
312 GE(CLSID_DirectMusicSong),
313 GE(CLSID_DirectMusicStyle),
314 GE(CLSID_DirectMusicStyleTrack),
315 GE(CLSID_DirectMusicSynth),
316 GE(CLSID_DirectMusicSynthSink),
317 GE(CLSID_DirectMusicSysExTrack),
318 GE(CLSID_DirectMusicTemplate),
319 GE(CLSID_DirectMusicTempoTrack),
320 GE(CLSID_DirectMusicTimeSigTrack),
321 GE(CLSID_DirectMusicWaveTrack),
322 GE(CLSID_DirectSoundWave),
323 /* IIDs */
324 GE(IID_IDirectMusic),
325 GE(IID_IDirectMusic2),
326 GE(IID_IDirectMusic8),
327 GE(IID_IDirectMusicAudioPath),
328 GE(IID_IDirectMusicBand),
329 GE(IID_IDirectMusicBuffer),
330 GE(IID_IDirectMusicChordMap),
331 GE(IID_IDirectMusicCollection),
332 GE(IID_IDirectMusicComposer),
333 GE(IID_IDirectMusicContainer),
334 GE(IID_IDirectMusicDownload),
335 GE(IID_IDirectMusicDownloadedInstrument),
336 GE(IID_IDirectMusicGetLoader),
337 GE(IID_IDirectMusicGraph),
338 GE(IID_IDirectMusicInstrument),
339 GE(IID_IDirectMusicLoader),
340 GE(IID_IDirectMusicLoader8),
341 GE(IID_IDirectMusicObject),
342 GE(IID_IDirectMusicPatternTrack),
343 GE(IID_IDirectMusicPerformance),
344 GE(IID_IDirectMusicPerformance2),
345 GE(IID_IDirectMusicPerformance8),
346 GE(IID_IDirectMusicPort),
347 GE(IID_IDirectMusicPortDownload),
348 GE(IID_IDirectMusicScript),
349 GE(IID_IDirectMusicSegment),
350 GE(IID_IDirectMusicSegment2),
351 GE(IID_IDirectMusicSegment8),
352 GE(IID_IDirectMusicSegmentState),
353 GE(IID_IDirectMusicSegmentState8),
354 GE(IID_IDirectMusicStyle),
355 GE(IID_IDirectMusicStyle8),
356 GE(IID_IDirectMusicSynth),
357 GE(IID_IDirectMusicSynth8),
358 GE(IID_IDirectMusicSynthSink),
359 GE(IID_IDirectMusicThru),
360 GE(IID_IDirectMusicTool),
361 GE(IID_IDirectMusicTool8),
362 GE(IID_IDirectMusicTrack),
363 GE(IID_IDirectMusicTrack8),
364 GE(IID_IUnknown),
365 GE(IID_IPersistStream),
366 GE(IID_IStream),
367 GE(IID_IClassFactory),
368 /* GUIDs */
369 GE(GUID_DirectMusicAllTypes),
370 GE(GUID_NOTIFICATION_CHORD),
371 GE(GUID_NOTIFICATION_COMMAND),
372 GE(GUID_NOTIFICATION_MEASUREANDBEAT),
373 GE(GUID_NOTIFICATION_PERFORMANCE),
374 GE(GUID_NOTIFICATION_RECOMPOSE),
375 GE(GUID_NOTIFICATION_SEGMENT),
376 GE(GUID_BandParam),
377 GE(GUID_ChordParam),
378 GE(GUID_CommandParam),
379 GE(GUID_CommandParam2),
380 GE(GUID_CommandParamNext),
381 GE(GUID_IDirectMusicBand),
382 GE(GUID_IDirectMusicChordMap),
383 GE(GUID_IDirectMusicStyle),
384 GE(GUID_MuteParam),
385 GE(GUID_Play_Marker),
386 GE(GUID_RhythmParam),
387 GE(GUID_TempoParam),
388 GE(GUID_TimeSignature),
389 GE(GUID_Valid_Start_Time),
390 GE(GUID_Clear_All_Bands),
391 GE(GUID_ConnectToDLSCollection),
392 GE(GUID_Disable_Auto_Download),
393 GE(GUID_DisableTempo),
394 GE(GUID_DisableTimeSig),
395 GE(GUID_Download),
396 GE(GUID_DownloadToAudioPath),
397 GE(GUID_Enable_Auto_Download),
398 GE(GUID_EnableTempo),
399 GE(GUID_EnableTimeSig),
400 GE(GUID_IgnoreBankSelectForGM),
401 GE(GUID_SeedVariations),
402 GE(GUID_StandardMIDIFile),
403 GE(GUID_Unload),
404 GE(GUID_UnloadFromAudioPath),
405 GE(GUID_Variations),
406 GE(GUID_PerfMasterTempo),
407 GE(GUID_PerfMasterVolume),
408 GE(GUID_PerfMasterGrooveLevel),
409 GE(GUID_PerfAutoDownload),
410 GE(GUID_DefaultGMCollection),
411 GE(GUID_Synth_Default),
412 GE(GUID_Buffer_Reverb),
413 GE(GUID_Buffer_EnvReverb),
414 GE(GUID_Buffer_Stereo),
415 GE(GUID_Buffer_3D_Dry),
416 GE(GUID_Buffer_Mono),
417 GE(GUID_DMUS_PROP_GM_Hardware),
418 GE(GUID_DMUS_PROP_GS_Capable),
419 GE(GUID_DMUS_PROP_GS_Hardware),
420 GE(GUID_DMUS_PROP_DLS1),
421 GE(GUID_DMUS_PROP_DLS2),
422 GE(GUID_DMUS_PROP_Effects),
423 GE(GUID_DMUS_PROP_INSTRUMENT2),
424 GE(GUID_DMUS_PROP_LegacyCaps),
425 GE(GUID_DMUS_PROP_MemorySize),
426 GE(GUID_DMUS_PROP_SampleMemorySize),
427 GE(GUID_DMUS_PROP_SamplePlaybackRate),
428 GE(GUID_DMUS_PROP_SetSynthSink),
429 GE(GUID_DMUS_PROP_SinkUsesDSound),
430 GE(GUID_DMUS_PROP_SynthSink_DSOUND),
431 GE(GUID_DMUS_PROP_SynthSink_WAVE),
432 GE(GUID_DMUS_PROP_Volume),
433 GE(GUID_DMUS_PROP_WavesReverb),
434 GE(GUID_DMUS_PROP_WriteLatency),
435 GE(GUID_DMUS_PROP_WritePeriod),
436 GE(GUID_DMUS_PROP_XG_Capable),
437 GE(GUID_DMUS_PROP_XG_Hardware)
440 unsigned int i;
442 if (!id) return "(null)";
443 for (i = 0; i < sizeof(guids)/sizeof(guids[0]); i++) {
444 if (IsEqualGUID(id, guids[i].guid))
445 return guids[i].name;
448 /* if we didn't find it, act like standard debugstr_guid */
449 return debugstr_guid(id);
452 /* generic flag-dumping function */
453 static const char* debugstr_flags (DWORD flags, const flag_info* names, size_t num_names){
454 static char buffer[128] = "", *ptr = &buffer[0];
455 unsigned int i;
456 int size = sizeof(buffer);
458 for (i=0; i < num_names; i++) {
459 if ((flags & names[i].val)) {
460 int cnt = snprintf(ptr, size, "%s ", names[i].name);
461 if (cnt < 0 || cnt >= size) break;
462 size -= cnt;
463 ptr += cnt;
467 ptr = &buffer[0];
468 return ptr;
471 /* dump DMUS_OBJ flags */
472 static const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask) {
473 static const flag_info flags[] = {
474 FE(DMUS_OBJ_OBJECT),
475 FE(DMUS_OBJ_CLASS),
476 FE(DMUS_OBJ_NAME),
477 FE(DMUS_OBJ_CATEGORY),
478 FE(DMUS_OBJ_FILENAME),
479 FE(DMUS_OBJ_FULLPATH),
480 FE(DMUS_OBJ_URL),
481 FE(DMUS_OBJ_VERSION),
482 FE(DMUS_OBJ_DATE),
483 FE(DMUS_OBJ_LOADED),
484 FE(DMUS_OBJ_MEMORY),
485 FE(DMUS_OBJ_STREAM)
487 return debugstr_flags (flagmask, flags, sizeof(flags)/sizeof(flags[0]));
490 const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc) {
491 if (pDesc) {
492 char buffer[1024], *ptr = buffer;
494 ptr += sprintf(ptr, "DMUS_OBJECTDESC (%p):\n", pDesc);
495 ptr += sprintf(ptr, " - dwSize = 0x%08X\n", pDesc->dwSize);
496 ptr += sprintf(ptr, " - dwValidData = 0x%08X ( %s)\n", pDesc->dwValidData, debugstr_DMUS_OBJ_FLAGS (pDesc->dwValidData));
497 if (pDesc->dwValidData & DMUS_OBJ_CLASS) ptr += sprintf(ptr, " - guidClass = %s\n", debugstr_dmguid(&pDesc->guidClass));
498 if (pDesc->dwValidData & DMUS_OBJ_OBJECT) ptr += sprintf(ptr, " - guidObject = %s\n", debugstr_guid(&pDesc->guidObject));
499 if (pDesc->dwValidData & DMUS_OBJ_DATE) ptr += sprintf(ptr, " - ftDate = %s\n", debugstr_filetime (&pDesc->ftDate));
500 if (pDesc->dwValidData & DMUS_OBJ_VERSION) ptr += sprintf(ptr, " - vVersion = %s\n", debugstr_dmversion(&pDesc->vVersion));
501 if (pDesc->dwValidData & DMUS_OBJ_NAME) ptr += sprintf(ptr, " - wszName = %s\n", debugstr_w(pDesc->wszName));
502 if (pDesc->dwValidData & DMUS_OBJ_CATEGORY) ptr += sprintf(ptr, " - wszCategory = %s\n", debugstr_w(pDesc->wszCategory));
503 if (pDesc->dwValidData & DMUS_OBJ_FILENAME) ptr += sprintf(ptr, " - wszFileName = %s\n", debugstr_w(pDesc->wszFileName));
504 if (pDesc->dwValidData & DMUS_OBJ_MEMORY) ptr += sprintf(ptr, " - llMemLength = 0x%s\n - pbMemData = %p\n",
505 wine_dbgstr_longlong(pDesc->llMemLength), pDesc->pbMemData);
506 if (pDesc->dwValidData & DMUS_OBJ_STREAM) ptr += sprintf(ptr, " - pStream = %p\n", pDesc->pStream);
508 return wine_dbg_sprintf("%s", buffer);
509 } else {
510 return wine_dbg_sprintf("(NULL)");