dlls/ddraw/main.c

   1 /*        DirectDraw Base Functions
   2  *
   3  * Copyright 1997-1999 Marcus Meissner
   4  * Copyright 1998 Lionel Ulmer
   5  * Copyright 2000-2001 TransGaming Technologies Inc.
   6  * Copyright 2006 Stefan Dösinger
   7  * Copyright 2008 Denver Gingerich
   8  *
   9  * This file contains the (internal) driver registration functions,
  10  * driver enumeration APIs and DirectDraw creation functions.
  11  *
  12  * This library is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU Lesser General Public
  14  * License as published by the Free Software Foundation; either
  15  * version 2.1 of the License, or (at your option) any later version.
  16  *
  17  * This library is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  20  * Lesser General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU Lesser General Public
  23  * License along with this library; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  25  */
  26
  27 #include "config.h"
  28 #include "wine/port.h"
  29 #include "wine/debug.h"
  30
  31 #include <assert.h>
  32 #include <stdarg.h>
  33 #include <string.h>
  34 #include <stdlib.h>
  35
  36 #define COBJMACROS
  37
  38 #include "windef.h"
  39 #include "winbase.h"
  40 #include "winerror.h"
  41 #include "wingdi.h"
  42 #include "wine/exception.h"
  43 #include "winreg.h"
  44
  45 #include "ddraw.h"
  46 #include "d3d.h"
  47
  48 #define DDRAW_INIT_GUID
  49 #include "ddraw_private.h"
  50
  51 static typeof(WineDirect3DCreate) *pWineDirect3DCreate;
  52
  53 WINE_DEFAULT_DEBUG_CHANNEL(ddraw);
  54
  55 /* The configured default surface */
  56 WINED3DSURFTYPE DefaultSurfaceType = SURFACE_UNKNOWN;
  57
  58 /* DDraw list and critical section */
  59 static struct list global_ddraw_list = LIST_INIT(global_ddraw_list);
  60
  61 static CRITICAL_SECTION_DEBUG ddraw_cs_debug =
  62 {
  63     0, 0, &ddraw_cs,
  64     { &ddraw_cs_debug.ProcessLocksList,
  65     &ddraw_cs_debug.ProcessLocksList },
  66     0, 0, { (DWORD_PTR)(__FILE__ ": ddraw_cs") }
  67 };
  68 CRITICAL_SECTION ddraw_cs = { &ddraw_cs_debug, -1, 0, 0, 0, 0 };
  69
  70 /* value of ForceRefreshRate */
  71 DWORD force_refresh_rate = 0;
  72
  73 /*
  74  * Helper Function for DDRAW_Create and DirectDrawCreateClipper for
  75  * lazy loading of the Wine D3D driver.
  76  *
  77  * Returns
  78  *  TRUE on success
  79  *  FALSE on failure.
  80  */
  81
  82 BOOL LoadWineD3D(void)
  83 {
  84     static HMODULE hWineD3D = (HMODULE) -1;
  85     if (hWineD3D == (HMODULE) -1)
  86     {
  87         hWineD3D = LoadLibraryA("wined3d");
  88         if (hWineD3D)
  89         {
  90             pWineDirect3DCreate = (typeof(WineDirect3DCreate) *)GetProcAddress(hWineD3D, "WineDirect3DCreate");
  91             pWineDirect3DCreateClipper = (typeof(WineDirect3DCreateClipper) *) GetProcAddress(hWineD3D, "WineDirect3DCreateClipper");
  92             return TRUE;
  93         }
  94     }
  95     return hWineD3D != NULL;
  96 }
  97
  98 /***********************************************************************
  99  *
 100  * Helper function for DirectDrawCreate and friends
 101  * Creates a new DDraw interface with the given REFIID
 102  *
 103  * Interfaces that can be created:
 104  *  IDirectDraw, IDirectDraw2, IDirectDraw4, IDirectDraw7
 105  *  IDirect3D, IDirect3D2, IDirect3D3, IDirect3D7. (Does Windows return
 106  *  IDirect3D interfaces?)
 107  *
 108  * Arguments:
 109  *  guid: ID of the requested driver, NULL for the default driver.
 110  *        The GUID can be queried with DirectDrawEnumerate(Ex)A/W
 111  *  DD: Used to return the pointer to the created object
 112  *  UnkOuter: For aggregation, which is unsupported. Must be NULL
 113  *  iid: requested version ID.
 114  *
 115  * Returns:
 116  *  DD_OK if the Interface was created successfully
 117  *  CLASS_E_NOAGGREGATION if UnkOuter is not NULL
 118  *  E_OUTOFMEMORY if some allocation failed
 119  *
 120  ***********************************************************************/
 121 static HRESULT
 122 DDRAW_Create(const GUID *guid,
 123              void **DD,
 124              IUnknown *UnkOuter,
 125              REFIID iid)
 126 {
 127     IDirectDrawImpl *This = NULL;
 128     HRESULT hr;
 129     IWineD3D *wineD3D = NULL;
 130     IWineD3DDevice *wineD3DDevice = NULL;
 131     HDC hDC;
 132     WINED3DDEVTYPE devicetype;
 133
 134     TRACE("(%s,%p,%p)\n", debugstr_guid(guid), DD, UnkOuter);
 135
 136     *DD = NULL;
 137
 138     /* We don't care about this guids. Well, there's no special guid anyway
 139      * OK, we could
 140      */
 141     if (guid == (GUID *) DDCREATE_EMULATIONONLY)
 142     {
 143         /* Use the reference device id. This doesn't actually change anything,
 144          * WineD3D always uses OpenGL for D3D rendering. One could make it request
 145          * indirect rendering
 146          */
 147         devicetype = WINED3DDEVTYPE_REF;
 148     }
 149     else if(guid == (GUID *) DDCREATE_HARDWAREONLY)
 150     {
 151         devicetype = WINED3DDEVTYPE_HAL;
 152     }
 153     else
 154     {
 155         devicetype = 0;
 156     }
 157
 158     /* DDraw doesn't support aggregation, according to msdn */
 159     if (UnkOuter != NULL)
 160         return CLASS_E_NOAGGREGATION;
 161
 162     /* DirectDraw creation comes here */
 163     This = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(IDirectDrawImpl));
 164     if(!This)
 165     {
 166         ERR("Out of memory when creating DirectDraw\n");
 167         return E_OUTOFMEMORY;
 168     }
 169
 170     /* The interfaces:
 171      * IDirectDraw and IDirect3D are the same object,
 172      * QueryInterface is used to get other interfaces.
 173      */
 174     ICOM_INIT_INTERFACE(This, IDirectDraw,  IDirectDraw1_Vtbl);
 175     ICOM_INIT_INTERFACE(This, IDirectDraw2, IDirectDraw2_Vtbl);
 176     ICOM_INIT_INTERFACE(This, IDirectDraw3, IDirectDraw3_Vtbl);
 177     ICOM_INIT_INTERFACE(This, IDirectDraw4, IDirectDraw4_Vtbl);
 178     ICOM_INIT_INTERFACE(This, IDirectDraw7, IDirectDraw7_Vtbl);
 179     ICOM_INIT_INTERFACE(This, IDirect3D,  IDirect3D1_Vtbl);
 180     ICOM_INIT_INTERFACE(This, IDirect3D2, IDirect3D2_Vtbl);
 181     ICOM_INIT_INTERFACE(This, IDirect3D3, IDirect3D3_Vtbl);
 182     ICOM_INIT_INTERFACE(This, IDirect3D7, IDirect3D7_Vtbl);
 183     This->device_parent_vtbl = &ddraw_wined3d_device_parent_vtbl;
 184
 185     /* See comments in IDirectDrawImpl_CreateNewSurface for a description
 186      * of this member.
 187      * Read from a registry key, should add a winecfg option later
 188      */
 189     This->ImplType = DefaultSurfaceType;
 190
 191     /* Get the current screen settings */
 192     hDC = GetDC(0);
 193     This->orig_bpp = GetDeviceCaps(hDC, BITSPIXEL) * GetDeviceCaps(hDC, PLANES);
 194     ReleaseDC(0, hDC);
 195     This->orig_width = GetSystemMetrics(SM_CXSCREEN);
 196     This->orig_height = GetSystemMetrics(SM_CYSCREEN);
 197
 198     if (!LoadWineD3D())
 199     {
 200         ERR("Couldn't load WineD3D - OpenGL libs not present?\n");
 201         hr = DDERR_NODIRECTDRAWSUPPORT;
 202         goto err_out;
 203     }
 204
 205     /* Initialize WineD3D
 206      *
 207      * All Rendering (2D and 3D) is relayed to WineD3D,
 208      * but DirectDraw specific management, like DDSURFACEDESC and DDPIXELFORMAT
 209      * structure handling is handled in this lib.
 210      */
 211     wineD3D = pWineDirect3DCreate(7 /* DXVersion */, (IUnknown *) This /* Parent */);
 212     if(!wineD3D)
 213     {
 214         ERR("Failed to initialise WineD3D\n");
 215         hr = E_OUTOFMEMORY;
 216         goto err_out;
 217     }
 218     This->wineD3D = wineD3D;
 219     TRACE("WineD3D created at %p\n", wineD3D);
 220
 221     /* Initialized member...
 222      *
 223      * It is set to false at creation time, and set to true in
 224      * IDirectDraw7::Initialize. Its sole purpose is to return DD_OK on
 225      * initialize only once
 226      */
 227     This->initialized = FALSE;
 228
 229     /* Initialize WineD3DDevice
 230      *
 231      * It is used for screen setup, surface and palette creation
 232      * When a Direct3DDevice7 is created, the D3D capabilities of WineD3D are
 233      * initialized
 234      */
 235     hr = IWineD3D_CreateDevice(wineD3D, 0 /* D3D_ADAPTER_DEFAULT */, devicetype, NULL /* FocusWindow, don't know yet */,
 236             0 /* BehaviorFlags */, (IUnknown *)ICOM_INTERFACE(This, IDirectDraw7),
 237             (IWineD3DDeviceParent *)&This->device_parent_vtbl, &wineD3DDevice);
 238     if(FAILED(hr))
 239     {
 240         ERR("Failed to create a wineD3DDevice, result = %x\n", hr);
 241         goto err_out;
 242     }
 243     This->wineD3DDevice = wineD3DDevice;
 244     TRACE("wineD3DDevice created at %p\n", This->wineD3DDevice);
 245
 246     /* Register the window class
 247      *
 248      * It is used to create a hidden window for D3D
 249      * rendering, if the application didn't pass one.
 250      * It can also be used for Creating a device window
 251      * from SetCooperativeLevel
 252      *
 253      * The name: DDRAW_<address>. The classname is
 254      * 32 bit long, so a 64 bit address will fit nicely
 255      * (Will this be compiled for 64 bit anyway?)
 256      *
 257      */
 258     sprintf(This->classname, "DDRAW_%p", This);
 259
 260     memset(&This->wnd_class, 0, sizeof(This->wnd_class));
 261     This->wnd_class.style = CS_HREDRAW | CS_VREDRAW;
 262     This->wnd_class.lpfnWndProc = DefWindowProcA;
 263     This->wnd_class.cbClsExtra = 0;
 264     This->wnd_class.cbWndExtra = 0;
 265     This->wnd_class.hInstance = GetModuleHandleA(0);
 266     This->wnd_class.hIcon = 0;
 267     This->wnd_class.hCursor = 0;
 268     This->wnd_class.hbrBackground = GetStockObject(BLACK_BRUSH);
 269     This->wnd_class.lpszMenuName = NULL;
 270     This->wnd_class.lpszClassName = This->classname;
 271     if(!RegisterClassA(&This->wnd_class))
 272     {
 273         ERR("RegisterClassA failed!\n");
 274         goto err_out;
 275     }
 276
 277     /* Get the amount of video memory */
 278     This->total_vidmem = IWineD3DDevice_GetAvailableTextureMem(This->wineD3DDevice);
 279
 280     list_init(&This->surface_list);
 281     list_add_head(&global_ddraw_list, &This->ddraw_list_entry);
 282
 283     /* Call QueryInterface to get the pointer to the requested interface. This also initializes
 284      * The required refcount
 285      */
 286     hr = IDirectDraw7_QueryInterface( ICOM_INTERFACE(This, IDirectDraw7), iid, DD);
 287     if(SUCCEEDED(hr)) return DD_OK;
 288
 289 err_out:
 290     /* Let's hope we never need this ;) */
 291     if(wineD3DDevice) IWineD3DDevice_Release(wineD3DDevice);
 292     if(wineD3D) IWineD3D_Release(wineD3D);
 293     if(This) HeapFree(GetProcessHeap(), 0, This->decls);
 294     HeapFree(GetProcessHeap(), 0, This);
 295     return hr;
 296 }
 297
 298 /***********************************************************************
 299  * DirectDrawCreate (DDRAW.@)
 300  *
 301  * Creates legacy DirectDraw Interfaces. Can't create IDirectDraw7
 302  * interfaces in theory
 303  *
 304  * Arguments, return values: See DDRAW_Create
 305  *
 306  ***********************************************************************/
 307 HRESULT WINAPI
 308 DirectDrawCreate(GUID *GUID,
 309                  LPDIRECTDRAW *DD,
 310                  IUnknown *UnkOuter)
 311 {
 312     HRESULT hr;
 313     TRACE("(%s,%p,%p)\n", debugstr_guid(GUID), DD, UnkOuter);
 314
 315     EnterCriticalSection(&ddraw_cs);
 316     hr = DDRAW_Create(GUID, (void **) DD, UnkOuter, &IID_IDirectDraw);
 317     LeaveCriticalSection(&ddraw_cs);
 318     return hr;
 319 }
 320
 321 /***********************************************************************
 322  * DirectDrawCreateEx (DDRAW.@)
 323  *
 324  * Only creates new IDirectDraw7 interfaces, supposed to fail if legacy
 325  * interfaces are requested.
 326  *
 327  * Arguments, return values: See DDRAW_Create
 328  *
 329  ***********************************************************************/
 330 HRESULT WINAPI
 331 DirectDrawCreateEx(GUID *GUID,
 332                    LPVOID *DD,
 333                    REFIID iid,
 334                    IUnknown *UnkOuter)
 335 {
 336     HRESULT hr;
 337     TRACE("(%s,%p,%s,%p)\n", debugstr_guid(GUID), DD, debugstr_guid(iid), UnkOuter);
 338
 339     if (!IsEqualGUID(iid, &IID_IDirectDraw7))
 340         return DDERR_INVALIDPARAMS;
 341
 342     EnterCriticalSection(&ddraw_cs);
 343     hr = DDRAW_Create(GUID, DD, UnkOuter, iid);
 344     LeaveCriticalSection(&ddraw_cs);
 345     return hr;
 346 }
 347
 348 /***********************************************************************
 349  * DirectDrawEnumerateA (DDRAW.@)
 350  *
 351  * Enumerates legacy ddraw drivers, ascii version. We only have one
 352  * driver, which relays to WineD3D. If we were sufficiently cool,
 353  * we could offer various interfaces, which use a different default surface
 354  * implementation, but I think it's better to offer this choice in
 355  * winecfg, because some apps use the default driver, so we would need
 356  * a winecfg option anyway, and there shouldn't be 2 ways to set one setting
 357  *
 358  * Arguments:
 359  *  Callback: Callback function from the app
 360  *  Context: Argument to the call back.
 361  *
 362  * Returns:
 363  *  DD_OK on success
 364  *  E_INVALIDARG if the Callback caused a page fault
 365  *
 366  *
 367  ***********************************************************************/
 368 HRESULT WINAPI
 369 DirectDrawEnumerateA(LPDDENUMCALLBACKA Callback,
 370                      LPVOID Context)
 371 {
 372     BOOL stop = FALSE;
 373
 374     TRACE(" Enumerating default DirectDraw HAL interface\n");
 375     /* We only have one driver */
 376     __TRY
 377     {
 378         static CHAR driver_desc[] = "DirectDraw HAL",
 379         driver_name[] = "display";
 380
 381         stop = !Callback(NULL, driver_desc, driver_name, Context);
 382     }
 383     __EXCEPT_PAGE_FAULT
 384     {
 385         return E_INVALIDARG;
 386     }
 387     __ENDTRY
 388
 389     TRACE(" End of enumeration\n");
 390     return DD_OK;
 391 }
 392
 393 /***********************************************************************
 394  * DirectDrawEnumerateExA (DDRAW.@)
 395  *
 396  * Enumerates DirectDraw7 drivers, ascii version. See
 397  * the comments above DirectDrawEnumerateA for more details.
 398  *
 399  * The Flag member is not supported right now.
 400  *
 401  ***********************************************************************/
 402 HRESULT WINAPI
 403 DirectDrawEnumerateExA(LPDDENUMCALLBACKEXA Callback,
 404                        LPVOID Context,
 405                        DWORD Flags)
 406 {
 407     BOOL stop = FALSE;
 408     TRACE("Enumerating default DirectDraw HAL interface\n");
 409
 410     /* We only have one driver by now */
 411     __TRY
 412     {
 413         static CHAR driver_desc[] = "DirectDraw HAL",
 414         driver_name[] = "display";
 415
 416         /* QuickTime expects the description "DirectDraw HAL" */
 417         stop = !Callback(NULL, driver_desc, driver_name, Context, 0);
 418     }
 419     __EXCEPT_PAGE_FAULT
 420     {
 421         return E_INVALIDARG;
 422     }
 423     __ENDTRY;
 424
 425     TRACE("End of enumeration\n");
 426     return DD_OK;
 427 }
 428
 429 /***********************************************************************
 430  * DirectDrawEnumerateW (DDRAW.@)
 431  *
 432  * Enumerates legacy drivers, unicode version. See
 433  * the comments above DirectDrawEnumerateA for more details.
 434  *
 435  * The Flag member is not supported right now.
 436  *
 437  ***********************************************************************/
 438
 439 /***********************************************************************
 440  * DirectDrawEnumerateExW (DDRAW.@)
 441  *
 442  * Enumerates DirectDraw7 drivers, unicode version. See
 443  * the comments above DirectDrawEnumerateA for more details.
 444  *
 445  * The Flag member is not supported right now.
 446  *
 447  ***********************************************************************/
 448
 449 /***********************************************************************
 450  * Classfactory implementation.
 451  ***********************************************************************/
 452
 453 /***********************************************************************
 454  * CF_CreateDirectDraw
 455  *
 456  * DDraw creation function for the class factory
 457  *
 458  * Params:
 459  *  UnkOuter: Set to NULL
 460  *  iid: ID of the wanted interface
 461  *  obj: Address to pass the interface pointer back
 462  *
 463  * Returns
 464  *  DD_OK / DDERR*, see DDRAW_Create
 465  *
 466  ***********************************************************************/
 467 static HRESULT
 468 CF_CreateDirectDraw(IUnknown* UnkOuter, REFIID iid,
 469                     void **obj)
 470 {
 471     HRESULT hr;
 472
 473     TRACE("(%p,%s,%p)\n", UnkOuter, debugstr_guid(iid), obj);
 474
 475     EnterCriticalSection(&ddraw_cs);
 476     hr = DDRAW_Create(NULL, obj, UnkOuter, iid);
 477     LeaveCriticalSection(&ddraw_cs);
 478     return hr;
 479 }
 480
 481 /***********************************************************************
 482  * CF_CreateDirectDraw
 483  *
 484  * Clipper creation function for the class factory
 485  *
 486  * Params:
 487  *  UnkOuter: Set to NULL
 488  *  iid: ID of the wanted interface
 489  *  obj: Address to pass the interface pointer back
 490  *
 491  * Returns
 492  *  DD_OK / DDERR*, see DDRAW_Create
 493  *
 494  ***********************************************************************/
 495 static HRESULT
 496 CF_CreateDirectDrawClipper(IUnknown* UnkOuter, REFIID riid,
 497                               void **obj)
 498 {
 499     HRESULT hr;
 500     IDirectDrawClipper *Clip;
 501
 502     EnterCriticalSection(&ddraw_cs);
 503     hr = DirectDrawCreateClipper(0, &Clip, UnkOuter);
 504     if (hr != DD_OK)
 505     {
 506         LeaveCriticalSection(&ddraw_cs);
 507         return hr;
 508     }
 509
 510     hr = IDirectDrawClipper_QueryInterface(Clip, riid, obj);
 511     IDirectDrawClipper_Release(Clip);
 512
 513     LeaveCriticalSection(&ddraw_cs);
 514     return hr;
 515 }
 516
 517 static const struct object_creation_info object_creation[] =
 518 {
 519     { &CLSID_DirectDraw,        CF_CreateDirectDraw },
 520     { &CLSID_DirectDraw7,       CF_CreateDirectDraw },
 521     { &CLSID_DirectDrawClipper, CF_CreateDirectDrawClipper }
 522 };
 523
 524 /*******************************************************************************
 525  * IDirectDrawClassFactory::QueryInterface
 526  *
 527  * QueryInterface for the class factory
 528  *
 529  * PARAMS
 530  *    riid   Reference to identifier of queried interface
 531  *    ppv    Address to return the interface pointer at
 532  *
 533  * RETURNS
 534  *    Success: S_OK
 535  *    Failure: E_NOINTERFACE
 536  *
 537  *******************************************************************************/
 538 static HRESULT WINAPI
 539 IDirectDrawClassFactoryImpl_QueryInterface(IClassFactory *iface,
 540                     REFIID riid,
 541                     void **obj)
 542 {
 543     ICOM_THIS_FROM(IClassFactoryImpl, IClassFactory, iface);
 544
 545     TRACE("(%p)->(%s,%p)\n", This, debugstr_guid(riid), obj);
 546
 547     if (IsEqualGUID(riid, &IID_IUnknown)
 548         || IsEqualGUID(riid, &IID_IClassFactory))
 549     {
 550         IClassFactory_AddRef(iface);
 551         *obj = This;
 552         return S_OK;
 553     }
 554
 555     WARN("(%p)->(%s,%p),not found\n",This,debugstr_guid(riid),obj);
 556     return E_NOINTERFACE;
 557 }
 558
 559 /*******************************************************************************
 560  * IDirectDrawClassFactory::AddRef
 561  *
 562  * AddRef for the class factory
 563  *
 564  * RETURNS
 565  *  The new refcount
 566  *
 567  *******************************************************************************/
 568 static ULONG WINAPI
 569 IDirectDrawClassFactoryImpl_AddRef(IClassFactory *iface)
 570 {
 571     ICOM_THIS_FROM(IClassFactoryImpl, IClassFactory, iface);
 572     ULONG ref = InterlockedIncrement(&This->ref);
 573
 574     TRACE("(%p)->() incrementing from %d.\n", This, ref - 1);
 575
 576     return ref;
 577 }
 578
 579 /*******************************************************************************
 580  * IDirectDrawClassFactory::Release
 581  *
 582  * Release for the class factory. If the refcount falls to 0, the object
 583  * is destroyed
 584  *
 585  * RETURNS
 586  *  The new refcount
 587  *
 588  *******************************************************************************/
 589 static ULONG WINAPI
 590 IDirectDrawClassFactoryImpl_Release(IClassFactory *iface)
 591 {
 592     ICOM_THIS_FROM(IClassFactoryImpl, IClassFactory, iface);
 593     ULONG ref = InterlockedDecrement(&This->ref);
 594     TRACE("(%p)->() decrementing from %d.\n", This, ref+1);
 595
 596     if (ref == 0)
 597         HeapFree(GetProcessHeap(), 0, This);
 598
 599     return ref;
 600 }
 601
 602
 603 /*******************************************************************************
 604  * IDirectDrawClassFactory::CreateInstance
 605  *
 606  * What is this? Seems to create DirectDraw objects...
 607  *
 608  * Params
 609  *  The usual things???
 610  *
 611  * RETURNS
 612  *  ???
 613  *
 614  *******************************************************************************/
 615 static HRESULT WINAPI
 616 IDirectDrawClassFactoryImpl_CreateInstance(IClassFactory *iface,
 617                                            IUnknown *UnkOuter,
 618                                            REFIID riid,
 619                                            void **obj)
 620 {
 621     ICOM_THIS_FROM(IClassFactoryImpl, IClassFactory, iface);
 622
 623     TRACE("(%p)->(%p,%s,%p)\n",This,UnkOuter,debugstr_guid(riid),obj);
 624
 625     return This->pfnCreateInstance(UnkOuter, riid, obj);
 626 }
 627
 628 /*******************************************************************************
 629  * IDirectDrawClassFactory::LockServer
 630  *
 631  * What is this?
 632  *
 633  * Params
 634  *  ???
 635  *
 636  * RETURNS
 637  *  S_OK, because it's a stub
 638  *
 639  *******************************************************************************/
 640 static HRESULT WINAPI
 641 IDirectDrawClassFactoryImpl_LockServer(IClassFactory *iface,BOOL dolock)
 642 {
 643     ICOM_THIS_FROM(IClassFactoryImpl, IClassFactory, iface);
 644     FIXME("(%p)->(%d),stub!\n",This,dolock);
 645     return S_OK;
 646 }
 647
 648 /*******************************************************************************
 649  * The class factory VTable
 650  *******************************************************************************/
 651 static const IClassFactoryVtbl IClassFactory_Vtbl =
 652 {
 653     IDirectDrawClassFactoryImpl_QueryInterface,
 654     IDirectDrawClassFactoryImpl_AddRef,
 655     IDirectDrawClassFactoryImpl_Release,
 656     IDirectDrawClassFactoryImpl_CreateInstance,
 657     IDirectDrawClassFactoryImpl_LockServer
 658 };
 659
 660 /*******************************************************************************
 661  * DllGetClassObject [DDRAW.@]
 662  * Retrieves class object from a DLL object
 663  *
 664  * NOTES
 665  *    Docs say returns STDAPI
 666  *
 667  * PARAMS
 668  *    rclsid [I] CLSID for the class object
 669  *    riid   [I] Reference to identifier of interface for class object
 670  *    ppv    [O] Address of variable to receive interface pointer for riid
 671  *
 672  * RETURNS
 673  *    Success: S_OK
 674  *    Failure: CLASS_E_CLASSNOTAVAILABLE, E_OUTOFMEMORY, E_INVALIDARG,
 675  *             E_UNEXPECTED
 676  */
 677 HRESULT WINAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv)
 678 {
 679     unsigned int i;
 680     IClassFactoryImpl *factory;
 681
 682     TRACE("(%s,%s,%p)\n", debugstr_guid(rclsid), debugstr_guid(riid), ppv);
 683
 684     if ( !IsEqualGUID( &IID_IClassFactory, riid )
 685          && ! IsEqualGUID( &IID_IUnknown, riid) )
 686         return E_NOINTERFACE;
 687
 688     for (i=0; i < sizeof(object_creation)/sizeof(object_creation[0]); i++)
 689     {
 690         if (IsEqualGUID(object_creation[i].clsid, rclsid))
 691             break;
 692     }
 693
 694     if (i == sizeof(object_creation)/sizeof(object_creation[0]))
 695     {
 696         FIXME("%s: no class found.\n", debugstr_guid(rclsid));
 697         return CLASS_E_CLASSNOTAVAILABLE;
 698     }
 699
 700     factory = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*factory));
 701     if (factory == NULL) return E_OUTOFMEMORY;
 702
 703     ICOM_INIT_INTERFACE(factory, IClassFactory, IClassFactory_Vtbl);
 704     factory->ref = 1;
 705
 706     factory->pfnCreateInstance = object_creation[i].pfnCreateInstance;
 707
 708     *ppv = ICOM_INTERFACE(factory, IClassFactory);
 709     return S_OK;
 710 }
 711
 712
 713 /*******************************************************************************
 714  * DllCanUnloadNow [DDRAW.@]  Determines whether the DLL is in use.
 715  *
 716  * RETURNS
 717  *    Success: S_OK
 718  *    Failure: S_FALSE
 719  */
 720 HRESULT WINAPI DllCanUnloadNow(void)
 721 {
 722     HRESULT hr;
 723     FIXME("(void): stub\n");
 724
 725     EnterCriticalSection(&ddraw_cs);
 726     hr = S_FALSE;
 727     LeaveCriticalSection(&ddraw_cs);
 728
 729     return hr;
 730 }
 731
 732 /*******************************************************************************
 733  * DestroyCallback
 734  *
 735  * Callback function for the EnumSurfaces call in DllMain.
 736  * Dumps some surface info and releases the surface
 737  *
 738  * Params:
 739  *  surf: The enumerated surface
 740  *  desc: it's description
 741  *  context: Pointer to the ddraw impl
 742  *
 743  * Returns:
 744  *  DDENUMRET_OK;
 745  *******************************************************************************/
 746 static HRESULT WINAPI
 747 DestroyCallback(IDirectDrawSurface7 *surf,
 748                 DDSURFACEDESC2 *desc,
 749                 void *context)
 750 {
 751     IDirectDrawSurfaceImpl *Impl = ICOM_OBJECT(IDirectDrawSurfaceImpl, IDirectDrawSurface7, surf);
 752     IDirectDrawImpl *ddraw = context;
 753     ULONG ref;
 754
 755     ref = IDirectDrawSurface7_Release(surf);  /* For the EnumSurfaces */
 756     WARN("Surface %p has an reference count of %d\n", Impl, ref);
 757
 758     /* Skip surfaces which are attached somewhere or which are
 759      * part of a complex compound. They will get released when destroying
 760      * the root
 761      */
 762     if( (!Impl->is_complex_root) || (Impl->first_attached != Impl) )
 763         return DDENUMRET_OK;
 764     /* Skip our depth stencil surface, it will be released with the render target */
 765     if( Impl == ddraw->DepthStencilBuffer)
 766         return DDENUMRET_OK;
 767
 768     /* Destroy the surface */
 769     while(ref) ref = IDirectDrawSurface7_Release(surf);
 770
 771     return DDENUMRET_OK;
 772 }
 773
 774 /***********************************************************************
 775  * get_config_key
 776  *
 777  * Reads a config key from the registry. Taken from WineD3D
 778  *
 779  ***********************************************************************/
 780 static inline DWORD get_config_key(HKEY defkey, HKEY appkey, const char* name, char* buffer, DWORD size)
 781 {
 782     if (0 != appkey && !RegQueryValueExA( appkey, name, 0, NULL, (LPBYTE) buffer, &size )) return 0;
 783     if (0 != defkey && !RegQueryValueExA( defkey, name, 0, NULL, (LPBYTE) buffer, &size )) return 0;
 784     return ERROR_FILE_NOT_FOUND;
 785 }
 786
 787 /***********************************************************************
 788  * DllMain (DDRAW.0)
 789  *
 790  * Could be used to register DirectDraw drivers, if we have more than
 791  * one. Also used to destroy any objects left at unload if the
 792  * app didn't release them properly(Gothic 2, Diablo 2, Moto racer, ...)
 793  *
 794  ***********************************************************************/
 795 BOOL WINAPI
 796 DllMain(HINSTANCE hInstDLL,
 797         DWORD Reason,
 798         LPVOID lpv)
 799 {
 800     TRACE("(%p,%x,%p)\n", hInstDLL, Reason, lpv);
 801     if (Reason == DLL_PROCESS_ATTACH)
 802     {
 803         char buffer[MAX_PATH+10];
 804         DWORD size = sizeof(buffer);
 805         HKEY hkey = 0;
 806         HKEY appkey = 0;
 807         DWORD len;
 808
 809        /* @@ Wine registry key: HKCU\Software\Wine\Direct3D */
 810        if ( RegOpenKeyA( HKEY_CURRENT_USER, "Software\\Wine\\Direct3D", &hkey ) ) hkey = 0;
 811
 812        len = GetModuleFileNameA( 0, buffer, MAX_PATH );
 813        if (len && len < MAX_PATH)
 814        {
 815             HKEY tmpkey;
 816             /* @@ Wine registry key: HKCU\Software\Wine\AppDefaults\app.exe\Direct3D */
 817             if (!RegOpenKeyA( HKEY_CURRENT_USER, "Software\\Wine\\AppDefaults", &tmpkey ))
 818             {
 819                 char *p, *appname = buffer;
 820                 if ((p = strrchr( appname, '/' ))) appname = p + 1;
 821                 if ((p = strrchr( appname, '\\' ))) appname = p + 1;
 822                 strcat( appname, "\\Direct3D" );
 823                 TRACE("appname = [%s]\n", appname);
 824                 if (RegOpenKeyA( tmpkey, appname, &appkey )) appkey = 0;
 825                 RegCloseKey( tmpkey );
 826             }
 827        }
 828
 829        if ( 0 != hkey || 0 != appkey )
 830        {
 831             if ( !get_config_key( hkey, appkey, "DirectDrawRenderer", buffer, size) )
 832             {
 833                 if (!strcmp(buffer,"gdi"))
 834                 {
 835                     TRACE("Defaulting to GDI surfaces\n");
 836                     DefaultSurfaceType = SURFACE_GDI;
 837                 }
 838                 else if (!strcmp(buffer,"opengl"))
 839                 {
 840                     TRACE("Defaulting to opengl surfaces\n");
 841                     DefaultSurfaceType = SURFACE_OPENGL;
 842                 }
 843                 else
 844                 {
 845                     ERR("Unknown default surface type. Supported are:\n gdi, opengl\n");
 846                 }
 847             }
 848         }
 849
 850         /* On Windows one can force the refresh rate that DirectDraw uses by
 851          * setting an override value in dxdiag.  This is documented in KB315614
 852          * (main article), KB230002, and KB217348.  By comparing registry dumps
 853          * before and after setting the override, we see that the override value
 854          * is stored in HKLM\Software\Microsoft\DirectDraw\ForceRefreshRate as a
 855          * DWORD that represents the refresh rate to force.  We use this
 856          * registry entry to modify the behavior of SetDisplayMode so that Wine
 857          * users can override the refresh rate in a Windows-compatible way.
 858          *
 859          * dxdiag will not accept a refresh rate lower than 40 or higher than
 860          * 120 so this value should be within that range.  It is, of course,
 861          * possible for a user to set the registry entry value directly so that
 862          * assumption might not hold.
 863          *
 864          * There is no current mechanism for setting this value through the Wine
 865          * GUI.  It would be most appropriate to set this value through a dxdiag
 866          * clone, but it may be sufficient to use winecfg.
 867          *
 868          * TODO: Create a mechanism for setting this value through the Wine GUI.
 869          */
 870         if ( !RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Microsoft\\DirectDraw", &hkey ) )
 871         {
 872             DWORD type, data;
 873             size = sizeof(data);
 874             if (!RegQueryValueExA( hkey, "ForceRefreshRate", NULL, &type, (LPBYTE)&data, &size ) && type == REG_DWORD)
 875             {
 876                 TRACE("ForceRefreshRate set; overriding refresh rate to %d Hz\n", data);
 877                 force_refresh_rate = data;
 878             }
 879             RegCloseKey( hkey );
 880         }
 881
 882         DisableThreadLibraryCalls(hInstDLL);
 883     }
 884     else if (Reason == DLL_PROCESS_DETACH)
 885     {
 886         if(!list_empty(&global_ddraw_list))
 887         {
 888             struct list *entry, *entry2;
 889             WARN("There are still existing DirectDraw interfaces. Wine bug or buggy application?\n");
 890
 891             /* We remove elements from this loop */
 892             LIST_FOR_EACH_SAFE(entry, entry2, &global_ddraw_list)
 893             {
 894                 HRESULT hr;
 895                 DDSURFACEDESC2 desc;
 896                 int i;
 897                 IDirectDrawImpl *ddraw = LIST_ENTRY(entry, IDirectDrawImpl, ddraw_list_entry);
 898
 899                 WARN("DDraw %p has a refcount of %d\n", ddraw, ddraw->ref7 + ddraw->ref4 + ddraw->ref3 + ddraw->ref2 + ddraw->ref1);
 900
 901                 /* Add references to each interface to avoid freeing them unexpectedly */
 902                 IDirectDraw_AddRef(ICOM_INTERFACE(ddraw, IDirectDraw));
 903                 IDirectDraw2_AddRef(ICOM_INTERFACE(ddraw, IDirectDraw2));
 904                 IDirectDraw3_AddRef(ICOM_INTERFACE(ddraw, IDirectDraw3));
 905                 IDirectDraw4_AddRef(ICOM_INTERFACE(ddraw, IDirectDraw4));
 906                 IDirectDraw7_AddRef(ICOM_INTERFACE(ddraw, IDirectDraw7));
 907
 908                 /* Does a D3D device exist? Destroy it
 909                     * TODO: Destroy all Vertex buffers, Lights, Materials
 910                     * and execute buffers too
 911                     */
 912                 if(ddraw->d3ddevice)
 913                 {
 914                     WARN("DDraw %p has d3ddevice %p attached\n", ddraw, ddraw->d3ddevice);
 915                     while(IDirect3DDevice7_Release(ICOM_INTERFACE(ddraw->d3ddevice, IDirect3DDevice7)));
 916                 }
 917
 918                 /* Try to release the objects
 919                     * Do an EnumSurfaces to find any hanging surfaces
 920                     */
 921                 memset(&desc, 0, sizeof(desc));
 922                 desc.dwSize = sizeof(desc);
 923                 for(i = 0; i <= 1; i++)
 924                 {
 925                     hr = IDirectDraw7_EnumSurfaces(ICOM_INTERFACE(ddraw, IDirectDraw7),
 926                                                     DDENUMSURFACES_ALL,
 927                                                     &desc,
 928                                                     ddraw,
 929                                                     DestroyCallback);
 930                     if(hr != D3D_OK)
 931                         ERR("(%p) EnumSurfaces failed, prepare for trouble\n", ddraw);
 932                 }
 933
 934                 /* Check the surface count */
 935                 if(ddraw->surfaces > 0)
 936                     ERR("DDraw %p still has %d surfaces attached\n", ddraw, ddraw->surfaces);
 937
 938                 /* Release all hanging references to destroy the objects. This
 939                     * restores the screen mode too
 940                     */
 941                 while(IDirectDraw_Release(ICOM_INTERFACE(ddraw, IDirectDraw)));
 942                 while(IDirectDraw2_Release(ICOM_INTERFACE(ddraw, IDirectDraw2)));
 943                 while(IDirectDraw3_Release(ICOM_INTERFACE(ddraw, IDirectDraw3)));
 944                 while(IDirectDraw4_Release(ICOM_INTERFACE(ddraw, IDirectDraw4)));
 945                 while(IDirectDraw7_Release(ICOM_INTERFACE(ddraw, IDirectDraw7)));
 946             }
 947         }
 948     }
 949
 950     return TRUE;
 951 }