/* Debug and Helper Functions * * Copyright (C) 2004 Rok Mandeljc * Copyright (C) 2004 Raphael Junqueira * * 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 "config.h" #include "wine/port.h" #include <stdio.h> #include <stdarg.h> #include <string.h> #include "windef.h" #include "winbase.h" #include "winnt.h" #include "wingdi.h" #include "winuser.h" #include "wine/debug.h" #include "wine/unicode.h" #include "objbase.h" #include "dmusici.h" #include "dmusicf.h" #include "dmusics.h" #include "dmutils.h" WINE_DEFAULT_DEBUG_CHANNEL(dmusic); WINE_DECLARE_DEBUG_CHANNEL(dmfile); /* generic flag-dumping function */ static const char* debugstr_flags (DWORD flags, const flag_info* names, size_t num_names){ static char buffer[128] = "", *ptr = &buffer[0]; unsigned int i; int size = sizeof(buffer); for (i=0; i < num_names; i++) { if ((flags & names[i].val)) { int cnt = snprintf(ptr, size, "%s ", names[i].name); if (cnt < 0 || cnt >= size) break; size -= cnt; ptr += cnt; } } ptr = &buffer[0]; return ptr; } /* dump DMUS_OBJ flags */ static const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask) { static const flag_info flags[] = { FE(DMUS_OBJ_OBJECT), FE(DMUS_OBJ_CLASS), FE(DMUS_OBJ_NAME), FE(DMUS_OBJ_CATEGORY), FE(DMUS_OBJ_FILENAME), FE(DMUS_OBJ_FULLPATH), FE(DMUS_OBJ_URL), FE(DMUS_OBJ_VERSION), FE(DMUS_OBJ_DATE), FE(DMUS_OBJ_LOADED), FE(DMUS_OBJ_MEMORY), FE(DMUS_OBJ_STREAM) }; return debugstr_flags (flagmask, flags, sizeof(flags)/sizeof(flags[0])); } /* month number into month name (for debugstr_filetime) */ static const char *debugstr_month (DWORD dwMonth) { switch (dwMonth) { case 1: return "January"; case 2: return "February"; case 3: return "March"; case 4: return "April"; case 5: return "May"; case 6: return "June"; case 7: return "July"; case 8: return "August"; case 9: return "September"; case 10: return "October"; case 11: return "November"; case 12: return "December"; default: return "Invalid"; } } /* FILETIME struct to string conversion for debug messages */ static const char *debugstr_filetime (const FILETIME *time) { SYSTEMTIME sysTime; if (!time) return "'null'"; FileTimeToSystemTime (time, &sysTime); return wine_dbg_sprintf ("\'%02i. %s %04i %02i:%02i:%02i\'", sysTime.wDay, debugstr_month(sysTime.wMonth), sysTime.wYear, sysTime.wHour, sysTime.wMinute, sysTime.wSecond); } /* DMUS_VERSION struct to string conversion for debug messages */ static const char *debugstr_dmversion (const DMUS_VERSION *version) { if (!version) return "'null'"; return wine_dbg_sprintf ("\'%i,%i,%i,%i\'", HIWORD(version->dwVersionMS),LOWORD(version->dwVersionMS), HIWORD(version->dwVersionLS), LOWORD(version->dwVersionLS)); } /* dump whole DMUS_OBJECTDESC struct */ static const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc) { if (pDesc) { char buffer[1024] = "", *ptr = &buffer[0]; ptr += sprintf(ptr, "DMUS_OBJECTDESC (%p):\n", pDesc); ptr += sprintf(ptr, " - dwSize = 0x%08X\n", pDesc->dwSize); ptr += sprintf(ptr, " - dwValidData = 0x%08X ( %s)\n", pDesc->dwValidData, debugstr_DMUS_OBJ_FLAGS (pDesc->dwValidData)); if (pDesc->dwValidData & DMUS_OBJ_CLASS) ptr += sprintf(ptr, " - guidClass = %s\n", debugstr_dmguid(&pDesc->guidClass)); if (pDesc->dwValidData & DMUS_OBJ_OBJECT) ptr += sprintf(ptr, " - guidObject = %s\n", debugstr_guid(&pDesc->guidObject)); if (pDesc->dwValidData & DMUS_OBJ_DATE) ptr += sprintf(ptr, " - ftDate = %s\n", debugstr_filetime (&pDesc->ftDate)); if (pDesc->dwValidData & DMUS_OBJ_VERSION) ptr += sprintf(ptr, " - vVersion = %s\n", debugstr_dmversion(&pDesc->vVersion)); if (pDesc->dwValidData & DMUS_OBJ_NAME) ptr += sprintf(ptr, " - wszName = %s\n", debugstr_w(pDesc->wszName)); if (pDesc->dwValidData & DMUS_OBJ_CATEGORY) ptr += sprintf(ptr, " - wszCategory = %s\n", debugstr_w(pDesc->wszCategory)); if (pDesc->dwValidData & DMUS_OBJ_FILENAME) ptr += sprintf(ptr, " - wszFileName = %s\n", debugstr_w(pDesc->wszFileName)); if (pDesc->dwValidData & DMUS_OBJ_MEMORY) ptr += sprintf(ptr, " - llMemLength = 0x%s\n - pbMemData = %p\n", wine_dbgstr_longlong(pDesc->llMemLength), pDesc->pbMemData); if (pDesc->dwValidData & DMUS_OBJ_STREAM) ptr += sprintf(ptr, " - pStream = %p\n", pDesc->pStream); return wine_dbg_sprintf("%s", buffer); } else { return "(NULL)"; } } HRESULT IDirectMusicUtils_IPersistStream_ParseDescGeneric (DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, LPDMUS_OBJECTDESC pDesc) { switch (pChunk->fccID) { case DMUS_FOURCC_GUID_CHUNK: { TRACE_(dmfile)(": GUID chunk\n"); pDesc->dwValidData |= DMUS_OBJ_OBJECT; IStream_Read (pStm, &pDesc->guidObject, pChunk->dwSize, NULL); break; } case DMUS_FOURCC_DATE_CHUNK: { TRACE_(dmfile)(": file date chunk\n"); pDesc->dwValidData |= DMUS_OBJ_DATE; IStream_Read (pStm, &pDesc->ftDate, pChunk->dwSize, NULL); break; } case DMUS_FOURCC_NAME_CHUNK: { TRACE_(dmfile)(": name chunk\n"); pDesc->dwValidData |= DMUS_OBJ_NAME; IStream_Read (pStm, pDesc->wszName, pChunk->dwSize, NULL); break; } case DMUS_FOURCC_FILE_CHUNK: { TRACE_(dmfile)(": file name chunk\n"); pDesc->dwValidData |= DMUS_OBJ_FILENAME; IStream_Read (pStm, pDesc->wszFileName, pChunk->dwSize, NULL); break; } case DMUS_FOURCC_VERSION_CHUNK: { TRACE_(dmfile)(": version chunk\n"); pDesc->dwValidData |= DMUS_OBJ_VERSION; IStream_Read (pStm, &pDesc->vVersion, pChunk->dwSize, NULL); break; } case DMUS_FOURCC_CATEGORY_CHUNK: { TRACE_(dmfile)(": category chunk\n"); pDesc->dwValidData |= DMUS_OBJ_CATEGORY; IStream_Read (pStm, pDesc->wszCategory, pChunk->dwSize, NULL); break; } default: /* not handled */ return S_FALSE; } return S_OK; } HRESULT IDirectMusicUtils_IPersistStream_ParseUNFOGeneric (DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, LPDMUS_OBJECTDESC pDesc) { LARGE_INTEGER liMove; /* used when skipping chunks */ /** * don't ask me why, but M$ puts INFO elements in UNFO list sometimes * (though strings seem to be valid unicode) */ switch (pChunk->fccID) { case mmioFOURCC('I','N','A','M'): case DMUS_FOURCC_UNAM_CHUNK: { TRACE_(dmfile)(": name chunk\n"); pDesc->dwValidData |= DMUS_OBJ_NAME; IStream_Read (pStm, pDesc->wszName, pChunk->dwSize, NULL); TRACE_(dmfile)(" - wszName: %s\n", debugstr_w(pDesc->wszName)); break; } case mmioFOURCC('I','A','R','T'): case DMUS_FOURCC_UART_CHUNK: { TRACE_(dmfile)(": artist chunk (ignored)\n"); liMove.QuadPart = pChunk->dwSize; IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); break; } case mmioFOURCC('I','C','O','P'): case DMUS_FOURCC_UCOP_CHUNK: { TRACE_(dmfile)(": copyright chunk (ignored)\n"); liMove.QuadPart = pChunk->dwSize; IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); break; } case mmioFOURCC('I','S','B','J'): case DMUS_FOURCC_USBJ_CHUNK: { TRACE_(dmfile)(": subject chunk (ignored)\n"); liMove.QuadPart = pChunk->dwSize; IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); break; } case mmioFOURCC('I','C','M','T'): case DMUS_FOURCC_UCMT_CHUNK: { TRACE_(dmfile)(": comment chunk (ignored)\n"); liMove.QuadPart = pChunk->dwSize; IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); break; } default: /* not handled */ return S_FALSE; } return S_OK; } HRESULT IDirectMusicUtils_IPersistStream_ParseReference (LPPERSISTSTREAM iface, DMUS_PRIVATE_CHUNK* pChunk, IStream* pStm, IDirectMusicObject** ppObject) { DMUS_PRIVATE_CHUNK Chunk; DWORD ListSize[3], ListCount[3]; LARGE_INTEGER liMove; /* used when skipping chunks */ HRESULT hr; DMUS_IO_REFERENCE ref; DMUS_OBJECTDESC ref_desc; memset(&ref, 0, sizeof(ref)); memset(&ref_desc, 0, sizeof(ref_desc)); if (pChunk->fccID != DMUS_FOURCC_REF_LIST) { ERR_(dmfile)(": %s chunk should be a REF list\n", debugstr_fourcc (pChunk->fccID)); return E_FAIL; } ListSize[0] = pChunk->dwSize - sizeof(FOURCC); ListCount[0] = 0; do { IStream_Read (pStm, &Chunk, sizeof(FOURCC)+sizeof(DWORD), NULL); ListCount[0] += sizeof(FOURCC) + sizeof(DWORD) + Chunk.dwSize; TRACE_(dmfile)(": %s chunk (size = %d)", debugstr_fourcc (Chunk.fccID), Chunk.dwSize); hr = IDirectMusicUtils_IPersistStream_ParseDescGeneric(&Chunk, pStm, &ref_desc); if (FAILED(hr)) return hr; if (hr == S_FALSE) { switch (Chunk.fccID) { case DMUS_FOURCC_REF_CHUNK: { TRACE_(dmfile)(": Reference chunk\n"); if (Chunk.dwSize != sizeof(DMUS_IO_REFERENCE)) return E_FAIL; IStream_Read (pStm, &ref, sizeof(DMUS_IO_REFERENCE), NULL); TRACE_(dmfile)(" - guidClassID: %s\n", debugstr_dmguid(&ref.guidClassID)); TRACE_(dmfile)(" - dwValidData: %u\n", ref.dwValidData); break; } default: { TRACE_(dmfile)(": unknown chunk (irrelevant & skipping)\n"); liMove.QuadPart = Chunk.dwSize; IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); break; } } } TRACE_(dmfile)(": ListCount[0] = %d < ListSize[0] = %d\n", ListCount[0], ListSize[0]); } while (ListCount[0] < ListSize[0]); ref_desc.dwValidData |= DMUS_OBJ_CLASS; ref_desc.guidClass = ref.guidClassID; TRACE_(dmfile)("** DM Reference Begin of Load ***\n"); TRACE_(dmfile)("With Desc:\n"); debugstr_DMUS_OBJECTDESC(&ref_desc); { LPDIRECTMUSICGETLOADER pGetLoader = NULL; LPDIRECTMUSICLOADER pLoader = NULL; IStream_QueryInterface (pStm, &IID_IDirectMusicGetLoader, (LPVOID*)&pGetLoader); IDirectMusicGetLoader_GetLoader (pGetLoader, &pLoader); IDirectMusicGetLoader_Release (pGetLoader); hr = IDirectMusicLoader_GetObject (pLoader, &ref_desc, &IID_IDirectMusicObject, (LPVOID*)ppObject); IDirectMusicLoader_Release (pLoader); /* release loader */ } TRACE_(dmfile)("** DM Reference End of Load ***\n"); return S_OK; } /* FOURCC to string conversion for debug messages */ const char *debugstr_fourcc (DWORD fourcc) { if (!fourcc) return "'null'"; return wine_dbg_sprintf ("\'%c%c%c%c\'", (char)(fourcc), (char)(fourcc >> 8), (char)(fourcc >> 16), (char)(fourcc >> 24)); } /* returns name of given GUID */ const char *debugstr_dmguid (const GUID *id) { static const guid_info guids[] = { /* CLSIDs */ GE(CLSID_AudioVBScript), GE(CLSID_DirectMusic), GE(CLSID_DirectMusicAudioPath), GE(CLSID_DirectMusicAudioPathConfig), GE(CLSID_DirectMusicAuditionTrack), GE(CLSID_DirectMusicBand), GE(CLSID_DirectMusicBandTrack), GE(CLSID_DirectMusicChordMapTrack), GE(CLSID_DirectMusicChordMap), GE(CLSID_DirectMusicChordTrack), GE(CLSID_DirectMusicCollection), GE(CLSID_DirectMusicCommandTrack), GE(CLSID_DirectMusicComposer), GE(CLSID_DirectMusicContainer), GE(CLSID_DirectMusicGraph), GE(CLSID_DirectMusicLoader), GE(CLSID_DirectMusicLyricsTrack), GE(CLSID_DirectMusicMarkerTrack), GE(CLSID_DirectMusicMelodyFormulationTrack), GE(CLSID_DirectMusicMotifTrack), GE(CLSID_DirectMusicMuteTrack), GE(CLSID_DirectMusicParamControlTrack), GE(CLSID_DirectMusicPatternTrack), GE(CLSID_DirectMusicPerformance), GE(CLSID_DirectMusicScript), GE(CLSID_DirectMusicScriptAutoImpSegment), GE(CLSID_DirectMusicScriptAutoImpPerformance), GE(CLSID_DirectMusicScriptAutoImpSegmentState), GE(CLSID_DirectMusicScriptAutoImpAudioPathConfig), GE(CLSID_DirectMusicScriptAutoImpAudioPath), GE(CLSID_DirectMusicScriptAutoImpSong), GE(CLSID_DirectMusicScriptSourceCodeLoader), GE(CLSID_DirectMusicScriptTrack), GE(CLSID_DirectMusicSection), GE(CLSID_DirectMusicSegment), GE(CLSID_DirectMusicSegmentState), GE(CLSID_DirectMusicSegmentTriggerTrack), GE(CLSID_DirectMusicSegTriggerTrack), GE(CLSID_DirectMusicSeqTrack), GE(CLSID_DirectMusicSignPostTrack), GE(CLSID_DirectMusicSong), GE(CLSID_DirectMusicStyle), GE(CLSID_DirectMusicStyleTrack), GE(CLSID_DirectMusicSynth), GE(CLSID_DirectMusicSynthSink), GE(CLSID_DirectMusicSysExTrack), GE(CLSID_DirectMusicTemplate), GE(CLSID_DirectMusicTempoTrack), GE(CLSID_DirectMusicTimeSigTrack), GE(CLSID_DirectMusicWaveTrack), GE(CLSID_DirectSoundWave), /* IIDs */ GE(IID_IDirectMusic), GE(IID_IDirectMusic2), GE(IID_IDirectMusic8), GE(IID_IDirectMusicAudioPath), GE(IID_IDirectMusicBand), GE(IID_IDirectMusicBuffer), GE(IID_IDirectMusicChordMap), GE(IID_IDirectMusicCollection), GE(IID_IDirectMusicComposer), GE(IID_IDirectMusicContainer), GE(IID_IDirectMusicDownload), GE(IID_IDirectMusicDownloadedInstrument), GE(IID_IDirectMusicGetLoader), GE(IID_IDirectMusicGraph), GE(IID_IDirectMusicInstrument), GE(IID_IDirectMusicLoader), GE(IID_IDirectMusicLoader8), GE(IID_IDirectMusicObject), GE(IID_IDirectMusicPatternTrack), GE(IID_IDirectMusicPerformance), GE(IID_IDirectMusicPerformance2), GE(IID_IDirectMusicPerformance8), GE(IID_IDirectMusicPort), GE(IID_IDirectMusicPortDownload), GE(IID_IDirectMusicScript), GE(IID_IDirectMusicSegment), GE(IID_IDirectMusicSegment2), GE(IID_IDirectMusicSegment8), GE(IID_IDirectMusicSegmentState), GE(IID_IDirectMusicSegmentState8), GE(IID_IDirectMusicStyle), GE(IID_IDirectMusicStyle8), GE(IID_IDirectMusicSynth), GE(IID_IDirectMusicSynth8), GE(IID_IDirectMusicSynthSink), GE(IID_IDirectMusicThru), GE(IID_IDirectMusicTool), GE(IID_IDirectMusicTool8), GE(IID_IDirectMusicTrack), GE(IID_IDirectMusicTrack8), GE(IID_IUnknown), GE(IID_IPersistStream), GE(IID_IStream), GE(IID_IClassFactory), /* GUIDs */ GE(GUID_DirectMusicAllTypes), GE(GUID_NOTIFICATION_CHORD), GE(GUID_NOTIFICATION_COMMAND), GE(GUID_NOTIFICATION_MEASUREANDBEAT), GE(GUID_NOTIFICATION_PERFORMANCE), GE(GUID_NOTIFICATION_RECOMPOSE), GE(GUID_NOTIFICATION_SEGMENT), GE(GUID_BandParam), GE(GUID_ChordParam), GE(GUID_CommandParam), GE(GUID_CommandParam2), GE(GUID_CommandParamNext), GE(GUID_IDirectMusicBand), GE(GUID_IDirectMusicChordMap), GE(GUID_IDirectMusicStyle), GE(GUID_MuteParam), GE(GUID_Play_Marker), GE(GUID_RhythmParam), GE(GUID_TempoParam), GE(GUID_TimeSignature), GE(GUID_Valid_Start_Time), GE(GUID_Clear_All_Bands), GE(GUID_ConnectToDLSCollection), GE(GUID_Disable_Auto_Download), GE(GUID_DisableTempo), GE(GUID_DisableTimeSig), GE(GUID_Download), GE(GUID_DownloadToAudioPath), GE(GUID_Enable_Auto_Download), GE(GUID_EnableTempo), GE(GUID_EnableTimeSig), GE(GUID_IgnoreBankSelectForGM), GE(GUID_SeedVariations), GE(GUID_StandardMIDIFile), GE(GUID_Unload), GE(GUID_UnloadFromAudioPath), GE(GUID_Variations), GE(GUID_PerfMasterTempo), GE(GUID_PerfMasterVolume), GE(GUID_PerfMasterGrooveLevel), GE(GUID_PerfAutoDownload), GE(GUID_DefaultGMCollection), GE(GUID_Synth_Default), GE(GUID_Buffer_Reverb), GE(GUID_Buffer_EnvReverb), GE(GUID_Buffer_Stereo), GE(GUID_Buffer_3D_Dry), GE(GUID_Buffer_Mono), GE(GUID_DMUS_PROP_GM_Hardware), GE(GUID_DMUS_PROP_GS_Capable), GE(GUID_DMUS_PROP_GS_Hardware), GE(GUID_DMUS_PROP_DLS1), GE(GUID_DMUS_PROP_DLS2), GE(GUID_DMUS_PROP_Effects), GE(GUID_DMUS_PROP_INSTRUMENT2), GE(GUID_DMUS_PROP_LegacyCaps), GE(GUID_DMUS_PROP_MemorySize), GE(GUID_DMUS_PROP_SampleMemorySize), GE(GUID_DMUS_PROP_SamplePlaybackRate), GE(GUID_DMUS_PROP_SetSynthSink), GE(GUID_DMUS_PROP_SinkUsesDSound), GE(GUID_DMUS_PROP_SynthSink_DSOUND), GE(GUID_DMUS_PROP_SynthSink_WAVE), GE(GUID_DMUS_PROP_Volume), GE(GUID_DMUS_PROP_WavesReverb), GE(GUID_DMUS_PROP_WriteLatency), GE(GUID_DMUS_PROP_WritePeriod), GE(GUID_DMUS_PROP_XG_Capable), GE(GUID_DMUS_PROP_XG_Hardware) }; unsigned int i; if (!id) return "(null)"; for (i = 0; i < sizeof(guids)/sizeof(guids[0]); i++) { if (IsEqualGUID(id, guids[i].guid)) return guids[i].name; } /* if we didn't find it, act like standard debugstr_guid */ return debugstr_guid(id); } void debug_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc) { if (pDesc) { TRACE("DMUS_OBJECTDESC (%p):\n", pDesc); TRACE(" - dwSize = %d\n", pDesc->dwSize); TRACE(" - dwValidData = %s\n", debugstr_DMUS_OBJ_FLAGS (pDesc->dwValidData)); if (pDesc->dwValidData & DMUS_OBJ_NAME) TRACE(" - wszName = %s\n", debugstr_w(pDesc->wszName)); if (pDesc->dwValidData & DMUS_OBJ_CLASS) TRACE(" - guidClass = %s\n", debugstr_dmguid(&pDesc->guidClass)); if (pDesc->dwValidData & DMUS_OBJ_OBJECT) TRACE(" - guidObject = %s\n", debugstr_guid(&pDesc->guidObject)); if (pDesc->dwValidData & DMUS_OBJ_DATE) TRACE(" - ftDate = FIXME\n"); if (pDesc->dwValidData & DMUS_OBJ_VERSION) TRACE(" - vVersion = %s\n", debugstr_dmversion(&pDesc->vVersion)); if (pDesc->dwValidData & DMUS_OBJ_CATEGORY) TRACE(" - wszCategory = %s\n", debugstr_w(pDesc->wszCategory)); if (pDesc->dwValidData & DMUS_OBJ_FILENAME) TRACE(" - wszFileName = %s\n", debugstr_w(pDesc->wszFileName)); if (pDesc->dwValidData & DMUS_OBJ_MEMORY) TRACE(" - llMemLength = 0x%s\n - pbMemData = %p\n", wine_dbgstr_longlong(pDesc->llMemLength), pDesc->pbMemData); if (pDesc->dwValidData & DMUS_OBJ_STREAM) TRACE(" - pStream = %p\n", pDesc->pStream); } else { TRACE("(NULL)\n"); } }