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