Moved ICOM_THIS_MULTI definition out of objbase.h and into the files
[wine] / 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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         TRACE("(%p): AddRef from %ld\n", This, This->ref);
55         return ++(This->ref);
56 }
57
58 ULONG WINAPI IDirectMusicCommandTrack_IUnknown_Release (LPUNKNOWN iface) {
59         ICOM_THIS_MULTI(IDirectMusicCommandTrack, UnknownVtbl, iface);
60         ULONG ref = --This->ref;
61         TRACE("(%p): ReleaseRef to %ld\n", This, This->ref);
62         if (ref == 0) {
63                 HeapFree(GetProcessHeap(), 0, This);
64         }
65         return ref;
66 }
67
68 IUnknownVtbl DirectMusicCommandTrack_Unknown_Vtbl = {
69     ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
70         IDirectMusicCommandTrack_IUnknown_QueryInterface,
71         IDirectMusicCommandTrack_IUnknown_AddRef,
72         IDirectMusicCommandTrack_IUnknown_Release
73 };
74
75 /* IDirectMusicCommandTrack IDirectMusicTrack8 part: */
76 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_QueryInterface (LPDIRECTMUSICTRACK8 iface, REFIID riid, LPVOID *ppobj) {
77         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
78         return IDirectMusicCommandTrack_IUnknown_QueryInterface ((LPUNKNOWN)&This->UnknownVtbl, riid, ppobj);
79 }
80
81 ULONG WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_AddRef (LPDIRECTMUSICTRACK8 iface) {
82         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
83         return IDirectMusicCommandTrack_IUnknown_AddRef ((LPUNKNOWN)&This->UnknownVtbl);
84 }
85
86 ULONG WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Release (LPDIRECTMUSICTRACK8 iface) {
87         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
88         return IDirectMusicCommandTrack_IUnknown_Release ((LPUNKNOWN)&This->UnknownVtbl);
89 }
90
91 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Init (LPDIRECTMUSICTRACK8 iface, IDirectMusicSegment* pSegment)
92 {
93         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
94         FIXME("(%p, %p): stub\n", This, pSegment);
95         return S_OK;
96 }
97
98 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_InitPlay (LPDIRECTMUSICTRACK8 iface, IDirectMusicSegmentState* pSegmentState, IDirectMusicPerformance* pPerformance, void** ppStateData, DWORD dwVirtualTrack8ID, DWORD dwFlags)
99 {
100         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
101         FIXME("(%p, %p, %p, %p, %ld, %ld): stub\n", This, pSegmentState, pPerformance, ppStateData, dwVirtualTrack8ID, dwFlags);
102         return S_OK;
103 }
104
105 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_EndPlay (LPDIRECTMUSICTRACK8 iface, void* pStateData)
106 {
107         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
108         FIXME("(%p, %p): stub\n", This, pStateData);
109         return S_OK;
110 }
111
112 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)
113 {
114         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
115         FIXME("(%p, %p, %ld, %ld, %ld, %ld, %p, %p, %ld): stub\n", This, pStateData, mtStart, mtEnd, mtOffset, dwFlags, pPerf, pSegSt, dwVirtualID);
116         return S_OK;
117 }
118
119 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_GetParam (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME* pmtNext, void* pParam) {
120         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
121         FIXME("(%p, %s, %ld, %p, %p): stub\n", This, debugstr_dmguid(rguidType), mtTime, pmtNext, pParam);
122         return S_OK;
123 }
124
125 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_SetParam (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, MUSIC_TIME mtTime, void* pParam) {
126         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
127         FIXME("(%p, %s, %ld, %p): stub\n", This, debugstr_dmguid(rguidType), mtTime, pParam);
128         return S_OK;
129 }
130
131 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_IsParamSupported (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType) {
132         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
133
134         TRACE("(%p, %s): ", This, debugstr_dmguid(rguidType));
135         if (IsEqualGUID (rguidType, &GUID_CommandParam)
136                 || IsEqualGUID (rguidType, &GUID_CommandParam2)
137                 || IsEqualGUID (rguidType, &GUID_CommandParamNext)) {
138                 TRACE("param supported\n");
139                 return S_OK;
140         }
141         
142         TRACE("param unsupported\n");
143         return DMUS_E_TYPE_UNSUPPORTED;
144 }
145
146 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_AddNotificationType (LPDIRECTMUSICTRACK8 iface, REFGUID rguidNotificationType) {
147         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
148         FIXME("(%p, %s): stub\n", This, debugstr_dmguid(rguidNotificationType));
149         return S_OK;
150 }
151
152 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_RemoveNotificationType (LPDIRECTMUSICTRACK8 iface, REFGUID rguidNotificationType) {
153         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
154         FIXME("(%p, %s): stub\n", This, debugstr_dmguid(rguidNotificationType));
155         return S_OK;
156 }
157
158 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Clone (LPDIRECTMUSICTRACK8 iface, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack** ppTrack) {
159         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
160         FIXME("(%p, %ld, %ld, %p): stub\n", This, mtStart, mtEnd, ppTrack);
161         return S_OK;
162 }
163
164 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) {
165         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
166         FIXME("(%p, %p, %lli, %lli, %lli, %ld, %p, %p, %ld): stub\n", This, pStateData, rtStart, rtEnd, rtOffset, dwFlags, pPerf, pSegSt, dwVirtualID);
167         return S_OK;
168 }
169
170 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_GetParamEx (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, REFERENCE_TIME rtTime, REFERENCE_TIME* prtNext, void* pParam, void* pStateData, DWORD dwFlags) {
171         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
172         FIXME("(%p, %s, %lli, %p, %p, %p, %ld): stub\n", This, debugstr_dmguid(rguidType), rtTime, prtNext, pParam, pStateData, dwFlags);
173         return S_OK;
174 }
175
176 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_SetParamEx (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, REFERENCE_TIME rtTime, void* pParam, void* pStateData, DWORD dwFlags) {
177         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
178         FIXME("(%p, %s, %lli, %p, %p, %ld): stub\n", This, debugstr_dmguid(rguidType), rtTime, pParam, pStateData, dwFlags);
179         return S_OK;
180 }
181
182 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Compose (LPDIRECTMUSICTRACK8 iface, IUnknown* pContext, DWORD dwTrackGroup, IDirectMusicTrack** ppResultTrack) {
183         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
184         FIXME("(%p, %p, %ld, %p): stub\n", This, pContext, dwTrackGroup, ppResultTrack);
185         return S_OK;
186 }
187
188 HRESULT WINAPI IDirectMusicCommandTrack_IDirectMusicTrack_Join (LPDIRECTMUSICTRACK8 iface, IDirectMusicTrack* pNewTrack, MUSIC_TIME mtJoin, IUnknown* pContext, DWORD dwTrackGroup, IDirectMusicTrack** ppResultTrack) {
189         ICOM_THIS_MULTI(IDirectMusicCommandTrack, TrackVtbl, iface);
190         FIXME("(%p, %p, %ld, %p, %ld, %p): stub\n", This, pNewTrack, mtJoin, pContext, dwTrackGroup, ppResultTrack);
191         return S_OK;
192 }
193
194 IDirectMusicTrack8Vtbl DirectMusicCommandTrack_Track_Vtbl = {
195     ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
196         IDirectMusicCommandTrack_IDirectMusicTrack_QueryInterface,
197         IDirectMusicCommandTrack_IDirectMusicTrack_AddRef,
198         IDirectMusicCommandTrack_IDirectMusicTrack_Release,
199         IDirectMusicCommandTrack_IDirectMusicTrack_Init,
200         IDirectMusicCommandTrack_IDirectMusicTrack_InitPlay,
201         IDirectMusicCommandTrack_IDirectMusicTrack_EndPlay,
202         IDirectMusicCommandTrack_IDirectMusicTrack_Play,
203         IDirectMusicCommandTrack_IDirectMusicTrack_GetParam,
204         IDirectMusicCommandTrack_IDirectMusicTrack_SetParam,
205         IDirectMusicCommandTrack_IDirectMusicTrack_IsParamSupported,
206         IDirectMusicCommandTrack_IDirectMusicTrack_AddNotificationType,
207         IDirectMusicCommandTrack_IDirectMusicTrack_RemoveNotificationType,
208         IDirectMusicCommandTrack_IDirectMusicTrack_Clone,
209         IDirectMusicCommandTrack_IDirectMusicTrack_PlayEx,
210         IDirectMusicCommandTrack_IDirectMusicTrack_GetParamEx,
211         IDirectMusicCommandTrack_IDirectMusicTrack_SetParamEx,
212         IDirectMusicCommandTrack_IDirectMusicTrack_Compose,
213         IDirectMusicCommandTrack_IDirectMusicTrack_Join
214 };
215
216 /* IDirectMusicCommandTrack IPersistStream part: */
217 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_QueryInterface (LPPERSISTSTREAM iface, REFIID riid, LPVOID *ppobj) {
218         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
219         return IDirectMusicCommandTrack_IUnknown_QueryInterface ((LPUNKNOWN)&This->UnknownVtbl, riid, ppobj);
220 }
221
222 ULONG WINAPI IDirectMusicCommandTrack_IPersistStream_AddRef (LPPERSISTSTREAM iface) {
223         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
224         return IDirectMusicCommandTrack_IUnknown_AddRef ((LPUNKNOWN)&This->UnknownVtbl);
225 }
226
227 ULONG WINAPI IDirectMusicCommandTrack_IPersistStream_Release (LPPERSISTSTREAM iface) {
228         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
229         return IDirectMusicCommandTrack_IUnknown_Release ((LPUNKNOWN)&This->UnknownVtbl);
230 }
231
232 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_GetClassID (LPPERSISTSTREAM iface, CLSID* pClassID) {
233         return E_NOTIMPL;
234 }
235
236 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_IsDirty (LPPERSISTSTREAM iface) {
237         return E_NOTIMPL;
238 }
239
240 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_Load (LPPERSISTSTREAM iface, IStream* pStm) {
241         ICOM_THIS_MULTI(IDirectMusicCommandTrack, PersistStreamVtbl, iface);
242         FOURCC chunkID;
243         DWORD chunkSize, dwSizeOfStruct, nrCommands;
244         LARGE_INTEGER liMove; /* used when skipping chunks */
245         
246         IStream_Read (pStm, &chunkID, sizeof(FOURCC), NULL);
247         IStream_Read (pStm, &chunkSize, sizeof(DWORD), NULL);
248         TRACE_(dmfile)(": %s chunk (size = %ld)", debugstr_fourcc (chunkID), chunkSize);
249         switch (chunkID) {
250                 case DMUS_FOURCC_COMMANDTRACK_CHUNK: {
251                         int count;
252                         TRACE_(dmfile)(": command track chunk\n");
253                         IStream_Read (pStm, &dwSizeOfStruct, sizeof(DWORD), NULL);
254                         if (dwSizeOfStruct != sizeof(DMUS_IO_COMMAND)) {
255                                 TRACE_(dmfile)(": declared size of struct (=%ld) != actual size (=%i); indicates older direct music version\n", dwSizeOfStruct, sizeof(DMUS_IO_COMMAND));
256                         }
257                         chunkSize -= sizeof(DWORD); /* now chunk size is one DWORD shorter */
258                         nrCommands = chunkSize/dwSizeOfStruct; /* and this is the number of commands */
259                         /* load each command seperately in new entry */
260                         for (count = 0; count < nrCommands; count++) {
261                                 LPDMUS_PRIVATE_COMMAND pNewCommand = (LPDMUS_PRIVATE_COMMAND) HeapAlloc (GetProcessHeap (), HEAP_ZERO_MEMORY, sizeof(DMUS_PRIVATE_COMMAND));
262                                 IStream_Read (pStm, &pNewCommand->pCommand, dwSizeOfStruct, NULL);
263                                 list_add_tail (&This->Commands, &pNewCommand->entry);
264                         }
265                         TRACE_(dmfile)(": reading finished\n");
266                         This->pDesc->dwValidData |= DMUS_OBJ_LOADED;
267                         break;
268                 }       
269                 default: {
270                         TRACE_(dmfile)(": unexpected chunk; loading failed)\n");
271                         liMove.QuadPart = chunkSize;
272                         IStream_Seek (pStm, liMove, STREAM_SEEK_CUR, NULL); /* skip the rest of the chunk */
273                         return E_FAIL;
274                 }
275         }
276
277         /* DEBUG: dumps whole band track object tree: */
278         if (TRACE_ON(dmstyle)) {
279                 int r = 0;
280                 DMUS_PRIVATE_COMMAND *tmpEntry;
281                 struct list *listEntry;
282                 TRACE("*** IDirectMusicCommandTrack (%p) ***\n", (LPDIRECTMUSICTRACK8)This->TrackVtbl);
283                 TRACE(" - Commands:\n");
284                 LIST_FOR_EACH (listEntry, &This->Commands) {
285                         tmpEntry = LIST_ENTRY (listEntry, DMUS_PRIVATE_COMMAND, entry);
286                         TRACE("    - Command[%i]:\n", r);
287                         TRACE("       - mtTime = %li\n", tmpEntry->pCommand.mtTime);
288                         TRACE("       - wMeasure = %d\n", tmpEntry->pCommand.wMeasure);
289                         TRACE("       - bBeat = %i\n", tmpEntry->pCommand.bBeat);
290                         TRACE("       - bCommand = %i\n", tmpEntry->pCommand.bCommand);
291                         TRACE("       - bGrooveLevel = %i\n", tmpEntry->pCommand.bGrooveLevel);
292                         TRACE("       - bGrooveRange = %i\n", tmpEntry->pCommand.bGrooveRange);
293                         TRACE("       - bRepeatMode = %i\n", tmpEntry->pCommand.bRepeatMode);                   
294                         r++;
295                 }
296         }
297
298         return S_OK;
299 }
300
301 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_Save (LPPERSISTSTREAM iface, IStream* pStm, BOOL fClearDirty) {
302         return E_NOTIMPL;
303 }
304
305 HRESULT WINAPI IDirectMusicCommandTrack_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface, ULARGE_INTEGER* pcbSize) {
306         return E_NOTIMPL;
307 }
308
309 IPersistStreamVtbl DirectMusicCommandTrack_PersistStream_Vtbl = {
310     ICOM_MSVTABLE_COMPAT_DummyRTTIVALUE
311         IDirectMusicCommandTrack_IPersistStream_QueryInterface,
312         IDirectMusicCommandTrack_IPersistStream_AddRef,
313         IDirectMusicCommandTrack_IPersistStream_Release,
314         IDirectMusicCommandTrack_IPersistStream_GetClassID,
315         IDirectMusicCommandTrack_IPersistStream_IsDirty,
316         IDirectMusicCommandTrack_IPersistStream_Load,
317         IDirectMusicCommandTrack_IPersistStream_Save,
318         IDirectMusicCommandTrack_IPersistStream_GetSizeMax
319 };
320
321 /* for ClassFactory */
322 HRESULT WINAPI DMUSIC_CreateDirectMusicCommandTrack (LPCGUID lpcGUID, LPVOID *ppobj, LPUNKNOWN pUnkOuter) {
323         IDirectMusicCommandTrack* track;
324         
325         track = HeapAlloc (GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(IDirectMusicCommandTrack));
326         if (NULL == track) {
327                 *ppobj = (LPVOID) NULL;
328                 return E_OUTOFMEMORY;
329         }
330         track->UnknownVtbl = &DirectMusicCommandTrack_Unknown_Vtbl;
331         track->TrackVtbl = &DirectMusicCommandTrack_Track_Vtbl;
332         track->PersistStreamVtbl = &DirectMusicCommandTrack_PersistStream_Vtbl;
333         track->pDesc = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(DMUS_OBJECTDESC));
334         DM_STRUCT_INIT(track->pDesc);
335         track->pDesc->dwValidData |= DMUS_OBJ_CLASS;
336         memcpy (&track->pDesc->guidClass, &CLSID_DirectMusicCommandTrack, sizeof (CLSID));
337         track->ref = 0; /* will be inited by QueryInterface */
338         list_init (&track->Commands);
339         
340         return IDirectMusicCommandTrack_IUnknown_QueryInterface ((LPUNKNOWN)&track->UnknownVtbl, lpcGUID, ppobj);
341 }