dlls/dmstyle/commandtrack.c

   1 /* IDirectMusicCommandTrack Implementation
   2  *
   3  * Copyright (C) 2003-2004 Rok Mandeljc
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #include "dmstyle_private.h"
  21
  22 WINE_DEFAULT_DEBUG_CHANNEL(dmstyle);
  23 WINE_DECLARE_DEBUG_CHANNEL(dmfile);
  24
  25 /*****************************************************************************
  26  * IDirectMusicCommandTrack implementation
  27  */
  28 /* IDirectMusicCommandTrack IUnknown part: */
  29 HRESULT WINAPI IDirectMusicCommandTrack_IUnknown_QueryInterface (LPUNKNOWN iface, REFIID riid, LPVOID *ppobj) {
  30         ICOM_THIS_MULTI(IDirectMusicCommandTrack, UnknownVtbl, iface);
  31         TRACE("(%p, %s, %p)\n", This, debugstr_dmguid(riid), ppobj);
  32
  33         if (IsEqualIID (riid, &IID_IUnknown)) {
  34                 *ppobj = (LPUNKNOWN)&This->UnknownVtbl;
  35                 IDirectMusicCommandTrack_IUnknown_AddRef ((LPUNKNOWN)&This->UnknownVtbl);
  36                 return S_OK;
  37         } else if (IsEqualIID (riid, &IID_IDirectMusicTrack)
  38           || IsEqualIID (riid, &IID_IDirectMusicTrack8)) {
  39                 *ppobj = (LPDIRECTMUSICTRACK8)&This->TrackVtbl;
  40                 IDirectMusicCommandTrack_IDirectMusicTrack_AddRef ((LPDIRECTMUSICTRACK8)&This->TrackVtbl);
  41                 return S_OK;
  42         } else if (IsEqualIID (riid, &IID_IPersistStream)) {
  43                 *ppobj = (LPPERSISTSTREAM)&This->PersistStreamVtbl;
  44                 IDirectMusicCommandTrack_IPersistStream_AddRef ((LPPERSISTSTREAM)&This->PersistStreamVtbl);
  45                 return S_OK;
  46         }
  47
  48         WARN("(%p, %s, %p): not found\n", This, debugstr_dmguid(riid), ppobj);
  49         return E_NOINTERFACE;
  50 }
  51
  52 ULONG WINAPI IDirectMusicCommandTrack_IUnknown_AddRef (LPUNKNOWN iface) {
  53         ICOM_THIS_MULTI(IDirectMusicCommandTrack, UnknownVtbl, iface);
  54         ULONG ref = InterlockedIncrement(&This->ref);
  55
  56         TRACE("(%p): AddRef from %ld\n", This, ref - 1);
  57
  58         DMSTYLE_LockModule();
  59
  60         return ref;
  61 }
  62
  63 ULONG WINAPI IDirectMusicCommandTrack_IUnknown_Release (LPUNKNOWN iface) {
  64         ICOM_THIS_MULTI(IDirectMusicCommandTrack, UnknownVtbl, iface);
  65         ULONG ref = InterlockedDecrement(&This->ref);
  66
  67         TRACE("(%p): ReleaseRef to %ld\n", This, ref);
  68
  69         if (ref == 0) {
  70                 HeapFree(GetProcessHeap(), 0, This);
  71         }
  72
  73         DMSTYLE_UnlockModule();
  74
  75         return ref;
  76 }
  77
  78 static const IUnknownVtbl DirectMusicCommandTrack_Unknown_Vtbl = {
  79         IDirectMusicCommandTrack_IUnknown_QueryInterface,
  80         IDirectMusicCommandTrack_IUnknown_AddRef,
  81         IDirectMusicCommandTrack_IUnknown_Release
  82 };
  83
  84 /* IDirectMusicCommandTrack IDirectMusicTrack8 part: */
  85 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_QueryInterface (LPDIRECTMUSICTRACK8 iface, REFIID riid, LPVOID *ppobj) {
  86         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
  87         return IDirectMusicCommandTrack_IUnknown_QueryInterface ((LPUNKNOWN)&This->UnknownVtbl, riid, ppobj);
  88 }
  89
  90 ULONG WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_AddRef (LPDIRECTMUSICTRACK8 iface) {
  91         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
  92         return IDirectMusicCommandTrack_IUnknown_AddRef ((LPUNKNOWN)&This->UnknownVtbl);
  93 }
  94
  95 ULONG WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Release (LPDIRECTMUSICTRACK8 iface) {
  96         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
  97         return IDirectMusicCommandTrack_IUnknown_Release ((LPUNKNOWN)&This->UnknownVtbl);
  98 }
  99
 100 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Init (LPDIRECTMUSICTRACK8 iface, IDirectMusicSegment* pSegment)
 101 {
 102         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 103         FIXME("(%p, %p): stub\n", This, pSegment);
 104         return S_OK;
 105 }
 106
 107 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_InitPlay (LPDIRECTMUSICTRACK8 iface, IDirectMusicSegmentState* pSegmentState, IDirectMusicPerformance* pPerformance, void** ppStateData, DWORD dwVirtualTrack8ID, DWORD dwFlags)
 108 {
 109         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 110         FIXME("(%p, %p, %p, %p, %ld, %ld): stub\n", This, pSegmentState, pPerformance, ppStateData, dwVirtualTrack8ID, dwFlags);
 111         return S_OK;
 112 }
 113
 114 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_EndPlay (LPDIRECTMUSICTRACK8 iface, void* pStateData)
 115 {
 116         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 117         FIXME("(%p, %p): stub\n", This, pStateData);
 118         return S_OK;
 119 }
 120
 121 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Play (LPDIRECTMUSICTRACK8 iface, void* pStateData, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags, IDirectMusicPerformance* pPerf, IDirectMusicSegmentState* pSegSt, DWORD dwVirtualID)
 122 {
 123         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 124         FIXME("(%p, %p, %ld, %ld, %ld, %ld, %p, %p, %ld): stub\n", This, pStateData, mtStart, mtEnd, mtOffset, dwFlags, pPerf, pSegSt, dwVirtualID);
 125         return S_OK;
 126 }
 127
 128 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_GetParam (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME* pmtNext, void* pParam) {
 129         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 130         FIXME("(%p, %s, %ld, %p, %p): stub\n", This, debugstr_dmguid(rguidType), mtTime, pmtNext, pParam);
 131         return S_OK;
 132 }
 133
 134 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_SetParam (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, MUSIC_TIME mtTime, void* pParam) {
 135         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 136         FIXME("(%p, %s, %ld, %p): stub\n", This, debugstr_dmguid(rguidType), mtTime, pParam);
 137         return S_OK;
 138 }
 139
 140 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_IsParamSupported (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType) {
 141         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 142
 143         TRACE("(%p, %s): ", This, debugstr_dmguid(rguidType));
 144         if (IsEqualGUID (rguidType, &GUID_CommandParam)
 145                 || IsEqualGUID (rguidType, &GUID_CommandParam2)
 146                 || IsEqualGUID (rguidType, &GUID_CommandParamNext)) {
 147                 TRACE("param supported\n");
 148                 return S_OK;
 149         }
 150
 151         TRACE("param unsupported\n");
 152         return DMUS_E_TYPE_UNSUPPORTED;
 153 }
 154
 155 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_AddNotificationType (LPDIRECTMUSICTRACK8 iface, REFGUID rguidNotificationType) {
 156         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 157         FIXME("(%p, %s): stub\n", This, debugstr_dmguid(rguidNotificationType));
 158         return S_OK;
 159 }
 160
 161 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_RemoveNotificationType (LPDIRECTMUSICTRACK8 iface, REFGUID rguidNotificationType) {
 162         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 163         FIXME("(%p, %s): stub\n", This, debugstr_dmguid(rguidNotificationType));
 164         return S_OK;
 165 }
 166
 167 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Clone (LPDIRECTMUSICTRACK8 iface, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack** ppTrack) {
 168         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 169         FIXME("(%p, %ld, %ld, %p): stub\n", This, mtStart, mtEnd, ppTrack);
 170         return S_OK;
 171 }
 172
 173 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_PlayEx (LPDIRECTMUSICTRACK8 iface, void* pStateData, REFERENCE_TIME rtStart, REFERENCE_TIME rtEnd, REFERENCE_TIME rtOffset, DWORD dwFlags, IDirectMusicPerformance* pPerf, IDirectMusicSegmentState* pSegSt, DWORD dwVirtualID) {
 174         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 175         FIXME("(%p, %p, %lli, %lli, %lli, %ld, %p, %p, %ld): stub\n", This, pStateData, rtStart, rtEnd, rtOffset, dwFlags, pPerf, pSegSt, dwVirtualID);
 176         return S_OK;
 177 }
 178
 179 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_GetParamEx (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, REFERENCE_TIME rtTime, REFERENCE_TIME* prtNext, void* pParam, void* pStateData, DWORD dwFlags) {
 180         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 181         FIXME("(%p, %s, %lli, %p, %p, %p, %ld): stub\n", This, debugstr_dmguid(rguidType), rtTime, prtNext, pParam, pStateData, dwFlags);
 182         return S_OK;
 183 }
 184
 185 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_SetParamEx (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, REFERENCE_TIME rtTime, void* pParam, void* pStateData, DWORD dwFlags) {
 186         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 187         FIXME("(%p, %s, %lli, %p, %p, %ld): stub\n", This, debugstr_dmguid(rguidType), rtTime, pParam, pStateData, dwFlags);
 188         return S_OK;
 189 }
 190
 191 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Compose (LPDIRECTMUSICTRACK8 iface, IUnknown* pContext, DWORD dwTrackGroup, IDirectMusicTrack** ppResultTrack) {
 192         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 193         FIXME("(%p, %p, %ld, %p): stub\n", This, pContext, dwTrackGroup, ppResultTrack);
 194         return S_OK;
 195 }
 196
 197 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Join (LPDIRECTMUSICTRACK8 iface, IDirectMusicTrack* pNewTrack, MUSIC_TIME mtJoin, IUnknown* pContext, DWORD dwTrackGroup, IDirectMusicTrack** ppResultTrack) {
 198         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
 199         FIXME("(%p, %p, %ld, %p, %ld, %p): stub\n", This, pNewTrack, mtJoin, pContext, dwTrackGroup, ppResultTrack);
 200         return S_OK;
 201 }
 202
 203 static const IDirectMusicTrack8Vtbl DirectMusicCommandTrack_Track_Vtbl = {
 204         IDirectMusicCommandTrack_IDirectMusicTrack_QueryInterface,
 205         IDirectMusicCommandTrack_IDirectMusicTrack_AddRef,
 206         IDirectMusicCommandTrack_IDirectMusicTrack_Release,
 207         IDirectMusicCommandTrack_IDirectMusicTrack_Init,
 208         IDirectMusicCommandTrack_IDirectMusicTrack_InitPlay,
 209         IDirectMusicCommandTrack_IDirectMusicTrack_EndPlay,
 210         IDirectMusicCommandTrack_IDirectMusicTrack_Play,
 211         IDirectMusicCommandTrack_IDirectMusicTrack_GetParam,
 212         IDirectMusicCommandTrack_IDirectMusicTrack_SetParam,
 213         IDirectMusicCommandTrack_IDirectMusicTrack_IsParamSupported,
 214         IDirectMusicCommandTrack_IDirectMusicTrack_AddNotificationType,
 215         IDirectMusicCommandTrack_IDirectMusicTrack_RemoveNotificationType,
 216         IDirectMusicCommandTrack_IDirectMusicTrack_Clone,
 217         IDirectMusicCommandTrack_IDirectMusicTrack_PlayEx,
 218         IDirectMusicCommandTrack_IDirectMusicTrack_GetParamEx,
 219         IDirectMusicCommandTrack_IDirectMusicTrack_SetParamEx,
 220         IDirectMusicCommandTrack_IDirectMusicTrack_Compose,
 221         IDirectMusicCommandTrack_IDirectMusicTrack_Join
 222 };
 223
 224 /* IDirectMusicCommandTrack IPersistStream part: */
 225 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_QueryInterface (LPPERSISTSTREAM iface, REFIID riid, LPVOID *ppobj) {
 226         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
 227         return IDirectMusicCommandTrack_IUnknown_QueryInterface ((LPUNKNOWN)&This->UnknownVtbl, riid, ppobj);
 228 }
 229
 230 ULONG WINAPI IDirectMusicCommandTrack_IPersistStream_AddRef (LPPERSISTSTREAM iface) {
 231         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
 232         return IDirectMusicCommandTrack_IUnknown_AddRef ((LPUNKNOWN)&This->UnknownVtbl);
 233 }
 234
 235 ULONG WINAPI IDirectMusicCommandTrack_IPersistStream_Release (LPPERSISTSTREAM iface) {
 236         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
 237         return IDirectMusicCommandTrack_IUnknown_Release ((LPUNKNOWN)&This->UnknownVtbl);
 238 }
 239
 240 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_GetClassID (LPPERSISTSTREAM iface, CLSID* pClassID) {
 241         return E_NOTIMPL;
 242 }
 243
 244 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_IsDirty (LPPERSISTSTREAM iface) {
 245         return E_NOTIMPL;
 246 }
 247
 248 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_Load (LPPERSISTSTREAM iface, IStream* pStm) {
 249         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
 250         FOURCC chunkID;
 251         DWORD chunkSize, dwSizeOfStruct, nrCommands;
 252         LARGE_INTEGER liMove; /* used when skipping chunks */
 253
 254         IStream_Read (pStm, &chunkID, sizeof(FOURCC), NULL);
 255         IStream_Read (pStm, &chunkSize, sizeof(DWORD), NULL);
 256         TRACE_(dmfile)(": %s chunk (size = %ld)", debugstr_fourcc (chunkID), chunkSize);
 257         switch (chunkID) {
 258                 case DMUS_FOURCC_COMMANDTRACK_CHUNK: {
 259                         int count;
 260                         TRACE_(dmfile)(": command track chunk\n");
 261                         IStream_Read (pStm, &dwSizeOfStruct, sizeof(DWORD), NULL);
 262                         if (dwSizeOfStruct != sizeof(DMUS_IO_COMMAND)) {
 263                                 TRACE_(dmfile)(": declared size of struct (=%ld) != actual size (=%i); indicates older direct music version\n", dwSizeOfStruct, sizeof(DMUS_IO_COMMAND));
 264                         }
 265                         chunkSize -= sizeof(DWORD); /* now chunk size is one DWORD shorter */
 266                         nrCommands = chunkSize/dwSizeOfStruct; /* and this is the number of commands */
 267                         /* load each command seperately in new entry */
 268                         for (count = 0; count < nrCommands; count++) {
 269                                 LPDMUS_PRIVATE_COMMAND pNewCommand = HeapAlloc (GetProcessHeap (), HEAP_ZERO_MEMORY, sizeof(DMUS_PRIVATE_COMMAND));
 270                                 IStream_Read (pStm, &pNewCommand->pCommand, dwSizeOfStruct, NULL);
 271                                 list_add_tail (&This->Commands, &pNewCommand->entry);
 272                         }
 273                         TRACE_(dmfile)(": reading finished\n");
 274                         This->pDesc->dwValidData |= DMUS_OBJ_LOADED;
 275                         break;
 276                 }
 277                 default: {
 278                         TRACE_(dmfile)(": unexpected chunk; loading failed)\n");
 279                         liMove.QuadPart = chunkSize;
 280                         IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); /* skip the rest of the chunk */
 281                         return E_FAIL;
 282                 }
 283         }
 284
 285         /* DEBUG: dumps whole band track object tree: */
 286         if (TRACE_ON(dmstyle)) {
 287                 int r = 0;
 288                 DMUS_PRIVATE_COMMAND *tmpEntry;
 289                 struct list *listEntry;
 290                 TRACE("*** IDirectMusicCommandTrack (%p) ***\n", This->TrackVtbl);
 291                 TRACE(" - Commands:\n");
 292                 LIST_FOR_EACH (listEntry, &This->Commands) {
 293                         tmpEntry = LIST_ENTRY (listEntry, DMUS_PRIVATE_COMMAND, entry);
 294                         TRACE("    - Command[%i]:\n", r);
 295                         TRACE("       - mtTime = %li\n", tmpEntry->pCommand.mtTime);
 296                         TRACE("       - wMeasure = %d\n", tmpEntry->pCommand.wMeasure);
 297                         TRACE("       - bBeat = %i\n", tmpEntry->pCommand.bBeat);
 298                         TRACE("       - bCommand = %i\n", tmpEntry->pCommand.bCommand);
 299                         TRACE("       - bGrooveLevel = %i\n", tmpEntry->pCommand.bGrooveLevel);
 300                         TRACE("       - bGrooveRange = %i\n", tmpEntry->pCommand.bGrooveRange);
 301                         TRACE("       - bRepeatMode = %i\n", tmpEntry->pCommand.bRepeatMode);
 302                         r++;
 303                 }
 304         }
 305
 306         return S_OK;
 307 }
 308
 309 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_Save (LPPERSISTSTREAM iface, IStream* pStm, BOOL fClearDirty) {
 310         return E_NOTIMPL;
 311 }
 312
 313 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface, ULARGE_INTEGER* pcbSize) {
 314         return E_NOTIMPL;
 315 }
 316
 317 static const IPersistStreamVtbl DirectMusicCommandTrack_PersistStream_Vtbl = {
 318         IDirectMusicCommandTrack_IPersistStream_QueryInterface,
 319         IDirectMusicCommandTrack_IPersistStream_AddRef,
 320         IDirectMusicCommandTrack_IPersistStream_Release,
 321         IDirectMusicCommandTrack_IPersistStream_GetClassID,
 322         IDirectMusicCommandTrack_IPersistStream_IsDirty,
 323         IDirectMusicCommandTrack_IPersistStream_Load,
 324         IDirectMusicCommandTrack_IPersistStream_Save,
 325         IDirectMusicCommandTrack_IPersistStream_GetSizeMax
 326 };
 327
 328 /* for ClassFactory */
 329 HRESULT WINAPI DMUSIC_CreateDirectMusicCommandTrack (LPCGUID lpcGUID, LPVOID *ppobj, LPUNKNOWN pUnkOuter) {
 330         IDirectMusicCommandTrack* track;
 331
 332         track = HeapAlloc (GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(IDirectMusicCommandTrack));
 333         if (NULL == track) {
 334                 *ppobj = NULL;
 335                 return E_OUTOFMEMORY;
 336         }
 337         track->UnknownVtbl = &DirectMusicCommandTrack_Unknown_Vtbl;
 338         track->TrackVtbl = &DirectMusicCommandTrack_Track_Vtbl;
 339         track->PersistStreamVtbl = &DirectMusicCommandTrack_PersistStream_Vtbl;
 340         track->pDesc = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(DMUS_OBJECTDESC));
 341         DM_STRUCT_INIT(track->pDesc);
 342         track->pDesc->dwValidData |= DMUS_OBJ_CLASS;
 343         memcpy (&track->pDesc->guidClass, &CLSID_DirectMusicCommandTrack, sizeof (CLSID));
 344         track->ref = 0; /* will be inited by QueryInterface */
 345         list_init (&track->Commands);
 346
 347         return IDirectMusicCommandTrack_IUnknown_QueryInterface ((LPUNKNOWN)&track->UnknownVtbl, lpcGUID, ppobj);
 348 }