DisplayListCanvas.h revision 94394b3fb048d5349a77b57950ab7f6b6e92ce34
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 // TODO: move drawPatch() to Canvas.h 83 void drawPatch(const SkBitmap& bitmap, const Res_png_9patch* patch, 84 float left, float top, float right, float bottom, const SkPaint* paint); 85 86 // Shapes 87 void drawRoundRect(CanvasPropertyPrimitive* left, CanvasPropertyPrimitive* top, 88 CanvasPropertyPrimitive* right, CanvasPropertyPrimitive* bottom, 89 CanvasPropertyPrimitive* rx, CanvasPropertyPrimitive* ry, 90 CanvasPropertyPaint* paint); 91 void drawCircle(CanvasPropertyPrimitive* x, CanvasPropertyPrimitive* y, 92 CanvasPropertyPrimitive* radius, CanvasPropertyPaint* paint); 93 94 95// ---------------------------------------------------------------------------- 96// HWUI Canvas draw operations - special 97// ---------------------------------------------------------------------------- 98 void drawLayer(DeferredLayerUpdater* layerHandle, float x, float y); 99 void drawRenderNode(RenderNode* renderNode); 100 101 // TODO: rename for consistency 102 void callDrawGLFunction(Functor* functor); 103 104 void setHighContrastText(bool highContrastText) { 105 mHighContrastText = highContrastText; 106 } 107 108// ---------------------------------------------------------------------------- 109// CanvasStateClient interface 110// ---------------------------------------------------------------------------- 111 virtual void onViewportInitialized() override { } 112 virtual void onSnapshotRestored(const Snapshot& removed, const Snapshot& restored) override { } 113 virtual GLuint getTargetFbo() const override { return -1; } 114 115// ---------------------------------------------------------------------------- 116// android/graphics/Canvas interface 117// ---------------------------------------------------------------------------- 118 virtual SkCanvas* asSkCanvas() override; 119 120 virtual void setBitmap(const SkBitmap& bitmap) override { 121 LOG_ALWAYS_FATAL("DisplayListCanvas is not backed by a bitmap."); 122 } 123 124 virtual bool isOpaque() override { return false; } 125 virtual int width() override { return mState.getWidth(); } 126 virtual int height() override { return mState.getHeight(); } 127 128// ---------------------------------------------------------------------------- 129// android/graphics/Canvas state operations 130// ---------------------------------------------------------------------------- 131 // Save (layer) 132 virtual int getSaveCount() const override { return mState.getSaveCount(); } 133 virtual int save(SkCanvas::SaveFlags flags) override; 134 virtual void restore() override; 135 virtual void restoreToCount(int saveCount) override; 136 137 virtual int saveLayer(float left, float top, float right, float bottom, const SkPaint* paint, 138 SkCanvas::SaveFlags flags) override; 139 virtual int saveLayerAlpha(float left, float top, float right, float bottom, 140 int alpha, SkCanvas::SaveFlags flags) override { 141 SkPaint paint; 142 paint.setAlpha(alpha); 143 return saveLayer(left, top, right, bottom, &paint, flags); 144 } 145 146 // Matrix 147 virtual void getMatrix(SkMatrix* outMatrix) const override { mState.getMatrix(outMatrix); } 148 virtual void setMatrix(const SkMatrix& matrix) override; 149 virtual void setLocalMatrix(const SkMatrix& matrix) override; 150 151 virtual void concat(const SkMatrix& matrix) override; 152 virtual void rotate(float degrees) override; 153 virtual void scale(float sx, float sy) override; 154 virtual void skew(float sx, float sy) override; 155 virtual void translate(float dx, float dy) override; 156 157 // Clip 158 virtual bool getClipBounds(SkRect* outRect) const override; 159 virtual bool quickRejectRect(float left, float top, float right, float bottom) const override; 160 virtual bool quickRejectPath(const SkPath& path) const override; 161 162 virtual bool clipRect(float left, float top, float right, float bottom, SkRegion::Op op) override; 163 virtual bool clipPath(const SkPath* path, SkRegion::Op op) override; 164 virtual bool clipRegion(const SkRegion* region, SkRegion::Op op) override; 165 166 // Misc 167 virtual SkDrawFilter* getDrawFilter() override { return mDrawFilter.get(); } 168 virtual void setDrawFilter(SkDrawFilter* filter) override; 169 170// ---------------------------------------------------------------------------- 171// android/graphics/Canvas draw operations 172// ---------------------------------------------------------------------------- 173 virtual void drawColor(int color, SkXfermode::Mode mode) override; 174 virtual void drawPaint(const SkPaint& paint) override; 175 176 // Geometry 177 virtual void drawPoint(float x, float y, const SkPaint& paint) override { 178 float points[2] = { x, y }; 179 drawPoints(points, 2, paint); 180 } 181 virtual void drawPoints(const float* points, int count, const SkPaint& paint) override; 182 virtual void drawLine(float startX, float startY, float stopX, float stopY, 183 const SkPaint& paint) override { 184 float points[4] = { startX, startY, stopX, stopY }; 185 drawLines(points, 4, paint); 186 } 187 virtual void drawLines(const float* points, int count, const SkPaint& paint) override; 188 virtual void drawRect(float left, float top, float right, float bottom, const SkPaint& paint) override; 189 virtual void drawRegion(const SkRegion& region, const SkPaint& paint) override; 190 virtual void drawRoundRect(float left, float top, float right, float bottom, 191 float rx, float ry, const SkPaint& paint) override; 192 virtual void drawCircle(float x, float y, float radius, const SkPaint& paint) override; 193 virtual void drawOval(float left, float top, float right, float bottom, const SkPaint& paint) override; 194 virtual void drawArc(float left, float top, float right, float bottom, 195 float startAngle, float sweepAngle, bool useCenter, const SkPaint& paint) override; 196 virtual void drawPath(const SkPath& path, const SkPaint& paint) override; 197 virtual void drawVertices(SkCanvas::VertexMode vertexMode, int vertexCount, 198 const float* verts, const float* tex, const int* colors, 199 const uint16_t* indices, int indexCount, const SkPaint& paint) override 200 { /* DisplayListCanvas does not support drawVertices(); ignore */ } 201 202 // Bitmap-based 203 virtual void drawBitmap(const SkBitmap& bitmap, float left, float top, const SkPaint* paint) override; 204 virtual void drawBitmap(const SkBitmap& bitmap, const SkMatrix& matrix, 205 const SkPaint* paint) override; 206 virtual void drawBitmap(const SkBitmap& bitmap, float srcLeft, float srcTop, 207 float srcRight, float srcBottom, float dstLeft, float dstTop, 208 float dstRight, float dstBottom, const SkPaint* paint) override; 209 virtual void drawBitmapMesh(const SkBitmap& bitmap, int meshWidth, int meshHeight, 210 const float* vertices, const int* colors, 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.add(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 SkPaint* copyPaint(const SkPaint* paint) { 308 if (!paint) return nullptr; 309 310 SkPaint* returnPaint = new SkPaint(*paint); 311 std::unique_ptr<const SkPaint> copy(returnPaint); 312 mDisplayListData->paints.push_back(std::move(copy)); 313 314 return returnPaint; 315 } 316 317 inline const SkRegion* refRegion(const SkRegion* region) { 318 if (!region) { 319 return region; 320 } 321 322 const SkRegion* cachedRegion = mRegionMap.valueFor(region); 323 // TODO: Add generation ID to SkRegion 324 if (cachedRegion == nullptr) { 325 std::unique_ptr<const SkRegion> copy(new SkRegion(*region)); 326 cachedRegion = copy.get(); 327 mDisplayListData->regions.push_back(std::move(copy)); 328 329 // replaceValueFor() performs an add if the entry doesn't exist 330 mRegionMap.replaceValueFor(region, cachedRegion); 331 } 332 333 return cachedRegion; 334 } 335 336 inline const SkBitmap* refBitmap(const SkBitmap& bitmap) { 337 // Note that this assumes the bitmap is immutable. There are cases this won't handle 338 // correctly, such as creating the bitmap from scratch, drawing with it, changing its 339 // contents, and drawing again. The only fix would be to always copy it the first time, 340 // which doesn't seem worth the extra cycles for this unlikely case. 341 SkBitmap* localBitmap = new (alloc()) SkBitmap(bitmap); 342 alloc().autoDestroy(localBitmap); 343 mDisplayListData->bitmapResources.push_back(localBitmap); 344 return localBitmap; 345 } 346 347 inline const Res_png_9patch* refPatch(const Res_png_9patch* patch) { 348 mDisplayListData->patchResources.add(patch); 349 mResourceCache.incrementRefcount(patch); 350 return patch; 351 } 352 353 DefaultKeyedVector<uint32_t, const SkPaint*> mPaintMap; 354 DefaultKeyedVector<const SkPath*, const SkPath*> mPathMap; 355 DefaultKeyedVector<const SkRegion*, const SkRegion*> mRegionMap; 356 357 ResourceCache& mResourceCache; 358 DisplayListData* mDisplayListData; 359 360 float mTranslateX; 361 float mTranslateY; 362 bool mHasDeferredTranslate; 363 DeferredBarrierType mDeferredBarrierType; 364 bool mHighContrastText; 365 366 int mRestoreSaveCount; 367 368 SkAutoTUnref<SkDrawFilter> mDrawFilter; 369 370 friend class RenderNode; 371 372}; // class DisplayListCanvas 373 374}; // namespace uirenderer 375}; // namespace android 376 377#endif // ANDROID_HWUI_DISPLAY_LIST_RENDERER_H 378