- more FIXME -> TRACE
[wine.git] / include / dmusics.h
blob457dee29fbfc9eda58b3244106cf2c5787a5dcaf
1 /*
2 * DirectMusic Software Synth Definitions
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_SOFTWARESYNTH_H
22 #define __WINE_DMUSIC_SOFTWARESYNTH_H
24 #include <dmusicc.h>
26 /*****************************************************************************
27 * Registry path
29 #define REGSTR_PATH_SOFTWARESYNTHS "Software\\Microsoft\\DirectMusic\\SoftwareSynths"
32 /*****************************************************************************
33 * Predeclare the interfaces
35 /* IIDs */
36 DEFINE_GUID(IID_IDirectMusicSynth, 0x09823661,0x5c85,0x11d2,0xaf,0xa6,0x00,0xaa,0x00,0x24,0xd8,0xb6);
37 DEFINE_GUID(IID_IDirectMusicSynth8, 0x53cab625,0x2711,0x4c9f,0x9d,0xe7,0x1b,0x7f,0x92,0x5f,0x6f,0xc8);
38 DEFINE_GUID(IID_IDirectMusicSynthSink, 0x09823663,0x5c85,0x11d2,0xaf,0xa6,0x00,0xaa,0x00,0x24,0xd8,0xb6);
40 /* typedef definitions */
41 typedef struct IDirectMusicSynth IDirectMusicSynth, *LPDIRECTMUSICSYNTH;
42 typedef struct IDirectMusicSynth8 IDirectMusicSynth8, *LPDIRECTMUSICSYNTH8;
43 typedef struct IDirectMusicSynthSink IDirectMusicSynthSink, *LPDIRECTMUSICSYNTHSINK;
45 /* GUIDs - property set */
46 DEFINE_GUID(GUID_DMUS_PROP_SetSynthSink, 0x0a3a5ba5,0x37b6,0x11d2,0xb9,0xf9,0x00,0x00,0xf8,0x75,0xac,0x12);
47 DEFINE_GUID(GUID_DMUS_PROP_SinkUsesDSound, 0xbe208857,0x8952,0x11d2,0xba,0x1c,0x00,0x00,0xf8,0x75,0xac,0x12);
50 /*****************************************************************************
51 * Flags
53 #define REFRESH_F_LASTBUFFER 0x1
56 /*****************************************************************************
57 * Structures
59 #ifndef _DMUS_VOICE_STATE_DEFINED
60 #define _DMUS_VOICE_STATE_DEFINED
62 /* typedef definition */
63 typedef struct _DMUS_VOICE_STATE DMUS_VOICE_STATE, *LPDMUS_VOICE_STATE;
65 /* actual structure */
66 struct _DMUS_VOICE_STATE {
67 BOOL bExists;
68 SAMPLE_POSITION spPosition;
69 };
70 #endif /* _DMUS_VOICE_STATE_DEFINED */
73 /*****************************************************************************
74 * IDirectMusicSynth interface
76 #undef INTERFACE
77 #define INTERFACE IDirectMusicSynth
78 #define IDirectMusicSynth_METHODS \
79 IUnknown_METHODS \
80 STDMETHOD(Open)(THIS_ LPDMUS_PORTPARAMS pPortParams) PURE; \
81 STDMETHOD(Close)(THIS) PURE; \
82 STDMETHOD(SetNumChannelGroups)(THIS_ DWORD dwGroups) PURE; \
83 STDMETHOD(Download)(THIS_ LPHANDLE phDownload, LPVOID pvData, LPBOOL pbFree) PURE; \
84 STDMETHOD(Unload)(THIS_ HANDLE hDownload, HRESULT (CALLBACK* lpFreeHandle)(HANDLE,HANDLE), HANDLE hUserData) PURE; \
85 STDMETHOD(PlayBuffer)(THIS_ REFERENCE_TIME rt, LPBYTE pbBuffer, DWORD cbBuffer) PURE; \
86 STDMETHOD(GetRunningStats)(THIS_ LPDMUS_SYNTHSTATS pStats) PURE; \
87 STDMETHOD(GetPortCaps)(THIS_ LPDMUS_PORTCAPS pCaps) PURE; \
88 STDMETHOD(SetMasterClock)(THIS_ IReferenceClock *pClock) PURE; \
89 STDMETHOD(GetLatencyClock)(THIS_ IReferenceClock **ppClock) PURE; \
90 STDMETHOD(Activate)(THIS_ BOOL fEnable) PURE; \
91 STDMETHOD(SetSynthSink)(THIS_ IDirectMusicSynthSink *pSynthSink) PURE; \
92 STDMETHOD(Render)(THIS_ short *pBuffer, DWORD dwLength, LONGLONG llPosition) PURE; \
93 STDMETHOD(SetChannelPriority)(THIS_ DWORD dwChannelGroup, DWORD dwChannel, DWORD dwPriority) PURE; \
94 STDMETHOD(GetChannelPriority)(THIS_ DWORD dwChannelGroup, DWORD dwChannel, LPDWORD pdwPriority) PURE; \
95 STDMETHOD(GetFormat)(THIS_ LPWAVEFORMATEX pWaveFormatEx, LPDWORD pdwWaveFormatExSiz) PURE; \
96 STDMETHOD(GetAppend)(THIS_ DWORD *pdwAppend) PURE;
97 ICOM_DEFINE(IDirectMusicSynth,IUnknown)
98 #undef INTERFACE
100 #ifdef COBJMACROS
101 /*** IUnknown methods ***/
102 #define IDirectMusicSynth_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
103 #define IDirectMusicSynth_AddRef(p) (p)->lpVtbl->AddRef(p)
104 #define IDirectMusicSynth_Release(p) (p)->lpVtbl->Release(p)
105 /*** IDirectMusicSynth methods ***/
106 #define IDirectMusicSynth_Open(p,a) (p)->lpVtbl->Open(p,a)
107 #define IDirectMusicSynth_Close(p) (p)->lpVtbl->Close(p)
108 #define IDirectMusicSynth_SetNumChannelGroups(p,a) (p)->lpVtbl->SetNumChannelGroups(p,a)
109 #define IDirectMusicSynth_Download(p,a,b,c) (p)->lpVtbl->Download(p,a,b,c)
110 #define IDirectMusicSynth_Unload(p,a,b,c) (p)->lpVtbl->Unload(p,a,b,c)
111 #define IDirectMusicSynth_PlayBuffer(p,a,b,c) (p)->lpVtbl->PlayBuffer(p,a,b,c)
112 #define IDirectMusicSynth_GetRunningStats(p,a) (p)->lpVtbl->GetRunningStats(p,a)
113 #define IDirectMusicSynth_GetPortCaps(p,a) (p)->lpVtbl->GetPortCaps(p,a)
114 #define IDirectMusicSynth_SetMasterClock(p,a) (p)->lpVtbl->SetMasterClock(p,a)
115 #define IDirectMusicSynth_GetLatencyClock(p,a) (p)->lpVtbl->GetLatencyClock(p,a)
116 #define IDirectMusicSynth_Activate(p,a) (p)->lpVtbl->Activate(p,a)
117 #define IDirectMusicSynth_SetSynthSink(p,a) (p)->lpVtbl->SetSynthSink(p,a)
118 #define IDirectMusicSynth_Render(p,a,b,c) (p)->lpVtbl->Render(p,a,b,c)
119 #define IDirectMusicSynth_SetChannelPriority(p,a,b,c) (p)->lpVtbl->SetChannelPriority(p,a,b,c)
120 #define IDirectMusicSynth_GetChannelPriority(p,a,b,c) (p)->lpVtbl->GetChannelPriority(p,a,b,c)
121 #define IDirectMusicSynth_GetFormat(p,a,b) (p)->lpVtbl->GetFormat(p,a,b)
122 #define IDirectMusicSynth_GetAppend(p,a) (p)->lpVtbl->GetAppend(p,a)
123 #endif
126 /*****************************************************************************
127 * IDirectMusicSynth8 interface
129 #undef INTERFACE
130 #define INTERFACE IDirectMusicSynth8
131 #define IDirectMusicSynth8_METHODS \
132 IDirectMusicSynth_METHODS \
133 STDMETHOD(PlayVoice)(THIS_ REFERENCE_TIME rt, DWORD dwVoiceId, DWORD dwChannelGroup, DWORD dwChannel, DWORD dwDLId, long prPitch, long vrVolume, SAMPLE_TIME stVoiceStart, SAMPLE_TIME stLoopStart, SAMPLE_TIME stLoopEnd) PURE; \
134 STDMETHOD(StopVoice)(THIS_ REFERENCE_TIME rt, DWORD dwVoiceId) PURE; \
135 STDMETHOD(GetVoiceState)(THIS_ DWORD dwVoice[], DWORD cbVoice, DMUS_VOICE_STATE dwVoiceState[]) PURE; \
136 STDMETHOD(Refresh)(THIS_ DWORD dwDownloadID, DWORD dwFlags) PURE; \
137 STDMETHOD(AssignChannelToBuses)(THIS_ DWORD dwChannelGroup, DWORD dwChannel, LPDWORD pdwBuses, DWORD cBuses) PURE;
138 ICOM_DEFINE(IDirectMusicSynth8,IDirectMusicSynth)
139 #undef INTERFACE
141 #ifdef COBJMACROS
142 /*** IUnknown methods ***/
143 #define IDirectMusicSynth8_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
144 #define IDirectMusicSynth8_AddRef(p) (p)->lpVtbl->AddRef(p)
145 #define IDirectMusicSynth8_Release(p) (p)->lpVtbl->Release(p)
146 /*** IDirectMusicSynth methods ***/
147 #define IDirectMusicSynth8_Open(p,a) (p)->lpVtbl->Open(p,a)
148 #define IDirectMusicSynth8_Close(p) (p)->lpVtbl->Close(p)
149 #define IDirectMusicSynth8_SetNumChannelGroups(p,a) (p)->lpVtbl->SetNumChannelGroups(p,a)
150 #define IDirectMusicSynth8_Download(p,a,b,c) (p)->lpVtbl->Download(p,a,b,c)
151 #define IDirectMusicSynth8_Unload(p,a,b,c) (p)->lpVtbl->Unload(p,a,b,c)
152 #define IDirectMusicSynth8_PlayBuffer(p,a,b,c) (p)->lpVtbl->PlayBuffer(p,a,b,c)
153 #define IDirectMusicSynth8_GetRunningStats(p,a) (p)->lpVtbl->GetRunningStats(p,a)
154 #define IDirectMusicSynth8_GetPortCaps(p,a) (p)->lpVtbl->GetPortCaps(p,a)
155 #define IDirectMusicSynth8_SetMasterClock(p,a) (p)->lpVtbl->SetMasterClock(p,a)
156 #define IDirectMusicSynth8_GetLatencyClock(p,a) (p)->lpVtbl->GetLatencyClock(p,a)
157 #define IDirectMusicSynth8_Activate(p,a) (p)->lpVtbl->Activate(p,a)
158 #define IDirectMusicSynth8_SetSynthSink(p,a) (p)->lpVtbl->SetSynthSink(p,a)
159 #define IDirectMusicSynth8_Render(p,a,b,c) (p)->lpVtbl->Render(p,a,b,c)
160 #define IDirectMusicSynth8_SetChannelPriority(p,a,b,c) (p)->lpVtbl->SetChannelPriority(p,a,b,c)
161 #define IDirectMusicSynth8_GetChannelPriority(p,a,b,c) (p)->lpVtbl->GetChannelPriority(p,a,b,c)
162 #define IDirectMusicSynth8_GetFormat(p,a,b) (p)->lpVtbl->GetFormat(p,a,b)
163 #define IDirectMusicSynth8_GetAppend(p,a) (p)->lpVtbl->GetAppend(p,a)
164 /*** IDirectMusicSynth8 methods ***/
165 #define IDirectMusicSynth8_PlayVoice(p,a,b,c,d,e,f,g,h,i,j) (p)->lpVtbl->PlayVoice(p,a,b,c,d,e,f,g,h,i,j)
166 #define IDirectMusicSynth8_StopVoice(p,a,b) (p)->lpVtbl->StopVoice(p,a,b)
167 #define IDirectMusicSynth8_GetVoiceState(p,a,b,c) (p)->lpVtbl->GetVoiceState(p,a,b,c)
168 #define IDirectMusicSynth8_Refresh(p,a,b) (p)->lpVtbl->Refresh(p,a,b)
169 #define IDirectMusicSynth8_AssignChannelToBuses(p,a,b,c,d) (p)->lpVtbl->AssignChannelToBuses(p,a,b,c,d)
170 #endif
173 /*****************************************************************************
174 * IDirectMusicSynthSink interface
176 #undef INTERFACE
177 #define INTERFACE IDirectMusicSynthSink
178 #define IDirectMusicSynthSink_METHODS \
179 IUnknown_METHODS \
180 STDMETHOD(Init)(THIS_ IDirectMusicSynth *pSynth) PURE; \
181 STDMETHOD(SetMasterClock)(THIS_ IReferenceClock *pClock) PURE; \
182 STDMETHOD(GetLatencyClock)(THIS_ IReferenceClock **ppClock) PURE; \
183 STDMETHOD(Activate)(THIS_ BOOL fEnable) PURE; \
184 STDMETHOD(SampleToRefTime)(THIS_ LONGLONG llSampleTime, REFERENCE_TIME *prfTime) PURE; \
185 STDMETHOD(RefTimeToSample)(THIS_ REFERENCE_TIME rfTime, LONGLONG *pllSampleTime) PURE; \
186 STDMETHOD(SetDirectSound)(THIS_ LPDIRECTSOUND pDirectSound, LPDIRECTSOUNDBUFFER pDirectSoundBuffer) PURE; \
187 STDMETHOD(GetDesiredBufferSize)(THIS_ LPDWORD pdwBufferSizeInSamples) PURE;
188 ICOM_DEFINE(IDirectMusicSynthSink,IUnknown)
189 #undef INTERFACE
191 #ifdef COBJMACROS
192 /*** IUnknown methods ***/
193 #define IDirectMusicSynthSink_QueryInterface(p,a,b) (p)->lpVtbl->QueryInterface(p,a,b)
194 #define IDirectMusicSynthSink_AddRef(p) (p)->lpVtbl->AddRef(p)
195 #define IDirectMusicSynthSink_Release(p) (p)->lpVtbl->Release(p)
196 /*** IDirectMusicSynth methods ***/
197 #define IDirectMusicSynthSink_Init(p,a) (p)->lpVtbl->Init(p,a)
198 #define IDirectMusicSynthSink_SetMasterClock(p,a) (p)->lpVtbl->SetMasterClock(p,a)
199 #define IDirectMusicSynthSink_GetLatencyClock(p,a) (p)->lpVtbl->GetLatencyClock(p,a)
200 #define IDirectMusicSynthSink_Activate(p,a) (p)->lpVtbl->Activate(p,a)
201 #define IDirectMusicSynthSink_SampleToRefTime(p,a,b) (p)->lpVtbl->SampleToRefTime(p,a,b)
202 #define IDirectMusicSynthSink_RefTimeToSample(p,a,b) (p)->lpVtbl->RefTimeToSample(p,a,b)
203 #define IDirectMusicSynthSink_SetDirectSound(p,a,b) (p)->lpVtbl->SetDirectSound(p,a,b)
204 #define IDirectMusicSynthSink_GetDesiredBufferSize(p,a) (p)->lpVtbl->GetDesiredBufferSize(p,a)
205 #endif
207 #endif /* __WINE_DMUSIC_SOFTWARESYNTH_H */