Simplify WKCACFLayerRenderer's API
[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_mustResetLostDeviceBeforeRendering(false)
191     , m_syncLayerChanges(false)
192 {
193     // Point the CACFContext to this
194     wkCACFContextSetUserData(m_context, this);
195
196     // Under the root layer, we have a clipping layer to clip the content,
197     // that contains a scroll layer that we use for scrolling the content.
198     // The root layer is the size of the client area of the window.
199     // The clipping layer is the size of the WebView client area (window less the scrollbars).
200     // The scroll layer is the size of the root child layer.
201     // Resizing the window will change the bounds of the rootLayer and the clip layer and will not
202     // cause any repositioning.
203     // Scrolling will affect only the position of the scroll layer without affecting the bounds.
204
205     m_rootLayer->setName("WKCACFLayerRenderer rootLayer");
206     m_rootLayer->setAnchorPoint(FloatPoint3D(0, 0, 0));
207     m_rootLayer->setGeometryFlipped(true);
208
209 #ifndef NDEBUG
210     CGColorRef debugColor = CGColorCreateGenericRGB(1, 0, 0, 0.8);
211     m_rootLayer->setBackgroundColor(debugColor);
212     CGColorRelease(debugColor);
213 #endif
214
215     if (m_context)
216         wkCACFContextSetLayer(m_context, m_rootLayer->platformLayer());
217
218 #ifndef NDEBUG
219     char* printTreeFlag = getenv("CA_PRINT_TREE");
220     m_printTree = printTreeFlag && atoi(printTreeFlag);
221 #endif
222 }
223
224 WKCACFLayerRenderer::~WKCACFLayerRenderer()
225 {
226     setHostWindow(0);
227     WKCACFContextFlusher::shared().removeContext(m_context);
228     wkCACFContextDestroy(m_context);
229 }
230
231 void WKCACFLayerRenderer::setHostWindow(HWND window)
232 {
233     if (window == m_hostWindow)
234         return;
235
236     if (m_hostWindow)
237         destroyRenderer();
238
239     m_hostWindow = window;
240
241     if (m_hostWindow)
242         createRenderer();
243 }
244
245 PlatformCALayer* WKCACFLayerRenderer::rootLayer() const
246 {
247     return m_rootLayer.get();
248 }
249
250 void WKCACFLayerRenderer::addPendingAnimatedLayer(PassRefPtr<PlatformCALayer> layer)
251 {
252     m_pendingAnimatedLayers.add(layer);
253 }
254
255 void WKCACFLayerRenderer::setRootChildLayer(PlatformCALayer* layer)
256 {
257     m_rootLayer->removeAllSublayers();
258     m_rootChildLayer = layer;
259     if (m_rootChildLayer)
260         m_rootLayer->appendSublayer(m_rootChildLayer.get());
261 }
262    
263 void WKCACFLayerRenderer::layerTreeDidChange()
264 {
265     WKCACFContextFlusher::shared().addContext(m_context);
266     renderSoon();
267 }
268
269 bool WKCACFLayerRenderer::createRenderer()
270 {
271     if (m_d3dDevice || !m_mightBeAbleToCreateDeviceLater)
272         return m_d3dDevice;
273
274     m_mightBeAbleToCreateDeviceLater = false;
275     D3DPRESENT_PARAMETERS parameters = initialPresentationParameters();
276
277     if (!d3d() || !::IsWindow(m_hostWindow))
278         return false;
279
280     // D3D doesn't like to make back buffers for 0 size windows. We skirt this problem if we make the
281     // passed backbuffer width and height non-zero. The window will necessarily get set to a non-zero
282     // size eventually, and then the backbuffer size will get reset.
283     RECT rect;
284     GetClientRect(m_hostWindow, &rect);
285
286     if (rect.left-rect.right == 0 || rect.bottom-rect.top == 0) {
287         parameters.BackBufferWidth = 1;
288         parameters.BackBufferHeight = 1;
289     }
290
291     D3DCAPS9 d3dCaps;
292     if (FAILED(d3d()->GetDeviceCaps(D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, &d3dCaps)))
293         return false;
294
295     DWORD behaviorFlags = D3DCREATE_FPU_PRESERVE;
296     if ((d3dCaps.DevCaps & D3DDEVCAPS_HWTRANSFORMANDLIGHT) && d3dCaps.VertexProcessingCaps)
297         behaviorFlags |= D3DCREATE_HARDWARE_VERTEXPROCESSING;
298     else
299         behaviorFlags |= D3DCREATE_SOFTWARE_VERTEXPROCESSING;
300
301     COMPtr<IDirect3DDevice9> device;
302     if (FAILED(d3d()->CreateDevice(D3DADAPTER_DEFAULT, D3DDEVTYPE_HAL, m_hostWindow, behaviorFlags, &parameters, &device))) {
303         // In certain situations (e.g., shortly after waking from sleep), Direct3DCreate9() will
304         // return an IDirect3D9 for which IDirect3D9::CreateDevice will always fail. In case we
305         // have one of these bad IDirect3D9s, get rid of it so we'll fetch a new one the next time
306         // we want to call CreateDevice.
307         s_d3d->Release();
308         s_d3d = 0;
309
310         // Even if we don't have a bad IDirect3D9, in certain situations (e.g., shortly after
311         // waking from sleep), CreateDevice will fail, but will later succeed if called again.
312         m_mightBeAbleToCreateDeviceLater = true;
313
314         return false;
315     }
316
317     // Now that we've created the IDirect3DDevice9 based on the capabilities we
318     // got from the IDirect3D9 global object, we requery the device for its
319     // actual capabilities. The capabilities returned by the device can
320     // sometimes be more complete, for example when using software vertex
321     // processing.
322     D3DCAPS9 deviceCaps;
323     if (FAILED(device->GetDeviceCaps(&deviceCaps)))
324         return false;
325
326     if (!hardwareCapabilitiesIndicateCoreAnimationSupport(deviceCaps))
327         return false;
328
329     m_d3dDevice = device;
330
331     initD3DGeometry();
332
333     wkCACFContextSetD3DDevice(m_context, m_d3dDevice.get());
334
335     if (IsWindow(m_hostWindow))
336         m_rootLayer->setBounds(bounds());
337
338     return true;
339 }
340
341 void WKCACFLayerRenderer::destroyRenderer()
342 {
343     wkCACFContextSetLayer(m_context, m_rootLayer->platformLayer());
344
345     wkCACFContextSetD3DDevice(m_context, 0);
346     m_d3dDevice = 0;
347     if (s_d3d)
348         s_d3d->Release();
349
350     s_d3d = 0;
351     m_rootLayer = 0;
352     m_rootChildLayer = 0;
353
354     m_mightBeAbleToCreateDeviceLater = true;
355 }
356
357 void WKCACFLayerRenderer::resize()
358 {
359     if (!m_d3dDevice)
360         return;
361
362     // Resetting the device might fail here. But that's OK, because if it does it we will attempt to
363     // reset the device the next time we try to render.
364     resetDevice(ChangedWindowSize);
365
366     if (m_rootLayer) {
367         m_rootLayer->setBounds(bounds());
368         WKCACFContextFlusher::shared().flushAllContexts();
369     }
370 }
371
372 static void getDirtyRects(HWND window, Vector<CGRect>& outRects)
373 {
374     ASSERT_ARG(outRects, outRects.isEmpty());
375
376     RECT clientRect;
377     if (!GetClientRect(window, &clientRect))
378         return;
379
380     OwnPtr<HRGN> region(CreateRectRgn(0, 0, 0, 0));
381     int regionType = GetUpdateRgn(window, region.get(), false);
382     if (regionType != COMPLEXREGION) {
383         RECT dirtyRect;
384         if (GetUpdateRect(window, &dirtyRect, false))
385             outRects.append(winRectToCGRect(dirtyRect, clientRect));
386         return;
387     }
388
389     DWORD dataSize = GetRegionData(region.get(), 0, 0);
390     OwnArrayPtr<unsigned char> regionDataBuffer(new unsigned char[dataSize]);
391     RGNDATA* regionData = reinterpret_cast<RGNDATA*>(regionDataBuffer.get());
392     if (!GetRegionData(region.get(), dataSize, regionData))
393         return;
394
395     outRects.resize(regionData->rdh.nCount);
396
397     RECT* rect = reinterpret_cast<RECT*>(regionData->Buffer);
398     for (size_t i = 0; i < outRects.size(); ++i, ++rect)
399         outRects[i] = winRectToCGRect(*rect, clientRect);
400 }
401
402 void WKCACFLayerRenderer::renderTimerFired(Timer<WKCACFLayerRenderer>*)
403 {
404     paint();
405 }
406
407 void WKCACFLayerRenderer::paint()
408 {
409     createRenderer();
410     if (!m_d3dDevice) {
411         if (m_mightBeAbleToCreateDeviceLater)
412             renderSoon();
413         return;
414     }
415
416     Vector<CGRect> dirtyRects;
417     getDirtyRects(m_hostWindow, dirtyRects);
418     render(dirtyRects);
419 }
420
421 void WKCACFLayerRenderer::render(const Vector<CGRect>& windowDirtyRects)
422 {
423     ASSERT(m_d3dDevice);
424
425     if (m_mustResetLostDeviceBeforeRendering && !resetDevice(LostDevice)) {
426         // We can't reset the device right now. Try again soon.
427         renderSoon();
428         return;
429     }
430
431     if (m_client && !m_client->shouldRender()) {
432         renderSoon();
433         return;
434     }
435
436     // Sync the layer if needed
437     if (m_syncLayerChanges) {
438         m_client->syncCompositingState();
439         m_syncLayerChanges = false;
440     }
441
442     // Flush the root layer to the render tree.
443     wkCACFContextFlush(m_context);
444
445     // All pending animations will have been started with the flush. Fire the animationStarted calls
446     double currentTime = WTF::currentTime();
447     double currentMediaTime = CACurrentMediaTime();
448     double t = currentTime + wkCACFContextGetLastCommitTime(m_context) - currentMediaTime;
449     ASSERT(t <= currentTime);
450
451     HashSet<RefPtr<PlatformCALayer> >::iterator end = m_pendingAnimatedLayers.end();
452     for (HashSet<RefPtr<PlatformCALayer> >::iterator it = m_pendingAnimatedLayers.begin(); it != end; ++it) {
453         PlatformCALayerClient* owner = (*it)->owner();
454         owner->platformCALayerAnimationStarted(t);
455     }
456
457     m_pendingAnimatedLayers.clear();
458
459     CGRect bounds = this->bounds();
460
461     // Give the renderer some space to use. This needs to be valid until the
462     // wkCACFContextFinishUpdate() call below.
463     char space[4096];
464     if (!wkCACFContextBeginUpdate(m_context, space, sizeof(space), currentMediaTime, bounds, windowDirtyRects.data(), windowDirtyRects.size()))
465         return;
466
467     HRESULT err = S_OK;
468     CFTimeInterval timeToNextRender = numeric_limits<CFTimeInterval>::infinity();
469
470     do {
471         // FIXME: don't need to clear dirty region if layer tree is opaque.
472
473         WKCACFUpdateRectEnumerator* e = wkCACFContextCopyUpdateRectEnumerator(m_context);
474         if (!e)
475             break;
476
477         Vector<D3DRECT, 64> rects;
478         for (const CGRect* r = wkCACFUpdateRectEnumeratorNextRect(e); r; r = wkCACFUpdateRectEnumeratorNextRect(e)) {
479             D3DRECT rect;
480             rect.x1 = r->origin.x;
481             rect.x2 = rect.x1 + r->size.width;
482             rect.y1 = bounds.origin.y + bounds.size.height - (r->origin.y + r->size.height);
483             rect.y2 = rect.y1 + r->size.height;
484
485             rects.append(rect);
486         }
487         wkCACFUpdateRectEnumeratorRelease(e);
488
489         timeToNextRender = wkCACFContextGetNextUpdateTime(m_context);
490
491         if (rects.isEmpty())
492             break;
493
494         m_d3dDevice->Clear(rects.size(), rects.data(), D3DCLEAR_TARGET, 0, 1.0f, 0);
495
496         m_d3dDevice->BeginScene();
497         wkCACFContextRenderUpdate(m_context);
498         m_d3dDevice->EndScene();
499
500         err = m_d3dDevice->Present(0, 0, 0, 0);
501
502         if (err == D3DERR_DEVICELOST) {
503             wkCACFContextAddUpdateRect(m_context, bounds);
504             if (!resetDevice(LostDevice)) {
505                 // We can't reset the device right now. Try again soon.
506                 renderSoon();
507                 return;
508             }
509         }
510     } while (err == D3DERR_DEVICELOST);
511
512     wkCACFContextFinishUpdate(m_context);
513
514 #ifndef NDEBUG
515     if (m_printTree)
516         m_rootLayer->printTree();
517 #endif
518
519     // If timeToNextRender is not infinity, it means animations are running, so queue up to render again
520     if (timeToNextRender != numeric_limits<CFTimeInterval>::infinity())
521         renderSoon();
522 }
523
524 void WKCACFLayerRenderer::renderSoon()
525 {
526     if (!m_renderTimer.isActive())
527         m_renderTimer.startOneShot(0);
528 }
529
530 void WKCACFLayerRenderer::syncCompositingStateSoon()
531 {
532     m_syncLayerChanges = true;
533     renderSoon();
534 }
535
536 CGRect WKCACFLayerRenderer::bounds() const
537 {
538     RECT clientRect;
539     GetClientRect(m_hostWindow, &clientRect);
540
541     return winRectToCGRect(clientRect);
542 }
543
544 void WKCACFLayerRenderer::initD3DGeometry()
545 {
546     ASSERT(m_d3dDevice);
547
548     CGRect bounds = this->bounds();
549
550     float x0 = bounds.origin.x;
551     float y0 = bounds.origin.y;
552     float x1 = x0 + bounds.size.width;
553     float y1 = y0 + bounds.size.height;
554
555     D3DXMATRIXA16 projection;
556     D3DXMatrixOrthoOffCenterRH(&projection, x0, x1, y0, y1, -1.0f, 1.0f);
557
558     m_d3dDevice->SetTransform(D3DTS_PROJECTION, &projection);
559 }
560
561 bool WKCACFLayerRenderer::resetDevice(ResetReason reason)
562 {
563     ASSERT(m_d3dDevice);
564     ASSERT(m_context);
565
566     HRESULT hr = m_d3dDevice->TestCooperativeLevel();
567
568     if (hr == D3DERR_DEVICELOST || hr == D3DERR_DRIVERINTERNALERROR) {
569         // The device cannot be reset at this time. Try again soon.
570         m_mustResetLostDeviceBeforeRendering = true;
571         return false;
572     }
573
574     m_mustResetLostDeviceBeforeRendering = false;
575
576     if (reason == LostDevice && hr == D3D_OK) {
577         // The device wasn't lost after all.
578         return true;
579     }
580
581     // We can reset the device.
582
583     // We have to release the context's D3D resrouces whenever we reset the IDirect3DDevice9 in order to
584     // destroy any D3DPOOL_DEFAULT resources that Core Animation has allocated (e.g., textures used
585     // for mask layers). See <http://msdn.microsoft.com/en-us/library/bb174425(v=VS.85).aspx>.
586     wkCACFContextReleaseD3DResources(m_context);
587
588     D3DPRESENT_PARAMETERS parameters = initialPresentationParameters();
589     hr = m_d3dDevice->Reset(&parameters);
590
591     // TestCooperativeLevel told us the device may be reset now, so we should
592     // not be told here that the device is lost.
593     ASSERT(hr != D3DERR_DEVICELOST);
594
595     initD3DGeometry();
596
597     return true;
598 }
599
600 }
601
602 #endif // USE(ACCELERATED_COMPOSITING)