DisplayListCanvas.h revision edca320a2b42011f98c308fdf25fc0494c6a5454 
1/*
2 * Copyright (C) 2010 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 ANDROID_HWUI_DISPLAY_LIST_RENDERER_H
18#define ANDROID_HWUI_DISPLAY_LIST_RENDERER_H
19
20#include <SkDrawFilter.h>
21#include <SkMatrix.h>
22#include <SkPaint.h>
23#include <SkPath.h>
24#include <SkRegion.h>
25#include <SkTLazy.h>
26#include <cutils/compiler.h>
27
28#include "Canvas.h"
29#include "CanvasState.h"
30#include "DisplayList.h"
31#include "SkiaCanvasProxy.h"
32#include "RenderNode.h"
33#include "ResourceCache.h"
34
35namespace android {
36namespace uirenderer {
37
38///////////////////////////////////////////////////////////////////////////////
39// Defines
40///////////////////////////////////////////////////////////////////////////////
41
42// Debug
43#if DEBUG_DISPLAY_LIST
44    #define DISPLAY_LIST_LOGD(...) ALOGD(__VA_ARGS__)
45#else
46    #define DISPLAY_LIST_LOGD(...)
47#endif
48
49///////////////////////////////////////////////////////////////////////////////
50// Display list
51///////////////////////////////////////////////////////////////////////////////
52
53class DeferredDisplayList;
54class DeferredLayerUpdater;
55class DisplayListOp;
56class DrawOp;
57class RenderNode;
58class StateOp;
59
60/**
61 * Records drawing commands in a display list for later playback into an OpenGLRenderer.
62 */
63class ANDROID_API DisplayListCanvas: public Canvas, public CanvasStateClient {
64public:
65    DisplayListCanvas(int width, int height);
66    virtual ~DisplayListCanvas();
67
68    void reset(int width, int height);
69
70    DisplayListData* finishRecording();
71
72// ----------------------------------------------------------------------------
73// HWUI Canvas state operations
74// ----------------------------------------------------------------------------
75
76    void insertReorderBarrier(bool enableReorder);
77
78// ----------------------------------------------------------------------------
79// HWUI Canvas draw operations
80// ----------------------------------------------------------------------------
81
82    // Shapes
83    void drawRoundRect(CanvasPropertyPrimitive* left, CanvasPropertyPrimitive* top,
84                CanvasPropertyPrimitive* right, CanvasPropertyPrimitive* bottom,
85                CanvasPropertyPrimitive* rx, CanvasPropertyPrimitive* ry,
86                CanvasPropertyPaint* paint);
87    void drawCircle(CanvasPropertyPrimitive* x, CanvasPropertyPrimitive* y,
88                CanvasPropertyPrimitive* radius, CanvasPropertyPaint* paint);
89
90
91// ----------------------------------------------------------------------------
92// HWUI Canvas draw operations - special
93// ----------------------------------------------------------------------------
94    void drawLayer(DeferredLayerUpdater* layerHandle, float x, float y);
95    void drawRenderNode(RenderNode* renderNode);
96
97    // TODO: rename for consistency
98    void callDrawGLFunction(Functor* functor);
99
100// ----------------------------------------------------------------------------
101// CanvasStateClient interface
102// ----------------------------------------------------------------------------
103    virtual void onViewportInitialized() override { }
104    virtual void onSnapshotRestored(const Snapshot& removed, const Snapshot& restored) override { }
105    virtual GLuint getTargetFbo() const override { return -1; }
106
107// ----------------------------------------------------------------------------
108// android/graphics/Canvas interface
109// ----------------------------------------------------------------------------
110    virtual SkCanvas* asSkCanvas() override;
111
112    virtual void setBitmap(const SkBitmap& bitmap) override {
113        LOG_ALWAYS_FATAL("DisplayListCanvas is not backed by a bitmap.");
114    }
115
116    virtual bool isOpaque() override { return false; }
117    virtual int width() override { return mState.getWidth(); }
118    virtual int height() override { return mState.getHeight(); }
119
120    virtual void setHighContrastText(bool highContrastText) override {
121        mHighContrastText = highContrastText;
122    }
123    virtual bool isHighContrastText() override { return mHighContrastText; }
124
125// ----------------------------------------------------------------------------
126// android/graphics/Canvas state operations
127// ----------------------------------------------------------------------------
128    // Save (layer)
129    virtual int getSaveCount() const override { return mState.getSaveCount(); }
130    virtual int save(SkCanvas::SaveFlags flags) override;
131    virtual void restore() override;
132    virtual void restoreToCount(int saveCount) override;
133
134    virtual int saveLayer(float left, float top, float right, float bottom, const SkPaint* paint,
135        SkCanvas::SaveFlags flags) override;
136    virtual int saveLayerAlpha(float left, float top, float right, float bottom,
137            int alpha, SkCanvas::SaveFlags flags) override {
138        SkPaint paint;
139        paint.setAlpha(alpha);
140        return saveLayer(left, top, right, bottom, &paint, flags);
141    }
142
143    // Matrix
144    virtual void getMatrix(SkMatrix* outMatrix) const override { mState.getMatrix(outMatrix); }
145    virtual void setMatrix(const SkMatrix& matrix) override;
146    virtual void setLocalMatrix(const SkMatrix& matrix) override;
147
148    virtual void concat(const SkMatrix& matrix) override;
149    virtual void rotate(float degrees) override;
150    virtual void scale(float sx, float sy) override;
151    virtual void skew(float sx, float sy) override;
152    virtual void translate(float dx, float dy) override;
153
154    // Clip
155    virtual bool getClipBounds(SkRect* outRect) const override;
156    virtual bool quickRejectRect(float left, float top, float right, float bottom) const override;
157    virtual bool quickRejectPath(const SkPath& path) const override;
158
159    virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op) override;
160    virtual bool clipPath(const SkPath* path, SkRegion::Op op) override;
161    virtual bool clipRegion(const SkRegion* region, SkRegion::Op op) override;
162
163    // Misc
164    virtual SkDrawFilter* getDrawFilter() override { return mDrawFilter.get(); }
165    virtual void setDrawFilter(SkDrawFilter* filter) override;
166
167// ----------------------------------------------------------------------------
168// android/graphics/Canvas draw operations
169// ----------------------------------------------------------------------------
170    virtual void drawColor(int color, SkXfermode::Mode mode) override;
171    virtual void drawPaint(const SkPaint& paint) override;
172
173    // Geometry
174    virtual void drawPoint(float x, float y, const SkPaint& paint) override {
175        float points[2] = { x, y };
176        drawPoints(points, 2, paint);
177    }
178    virtual void drawPoints(const float* points, int count, const SkPaint& paint) override;
179    virtual void drawLine(float startX, float startY, float stopX, float stopY,
180            const SkPaint& paint) override {
181        float points[4] = { startX, startY, stopX, stopY };
182        drawLines(points, 4, paint);
183    }
184    virtual void drawLines(const float* points, int count, const SkPaint& paint) override;
185    virtual void drawRect(float left, float top, float right, float bottom, const SkPaint& paint) override;
186    virtual void drawRegion(const SkRegion& region, const SkPaint& paint) override;
187    virtual void drawRoundRect(float left, float top, float right, float bottom,
188            float rx, float ry, const SkPaint& paint) override;
189    virtual void drawCircle(float x, float y, float radius, const SkPaint& paint) override;
190    virtual void drawOval(float left, float top, float right, float bottom, const SkPaint& paint) override;
191    virtual void drawArc(float left, float top, float right, float bottom,
192            float startAngle, float sweepAngle, bool useCenter, const SkPaint& paint) override;
193    virtual void drawPath(const SkPath& path, const SkPaint& paint) override;
194    virtual void drawVertices(SkCanvas::VertexMode vertexMode, int vertexCount,
195            const float* verts, const float* tex, const int* colors,
196            const uint16_t* indices, int indexCount, const SkPaint& paint) override
197        { /* DisplayListCanvas does not support drawVertices(); ignore */ }
198
199    // Bitmap-based
200    virtual void drawBitmap(const SkBitmap& bitmap, float left, float top, const SkPaint* paint) override;
201    virtual void drawBitmap(const SkBitmap& bitmap, const SkMatrix& matrix,
202                            const SkPaint* paint) override;
203    virtual void drawBitmap(const SkBitmap& bitmap, float srcLeft, float srcTop,
204            float srcRight, float srcBottom, float dstLeft, float dstTop,
205            float dstRight, float dstBottom, const SkPaint* paint) override;
206    virtual void drawBitmapMesh(const SkBitmap& bitmap, int meshWidth, int meshHeight,
207            const float* vertices, const int* colors, const SkPaint* paint) override;
208    virtual void drawNinePatch(const SkBitmap& bitmap, const android::Res_png_9patch& chunk,
209            float dstLeft, float dstTop, float dstRight, float dstBottom,
210            const SkPaint* paint) override;
211
212    // Text
213    virtual void drawText(const uint16_t* glyphs, const float* positions, int count,
214            const SkPaint& paint, float x, float y, float boundsLeft, float boundsTop,
215            float boundsRight, float boundsBottom, float totalAdvance) override;
216    virtual void drawPosText(const uint16_t* text, const float* positions, int count,
217            int posCount, const SkPaint& paint) override;
218    virtual void drawTextOnPath(const uint16_t* glyphs, int count, const SkPath& path,
219            float hOffset, float vOffset, const SkPaint& paint) override;
220    virtual bool drawTextAbsolutePos() const override { return false; }
221
222
223private:
224
225    CanvasState mState;
226    std::unique_ptr<SkiaCanvasProxy> mSkiaCanvasProxy;
227
228    enum DeferredBarrierType {
229        kBarrier_None,
230        kBarrier_InOrder,
231        kBarrier_OutOfOrder,
232    };
233
234    void drawBitmap(const SkBitmap* bitmap, const SkPaint* paint);
235    void drawRects(const float* rects, int count, const SkPaint* paint);
236
237    void flushRestoreToCount();
238    void flushTranslate();
239    void flushReorderBarrier();
240
241    LinearAllocator& alloc() { return mDisplayListData->allocator; }
242
243    // Each method returns final index of op
244    size_t addOpAndUpdateChunk(DisplayListOp* op);
245    // flushes any deferred operations, and appends the op
246    size_t flushAndAddOp(DisplayListOp* op);
247
248    size_t addStateOp(StateOp* op);
249    size_t addDrawOp(DrawOp* op);
250    size_t addRenderNodeOp(DrawRenderNodeOp* op);
251
252    void refBitmapsInShader(const SkShader* shader);
253
254    template<class T>
255    inline const T* refBuffer(const T* srcBuffer, int32_t count) {
256        if (!srcBuffer) return nullptr;
257
258        T* dstBuffer = (T*) mDisplayListData->allocator.alloc(count * sizeof(T));
259        memcpy(dstBuffer, srcBuffer, count * sizeof(T));
260        return dstBuffer;
261    }
262
263    inline char* refText(const char* text, size_t byteLength) {
264        return (char*) refBuffer<uint8_t>((uint8_t*)text, byteLength);
265    }
266
267    inline const SkPath* refPath(const SkPath* path) {
268        if (!path) return nullptr;
269
270        // The points/verbs within the path are refcounted so this copy operation
271        // is inexpensive and maintains the generationID of the original path.
272        const SkPath* cachedPath = new SkPath(*path);
273        mDisplayListData->pathResources.push_back(cachedPath);
274        return cachedPath;
275    }
276
277    inline const SkPaint* refPaint(const SkPaint* paint) {
278        if (!paint) return nullptr;
279
280        // If there is a draw filter apply it here and store the modified paint
281        // so that we don't need to modify the paint every time we access it.
282        SkTLazy<SkPaint> filteredPaint;
283        if (mDrawFilter.get()) {
284            filteredPaint.set(*paint);
285            mDrawFilter->filter(filteredPaint.get(), SkDrawFilter::kPaint_Type);
286            paint = filteredPaint.get();
287        }
288
289        // compute the hash key for the paint and check the cache.
290        const uint32_t key = paint->getHash();
291        const SkPaint* cachedPaint = mPaintMap.valueFor(key);
292        // In the unlikely event that 2 unique paints have the same hash we do a
293        // object equality check to ensure we don't erroneously dedup them.
294        if (cachedPaint == nullptr || *cachedPaint != *paint) {
295            cachedPaint = new SkPaint(*paint);
296            std::unique_ptr<const SkPaint> copy(cachedPaint);
297            mDisplayListData->paints.push_back(std::move(copy));
298
299            // replaceValueFor() performs an add if the entry doesn't exist
300            mPaintMap.replaceValueFor(key, cachedPaint);
301            refBitmapsInShader(cachedPaint->getShader());
302        }
303
304        return cachedPaint;
305    }
306
307    inline const SkRegion* refRegion(const SkRegion* region) {
308        if (!region) {
309            return region;
310        }
311
312        const SkRegion* cachedRegion = mRegionMap.valueFor(region);
313        // TODO: Add generation ID to SkRegion
314        if (cachedRegion == nullptr) {
315            std::unique_ptr<const SkRegion> copy(new SkRegion(*region));
316            cachedRegion = copy.get();
317            mDisplayListData->regions.push_back(std::move(copy));
318
319            // replaceValueFor() performs an add if the entry doesn't exist
320            mRegionMap.replaceValueFor(region, cachedRegion);
321        }
322
323        return cachedRegion;
324    }
325
326    inline const SkBitmap* refBitmap(const SkBitmap& bitmap) {
327        // Note that this assumes the bitmap is immutable. There are cases this won't handle
328        // correctly, such as creating the bitmap from scratch, drawing with it, changing its
329        // contents, and drawing again. The only fix would be to always copy it the first time,
330        // which doesn't seem worth the extra cycles for this unlikely case.
331        SkBitmap* localBitmap = new (alloc()) SkBitmap(bitmap);
332        alloc().autoDestroy(localBitmap);
333        mDisplayListData->bitmapResources.push_back(localBitmap);
334        return localBitmap;
335    }
336
337    inline const Res_png_9patch* refPatch(const Res_png_9patch* patch) {
338        mDisplayListData->patchResources.push_back(patch);
339        mResourceCache.incrementRefcount(patch);
340        return patch;
341    }
342
343    DefaultKeyedVector<uint32_t, const SkPaint*> mPaintMap;
344    DefaultKeyedVector<const SkPath*, const SkPath*> mPathMap;
345    DefaultKeyedVector<const SkRegion*, const SkRegion*> mRegionMap;
346
347    ResourceCache& mResourceCache;
348    DisplayListData* mDisplayListData;
349
350    float mTranslateX;
351    float mTranslateY;
352    bool mHasDeferredTranslate;
353    DeferredBarrierType mDeferredBarrierType;
354    bool mHighContrastText;
355
356    int mRestoreSaveCount;
357
358    SkAutoTUnref<SkDrawFilter> mDrawFilter;
359
360    friend class RenderNode;
361
362}; // class DisplayListCanvas
363
364}; // namespace uirenderer
365}; // namespace android
366
367#endif // ANDROID_HWUI_DISPLAY_LIST_RENDERER_H
368