Release 0.9.6.
[wine/multimedia.git] / include / dmplugin.h
blob15f5cda14be6033353b89af26f50040dbdf52951
1 /*
2 * DirectMusic Performance Layer Plugins API
4 * Copyright (C) 2003-2004 Rok Mandeljc
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Library General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
21 #ifndef __WINE_DMUSIC_PLUGIN_H
22 #define __WINE_DMUSIC_PLUGIN_H
24 #ifndef __WINESRC__
25 #include <windows.h>
26 #endif /* __WINESRC__ */
28 #include <objbase.h>
29 #include <mmsystem.h>
30 #include <dmusici.h>
31 #include <pshpack8.h>
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
37 /*****************************************************************************
38 * Registry path
40 #define DMUS_REGSTR_PATH_TOOLS "Software\\Microsoft\\DirectMusic\\Tools"
43 /*****************************************************************************
44 * Predeclare the interfaces
46 /* CLSIDs */
47 DEFINE_GUID(CLSID_DirectMusicBandTrack, 0xd2ac2894,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
48 DEFINE_GUID(CLSID_DirectMusicChordTrack, 0xd2ac288b,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
49 DEFINE_GUID(CLSID_DirectMusicChordMapTrack, 0xd2ac2896,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
50 DEFINE_GUID(CLSID_DirectMusicCommandTrack, 0xd2ac288c,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
51 DEFINE_GUID(CLSID_DirectMusicLyricsTrack, 0x995c1cf5,0x54ff,0x11d3,0x8b,0xda,0x00,0x60,0x08,0x93,0xb1,0xb6);
52 DEFINE_GUID(CLSID_DirectMusicMarkerTrack, 0x55a8fd00,0x4288,0x11d3,0x9b,0xd1,0x8a,0x0d,0x61,0xc8,0x88,0x35);
53 DEFINE_GUID(CLSID_DirectMusicMotifTrack, 0xd2ac288e,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
54 DEFINE_GUID(CLSID_DirectMusicMuteTrack, 0xd2ac2898,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
55 DEFINE_GUID(CLSID_DirectMusicParamControlTrack, 0x4be0537b,0x5c19,0x11d3,0x8b,0xdc,0x00,0x60,0x08,0x93,0xb1,0xb6);
56 DEFINE_GUID(CLSID_DirectMusicScriptTrack, 0x4108fa85,0x3586,0x11d3,0x8b,0xd7,0x00,0x60,0x08,0x93,0xb1,0xb6);
57 DEFINE_GUID(CLSID_DirectMusicSegmentTriggerTrack, 0xbae4d665,0x4ea1,0x11d3,0x8b,0xda,0x00,0x60,0x08,0x93,0xb1,0xb6);
58 DEFINE_GUID(CLSID_DirectMusicSeqTrack, 0xd2ac2886,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
59 DEFINE_GUID(CLSID_DirectMusicSignPostTrack, 0xf17e8672,0xc3b4,0x11d1,0x87,0x0b,0x00,0x60,0x08,0x93,0xb1,0xbd);
60 DEFINE_GUID(CLSID_DirectMusicStyleTrack, 0xd2ac288d,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
61 DEFINE_GUID(CLSID_DirectMusicSysExTrack, 0xd2ac2887,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
62 DEFINE_GUID(CLSID_DirectMusicTempoTrack, 0xd2ac2885,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
63 DEFINE_GUID(CLSID_DirectMusicTimeSigTrack, 0xd2ac2888,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
64 DEFINE_GUID(CLSID_DirectMusicWaveTrack, 0xeed36461,0x9ea5,0x11d3,0x9b,0xd1,0x00,0x80,0xc7,0x15,0x0a,0x74);
65 /* MS doesn't support this in DX 9.0 and newer... but there's no harm in keeping it around */
66 DEFINE_GUID(CLSID_DirectMusicMelodyFormulationTrack, 0xb0684266,0xb57f,0x11d2,0x97,0xf9,0x00,0xc0,0x4f,0xa3,0x6e,0x58);
68 /* IIDs */
69 DEFINE_GUID(IID_IDirectMusicTool, 0xd2ac28ba,0xb39b,0x11d1,0x87,0x04,0x00,0x60,0x08,0x93,0xb1,0xbd);
70 DEFINE_GUID(IID_IDirectMusicTool8, 0x0e674303,0x3b05,0x11d3,0x9b,0xd1,0xf9,0xe7,0xf0,0xa0,0x15,0x36);
71 DEFINE_GUID(IID_IDirectMusicTrack, 0xf96029a1,0x4282,0x11d2,0x87,0x17,0x00,0x60,0x08,0x93,0xb1,0xbd);
72 DEFINE_GUID(IID_IDirectMusicTrack8, 0x0e674304,0x3b05,0x11d3,0x9b,0xd1,0xf9,0xe7,0xf0,0xa0,0x15,0x36);
74 /* typedef definitions */
75 typedef struct IDirectMusicTrack *LPDIRECTMUSICTRACK;
76 typedef struct IDirectMusicTrack8 *LPDIRECTMUSICTRACK8;
77 typedef struct IDirectMusicTool *LPDIRECTMUSICTOOL;
78 typedef struct IDirectMusicTool8 *LPDIRECTMUSICTOOL8;
79 /* these are from dmusici.h and are needed here */
80 typedef struct IDirectMusicPerformance *LPDIRECTMUSICPERFORMANCE;
81 typedef struct IDirectMusicPerformance8 *LPDIRECTMUSICPERFORMANCE8;
82 typedef struct IDirectMusicSegment *LPDIRECTMUSICSEGMENT;
83 typedef struct IDirectMusicSegment8 *LPDIRECTMUSICSEGMENT8;
84 typedef struct IDirectMusicSegmentState *LPDIRECTMUSICSEGMENTSTATE;
85 typedef struct IDirectMusicSegmentState8 *LPDIRECTMUSICSEGMENTSTATE8;
86 typedef struct IDirectMusicGraph *LPDIRECTMUSICGRAPH;
87 typedef struct IDirectMusicGraph IDirectMusicGraph8, *LPDIRECTMUSICGRAPH8;
90 /*****************************************************************************
91 * Typedef definitions
93 typedef struct _DMUS_PMSG DMUS_PMSG;
94 typedef long MUSIC_TIME;
97 /*****************************************************************************
98 * Flags
100 #define DMUS_TRACK_PARAMF_CLOCK 0x1
102 /*****************************************************************************
103 * Enumerations
105 /* typedef definitions */
106 typedef enum enumDMUS_TRACKF_FLAGS DMUS_TRACKF_FLAGS;
108 /* actual enumerations */
109 enum enumDMUS_TRACKF_FLAGS {
110 DMUS_TRACKF_SEEK = 0x001,
111 DMUS_TRACKF_LOOP = 0x002,
112 DMUS_TRACKF_START = 0x004,
113 DMUS_TRACKF_FLUSH = 0x008,
114 DMUS_TRACKF_DIRTY = 0x010,
115 DMUS_TRACKF_NOTIFY_OFF = 0x020,
116 DMUS_TRACKF_PLAY_OFF = 0x040,
117 DMUS_TRACKF_LOOPEND = 0x080,
118 DMUS_TRACKF_STOP = 0x100,
119 DMUS_TRACKF_RECOMPOSE = 0x200,
120 DMUS_TRACKF_CLOCK = 0x400,
123 /*****************************************************************************
124 * IDirectMusicTool interface
126 #define INTERFACE IDirectMusicTool
127 DECLARE_INTERFACE_(IDirectMusicTool,IUnknown)
129 /*** IUnknown methods ***/
130 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
131 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
132 STDMETHOD_(ULONG,Release)(THIS) PURE;
133 /*** IDirectMusicTool methods ***/
134 STDMETHOD(Init)(THIS_ struct IDirectMusicGraph *pGraph) PURE;
135 STDMETHOD(GetMsgDeliveryType)(THIS_ DWORD *pdwDeliveryType) PURE;
136 STDMETHOD(GetMediaTypeArraySize)(THIS_ DWORD *pdwNumElements) PURE;
137 STDMETHOD(GetMediaTypes)(THIS_ DWORD **padwMediaTypes, DWORD dwNumElements) PURE;
138 STDMETHOD(ProcessPMsg)(THIS_ struct IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG) PURE;
139 STDMETHOD(Flush)(THIS_ struct IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG, REFERENCE_TIME rtTime) PURE;
141 #undef INTERFACE
143 #if !defined(__cplusplus) || defined(CINTERFACE)
144 /*** IUnknown methods ***/
145 #define IDirectMusicTool_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
146 #define IDirectMusicTool_AddRef(p) (p)->lpVtbl->AddRef(p)
147 #define IDirectMusicTool_Release(p) (p)->lpVtbl->Release(p)
148 /*** IDirectMusicTool methods ***/
149 #define IDirectMusicTool_Init(p,a) (p)->lpVtbl->Init(p,a)
150 #define IDirectMusicTool_GetMsgDeliveryType(p,a) (p)->lpVtbl->GetMsgDeliveryType(p,a)
151 #define IDirectMusicTool_GetMediaTypeArraySize(p,a) (p)->lpVtbl->GetMediaTypeArraySize(p,a)
152 #define IDirectMusicTool_GetMediaTypes(p,a,b) (p)->lpVtbl->GetMediaTypes(p,a,b)
153 #define IDirectMusicTool_ProcessPMsg(p,a,b) (p)->lpVtbl->ProcessPMsg(p,a,b)
154 #define IDirectMusicTool_Flush(p,a,b,c) (p)->lpVtbl->Flush(p,a,b,c)
155 #endif
158 /*****************************************************************************
159 * IDirectMusicTool8 interface
161 #define INTERFACE IDirectMusicTool8
162 DECLARE_INTERFACE_(IDirectMusicTool8,IDirectMusicTool)
164 /*** IUnknown methods ***/
165 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
166 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
167 STDMETHOD_(ULONG,Release)(THIS) PURE;
168 /*** IDirectMusicTool methods ***/
169 STDMETHOD(Init)(THIS_ struct IDirectMusicGraph *pGraph) PURE;
170 STDMETHOD(GetMsgDeliveryType)(THIS_ DWORD *pdwDeliveryType) PURE;
171 STDMETHOD(GetMediaTypeArraySize)(THIS_ DWORD *pdwNumElements) PURE;
172 STDMETHOD(GetMediaTypes)(THIS_ DWORD **padwMediaTypes, DWORD dwNumElements) PURE;
173 STDMETHOD(ProcessPMsg)(THIS_ struct IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG) PURE;
174 STDMETHOD(Flush)(THIS_ struct IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG, REFERENCE_TIME rtTime) PURE;
175 /*** IDirectMusicTool8 methods ***/
176 STDMETHOD(Clone)(THIS_ IDirectMusicTool **ppTool) PURE;
178 #undef INTERFACE
180 #if !defined(__cplusplus) || defined(CINTERFACE)
181 /*** IUnknown methods ***/
182 #define IDirectMusicTool8_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
183 #define IDirectMusicTool8_AddRef(p) (p)->lpVtbl->AddRef(p)
184 #define IDirectMusicTool8_Release(p) (p)->lpVtbl->Release(p)
185 /*** IDirectMusicTool methods ***/
186 #define IDirectMusicTool8_Init(p,a) (p)->lpVtbl->Init(p,a)
187 #define IDirectMusicTool8_GetMsgDeliveryType(p,a) (p)->lpVtbl->GetMsgDeliveryType(p,a)
188 #define IDirectMusicTool8_GetMediaTypeArraySize(p,a) (p)->lpVtbl->GetMediaTypeArraySize(p,a)
189 #define IDirectMusicTool8_GetMediaTypes(p,a,b) (p)->lpVtbl->GetMediaTypes(p,a,b)
190 #define IDirectMusicTool8_ProcessPMsg(p,a,b) (p)->lpVtbl->ProcessPMsg(p,a,b)
191 #define IDirectMusicTool8_Flush(p,a,b) (p)->lpVtbl->Flush(p,a,b)
192 /*** IDirectMusicTool8 methods ***/
193 #define IDirectMusicTool8_Clone(p,a) (p)->lpVtbl->Clone(p,a)
194 #endif
197 /*****************************************************************************
198 * IDirectMusicTrack interface
200 #define INTERFACE IDirectMusicTrack
201 DECLARE_INTERFACE_(IDirectMusicTrack,IUnknown)
203 /*** IUnknown methods ***/
204 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
205 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
206 STDMETHOD_(ULONG,Release)(THIS) PURE;
207 /*** IDirectMusicTrack methods ***/
208 STDMETHOD(Init)(THIS_ struct IDirectMusicSegment *pSegment) PURE;
209 STDMETHOD(InitPlay)(THIS_ struct IDirectMusicSegmentState *pSegmentState, struct IDirectMusicPerformance *pPerformance, void **ppStateData, DWORD dwVirtualTrackID, DWORD dwFlags) PURE;
210 STDMETHOD(EndPlay)(THIS_ void *pStateData) PURE;
211 STDMETHOD(Play)(THIS_ void *pStateData, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags, struct IDirectMusicPerformance *pPerf, struct IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE;
212 STDMETHOD(GetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME *pmtNext, void *pParam) PURE;
213 STDMETHOD(SetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, void *pParam) PURE;
214 STDMETHOD(IsParamSupported)(THIS_ REFGUID rguidType) PURE;
215 STDMETHOD(AddNotificationType)(THIS_ REFGUID rguidNotificationType) PURE;
216 STDMETHOD(RemoveNotificationType)(THIS_ REFGUID rguidNotificationType) PURE;
217 STDMETHOD(Clone)(THIS_ MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack **ppTrack) PURE;
219 #undef INTERFACE
221 #if !defined(__cplusplus) || defined(CINTERFACE)
222 /*** IUnknown methods ***/
223 #define IDirectMusicTrack_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
224 #define IDirectMusicTrack_AddRef(p) (p)->lpVtbl->AddRef(p)
225 #define IDirectMusicTrack_Release(p) (p)->lpVtbl->Release(p)
226 /*** IDirectMusicTrack methods ***/
227 #define IDirectMusicTrack_Init(p,a) (p)->lpVtbl->Init(p,a)
228 #define IDirectMusicTrack_InitPlay(p,a,b,c,d,e) (p)->lpVtbl->InitPlay(p,a,b,c,d,e)
229 #define IDirectMusicTrack_EndPlay(p,a) (p)->lpVtbl->EndPlay(p,a)
230 #define IDirectMusicTrack_Play(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->Play(p,a,b,c,d,e,f,g,h)
231 #define IDirectMusicTrack_GetParam(p,a,b,c,d) (p)->lpVtbl->GetParam(p,a,b,c,d)
232 #define IDirectMusicTrack_SetParam(p,a,b,c) (p)->lpVtbl->SetParam(p,a,b,c)
233 #define IDirectMusicTrack_IsParamSupported(p,a) (p)->lpVtbl->IsParamSupported(p,a)
234 #define IDirectMusicTrack_AddNotificationType(p,a) (p)->lpVtbl->AddNotificationType(p,a)
235 #define IDirectMusicTrack_RemoveNotificationType(p,a) (p)->lpVtbl->RemoveNotificationType(p,a)
236 #define IDirectMusicTrack_Clone(p,a,b,c) (p)->lpVtbl->Clone(p,a,b,c)
237 #endif
240 /*****************************************************************************
241 * IDirectMusicTrack8 interface
243 #define INTERFACE IDirectMusicTrack8
244 DECLARE_INTERFACE_(IDirectMusicTrack8,IDirectMusicTrack)
246 /*** IUnknown methods ***/
247 STDMETHOD_(HRESULT,QueryInterface)(THIS_ REFIID riid, void** ppvObject) PURE;
248 STDMETHOD_(ULONG,AddRef)(THIS) PURE;
249 STDMETHOD_(ULONG,Release)(THIS) PURE;
250 /*** IDirectMusicTrack methods ***/
251 STDMETHOD(Init)(THIS_ struct IDirectMusicSegment *pSegment) PURE;
252 STDMETHOD(InitPlay)(THIS_ struct IDirectMusicSegmentState *pSegmentState, struct IDirectMusicPerformance *pPerformance, void **ppStateData, DWORD dwVirtualTrackID, DWORD dwFlags) PURE;
253 STDMETHOD(EndPlay)(THIS_ void *pStateData) PURE;
254 STDMETHOD(Play)(THIS_ void *pStateData, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags, struct IDirectMusicPerformance *pPerf, struct IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE;
255 STDMETHOD(GetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME *pmtNext, void *pParam) PURE;
256 STDMETHOD(SetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, void *pParam) PURE;
257 STDMETHOD(IsParamSupported)(THIS_ REFGUID rguidType) PURE;
258 STDMETHOD(AddNotificationType)(THIS_ REFGUID rguidNotificationType) PURE;
259 STDMETHOD(RemoveNotificationType)(THIS_ REFGUID rguidNotificationType) PURE;
260 STDMETHOD(Clone)(THIS_ MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack **ppTrack) PURE;
261 /*** IDirectMusicTrack8 methods ***/
262 STDMETHOD(PlayEx)(THIS_ void *pStateData, REFERENCE_TIME rtStart, REFERENCE_TIME rtEnd, REFERENCE_TIME rtOffset, DWORD dwFlags, struct IDirectMusicPerformance *pPerf, struct IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE;
263 STDMETHOD(GetParamEx)(THIS_ REFGUID rguidType, REFERENCE_TIME rtTime, REFERENCE_TIME *prtNext, void *pParam, void *pStateData, DWORD dwFlags) PURE;
264 STDMETHOD(SetParamEx)(THIS_ REFGUID rguidType, REFERENCE_TIME rtTime, void *pParam, void *pStateData, DWORD dwFlags) PURE;
265 STDMETHOD(Compose)(THIS_ IUnknown *pContext, DWORD dwTrackGroup, IDirectMusicTrack **ppResultTrack) PURE;
266 STDMETHOD(Join)(THIS_ IDirectMusicTrack *pNewTrack, MUSIC_TIME mtJoin, IUnknown *pContext, DWORD dwTrackGroup, IDirectMusicTrack **ppResultTrack) PURE;
268 #undef INTERFACE
270 #if !defined(__cplusplus) || defined(CINTERFACE)
271 /*** IUnknown methods ***/
272 #define IDirectMusicTrack8_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
273 #define IDirectMusicTrack8_AddRef(p) (p)->lpVtbl->AddRef(p)
274 #define IDirectMusicTrack8_Release(p) (p)->lpVtbl->Release(p)
275 /*** IDirectMusicTrack methods ***/
276 #define IDirectMusicTrack8_Init(p,a) (p)->lpVtbl->Init(p,a)
277 #define IDirectMusicTrack8_InitPlay(p,a,b,c,d,e) (p)->lpVtbl->InitPlay(p,a,b,c,d,e)
278 #define IDirectMusicTrack8_EndPlay(p,a) (p)->lpVtbl->EndPlay(p,a)
279 #define IDirectMusicTrack8_Play(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->Play(p,a,b,c,d,e,f,g,h)
280 #define IDirectMusicTrack8_GetParam(p,a,b,c,d) (p)->lpVtbl->GetParam(p,a,b,c,d)
281 #define IDirectMusicTrack8_SetParam(p,a,b,c) (p)->lpVtbl->SetParam(p,a,b,c)
282 #define IDirectMusicTrack8_IsParamSupported(p,a) (p)->lpVtbl->IsParamSupported(p,a)
283 #define IDirectMusicTrack8_AddNotificationType(p,a) (p)->lpVtbl->AddNotificationType(p,a)
284 #define IDirectMusicTrack8_RemoveNotificationType(p,a) (p)->lpVtbl->RemoveNotificationType(p,a)
285 #define IDirectMusicTrack8_Clone(p,a,b,c) (p)->lpVtbl->Clone(p,a,b,c)
286 /*** IDirectMusicTrack8 methods ***/
287 #define IDirectMusicTrack8_PlayEx(p,a,b,c,d,e,f,g,h) (p)->lpVtbl->PlayEx(p,a,b,c,d,e,f,g,h)
288 #define IDirectMusicTrack8_GetParamEx(p,a,b,c,d,e,f) (p)->lpVtbl->GetParamEx(p,a,b,c,d,e,f)
289 #define IDirectMusicTrack8_SetParamEx(p,a,b,c,d,e) (p)->lpVtbl->SetParamEx(p,a,b,c,d,e)
290 #define IDirectMusicTrack8_Compose(p,a,b,c) (p)->lpVtbl->Compose(p,a,b,c)
291 #define IDirectMusicTrack8_Join(p,a,b,c,d,e) (p)->lpVtbl->Join(p,a,b,c,d,e)
292 #endif
294 #ifdef __cplusplus
296 #endif
298 #include <poppack.h>
300 #endif /* __WINE_DMUSIC_PLUGIN_H */