RenderProxy.h revision 59eecb526adc5bd7041e7b6147bfcc40dd2c200e 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef RENDERPROXY_H_
18#define RENDERPROXY_H_
19
20#include "RenderTask.h"
21
22#include <cutils/compiler.h>
23#include <EGL/egl.h>
24#include <SkBitmap.h>
25#include <utils/Condition.h>
26#include <utils/Functor.h>
27#include <utils/Mutex.h>
28#include <utils/Timers.h>
29#include <utils/StrongPointer.h>
30
31#include "../Caches.h"
32#include "../FrameMetricsObserver.h"
33#include "../IContextFactory.h"
34#include "CanvasContext.h"
35#include "DrawFrameTask.h"
36
37namespace android {
38class GraphicBuffer;
39
40namespace uirenderer {
41
42class DeferredLayerUpdater;
43class RenderNode;
44class DisplayList;
45class Layer;
46class Rect;
47class TreeObserver;
48
49namespace renderthread {
50
51class ErrorChannel;
52class RenderThread;
53class RenderProxyBridge;
54
55namespace DumpFlags {
56    enum {
57        FrameStats = 1 << 0,
58        Reset      = 1 << 1,
59        JankStats  = 1 << 2,
60    };
61};
62
63/*
64 * RenderProxy is strictly single threaded. All methods must be invoked on the owning
65 * thread. It is important to note that RenderProxy may be deleted while it has
66 * tasks post()'d as a result. Therefore any RenderTask that is post()'d must not
67 * reference RenderProxy or any of its fields. The exception here is that postAndWait()
68 * references RenderProxy fields. This is safe as RenderProxy cannot
69 * be deleted if it is blocked inside a call.
70 */
71class ANDROID_API RenderProxy {
72public:
73    ANDROID_API RenderProxy(bool translucent, RenderNode* rootNode, IContextFactory* contextFactory);
74    ANDROID_API virtual ~RenderProxy();
75
76    // Won't take effect until next EGLSurface creation
77    ANDROID_API void setSwapBehavior(SwapBehavior swapBehavior);
78    ANDROID_API bool loadSystemProperties();
79    ANDROID_API void setName(const char* name);
80
81    ANDROID_API void initialize(const sp<Surface>& surface);
82    ANDROID_API void updateSurface(const sp<Surface>& surface);
83    ANDROID_API bool pauseSurface(const sp<Surface>& surface);
84    ANDROID_API void setStopped(bool stopped);
85    ANDROID_API void setup(float lightRadius,
86            uint8_t ambientShadowAlpha, uint8_t spotShadowAlpha);
87    ANDROID_API void setLightCenter(const Vector3& lightCenter);
88    ANDROID_API void setOpaque(bool opaque);
89    ANDROID_API int64_t* frameInfo();
90    ANDROID_API int syncAndDrawFrame(TreeObserver* observer);
91    ANDROID_API void destroy(TreeObserver* observer);
92
93    ANDROID_API static void invokeFunctor(Functor* functor, bool waitForCompletion);
94
95    ANDROID_API DeferredLayerUpdater* createTextureLayer();
96    ANDROID_API void buildLayer(RenderNode* node, TreeObserver* observer);
97    ANDROID_API bool copyLayerInto(DeferredLayerUpdater* layer, SkBitmap& bitmap);
98    ANDROID_API void pushLayerUpdate(DeferredLayerUpdater* layer);
99    ANDROID_API void cancelLayerUpdate(DeferredLayerUpdater* layer);
100    ANDROID_API void detachSurfaceTexture(DeferredLayerUpdater* layer);
101
102    ANDROID_API void destroyHardwareResources(TreeObserver* observer);
103    ANDROID_API static void trimMemory(int level);
104    ANDROID_API static void overrideProperty(const char* name, const char* value);
105
106    ANDROID_API void fence();
107    ANDROID_API static void staticFence();
108    ANDROID_API void stopDrawing();
109    ANDROID_API void notifyFramePending();
110
111    ANDROID_API void dumpProfileInfo(int fd, int dumpFlags);
112    // Not exported, only used for testing
113    void resetProfileInfo();
114    uint32_t frameTimePercentile(int p);
115    ANDROID_API static void dumpGraphicsMemory(int fd);
116
117    ANDROID_API void setProcessStatsBuffer(int fd);
118    ANDROID_API int getRenderThreadTid();
119
120    ANDROID_API void serializeDisplayListTree();
121
122    ANDROID_API void addRenderNode(RenderNode* node, bool placeFront);
123    ANDROID_API void removeRenderNode(RenderNode* node);
124    ANDROID_API void drawRenderNode(RenderNode* node);
125    ANDROID_API void setContentDrawBounds(int left, int top, int right, int bottom);
126
127    ANDROID_API void addFrameMetricsObserver(FrameMetricsObserver* observer);
128    ANDROID_API void removeFrameMetricsObserver(FrameMetricsObserver* observer);
129    ANDROID_API long getDroppedFrameReportCount();
130
131    ANDROID_API static int copySurfaceInto(sp<Surface>& surface,
132            int left, int top, int right, int bottom, SkBitmap* bitmap);
133    ANDROID_API static void prepareToDraw(Bitmap& bitmap);
134
135    static sk_sp<Bitmap> allocateHardwareBitmap(SkBitmap& bitmap);
136
137    static int copyGraphicBufferInto(GraphicBuffer* buffer, SkBitmap* bitmap);
138private:
139    RenderThread& mRenderThread;
140    CanvasContext* mContext;
141
142    DrawFrameTask mDrawFrameTask;
143
144    Mutex mSyncMutex;
145    Condition mSyncCondition;
146
147    void destroyContext();
148
149    void post(RenderTask* task);
150    void* postAndWait(MethodInvokeRenderTask* task);
151
152    static void* staticPostAndWait(MethodInvokeRenderTask* task);
153
154    // Friend class to help with bridging
155    friend class RenderProxyBridge;
156};
157
158} /* namespace renderthread */
159} /* namespace uirenderer */
160} /* namespace android */
161#endif /* RENDERPROXY_H_ */
162