dlls/wined3d/surface_gdi.c

   1 /*
   2  * 2D Surface implementation without OpenGL
   3  *
   4  * Copyright 1997-2000 Marcus Meissner
   5  * Copyright 1998-2000 Lionel Ulmer
   6  * Copyright 2000-2001 TransGaming Technologies Inc.
   7  * Copyright 2002-2005 Jason Edmeades
   8  * Copyright 2002-2003 Raphael Junqueira
   9  * Copyright 2004 Christian Costa
  10  * Copyright 2005 Oliver Stieber
  11  * Copyright 2006-2008 Stefan Dösinger
  12  *
  13  * This library is free software; you can redistribute it and/or
  14  * modify it under the terms of the GNU Lesser General Public
  15  * License as published by the Free Software Foundation; either
  16  * version 2.1 of the License, or (at your option) any later version.
  17  *
  18  * This library is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21  * Lesser General Public License for more details.
  22  *
  23  * You should have received a copy of the GNU Lesser General Public
  24  * License along with this library; if not, write to the Free Software
  25  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  26  */
  27
  28 #include "config.h"
  29 #include "wine/port.h"
  30 #include "wined3d_private.h"
  31
  32 #include <stdio.h>
  33
  34 /* Use the d3d_surface debug channel to have one channel for all surfaces */
  35 WINE_DEFAULT_DEBUG_CHANNEL(d3d_surface);
  36
  37 void surface_gdi_cleanup(IWineD3DSurfaceImpl *This)
  38 {
  39     TRACE("(%p) : Cleaning up.\n", This);
  40
  41     if (This->flags & SFLAG_DIBSECTION)
  42     {
  43         /* Release the DC. */
  44         SelectObject(This->hDC, This->dib.holdbitmap);
  45         DeleteDC(This->hDC);
  46         /* Release the DIB section. */
  47         DeleteObject(This->dib.DIBsection);
  48         This->dib.bitmap_data = NULL;
  49         This->resource.allocatedMemory = NULL;
  50     }
  51
  52     if (This->flags & SFLAG_USERPTR) IWineD3DSurface_SetMem((IWineD3DSurface *)This, NULL);
  53     if (This->overlay_dest) list_remove(&This->overlay_entry);
  54
  55     HeapFree(GetProcessHeap(), 0, This->palette9);
  56
  57     resource_cleanup((IWineD3DResource *)This);
  58 }
  59
  60 /*****************************************************************************
  61  * IWineD3DSurface::Release, GDI version
  62  *
  63  * In general a normal COM Release method, but the GDI version doesn't have
  64  * to destroy all the GL things.
  65  *
  66  *****************************************************************************/
  67 static ULONG WINAPI IWineGDISurfaceImpl_Release(IWineD3DSurface *iface) {
  68     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *)iface;
  69     ULONG ref = InterlockedDecrement(&This->resource.ref);
  70     TRACE("(%p) : Releasing from %d\n", This, ref + 1);
  71
  72     if (!ref)
  73     {
  74         surface_gdi_cleanup(This);
  75
  76         TRACE("(%p) Released.\n", This);
  77         HeapFree(GetProcessHeap(), 0, This);
  78     }
  79
  80     return ref;
  81 }
  82
  83 /*****************************************************************************
  84  * IWineD3DSurface::PreLoad, GDI version
  85  *
  86  * This call is unsupported on GDI surfaces, if it's called something went
  87  * wrong in the parent library. Write an informative warning
  88  *
  89  *****************************************************************************/
  90 static void WINAPI
  91 IWineGDISurfaceImpl_PreLoad(IWineD3DSurface *iface)
  92 {
  93     ERR("(%p): PreLoad is not supported on X11 surfaces!\n", iface);
  94     ERR("(%p): Most likely the parent library did something wrong.\n", iface);
  95     ERR("(%p): Please report to wine-devel\n", iface);
  96 }
  97
  98 /*****************************************************************************
  99  * IWineD3DSurface::UnLoad, GDI version
 100  *
 101  * This call is unsupported on GDI surfaces, if it's called something went
 102  * wrong in the parent library. Write an informative warning.
 103  *
 104  *****************************************************************************/
 105 static void WINAPI IWineGDISurfaceImpl_UnLoad(IWineD3DSurface *iface)
 106 {
 107     ERR("(%p): UnLoad is not supported on X11 surfaces!\n", iface);
 108     ERR("(%p): Most likely the parent library did something wrong.\n", iface);
 109     ERR("(%p): Please report to wine-devel\n", iface);
 110 }
 111
 112 static HRESULT WINAPI IWineGDISurfaceImpl_Map(IWineD3DSurface *iface,
 113         WINED3DLOCKED_RECT *pLockedRect, const RECT *pRect, DWORD Flags)
 114 {
 115     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *)iface;
 116
 117     /* Already locked? */
 118     if (This->flags & SFLAG_LOCKED)
 119     {
 120         WARN("(%p) Surface already locked\n", This);
 121         /* What should I return here? */
 122         return WINED3DERR_INVALIDCALL;
 123     }
 124     This->flags |= SFLAG_LOCKED;
 125
 126     if(!This->resource.allocatedMemory) {
 127         /* This happens on gdi surfaces if the application set a user pointer and resets it.
 128          * Recreate the DIB section
 129          */
 130         IWineD3DBaseSurfaceImpl_CreateDIBSection(iface);
 131         This->resource.allocatedMemory = This->dib.bitmap_data;
 132     }
 133
 134     return IWineD3DBaseSurfaceImpl_Map(iface, pLockedRect, pRect, Flags);
 135 }
 136
 137 static HRESULT WINAPI IWineGDISurfaceImpl_Unmap(IWineD3DSurface *iface)
 138 {
 139     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *)iface;
 140     TRACE("(%p)\n", This);
 141
 142     if (!(This->flags & SFLAG_LOCKED))
 143     {
 144         WARN("Trying to unmap unmapped surfaces %p.\n", iface);
 145         return WINEDDERR_NOTLOCKED;
 146     }
 147
 148     /* Tell the swapchain to update the screen */
 149     if (This->container.type == WINED3D_CONTAINER_SWAPCHAIN)
 150     {
 151         IWineD3DSwapChainImpl *swapchain = This->container.u.swapchain;
 152         if (This == swapchain->front_buffer)
 153         {
 154             x11_copy_to_screen(swapchain, &This->lockedRect);
 155         }
 156     }
 157
 158     This->flags &= ~SFLAG_LOCKED;
 159     memset(&This->lockedRect, 0, sizeof(RECT));
 160     return WINED3D_OK;
 161 }
 162
 163 /*****************************************************************************
 164  * IWineD3DSurface::Flip, GDI version
 165  *
 166  * Flips 2 flipping enabled surfaces. Determining the 2 targets is done by
 167  * the parent library. This implementation changes the data pointers of the
 168  * surfaces and copies the new front buffer content to the screen
 169  *
 170  * Params:
 171  *  override: Flipping target(e.g. back buffer)
 172  *
 173  * Returns:
 174  *  WINED3D_OK on success
 175  *
 176  *****************************************************************************/
 177 static HRESULT WINAPI
 178 IWineGDISurfaceImpl_Flip(IWineD3DSurface *iface,
 179                          IWineD3DSurface *override,
 180                          DWORD Flags)
 181 {
 182     IWineD3DSurfaceImpl *surface = (IWineD3DSurfaceImpl *)iface;
 183     IWineD3DSwapChainImpl *swapchain;
 184     HRESULT hr;
 185
 186     if (surface->container.type != WINED3D_CONTAINER_SWAPCHAIN)
 187     {
 188         ERR("Flipped surface is not on a swapchain\n");
 189         return WINEDDERR_NOTFLIPPABLE;
 190     }
 191
 192     swapchain = surface->container.u.swapchain;
 193     hr = IWineD3DSwapChain_Present((IWineD3DSwapChain *)swapchain,
 194             NULL, NULL, swapchain->win_handle, NULL, 0);
 195
 196     return hr;
 197 }
 198
 199 /*****************************************************************************
 200  * IWineD3DSurface::LoadTexture, GDI version
 201  *
 202  * This is mutually unsupported by GDI surfaces
 203  *
 204  * Returns:
 205  *  D3DERR_INVALIDCALL
 206  *
 207  *****************************************************************************/
 208 static HRESULT WINAPI
 209 IWineGDISurfaceImpl_LoadTexture(IWineD3DSurface *iface, BOOL srgb_mode)
 210 {
 211     ERR("Unsupported on X11 surfaces\n");
 212     return WINED3DERR_INVALIDCALL;
 213 }
 214
 215 static void WINAPI IWineGDISurfaceImpl_BindTexture(IWineD3DSurface *iface, BOOL srgb)
 216 {
 217     ERR("Not supported.\n");
 218 }
 219
 220 static HRESULT WINAPI IWineGDISurfaceImpl_GetDC(IWineD3DSurface *iface, HDC *pHDC) {
 221     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *)iface;
 222     WINED3DLOCKED_RECT lock;
 223     HRESULT hr;
 224     RGBQUAD col[256];
 225
 226     TRACE("(%p)->(%p)\n",This,pHDC);
 227
 228     if (!(This->flags & SFLAG_DIBSECTION))
 229     {
 230         WARN("DC not supported on this surface\n");
 231         return WINED3DERR_INVALIDCALL;
 232     }
 233
 234     if (This->flags & SFLAG_USERPTR)
 235     {
 236         ERR("Not supported on surfaces with an application-provided surfaces\n");
 237         return WINEDDERR_NODC;
 238     }
 239
 240     /* Give more detailed info for ddraw */
 241     if (This->flags & SFLAG_DCINUSE)
 242         return WINEDDERR_DCALREADYCREATED;
 243
 244     /* Can't GetDC if the surface is locked */
 245     if (This->flags & SFLAG_LOCKED)
 246         return WINED3DERR_INVALIDCALL;
 247
 248     memset(&lock, 0, sizeof(lock)); /* To be sure */
 249
 250     /* Should have a DIB section already */
 251
 252     /* Map the surface. */
 253     hr = IWineD3DSurface_Map(iface, &lock, NULL, 0);
 254     if (FAILED(hr))
 255     {
 256         ERR("IWineD3DSurface_Map failed, hr %#x.\n", hr);
 257         /* keep the dib section */
 258         return hr;
 259     }
 260
 261     if (This->resource.format->id == WINED3DFMT_P8_UINT
 262             || This->resource.format->id == WINED3DFMT_P8_UINT_A8_UNORM)
 263     {
 264         unsigned int n;
 265         const PALETTEENTRY *pal = NULL;
 266
 267         if(This->palette) {
 268             pal = This->palette->palents;
 269         } else {
 270             IWineD3DSurfaceImpl *dds_primary;
 271             IWineD3DSwapChainImpl *swapchain;
 272             swapchain = (IWineD3DSwapChainImpl *)This->resource.device->swapchains[0];
 273             dds_primary = swapchain->front_buffer;
 274             if (dds_primary && dds_primary->palette)
 275                 pal = dds_primary->palette->palents;
 276         }
 277
 278         if (pal) {
 279             for (n=0; n<256; n++) {
 280                 col[n].rgbRed   = pal[n].peRed;
 281                 col[n].rgbGreen = pal[n].peGreen;
 282                 col[n].rgbBlue  = pal[n].peBlue;
 283                 col[n].rgbReserved = 0;
 284             }
 285             SetDIBColorTable(This->hDC, 0, 256, col);
 286         }
 287     }
 288
 289     *pHDC = This->hDC;
 290     TRACE("returning %p\n",*pHDC);
 291     This->flags |= SFLAG_DCINUSE;
 292
 293     return WINED3D_OK;
 294 }
 295
 296 static HRESULT WINAPI IWineGDISurfaceImpl_ReleaseDC(IWineD3DSurface *iface, HDC hDC) {
 297     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *)iface;
 298
 299     TRACE("(%p)->(%p)\n",This,hDC);
 300
 301     if (!(This->flags & SFLAG_DCINUSE))
 302         return WINEDDERR_NODC;
 303
 304     if (This->hDC !=hDC) {
 305         WARN("Application tries to release an invalid DC(%p), surface dc is %p\n", hDC, This->hDC);
 306         return WINEDDERR_NODC;
 307     }
 308
 309     /* we locked first, so unlock now */
 310     IWineD3DSurface_Unmap(iface);
 311
 312     This->flags &= ~SFLAG_DCINUSE;
 313
 314     return WINED3D_OK;
 315 }
 316
 317 static HRESULT WINAPI IWineGDISurfaceImpl_RealizePalette(IWineD3DSurface *iface) {
 318     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *) iface;
 319     RGBQUAD col[256];
 320     IWineD3DPaletteImpl *pal = This->palette;
 321     unsigned int n;
 322     TRACE("(%p)\n", This);
 323
 324     if (!pal) return WINED3D_OK;
 325
 326     if (This->flags & SFLAG_DIBSECTION)
 327     {
 328         TRACE("(%p): Updating the hdc's palette\n", This);
 329         for (n=0; n<256; n++) {
 330             col[n].rgbRed   = pal->palents[n].peRed;
 331             col[n].rgbGreen = pal->palents[n].peGreen;
 332             col[n].rgbBlue  = pal->palents[n].peBlue;
 333             col[n].rgbReserved = 0;
 334         }
 335         SetDIBColorTable(This->hDC, 0, 256, col);
 336     }
 337
 338     /* Update the image because of the palette change. Some games like e.g Red Alert
 339        call SetEntries a lot to implement fading. */
 340     /* Tell the swapchain to update the screen */
 341     if (This->container.type == WINED3D_CONTAINER_SWAPCHAIN)
 342     {
 343         IWineD3DSwapChainImpl *swapchain = This->container.u.swapchain;
 344         if (This == swapchain->front_buffer)
 345         {
 346             x11_copy_to_screen(swapchain, NULL);
 347         }
 348     }
 349
 350     return WINED3D_OK;
 351 }
 352
 353 /*****************************************************************************
 354  * IWineD3DSurface::PrivateSetup, GDI version
 355  *
 356  * Initializes the GDI surface, aka creates the DIB section we render to
 357  * The DIB section creation is done by calling GetDC, which will create the
 358  * section and releasing the dc to allow the app to use it. The dib section
 359  * will stay until the surface is released
 360  *
 361  * GDI surfaces do not need to be a power of 2 in size, so the pow2 sizes
 362  * are set to the real sizes to save memory. The NONPOW2 flag is unset to
 363  * avoid confusion in the shared surface code.
 364  *
 365  * Returns:
 366  *  WINED3D_OK on success
 367  *  The return values of called methods on failure
 368  *
 369  *****************************************************************************/
 370 static HRESULT WINAPI
 371 IWineGDISurfaceImpl_PrivateSetup(IWineD3DSurface *iface)
 372 {
 373     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *) iface;
 374     HRESULT hr;
 375
 376     if(This->resource.usage & WINED3DUSAGE_OVERLAY)
 377     {
 378         ERR("(%p) Overlays not yet supported by GDI surfaces\n", This);
 379         return WINED3DERR_INVALIDCALL;
 380     }
 381
 382     /* Sysmem textures have memory already allocated -
 383      * release it, this avoids an unnecessary memcpy
 384      */
 385     hr = IWineD3DBaseSurfaceImpl_CreateDIBSection(iface);
 386     if(SUCCEEDED(hr))
 387     {
 388         HeapFree(GetProcessHeap(), 0, This->resource.heapMemory);
 389         This->resource.heapMemory = NULL;
 390         This->resource.allocatedMemory = This->dib.bitmap_data;
 391     }
 392
 393     /* We don't mind the nonpow2 stuff in GDI */
 394     This->pow2Width = This->currentDesc.Width;
 395     This->pow2Height = This->currentDesc.Height;
 396
 397     return WINED3D_OK;
 398 }
 399
 400 static HRESULT WINAPI IWineGDISurfaceImpl_SetMem(IWineD3DSurface *iface, void *Mem) {
 401     IWineD3DSurfaceImpl *This = (IWineD3DSurfaceImpl *) iface;
 402
 403     /* Render targets depend on their hdc, and we can't create an hdc on a user pointer */
 404     if(This->resource.usage & WINED3DUSAGE_RENDERTARGET) {
 405         ERR("Not supported on render targets\n");
 406         return WINED3DERR_INVALIDCALL;
 407     }
 408
 409     if (This->flags & (SFLAG_LOCKED | SFLAG_DCINUSE))
 410     {
 411         WARN("Surface is locked or the HDC is in use\n");
 412         return WINED3DERR_INVALIDCALL;
 413     }
 414
 415     if(Mem && Mem != This->resource.allocatedMemory) {
 416         void *release = NULL;
 417
 418         /* Do I have to copy the old surface content? */
 419         if (This->flags & SFLAG_DIBSECTION)
 420         {
 421                 /* Release the DC. No need to hold the critical section for the update
 422             * Thread because this thread runs only on front buffers, but this method
 423             * fails for render targets in the check above.
 424                 */
 425             SelectObject(This->hDC, This->dib.holdbitmap);
 426             DeleteDC(This->hDC);
 427             /* Release the DIB section */
 428             DeleteObject(This->dib.DIBsection);
 429             This->dib.bitmap_data = NULL;
 430             This->resource.allocatedMemory = NULL;
 431             This->hDC = NULL;
 432             This->flags &= ~SFLAG_DIBSECTION;
 433         }
 434         else if(!(This->flags & SFLAG_USERPTR))
 435         {
 436             release = This->resource.allocatedMemory;
 437         }
 438         This->resource.allocatedMemory = Mem;
 439         This->flags |= SFLAG_USERPTR | SFLAG_INSYSMEM;
 440
 441         /* Now free the old memory if any */
 442         HeapFree(GetProcessHeap(), 0, release);
 443     }
 444     else if (This->flags & SFLAG_USERPTR)
 445     {
 446         /* Map() and GetDC() will re-create the dib section and allocated memory. */
 447         This->resource.allocatedMemory = NULL;
 448         This->flags &= ~SFLAG_USERPTR;
 449     }
 450     return WINED3D_OK;
 451 }
 452
 453 static WINED3DSURFTYPE WINAPI IWineGDISurfaceImpl_GetImplType(IWineD3DSurface *iface) {
 454     return SURFACE_GDI;
 455 }
 456
 457 static HRESULT WINAPI IWineGDISurfaceImpl_DrawOverlay(IWineD3DSurface *iface) {
 458     FIXME("GDI surfaces can't draw overlays yet\n");
 459     return E_FAIL;
 460 }
 461
 462 /* FIXME: This vtable should not use any IWineD3DSurface* implementation functions,
 463  * only IWineD3DBaseSurface and IWineGDISurface ones.
 464  */
 465 const IWineD3DSurfaceVtbl IWineGDISurface_Vtbl =
 466 {
 467     /* IUnknown */
 468     IWineD3DBaseSurfaceImpl_QueryInterface,
 469     IWineD3DBaseSurfaceImpl_AddRef,
 470     IWineGDISurfaceImpl_Release,
 471     /* IWineD3DResource */
 472     IWineD3DBaseSurfaceImpl_GetParent,
 473     IWineD3DBaseSurfaceImpl_SetPrivateData,
 474     IWineD3DBaseSurfaceImpl_GetPrivateData,
 475     IWineD3DBaseSurfaceImpl_FreePrivateData,
 476     IWineD3DBaseSurfaceImpl_SetPriority,
 477     IWineD3DBaseSurfaceImpl_GetPriority,
 478     IWineGDISurfaceImpl_PreLoad,
 479     IWineGDISurfaceImpl_UnLoad,
 480     IWineD3DBaseSurfaceImpl_GetType,
 481     /* IWineD3DSurface */
 482     IWineD3DBaseSurfaceImpl_GetDesc,
 483     IWineGDISurfaceImpl_Map,
 484     IWineGDISurfaceImpl_Unmap,
 485     IWineGDISurfaceImpl_GetDC,
 486     IWineGDISurfaceImpl_ReleaseDC,
 487     IWineGDISurfaceImpl_Flip,
 488     IWineD3DBaseSurfaceImpl_Blt,
 489     IWineD3DBaseSurfaceImpl_GetBltStatus,
 490     IWineD3DBaseSurfaceImpl_GetFlipStatus,
 491     IWineD3DBaseSurfaceImpl_IsLost,
 492     IWineD3DBaseSurfaceImpl_Restore,
 493     IWineD3DBaseSurfaceImpl_BltFast,
 494     IWineD3DBaseSurfaceImpl_GetPalette,
 495     IWineD3DBaseSurfaceImpl_SetPalette,
 496     IWineGDISurfaceImpl_RealizePalette,
 497     IWineD3DBaseSurfaceImpl_SetColorKey,
 498     IWineD3DBaseSurfaceImpl_GetPitch,
 499     IWineGDISurfaceImpl_SetMem,
 500     IWineD3DBaseSurfaceImpl_SetOverlayPosition,
 501     IWineD3DBaseSurfaceImpl_GetOverlayPosition,
 502     IWineD3DBaseSurfaceImpl_UpdateOverlayZOrder,
 503     IWineD3DBaseSurfaceImpl_UpdateOverlay,
 504     IWineD3DBaseSurfaceImpl_SetClipper,
 505     IWineD3DBaseSurfaceImpl_GetClipper,
 506     /* Internal use: */
 507     IWineGDISurfaceImpl_LoadTexture,
 508     IWineGDISurfaceImpl_BindTexture,
 509     IWineD3DBaseSurfaceImpl_GetData,
 510     IWineD3DBaseSurfaceImpl_SetFormat,
 511     IWineGDISurfaceImpl_PrivateSetup,
 512     IWineGDISurfaceImpl_GetImplType,
 513     IWineGDISurfaceImpl_DrawOverlay
 514 };