Don't leak a list of visuals (with advice of Jacek Caban).
[wine] / dlls / dswave / dswave_private.h
1 /* DirectMusic Wave 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_DSWAVE_PRIVATE_H
21 #define __WINE_DSWAVE_PRIVATE_H
22
23 #include <stdarg.h>
24
25 #define COBJMACROS
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 #include "objbase.h"
38
39 #include "dmusici.h"
40 #include "dmusicf.h"
41 #include "dmusics.h"
42
43 /*****************************************************************************
44  * Interfaces
45  */
46 typedef struct IDirectMusicWaveImpl IDirectMusicWaveImpl;
47
48 /*****************************************************************************
49  * ClassFactory
50  */
51 extern HRESULT WINAPI DMUSIC_CreateDirectMusicWaveImpl (LPCGUID lpcGUID, LPVOID* ppobj, LPUNKNOWN pUnkOuter);
52
53
54 /*****************************************************************************
55  * IDirectMusicWaveImpl implementation structure
56  */
57 struct IDirectMusicWaveImpl {
58   /* IUnknown fields */
59   const IUnknownVtbl *UnknownVtbl;
60   const IDirectMusicSegment8Vtbl *SegmentVtbl;
61   const IDirectMusicObjectVtbl *ObjectVtbl;
62   const IPersistStreamVtbl *PersistStreamVtbl;
63   LONG          ref;
64
65   /* IDirectMusicWaveImpl fields */
66   LPDMUS_OBJECTDESC pDesc;
67
68 };
69
70 /* IUnknown: */
71 extern ULONG WINAPI   IDirectMusicWaveImpl_IUnknown_AddRef (LPUNKNOWN iface);
72 /* IDirectMusicSegment(8): */
73 extern ULONG WINAPI   IDirectMusicWaveImpl_IDirectMusicSegment8_AddRef (LPDIRECTMUSICSEGMENT8 iface);
74
75 /* IDirectMusicObject: */
76 extern ULONG WINAPI   IDirectMusicWaveImpl_IDirectMusicObject_AddRef (LPDIRECTMUSICOBJECT iface);
77 /* IPersistStream: */
78 extern ULONG WINAPI   IDirectMusicWaveImpl_IPersistStream_AddRef (LPPERSISTSTREAM iface);
79
80 /**********************************************************************
81  * Dll lifetime tracking declaration for dswave.dll
82  */
83 extern LONG DSWAVE_refCount;
84 static inline void DSWAVE_LockModule(void) { InterlockedIncrement( &DSWAVE_refCount ); }
85 static inline void DSWAVE_UnlockModule(void) { InterlockedDecrement( &DSWAVE_refCount ); }
86
87 /*****************************************************************************
88  * Misc.
89  */
90 /* for simpler reading */
91 typedef struct _DMUS_PRIVATE_CHUNK {
92         FOURCC fccID; /* FOURCC ID of the chunk */
93         DWORD dwSize; /* size of the chunk */
94 } DMUS_PRIVATE_CHUNK, *LPDMUS_PRIVATE_CHUNK;
95
96 /* used for generic dumping (copied from ddraw) */
97 typedef struct {
98     DWORD val;
99     const char* name;
100 } flag_info;
101
102 typedef struct {
103     const GUID *guid;
104     const char* name;
105 } guid_info;
106
107 /* used for initialising structs (primarily for DMUS_OBJECTDESC) */
108 #define DM_STRUCT_INIT(x)                               \
109         do {                                                            \
110                 memset((x), 0, sizeof(*(x)));   \
111                 (x)->dwSize = sizeof(*x);               \
112         } while (0)
113
114 #define FE(x) { x, #x } 
115 #define GE(x) { &x, #x }
116
117 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
118
119 /* check whether the given DWORD is even (return 0) or odd (return 1) */
120 extern int even_or_odd (DWORD number);
121 /* FOURCC to string conversion for debug messages */
122 extern const char *debugstr_fourcc (DWORD fourcc);
123 /* DMUS_VERSION struct to string conversion for debug messages */
124 extern const char *debugstr_dmversion (LPDMUS_VERSION version);
125 /* returns name of given GUID */
126 extern const char *debugstr_dmguid (const GUID *id);
127 /* returns name of given error code */
128 extern const char *debugstr_dmreturn (DWORD code);
129 /* generic flags-dumping function */
130 extern const char *debugstr_flags (DWORD flags, const flag_info* names, size_t num_names);
131 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask);
132 /* dump whole DMUS_OBJECTDESC struct */
133 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc);
134
135 #endif  /* __WINE_DSWAVE_PRIVATE_H */