wined3d: Get rid of the surface_type parameter to wined3d_check_device_format().
[wine] / 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
30 #define DDRAW_INIT_GUID
31 #include "ddraw_private.h"
32 #include "rpcproxy.h"
33
34 #include "wine/exception.h"
35 #include "winreg.h"
36
37 WINE_DEFAULT_DEBUG_CHANNEL(ddraw);
38
39 /* The configured default surface */
40 enum ddraw_surface_type DefaultSurfaceType = DDRAW_SURFACE_TYPE_OPENGL;
41
42 static struct list global_ddraw_list = LIST_INIT(global_ddraw_list);
43
44 static HINSTANCE instance;
45
46 /* value of ForceRefreshRate */
47 DWORD force_refresh_rate = 0;
48
49 /* Structure for converting DirectDrawEnumerateA to DirectDrawEnumerateExA */
50 struct callback_info
51 {
52     LPDDENUMCALLBACKA callback;
53     void *context;
54 };
55
56 /* Enumeration callback for converting DirectDrawEnumerateA to DirectDrawEnumerateExA */
57 static HRESULT CALLBACK enum_callback(GUID *guid, char *description, char *driver_name,
58                                       void *context, HMONITOR monitor)
59 {
60     const struct callback_info *info = context;
61
62     return info->callback(guid, description, driver_name, info->context);
63 }
64
65 /* Handle table functions */
66 BOOL ddraw_handle_table_init(struct ddraw_handle_table *t, UINT initial_size)
67 {
68     t->entries = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, initial_size * sizeof(*t->entries));
69     if (!t->entries)
70     {
71         ERR("Failed to allocate handle table memory.\n");
72         return FALSE;
73     }
74     t->free_entries = NULL;
75     t->table_size = initial_size;
76     t->entry_count = 0;
77
78     return TRUE;
79 }
80
81 void ddraw_handle_table_destroy(struct ddraw_handle_table *t)
82 {
83     HeapFree(GetProcessHeap(), 0, t->entries);
84     memset(t, 0, sizeof(*t));
85 }
86
87 DWORD ddraw_allocate_handle(struct ddraw_handle_table *t, void *object, enum ddraw_handle_type type)
88 {
89     struct ddraw_handle_entry *entry;
90
91     if (t->free_entries)
92     {
93         DWORD idx = t->free_entries - t->entries;
94         /* Use a free handle */
95         entry = t->free_entries;
96         if (entry->type != DDRAW_HANDLE_FREE)
97         {
98             ERR("Handle %#x (%p) is in the free list, but has type %#x.\n", idx, entry->object, entry->type);
99             return DDRAW_INVALID_HANDLE;
100         }
101         t->free_entries = entry->object;
102         entry->object = object;
103         entry->type = type;
104
105         return idx;
106     }
107
108     if (!(t->entry_count < t->table_size))
109     {
110         /* Grow the table */
111         UINT new_size = t->table_size + (t->table_size >> 1);
112         struct ddraw_handle_entry *new_entries = HeapReAlloc(GetProcessHeap(),
113                 0, t->entries, new_size * sizeof(*t->entries));
114         if (!new_entries)
115         {
116             ERR("Failed to grow the handle table.\n");
117             return DDRAW_INVALID_HANDLE;
118         }
119         t->entries = new_entries;
120         t->table_size = new_size;
121     }
122
123     entry = &t->entries[t->entry_count];
124     entry->object = object;
125     entry->type = type;
126
127     return t->entry_count++;
128 }
129
130 void *ddraw_free_handle(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type)
131 {
132     struct ddraw_handle_entry *entry;
133     void *object;
134
135     if (handle == DDRAW_INVALID_HANDLE || handle >= t->entry_count)
136     {
137         WARN("Invalid handle %#x passed.\n", handle);
138         return NULL;
139     }
140
141     entry = &t->entries[handle];
142     if (entry->type != type)
143     {
144         WARN("Handle %#x (%p) is not of type %#x.\n", handle, entry->object, type);
145         return NULL;
146     }
147
148     object = entry->object;
149     entry->object = t->free_entries;
150     entry->type = DDRAW_HANDLE_FREE;
151     t->free_entries = entry;
152
153     return object;
154 }
155
156 void *ddraw_get_object(struct ddraw_handle_table *t, DWORD handle, enum ddraw_handle_type type)
157 {
158     struct ddraw_handle_entry *entry;
159
160     if (handle == DDRAW_INVALID_HANDLE || handle >= t->entry_count)
161     {
162         WARN("Invalid handle %#x passed.\n", handle);
163         return NULL;
164     }
165
166     entry = &t->entries[handle];
167     if (entry->type != type)
168     {
169         WARN("Handle %#x (%p) is not of type %#x.\n", handle, entry->object, type);
170         return NULL;
171     }
172
173     return entry->object;
174 }
175
176 /***********************************************************************
177  *
178  * Helper function for DirectDrawCreate and friends
179  * Creates a new DDraw interface with the given REFIID
180  *
181  * Interfaces that can be created:
182  *  IDirectDraw, IDirectDraw2, IDirectDraw4, IDirectDraw7
183  *  IDirect3D, IDirect3D2, IDirect3D3, IDirect3D7. (Does Windows return
184  *  IDirect3D interfaces?)
185  *
186  * Arguments:
187  *  guid: ID of the requested driver, NULL for the default driver.
188  *        The GUID can be queried with DirectDrawEnumerate(Ex)A/W
189  *  DD: Used to return the pointer to the created object
190  *  UnkOuter: For aggregation, which is unsupported. Must be NULL
191  *  iid: requested version ID.
192  *
193  * Returns:
194  *  DD_OK if the Interface was created successfully
195  *  CLASS_E_NOAGGREGATION if UnkOuter is not NULL
196  *  E_OUTOFMEMORY if some allocation failed
197  *
198  ***********************************************************************/
199 static HRESULT
200 DDRAW_Create(const GUID *guid,
201              void **DD,
202              IUnknown *UnkOuter,
203              REFIID iid)
204 {
205     enum wined3d_device_type device_type;
206     struct ddraw *ddraw;
207     HRESULT hr;
208
209     TRACE("driver_guid %s, ddraw %p, outer_unknown %p, interface_iid %s.\n",
210             debugstr_guid(guid), DD, UnkOuter, debugstr_guid(iid));
211
212     *DD = NULL;
213
214     /* We don't care about this guids. Well, there's no special guid anyway
215      * OK, we could
216      */
217     if (guid == (GUID *) DDCREATE_EMULATIONONLY)
218     {
219         /* Use the reference device id. This doesn't actually change anything,
220          * WineD3D always uses OpenGL for D3D rendering. One could make it request
221          * indirect rendering
222          */
223         device_type = WINED3D_DEVICE_TYPE_REF;
224     }
225     else if(guid == (GUID *) DDCREATE_HARDWAREONLY)
226     {
227         device_type = WINED3D_DEVICE_TYPE_HAL;
228     }
229     else
230     {
231         device_type = 0;
232     }
233
234     /* DDraw doesn't support aggregation, according to msdn */
235     if (UnkOuter != NULL)
236         return CLASS_E_NOAGGREGATION;
237
238     /* DirectDraw creation comes here */
239     ddraw = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*ddraw));
240     if (!ddraw)
241     {
242         ERR("Out of memory when creating DirectDraw\n");
243         return E_OUTOFMEMORY;
244     }
245
246     hr = ddraw_init(ddraw, device_type);
247     if (FAILED(hr))
248     {
249         WARN("Failed to initialize ddraw object, hr %#x.\n", hr);
250         HeapFree(GetProcessHeap(), 0, ddraw);
251         return hr;
252     }
253
254     hr = IDirectDraw7_QueryInterface(&ddraw->IDirectDraw7_iface, iid, DD);
255     IDirectDraw7_Release(&ddraw->IDirectDraw7_iface);
256     if (SUCCEEDED(hr))
257         list_add_head(&global_ddraw_list, &ddraw->ddraw_list_entry);
258     else
259         WARN("Failed to query interface %s from ddraw object %p.\n", debugstr_guid(iid), ddraw);
260
261     return hr;
262 }
263
264 /***********************************************************************
265  * DirectDrawCreate (DDRAW.@)
266  *
267  * Creates legacy DirectDraw Interfaces. Can't create IDirectDraw7
268  * interfaces in theory
269  *
270  * Arguments, return values: See DDRAW_Create
271  *
272  ***********************************************************************/
273 HRESULT WINAPI DECLSPEC_HOTPATCH DirectDrawCreate(GUID *driver_guid, IDirectDraw **ddraw, IUnknown *outer)
274 {
275     HRESULT hr;
276
277     TRACE("driver_guid %s, ddraw %p, outer %p.\n",
278             debugstr_guid(driver_guid), ddraw, outer);
279
280     wined3d_mutex_lock();
281     hr = DDRAW_Create(driver_guid, (void **)ddraw, outer, &IID_IDirectDraw);
282     wined3d_mutex_unlock();
283
284     if (SUCCEEDED(hr))
285     {
286         if (FAILED(hr = IDirectDraw_Initialize(*ddraw, driver_guid)))
287             IDirectDraw_Release(*ddraw);
288     }
289
290     return hr;
291 }
292
293 /***********************************************************************
294  * DirectDrawCreateEx (DDRAW.@)
295  *
296  * Only creates new IDirectDraw7 interfaces, supposed to fail if legacy
297  * interfaces are requested.
298  *
299  * Arguments, return values: See DDRAW_Create
300  *
301  ***********************************************************************/
302 HRESULT WINAPI DECLSPEC_HOTPATCH
303 DirectDrawCreateEx(GUID *guid,
304                    LPVOID *dd,
305                    REFIID iid,
306                    IUnknown *UnkOuter)
307 {
308     HRESULT hr;
309
310     TRACE("driver_guid %s, ddraw %p, interface_iid %s, outer_unknown %p.\n",
311             debugstr_guid(guid), dd, debugstr_guid(iid), UnkOuter);
312
313     if (!IsEqualGUID(iid, &IID_IDirectDraw7))
314         return DDERR_INVALIDPARAMS;
315
316     wined3d_mutex_lock();
317     hr = DDRAW_Create(guid, dd, UnkOuter, iid);
318     wined3d_mutex_unlock();
319
320     if (SUCCEEDED(hr))
321     {
322         IDirectDraw7 *ddraw7 = *(IDirectDraw7 **)dd;
323         hr = IDirectDraw7_Initialize(ddraw7, guid);
324         if (FAILED(hr))
325             IDirectDraw7_Release(ddraw7);
326     }
327
328     return hr;
329 }
330
331 /***********************************************************************
332  * DirectDrawEnumerateA (DDRAW.@)
333  *
334  * Enumerates legacy ddraw drivers, ascii version. We only have one
335  * driver, which relays to WineD3D. If we were sufficiently cool,
336  * we could offer various interfaces, which use a different default surface
337  * implementation, but I think it's better to offer this choice in
338  * winecfg, because some apps use the default driver, so we would need
339  * a winecfg option anyway, and there shouldn't be 2 ways to set one setting
340  *
341  * Arguments:
342  *  Callback: Callback function from the app
343  *  Context: Argument to the call back.
344  *
345  * Returns:
346  *  DD_OK on success
347  *  E_INVALIDARG if the Callback caused a page fault
348  *
349  *
350  ***********************************************************************/
351 HRESULT WINAPI DirectDrawEnumerateA(LPDDENUMCALLBACKA callback, void *context)
352 {
353     struct callback_info info;
354
355     TRACE("callback %p, context %p.\n", callback, context);
356
357     info.callback = callback;
358     info.context = context;
359     return DirectDrawEnumerateExA(enum_callback, &info, 0x0);
360 }
361
362 /***********************************************************************
363  * DirectDrawEnumerateExA (DDRAW.@)
364  *
365  * Enumerates DirectDraw7 drivers, ascii version. See
366  * the comments above DirectDrawEnumerateA for more details.
367  *
368  * The Flag member is not supported right now.
369  *
370  ***********************************************************************/
371 HRESULT WINAPI DirectDrawEnumerateExA(LPDDENUMCALLBACKEXA callback, void *context, DWORD flags)
372 {
373     struct wined3d *wined3d;
374     DWORD wined3d_flags;
375
376     TRACE("callback %p, context %p, flags %#x.\n", callback, context, flags);
377
378     if (flags & ~(DDENUM_ATTACHEDSECONDARYDEVICES |
379                   DDENUM_DETACHEDSECONDARYDEVICES |
380                   DDENUM_NONDISPLAYDEVICES))
381         return DDERR_INVALIDPARAMS;
382
383     if (flags)
384         FIXME("flags 0x%08x not handled\n", flags);
385
386     wined3d_flags = WINED3D_LEGACY_DEPTH_BIAS;
387     if (DefaultSurfaceType != DDRAW_SURFACE_TYPE_OPENGL)
388         wined3d_flags |= WINED3D_NO3D;
389
390     TRACE("Enumerating ddraw interfaces\n");
391     if (!(wined3d = wined3d_create(7, wined3d_flags)))
392     {
393         if ((wined3d_flags & WINED3D_NO3D) || !(wined3d = wined3d_create(7, wined3d_flags | WINED3D_NO3D)))
394         {
395             WARN("Failed to create a wined3d object.\n");
396             return E_FAIL;
397         }
398
399         WARN("Created a wined3d object without 3D support.\n");
400         DefaultSurfaceType = DDRAW_SURFACE_TYPE_GDI;
401     }
402
403     __TRY
404     {
405         /* QuickTime expects the description "DirectDraw HAL" */
406         static CHAR driver_desc[] = "DirectDraw HAL",
407         driver_name[] = "display";
408         struct wined3d_adapter_identifier adapter_id;
409         HRESULT hr = S_OK;
410         UINT adapter = 0;
411         BOOL cont_enum;
412
413         /* The Battle.net System Checker expects both a NULL device and a GUID-based device */
414         TRACE("Default interface: DirectDraw HAL\n");
415         cont_enum = callback(NULL, driver_desc, driver_name, context, 0);
416         for (adapter = 0; SUCCEEDED(hr) && cont_enum; adapter++)
417         {
418             char DriverName[512] = "";
419
420             /* The Battle.net System Checker expects the GetAdapterIdentifier DeviceName to match the
421              * Driver Name, so obtain the DeviceName and GUID from D3D. */
422             memset(&adapter_id, 0x0, sizeof(adapter_id));
423             adapter_id.device_name = DriverName;
424             adapter_id.device_name_size = sizeof(DriverName);
425             wined3d_mutex_lock();
426             hr = wined3d_get_adapter_identifier(wined3d, adapter, 0x0, &adapter_id);
427             wined3d_mutex_unlock();
428             if (SUCCEEDED(hr))
429             {
430                 TRACE("Interface %d: %s\n", adapter, wine_dbgstr_guid(&adapter_id.device_identifier));
431                 cont_enum = callback(&adapter_id.device_identifier, driver_desc,
432                                      adapter_id.device_name, context, 0);
433             }
434         }
435     }
436     __EXCEPT_PAGE_FAULT
437     {
438         wined3d_decref(wined3d);
439         return DDERR_INVALIDPARAMS;
440     }
441     __ENDTRY;
442
443     wined3d_decref(wined3d);
444     TRACE("End of enumeration\n");
445     return DD_OK;
446 }
447
448 /***********************************************************************
449  * DirectDrawEnumerateW (DDRAW.@)
450  *
451  * Enumerates legacy drivers, unicode version.
452  * This function is not implemented on Windows.
453  *
454  ***********************************************************************/
455 HRESULT WINAPI DirectDrawEnumerateW(LPDDENUMCALLBACKW callback, void *context)
456 {
457     TRACE("callback %p, context %p.\n", callback, context);
458
459     if (!callback)
460         return DDERR_INVALIDPARAMS;
461     else
462         return DDERR_UNSUPPORTED;
463 }
464
465 /***********************************************************************
466  * DirectDrawEnumerateExW (DDRAW.@)
467  *
468  * Enumerates DirectDraw7 drivers, unicode version.
469  * This function is not implemented on Windows.
470  *
471  ***********************************************************************/
472 HRESULT WINAPI DirectDrawEnumerateExW(LPDDENUMCALLBACKEXW callback, void *context, DWORD flags)
473 {
474     TRACE("callback %p, context %p, flags %#x.\n", callback, context, flags);
475
476     return DDERR_UNSUPPORTED;
477 }
478
479 /***********************************************************************
480  * Classfactory implementation.
481  ***********************************************************************/
482
483 /***********************************************************************
484  * CF_CreateDirectDraw
485  *
486  * DDraw creation function for the class factory
487  *
488  * Params:
489  *  UnkOuter: Set to NULL
490  *  iid: ID of the wanted interface
491  *  obj: Address to pass the interface pointer back
492  *
493  * Returns
494  *  DD_OK / DDERR*, see DDRAW_Create
495  *
496  ***********************************************************************/
497 static HRESULT
498 CF_CreateDirectDraw(IUnknown* UnkOuter, REFIID iid,
499                     void **obj)
500 {
501     HRESULT hr;
502
503     TRACE("outer_unknown %p, riid %s, object %p.\n", UnkOuter, debugstr_guid(iid), obj);
504
505     wined3d_mutex_lock();
506     hr = DDRAW_Create(NULL, obj, UnkOuter, iid);
507     wined3d_mutex_unlock();
508
509     return hr;
510 }
511
512 /***********************************************************************
513  * CF_CreateDirectDraw
514  *
515  * Clipper creation function for the class factory
516  *
517  * Params:
518  *  UnkOuter: Set to NULL
519  *  iid: ID of the wanted interface
520  *  obj: Address to pass the interface pointer back
521  *
522  * Returns
523  *  DD_OK / DDERR*, see DDRAW_Create
524  *
525  ***********************************************************************/
526 static HRESULT
527 CF_CreateDirectDrawClipper(IUnknown* UnkOuter, REFIID riid,
528                               void **obj)
529 {
530     HRESULT hr;
531     IDirectDrawClipper *Clip;
532
533     TRACE("outer_unknown %p, riid %s, object %p.\n", UnkOuter, debugstr_guid(riid), obj);
534
535     wined3d_mutex_lock();
536     hr = DirectDrawCreateClipper(0, &Clip, UnkOuter);
537     if (hr != DD_OK)
538     {
539         wined3d_mutex_unlock();
540         return hr;
541     }
542
543     hr = IDirectDrawClipper_QueryInterface(Clip, riid, obj);
544     IDirectDrawClipper_Release(Clip);
545
546     wined3d_mutex_unlock();
547
548     return hr;
549 }
550
551 static const struct object_creation_info object_creation[] =
552 {
553     { &CLSID_DirectDraw,        CF_CreateDirectDraw },
554     { &CLSID_DirectDraw7,       CF_CreateDirectDraw },
555     { &CLSID_DirectDrawClipper, CF_CreateDirectDrawClipper }
556 };
557
558 struct ddraw_class_factory
559 {
560     IClassFactory IClassFactory_iface;
561
562     LONG ref;
563     HRESULT (*pfnCreateInstance)(IUnknown *pUnkOuter, REFIID iid, LPVOID *ppObj);
564 };
565
566 static inline struct ddraw_class_factory *impl_from_IClassFactory(IClassFactory *iface)
567 {
568     return CONTAINING_RECORD(iface, struct ddraw_class_factory, IClassFactory_iface);
569 }
570
571 /*******************************************************************************
572  * IDirectDrawClassFactory::QueryInterface
573  *
574  * QueryInterface for the class factory
575  *
576  * PARAMS
577  *    riid   Reference to identifier of queried interface
578  *    ppv    Address to return the interface pointer at
579  *
580  * RETURNS
581  *    Success: S_OK
582  *    Failure: E_NOINTERFACE
583  *
584  *******************************************************************************/
585 static HRESULT WINAPI ddraw_class_factory_QueryInterface(IClassFactory *iface, REFIID riid, void **out)
586 {
587     TRACE("iface %p, riid %s, out %p.\n", iface, debugstr_guid(riid), out);
588
589     if (IsEqualGUID(riid, &IID_IUnknown)
590         || IsEqualGUID(riid, &IID_IClassFactory))
591     {
592         IClassFactory_AddRef(iface);
593         *out = iface;
594         return S_OK;
595     }
596
597     WARN("%s not implemented, returning E_NOINTERFACE.\n", debugstr_guid(riid));
598
599     return E_NOINTERFACE;
600 }
601
602 /*******************************************************************************
603  * IDirectDrawClassFactory::AddRef
604  *
605  * AddRef for the class factory
606  *
607  * RETURNS
608  *  The new refcount
609  *
610  *******************************************************************************/
611 static ULONG WINAPI ddraw_class_factory_AddRef(IClassFactory *iface)
612 {
613     struct ddraw_class_factory *factory = impl_from_IClassFactory(iface);
614     ULONG ref = InterlockedIncrement(&factory->ref);
615
616     TRACE("%p increasing refcount to %u.\n", factory, ref);
617
618     return ref;
619 }
620
621 /*******************************************************************************
622  * IDirectDrawClassFactory::Release
623  *
624  * Release for the class factory. If the refcount falls to 0, the object
625  * is destroyed
626  *
627  * RETURNS
628  *  The new refcount
629  *
630  *******************************************************************************/
631 static ULONG WINAPI ddraw_class_factory_Release(IClassFactory *iface)
632 {
633     struct ddraw_class_factory *factory = impl_from_IClassFactory(iface);
634     ULONG ref = InterlockedDecrement(&factory->ref);
635
636     TRACE("%p decreasing refcount to %u.\n", factory, ref);
637
638     if (!ref)
639         HeapFree(GetProcessHeap(), 0, factory);
640
641     return ref;
642 }
643
644
645 /*******************************************************************************
646  * IDirectDrawClassFactory::CreateInstance
647  *
648  * What is this? Seems to create DirectDraw objects...
649  *
650  * Params
651  *  The usual things???
652  *
653  * RETURNS
654  *  ???
655  *
656  *******************************************************************************/
657 static HRESULT WINAPI ddraw_class_factory_CreateInstance(IClassFactory *iface,
658         IUnknown *outer_unknown, REFIID riid, void **out)
659 {
660     struct ddraw_class_factory *factory = impl_from_IClassFactory(iface);
661
662     TRACE("iface %p, outer_unknown %p, riid %s, out %p.\n",
663             iface, outer_unknown, debugstr_guid(riid), out);
664
665     return factory->pfnCreateInstance(outer_unknown, riid, out);
666 }
667
668 /*******************************************************************************
669  * IDirectDrawClassFactory::LockServer
670  *
671  * What is this?
672  *
673  * Params
674  *  ???
675  *
676  * RETURNS
677  *  S_OK, because it's a stub
678  *
679  *******************************************************************************/
680 static HRESULT WINAPI ddraw_class_factory_LockServer(IClassFactory *iface, BOOL dolock)
681 {
682     FIXME("iface %p, dolock %#x stub!\n", iface, dolock);
683
684     return S_OK;
685 }
686
687 /*******************************************************************************
688  * The class factory VTable
689  *******************************************************************************/
690 static const IClassFactoryVtbl IClassFactory_Vtbl =
691 {
692     ddraw_class_factory_QueryInterface,
693     ddraw_class_factory_AddRef,
694     ddraw_class_factory_Release,
695     ddraw_class_factory_CreateInstance,
696     ddraw_class_factory_LockServer
697 };
698
699 /*******************************************************************************
700  * DllGetClassObject [DDRAW.@]
701  * Retrieves class object from a DLL object
702  *
703  * NOTES
704  *    Docs say returns STDAPI
705  *
706  * PARAMS
707  *    rclsid [I] CLSID for the class object
708  *    riid   [I] Reference to identifier of interface for class object
709  *    ppv    [O] Address of variable to receive interface pointer for riid
710  *
711  * RETURNS
712  *    Success: S_OK
713  *    Failure: CLASS_E_CLASSNOTAVAILABLE, E_OUTOFMEMORY, E_INVALIDARG,
714  *             E_UNEXPECTED
715  */
716 HRESULT WINAPI DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv)
717 {
718     struct ddraw_class_factory *factory;
719     unsigned int i;
720
721     TRACE("rclsid %s, riid %s, object %p.\n",
722             debugstr_guid(rclsid), debugstr_guid(riid), ppv);
723
724     if (!IsEqualGUID(&IID_IClassFactory, riid)
725             && !IsEqualGUID(&IID_IUnknown, riid))
726         return E_NOINTERFACE;
727
728     for (i=0; i < sizeof(object_creation)/sizeof(object_creation[0]); i++)
729     {
730         if (IsEqualGUID(object_creation[i].clsid, rclsid))
731             break;
732     }
733
734     if (i == sizeof(object_creation)/sizeof(object_creation[0]))
735     {
736         FIXME("%s: no class found.\n", debugstr_guid(rclsid));
737         return CLASS_E_CLASSNOTAVAILABLE;
738     }
739
740     factory = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*factory));
741     if (factory == NULL) return E_OUTOFMEMORY;
742
743     factory->IClassFactory_iface.lpVtbl = &IClassFactory_Vtbl;
744     factory->ref = 1;
745
746     factory->pfnCreateInstance = object_creation[i].pfnCreateInstance;
747
748     *ppv = factory;
749     return S_OK;
750 }
751
752
753 /*******************************************************************************
754  * DllCanUnloadNow [DDRAW.@]  Determines whether the DLL is in use.
755  *
756  * RETURNS
757  *    Success: S_OK
758  *    Failure: S_FALSE
759  */
760 HRESULT WINAPI DllCanUnloadNow(void)
761 {
762     TRACE("\n");
763
764     return S_FALSE;
765 }
766
767
768 /***********************************************************************
769  *              DllRegisterServer (DDRAW.@)
770  */
771 HRESULT WINAPI DllRegisterServer(void)
772 {
773     return __wine_register_resources( instance );
774 }
775
776 /***********************************************************************
777  *              DllUnregisterServer (DDRAW.@)
778  */
779 HRESULT WINAPI DllUnregisterServer(void)
780 {
781     return __wine_unregister_resources( instance );
782 }
783
784 /*******************************************************************************
785  * DestroyCallback
786  *
787  * Callback function for the EnumSurfaces call in DllMain.
788  * Dumps some surface info and releases the surface
789  *
790  * Params:
791  *  surf: The enumerated surface
792  *  desc: it's description
793  *  context: Pointer to the ddraw impl
794  *
795  * Returns:
796  *  DDENUMRET_OK;
797  *******************************************************************************/
798 static HRESULT WINAPI
799 DestroyCallback(IDirectDrawSurface7 *surf,
800                 DDSURFACEDESC2 *desc,
801                 void *context)
802 {
803     struct ddraw_surface *Impl = impl_from_IDirectDrawSurface7(surf);
804     ULONG ref7, ref4, ref3, ref2, ref1, gamma_count, iface_count;
805
806     ref7 = IDirectDrawSurface7_Release(surf);  /* For the EnumSurfaces */
807     ref4 = Impl->ref4;
808     ref3 = Impl->ref3;
809     ref2 = Impl->ref2;
810     ref1 = Impl->ref1;
811     gamma_count = Impl->gamma_count;
812
813     WARN("Surface %p has an reference counts of 7: %u 4: %u 3: %u 2: %u 1: %u gamma: %u\n",
814             Impl, ref7, ref4, ref3, ref2, ref1, gamma_count);
815
816     /* Skip surfaces which are attached somewhere or which are
817      * part of a complex compound. They will get released when destroying
818      * the root
819      */
820     if( (!Impl->is_complex_root) || (Impl->first_attached != Impl) )
821         return DDENUMRET_OK;
822
823     /* Destroy the surface */
824     iface_count = ddraw_surface_release_iface(Impl);
825     while (iface_count) iface_count = ddraw_surface_release_iface(Impl);
826
827     return DDENUMRET_OK;
828 }
829
830 /***********************************************************************
831  * get_config_key
832  *
833  * Reads a config key from the registry. Taken from WineD3D
834  *
835  ***********************************************************************/
836 static inline DWORD get_config_key(HKEY defkey, HKEY appkey, const char* name, char* buffer, DWORD size)
837 {
838     if (0 != appkey && !RegQueryValueExA( appkey, name, 0, NULL, (LPBYTE) buffer, &size )) return 0;
839     if (0 != defkey && !RegQueryValueExA( defkey, name, 0, NULL, (LPBYTE) buffer, &size )) return 0;
840     return ERROR_FILE_NOT_FOUND;
841 }
842
843 /***********************************************************************
844  * DllMain (DDRAW.0)
845  *
846  * Could be used to register DirectDraw drivers, if we have more than
847  * one. Also used to destroy any objects left at unload if the
848  * app didn't release them properly(Gothic 2, Diablo 2, Moto racer, ...)
849  *
850  ***********************************************************************/
851 BOOL WINAPI
852 DllMain(HINSTANCE hInstDLL,
853         DWORD Reason,
854         LPVOID lpv)
855 {
856     TRACE("(%p,%x,%p)\n", hInstDLL, Reason, lpv);
857     if (Reason == DLL_PROCESS_ATTACH)
858     {
859         static HMODULE ddraw_self;
860         char buffer[MAX_PATH+10];
861         DWORD size = sizeof(buffer);
862         HKEY hkey = 0;
863         HKEY appkey = 0;
864         WNDCLASSA wc;
865         DWORD len;
866
867         /* Register the window class. This is used to create a hidden window
868          * for D3D rendering, if the application didn't pass one. It can also
869          * be used for creating a device window from SetCooperativeLevel(). */
870         wc.style = CS_HREDRAW | CS_VREDRAW;
871         wc.lpfnWndProc = DefWindowProcA;
872         wc.cbClsExtra = 0;
873         wc.cbWndExtra = 0;
874         wc.hInstance = hInstDLL;
875         wc.hIcon = 0;
876         wc.hCursor = 0;
877         wc.hbrBackground = GetStockObject(BLACK_BRUSH);
878         wc.lpszMenuName = NULL;
879         wc.lpszClassName = DDRAW_WINDOW_CLASS_NAME;
880         if (!RegisterClassA(&wc))
881         {
882             ERR("Failed to register ddraw window class, last error %#x.\n", GetLastError());
883             return FALSE;
884         }
885
886        /* @@ Wine registry key: HKCU\Software\Wine\Direct3D */
887        if ( RegOpenKeyA( HKEY_CURRENT_USER, "Software\\Wine\\Direct3D", &hkey ) ) hkey = 0;
888
889        len = GetModuleFileNameA( 0, buffer, MAX_PATH );
890        if (len && len < MAX_PATH)
891        {
892             HKEY tmpkey;
893             /* @@ Wine registry key: HKCU\Software\Wine\AppDefaults\app.exe\Direct3D */
894             if (!RegOpenKeyA( HKEY_CURRENT_USER, "Software\\Wine\\AppDefaults", &tmpkey ))
895             {
896                 char *p, *appname = buffer;
897                 if ((p = strrchr( appname, '/' ))) appname = p + 1;
898                 if ((p = strrchr( appname, '\\' ))) appname = p + 1;
899                 strcat( appname, "\\Direct3D" );
900                 TRACE("appname = [%s]\n", appname);
901                 if (RegOpenKeyA( tmpkey, appname, &appkey )) appkey = 0;
902                 RegCloseKey( tmpkey );
903             }
904        }
905
906        if ( 0 != hkey || 0 != appkey )
907        {
908             if ( !get_config_key( hkey, appkey, "DirectDrawRenderer", buffer, size) )
909             {
910                 if (!strcmp(buffer,"gdi"))
911                 {
912                     TRACE("Defaulting to GDI surfaces\n");
913                     DefaultSurfaceType = DDRAW_SURFACE_TYPE_GDI;
914                 }
915                 else if (!strcmp(buffer,"opengl"))
916                 {
917                     TRACE("Defaulting to opengl surfaces\n");
918                     DefaultSurfaceType = DDRAW_SURFACE_TYPE_OPENGL;
919                 }
920                 else
921                 {
922                     ERR("Unknown default surface type. Supported are:\n gdi, opengl\n");
923                 }
924             }
925         }
926
927         /* On Windows one can force the refresh rate that DirectDraw uses by
928          * setting an override value in dxdiag.  This is documented in KB315614
929          * (main article), KB230002, and KB217348.  By comparing registry dumps
930          * before and after setting the override, we see that the override value
931          * is stored in HKLM\Software\Microsoft\DirectDraw\ForceRefreshRate as a
932          * DWORD that represents the refresh rate to force.  We use this
933          * registry entry to modify the behavior of SetDisplayMode so that Wine
934          * users can override the refresh rate in a Windows-compatible way.
935          *
936          * dxdiag will not accept a refresh rate lower than 40 or higher than
937          * 120 so this value should be within that range.  It is, of course,
938          * possible for a user to set the registry entry value directly so that
939          * assumption might not hold.
940          *
941          * There is no current mechanism for setting this value through the Wine
942          * GUI.  It would be most appropriate to set this value through a dxdiag
943          * clone, but it may be sufficient to use winecfg.
944          *
945          * TODO: Create a mechanism for setting this value through the Wine GUI.
946          */
947         if ( !RegOpenKeyA( HKEY_LOCAL_MACHINE, "Software\\Microsoft\\DirectDraw", &hkey ) )
948         {
949             DWORD type, data;
950             size = sizeof(data);
951             if (!RegQueryValueExA( hkey, "ForceRefreshRate", NULL, &type, (LPBYTE)&data, &size ) && type == REG_DWORD)
952             {
953                 TRACE("ForceRefreshRate set; overriding refresh rate to %d Hz\n", data);
954                 force_refresh_rate = data;
955             }
956             RegCloseKey( hkey );
957         }
958
959         /* Prevent the ddraw module from being unloaded. When switching to
960          * exclusive mode, we replace the window proc of the ddraw window. If
961          * an application would unload ddraw from the WM_DESTROY handler for
962          * that window, it would return to unmapped memory and die. Apparently
963          * this is supposed to work on Windows. We should probably use
964          * GET_MODULE_HANDLE_EX_FLAG_PIN for this, but that's not currently
965          * implemented. */
966         if (!GetModuleHandleExW(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS, (const WCHAR *)&ddraw_self, &ddraw_self))
967             ERR("Failed to get own module handle.\n");
968
969         instance = hInstDLL;
970         DisableThreadLibraryCalls(hInstDLL);
971     }
972     else if (Reason == DLL_PROCESS_DETACH)
973     {
974         if(!list_empty(&global_ddraw_list))
975         {
976             struct list *entry, *entry2;
977             WARN("There are still existing DirectDraw interfaces. Wine bug or buggy application?\n");
978
979             /* We remove elements from this loop */
980             LIST_FOR_EACH_SAFE(entry, entry2, &global_ddraw_list)
981             {
982                 struct ddraw *ddraw = LIST_ENTRY(entry, struct ddraw, ddraw_list_entry);
983                 HRESULT hr;
984                 DDSURFACEDESC2 desc;
985                 int i;
986
987                 WARN("DDraw %p has a refcount of %d\n", ddraw, ddraw->ref7 + ddraw->ref4 + ddraw->ref3 + ddraw->ref2 + ddraw->ref1);
988
989                 /* Add references to each interface to avoid freeing them unexpectedly */
990                 IDirectDraw_AddRef(&ddraw->IDirectDraw_iface);
991                 IDirectDraw2_AddRef(&ddraw->IDirectDraw2_iface);
992                 IDirectDraw4_AddRef(&ddraw->IDirectDraw4_iface);
993                 IDirectDraw7_AddRef(&ddraw->IDirectDraw7_iface);
994
995                 /* Does a D3D device exist? Destroy it
996                     * TODO: Destroy all Vertex buffers, Lights, Materials
997                     * and execute buffers too
998                     */
999                 if(ddraw->d3ddevice)
1000                 {
1001                     WARN("DDraw %p has d3ddevice %p attached\n", ddraw, ddraw->d3ddevice);
1002                     while(IDirect3DDevice7_Release(&ddraw->d3ddevice->IDirect3DDevice7_iface));
1003                 }
1004
1005                 /* Destroy the swapchain after any 3D device. The 3D device
1006                  * cleanup code needs a swapchain. Specifically, it tries to
1007                  * set the current render target to the front buffer. */
1008                 if (ddraw->wined3d_swapchain)
1009                     ddraw_destroy_swapchain(ddraw);
1010
1011                 /* Try to release the objects
1012                     * Do an EnumSurfaces to find any hanging surfaces
1013                     */
1014                 memset(&desc, 0, sizeof(desc));
1015                 desc.dwSize = sizeof(desc);
1016                 for(i = 0; i <= 1; i++)
1017                 {
1018                     hr = IDirectDraw7_EnumSurfaces(&ddraw->IDirectDraw7_iface, DDENUMSURFACES_ALL,
1019                             &desc, ddraw, DestroyCallback);
1020                     if(hr != D3D_OK)
1021                         ERR("(%p) EnumSurfaces failed, prepare for trouble\n", ddraw);
1022                 }
1023
1024                 if (!list_empty(&ddraw->surface_list))
1025                     ERR("DDraw %p still has surfaces attached.\n", ddraw);
1026
1027                 /* Release all hanging references to destroy the objects. This
1028                     * restores the screen mode too
1029                     */
1030                 while(IDirectDraw_Release(&ddraw->IDirectDraw_iface));
1031                 while(IDirectDraw2_Release(&ddraw->IDirectDraw2_iface));
1032                 while(IDirectDraw4_Release(&ddraw->IDirectDraw4_iface));
1033                 while(IDirectDraw7_Release(&ddraw->IDirectDraw7_iface));
1034             }
1035         }
1036
1037         /* Unregister the window class. */
1038         UnregisterClassA(DDRAW_WINDOW_CLASS_NAME, hInstDLL);
1039     }
1040
1041     return TRUE;
1042 }