dlls/dplayx/dplaysp.h

   1 /*
   2  * Copyright 2000 Peter Hunnisett
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 #ifndef __WINE_DIRECT_PLAY_SP_H
  20 #define __WINE_DIRECT_PLAY_SP_H
  21
  22 #include "dplay.h"
  23 #include "dplobby.h"
  24
  25 /* GUID for IDirectPlaySP  {0C9F6360-CC61-11cf-ACEC-00AA006886E3} */
  26 DEFINE_GUID(IID_IDirectPlaySP, 0xc9f6360, 0xcc61, 0x11cf, 0xac, 0xec, 0x0, 0xaa, 0x0, 0x68, 0x86, 0xe3);
  27 typedef struct IDirectPlaySP IDirectPlaySP, *LPDIRECTPLAYSP;
  28
  29
  30 typedef BOOL (CALLBACK *LPENUMMRUCALLBACK)( LPCVOID lpData,
  31                                             DWORD  dwDataSize,
  32                                             LPVOID lpContext );
  33
  34 /* For SP. Top 16 bits is dplay, bottom 16 is SP */
  35 #define DPSP_MAJORVERSION 0x00060000
  36 #define DPSP_DX5VERSION   0x00050000
  37 #define DPSP_DX3VERSION   0x00040000
  38
  39 #define DPSP_MAJORVERSIONMASK 0xFFFF0000
  40 #define DPSP_MINORVERSIONMASK 0x0000FFFF
  41
  42
  43 /* Some flags */
  44 #define DPLAYI_PLAYER_SYSPLAYER      0x00000001
  45 #define DPLAYI_PLAYER_NAMESRVR       0x00000002
  46 #define DPLAYI_PLAYER_PLAYERINGROUP  0x00000004
  47 #define DPLAYI_PLAYER_PLAYERLOCAL    0x00000008
  48 #define DPLAYI_GROUP_SYSGROUP        0x00000020
  49 #define DPLAYI_GROUP_DPLAYOWNS       0x00000040
  50 #define DPLAYI_PLAYER_APPSERVER      0x00000080
  51 #define DPLAYI_GROUP_HIDDEN          0x00000400
  52
  53 /* Define the COM interface */
  54 #define INTERFACE IDirectPlaySP
  55 #define IDirectPlaySP_METHODS \
  56    IUnknown_METHODS \
  57    STDMETHOD(AddMRUEntry)(THIS_ LPCWSTR lpSection, LPCWSTR lpKey, LPCVOID lpData, DWORD dwDataSize, DWORD dwMaxEntries ) PURE; \
  58    STDMETHOD(CreateAddress)(THIS_ REFGUID guidSP, REFGUID guidDataType, LPCVOID lpData, DWORD dwDataSize, LPVOID lpAddress,LPDWORD lpdwAddressSize) PURE; \
  59    STDMETHOD(EnumAddress)(THIS_ LPDPENUMADDRESSCALLBACK lpEnumAddressCallback, LPCVOID lpAddress, DWORD dwAddressSize, LPVOID lpContext ) PURE; \
  60    STDMETHOD(EnumMRUEntries)(THIS_ LPCWSTR lpSection, LPCWSTR lpKey, LPENUMMRUCALLBACK lpEnumMRUCallback, LPVOID lpContext ) PURE; \
  61    STDMETHOD(GetPlayerFlags)(THIS_ DPID idPlayer, LPDWORD lpdwPlayerFlags ) PURE; \
  62    STDMETHOD(GetSPPlayerData)(THIS_ DPID idPlayer, LPVOID *lplpData, LPDWORD lpdwDataSize, DWORD dwFlags ) PURE; \
  63    STDMETHOD(HandleMessage)(THIS_ LPVOID lpMessageBody, DWORD dwMessageBodySize, LPVOID lpMessageHeader ) PURE; \
  64    STDMETHOD(SetSPPlayerData)(THIS_ DPID idPlayer, LPVOID lpData, DWORD dwDataSize, DWORD dwFlags ) PURE; \
  65    STDMETHOD(CreateCompoundAddress)(THIS_ LPCDPCOMPOUNDADDRESSELEMENT lpElements, DWORD dwElementCount, LPVOID lpAddress, LPDWORD lpdwAddressSize ) PURE; \
  66    STDMETHOD(GetSPData)(THIS_ LPVOID *lplpData, LPDWORD dwDataSize, DWORD dwFlags ) PURE; \
  67    STDMETHOD(SetSPData)(THIS_ LPVOID lpData, DWORD dwDataSize, DWORD dwFlags ) PURE; \
  68    STDMETHOD_(VOID,SendComplete)(THIS_ LPVOID , DWORD  ) PURE;
  69 ICOM_DEFINE(IDirectPlaySP,IUnknown)
  70 #undef INTERFACE
  71
  72
  73 /* NOTE: The microsoft provided header file doesn't have these access
  74  * functions
  75  */
  76 #ifdef COBJMACROS
  77 /*** IUnknown methods ***/
  78 #define IDirectPlaySP_QueryInterface(p,a,b)        (p)->lpVtbl->QueryInterface(p,a,b)
  79 #define IDirectPlaySP_AddRef(p)                    (p)->lpVtbl->AddRef(p)
  80 #define IDirectPlaySP_Release(p)                   (p)->lpVtbl->Release(p)
  81 /*** IDirectPlaySP methods ***/
  82 #define IDirectPlaySP_AddMRUEntry(p,a,b,c,d,e)     (p)->lpVtbl->AddMRUEntry(p,a,b,c,d,e)
  83 #define IDirectPlaySP_CreateAddress(p,a,b,c,d,e,f) (p)->lpVtbl->CreateAddress(p,a,b,c,d,e,f)
  84 #define IDirectPlaySP_EnumAddress(p,a,b,c,d)       (p)->lpVtbl->EnumAddress(p,a,b,c,d)
  85 #define IDirectPlaySP_EnumMRUEntries(p,a,b,c,d)    (p)->lpVtbl->EnumMRUEntries(p,a,b,c,d)
  86 #define IDirectPlaySP_GetPlayerFlags(p,a,b)        (p)->lpVtbl->GetPlayerFlags(p,a,b)
  87 #define IDirectPlaySP_GetSPPlayerData(p,a,b,c,d)   (p)->lpVtbl->GetSPPlayerData(p,a,b,c,d)
  88 #define IDirectPlaySP_HandleMessage(p,a,b,c)       (p)->lpVtbl->HandleMessage(p,a,b,c)
  89 #define IDirectPlaySP_SetSPPlayerData(p,a,b,c,d)   (p)->lpVtbl->SetSPPlayerData(p,a,b,c,d)
  90 #define IDirectPlaySP_CreateCompoundAddress(p,a,b,c,d)  (p)->lpVtbl->CreateCompoundAddress(p,a,b,c,d)
  91 #define IDirectPlaySP_GetSPData(p,a,b,c)           (p)->lpVtbl->GetSPData(p,a,b,c)
  92 #define IDirectPlaySP_SetSPData(p,a,b,c)           (p)->lpVtbl->SetSPData(p,a,b,c)
  93 #define IDirectPlaySP_SendComplete(p,a,b)          (p)->lpVtbl->SendComplete(p,a,b)
  94 #endif
  95
  96 /* SP Callback stuff */
  97
  98 typedef struct tagDPSP_ADDPLAYERTOGROUPDATA
  99 {
 100   DPID           idPlayer;
 101   DPID           idGroup;
 102   IDirectPlaySP* lpISP;
 103 } DPSP_ADDPLAYERTOGROUPDATA, *LPDPSP_ADDPLAYERTOGROUPDATA;
 104
 105 typedef struct tagDPSP_CLOSEDATA
 106 {
 107   IDirectPlaySP* lpISP;
 108 } DPSP_CLOSEDATA, *LPDPSP_CLOSEDATA;
 109
 110 typedef struct tagDPSP_CREATEGROUPDATA
 111 {
 112   DPID           idGroup;
 113   DWORD          dwFlags;
 114   LPVOID         lpSPMessageHeader;
 115   IDirectPlaySP* lpISP;
 116 } DPSP_CREATEGROUPDATA, *LPDPSP_CREATEGROUPDATA;
 117
 118 typedef struct tagDPSP_CREATEPLAYERDATA
 119 {
 120   DPID           idPlayer;
 121   DWORD          dwFlags;
 122   LPVOID         lpSPMessageHeader;
 123   IDirectPlaySP* lpISP;
 124 } DPSP_CREATEPLAYERDATA, *LPDPSP_CREATEPLAYERDATA;
 125
 126 typedef struct tagDPSP_DELETEGROUPDATA
 127 {
 128   DPID           idGroup;
 129   DWORD          dwFlags;
 130   IDirectPlaySP* lpISP;
 131 } DPSP_DELETEGROUPDATA, *LPDPSP_DELETEGROUPDATA;
 132
 133 typedef struct tagDPSP_DELETEPLAYERDATA
 134 {
 135   DPID           idPlayer;
 136   DWORD          dwFlags;
 137   IDirectPlaySP* lpISP;
 138 } DPSP_DELETEPLAYERDATA, *LPDPSP_DELETEPLAYERDATA;
 139
 140 typedef struct tagDPSP_ENUMSESSIONSDATA
 141 {
 142   LPVOID         lpMessage;
 143   DWORD          dwMessageSize;
 144   IDirectPlaySP* lpISP;
 145   BOOL           bReturnStatus;
 146 } DPSP_ENUMSESSIONSDATA, *LPDPSP_ENUMSESSIONSDATA;
 147
 148 typedef struct _DPSP_GETADDRESSDATA
 149 {
 150   DPID           idPlayer;
 151   DWORD          dwFlags;
 152   LPDPADDRESS    lpAddress;
 153   LPDWORD        lpdwAddressSize;
 154   IDirectPlaySP* lpISP;
 155 } DPSP_GETADDRESSDATA, *LPDPSP_GETADDRESSDATA;
 156
 157 typedef struct tagDPSP_GETADDRESSCHOICESDATA
 158 {
 159   LPDPADDRESS    lpAddress;
 160   LPDWORD        lpdwAddressSize;
 161   IDirectPlaySP* lpISP;
 162 } DPSP_GETADDRESSCHOICESDATA, *LPDPSP_GETADDRESSCHOICESDATA;
 163
 164 typedef struct tagDPSP_GETCAPSDATA
 165 {
 166   DPID           idPlayer;
 167   LPDPCAPS       lpCaps;
 168   DWORD          dwFlags;
 169   IDirectPlaySP* lpISP;
 170 } DPSP_GETCAPSDATA, *LPDPSP_GETCAPSDATA;
 171
 172 typedef struct tagDPSP_OPENDATA
 173 {
 174   BOOL           bCreate;
 175   LPVOID         lpSPMessageHeader;
 176   IDirectPlaySP* lpISP;
 177   BOOL           bReturnStatus;
 178   DWORD          dwOpenFlags;
 179   DWORD          dwSessionFlags;
 180 } DPSP_OPENDATA, *LPDPSP_OPENDATA;
 181
 182 typedef struct tagDPSP_REMOVEPLAYERFROMGROUPDATA
 183 {
 184   DPID           idPlayer;
 185   DPID           idGroup;
 186   IDirectPlaySP* lpISP;
 187 } DPSP_REMOVEPLAYERFROMGROUPDATA, *LPDPSP_REMOVEPLAYERFROMGROUPDATA;
 188
 189 typedef struct tagDPSP_REPLYDATA
 190 {
 191   LPVOID         lpSPMessageHeader;
 192   LPVOID         lpMessage;
 193   DWORD          dwMessageSize;
 194   DPID           idNameServer;
 195   IDirectPlaySP* lpISP;
 196 } DPSP_REPLYDATA, *LPDPSP_REPLYDATA;
 197
 198 typedef struct tagDPSP_SENDDATA
 199 {
 200   DWORD          dwFlags;
 201   DPID           idPlayerTo;
 202   DPID           idPlayerFrom;
 203   LPVOID         lpMessage;
 204   DWORD          dwMessageSize;
 205   BOOL           bSystemMessage;
 206   IDirectPlaySP* lpISP;
 207 } DPSP_SENDDATA, *LPDPSP_SENDDATA;
 208
 209 typedef struct tagDPSP_SENDTOGROUPDATA
 210 {
 211   DWORD          dwFlags;
 212   DPID           idGroupTo;
 213   DPID           idPlayerFrom;
 214   LPVOID         lpMessage;
 215   DWORD          dwMessageSize;
 216   IDirectPlaySP* lpISP;
 217 } DPSP_SENDTOGROUPDATA, *LPDPSP_SENDTOGROUPDATA;
 218
 219 typedef struct tagDPSP_SENDEXDATA
 220 {
 221   IDirectPlaySP* lpISP;
 222   DWORD          dwFlags;
 223   DPID           idPlayerTo;
 224   DPID           idPlayerFrom;
 225   LPSGBUFFER     lpSendBuffers;
 226   DWORD          cBuffers;
 227   DWORD          dwMessageSize;
 228   DWORD          dwPriority;
 229   DWORD          dwTimeout;
 230   LPVOID         lpDPContext;
 231   LPDWORD        lpdwSPMsgID;
 232   BOOL           bSystemMessage;
 233 } DPSP_SENDEXDATA, *LPDPSP_SENDEXDATA;
 234
 235 typedef struct tagDPSP_SENDTOGROUPEXDATA
 236 {
 237   IDirectPlaySP* lpISP;
 238   DWORD          dwFlags;
 239   DPID           idGroupTo;
 240   DPID           idPlayerFrom;
 241   LPSGBUFFER     lpSendBuffers;
 242   DWORD          cBuffers;
 243   DWORD          dwMessageSize;
 244   DWORD          dwPriority;
 245   DWORD          dwTimeout;
 246   LPVOID         lpDPContext;
 247   LPDWORD        lpdwSPMsgID;
 248 } DPSP_SENDTOGROUPEXDATA, *LPDPSP_SENDTOGROUPEXDATA;
 249
 250 typedef struct tagDPSP_GETMESSAGEQUEUEDATA
 251 {
 252   IDirectPlaySP* lpISP;
 253   DWORD          dwFlags;
 254   DPID           idFrom;
 255   DPID           idTo;
 256   LPDWORD        lpdwNumMsgs;
 257   LPDWORD        lpdwNumBytes;
 258 } DPSP_GETMESSAGEQUEUEDATA, *LPDPSP_GETMESSAGEQUEUEDATA;
 259
 260 #define DPCANCELSEND_PRIORITY 0x00000001
 261 #define DPCANCELSEND_ALL      0x00000002
 262
 263 typedef struct tagDPSP_CANCELDATA
 264 {
 265   IDirectPlaySP* lpISP;
 266   DWORD          dwFlags;
 267   LPRGLPVOID     lprglpvSPMsgID;
 268   DWORD          cSPMsgID;
 269   DWORD          dwMinPriority;
 270   DWORD          dwMaxPriority;
 271 } DPSP_CANCELDATA, *LPDPSP_CANCELDATA;
 272
 273 typedef struct tagDPSP_SHUTDOWNDATA
 274 {
 275   IDirectPlaySP* lpISP;
 276 } DPSP_SHUTDOWNDATA, *LPDPSP_SHUTDOWNDATA;
 277
 278
 279 /* Prototypes returned by SPInit */
 280 typedef HRESULT (WINAPI *LPDPSP_CREATEPLAYER)(LPDPSP_CREATEPLAYERDATA);
 281 typedef HRESULT (WINAPI *LPDPSP_DELETEPLAYER)(LPDPSP_DELETEPLAYERDATA);
 282 typedef HRESULT (WINAPI *LPDPSP_SEND)(LPDPSP_SENDDATA);
 283 typedef HRESULT (WINAPI *LPDPSP_ENUMSESSIONS)(LPDPSP_ENUMSESSIONSDATA);
 284 typedef HRESULT (WINAPI *LPDPSP_REPLY)(LPDPSP_REPLYDATA);
 285 typedef HRESULT (WINAPI *LPDPSP_SHUTDOWN)(void);
 286 typedef HRESULT (WINAPI *LPDPSP_CREATEGROUP)(LPDPSP_CREATEGROUPDATA);
 287 typedef HRESULT (WINAPI *LPDPSP_DELETEGROUP)(LPDPSP_DELETEGROUPDATA);
 288 typedef HRESULT (WINAPI *LPDPSP_ADDPLAYERTOGROUP)(LPDPSP_ADDPLAYERTOGROUPDATA);
 289 typedef HRESULT (WINAPI *LPDPSP_REMOVEPLAYERFROMGROUP)(LPDPSP_REMOVEPLAYERFROMGROUPDATA);
 290 typedef HRESULT (WINAPI *LPDPSP_GETCAPS)(LPDPSP_GETCAPSDATA);
 291 typedef HRESULT (WINAPI *LPDPSP_GETADDRESS)(LPDPSP_GETADDRESSDATA);
 292 typedef HRESULT (WINAPI *LPDPSP_GETADDRESSCHOICES)(LPDPSP_GETADDRESSCHOICESDATA);
 293 typedef HRESULT (WINAPI *LPDPSP_OPEN)(LPDPSP_OPENDATA);
 294 typedef HRESULT (WINAPI *LPDPSP_CLOSE)(void);
 295 typedef HRESULT (WINAPI *LPDPSP_SENDTOGROUP)(LPDPSP_SENDTOGROUPDATA);
 296 typedef HRESULT (WINAPI *LPDPSP_SHUTDOWNEX)(LPDPSP_SHUTDOWNDATA);
 297 typedef HRESULT (WINAPI *LPDPSP_CLOSEEX)(LPDPSP_CLOSEDATA);
 298 typedef HRESULT (WINAPI *LPDPSP_SENDEX)(LPDPSP_SENDEXDATA);
 299 typedef HRESULT (WINAPI *LPDPSP_SENDTOGROUPEX)(LPDPSP_SENDTOGROUPEXDATA);
 300 typedef HRESULT (WINAPI *LPDPSP_CANCEL)(LPDPSP_CANCELDATA);
 301 typedef HRESULT (WINAPI *LPDPSP_GETMESSAGEQUEUE)(LPDPSP_GETMESSAGEQUEUEDATA);
 302
 303
 304 typedef struct tagDPSP_SPCALLBACKS
 305 {
 306     DWORD                        dwSize;
 307     DWORD                        dwVersion;
 308
 309     LPDPSP_ENUMSESSIONS          EnumSessions;          /* Must be provided */
 310     LPDPSP_REPLY                 Reply;                 /* Must be provided */
 311     LPDPSP_SEND                  Send;                  /* Must be provided */
 312     LPDPSP_ADDPLAYERTOGROUP      AddPlayerToGroup;      /* Optional */
 313     LPDPSP_CLOSE                 Close;                 /* Optional */
 314     LPDPSP_CREATEGROUP           CreateGroup;           /* Optional */
 315     LPDPSP_CREATEPLAYER          CreatePlayer;          /* Optional */
 316     LPDPSP_DELETEGROUP           DeleteGroup;           /* Optional */
 317     LPDPSP_DELETEPLAYER          DeletePlayer;          /* Optional */
 318     LPDPSP_GETADDRESS            GetAddress;            /* Optional */
 319     LPDPSP_GETCAPS               GetCaps;               /* Optional */
 320     LPDPSP_OPEN                  Open;                  /* Optional */
 321     LPDPSP_REMOVEPLAYERFROMGROUP RemovePlayerFromGroup; /* Optional */
 322     LPDPSP_SENDTOGROUP           SendToGroup;           /* Optional */
 323     LPDPSP_SHUTDOWN              Shutdown;              /* Optional */
 324
 325     LPDPSP_CLOSEEX               CloseEx;               /* Optional */
 326     LPDPSP_SHUTDOWNEX            ShutdownEx;            /* Optional */
 327     LPDPSP_GETADDRESSCHOICES     GetAddressChoices;     /* Optional */
 328
 329     LPDPSP_SENDEX                SendEx;                /* Optional */
 330     LPDPSP_SENDTOGROUPEX         SendToGroupEx;         /* Optional */
 331     LPDPSP_CANCEL                Cancel;                /* Optional */
 332     LPDPSP_GETMESSAGEQUEUE       GetMessageQueue;       /* Optional */
 333 } DPSP_SPCALLBACKS, *LPDPSP_SPCALLBACKS;
 334
 335 typedef struct tagSPINITDATA
 336 {
 337     LPDPSP_SPCALLBACKS  lpCB;
 338     IDirectPlaySP*      lpISP;
 339     LPWSTR              lpszName;
 340     LPGUID              lpGuid;
 341     DWORD               dwReserved1;
 342     DWORD               dwReserved2;
 343     DWORD               dwSPHeaderSize;
 344     LPDPADDRESS         lpAddress;
 345     DWORD               dwAddressSize;
 346     DWORD               dwSPVersion;
 347 } SPINITDATA, *LPSPINITDATA;
 348
 349 typedef HRESULT (WINAPI *LPDPSP_SPINIT)(LPSPINITDATA);
 350
 351 /* This variable is exported from the DLL at ordinal 6 to be accessed by the
 352  * SP directly
 353  */
 354 extern DWORD gdwDPlaySPRefCount;
 355
 356 #endif