include/dmplugin.h

   1 /*
   2  *  DirectMusic Performance Layer Plugins API
   3  *
   4  *  Copyright (C) 2003-2004 Rok Mandeljc
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  */
  20
  21 #ifndef __WINE_DMUSIC_PLUGIN_H
  22 #define __WINE_DMUSIC_PLUGIN_H
  23
  24 #ifndef __WINESRC__
  25 #include <windows.h>
  26 #endif /* __WINESRC__ */
  27
  28 #include <objbase.h>
  29 #include <mmsystem.h>
  30 #include <dmusici.h>
  31 #include <pshpack8.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /*****************************************************************************
  38  * Registry path
  39  */
  40 #define DMUS_REGSTR_PATH_TOOLS "Software\\Microsoft\\DirectMusic\\Tools"
  41
  42
  43 /*****************************************************************************
  44  * Predeclare the interfaces
  45  */
  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);
  67
  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);
  73
  74 /* typedef definitions */
  75 typedef struct IDirectMusicTrack         IDirectMusicTrack,         *LPDIRECTMUSICTRACK;
  76 typedef struct IDirectMusicTrack         IDirectMusicTrack8,        *LPDIRECTMUSICTRACK8;
  77 typedef struct IDirectMusicTool          IDirectMusicTool,          *LPDIRECTMUSICTOOL;
  78 typedef struct IDirectMusicTool8         IDirectMusicTool8,         *LPDIRECTMUSICTOOL8;
  79 /* these are from dmusici.h and are needed here */
  80 typedef struct IDirectMusicPerformance   IDirectMusicPerformance,   *LPDIRECTMUSICPERFORMANCE;
  81 typedef struct IDirectMusicPerformance8  IDirectMusicPerformance8,  *LPDIRECTMUSICPERFORMANCE8;
  82 typedef struct IDirectMusicSegment       IDirectMusicSegment,       *LPDIRECTMUSICSEGMENT;
  83 typedef struct IDirectMusicSegment       IDirectMusicSegment8,      *LPDIRECTMUSICSEGMENT8;
  84 typedef struct IDirectMusicSegmentState  IDirectMusicSegmentState,  *LPDIRECTMUSICSEGMENTSTATE;
  85 typedef struct IDirectMusicSegmentState8 IDirectMusicSegmentState8, *LPDIRECTMUSICSEGMENTSTATE8;
  86 typedef struct IDirectMusicGraph         IDirectMusicGraph,         *LPDIRECTMUSICGRAPH;
  87 typedef struct IDirectMusicGraph         IDirectMusicGraph8,        *LPDIRECTMUSICGRAPH8;
  88
  89
  90 /*****************************************************************************
  91  * Typedef definitions
  92  */
  93 typedef struct _DMUS_PMSG DMUS_PMSG;
  94 typedef long MUSIC_TIME;
  95
  96
  97 /*****************************************************************************
  98  * Flags
  99  */
 100 #define DMUS_TRACK_PARAMF_CLOCK 0x1
 101
 102 /*****************************************************************************
 103  * Enumerations
 104  */
 105 /* typedef definitions */
 106 typedef enum enumDMUS_TRACKF_FLAGS DMUS_TRACKF_FLAGS;
 107
 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,
 121 };
 122
 123 /*****************************************************************************
 124  * IDirectMusicTool interface
 125  */
 126 #undef  INTERFACE
 127 #define INTERFACE IDirectMusicTool
 128 #define IDirectMusicTool_METHODS \
 129     IUnknown_METHODS \
 130     STDMETHOD(Init)(THIS_ IDirectMusicGraph *pGraph) PURE; \
 131     STDMETHOD(GetMsgDeliveryType)(THIS_ DWORD *pdwDeliveryType) PURE; \
 132     STDMETHOD(GetMediaTypeArraySize)(THIS_ DWORD *pdwNumElements) PURE; \
 133     STDMETHOD(GetMediaTypes)(THIS_ DWORD **padwMediaTypes, DWORD dwNumElements) PURE; \
 134     STDMETHOD(ProcessPMsg)(THIS_ IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG) PURE; \
 135     STDMETHOD(Flush)(THIS_ IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG, REFERENCE_TIME rtTime) PURE;
 136 DECLARE_INTERFACE_(IDirectMusicTool,IUnknown) { IDirectMusicTool_METHODS };
 137 #undef INTERFACE
 138
 139 #ifdef COBJMACROS
 140 /*** IUnknown methods ***/
 141 #define IDirectMusicTool_QueryInterface(p,a,b)      (p)->lpVtbl->QueryInterface(p,a,b)
 142 #define IDirectMusicTool_AddRef(p)                  (p)->lpVtbl->AddRef(p)
 143 #define IDirectMusicTool_Release(p)                 (p)->lpVtbl->Release(p)
 144 /*** IDirectMusicTool methods ***/
 145 #define IDirectMusicTool_Init(p,a)                  (p)->lpVtbl->Init(p,a)
 146 #define IDirectMusicTool_GetMsgDeliveryType(p,a)    (p)->lpVtbl->GetMsgDeliveryType(p,a)
 147 #define IDirectMusicTool_GetMediaTypeArraySize(p,a) (p)->lpVtbl->GetMediaTypeArraySize(p,a)
 148 #define IDirectMusicTool_GetMediaTypes(p,a,b)       (p)->lpVtbl->GetMediaTypes(p,a,b)
 149 #define IDirectMusicTool_ProcessPMsg(p,a,b)         (p)->lpVtbl->ProcessPMsg(p,a,b)
 150 #define IDirectMusicTool_Flush(p,a,b,c)             (p)->lpVtbl->Flush(p,a,b,c)
 151 #endif
 152
 153
 154 /*****************************************************************************
 155  * IDirectMusicTool8 interface
 156  */
 157 #undef  INTERFACE
 158 #define INTERFACE IDirectMusicTool8
 159 #define IDirectMusicTool8_METHODS \
 160     IDirectMusicTool_METHODS \
 161     STDMETHOD(Clone)(THIS_ IDirectMusicTool **ppTool) PURE;
 162 DECLARE_INTERFACE_(IDirectMusicTool8,IDirectMusicTool) { IDirectMusicTool8_METHODS };
 163 #undef INTERFACE
 164
 165 #ifdef COBJMACROS
 166 /*** IUnknown methods ***/
 167 #define IDirectMusicTool8_QueryInterface(p,a,b)      (p)->lpVtbl->QueryInterface(p,a,b)
 168 #define IDirectMusicTool8_AddRef(p)                  (p)->lpVtbl->AddRef(p)
 169 #define IDirectMusicTool8_Release(p)                 (p)->lpVtbl->Release(p)
 170 /*** IDirectMusicTool methods ***/
 171 #define IDirectMusicTool8_Init(p,a)                  (p)->lpVtbl->Init(p,a)
 172 #define IDirectMusicTool8_GetMsgDeliveryType(p,a)    (p)->lpVtbl->GetMsgDeliveryType(p,a)
 173 #define IDirectMusicTool8_GetMediaTypeArraySize(p,a) (p)->lpVtbl->GetMediaTypeArraySize(p,a)
 174 #define IDirectMusicTool8_GetMediaTypes(p,a,b)       (p)->lpVtbl->GetMediaTypes(p,a,b)
 175 #define IDirectMusicTool8_ProcessPMsg(p,a,b)         (p)->lpVtbl->ProcessPMsg(p,a,b)
 176 #define IDirectMusicTool8_Flush(p,a,b)               (p)->lpVtbl->Flush(p,a,b)
 177 /*** IDirectMusicTool8 methods ***/
 178 #define IDirectMusicTool8_Clone(p,a)                 (p)->lpVtbl->Clone(p,a)
 179 #endif
 180
 181
 182 /*****************************************************************************
 183  * IDirectMusicTrack interface
 184  */
 185 #undef  INTERFACE
 186 #define INTERFACE IDirectMusicTrack
 187 #define IDirectMusicTrack_METHODS \
 188     IUnknown_METHODS \
 189     STDMETHOD(Init)(THIS_ IDirectMusicSegment *pSegment) PURE; \
 190     STDMETHOD(InitPlay)(THIS_ IDirectMusicSegmentState *pSegmentState, IDirectMusicPerformance *pPerformance, void **ppStateData, DWORD dwVirtualTrackID, DWORD dwFlags) PURE; \
 191     STDMETHOD(EndPlay)(THIS_ void *pStateData) PURE; \
 192     STDMETHOD(Play)(THIS_ void *pStateData, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags, IDirectMusicPerformance *pPerf, IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE; \
 193     STDMETHOD(GetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME *pmtNext, void *pParam) PURE; \
 194     STDMETHOD(SetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, void *pParam) PURE; \
 195     STDMETHOD(IsParamSupported)(THIS_ REFGUID rguidType) PURE; \
 196     STDMETHOD(AddNotificationType)(THIS_ REFGUID rguidNotificationType) PURE; \
 197     STDMETHOD(RemoveNotificationType)(THIS_ REFGUID rguidNotificationType) PURE; \
 198     STDMETHOD(Clone)(THIS_ MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack **ppTrack) PURE;
 199 DECLARE_INTERFACE_(IDirectMusicTrack,IUnknown) { IDirectMusicTrack_METHODS };
 200 #undef INTERFACE
 201
 202 #ifdef COBJMACROS
 203 /*** IUnknown methods ***/
 204 #define IDirectMusicTrack_QueryInterface(p,a,b)       (p)->lpVtbl->QueryInterface(p,a,b)
 205 #define IDirectMusicTrack_AddRef(p)                   (p)->lpVtbl->AddRef(p)
 206 #define IDirectMusicTrack_Release(p)                  (p)->lpVtbl->Release(p)
 207 /*** IDirectMusicTrack methods ***/
 208 #define IDirectMusicTrack_Init(p,a)                   (p)->lpVtbl->Init(p,a)
 209 #define IDirectMusicTrack_InitPlay(p,a,b,c,d,e)       (p)->lpVtbl->InitPlay(p,a,b,c,d,e)
 210 #define IDirectMusicTrack_EndPlay(p,a)                (p)->lpVtbl->EndPlay(p,a)
 211 #define IDirectMusicTrack_Play(p,a,b,c,d,e,f,g,h)     (p)->lpVtbl->Play(p,a,b,c,d,e,f,g,h)
 212 #define IDirectMusicTrack_GetParam(p,a,b,c,d)         (p)->lpVtbl->GetParam(p,a,b,c,d)
 213 #define IDirectMusicTrack_SetParam(p,a,b,c)           (p)->lpVtbl->SetParam(p,a,b,c)
 214 #define IDirectMusicTrack_IsParamSupported(p,a)       (p)->lpVtbl->IsParamSupported(p,a)
 215 #define IDirectMusicTrack_AddNotificationType(p,a)    (p)->lpVtbl->AddNotificationType(p,a)
 216 #define IDirectMusicTrack_RemoveNotificationType(p,a) (p)->lpVtbl->RemoveNotificationType(p,a)
 217 #define IDirectMusicTrack_Clone(p,a,b,c)              (p)->lpVtbl->Clone(p,a,b,c)
 218 #endif
 219
 220
 221 /*****************************************************************************
 222  * IDirectMusicTrack8 interface
 223  */
 224 #undef  INTERFACE
 225 #define INTERFACE IDirectMusicTrack8
 226 #define IDirectMusicTrack8_METHODS \
 227     IDirectMusicTrack_METHODS \
 228     STDMETHOD(PlayEx)(THIS_ void *pStateData, REFERENCE_TIME rtStart, REFERENCE_TIME rtEnd, REFERENCE_TIME rtOffset, DWORD dwFlags, IDirectMusicPerformance *pPerf, IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE; \
 229     STDMETHOD(GetParamEx)(THIS_ REFGUID rguidType, REFERENCE_TIME rtTime, REFERENCE_TIME *prtNext, void *pParam, void *pStateData, DWORD dwFlags) PURE; \
 230     STDMETHOD(SetParamEx)(THIS_ REFGUID rguidType, REFERENCE_TIME rtTime, void *pParam, void *pStateData, DWORD dwFlags) PURE; \
 231     STDMETHOD(Compose)(THIS_ IUnknown *pContext, DWORD dwTrackGroup, IDirectMusicTrack **ppResultTrack) PURE; \
 232     STDMETHOD(Join)(THIS_ IDirectMusicTrack *pNewTrack, MUSIC_TIME mtJoin, IUnknown *pContext, DWORD dwTrackGroup, IDirectMusicTrack **ppResultTrack) PURE;
 233 DECLARE_INTERFACE_(IDirectMusicTrack8,IDirectMusicTrack) { IDirectMusicTrack8_METHODS };
 234 #undef INTERFACE
 235
 236 #ifdef COBJMACROS
 237 /*** IUnknown methods ***/
 238 #define IDirectMusicTrack8_QueryInterface(p,a,b)       (p)->lpVtbl->QueryInterface(p,a,b)
 239 #define IDirectMusicTrack8_AddRef(p)                   (p)->lpVtbl->AddRef(p)
 240 #define IDirectMusicTrack8_Release(p)                  (p)->lpVtbl->Release(p)
 241 /*** IDirectMusicTrack methods ***/
 242 #define IDirectMusicTrack8_Init(p,a)                   (p)->lpVtbl->Init(p,a)
 243 #define IDirectMusicTrack8_InitPlay(p,a,b,c,d,e)       (p)->lpVtbl->InitPlay(p,a,b,c,d,e)
 244 #define IDirectMusicTrack8_EndPlay(p,a)                (p)->lpVtbl->EndPlay(p,a)
 245 #define IDirectMusicTrack8_Play(p,a,b,c,d,e,f,g,h)     (p)->lpVtbl->Play(p,a,b,c,d,e,f,g,h)
 246 #define IDirectMusicTrack8_GetParam(p,a,b,c,d)         (p)->lpVtbl->GetParam(p,a,b,c,d)
 247 #define IDirectMusicTrack8_SetParam(p,a,b,c)           (p)->lpVtbl->SetParam(p,a,b,c)
 248 #define IDirectMusicTrack8_IsParamSupported(p,a)       (p)->lpVtbl->IsParamSupported(p,a)
 249 #define IDirectMusicTrack8_AddNotificationType(p,a)    (p)->lpVtbl->AddNotificationType(p,a)
 250 #define IDirectMusicTrack8_RemoveNotificationType(p,a) (p)->lpVtbl->RemoveNotificationType(p,a)
 251 #define IDirectMusicTrack8_Clone(p,a,b,c)              (p)->lpVtbl->Clone(p,a,b,c)
 252 /*** IDirectMusicTrack8 methods ***/
 253 #define IDirectMusicTrack8_PlayEx(p,a,b,c,d,e,f,g,h)   (p)->lpVtbl->PlayEx(p,a,b,c,d,e,f,g,h)
 254 #define IDirectMusicTrack8_GetParamEx(p,a,b,c,d,e,f)   (p)->lpVtbl->GetParamEx(p,a,b,c,d,e,f)
 255 #define IDirectMusicTrack8_SetParamEx(p,a,b,c,d,e)     (p)->lpVtbl->SetParamEx(p,a,b,c,d,e)
 256 #define IDirectMusicTrack8_Compose(p,a,b,c)            (p)->lpVtbl->Compose(p,a,b,c)
 257 #define IDirectMusicTrack8_Join(p,a,b,c,d,e)           (p)->lpVtbl->Join(p,a,b,c,d,e)
 258 #endif
 259
 260 #ifdef __cplusplus
 261 }
 262 #endif
 263
 264 #include <poppack.h>
 265
 266 #endif /* __WINE_DMUSIC_PLUGIN_H */