1 /* DirectMusicScript Private Include
3 * Copyright (C) 2003-2004 Rok Mandeljc
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.
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.
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.
20 #ifndef __WINE_DMSCRIPT_PRIVATE_H
21 #define __WINE_DMSCRIPT_PRIVATE_H
35 #include "wine/debug.h"
36 #include "wine/list.h"
37 #include "wine/unicode.h"
45 /*****************************************************************************
48 typedef struct IDirectMusicScriptImpl IDirectMusicScriptImpl
;
50 typedef struct IDirectMusicScriptTrack IDirectMusicScriptTrack
;
52 /*****************************************************************************
53 * Predeclare the interface implementation structures
55 extern IUnknownVtbl DirectMusicScript_Unknown_Vtbl
;
56 extern IDirectMusicScriptVtbl DirectMusicScript_Script_Vtbl
;
57 extern IDirectMusicObjectVtbl DirectMusicScript_Object_Vtbl
;
58 extern IPersistStreamVtbl DirectMusicScript_PersistStream_Vtbl
;
60 extern IUnknownVtbl DirectMusicScriptTrack_Unknown_Vtbl
;
61 extern IDirectMusicTrack8Vtbl DirectMusicScriptTrack_Track_Vtbl
;
62 extern IPersistStreamVtbl DirectMusicScriptTrack_PersistStream_Vtbl
;
64 /*****************************************************************************
67 extern HRESULT WINAPI
DMUSIC_CreateDirectMusicScriptImpl (LPCGUID lpcGUID
, LPVOID
* ppobj
, LPUNKNOWN pUnkOuter
);
69 extern HRESULT WINAPI
DMUSIC_CreateDirectMusicScriptTrack (LPCGUID lpcGUID
, LPVOID
* ppobj
, LPUNKNOWN pUnkOuter
);
71 /*****************************************************************************
72 * IDirectMusicScriptImpl implementation structure
74 struct IDirectMusicScriptImpl
{
76 IUnknownVtbl
*UnknownVtbl
;
77 IDirectMusicScriptVtbl
*ScriptVtbl
;
78 IDirectMusicObjectVtbl
*ObjectVtbl
;
79 IPersistStreamVtbl
*PersistStreamVtbl
;
82 /* IDirectMusicScriptImpl fields */
83 IDirectMusicPerformance
* pPerformance
;
84 LPDMUS_OBJECTDESC pDesc
;
85 DMUS_IO_SCRIPT_HEADER
* pHeader
;
86 DMUS_IO_VERSION
* pVersion
;
92 extern HRESULT WINAPI
IDirectMusicScriptImpl_IUnknown_QueryInterface (LPUNKNOWN iface
, REFIID riid
, LPVOID
*ppobj
);
93 extern ULONG WINAPI
IDirectMusicScriptImpl_IUnknown_AddRef (LPUNKNOWN iface
);
94 extern ULONG WINAPI
IDirectMusicScriptImpl_IUnknown_Release (LPUNKNOWN iface
);
95 /* IDirectMusicScript: */
96 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_QueryInterface (LPDIRECTMUSICSCRIPT iface
, REFIID riid
, LPVOID
*ppobj
);
97 extern ULONG WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_AddRef (LPDIRECTMUSICSCRIPT iface
);
98 extern ULONG WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_Release (LPDIRECTMUSICSCRIPT iface
);
99 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_Init (LPDIRECTMUSICSCRIPT iface
, IDirectMusicPerformance
* pPerformance
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
100 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_CallRoutine (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszRoutineName
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
101 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_SetVariableVariant (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszVariableName
, VARIANT varValue
, BOOL fSetRef
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
102 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_GetVariableVariant (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszVariableName
, VARIANT
* pvarValue
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
103 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_SetVariableNumber (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszVariableName
, LONG lValue
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
104 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_GetVariableNumber (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszVariableName
, LONG
* plValue
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
105 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_SetVariableObject (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszVariableName
, IUnknown
* punkValue
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
106 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_GetVariableObject (LPDIRECTMUSICSCRIPT iface
, WCHAR
* pwszVariableName
, REFIID riid
, LPVOID
* ppv
, DMUS_SCRIPT_ERRORINFO
* pErrorInfo
);
107 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_EnumRoutine (LPDIRECTMUSICSCRIPT iface
, DWORD dwIndex
, WCHAR
* pwszName
);
108 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicScript_EnumVariable (LPDIRECTMUSICSCRIPT iface
, DWORD dwIndex
, WCHAR
* pwszName
);
109 /* IDirectMusicObject: */
110 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicObject_QueryInterface (LPDIRECTMUSICOBJECT iface
, REFIID riid
, LPVOID
*ppobj
);
111 extern ULONG WINAPI
IDirectMusicScriptImpl_IDirectMusicObject_AddRef (LPDIRECTMUSICOBJECT iface
);
112 extern ULONG WINAPI
IDirectMusicScriptImpl_IDirectMusicObject_Release (LPDIRECTMUSICOBJECT iface
);
113 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicObject_GetDescriptor (LPDIRECTMUSICOBJECT iface
, LPDMUS_OBJECTDESC pDesc
);
114 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicObject_SetDescriptor (LPDIRECTMUSICOBJECT iface
, LPDMUS_OBJECTDESC pDesc
);
115 extern HRESULT WINAPI
IDirectMusicScriptImpl_IDirectMusicObject_ParseDescriptor (LPDIRECTMUSICOBJECT iface
, LPSTREAM pStream
, LPDMUS_OBJECTDESC pDesc
);
116 /* IPersistStream: */
117 extern HRESULT WINAPI
IDirectMusicScriptImpl_IPersistStream_QueryInterface (LPPERSISTSTREAM iface
, REFIID riid
, void** ppvObject
);
118 extern ULONG WINAPI
IDirectMusicScriptImpl_IPersistStream_AddRef (LPPERSISTSTREAM iface
);
119 extern ULONG WINAPI
IDirectMusicScriptImpl_IPersistStream_Release (LPPERSISTSTREAM iface
);
120 extern HRESULT WINAPI
IDirectMusicScriptImpl_IPersistStream_GetClassID (LPPERSISTSTREAM iface
, CLSID
* pClassID
);
121 extern HRESULT WINAPI
IDirectMusicScriptImpl_IPersistStream_IsDirty (LPPERSISTSTREAM iface
);
122 extern HRESULT WINAPI
IDirectMusicScriptImpl_IPersistStream_Load (LPPERSISTSTREAM iface
, IStream
* pStm
);
123 extern HRESULT WINAPI
IDirectMusicScriptImpl_IPersistStream_Save (LPPERSISTSTREAM iface
, IStream
* pStm
, BOOL fClearDirty
);
124 extern HRESULT WINAPI
IDirectMusicScriptImpl_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface
, ULARGE_INTEGER
* pcbSize
);
126 /*****************************************************************************
127 * IDirectMusicScriptTrack implementation structure
129 struct IDirectMusicScriptTrack
{
130 /* IUnknown fields */
131 IUnknownVtbl
*UnknownVtbl
;
132 IDirectMusicTrack8Vtbl
*TrackVtbl
;
133 IPersistStreamVtbl
*PersistStreamVtbl
;
136 /* IDirectMusicScriptTrack fields */
137 LPDMUS_OBJECTDESC pDesc
;
141 extern HRESULT WINAPI
IDirectMusicScriptTrack_IUnknown_QueryInterface (LPUNKNOWN iface
, REFIID riid
, LPVOID
*ppobj
);
142 extern ULONG WINAPI
IDirectMusicScriptTrack_IUnknown_AddRef (LPUNKNOWN iface
);
143 extern ULONG WINAPI
IDirectMusicScriptTrack_IUnknown_Release (LPUNKNOWN iface
);
144 /* IDirectMusicTrack(8): */
145 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_QueryInterface (LPDIRECTMUSICTRACK8 iface
, REFIID riid
, LPVOID
*ppobj
);
146 extern ULONG WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_AddRef (LPDIRECTMUSICTRACK8 iface
);
147 extern ULONG WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_Release (LPDIRECTMUSICTRACK8 iface
);
148 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_Init (LPDIRECTMUSICTRACK8 iface
, IDirectMusicSegment
* pSegment
);
149 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_InitPlay (LPDIRECTMUSICTRACK8 iface
, IDirectMusicSegmentState
* pSegmentState
, IDirectMusicPerformance
* pPerformance
, void** ppStateData
, DWORD dwVirtualTrackID
, DWORD dwFlags
);
150 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_EndPlay (LPDIRECTMUSICTRACK8 iface
, void* pStateData
);
151 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
);
152 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_GetParam (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidType
, MUSIC_TIME mtTime
, MUSIC_TIME
* pmtNext
, void* pParam
);
153 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_SetParam (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidType
, MUSIC_TIME mtTime
, void* pParam
);
154 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_IsParamSupported (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidType
);
155 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_AddNotificationType (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidNotificationType
);
156 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_RemoveNotificationType (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidNotificationType
);
157 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_Clone (LPDIRECTMUSICTRACK8 iface
, MUSIC_TIME mtStart
, MUSIC_TIME mtEnd
, IDirectMusicTrack
** ppTrack
);
158 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
);
159 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_GetParamEx (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidType
, REFERENCE_TIME rtTime
, REFERENCE_TIME
* prtNext
, void* pParam
, void* pStateData
, DWORD dwFlags
);
160 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_SetParamEx (LPDIRECTMUSICTRACK8 iface
, REFGUID rguidType
, REFERENCE_TIME rtTime
, void* pParam
, void* pStateData
, DWORD dwFlags
);
161 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_Compose (LPDIRECTMUSICTRACK8 iface
, IUnknown
* pContext
, DWORD dwTrackGroup
, IDirectMusicTrack
** ppResultTrack
);
162 extern HRESULT WINAPI
IDirectMusicScriptTrack_IDirectMusicTrack_Join (LPDIRECTMUSICTRACK8 iface
, IDirectMusicTrack
* pNewTrack
, MUSIC_TIME mtJoin
, IUnknown
* pContext
, DWORD dwTrackGroup
, IDirectMusicTrack
** ppResultTrack
);
163 /* IPersistStream: */
164 extern HRESULT WINAPI
IDirectMusicScriptTrack_IPersistStream_QueryInterface (LPPERSISTSTREAM iface
, REFIID riid
, void** ppvObject
);
165 extern ULONG WINAPI
IDirectMusicScriptTrack_IPersistStream_AddRef (LPPERSISTSTREAM iface
);
166 extern ULONG WINAPI
IDirectMusicScriptTrack_IPersistStream_Release (LPPERSISTSTREAM iface
);
167 extern HRESULT WINAPI
IDirectMusicScriptTrack_IPersistStream_GetClassID (LPPERSISTSTREAM iface
, CLSID
* pClassID
);
168 extern HRESULT WINAPI
IDirectMusicScriptTrack_IPersistStream_IsDirty (LPPERSISTSTREAM iface
);
169 extern HRESULT WINAPI
IDirectMusicScriptTrack_IPersistStream_Load (LPPERSISTSTREAM iface
, IStream
* pStm
);
170 extern HRESULT WINAPI
IDirectMusicScriptTrack_IPersistStream_Save (LPPERSISTSTREAM iface
, IStream
* pStm
, BOOL fClearDirty
);
171 extern HRESULT WINAPI
IDirectMusicScriptTrack_IPersistStream_GetSizeMax (LPPERSISTSTREAM iface
, ULARGE_INTEGER
* pcbSize
);
173 /**********************************************************************
174 * Dll lifetime tracking declaration for dmscript.dll
176 extern LONG DMSCRIPT_refCount
;
177 static inline void DMSCRIPT_LockModule() { InterlockedIncrement( &DMSCRIPT_refCount
); }
178 static inline void DMSCRIPT_UnlockModule() { InterlockedDecrement( &DMSCRIPT_refCount
); }
180 /*****************************************************************************
183 /* for simpler reading */
184 typedef struct _DMUS_PRIVATE_CHUNK
{
185 FOURCC fccID
; /* FOURCC ID of the chunk */
186 DWORD dwSize
; /* size of the chunk */
187 } DMUS_PRIVATE_CHUNK
, *LPDMUS_PRIVATE_CHUNK
;
189 /* used for generic dumping (copied from ddraw) */
200 /* used for initialising structs (primarily for DMUS_OBJECTDESC) */
201 #define DM_STRUCT_INIT(x) \
203 memset((x), 0, sizeof(*(x))); \
204 (x)->dwSize = sizeof(*x); \
207 #define FE(x) { x, #x }
208 #define GE(x) { &x, #x }
210 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
212 /* check whether the given DWORD is even (return 0) or odd (return 1) */
213 extern int even_or_odd (DWORD number
);
214 /* FOURCC to string conversion for debug messages */
215 extern const char *debugstr_fourcc (DWORD fourcc
);
216 /* DMUS_VERSION struct to string conversion for debug messages */
217 extern const char *debugstr_dmversion (LPDMUS_VERSION version
);
218 /* returns name of given GUID */
219 extern const char *debugstr_dmguid (const GUID
*id
);
220 /* returns name of given error code */
221 extern const char *debugstr_dmreturn (DWORD code
);
222 /* generic flags-dumping function */
223 extern const char *debugstr_flags (DWORD flags
, const flag_info
* names
, size_t num_names
);
224 extern const char *debugstr_DMUS_OBJ_FLAGS (DWORD flagmask
);
225 /* dump whole DMUS_OBJECTDESC struct */
226 extern const char *debugstr_DMUS_OBJECTDESC (LPDMUS_OBJECTDESC pDesc
);
228 #endif /* __WINE_DMSCRIPT_PRIVATE_H */