dlls/dmime/dmutils.c

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