Remove contexts from WKCACFContextFlusher before destroying them
[WebKit-https.git] / Source / WebCore / platform / graphics / win / WKCACFLayerRenderer.cpp
1 /*
2  * Copyright (C) 2009 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #include "config.h"
27
28 #if USE(ACCELERATED_COMPOSITING)
29
30 #ifndef NDEBUG
31 #define D3D_DEBUG_INFO
32 #endif
33
34 #include "WKCACFLayerRenderer.h"
35
36 #include "PlatformCALayer.h"
37 #include "WKCACFContextFlusher.h"
38 #include "WebCoreInstanceHandle.h"
39 #include <WebKitSystemInterface/WebKitSystemInterface.h>
40 #include <limits.h>
41 #include <wtf/CurrentTime.h>
42 #include <wtf/HashMap.h>
43 #include <wtf/OwnArrayPtr.h>
44 #include <wtf/OwnPtr.h>
45 #include <wtf/PassOwnPtr.h>
46 #include <wtf/StdLibExtras.h>
47 #include <d3d9.h>
48 #include <d3dx9.h>
49
50 using namespace std;
51
52 #pragma comment(lib, "d3d9")
53 #pragma comment(lib, "d3dx9")
54 #ifdef DEBUG_ALL
55 #pragma comment(lib, "QuartzCore_debug")
56 #else
57 #pragma comment(lib, "QuartzCore")
58 #endif
59
60 static IDirect3D9* s_d3d = 0;
61 static IDirect3D9* d3d()
62 {
63     if (s_d3d)
64         return s_d3d;
65
66     if (!LoadLibrary(TEXT("d3d9.dll")))
67         return 0;
68
69     s_d3d = Direct3DCreate9(D3D_SDK_VERSION);
70
71     return s_d3d;
72 }
73
74 inline static CGRect winRectToCGRect(RECT rc)
75 {
76     return CGRectMake(rc.left, rc.top, (rc.right - rc.left), (rc.bottom - rc.top));
77 }
78
79 inline static CGRect winRectToCGRect(RECT rc, RECT relativeToRect)
80 {
81     return CGRectMake(rc.left, (relativeToRect.bottom-rc.bottom), (rc.right - rc.left), (rc.bottom - rc.top));
82 }
83
84 namespace WebCore {
85
86 static D3DPRESENT_PARAMETERS initialPresentationParameters()
87 {
88     D3DPRESENT_PARAMETERS parameters = {0};
89     parameters.Windowed = TRUE;
90     parameters.SwapEffect = D3DSWAPEFFECT_COPY;
91     parameters.BackBufferCount = 1;
92     parameters.BackBufferFormat = D3DFMT_A8R8G8B8;
93     parameters.MultiSampleType = D3DMULTISAMPLE_NONE;
94
95     return parameters;
96 }
97
98 // FIXME: <rdar://6507851> Share this code with CoreAnimation.
99 static bool hardwareCapabilitiesIndicateCoreAnimationSupport(const D3DCAPS9& caps)
100 {
101     // CoreAnimation needs two or more texture units.
102     if (caps.MaxTextureBlendStages < 2)
103         return false;
104
105     // CoreAnimation needs non-power-of-two textures.
106     if ((caps.TextureCaps & D3DPTEXTURECAPS_POW2) && !(caps.TextureCaps & D3DPTEXTURECAPS_NONPOW2CONDITIONAL))
107         return false;
108
109     // CoreAnimation needs vertex shader 2.0 or greater.
110     if (D3DSHADER_VERSION_MAJOR(caps.VertexShaderVersion) < 2)
111         return false;
112
113     // CoreAnimation needs pixel shader 2.0 or greater.
114     if (D3DSHADER_VERSION_MAJOR(caps.PixelShaderVersion) < 2)
115         return false;
116
117     return true;
118 }
119
120 bool WKCACFLayerRenderer::acceleratedCompositingAvailable()
121 {
122     static bool available;
123     static bool tested;
124
125     if (tested)
126         return available;
127
128     tested = true;
129
130     // Initialize available to true since this function will be called from a 
131     // propagation within createRenderer(). We want to be able to return true 
132     // when that happens so that the test can continue.
133     available = true;
134     
135     HMODULE library = LoadLibrary(TEXT("d3d9.dll"));
136     if (!library) {
137         available = false;
138         return available;
139     }
140
141     FreeLibrary(library);
142 #ifdef DEBUG_ALL
143     library = LoadLibrary(TEXT("QuartzCore_debug.dll"));
144 #else
145     library = LoadLibrary(TEXT("QuartzCore.dll"));
146 #endif
147     if (!library) {
148         available = false;
149         return available;
150     }
151
152     FreeLibrary(library);
153
154     // Make a dummy HWND.
155     WNDCLASSEX wcex = { 0 };
156     wcex.cbSize = sizeof(WNDCLASSEX);
157     wcex.lpfnWndProc = DefWindowProc;
158     wcex.hInstance = WebCore::instanceHandle();
159     wcex.lpszClassName = L"CoreAnimationTesterWindowClass";
160     ::RegisterClassEx(&wcex);
161     HWND testWindow = ::CreateWindow(L"CoreAnimationTesterWindowClass", L"CoreAnimationTesterWindow", WS_POPUP, -500, -500, 0, 0, 0, 0, 0, 0);
162
163     if (!testWindow) {
164         available = false;
165         return available;
166     }
167
168     OwnPtr<WKCACFLayerRenderer> testLayerRenderer = WKCACFLayerRenderer::create(0);
169     testLayerRenderer->setHostWindow(testWindow);
170     available = testLayerRenderer->createRenderer();
171     ::DestroyWindow(testWindow);
172
173     return available;
174 }
175
176 PassOwnPtr<WKCACFLayerRenderer> WKCACFLayerRenderer::create(WKCACFLayerRendererClient* client)
177 {
178     if (!acceleratedCompositingAvailable())
179         return 0;
180     return new WKCACFLayerRenderer(client);
181 }
182
183 WKCACFLayerRenderer::WKCACFLayerRenderer(WKCACFLayerRendererClient* client)
184     : m_client(client)
185     , m_mightBeAbleToCreateDeviceLater(true)
186     , m_rootLayer(PlatformCALayer::create(PlatformCALayer::LayerTypeRootLayer, 0))
187     , m_context(wkCACFContextCreate())
188     , m_hostWindow(0)
189     , m_renderTimer(this, &WKCACFLayerRenderer::renderTimerFired)
190     , m_backingStoreDirty(false)
191     , m_mustResetLostDeviceBeforeRendering(false)
192     , m_syncLayerChanges(false)
193 {
194     // Point the CACFContext to this
195     wkCACFContextSetUserData(m_context, this);
196
197     // Under the root layer, we have a clipping layer to clip the content,
198     // that contains a scroll layer that we use for scrolling the content.
199     // The root layer is the size of the client area of the window.
200     // The clipping layer is the size of the WebView client area (window less the scrollbars).
201     // The scroll layer is the size of the root child layer.
202     // Resizing the window will change the bounds of the rootLayer and the clip layer and will not
203     // cause any repositioning.
204     // Scrolling will affect only the position of the scroll layer without affecting the bounds.
205
206     m_rootLayer->setName("WKCACFLayerRenderer rootLayer");
207     m_rootLayer->setAnchorPoint(FloatPoint3D(0, 0, 0));
208     m_rootLayer->setGeometryFlipped(true);
209
210 #ifndef NDEBUG
211     CGColorRef debugColor = CGColorCreateGenericRGB(1, 0, 0, 0.8);
212     m_rootLayer->setBackgroundColor(debugColor);
213     CGColorRelease(debugColor);
214 #endif
215
216     if (m_context)
217         wkCACFContextSetLayer(m_context, m_rootLayer->platformLayer());
218
219 #ifndef NDEBUG
220     char* printTreeFlag = getenv("CA_PRINT_TREE");
221     m_printTree = printTreeFlag && atoi(printTreeFlag);
222 #endif
223 }
224
225 WKCACFLayerRenderer::~WKCACFLayerRenderer()
226 {
227     destroyRenderer();
228     WKCACFContextFlusher::shared().removeContext(m_context);
229     wkCACFContextDestroy(m_context);
230 }
231
232 PlatformCALayer* WKCACFLayerRenderer::rootLayer() const
233 {
234     return m_rootLayer.get();
235 }
236
237 void WKCACFLayerRenderer::addPendingAnimatedLayer(PassRefPtr<PlatformCALayer> layer)
238 {
239     m_pendingAnimatedLayers.add(layer);
240 }
241
242 void WKCACFLayerRenderer::setRootContents(CGImageRef image)
243 {
244     ASSERT(m_rootLayer);
245     m_rootLayer->setContents(image);
246     renderSoon();
247 }
248
249 void WKCACFLayerRenderer::setRootContentsAndDisplay(CGImageRef image)
250 {
251     ASSERT(m_rootLayer);
252     m_rootLayer->setContents(image);
253     paint();
254 }
255
256 void WKCACFLayerRenderer::setRootChildLayer(PlatformCALayer* layer)
257 {
258     m_rootLayer->removeAllSublayers();
259     m_rootChildLayer = layer;
260     if (m_rootChildLayer)
261         m_rootLayer->appendSublayer(m_rootChildLayer.get());
262 }
263    
264 void WKCACFLayerRenderer::layerTreeDidChange()
265 {
266     WKCACFContextFlusher::shared().addContext(m_context);
267     renderSoon();
268 }
269
270 void WKCACFLayerRenderer::setNeedsDisplay(bool sync)
271 {
272     if (!m_syncLayerChanges && sync)
273         m_syncLayerChanges = true;
274
275     ASSERT(m_rootLayer);
276     m_rootLayer->setNeedsDisplay(0);
277     renderSoon();
278 }
279
280 bool WKCACFLayerRenderer::createRenderer()
281 {
282     if (m_d3dDevice || !m_mightBeAbleToCreateDeviceLater)
283         return m_d3dDevice;
284
285     m_mightBeAbleToCreateDeviceLater = false;
286     D3DPRESENT_PARAMETERS parameters = initialPresentationParameters();
287
288     if (!d3d() || !::IsWindow(m_hostWindow))
289         return false;
290
291     // D3D doesn't like to make back buffers for 0 size windows. We skirt this problem if we make the
292     // passed backbuffer width and height non-zero. The window will necessarily get set to a non-zero
293     // size eventually, and then the backbuffer size will get reset.
294     RECT rect;
295     GetClientRect(m_hostWindow, &rect);
296
297     if (rect.left-rect.right == 0 || rect.bottom-rect.top == 0) {
298         parameters.BackBufferWidth = 1;
299         parameters.BackBufferHeight = 1;
300     }
301
302     D3DCAPS9 d3dCaps;
303     if (FAILED(d3d()->GetDeviceCaps(D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, &d3dCaps)))
304         return false;
305
306     DWORD behaviorFlags = D3DCREATE_FPU_PRESERVE;
307     if ((d3dCaps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) && d3dCaps.VertexProcessingCaps)
308         behaviorFlags |= D3DCREATE_HARDWARE_VERTEXPROCESSING;
309     else
310         behaviorFlags |= D3DCREATE_SOFTWARE_VERTEXPROCESSING;
311
312     COMPtr<IDirect3DDevice9> device;
313     if (FAILED(d3d()->CreateDevice(D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, m_hostWindow, behaviorFlags, &parameters, &device))) {
314         // In certain situations (e.g., shortly after waking from sleep), Direct3DCreate9() will
315         // return an IDirect3D9 for which IDirect3D9::CreateDevice will always fail. In case we
316         // have one of these bad IDirect3D9s, get rid of it so we'll fetch a new one the next time
317         // we want to call CreateDevice.
318         s_d3d->Release();
319         s_d3d = 0;
320
321         // Even if we don't have a bad IDirect3D9, in certain situations (e.g., shortly after
322         // waking from sleep), CreateDevice will fail, but will later succeed if called again.
323         m_mightBeAbleToCreateDeviceLater = true;
324
325         return false;
326     }
327
328     // Now that we've created the IDirect3DDevice9 based on the capabilities we
329     // got from the IDirect3D9 global object, we requery the device for its
330     // actual capabilities. The capabilities returned by the device can
331     // sometimes be more complete, for example when using software vertex
332     // processing.
333     D3DCAPS9 deviceCaps;
334     if (FAILED(device->GetDeviceCaps(&deviceCaps)))
335         return false;
336
337     if (!hardwareCapabilitiesIndicateCoreAnimationSupport(deviceCaps))
338         return false;
339
340     m_d3dDevice = device;
341
342     initD3DGeometry();
343
344     wkCACFContextInitializeD3DDevice(m_context, m_d3dDevice.get());
345
346     if (IsWindow(m_hostWindow))
347         m_rootLayer->setBounds(bounds());
348
349     return true;
350 }
351
352 void WKCACFLayerRenderer::destroyRenderer()
353 {
354     wkCACFContextSetLayer(m_context, m_rootLayer->platformLayer());
355
356     m_d3dDevice = 0;
357     if (s_d3d)
358         s_d3d->Release();
359
360     s_d3d = 0;
361     m_rootLayer = 0;
362     m_rootChildLayer = 0;
363
364     m_mightBeAbleToCreateDeviceLater = true;
365 }
366
367 void WKCACFLayerRenderer::resize()
368 {
369     if (!m_d3dDevice)
370         return;
371
372     // Resetting the device might fail here. But that's OK, because if it does it we will attempt to
373     // reset the device the next time we try to render.
374     resetDevice(ChangedWindowSize);
375
376     if (m_rootLayer) {
377         m_rootLayer->setBounds(bounds());
378         WKCACFContextFlusher::shared().flushAllContexts();
379     }
380 }
381
382 static void getDirtyRects(HWND window, Vector<CGRect>& outRects)
383 {
384     ASSERT_ARG(outRects, outRects.isEmpty());
385
386     RECT clientRect;
387     if (!GetClientRect(window, &clientRect))
388         return;
389
390     OwnPtr<HRGN> region(CreateRectRgn(0, 0, 0, 0));
391     int regionType = GetUpdateRgn(window, region.get(), false);
392     if (regionType != COMPLEXREGION) {
393         RECT dirtyRect;
394         if (GetUpdateRect(window, &dirtyRect, false))
395             outRects.append(winRectToCGRect(dirtyRect, clientRect));
396         return;
397     }
398
399     DWORD dataSize = GetRegionData(region.get(), 0, 0);
400     OwnArrayPtr<unsigned char> regionDataBuffer(new unsigned char[dataSize]);
401     RGNDATA* regionData = reinterpret_cast<RGNDATA*>(regionDataBuffer.get());
402     if (!GetRegionData(region.get(), dataSize, regionData))
403         return;
404
405     outRects.resize(regionData->rdh.nCount);
406
407     RECT* rect = reinterpret_cast<RECT*>(regionData->Buffer);
408     for (size_t i = 0; i < outRects.size(); ++i, ++rect)
409         outRects[i] = winRectToCGRect(*rect, clientRect);
410 }
411
412 void WKCACFLayerRenderer::renderTimerFired(Timer<WKCACFLayerRenderer>*)
413 {
414     paint();
415 }
416
417 void WKCACFLayerRenderer::paint()
418 {
419     createRenderer();
420     if (!m_d3dDevice) {
421         if (m_mightBeAbleToCreateDeviceLater)
422             renderSoon();
423         return;
424     }
425
426     if (m_backingStoreDirty) {
427         // If the backing store is still dirty when we are about to draw the
428         // composited content, we need to force the window to paint into the
429         // backing store. The paint will only paint the dirty region that
430         // if being tracked in WebView.
431         UpdateWindow(m_hostWindow);
432         return;
433     }
434
435     Vector<CGRect> dirtyRects;
436     getDirtyRects(m_hostWindow, dirtyRects);
437     render(dirtyRects);
438 }
439
440 void WKCACFLayerRenderer::render(const Vector<CGRect>& windowDirtyRects)
441 {
442     ASSERT(m_d3dDevice);
443
444     if (m_mustResetLostDeviceBeforeRendering && !resetDevice(LostDevice)) {
445         // We can't reset the device right now. Try again soon.
446         renderSoon();
447         return;
448     }
449
450     if (m_client && !m_client->shouldRender()) {
451         renderSoon();
452         return;
453     }
454
455     // Sync the layer if needed
456     if (m_syncLayerChanges) {
457         m_client->syncCompositingState();
458         m_syncLayerChanges = false;
459     }
460
461     // Flush the root layer to the render tree.
462     wkCACFContextFlush(m_context);
463
464     // All pending animations will have been started with the flush. Fire the animationStarted calls
465     double currentTime = WTF::currentTime();
466     double currentMediaTime = CACurrentMediaTime();
467     double t = currentTime + wkCACFContextGetLastCommitTime(m_context) - currentMediaTime;
468     ASSERT(t <= currentTime);
469
470     HashSet<RefPtr<PlatformCALayer> >::iterator end = m_pendingAnimatedLayers.end();
471     for (HashSet<RefPtr<PlatformCALayer> >::iterator it = m_pendingAnimatedLayers.begin(); it != end; ++it) {
472         PlatformCALayerClient* owner = (*it)->owner();
473         owner->platformCALayerAnimationStarted(t);
474     }
475
476     m_pendingAnimatedLayers.clear();
477
478     CGRect bounds = this->bounds();
479
480     // Give the renderer some space to use. This needs to be valid until the
481     // wkCACFContextFinishUpdate() call below.
482     char space[4096];
483     if (!wkCACFContextBeginUpdate(m_context, space, sizeof(space), currentMediaTime, bounds, windowDirtyRects.data(), windowDirtyRects.size()))
484         return;
485
486     HRESULT err = S_OK;
487     CFTimeInterval timeToNextRender = numeric_limits<CFTimeInterval>::infinity();
488
489     do {
490         // FIXME: don't need to clear dirty region if layer tree is opaque.
491
492         WKCACFUpdateRectEnumerator* e = wkCACFContextCopyUpdateRectEnumerator(m_context);
493         if (!e)
494             break;
495
496         Vector<D3DRECT, 64> rects;
497         for (const CGRect* r = wkCACFUpdateRectEnumeratorNextRect(e); r; r = wkCACFUpdateRectEnumeratorNextRect(e)) {
498             D3DRECT rect;
499             rect.x1 = r->origin.x;
500             rect.x2 = rect.x1 + r->size.width;
501             rect.y1 = bounds.origin.y + bounds.size.height - (r->origin.y + r->size.height);
502             rect.y2 = rect.y1 + r->size.height;
503
504             rects.append(rect);
505         }
506         wkCACFUpdateRectEnumeratorRelease(e);
507
508         timeToNextRender = wkCACFContextGetNextUpdateTime(m_context);
509
510         if (rects.isEmpty())
511             break;
512
513         m_d3dDevice->Clear(rects.size(), rects.data(), D3DCLEAR_TARGET, 0, 1.0f, 0);
514
515         m_d3dDevice->BeginScene();
516         wkCACFContextRenderUpdate(m_context);
517         m_d3dDevice->EndScene();
518
519         err = m_d3dDevice->Present(0, 0, 0, 0);
520
521         if (err == D3DERR_DEVICELOST) {
522             wkCACFContextAddUpdateRect(m_context, bounds);
523             if (!resetDevice(LostDevice)) {
524                 // We can't reset the device right now. Try again soon.
525                 renderSoon();
526                 return;
527             }
528         }
529     } while (err == D3DERR_DEVICELOST);
530
531     wkCACFContextFinishUpdate(m_context);
532
533 #ifndef NDEBUG
534     if (m_printTree)
535         m_rootLayer->printTree();
536 #endif
537
538     // If timeToNextRender is not infinity, it means animations are running, so queue up to render again
539     if (timeToNextRender != numeric_limits<CFTimeInterval>::infinity())
540         renderSoon();
541 }
542
543 void WKCACFLayerRenderer::renderSoon()
544 {
545     if (!m_renderTimer.isActive())
546         m_renderTimer.startOneShot(0);
547 }
548
549 CGRect WKCACFLayerRenderer::bounds() const
550 {
551     RECT clientRect;
552     GetClientRect(m_hostWindow, &clientRect);
553
554     return winRectToCGRect(clientRect);
555 }
556
557 void WKCACFLayerRenderer::initD3DGeometry()
558 {
559     ASSERT(m_d3dDevice);
560
561     CGRect bounds = this->bounds();
562
563     float x0 = bounds.origin.x;
564     float y0 = bounds.origin.y;
565     float x1 = x0 + bounds.size.width;
566     float y1 = y0 + bounds.size.height;
567
568     D3DXMATRIXA16 projection;
569     D3DXMatrixOrthoOffCenterRH(&projection, x0, x1, y0, y1, -1.0f, 1.0f);
570
571     m_d3dDevice->SetTransform(D3DTS_PROJECTION, &projection);
572 }
573
574 bool WKCACFLayerRenderer::resetDevice(ResetReason reason)
575 {
576     ASSERT(m_d3dDevice);
577     ASSERT(m_context);
578
579     HRESULT hr = m_d3dDevice->TestCooperativeLevel();
580
581     if (hr == D3DERR_DEVICELOST || hr == D3DERR_DRIVERINTERNALERROR) {
582         // The device cannot be reset at this time. Try again soon.
583         m_mustResetLostDeviceBeforeRendering = true;
584         return false;
585     }
586
587     m_mustResetLostDeviceBeforeRendering = false;
588
589     if (reason == LostDevice && hr == D3D_OK) {
590         // The device wasn't lost after all.
591         return true;
592     }
593
594     // We can reset the device.
595
596     // We have to release the context's D3D resrouces whenever we reset the IDirect3DDevice9 in order to
597     // destroy any D3DPOOL_DEFAULT resources that Core Animation has allocated (e.g., textures used
598     // for mask layers). See <http://msdn.microsoft.com/en-us/library/bb174425(v=VS.85).aspx>.
599     wkCACFContextReleaseD3DResources(m_context);
600
601     D3DPRESENT_PARAMETERS parameters = initialPresentationParameters();
602     hr = m_d3dDevice->Reset(&parameters);
603
604     // TestCooperativeLevel told us the device may be reset now, so we should
605     // not be told here that the device is lost.
606     ASSERT(hr != D3DERR_DEVICELOST);
607
608     initD3DGeometry();
609
610     return true;
611 }
612
613 }
614
615 #endif // USE(ACCELERATED_COMPOSITING)