Make WebCore::IOSurface have single ownership instead of refcounting
[WebKit-https.git] / Source / WebKit2 / Shared / mac / RemoteLayerBackingStore.h
1 /*
2  * Copyright (C) 2013 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 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 #ifndef RemoteLayerBackingStore_h
27 #define RemoteLayerBackingStore_h
28
29 #include "ShareableBitmap.h"
30 #include <WebCore/FloatRect.h>
31 #include <WebCore/IOSurface.h>
32 #include <WebCore/Region.h>
33 #include <chrono>
34
35 OBJC_CLASS CALayer;
36
37 // FIXME: Make PlatformCALayerRemote.cpp Objective-C so we can include WebLayer.h here and share the typedef.
38 namespace WebCore {
39 typedef Vector<WebCore::FloatRect, 5> RepaintRectList;
40 }
41
42 namespace WebKit {
43
44 class PlatformCALayerRemote;
45
46 class RemoteLayerBackingStore {
47     WTF_MAKE_NONCOPYABLE(RemoteLayerBackingStore);
48     WTF_MAKE_FAST_ALLOCATED;
49 public:
50     RemoteLayerBackingStore(PlatformCALayerRemote*);
51     ~RemoteLayerBackingStore();
52
53     void ensureBackingStore(WebCore::FloatSize, float scale, bool acceleratesDrawing, bool isOpaque);
54
55     void setNeedsDisplay(const WebCore::IntRect);
56     void setNeedsDisplay();
57
58     bool display();
59
60     WebCore::FloatSize size() const { return m_size; }
61     float scale() const { return m_scale; }
62     bool acceleratesDrawing() const { return m_acceleratesDrawing; }
63     bool isOpaque() const { return m_isOpaque; }
64
65     PlatformCALayerRemote* layer() const { return m_layer; }
66
67     void applyBackingStoreToLayer(CALayer *);
68
69     void encode(IPC::ArgumentEncoder&) const;
70     static bool decode(IPC::ArgumentDecoder&, RemoteLayerBackingStore&);
71
72     void enumerateRectsBeingDrawn(CGContextRef, void (^)(CGRect));
73
74     bool hasFrontBuffer() const
75     {
76 #if USE(IOSURFACE)
77         if (m_acceleratesDrawing)
78             return !!m_frontBuffer.surface;
79 #endif
80         return !!m_frontBuffer.bitmap;
81     }
82
83     RetainPtr<CGContextRef> takeFrontContextPendingFlush();
84
85     enum class BufferType {
86         Front,
87         Back,
88         SecondaryBack
89     };
90
91     bool setBufferVolatility(BufferType type, bool isVolatile);
92
93     std::chrono::steady_clock::time_point lastDisplayTime() const { return m_lastDisplayTime; }
94
95 private:
96     void drawInContext(WebCore::GraphicsContext&, CGImageRef backImage);
97     void clearBackingStore();
98     void swapToValidFrontBuffer();
99     
100     WebCore::IntSize backingStoreSize() const;
101
102     PlatformCALayerRemote* m_layer;
103
104     WebCore::FloatSize m_size;
105     float m_scale;
106     bool m_isOpaque;
107
108     WebCore::Region m_dirtyRegion;
109
110     struct Buffer {
111         RefPtr<ShareableBitmap> bitmap;
112 #if USE(IOSURFACE)
113         std::unique_ptr<WebCore::IOSurface> surface;
114         bool isVolatile = false;
115 #endif
116
117         explicit operator bool() const
118         {
119 #if USE(IOSURFACE)
120             if (surface)
121                 return true;
122 #endif
123             if (bitmap)
124                 return true;
125
126             return false;
127         }
128
129         void discard();
130     };
131
132     Buffer m_frontBuffer;
133     Buffer m_backBuffer;
134 #if USE(IOSURFACE)
135     Buffer m_secondaryBackBuffer;
136 #endif
137
138     RetainPtr<CGContextRef> m_frontContextPendingFlush;
139
140     bool m_acceleratesDrawing;
141
142     WebCore::RepaintRectList m_paintingRects;
143
144     std::chrono::steady_clock::time_point m_lastDisplayTime;
145 };
146
147 } // namespace WebKit
148
149 #endif // RemoteLayerBackingStore_h