include/dmplugin.h

   1 /*
   2  *  DirectMusic Performance Layer Plugins API
   3  *
   4  *  Copyright (C) 2003 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 #include <objbase.h>
  25 #include <mmsystem.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 #define DMUS_REGSTR_PATH_TOOLS  "Software\\Microsoft\\DirectMusic\\Tools"
  32
  33 /*****************************************************************************
  34  * Predeclare the interfaces
  35  */
  36 DEFINE_GUID(IID_IDirectMusicTrack,                                                      0xf96029a1,0x4282,0x11d2,0x87,0x17,0x0,0x60,0x8,0x93,0xb1,0xbd);
  37 DEFINE_GUID(IID_IDirectMusicTool,                                                       0xd2ac28ba,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  38 DEFINE_GUID(IID_IDirectMusicTool8,                                                      0xe674303,0x3b05,0x11d3,0x9b,0xd1,0xf9,0xe7,0xf0,0xa0,0x15,0x36);
  39 DEFINE_GUID(IID_IDirectMusicTrack8,                                             0xe674304,0x3b05,0x11d3,0x9b,0xd1,0xf9,0xe7,0xf0,0xa0,0x15,0x36);
  40
  41 /* typedef definitions of interfaces are in dmusici.h */
  42
  43 DEFINE_GUID(CLSID_DirectMusicTempoTrack,                                        0xd2ac2885,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  44 DEFINE_GUID(CLSID_DirectMusicSeqTrack,                                          0xd2ac2886,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  45 DEFINE_GUID(CLSID_DirectMusicSysExTrack,                                        0xd2ac2887,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  46 DEFINE_GUID(CLSID_DirectMusicTimeSigTrack,                                      0xd2ac2888,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  47 DEFINE_GUID(CLSID_DirectMusicChordTrack,                                        0xd2ac288b,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  48 DEFINE_GUID(CLSID_DirectMusicCommandTrack,                                      0xd2ac288c,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  49 DEFINE_GUID(CLSID_DirectMusicStyleTrack,                                        0xd2ac288d,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  50 DEFINE_GUID(CLSID_DirectMusicMotifTrack,                                        0xd2ac288e,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  51 DEFINE_GUID(CLSID_DirectMusicSignPostTrack,                                     0xf17e8672,0xc3b4,0x11d1,0x87,0xb,0x0,0x60,0x8,0x93,0xb1,0xbd);
  52 DEFINE_GUID(CLSID_DirectMusicBandTrack,                                         0xd2ac2894,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  53 DEFINE_GUID(CLSID_DirectMusicChordMapTrack,                                     0xd2ac2896,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  54 DEFINE_GUID(CLSID_DirectMusicMuteTrack,                                         0xd2ac2898,0xb39b,0x11d1,0x87,0x4,0x0,0x60,0x8,0x93,0xb1,0xbd);
  55 DEFINE_GUID(CLSID_DirectMusicScriptTrack,                                       0x4108fa85,0x3586,0x11d3,0x8b,0xd7,0x0,0x60,0x8,0x93,0xb1,0xb6);
  56 DEFINE_GUID(CLSID_DirectMusicMarkerTrack,                                       0x55a8fd00,0x4288,0x11d3,0x9b,0xd1,0x8a,0xd,0x61,0xc8,0x88,0x35);
  57 DEFINE_GUID(CLSID_DirectMusicSegmentTriggerTrack,                       0xbae4d665,0x4ea1,0x11d3,0x8b,0xda,0x0,0x60,0x8,0x93,0xb1,0xb6);
  58 DEFINE_GUID(CLSID_DirectMusicLyricsTrack,                                       0x995c1cf5,0x54ff,0x11d3,0x8b,0xda,0x0,0x60,0x8,0x93,0xb1,0xb6);
  59 DEFINE_GUID(CLSID_DirectMusicParamControlTrack,                         0x4be0537b,0x5c19,0x11d3,0x8b,0xdc,0x0,0x60,0x8,0x93,0xb1,0xb6);
  60 DEFINE_GUID(CLSID_DirectMusicMelodyFormulationTrack,            0xb0684266,0xb57f,0x11d2,0x97,0xf9,0x0,0xc0,0x4f,0xa3,0x6e,0x58);
  61 DEFINE_GUID(CLSID_DirectMusicWaveTrack,                                         0xeed36461,0x9ea5,0x11d3,0x9b,0xd1,0x0,0x80,0xc7,0x15,0xa,0x74);
  62
  63
  64 /*****************************************************************************
  65  * IDirectMusicTool interface
  66  */
  67 #undef  INTERFACE
  68 #define INTERFACE IDirectMusicTool
  69 #define IDirectMusicTool_METHODS \
  70     IUnknown_METHODS \
  71     STDMETHOD(Init)(THIS_ IDirectMusicGraph *pGraph) PURE; \
  72     STDMETHOD(GetMsgDeliveryType)(THIS_ DWORD *pdwDeliveryType) PURE; \
  73     STDMETHOD(GetMediaTypeArraySize)(THIS_ DWORD *pdwNumElements) PURE; \
  74     STDMETHOD(GetMediaTypes)(THIS_ DWORD **padwMediaTypes, DWORD dwNumElements) PURE; \
  75     STDMETHOD(ProcessPMsg)(THIS_ IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG) PURE; \
  76     STDMETHOD(Flush)(THIS_ IDirectMusicPerformance *pPerf, DMUS_PMSG *pPMSG, REFERENCE_TIME rtTime) PURE;
  77 ICOM_DEFINE(IDirectMusicTool,IUnknown)
  78 #undef INTERFACE
  79
  80 #ifdef COBJMACROS
  81 /*** IUnknown methods ***/
  82 #define IDirectMusicTool_QueryInterface(p,a,b)          (p)->lpVtbl->QueryInterface(p,a,b)
  83 #define IDirectMusicTool_AddRef(p)                      (p)->lpVtbl->AddRef(p)
  84 #define IDirectMusicTool_Release(p)                     (p)->lpVtbl->Release(p)
  85 /*** IDirectMusicTool methods ***/
  86 #define IDirectMusicTool_Init(p,a)                      (p)->lpVtbl->Init(p,a)
  87 #define IDirectMusicTool_GetMsgDeliveryType(p,a)        (p)->lpVtbl->GetMsgDeliveryType(p,a)
  88 #define IDirectMusicTool_GetMediaTypeArraySize(p,a)     (p)->lpVtbl->GetMediaTypeArraySize(p,a)
  89 #define IDirectMusicTool_GetMediaTypes(p,a,b)           (p)->lpVtbl->GetMediaTypes(p,a,b)
  90 #define IDirectMusicTool_ProcessPMsg(p,a,b)             (p)->lpVtbl->ProcessPMsg(p,a,b)
  91 #define IDirectMusicTool_Flush(p,a,b,c)                 (p)->lpVtbl->Flush(p,a,b,c)
  92 #endif
  93
  94
  95 /*****************************************************************************
  96  * IDirectMusicTool8 interface
  97  */
  98 #undef  INTERFACE
  99 #define INTERFACE IDirectMusicTool8
 100 #define IDirectMusicTool8_METHODS \
 101     IDirectMusicTool_METHODS \
 102     STDMETHOD(Clone)(THIS_ IDirectMusicTool **ppTool) PURE;
 103 ICOM_DEFINE(IDirectMusicTool8,IDirectMusicTool)
 104 #undef INTERFACE
 105
 106 #ifdef COBJMACROS
 107 /*** IUnknown methods ***/
 108 #define IDirectMusicTool8_QueryInterface(p,a,b)         (p)->lpVtbl->QueryInterface(p,a,b)
 109 #define IDirectMusicTool8_AddRef(p)                     (p)->lpVtbl->AddRef(p)
 110 #define IDirectMusicTool8_Release(p)                    (p)->lpVtbl->Release(p)
 111 /*** IDirectMusicTool methods ***/
 112 #define IDirectMusicTool8_Init(p,a)                     (p)->lpVtbl->Init(p,a)
 113 #define IDirectMusicTool8_GetMsgDeliveryType(p,a)       (p)->lpVtbl->GetMsgDeliveryType(p,a)
 114 #define IDirectMusicTool8_GetMediaTypeArraySize(p,a)    (p)->lpVtbl->GetMediaTypeArraySize(p,a)
 115 #define IDirectMusicTool8_GetMediaTypes(p,a,b)          (p)->lpVtbl->GetMediaTypes(p,a,b)
 116 #define IDirectMusicTool8_ProcessPMsg(p,a,b)            (p)->lpVtbl->ProcessPMsg(p,a,b)
 117 #define IDirectMusicTool8_Flush(p,a,b)                  (p)->lpVtbl->Flush(p,a,b)
 118 /*** IDirectMusicTool8 methods ***/
 119 #define IDirectMusicTool8_Clone(p,a)                    (p)->lpVtbl->Clone(p,a)
 120 #endif
 121
 122
 123 typedef enum enumDMUS_TRACKF_FLAGS
 124 {
 125     DMUS_TRACKF_SEEK            = 1,
 126     DMUS_TRACKF_LOOP            = 2,
 127     DMUS_TRACKF_START           = 4,
 128     DMUS_TRACKF_FLUSH           = 8,
 129     DMUS_TRACKF_DIRTY           = 0x10,
 130     DMUS_TRACKF_NOTIFY_OFF      = 0x20,
 131     DMUS_TRACKF_PLAY_OFF        = 0x40,
 132     DMUS_TRACKF_LOOPEND         = 0x80,
 133     DMUS_TRACKF_STOP            = 0x100,
 134     DMUS_TRACKF_RECOMPOSE       = 0x200,
 135     DMUS_TRACKF_CLOCK           = 0x400,
 136 } DMUS_TRACKF_FLAGS;
 137
 138 #define DMUS_TRACK_PARAMF_CLOCK  0x01
 139
 140
 141
 142 /*****************************************************************************
 143  * IDirectMusicTrack interface
 144  */
 145 #undef  INTERFACE
 146 #define INTERFACE IDirectMusicTrack
 147 #define IDirectMusicTrack_METHODS \
 148     IUnknown_METHODS \
 149     STDMETHOD(Init)(THIS_ IDirectMusicSegment *pSegment) PURE; \
 150     STDMETHOD(InitPlay)(THIS_ IDirectMusicSegmentState *pSegmentState, IDirectMusicPerformance *pPerformance, void **ppStateData, DWORD dwVirtualTrackID, DWORD dwFlags) PURE; \
 151     STDMETHOD(EndPlay)(THIS_ void *pStateData) PURE; \
 152     STDMETHOD(Play)(THIS_ void *pStateData, MUSIC_TIME mtStart, MUSIC_TIME mtEnd, MUSIC_TIME mtOffset, DWORD dwFlags, IDirectMusicPerformance *pPerf, IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE; \
 153     STDMETHOD(GetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, MUSIC_TIME *pmtNext, void *pParam) PURE; \
 154     STDMETHOD(SetParam)(THIS_ REFGUID rguidType, MUSIC_TIME mtTime, void *pParam) PURE; \
 155     STDMETHOD(IsParamSupported)(THIS_ REFGUID rguidType) PURE; \
 156     STDMETHOD(AddNotificationType)(THIS_ REFGUID rguidNotificationType) PURE; \
 157     STDMETHOD(RemoveNotificationType)(THIS_ REFGUID rguidNotificationType) PURE; \
 158     STDMETHOD(Clone)(THIS_ MUSIC_TIME mtStart, MUSIC_TIME mtEnd, IDirectMusicTrack **ppTrack) PURE;
 159 ICOM_DEFINE(IDirectMusicTrack,IUnknown)
 160 #undef INTERFACE
 161
 162 #ifdef COBJMACROS
 163 /*** IUnknown methods ***/
 164 #define IDirectMusicTrack_QueryInterface(p,a,b)         (p)->lpVtbl->QueryInterface(p,a,b)
 165 #define IDirectMusicTrack_AddRef(p)                     (p)->lpVtbl->AddRef(p)
 166 #define IDirectMusicTrack_Release(p)                    (p)->lpVtbl->Release(p)
 167 /*** IDirectMusicTrack methods ***/
 168 #define IDirectMusicTrack_Init(p,a)                     (p)->lpVtbl->Init(p,a)
 169 #define IDirectMusicTrack_InitPlay(p,a,b,c,d,e)         (p)->lpVtbl->InitPlay(p,a,b,c,d,e)
 170 #define IDirectMusicTrack_EndPlay(p,a)                  (p)->lpVtbl->EndPlay(p,a)
 171 #define IDirectMusicTrack_Play(p,a,b,c,d,e,f,g,h)       (p)->lpVtbl->Play(p,a,b,c,d,e,f,g,h)
 172 #define IDirectMusicTrack_GetParam(p,a,b,c,d)           (p)->lpVtbl->GetParam(p,a,b,c,d)
 173 #define IDirectMusicTrack_SetParam(p,a,b,c)             (p)->lpVtbl->SetParam(p,a,b,c)
 174 #define IDirectMusicTrack_IsParamSupported(p,a)         (p)->lpVtbl->IsParamSupported(p,a)
 175 #define IDirectMusicTrack_AddNotificationType(p,a)      (p)->lpVtbl->AddNotificationType(p,a)
 176 #define IDirectMusicTrack_RemoveNotificationType(p,a)   (p)->lpVtbl->RemoveNotificationType(p,a)
 177 #define IDirectMusicTrack_Clone(p,a,b,c)                (p)->lpVtbl->Clone(p,a,b,c)
 178 #endif
 179
 180
 181 /*****************************************************************************
 182  * IDirectMusicTrack8 interface
 183  */
 184 #undef  INTERFACE
 185 #define INTERFACE IDirectMusicTrack8
 186 #define IDirectMusicTrack8_METHODS \
 187     IDirectMusicTrack_METHODS \
 188     STDMETHOD(PlayEx)(THIS_ void *pStateData, REFERENCE_TIME rtStart, REFERENCE_TIME rtEnd, REFERENCE_TIME rtOffset, DWORD dwFlags, IDirectMusicPerformance *pPerf, IDirectMusicSegmentState *pSegSt, DWORD dwVirtualID) PURE; \
 189     STDMETHOD(GetParamEx)(THIS_ REFGUID rguidType, REFERENCE_TIME rtTime, REFERENCE_TIME *prtNext, void *pParam, void *pStateData, DWORD dwFlags) PURE; \
 190     STDMETHOD(SetParamEx)(THIS_ REFGUID rguidType, REFERENCE_TIME rtTime, void *pParam, void *pStateData, DWORD dwFlags) PURE; \
 191     STDMETHOD(Compose)(THIS_ IUnknown *pContext, DWORD dwTrackGroup, IDirectMusicTrack **ppResultTrack) PURE; \
 192     STDMETHOD(Join)(THIS_ IDirectMusicTrack *pNewTrack, MUSIC_TIME mtJoin, IUnknown *pContext, DWORD dwTrackGroup, IDirectMusicTrack **ppResultTrack) PURE;
 193 ICOM_DEFINE(IDirectMusicTrack8,IDirectMusicTrack)
 194 #undef INTERFACE
 195
 196 #ifdef COBJMACROS
 197 /*** IUnknown methods ***/
 198 #define IDirectMusicTrack8_QueryInterface(p,a,b)        (p)->lpVtbl->QueryInterface(p,a,b)
 199 #define IDirectMusicTrack8_AddRef(p)                    (p)->lpVtbl->AddRef(p)
 200 #define IDirectMusicTrack8_Release(p)                   (p)->lpVtbl->Release(p)
 201 /*** IDirectMusicTrack methods ***/
 202 #define IDirectMusicTrack8_Init(p,a)                    (p)->lpVtbl->Init(p,a)
 203 #define IDirectMusicTrack8_InitPlay(p,a,b,c,d,e)        (p)->lpVtbl->InitPlay(p,a,b,c,d,e)
 204 #define IDirectMusicTrack8_EndPlay(p,a)                 (p)->lpVtbl->EndPlay(p,a)
 205 #define IDirectMusicTrack8_Play(p,a,b,c,d,e,f,g,h)      (p)->lpVtbl->Play(p,a,b,c,d,e,f,g,h)
 206 #define IDirectMusicTrack8_GetParam(p,a,b,c,d)          (p)->lpVtbl->GetParam(p,a,b,c,d)
 207 #define IDirectMusicTrack8_SetParam(p,a,b,c)            (p)->lpVtbl->SetParam(p,a,b,c)
 208 #define IDirectMusicTrack8_IsParamSupported(p,a)        (p)->lpVtbl->IsParamSupported(p,a)
 209 #define IDirectMusicTrack8_AddNotificationType(p,a)     (p)->lpVtbl->AddNotificationType(p,a)
 210 #define IDirectMusicTrack8_RemoveNotificationType(p,a)  (p)->lpVtbl->RemoveNotificationType(p,a)
 211 #define IDirectMusicTrack8_Clone(p,a,b,c)               (p)->lpVtbl->Clone(p,a,b,c)
 212 /*** IDirectMusicTrack8 methods ***/
 213 #define IDirectMusicTrack8_PlayEx(p,a,b,c,d,e,f,g,h)    (p)->lpVtbl->PlayEx(p,a,b,c,d,e,f,g,h)
 214 #define IDirectMusicTrack8_GetParamEx(p,a,b,c,d,e,f)    (p)->lpVtbl->GetParamEx(p,a,b,c,d,e,f)
 215 #define IDirectMusicTrack8_SetParamEx(p,a,b,c,d,e)      (p)->lpVtbl->SetParamEx(p,a,b,c,d,e)
 216 #define IDirectMusicTrack8_Compose(p,a,b,c)             (p)->lpVtbl->Compose(p,a,b,c)
 217 #define IDirectMusicTrack8_Join(p,a,b,c,d,e)            (p)->lpVtbl->Join(p,a,b,c,d,e)
 218 #endif
 219
 220
 221 #ifdef __cplusplus
 222 }
 223 #endif
 224
 225 #endif /* __WINE_DMUSIC_PLUGIN_H */