d004cc80fe865cb73c2e1d4c8cbfcf26cce29b86
[WebKit.git] / Source / WebCore / platform / graphics / texmap / TextureMapperPlatformLayerProxy.h
1 /*
2  * Copyright (C) 2015 Igalia S.L.
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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef TextureMapperPlatformLayerProxy_h
27 #define TextureMapperPlatformLayerProxy_h
28
29 #if USE(COORDINATED_GRAPHICS_THREADED)
30
31 #include "TextureMapperGLHeaders.h"
32 #include <wtf/Function.h>
33 #include <wtf/Lock.h>
34 #include <wtf/RunLoop.h>
35 #include <wtf/ThreadSafeRefCounted.h>
36 #include <wtf/Vector.h>
37
38 #ifndef NDEBUG
39 #include <wtf/Threading.h>
40 #endif
41
42 namespace WebCore {
43
44 class IntSize;
45 class TextureMapperGL;
46 class TextureMapperLayer;
47 class TextureMapperPlatformLayerBuffer;
48
49 class TextureMapperPlatformLayerProxy : public ThreadSafeRefCounted<TextureMapperPlatformLayerProxy> {
50     WTF_MAKE_FAST_ALLOCATED();
51 public:
52     class Compositor {
53     public:
54         virtual void onNewBufferAvailable() = 0;
55         virtual TextureMapperGL* texmapGL() = 0;
56     };
57
58     TextureMapperPlatformLayerProxy();
59     virtual ~TextureMapperPlatformLayerProxy();
60
61     // To avoid multiple lock/release situation to update a single frame,
62     // the implementation of TextureMapperPlatformLayerProxyProvider should
63     // aquire / release the lock explicitly to use below methods.
64     Lock& lock() { return m_lock; }
65     std::unique_ptr<TextureMapperPlatformLayerBuffer> getAvailableBuffer(const IntSize&, GLint internalFormat);
66     void pushNextBuffer(std::unique_ptr<TextureMapperPlatformLayerBuffer>);
67     bool isActive();
68
69     void activateOnCompositingThread(Compositor*, TextureMapperLayer*);
70     void invalidate();
71
72     void swapBuffer();
73     void dropCurrentBufferWhilePreservingTexture();
74
75     bool scheduleUpdateOnCompositorThread(Function<void()>&&);
76
77 private:
78     void appendToUnusedBuffers(std::unique_ptr<TextureMapperPlatformLayerBuffer>);
79     void scheduleReleaseUnusedBuffers();
80     void releaseUnusedBuffersTimerFired();
81
82     Compositor* m_compositor;
83     TextureMapperLayer* m_targetLayer;
84
85     std::unique_ptr<TextureMapperPlatformLayerBuffer> m_currentBuffer;
86     std::unique_ptr<TextureMapperPlatformLayerBuffer> m_pendingBuffer;
87
88     Lock m_lock;
89
90     Vector<std::unique_ptr<TextureMapperPlatformLayerBuffer>> m_usedBuffers;
91     std::unique_ptr<RunLoop::Timer<TextureMapperPlatformLayerProxy>> m_releaseUnusedBuffersTimer;
92
93 #ifndef NDEBUG
94     ThreadIdentifier m_compositorThreadID { 0 };
95 #endif
96
97     void compositorThreadUpdateTimerFired();
98     std::unique_ptr<RunLoop::Timer<TextureMapperPlatformLayerProxy>> m_compositorThreadUpdateTimer;
99     Function<void()> m_compositorThreadUpdateFunction;
100 };
101
102 } // namespace WebCore
103
104 #endif // USE(COORDINATED_GRAPHICS_THREADED)
105
106 #endif // TextureMapperPlatformLayerProxy_h