git.oblomov.eu Git - wine/blob - dlls/dmscript/dmscript_private.h

   1 /* DirectMusicScript Private Include
   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 #ifndef __WINE_DMSCRIPT_PRIVATE_H
  21 #define __WINE_DMSCRIPT_PRIVATE_H
  22
  23 #include <stdarg.h>
  24
  25 #include "windef.h"
  26 #include "winbase.h"
  27 #include "winnt.h"
  28 #include "wingdi.h"
  29 #include "winuser.h"
  30
  31 #include "wine/debug.h"
  32 #include "wine/list.h"
  33 #include "wine/unicode.h"
  34 #include "winreg.h"
  35
  36 #include "dmusici.h"
  37 #include "dmusicf.h"
  38 #include "dmusics.h"
  39
  40 /*****************************************************************************
  41  * Interfaces
  42  */
  43 typedef struct IDirectMusicScriptImpl IDirectMusicScriptImpl;
  44
  45 typedef struct IDirectMusicScriptTrack IDirectMusicScriptTrack;
  46
  47 /*****************************************************************************
  48  * Predeclare the interface implementation structures
  49  */
  50 extern ICOM_VTABLE(IUnknown)           DirectMusicScript_Unknown_Vtbl;
  51 extern ICOM_VTABLE(IDirectMusicScript) DirectMusicScript_Script_Vtbl;
  52 extern ICOM_VTABLE(IDirectMusicObject) DirectMusicScript_Object_Vtbl;
  53 extern ICOM_VTABLE(IPersistStream)     DirectMusicScript_PersistStream_Vtbl;
  54
  55 extern ICOM_VTABLE(IUnknown)           DirectMusicScriptTrack_Unknown_Vtbl;
  56 extern ICOM_VTABLE(IDirectMusicTrack8) DirectMusicScriptTrack_Track_Vtbl;
  57 extern ICOM_VTABLE(IPersistStream)     DirectMusicScriptTrack_PersistStream_Vtbl;
  58
  59 /*****************************************************************************
  60  * ClassFactory
  61  */
  62 extern HRESULT WINAPI DMUSIC_CreateDirectMusicScriptImpl (LPCGUID lpcGUID, LPVOID* ppobj, LPUNKNOWN pUnkOuter);
  63
  64 extern HRESULT WINAPI DMUSIC_CreateDirectMusicScriptTrack (LPCGUID lpcGUID, LPVOID* ppobj, LPUNKNOWN pUnkOuter);
  65
  66 /*****************************************************************************
  67  * IDirectMusicScriptImpl implementation structure
  68  */
  69 struct IDirectMusicScriptImpl {
  70   /* IUnknown fields */
  71   ICOM_VTABLE(IUnknown) *UnknownVtbl;
  72   ICOM_VTABLE(IDirectMusicScript) *ScriptVtbl;
  73   ICOM_VTABLE(IDirectMusicObject) *ObjectVtbl;
  74   ICOM_VTABLE(IPersistStream) *PersistStreamVtbl;
  75   DWORD          ref;
  76
  77   /* IDirectMusicScriptImpl fields */
  78   LPDMUS_OBJECTDESC pDesc;
  79 };
  80
  81 /* IUnknown: */
  82 extern HRESULT WINAPI IDirectMusicScriptImpl_IUnknown_QueryInterface (LPUNKNOWN iface, REFIID riid, LPVOID *ppobj);
  83 extern ULONG WINAPI   IDirectMusicScriptImpl_IUnknown_AddRef (LPUNKNOWN iface);
  84 extern ULONG WINAPI   IDirectMusicScriptImpl_IUnknown_Release (LPUNKNOWN iface);
  85 /* IDirectMusicScript: */
  86 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_QueryInterface (LPDIRECTMUSICSCRIPT iface, REFIID riid, LPVOID *ppobj);
  87 extern ULONG WINAPI   IDirectMusicScriptImpl_IDirectMusicScript_AddRef (LPDIRECTMUSICSCRIPT iface);
  88 extern ULONG WINAPI   IDirectMusicScriptImpl_IDirectMusicScript_Release (LPDIRECTMUSICSCRIPT iface);
  89 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_Init (LPDIRECTMUSICSCRIPT iface, IDirectMusicPerformance* pPerformance, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  90 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_CallRoutine (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszRoutineName, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  91 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_SetVariableVariant (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszVariableName, VARIANT varValue, BOOL fSetRef, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  92 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_GetVariableVariant (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszVariableName, VARIANT* pvarValue, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  93 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_SetVariableNumber (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszVariableName, LONG lValue, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  94 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_GetVariableNumber (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszVariableName, LONG* plValue, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  95 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_SetVariableObject (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszVariableName, IUnknown* punkValue, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  96 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_GetVariableObject (LPDIRECTMUSICSCRIPT iface, WCHAR* pwszVariableName, REFIID riid, LPVOID* ppv, DMUS_SCRIPT_ERRORINFO* pErrorInfo);
  97 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_EnumRoutine (LPDIRECTMUSICSCRIPT iface, DWORD dwIndex, WCHAR* pwszName);
  98 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicScript_EnumVariable (LPDIRECTMUSICSCRIPT iface, DWORD dwIndex, WCHAR* pwszName);
  99 /* IDirectMusicObject: */
 100 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicObject_QueryInterface (LPDIRECTMUSICOBJECT iface, REFIID riid, LPVOID *ppobj);
 101 extern ULONG WINAPI   IDirectMusicScriptImpl_IDirectMusicObject_AddRef (LPDIRECTMUSICOBJECT iface);
 102 extern ULONG WINAPI   IDirectMusicScriptImpl_IDirectMusicObject_Release (LPDIRECTMUSICOBJECT iface);
 103 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicObject_GetDescriptor (LPDIRECTMUSICOBJECT iface, LPDMUS_OBJECTDESC pDesc);
 104 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicObject_SetDescriptor (LPDIRECTMUSICOBJECT iface, LPDMUS_OBJECTDESC pDesc);
 105 extern HRESULT WINAPI IDirectMusicScriptImpl_IDirectMusicObject_ParseDescriptor (LPDIRECTMUSICOBJECT iface, LPSTREAM pStream, LPDMUS_OBJECTDESC pDesc);
 106 /* IPersistStream: */
 107 extern HRESULT WINAPI IDirectMusicScriptImpl_IPersistStream_QueryInterface (LPPERSISTSTREAM iface, REFIID riid, void** ppvObject);
 108 extern ULONG WINAPI   IDirectMusicScriptImpl_IPersistStream_AddRef (LPPERSISTSTREAM iface);
 109 extern ULONG WINAPI   IDirectMusicScriptImpl_IPersistStream_Release (LPPERSISTSTREAM iface);
 110 extern HRESULT WINAPI IDirectMusicScriptImpl_IPersistStream_GetClassID (LPPERSISTSTREAM iface, CLSID* pClassID);
 111 extern HRESULT WINAPI IDirectMusicScriptImpl_IPersistStream_IsDirty (LPPERSISTSTREAM iface);
 112 extern HRESULT WINAPI IDirectMusicScriptImpl_IPersistStream_Load (LPPERSISTSTREAM iface, IStream* pStm);
 113 extern HRESULT WINAPI IDirectMusicScriptImpl_IPersistStream_Save (LPPERSISTSTREAM iface, IStream* pStm, BOOL fClearDirty);
 114 extern HRESULT WINAPI IDirectMusicScriptImpl_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface, ULARGE_INTEGER* pcbSize);
 115
 116 /*****************************************************************************
 117  * IDirectMusicScriptTrack implementation structure
 118  */
 119 struct IDirectMusicScriptTrack {
 120   /* IUnknown fields */
 121   ICOM_VTABLE(IUnknown) *UnknownVtbl;
 122   ICOM_VTABLE(IDirectMusicTrack8) *TrackVtbl;
 123   ICOM_VTABLE(IPersistStream) *PersistStreamVtbl;
 124   DWORD          ref;
 125
 126   /* IDirectMusicScriptTrack fields */
 127   LPDMUS_OBJECTDESC pDesc;
 128 };
 129
 130 /* IUnknown: */
 131 extern HRESULT WINAPI IDirectMusicScriptTrack_IUnknown_QueryInterface (LPUNKNOWN iface, REFIID riid, LPVOID *ppobj);
 132 extern ULONG WINAPI   IDirectMusicScriptTrack_IUnknown_AddRef (LPUNKNOWN iface);
 133 extern ULONG WINAPI   IDirectMusicScriptTrack_IUnknown_Release (LPUNKNOWN iface);
 134 /* IDirectMusicTrack(8): */
 135 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_QueryInterface (LPDIRECTMUSICTRACK8 iface, REFIID riid, LPVOID *ppobj);
 136 extern ULONG WINAPI   IDirectMusicScriptTrack_IDirectMusicTrack_AddRef (LPDIRECTMUSICTRACK8 iface);
 137 extern ULONG WINAPI   IDirectMusicScriptTrack_IDirectMusicTrack_Release (LPDIRECTMUSICTRACK8 iface);
 138 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_Init (LPDIRECTMUSICTRACK8 iface, IDirectMusicSegment* pSegment);
 139 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_InitPlay (LPDIRECTMUSICTRACK8 iface, IDirectMusicSegmentState* pSegmentState, IDirectMusicPerformance* pPerformance, void** ppStateData, DWORD dwVirtualTrackID, DWORD dwFlags);
 140 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_EndPlay (LPDIRECTMUSICTRACK8 iface, void* pStateData);
 141 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_Play (LPDIRECTMUSICTRACK8 iface, void* pStateData, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags, IDirectMusicPerformance* pPerf, IDirectMusicSegmentState* pSegSt, DWORD dwVirtualID);
 142 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_GetParam (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME* pmtNext, void* pParam);
 143 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_SetParam (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, MUSIC_TIME mtTime, void* pParam);
 144 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_IsParamSupported (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType);
 145 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_AddNotificationType (LPDIRECTMUSICTRACK8 iface, REFGUID rguidNotificationType);
 146 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_RemoveNotificationType (LPDIRECTMUSICTRACK8 iface, REFGUID rguidNotificationType);
 147 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_Clone (LPDIRECTMUSICTRACK8 iface, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack** ppTrack);
 148 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_PlayEx (LPDIRECTMUSICTRACK8 iface, void* pStateData, REFERENCE_TIME rtStart, REFERENCE_TIME rtEnd, REFERENCE_TIME rtOffset, DWORD dwFlags, IDirectMusicPerformance* pPerf, IDirectMusicSegmentState* pSegSt, DWORD dwVirtualID);
 149 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_GetParamEx (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, REFERENCE_TIME rtTime, REFERENCE_TIME* prtNext, void* pParam, void* pStateData, DWORD dwFlags);
 150 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_SetParamEx (LPDIRECTMUSICTRACK8 iface, REFGUID rguidType, REFERENCE_TIME rtTime, void* pParam, void* pStateData, DWORD dwFlags);
 151 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_Compose (LPDIRECTMUSICTRACK8 iface, IUnknown* pContext, DWORD dwTrackGroup, IDirectMusicTrack** ppResultTrack);
 152 extern HRESULT WINAPI IDirectMusicScriptTrack_IDirectMusicTrack_Join (LPDIRECTMUSICTRACK8 iface, IDirectMusicTrack* pNewTrack, MUSIC_TIME mtJoin, IUnknown* pContext, DWORD dwTrackGroup, IDirectMusicTrack** ppResultTrack);
 153 /* IPersistStream: */
 154 extern HRESULT WINAPI IDirectMusicScriptTrack_IPersistStream_QueryInterface (LPPERSISTSTREAM iface, REFIID riid, void** ppvObject);
 155 extern ULONG WINAPI   IDirectMusicScriptTrack_IPersistStream_AddRef (LPPERSISTSTREAM iface);
 156 extern ULONG WINAPI   IDirectMusicScriptTrack_IPersistStream_Release (LPPERSISTSTREAM iface);
 157 extern HRESULT WINAPI IDirectMusicScriptTrack_IPersistStream_GetClassID (LPPERSISTSTREAM iface, CLSID* pClassID);
 158 extern HRESULT WINAPI IDirectMusicScriptTrack_IPersistStream_IsDirty (LPPERSISTSTREAM iface);
 159 extern HRESULT WINAPI IDirectMusicScriptTrack_IPersistStream_Load (LPPERSISTSTREAM iface, IStream* pStm);
 160 extern HRESULT WINAPI IDirectMusicScriptTrack_IPersistStream_Save (LPPERSISTSTREAM iface, IStream* pStm, BOOL fClearDirty);
 161 extern HRESULT WINAPI IDirectMusicScriptTrack_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface, ULARGE_INTEGER* pcbSize);
 162
 163
 164 /*****************************************************************************
 165  * Misc.
 166  */
 167 /* for simpler reading */
 168 typedef struct _DMUS_PRIVATE_CHUNK {
 169         FOURCC fccID; /* FOURCC ID of the chunk */
 170         DWORD dwSize; /* size of the chunk */
 171 } DMUS_PRIVATE_CHUNK, *LPDMUS_PRIVATE_CHUNK;
 172
 173 /* check whether the given DWORD is even (return 0) or odd (return 1) */
 174 static inline int even_or_odd (DWORD number) {
 175         return (number & 0x1); /* basically, check if bit 0 is set ;) */
 176 }
 177
 178 /* FOURCC to string conversion for debug messages */
 179 static inline const char *debugstr_fourcc (DWORD fourcc) {
 180     if (!fourcc) return "'null'";
 181     return wine_dbg_sprintf ("\'%c%c%c%c\'",
 182                 (char)(fourcc), (char)(fourcc >> 8),
 183         (char)(fourcc >> 16), (char)(fourcc >> 24));
 184 }
 185
 186 /* DMUS_VERSION struct to string conversion for debug messages */
 187 static inline const char *debugstr_dmversion (LPDMUS_VERSION version) {
 188         if (!version) return "'null'";
 189         return wine_dbg_sprintf ("\'%i,%i,%i,%i\'",
 190                 (int)((version->dwVersionMS && 0xFFFF0000) >> 8), (int)(version->dwVersionMS && 0x0000FFFF),
 191                 (int)((version->dwVersionLS && 0xFFFF0000) >> 8), (int)(version->dwVersionLS && 0x0000FFFF));
 192 }
 193
 194 /* used for initialising structs (primarily for DMUS_OBJECTDESC) */
 195 #define DM_STRUCT_INIT(x)                               \
 196         do {                                                            \
 197                 memset((x), 0, sizeof(*(x)));   \
 198                 (x)->dwSize = sizeof(*x);               \
 199         } while (0)
 200
 201
 202 /* used for generic dumping (copied from ddraw) */
 203 typedef struct {
 204     DWORD val;
 205     const char* name;
 206 } flag_info;
 207
 208 #define FE(x) { x, #x }
 209 #define DMUSIC_dump_flags(flags,names,num_names) DMUSIC_dump_flags_(flags, names, num_names, 1)
 210
 211 /* generic dump function */
 212 static inline void DMUSIC_dump_flags_ (DWORD flags, const flag_info* names, size_t num_names, int newline) {
 213         unsigned int i;
 214
 215         for (i=0; i < num_names; i++) {
 216                 if ((flags & names[i].val) ||      /* standard flag value */
 217                 ((!flags) && (!names[i].val))) /* zero value only */
 218                 DPRINTF("%s ", names[i].name);
 219         }
 220
 221     if (newline) DPRINTF("\n");
 222 }
 223
 224 static inline void DMUSIC_dump_DMUS_OBJ_FLAGS (DWORD flagmask) {
 225     static const flag_info flags[] = {
 226             FE(DMUS_OBJ_OBJECT),
 227             FE(DMUS_OBJ_CLASS),
 228             FE(DMUS_OBJ_NAME),
 229             FE(DMUS_OBJ_CATEGORY),
 230             FE(DMUS_OBJ_FILENAME),
 231             FE(DMUS_OBJ_FULLPATH),
 232             FE(DMUS_OBJ_URL),
 233             FE(DMUS_OBJ_VERSION),
 234             FE(DMUS_OBJ_DATE),
 235             FE(DMUS_OBJ_LOADED),
 236             FE(DMUS_OBJ_MEMORY),
 237             FE(DMUS_OBJ_STREAM)
 238         };
 239     DMUSIC_dump_flags(flagmask, flags, sizeof(flags)/sizeof(flags[0]));
 240 }
 241
 242 static inline void DMUSIC_dump_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc) {
 243         if (pDesc) {
 244                 DPRINTF("DMUS_OBJECTDESC (%p)\n", pDesc);
 245                 DPRINTF("  - dwSize = %ld\n", pDesc->dwSize);
 246                 DPRINTF("  - dwValidData = ");
 247                 DMUSIC_dump_DMUS_OBJ_FLAGS (pDesc->dwValidData);
 248                 if (pDesc->dwValidData & DMUS_OBJ_CLASS) DPRINTF("  - guidClass = %s\n", debugstr_guid(&pDesc->guidClass));
 249                 if (pDesc->dwValidData & DMUS_OBJ_OBJECT) DPRINTF("  - guidObject = %s\n", debugstr_guid(&pDesc->guidObject));
 250                 if (pDesc->dwValidData & DMUS_OBJ_DATE) DPRINTF("  - ftDate = FIXME\n");
 251                 if (pDesc->dwValidData & DMUS_OBJ_VERSION) DPRINTF("  - vVersion = %s\n", debugstr_dmversion(&pDesc->vVersion));
 252                 if (pDesc->dwValidData & DMUS_OBJ_NAME) DPRINTF("  - wszName = %s\n", debugstr_w(pDesc->wszName));
 253                 if (pDesc->dwValidData & DMUS_OBJ_CATEGORY) DPRINTF("  - wszCategory = %s\n", debugstr_w(pDesc->wszCategory));
 254                 if (pDesc->dwValidData & DMUS_OBJ_FILENAME) DPRINTF("  - wszFileName = %s\n", debugstr_w(pDesc->wszFileName));
 255                 if (pDesc->dwValidData & DMUS_OBJ_MEMORY) DPRINTF("  - llMemLength = %lli\n  - pbMemData = %p\n", pDesc->llMemLength, pDesc->pbMemData);
 256                 if (pDesc->dwValidData & DMUS_OBJ_STREAM) DPRINTF("  - pStream = %p\n", pDesc->pStream);
 257         } else {
 258                 DPRINTF("(NULL)\n");
 259         }
 260 }
 261
 262 #endif  /* __WINE_DMSCRIPT_PRIVATE_H */