git.oblomov.eu Git - wine/blob - dlls/dmloader/dmloader_private.h

   1 /* DirectMusicLoader 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_DMLOADER_PRIVATE_H
  21 #define __WINE_DMLOADER_PRIVATE_H
  22
  23 #include <stdio.h>
  24 #include <stdarg.h>
  25 #include <string.h>
  26
  27 #include "windef.h"
  28 #include "winbase.h"
  29 #include "winnt.h"
  30 #include "wingdi.h"
  31 #include "winuser.h"
  32
  33 #include "wine/debug.h"
  34 #include "wine/list.h"
  35 #include "wine/unicode.h"
  36 #include "winreg.h"
  37
  38 #include "dmusici.h"
  39 #include "dmusicf.h"
  40 #include "dmusics.h"
  41
  42 /*****************************************************************************
  43  * Auxiliary definitions
  44  */
  45 /* cache entry */
  46 typedef struct _DMUS_PRIVATE_CACHE_ENTRY {
  47         struct list entry; /* for listing elements */
  48         BOOL bIsFaultyDLS; /* my workaround for enabling caching of "faulty" dls collections */
  49     LPDIRECTMUSICOBJECT pObject; /* pointer to object */
  50 } DMUS_PRIVATE_CACHE_ENTRY, *LPDMUS_PRIVATE_CACHE_ENTRY;
  51
  52 /* alias entry */
  53 typedef struct _DMUS_PRIVATE_ALIAS_ENTRY {
  54         struct list entry; /* for listing elements */
  55         LPDMUS_OBJECTDESC pDesc; /* descriptor, containing info */
  56 } DMUS_PRIVATE_ALIAS_ENTRY, *LPDMUS_PRIVATE_ALIAS_ENTRY;
  57
  58 /* contained object entry */
  59 typedef struct _DMUS_PRIVATE_CONTAINED_OBJECT_ENTRY {
  60         struct list entry; /* for listing elements */
  61         WCHAR* wszAlias;
  62         LPDMUS_OBJECTDESC pDesc;
  63 } DMUS_PRIVATE_CONTAINED_OBJECT_ENTRY, *LPDMUS_PRIVATE_CONTAINED_OBJECT_ENTRY;
  64
  65 /*****************************************************************************
  66  * Interfaces
  67  */
  68 typedef struct IDirectMusicLoader8Impl IDirectMusicLoader8Impl;
  69 typedef struct IDirectMusicContainerImpl IDirectMusicContainerImpl;
  70
  71 typedef struct ILoaderStream ILoaderStream;
  72
  73 /*****************************************************************************
  74  * Predeclare the interface implementation structures
  75  */
  76 extern ICOM_VTABLE(IDirectMusicLoader8) DirectMusicLoader8_Vtbl;
  77
  78 extern ICOM_VTABLE(IUnknown) DirectMusicContainer_Unknown_Vtbl;
  79 extern ICOM_VTABLE(IDirectMusicContainer) DirectMusicContainer_Container_Vtbl;
  80 extern ICOM_VTABLE(IDirectMusicObject) DirectMusicContainer_Object_Vtbl;
  81 extern ICOM_VTABLE(IPersistStream) DirectMusicContainer_PersistStream_Vtbl;
  82
  83 extern ICOM_VTABLE(IUnknown) LoaderStream_Unknown_Vtbl;
  84 extern ICOM_VTABLE(IStream) LoaderStream_Stream_Vtbl;
  85 extern ICOM_VTABLE(IDirectMusicGetLoader) LoaderStream_GetLoader_Vtbl;
  86
  87 /*****************************************************************************
  88  * ClassFactory
  89  */
  90 extern HRESULT WINAPI DMUSIC_CreateDirectMusicLoaderImpl (LPCGUID lpcGUID, LPVOID *ppobj, LPUNKNOWN pUnkOuter);
  91 extern HRESULT WINAPI DMUSIC_CreateDirectMusicContainerImpl (LPCGUID lpcGUID, LPVOID *ppobj, LPUNKNOWN pUnkOuter);
  92
  93 extern HRESULT WINAPI DMUSIC_CreateLoaderStream (LPVOID *ppobj);
  94
  95 /*****************************************************************************
  96  * IDirectMusicLoader8Impl implementation structure
  97  */
  98 struct IDirectMusicLoader8Impl {
  99   /* IUnknown fields */
 100   ICOM_VFIELD(IDirectMusicLoader8);
 101   DWORD          ref;
 102
 103   /* IDirectMusicLoaderImpl fields */
 104   WCHAR wzSearchPath[MAX_PATH];
 105
 106   /* simple cache (linked list) */
 107   struct list CacheList;
 108   struct list AliasList;
 109 };
 110
 111 /* IUnknown: */
 112 extern HRESULT WINAPI IDirectMusicLoader8Impl_QueryInterface (LPDIRECTMUSICLOADER8 iface, REFIID riid, LPVOID *ppobj);
 113 extern ULONG WINAPI   IDirectMusicLoader8Impl_AddRef (LPDIRECTMUSICLOADER8 iface);
 114 extern ULONG WINAPI   IDirectMusicLoader8Impl_Release (LPDIRECTMUSICLOADER8 iface);
 115 /* IDirectMusicLoader: */
 116 extern HRESULT WINAPI IDirectMusicLoader8Impl_GetObject (LPDIRECTMUSICLOADER8 iface, LPDMUS_OBJECTDESC pDesc, REFIID riid, LPVOID*ppv);
 117 extern HRESULT WINAPI IDirectMusicLoader8Impl_SetObject (LPDIRECTMUSICLOADER8 iface, LPDMUS_OBJECTDESC pDesc);
 118 extern HRESULT WINAPI IDirectMusicLoader8Impl_SetSearchDirectory (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, WCHAR* pwzPath, BOOL fClear);
 119 extern HRESULT WINAPI IDirectMusicLoader8Impl_ScanDirectory (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, WCHAR* pwzFileExtension, WCHAR* pwzScanFileName);
 120 extern HRESULT WINAPI IDirectMusicLoader8Impl_CacheObject (LPDIRECTMUSICLOADER8 iface, IDirectMusicObject* pObject);
 121 extern HRESULT WINAPI IDirectMusicLoader8Impl_ReleaseObject (LPDIRECTMUSICLOADER8 iface, IDirectMusicObject* pObject);
 122 extern HRESULT WINAPI IDirectMusicLoader8Impl_ClearCache (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass);
 123 extern HRESULT WINAPI IDirectMusicLoader8Impl_EnableCache (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, BOOL fEnable);
 124 extern HRESULT WINAPI IDirectMusicLoader8Impl_EnumObject (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, DWORD dwIndex, LPDMUS_OBJECTDESC pDesc);
 125 /* IDirectMusicLoader8: */
 126 extern void    WINAPI IDirectMusicLoader8Impl_CollectGarbage (LPDIRECTMUSICLOADER8 iface);
 127 extern HRESULT WINAPI IDirectMusicLoader8Impl_ReleaseObjectByUnknown (LPDIRECTMUSICLOADER8 iface, IUnknown* pObject);
 128 extern HRESULT WINAPI IDirectMusicLoader8Impl_LoadObjectFromFile (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClassID, REFIID iidInterfaceID, WCHAR* pwzFilePath, void** ppObject);
 129
 130 /*****************************************************************************
 131  * IDirectMusicContainerImpl implementation structure
 132  */
 133 struct IDirectMusicContainerImpl {
 134   /* IUnknown fields */
 135   ICOM_VTABLE(IUnknown) *UnknownVtbl;
 136   ICOM_VTABLE(IDirectMusicContainer) *ContainerVtbl;
 137   ICOM_VTABLE(IDirectMusicObject) *ObjectVtbl;
 138   ICOM_VTABLE(IPersistStream) *PersistStreamVtbl;
 139   DWORD          ref;
 140
 141   /* IDirectMusicContainerImpl fields */
 142   LPDMUS_OBJECTDESC pDesc;
 143   DMUS_IO_CONTAINER_HEADER* pHeader;
 144
 145   /* list of objects */
 146   struct list ObjectsList;
 147 };
 148
 149 /* IUnknown: */
 150 extern HRESULT WINAPI IDirectMusicContainerImpl_IUnknown_QueryInterface (LPUNKNOWN iface, REFIID riid, LPVOID *ppobj);
 151 extern ULONG   WINAPI IDirectMusicContainerImpl_IUnknown_AddRef (LPUNKNOWN iface);
 152 extern ULONG   WINAPI IDirectMusicContainerImpl_IUnknown_Release (LPUNKNOWN iface);
 153 /* IDirectMusicContainer: */
 154 extern HRESULT WINAPI IDirectMusicContainerImpl_IDirectMusicContainer_QueryInterface (LPDIRECTMUSICCONTAINER iface, REFIID riid, LPVOID *ppobj);
 155 extern ULONG   WINAPI IDirectMusicContainerImpl_IDirectMusicContainer_AddRef (LPDIRECTMUSICCONTAINER iface);
 156 extern ULONG   WINAPI IDirectMusicContainerImpl_IDirectMusicContainer_Release (LPDIRECTMUSICCONTAINER iface);
 157 extern HRESULT WINAPI IDirectMusicContainerImpl_IDirectMusicContainer_EnumObject (LPDIRECTMUSICCONTAINER iface, REFGUID rguidClass, DWORD dwIndex, LPDMUS_OBJECTDESC pDesc, WCHAR* pwszAlias);
 158 /* IDirectMusicObject: */
 159 extern HRESULT WINAPI IDirectMusicContainerImpl_IDirectMusicObject_QueryInterface (LPDIRECTMUSICOBJECT iface, REFIID riid, LPVOID *ppobj);
 160 extern ULONG   WINAPI IDirectMusicContainerImpl_IDirectMusicObject_AddRef (LPDIRECTMUSICOBJECT iface);
 161 extern ULONG   WINAPI IDirectMusicContainerImpl_IDirectMusicObject_Release (LPDIRECTMUSICOBJECT iface);
 162 extern HRESULT WINAPI IDirectMusicContainerImpl_IDirectMusicObject_GetDescriptor (LPDIRECTMUSICOBJECT iface, LPDMUS_OBJECTDESC pDesc);
 163 extern HRESULT WINAPI IDirectMusicContainerImpl_IDirectMusicObject_SetDescriptor (LPDIRECTMUSICOBJECT iface, LPDMUS_OBJECTDESC pDesc);
 164 extern HRESULT WINAPI IDirectMusicContainerImpl_IDirectMusicObject_ParseDescriptor (LPDIRECTMUSICOBJECT iface, LPSTREAM pStream, LPDMUS_OBJECTDESC pDesc);
 165
 166 /* IPersistStream: */
 167 extern HRESULT WINAPI IDirectMusicContainerImpl_IPersistStream_QueryInterface (LPPERSISTSTREAM iface, REFIID riid, void** ppvObject);
 168 extern ULONG   WINAPI IDirectMusicContainerImpl_IPersistStream_AddRef (LPPERSISTSTREAM iface);
 169 extern ULONG   WINAPI IDirectMusicContainerImpl_IPersistStream_Release (LPPERSISTSTREAM iface);
 170 extern HRESULT WINAPI IDirectMusicContainerImpl_IPersistStream_GetClassID (LPPERSISTSTREAM iface, CLSID* pClassID);
 171 extern HRESULT WINAPI IDirectMusicContainerImpl_IPersistStream_IsDirty (LPPERSISTSTREAM iface);
 172 extern HRESULT WINAPI IDirectMusicContainerImpl_IPersistStream_Load (LPPERSISTSTREAM iface, IStream* pStm);
 173 extern HRESULT WINAPI IDirectMusicContainerImpl_IPersistStream_Save (LPPERSISTSTREAM iface, IStream* pStm, BOOL fClearDirty);
 174 extern HRESULT WINAPI IDirectMusicContainerImpl_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface, ULARGE_INTEGER* pcbSize);
 175
 176
 177 /*****************************************************************************
 178  * ILoaderStream implementation structure
 179  */
 180 struct ILoaderStream {
 181   /* IUnknown fields */
 182   ICOM_VTABLE(IUnknown) *UnknownVtbl;
 183   ICOM_VTABLE(IStream) *StreamVtbl;
 184   ICOM_VTABLE(IDirectMusicGetLoader) *GetLoaderVtbl;
 185   DWORD          ref;
 186
 187   /* ILoaderStream fields */
 188   IDirectMusicLoader8Impl* pLoader;
 189   HANDLE hFile;
 190   WCHAR wzFileName[MAX_PATH]; /* for clone */
 191 };
 192
 193 /* Custom: */
 194 extern HRESULT WINAPI ILoaderStream_Attach (LPSTREAM iface, LPCWSTR wzFile, IDirectMusicLoader *pLoader);
 195 extern void    WINAPI ILoaderStream_Detach (LPSTREAM iface);
 196 /* IUnknown: */
 197 extern HRESULT WINAPI ILoaderStream_IUnknown_QueryInterface (LPUNKNOWN iface, REFIID riid, void** ppobj);
 198 extern ULONG   WINAPI ILoaderStream_IUnknown_AddRef (LPUNKNOWN iface);
 199 extern ULONG   WINAPI ILoaderStream_IUnknown_Release (LPUNKNOWN iface);
 200 /* IDirectMusicGetLoader: */
 201 extern HRESULT WINAPI ILoaderStream_IDirectMusicGetLoader_QueryInterface (LPDIRECTMUSICGETLOADER iface, REFIID riid, void** ppobj);
 202 extern ULONG   WINAPI ILoaderStream_IDirectMusicGetLoader_AddRef (LPDIRECTMUSICGETLOADER iface);
 203 extern ULONG   WINAPI ILoaderStream_IDirectMusicGetLoader_Release (LPDIRECTMUSICGETLOADER iface);
 204 extern HRESULT WINAPI ILoaderStream_IDirectMusicGetLoader_GetLoader (LPDIRECTMUSICGETLOADER iface, IDirectMusicLoader **ppLoader);
 205 /* IStream: */
 206 extern HRESULT WINAPI ILoaderStream_IStream_QueryInterface (LPSTREAM iface, REFIID riid, void** ppobj);
 207 extern ULONG   WINAPI ILoaderStream_IStream_AddRef (LPSTREAM iface);
 208 extern ULONG   WINAPI ILoaderStream_IStream_Release (LPSTREAM iface);extern HRESULT WINAPI ILoaderStream_IStream_Read (IStream* iface, void* pv, ULONG cb, ULONG* pcbRead);
 209 extern HRESULT WINAPI ILoaderStream_IStream_Write (LPSTREAM iface, const void* pv, ULONG cb, ULONG* pcbWritten);
 210 extern HRESULT WINAPI ILoaderStream_IStream_Seek (LPSTREAM iface, LARGE_INTEGER dlibMove, DWORD dwOrigin, ULARGE_INTEGER* plibNewPosition);
 211 extern HRESULT WINAPI ILoaderStream_IStream_SetSize (LPSTREAM iface, ULARGE_INTEGER libNewSize);
 212 extern HRESULT WINAPI ILoaderStream_IStream_CopyTo (LPSTREAM iface, IStream* pstm, ULARGE_INTEGER cb, ULARGE_INTEGER* pcbRead, ULARGE_INTEGER* pcbWritten);
 213 extern HRESULT WINAPI ILoaderStream_IStream_Commit (LPSTREAM iface, DWORD grfCommitFlags);
 214 extern HRESULT WINAPI ILoaderStream_IStream_Revert (LPSTREAM iface);
 215 extern HRESULT WINAPI ILoaderStream_IStream_LockRegion (LPSTREAM iface, ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType);
 216 extern HRESULT WINAPI ILoaderStream_IStream_UnlockRegion (LPSTREAM iface, ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType);
 217 extern HRESULT WINAPI ILoaderStream_IStream_Stat (LPSTREAM iface, STATSTG* pstatstg, DWORD grfStatFlag);
 218 extern HRESULT WINAPI ILoaderStream_IStream_Clone (LPSTREAM iface, IStream** ppstm);
 219
 220
 221 /*****************************************************************************
 222  * Misc.
 223  */
 224 /* for simpler reading */
 225 typedef struct _DMUS_PRIVATE_CHUNK {
 226         FOURCC fccID; /* FOURCC ID of the chunk */
 227         DWORD dwSize; /* size of the chunk */
 228 } DMUS_PRIVATE_CHUNK, *LPDMUS_PRIVATE_CHUNK;
 229
 230 /* used for generic dumping (copied from ddraw) */
 231 typedef struct {
 232     DWORD val;
 233     const char* name;
 234 } flag_info;
 235
 236 typedef struct {
 237     const GUID *guid;
 238     const char* name;
 239 } guid_info;
 240
 241 /* used for initialising structs (primarily for DMUS_OBJECTDESC) */
 242 #define DM_STRUCT_INIT(x)                               \
 243         do {                                                            \
 244                 memset((x), 0, sizeof(*(x)));   \
 245                 (x)->dwSize = sizeof(*x);               \
 246         } while (0)
 247
 248 #define FE(x) { x, #x }
 249 #define GE(x) { &x, #x }
 250
 251 /* check whether the given DWORD is even (return 0) or odd (return 1) */
 252 extern int even_or_odd (DWORD number);
 253 /* translate STREAM_SEEK flag to string */
 254 extern const char *resolve_STREAM_SEEK (DWORD flag);
 255 /* FOURCC to string conversion for debug messages */
 256 extern const char *debugstr_fourcc (DWORD fourcc);
 257 /* DMUS_VERSION struct to string conversion for debug messages */
 258 extern const char *debugstr_dmversion (LPDMUS_VERSION version);
 259 /* returns name of given GUID */
 260 extern const char *debugstr_dmguid (const GUID *id);
 261 /* returns name of given error code */
 262 extern const char *debugstr_dmreturn (DWORD code);
 263 /* generic flags-dumping function */
 264 extern const char *debugstr_flags (DWORD flags, const flag_info* names, size_t num_names);
 265 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask);
 266 /* dump whole DMUS_OBJECTDESC struct */
 267 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
 268 /* check whether chunkID is valid dmobject form chunk */
 269 extern BOOL IS_VALID_DMFORM (FOURCC chunkID);
 270
 271 #endif  /* __WINE_DMLOADER_PRIVATE_H */