e1de74e8f1f0c95fa556e515cafc2dea500b68dc
[WebKit-https.git] / Source / WebCore / platform / graphics / blackberry / LayerCompositingThread.h
1 /*
2  * Copyright (C) 2010, 2011, 2012 Research In Motion Limited. All rights reserved.
3  * Copyright (C) 2010 Google Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions are
7  * met:
8  *
9  *     * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *     * Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *     * Neither the name of Google Inc. nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32
33 #ifndef LayerCompositingThread_h
34 #define LayerCompositingThread_h
35
36 #if USE(ACCELERATED_COMPOSITING)
37
38 #include "FloatQuad.h"
39 #include "LayerData.h"
40 #include "LayerRendererSurface.h"
41 #include "LayerTiler.h"
42
43 #include <BlackBerryPlatformGuardedPointer.h>
44 #include <wtf/ThreadSafeRefCounted.h>
45
46 namespace BlackBerry {
47 namespace Platform {
48 namespace Graphics {
49 class Buffer;
50 }
51 }
52 }
53
54 namespace WebCore {
55
56 class DestroyOnCompositingThread;
57 class LayerRenderer;
58
59 class LayerCompositingThread : public ThreadSafeRefCounted<LayerCompositingThread>, public LayerData, public BlackBerry::Platform::GuardedPointerBase {
60 public:
61     static PassRefPtr<LayerCompositingThread> create(LayerType, PassRefPtr<LayerTiler>);
62
63     ~LayerCompositingThread();
64
65     // Thread safe
66     void setPluginView(PluginView*);
67 #if ENABLE(VIDEO)
68     void setMediaPlayer(MediaPlayer*);
69 #endif
70     void clearAnimations();
71
72     // Not thread safe
73
74     // Returns true if we have an animation
75     bool updateAnimations(double currentTime);
76     void updateTextureContentsIfNeeded();
77     void bindContentsTexture()
78     {
79         if (m_tiler)
80             m_tiler->bindContentsTexture();
81     }
82
83     const LayerCompositingThread* rootLayer() const;
84     void setSublayers(const Vector<RefPtr<LayerCompositingThread> >&);
85     const Vector<RefPtr<LayerCompositingThread> >& getSublayers() const { return m_sublayers; }
86     void setSuperlayer(LayerCompositingThread* superlayer) { m_superlayer = superlayer; }
87     LayerCompositingThread* superlayer() const { return m_superlayer; }
88
89     // The layer renderer must be set if the layer has been rendered
90     void setLayerRenderer(LayerRenderer*);
91
92     void setDrawTransform(const TransformationMatrix&);
93     const TransformationMatrix& drawTransform() const { return m_drawTransform; }
94
95     void setDrawOpacity(float opacity) { m_drawOpacity = opacity; }
96     float drawOpacity() const { return m_drawOpacity; }
97
98     void createLayerRendererSurface();
99     LayerRendererSurface* layerRendererSurface() const { return m_layerRendererSurface.get(); }
100     void clearLayerRendererSurface() { m_layerRendererSurface.clear(); }
101
102     void setMaskLayer(LayerCompositingThread* maskLayer) { m_maskLayer = maskLayer; }
103     LayerCompositingThread* maskLayer() const { return m_maskLayer.get(); }
104
105     void setReplicaLayer(LayerCompositingThread* layer) { m_replicaLayer = layer; }
106     LayerCompositingThread* replicaLayer() const { return m_replicaLayer.get(); }
107
108     FloatRect getDrawRect() const { return m_drawRect; }
109     const FloatQuad& getTransformedBounds() const { return m_transformedBounds; }
110     FloatQuad getTransformedHolePunchRect() const;
111
112     void deleteTextures();
113
114     void drawTextures(int positionLocation, int texCoordLocation, const FloatRect& visibleRect);
115     bool hasMissingTextures() const { return m_tiler ? m_tiler->hasMissingTextures() : false; }
116     void drawMissingTextures(int positionLocation, int texCoordLocation, const FloatRect& visibleRect);
117     void drawSurface(const TransformationMatrix&, LayerCompositingThread* mask, int positionLocation, int texCoordLocation);
118     bool isDirty() const { return m_tiler ? m_tiler->hasDirtyTiles() : false; }
119
120     void releaseTextureResources();
121
122     // Layer visibility is determined by the LayerRenderer when drawing.
123     // So we don't have an accurate value for visibility until it's too late,
124     // but the attribute still is useful.
125     bool isVisible() const { return m_visible; }
126     void setVisible(bool);
127
128     // This will cause a commit of the whole layer tree on the WebKit thread,
129     // sometime after rendering is finished. Used when rendering results in a
130     // need for commit, for example when a dirty layer becomes visible.
131     void setNeedsCommit();
132
133     // Normally you would schedule a commit from the webkit thread, but
134     // this allows you to do it from the compositing thread.
135     void scheduleCommit();
136
137     // These two functions are used to update animated properties in LayerAnimation.
138     void setOpacity(float opacity) { m_opacity = opacity; }
139     void setTransform(const TransformationMatrix& matrix) { m_transform = matrix; }
140
141     bool hasRunningAnimations() const { return !m_runningAnimations.isEmpty(); }
142
143     bool hasVisibleHolePunchRect() const;
144
145 private:
146     LayerCompositingThread(LayerType, PassRefPtr<LayerTiler>);
147
148     friend class DestroyOnCompositingThread;
149     void destroyOnCompositingThread();
150
151     void updateTileContents(const IntRect& tile);
152
153     void removeFromSuperlayer();
154
155     size_t numSublayers() const { return m_sublayers.size(); }
156
157     // Returns the index of the sublayer or -1 if not found.
158     int indexOfSublayer(const LayerCompositingThread*);
159
160     // This should only be called from removeFromSuperlayer.
161     void removeSublayer(LayerCompositingThread*);
162
163     LayerRenderer* m_layerRenderer;
164
165     typedef Vector<RefPtr<LayerCompositingThread> > LayerList;
166     LayerList m_sublayers;
167     LayerCompositingThread* m_superlayer;
168
169     // Vertex data for the bounds of this layer
170     FloatQuad m_transformedBounds;
171     // The bounding rectangle of the transformed layer
172     FloatRect m_drawRect;
173
174     OwnPtr<LayerRendererSurface> m_layerRendererSurface;
175
176     RefPtr<LayerCompositingThread> m_maskLayer;
177     RefPtr<LayerCompositingThread> m_replicaLayer;
178
179     BlackBerry::Platform::Graphics::Buffer* m_pluginBuffer;
180
181     // The global property values, after concatenation with parent values
182     TransformationMatrix m_drawTransform;
183     float m_drawOpacity;
184
185     bool m_visible;
186     bool m_commitScheduled;
187
188     RefPtr<LayerTiler> m_tiler;
189 };
190
191 }
192
193 #endif // USE(ACCELERATED_COMPOSITING)
194
195 #endif