Use INVALID_FILE_ATTRIBUTES to test for failure of
[wine] / dlls / dmloader / dmloader_private.h
1 /* DirectMusicLoader Private Include
2  *
3  * Copyright (C) 2003 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 <stdarg.h>
24
25 #include "windef.h"
26 #include "wine/debug.h"
27 #include "winbase.h"
28 #include "winnt.h"
29 #include "wingdi.h"
30 #include "dmusicc.h"
31 #include "dmusici.h"
32 #include "dmusics.h"
33 #include "dmplugin.h"
34 #include "dmusicf.h"
35 #include "dsound.h"
36 #include "wine/list.h"
37
38
39 /*****************************************************************************
40  * Auxiliary definitions
41  */
42 typedef struct _DMUS_PRIVATE_CACHE_ENTRY {
43         struct list entry; /* for listing elements */
44         GUID guidObject;
45         WCHAR wzFileName[MAX_PATH];
46     IDirectMusicObject* pObject;
47 } DMUS_PRIVATE_CACHE_ENTRY, *LPDMUS_PRIVATE_CACHE_ENTRY;
48
49
50 /*****************************************************************************
51  * Interfaces
52  */
53 typedef struct IDirectMusicLoader8Impl IDirectMusicLoader8Impl;
54 typedef struct IDirectMusicContainerImpl IDirectMusicContainerImpl;
55
56 typedef struct IDirectMusicContainerObject IDirectMusicContainerObject;
57 typedef struct IDirectMusicContainerObjectStream IDirectMusicContainerObjectStream;
58
59 typedef struct ILoaderStream ILoaderStream;
60
61 /*****************************************************************************
62  * Predeclare the interface implementation structures
63  */
64 extern ICOM_VTABLE(IDirectMusicLoader8) DirectMusicLoader8_Vtbl;
65 extern ICOM_VTABLE(IDirectMusicContainer) DirectMusicContainer_Vtbl;
66
67 extern ICOM_VTABLE(IDirectMusicObject) DirectMusicContainerObject_Vtbl;
68 extern ICOM_VTABLE(IPersistStream) DirectMusicContainerObjectStream_Vtbl;
69
70 extern ICOM_VTABLE(IUnknown) LoaderStream_Unknown_Vtbl;
71 extern ICOM_VTABLE(IStream) LoaderStream_Stream_Vtbl;
72 extern ICOM_VTABLE(IDirectMusicGetLoader) LoaderStream_GetLoader_Vtbl;
73
74 /*****************************************************************************
75  * ClassFactory
76  */
77 /* can support IID_IDirectMusicLoader and IID_IDirectMusicLoader8
78  * return always an IDirectMusicLoader8Impl
79  */
80 extern HRESULT WINAPI DMUSIC_CreateDirectMusicLoader (LPCGUID lpcGUID, LPDIRECTMUSICLOADER8 *ppDMLoad, LPUNKNOWN pUnkOuter);
81 /* can support IID_IDirectMusicContainer
82  * return always an IDirectMusicContainerImpl
83  */
84 extern HRESULT WINAPI DMUSIC_CreateDirectMusicContainer (LPCGUID lpcGUID, LPDIRECTMUSICCONTAINER *ppDMCon, LPUNKNOWN pUnkOuter);
85
86 extern HRESULT WINAPI DMUSIC_CreateDirectMusicContainerObject (LPCGUID lpcGUID, LPDIRECTMUSICOBJECT* ppObject, LPUNKNOWN pUnkOuter);
87
88 extern HRESULT WINAPI DMUSIC_CreateLoaderStream (LPSTREAM *ppStream);
89
90 /*****************************************************************************
91  * IDirectMusicLoader8Impl implementation structure
92  */
93 struct IDirectMusicLoader8Impl
94 {
95   /* IUnknown fields */
96   ICOM_VFIELD(IDirectMusicLoader8);
97   DWORD          ref;
98
99   /* IDirectMusicLoaderImpl fields */
100   WCHAR wzSearchPath[MAX_PATH];
101         
102   /* simple cache (linked list) */
103   struct list CacheList;
104 };
105
106 /* IUnknown: */
107 extern HRESULT WINAPI IDirectMusicLoader8Impl_QueryInterface (LPDIRECTMUSICLOADER8 iface, REFIID riid, LPVOID *ppobj);
108 extern ULONG WINAPI   IDirectMusicLoader8Impl_AddRef (LPDIRECTMUSICLOADER8 iface);
109 extern ULONG WINAPI   IDirectMusicLoader8Impl_Release (LPDIRECTMUSICLOADER8 iface);
110 /* IDirectMusicLoader: */
111 extern HRESULT WINAPI IDirectMusicLoader8Impl_GetObject (LPDIRECTMUSICLOADER8 iface, LPDMUS_OBJECTDESC pDesc, REFIID riid, LPVOID*ppv);
112 extern HRESULT WINAPI IDirectMusicLoader8Impl_SetObject (LPDIRECTMUSICLOADER8 iface, LPDMUS_OBJECTDESC pDesc);
113 extern HRESULT WINAPI IDirectMusicLoader8Impl_SetSearchDirectory (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, WCHAR* pwzPath, BOOL fClear);
114 extern HRESULT WINAPI IDirectMusicLoader8Impl_ScanDirectory (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, WCHAR* pwzFileExtension, WCHAR* pwzScanFileName);
115 extern HRESULT WINAPI IDirectMusicLoader8Impl_CacheObject (LPDIRECTMUSICLOADER8 iface, IDirectMusicObject* pObject);
116 extern HRESULT WINAPI IDirectMusicLoader8Impl_ReleaseObject (LPDIRECTMUSICLOADER8 iface, IDirectMusicObject* pObject);
117 extern HRESULT WINAPI IDirectMusicLoader8Impl_ClearCache (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass);
118 extern HRESULT WINAPI IDirectMusicLoader8Impl_EnableCache (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, BOOL fEnable);
119 extern HRESULT WINAPI IDirectMusicLoader8Impl_EnumObject (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClass, DWORD dwIndex, LPDMUS_OBJECTDESC pDesc);
120 /* IDirectMusicLoader8: */
121 extern void    WINAPI IDirectMusicLoader8Impl_CollectGarbage (LPDIRECTMUSICLOADER8 iface);
122 extern HRESULT WINAPI IDirectMusicLoader8Impl_ReleaseObjectByUnknown (LPDIRECTMUSICLOADER8 iface, IUnknown* pObject);
123 extern HRESULT WINAPI IDirectMusicLoader8Impl_LoadObjectFromFile (LPDIRECTMUSICLOADER8 iface, REFGUID rguidClassID, REFIID iidInterfaceID, WCHAR* pwzFilePath, void** ppObject);
124
125 /*****************************************************************************
126  * IDirectMusicContainerImpl implementation structure
127  */
128 struct IDirectMusicContainerImpl
129 {
130   /* IUnknown fields */
131   ICOM_VFIELD(IDirectMusicContainer);
132   DWORD          ref;
133
134   /* IDirectMusicContainerImpl fields */
135   IDirectMusicContainerObject* pObject;
136 };
137
138 /* IUnknown: */
139 extern HRESULT WINAPI IDirectMusicContainerImpl_QueryInterface (LPDIRECTMUSICCONTAINER iface, REFIID riid, LPVOID *ppobj);
140 extern ULONG WINAPI   IDirectMusicContainerImpl_AddRef (LPDIRECTMUSICCONTAINER iface);
141 extern ULONG WINAPI   IDirectMusicContainerImpl_Release (LPDIRECTMUSICCONTAINER iface);
142 /* IDirectMusicContainer: */
143 extern HRESULT WINAPI IDirectMusicContainerImpl_EnumObject (LPDIRECTMUSICCONTAINER iface, REFGUID rguidClass, DWORD dwIndex, LPDMUS_OBJECTDESC pDesc, WCHAR* pwszAlias);
144
145
146 /*****************************************************************************
147  * IDirectMusicContainerObject implementation structure
148  */
149 struct IDirectMusicContainerObject
150 {
151   /* IUnknown fields */
152   ICOM_VFIELD(IDirectMusicObject);
153   DWORD          ref;
154
155   /* IDirectMusicObjectImpl fields */
156   LPDMUS_OBJECTDESC pDesc;
157   IDirectMusicContainerObjectStream* pStream;
158   IDirectMusicContainerImpl* pContainer;
159 };
160
161 /* IUnknown: */
162 extern HRESULT WINAPI IDirectMusicContainerObject_QueryInterface (LPDIRECTMUSICOBJECT iface, REFIID riid, LPVOID *ppobj);
163 extern ULONG WINAPI   IDirectMusicContainerObject_AddRef (LPDIRECTMUSICOBJECT iface);
164 extern ULONG WINAPI   IDirectMusicContainerObject_Release (LPDIRECTMUSICOBJECT iface);
165 /* IDirectMusicObject: */
166 extern HRESULT WINAPI IDirectMusicContainerObject_GetDescriptor (LPDIRECTMUSICOBJECT iface, LPDMUS_OBJECTDESC pDesc);
167 extern HRESULT WINAPI IDirectMusicContainerObject_SetDescriptor (LPDIRECTMUSICOBJECT iface, LPDMUS_OBJECTDESC pDesc);
168 extern HRESULT WINAPI IDirectMusicContainerObject_ParseDescriptor (LPDIRECTMUSICOBJECT iface, LPSTREAM pStream, LPDMUS_OBJECTDESC pDesc);
169
170 /*****************************************************************************
171  * IDirectMusicContainerObjectStream implementation structure
172  */
173 struct IDirectMusicContainerObjectStream
174 {
175   /* IUnknown fields */
176   ICOM_VFIELD (IPersistStream);
177   DWORD          ref;
178
179   /* IPersistStreamImpl fields */
180   IDirectMusicContainerObject* pParentObject;
181 };
182
183 /* IUnknown: */
184 extern HRESULT WINAPI IDirectMusicContainerObjectStream_QueryInterface (LPPERSISTSTREAM iface, REFIID riid, void** ppvObject);
185 extern ULONG WINAPI IDirectMusicContainerObjectStream_AddRef (LPPERSISTSTREAM iface);
186 extern ULONG WINAPI IDirectMusicContainerObjectStream_Release (LPPERSISTSTREAM iface);
187 /* IPersist: */
188 extern HRESULT WINAPI IDirectMusicContainerObjectStream_GetClassID (LPPERSISTSTREAM iface, CLSID* pClassID);
189 /* IPersistStream: */
190 extern HRESULT WINAPI IDirectMusicContainerObjectStream_IsDirty (LPPERSISTSTREAM iface);
191 extern HRESULT WINAPI IDirectMusicContainerObjectStream_Load (LPPERSISTSTREAM iface, IStream* pStm);
192 extern HRESULT WINAPI IDirectMusicContainerObjectStream_Save (LPPERSISTSTREAM iface, IStream* pStm, BOOL fClearDirty);
193 extern HRESULT WINAPI IDirectMusicContainerObjectStream_GetSizeMax (LPPERSISTSTREAM iface, ULARGE_INTEGER* pcbSize);
194
195
196 /*****************************************************************************
197  * ILoaderStream implementation structure
198  */
199 struct ILoaderStream
200 {
201   /* IUnknown fields */
202   ICOM_VTABLE(IStream) *StreamVtbl;
203   ICOM_VTABLE(IDirectMusicGetLoader) *GetLoaderVtbl;
204   DWORD          ref;
205
206   /* ILoaderStream fields */
207   IDirectMusicLoader8Impl* pLoader;
208   HANDLE hFile;
209   WCHAR wzFileName[MAX_PATH]; /* for clone */
210 };
211
212 /* Custom: */
213 extern HRESULT WINAPI ILoaderStream_Attach (ILoaderStream* iface, LPCWSTR wzFile, IDirectMusicLoader *pLoader);
214 extern void WINAPI ILoaderStream_Detach (ILoaderStream* iface);
215 /* IDirectMusicGetLoader: */
216 extern HRESULT WINAPI ILoaderStream_IDirectMusicGetLoader_QueryInterface (LPDIRECTMUSICGETLOADER iface, REFIID riid, void** ppobj);
217 extern ULONG WINAPI ILoaderStream_IDirectMusicGetLoader_AddRef (LPDIRECTMUSICGETLOADER iface);
218 extern ULONG WINAPI ILoaderStream_IDirectMusicGetLoader_Release (LPDIRECTMUSICGETLOADER iface);
219 extern HRESULT WINAPI ILoaderStream_IDirectMusicGetLoader_GetLoader (LPDIRECTMUSICGETLOADER iface, IDirectMusicLoader **ppLoader);
220 /* IStream: */
221 extern HRESULT WINAPI ILoaderStream_IStream_QueryInterface (LPSTREAM iface, REFIID riid, void** ppobj);
222 extern ULONG WINAPI ILoaderStream_IStream_AddRef (LPSTREAM iface);
223 extern ULONG WINAPI ILoaderStream_IStream_Release (LPSTREAM iface);extern HRESULT WINAPI ILoaderStream_IStream_Read (IStream* iface, void* pv, ULONG cb, ULONG* pcbRead);
224 extern HRESULT WINAPI ILoaderStream_IStream_Write (LPSTREAM iface, const void* pv, ULONG cb, ULONG* pcbWritten);
225 extern HRESULT WINAPI ILoaderStream_IStream_Seek (LPSTREAM iface, LARGE_INTEGER dlibMove, DWORD dwOrigin, ULARGE_INTEGER* plibNewPosition);
226 extern HRESULT WINAPI ILoaderStream_IStream_SetSize (LPSTREAM iface, ULARGE_INTEGER libNewSize);
227 extern HRESULT WINAPI ILoaderStream_IStream_CopyTo (LPSTREAM iface, IStream* pstm, ULARGE_INTEGER cb, ULARGE_INTEGER* pcbRead, ULARGE_INTEGER* pcbWritten);
228 extern HRESULT WINAPI ILoaderStream_IStream_Commit (LPSTREAM iface, DWORD grfCommitFlags);
229 extern HRESULT WINAPI ILoaderStream_IStream_Revert (LPSTREAM iface);
230 extern HRESULT WINAPI ILoaderStream_IStream_LockRegion (LPSTREAM iface, ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType);
231 extern HRESULT WINAPI ILoaderStream_IStream_UnlockRegion (LPSTREAM iface, ULARGE_INTEGER libOffset, ULARGE_INTEGER cb, DWORD dwLockType);
232 extern HRESULT WINAPI ILoaderStream_IStream_Stat (LPSTREAM iface, STATSTG* pstatstg, DWORD grfStatFlag);
233 extern HRESULT WINAPI ILoaderStream_IStream_Clone (LPSTREAM iface, IStream** ppstm);
234
235 #endif  /* __WINE_DMLOADER_PRIVATE_H */