msvcrt: Add a helper function to flush all buffers.
[wine] / 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
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (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 GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License 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 #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 #define COBJMACROS
28
29 #include "windef.h"
30 #include "winbase.h"
31 #include "winnt.h"
32 #include "wingdi.h"
33 #include "winuser.h"
34
35 #include "wine/debug.h"
36 #include "wine/list.h"
37 #include "wine/unicode.h"
38 #include "winreg.h"
39 #include "objbase.h"
40
41 #include "dmusici.h"
42 #include "dmusicf.h"
43 #include "dmusics.h"
44
45 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
46
47 /* dmloader.dll global (for DllCanUnloadNow) */
48 extern LONG module_ref DECLSPEC_HIDDEN;
49 static inline void lock_module(void) { InterlockedIncrement( &module_ref ); }
50 static inline void unlock_module(void) { InterlockedDecrement( &module_ref ); }
51
52 /*****************************************************************************
53  * Interfaces
54  */
55 typedef struct IDirectMusicLoaderCF             IDirectMusicLoaderCF;
56 typedef struct IDirectMusicContainerCF          IDirectMusicContainerCF;
57
58 typedef struct IDirectMusicLoaderImpl           IDirectMusicLoaderImpl;
59 typedef struct IDirectMusicContainerImpl        IDirectMusicContainerImpl;
60
61 typedef struct IDirectMusicLoaderFileStream     IDirectMusicLoaderFileStream;
62 typedef struct IDirectMusicLoaderResourceStream IDirectMusicLoaderResourceStream;
63 typedef struct IDirectMusicLoaderGenericStream  IDirectMusicLoaderGenericStream;
64
65 /*****************************************************************************
66  * Creation helpers
67  */
68 extern HRESULT WINAPI DMUSIC_CreateDirectMusicLoaderImpl (LPCGUID lpcGUID, LPVOID *ppobj, LPUNKNOWN pUnkOuter) DECLSPEC_HIDDEN;
69 extern HRESULT WINAPI DMUSIC_CreateDirectMusicContainerImpl (LPCGUID lpcGUID, LPVOID *ppobj, LPUNKNOWN pUnkOuter) DECLSPEC_HIDDEN;
70 extern HRESULT WINAPI DMUSIC_CreateDirectMusicLoaderFileStream (LPVOID *ppobj) DECLSPEC_HIDDEN;
71 extern HRESULT WINAPI DMUSIC_CreateDirectMusicLoaderResourceStream (LPVOID *ppobj) DECLSPEC_HIDDEN;
72 extern HRESULT WINAPI DMUSIC_CreateDirectMusicLoaderGenericStream (LPVOID *ppobj) DECLSPEC_HIDDEN;
73
74 /* cache/alias entry */
75 typedef struct _WINE_LOADER_ENTRY {
76         struct list entry; /* for listing elements */
77         DMUS_OBJECTDESC Desc;
78     LPDIRECTMUSICOBJECT pObject; /* pointer to object */
79         BOOL bInvalidDefaultDLS; /* my workaround for enabling caching of "faulty" default dls collection */
80 } WINE_LOADER_ENTRY, *LPWINE_LOADER_ENTRY;
81
82 /* cache options, search paths for specific types of objects */
83 typedef struct _WINE_LOADER_OPTION {
84         struct list entry; /* for listing elements */
85         GUID guidClass; /* ID of object type */
86         WCHAR wszSearchPath[MAX_PATH]; /* look for objects of certain type in here */
87         BOOL bCache; /* cache objects of certain type */
88 } WINE_LOADER_OPTION, *LPWINE_LOADER_OPTION;
89
90 /*****************************************************************************
91  * IDirectMusicLoaderImpl implementation structure
92  */
93 struct IDirectMusicLoaderImpl {
94         /* VTABLEs */
95         const IDirectMusicLoader8Vtbl *LoaderVtbl;
96         /* reference counter */
97         LONG dwRef;     
98         /* simple cache (linked list) */
99         struct list *pObjects;
100         /* settings for certain object classes */
101         struct list *pClassSettings;
102 };
103
104 /* contained object entry */
105 typedef struct _WINE_CONTAINER_ENTRY {
106         struct list entry; /* for listing elements */
107         DMUS_OBJECTDESC Desc;
108         BOOL bIsRIFF;
109         DWORD dwFlags; /* DMUS_CONTAINED_OBJF_KEEP: keep object in loader's cache, even when container is released */
110         WCHAR* wszAlias;
111         LPDIRECTMUSICOBJECT pObject; /* needed when releasing from loader's cache on container release */
112 } WINE_CONTAINER_ENTRY, *LPWINE_CONTAINER_ENTRY;
113
114 /*****************************************************************************
115  * IDirectMusicContainerImpl implementation structure
116  */
117 struct IDirectMusicContainerImpl {
118         /* VTABLEs */
119         const IDirectMusicContainerVtbl *ContainerVtbl;
120         const IDirectMusicObjectVtbl *ObjectVtbl;
121         const IPersistStreamVtbl *PersistStreamVtbl;
122         /* reference counter */
123         LONG dwRef;
124         /* stream */
125         LPSTREAM pStream;
126         /* header */
127         DMUS_IO_CONTAINER_HEADER Header;
128         /* data */
129         struct list *pContainedObjects; 
130         /* descriptor */
131         DMUS_OBJECTDESC Desc;
132 };
133
134 /*****************************************************************************
135  * IDirectMusicLoaderFileStream implementation structure
136  */
137 struct IDirectMusicLoaderFileStream {
138         /* VTABLEs */
139         const IStreamVtbl *StreamVtbl;
140         const IDirectMusicGetLoaderVtbl *GetLoaderVtbl;
141         /* reference counter */
142         LONG dwRef;
143         /* file */
144         WCHAR wzFileName[MAX_PATH]; /* for clone */
145         HANDLE hFile;
146         /* loader */
147         LPDIRECTMUSICLOADER8 pLoader;
148 };
149
150 /* Custom: */
151 extern HRESULT WINAPI IDirectMusicLoaderFileStream_Attach (LPSTREAM iface, LPCWSTR wzFile, LPDIRECTMUSICLOADER8 pLoader) DECLSPEC_HIDDEN;
152
153 /*****************************************************************************
154  * IDirectMusicLoaderResourceStream implementation structure
155  */
156 struct IDirectMusicLoaderResourceStream {
157         /* IUnknown fields */
158         const IStreamVtbl *StreamVtbl;
159         const IDirectMusicGetLoaderVtbl *GetLoaderVtbl;
160         /* reference counter */
161         LONG dwRef;
162         /* data */
163         LPBYTE pbMemData;
164         LONGLONG llMemLength;
165         /* current position */
166         LONGLONG llPos; 
167         /* loader */
168         LPDIRECTMUSICLOADER8 pLoader;
169 };
170
171 /* Custom: */
172 extern HRESULT WINAPI IDirectMusicLoaderResourceStream_Attach (LPSTREAM iface, LPBYTE pbMemData, LONGLONG llMemLength, LONGLONG llPos, LPDIRECTMUSICLOADER8 pLoader) DECLSPEC_HIDDEN;
173
174 /*****************************************************************************
175  * IDirectMusicLoaderGenericStream implementation structure
176  */
177 struct IDirectMusicLoaderGenericStream {
178         /* IUnknown fields */
179         const IStreamVtbl *StreamVtbl;
180         const IDirectMusicGetLoaderVtbl *GetLoaderVtbl;
181         /* reference counter */
182         LONG dwRef;
183         /* stream */
184         LPSTREAM pStream;
185         /* loader */
186         LPDIRECTMUSICLOADER8 pLoader;
187 };
188
189 /* Custom: */
190 extern HRESULT WINAPI IDirectMusicLoaderGenericStream_Attach (LPSTREAM iface, LPSTREAM pStream, LPDIRECTMUSICLOADER8 pLoader) DECLSPEC_HIDDEN;
191
192 /*****************************************************************************
193  * Misc.
194  */
195 /* for simpler reading */
196 typedef struct _WINE_CHUNK {
197         FOURCC fccID; /* FOURCC ID of the chunk */
198         DWORD dwSize; /* size of the chunk */
199 } WINE_CHUNK, *LPWINE_CHUNK;
200
201 #include "debug.h"
202
203 #endif  /* __WINE_DMLOADER_PRIVATE_H */