PathCache.cpp revision e3b0a0117a2ab4118f868a731b238fe8f2430276 
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#define LOG_TAG "OpenGLRenderer"
18#define ATRACE_TAG ATRACE_TAG_VIEW
19
20#include <SkBitmap.h>
21#include <SkCanvas.h>
22#include <SkPaint.h>
23#include <SkPath.h>
24#include <SkRect.h>
25
26#include <utils/JenkinsHash.h>
27#include <utils/Trace.h>
28
29#include "Caches.h"
30#include "PathCache.h"
31
32#include "thread/Signal.h"
33#include "thread/Task.h"
34#include "thread/TaskProcessor.h"
35
36namespace android {
37namespace uirenderer {
38
39///////////////////////////////////////////////////////////////////////////////
40// Cache entries
41///////////////////////////////////////////////////////////////////////////////
42
43PathDescription::PathDescription():
44        type(kShapeNone),
45        join(SkPaint::kDefault_Join),
46        cap(SkPaint::kDefault_Cap),
47        style(SkPaint::kFill_Style),
48        miter(4.0f),
49        strokeWidth(1.0f),
50        pathEffect(NULL) {
51    memset(&shape, 0, sizeof(Shape));
52}
53
54PathDescription::PathDescription(ShapeType type, SkPaint* paint):
55        type(type),
56        join(paint->getStrokeJoin()),
57        cap(paint->getStrokeCap()),
58        style(paint->getStyle()),
59        miter(paint->getStrokeMiter()),
60        strokeWidth(paint->getStrokeWidth()),
61        pathEffect(paint->getPathEffect()) {
62    memset(&shape, 0, sizeof(Shape));
63}
64
65hash_t PathDescription::hash() const {
66    uint32_t hash = JenkinsHashMix(0, type);
67    hash = JenkinsHashMix(hash, join);
68    hash = JenkinsHashMix(hash, cap);
69    hash = JenkinsHashMix(hash, style);
70    hash = JenkinsHashMix(hash, android::hash_type(miter));
71    hash = JenkinsHashMix(hash, android::hash_type(strokeWidth));
72    hash = JenkinsHashMix(hash, android::hash_type(pathEffect));
73    hash = JenkinsHashMixBytes(hash, (uint8_t*) &shape, sizeof(Shape));
74    return JenkinsHashWhiten(hash);
75}
76
77int PathDescription::compare(const PathDescription& rhs) const {
78    return memcmp(this, &rhs, sizeof(PathDescription));
79}
80
81///////////////////////////////////////////////////////////////////////////////
82// Utilities
83///////////////////////////////////////////////////////////////////////////////
84
85bool PathCache::canDrawAsConvexPath(SkPath* path, SkPaint* paint) {
86    // NOTE: This should only be used after PathTessellator handles joins properly
87    return paint->getPathEffect() == NULL && path->getConvexity() == SkPath::kConvex_Convexity;
88}
89
90void PathCache::computePathBounds(const SkPath* path, const SkPaint* paint,
91        float& left, float& top, float& offset, uint32_t& width, uint32_t& height) {
92    const SkRect& bounds = path->getBounds();
93    PathCache::computeBounds(bounds, paint, left, top, offset, width, height);
94}
95
96void PathCache::computeBounds(const SkRect& bounds, const SkPaint* paint,
97        float& left, float& top, float& offset, uint32_t& width, uint32_t& height) {
98    const float pathWidth = fmax(bounds.width(), 1.0f);
99    const float pathHeight = fmax(bounds.height(), 1.0f);
100
101    left = bounds.fLeft;
102    top = bounds.fTop;
103
104    offset = (int) floorf(fmax(paint->getStrokeWidth(), 1.0f) * 1.5f + 0.5f);
105
106    width = uint32_t(pathWidth + offset * 2.0 + 0.5);
107    height = uint32_t(pathHeight + offset * 2.0 + 0.5);
108}
109
110static void initBitmap(SkBitmap& bitmap, uint32_t width, uint32_t height) {
111    bitmap.setConfig(SkBitmap::kA8_Config, width, height);
112    bitmap.allocPixels();
113    bitmap.eraseColor(0);
114}
115
116static void initPaint(SkPaint& paint) {
117    // Make sure the paint is opaque, color, alpha, filter, etc.
118    // will be applied later when compositing the alpha8 texture
119    paint.setColor(0xff000000);
120    paint.setAlpha(255);
121    paint.setColorFilter(NULL);
122    paint.setMaskFilter(NULL);
123    paint.setShader(NULL);
124    SkXfermode* mode = SkXfermode::Create(SkXfermode::kSrc_Mode);
125    SkSafeUnref(paint.setXfermode(mode));
126}
127
128static void drawPath(const SkPath *path, const SkPaint* paint, SkBitmap& bitmap,
129        float left, float top, float offset, uint32_t width, uint32_t height) {
130    initBitmap(bitmap, width, height);
131
132    SkPaint pathPaint(*paint);
133    initPaint(pathPaint);
134
135    SkCanvas canvas(bitmap);
136    canvas.translate(-left + offset, -top + offset);
137    canvas.drawPath(*path, pathPaint);
138}
139
140static PathTexture* createTexture(float left, float top, float offset,
141        uint32_t width, uint32_t height, uint32_t id) {
142    PathTexture* texture = new PathTexture(Caches::getInstance());
143    texture->left = left;
144    texture->top = top;
145    texture->offset = offset;
146    texture->width = width;
147    texture->height = height;
148    texture->generation = id;
149    return texture;
150}
151
152///////////////////////////////////////////////////////////////////////////////
153// Cache constructor/destructor
154///////////////////////////////////////////////////////////////////////////////
155
156PathCache::PathCache():
157        mCache(LruCache<PathDescription, PathTexture*>::kUnlimitedCapacity),
158        mSize(0), mMaxSize(MB(DEFAULT_PATH_CACHE_SIZE)) {
159    char property[PROPERTY_VALUE_MAX];
160    if (property_get(PROPERTY_PATH_CACHE_SIZE, property, NULL) > 0) {
161        INIT_LOGD("  Setting %s cache size to %sMB", name, property);
162        setMaxSize(MB(atof(property)));
163    } else {
164        INIT_LOGD("  Using default %s cache size of %.2fMB", name, DEFAULT_PATH_CACHE_SIZE);
165    }
166    init();
167}
168
169PathCache::~PathCache() {
170    mCache.clear();
171}
172
173void PathCache::init() {
174    mCache.setOnEntryRemovedListener(this);
175
176    GLint maxTextureSize;
177    glGetIntegerv(GL_MAX_TEXTURE_SIZE, &maxTextureSize);
178    mMaxTextureSize = maxTextureSize;
179
180    mDebugEnabled = readDebugLevel() & kDebugCaches;
181}
182
183///////////////////////////////////////////////////////////////////////////////
184// Size management
185///////////////////////////////////////////////////////////////////////////////
186
187uint32_t PathCache::getSize() {
188    return mSize;
189}
190
191uint32_t PathCache::getMaxSize() {
192    return mMaxSize;
193}
194
195void PathCache::setMaxSize(uint32_t maxSize) {
196    mMaxSize = maxSize;
197    while (mSize > mMaxSize) {
198        mCache.removeOldest();
199    }
200}
201
202///////////////////////////////////////////////////////////////////////////////
203// Callbacks
204///////////////////////////////////////////////////////////////////////////////
205
206void PathCache::operator()(PathDescription& entry, PathTexture*& texture) {
207    removeTexture(texture);
208}
209
210///////////////////////////////////////////////////////////////////////////////
211// Caching
212///////////////////////////////////////////////////////////////////////////////
213
214void PathCache::removeTexture(PathTexture* texture) {
215    if (texture) {
216        const uint32_t size = texture->width * texture->height;
217        mSize -= size;
218
219        PATH_LOGD("PathCache::delete name, size, mSize = %d, %d, %d",
220                texture->id, size, mSize);
221        if (mDebugEnabled) {
222            ALOGD("Shape deleted, size = %d", size);
223        }
224
225        if (texture->id) {
226            Caches::getInstance().deleteTexture(texture->id);
227        }
228        delete texture;
229    }
230}
231
232void PathCache::purgeCache(uint32_t width, uint32_t height) {
233    const uint32_t size = width * height;
234    // Don't even try to cache a bitmap that's bigger than the cache
235    if (size < mMaxSize) {
236        while (mSize + size > mMaxSize) {
237            mCache.removeOldest();
238        }
239    }
240}
241
242void PathCache::trim() {
243    while (mSize > mMaxSize) {
244        mCache.removeOldest();
245    }
246}
247
248PathTexture* PathCache::addTexture(const PathDescription& entry, const SkPath *path,
249        const SkPaint* paint) {
250    ATRACE_CALL();
251
252    float left, top, offset;
253    uint32_t width, height;
254    computePathBounds(path, paint, left, top, offset, width, height);
255
256    if (!checkTextureSize(width, height)) return NULL;
257
258    purgeCache(width, height);
259
260    SkBitmap bitmap;
261    drawPath(path, paint, bitmap, left, top, offset, width, height);
262
263    PathTexture* texture = createTexture(left, top, offset, width, height,
264            path->getGenerationID());
265    generateTexture(entry, &bitmap, texture);
266
267    return texture;
268}
269
270void PathCache::generateTexture(const PathDescription& entry, SkBitmap* bitmap,
271        PathTexture* texture, bool addToCache) {
272    generateTexture(*bitmap, texture);
273
274    uint32_t size = texture->width * texture->height;
275    if (size < mMaxSize) {
276        mSize += size;
277        PATH_LOGD("PathCache::get/create: name, size, mSize = %d, %d, %d",
278                texture->id, size, mSize);
279        if (mDebugEnabled) {
280            ALOGD("Shape created, size = %d", size);
281        }
282        if (addToCache) {
283            mCache.put(entry, texture);
284        }
285    } else {
286        texture->cleanup = true;
287    }
288}
289
290void PathCache::clear() {
291    mCache.clear();
292}
293
294void PathCache::generateTexture(SkBitmap& bitmap, Texture* texture) {
295    SkAutoLockPixels alp(bitmap);
296    if (!bitmap.readyToDraw()) {
297        ALOGE("Cannot generate texture from bitmap");
298        return;
299    }
300
301    glGenTextures(1, &texture->id);
302
303    Caches::getInstance().bindTexture(texture->id);
304    // Textures are Alpha8
305    glPixelStorei(GL_UNPACK_ALIGNMENT, 1);
306
307    texture->blend = true;
308    glTexImage2D(GL_TEXTURE_2D, 0, GL_ALPHA, texture->width, texture->height, 0,
309            GL_ALPHA, GL_UNSIGNED_BYTE, bitmap.getPixels());
310
311    texture->setFilter(GL_LINEAR);
312    texture->setWrap(GL_CLAMP_TO_EDGE);
313}
314
315///////////////////////////////////////////////////////////////////////////////
316// Path precaching
317///////////////////////////////////////////////////////////////////////////////
318
319PathCache::PathProcessor::PathProcessor(Caches& caches):
320        TaskProcessor<SkBitmap*>(&caches.tasks), mMaxTextureSize(caches.maxTextureSize) {
321}
322
323void PathCache::PathProcessor::onProcess(const sp<Task<SkBitmap*> >& task) {
324    sp<PathTask> t = static_cast<PathTask* >(task.get());
325    ATRACE_NAME("pathPrecache");
326
327    float left, top, offset;
328    uint32_t width, height;
329    PathCache::computePathBounds(t->path, t->paint, left, top, offset, width, height);
330
331    PathTexture* texture = t->texture;
332    texture->left = left;
333    texture->top = top;
334    texture->offset = offset;
335    texture->width = width;
336    texture->height = height;
337
338    if (width <= mMaxTextureSize && height <= mMaxTextureSize) {
339        SkBitmap* bitmap = new SkBitmap();
340        drawPath(t->path, t->paint, *bitmap, left, top, offset, width, height);
341        t->setResult(bitmap);
342    } else {
343        texture->width = 0;
344        texture->height = 0;
345        t->setResult(NULL);
346    }
347}
348
349///////////////////////////////////////////////////////////////////////////////
350// Paths
351///////////////////////////////////////////////////////////////////////////////
352
353void PathCache::remove(Vector<PathDescription>& pathsToRemove, const path_pair_t& pair) {
354    LruCache<PathDescription, PathTexture*>::Iterator i(mCache);
355
356    while (i.next()) {
357        const PathDescription& key = i.key();
358        if (key.type == kShapePath &&
359                (key.shape.path.mPath == pair.getFirst() ||
360                        key.shape.path.mPath == pair.getSecond())) {
361            pathsToRemove.push(key);
362        }
363    }
364}
365
366void PathCache::removeDeferred(SkPath* path) {
367    Mutex::Autolock l(mLock);
368    mGarbage.push(path_pair_t(path, const_cast<SkPath*>(path->getSourcePath())));
369}
370
371void PathCache::clearGarbage() {
372    Vector<PathDescription> pathsToRemove;
373
374    { // scope for the mutex
375        Mutex::Autolock l(mLock);
376        size_t count = mGarbage.size();
377        for (size_t i = 0; i < count; i++) {
378            remove(pathsToRemove, mGarbage.itemAt(i));
379        }
380        mGarbage.clear();
381    }
382
383    for (size_t i = 0; i < pathsToRemove.size(); i++) {
384        mCache.remove(pathsToRemove.itemAt(i));
385    }
386}
387
388/**
389 * To properly handle path mutations at draw time we always make a copy
390 * of paths objects when recording display lists. The source path points
391 * to the path we originally copied the path from. This ensures we use
392 * the original path as a cache key the first time a path is inserted
393 * in the cache. The source path is also used to reclaim garbage when a
394 * Dalvik Path object is collected.
395 */
396static SkPath* getSourcePath(SkPath* path) {
397    const SkPath* sourcePath = path->getSourcePath();
398    if (sourcePath && sourcePath->getGenerationID() == path->getGenerationID()) {
399        return const_cast<SkPath*>(sourcePath);
400    }
401    return path;
402}
403
404PathTexture* PathCache::get(SkPath* path, SkPaint* paint) {
405    path = getSourcePath(path);
406
407    PathDescription entry(kShapePath, paint);
408    entry.shape.path.mPath = path;
409
410    PathTexture* texture = mCache.get(entry);
411
412    if (!texture) {
413        texture = addTexture(entry, path, paint);
414    } else {
415        // A bitmap is attached to the texture, this means we need to
416        // upload it as a GL texture
417        const sp<Task<SkBitmap*> >& task = texture->task();
418        if (task != NULL) {
419            // But we must first wait for the worker thread to be done
420            // producing the bitmap, so let's wait
421            SkBitmap* bitmap = task->getResult();
422            if (bitmap) {
423                generateTexture(entry, bitmap, texture, false);
424                texture->clearTask();
425            } else {
426                ALOGW("Path too large to be rendered into a texture");
427                texture->clearTask();
428                texture = NULL;
429                mCache.remove(entry);
430            }
431        } else if (path->getGenerationID() != texture->generation) {
432            // The size of the path might have changed so we first
433            // remove the entry from the cache
434            mCache.remove(entry);
435            texture = addTexture(entry, path, paint);
436        }
437    }
438
439    return texture;
440}
441
442void PathCache::precache(SkPath* path, SkPaint* paint) {
443    if (!Caches::getInstance().tasks.canRunTasks()) {
444        return;
445    }
446
447    path = getSourcePath(path);
448
449    PathDescription entry(kShapePath, paint);
450    entry.shape.path.mPath = path;
451
452    PathTexture* texture = mCache.get(entry);
453
454    bool generate = false;
455    if (!texture) {
456        generate = true;
457    } else if (path->getGenerationID() != texture->generation) {
458        mCache.remove(entry);
459        generate = true;
460    }
461
462    if (generate) {
463        // It is important to specify the generation ID so we do not
464        // attempt to precache the same path several times
465        texture = createTexture(0.0f, 0.0f, 0.0f, 0, 0, path->getGenerationID());
466        sp<PathTask> task = new PathTask(path, paint, texture);
467        texture->setTask(task);
468
469        // During the precaching phase we insert path texture objects into
470        // the cache that do not point to any GL texture. They are instead
471        // treated as a task for the precaching worker thread. This is why
472        // we do not check the cache limit when inserting these objects.
473        // The conversion into GL texture will happen in get(), when a client
474        // asks for a path texture. This is also when the cache limit will
475        // be enforced.
476        mCache.put(entry, texture);
477
478        if (mProcessor == NULL) {
479            mProcessor = new PathProcessor(Caches::getInstance());
480        }
481        mProcessor->add(task);
482    }
483}
484
485///////////////////////////////////////////////////////////////////////////////
486// Rounded rects
487///////////////////////////////////////////////////////////////////////////////
488
489PathTexture* PathCache::getRoundRect(float width, float height,
490        float rx, float ry, SkPaint* paint) {
491    PathDescription entry(kShapeRoundRect, paint);
492    entry.shape.roundRect.mWidth = width;
493    entry.shape.roundRect.mHeight = height;
494    entry.shape.roundRect.mRx = rx;
495    entry.shape.roundRect.mRy = ry;
496
497    PathTexture* texture = get(entry);
498
499    if (!texture) {
500        SkPath path;
501        SkRect r;
502        r.set(0.0f, 0.0f, width, height);
503        path.addRoundRect(r, rx, ry, SkPath::kCW_Direction);
504
505        texture = addTexture(entry, &path, paint);
506    }
507
508    return texture;
509}
510
511///////////////////////////////////////////////////////////////////////////////
512// Circles
513///////////////////////////////////////////////////////////////////////////////
514
515PathTexture* PathCache::getCircle(float radius, SkPaint* paint) {
516    PathDescription entry(kShapeCircle, paint);
517    entry.shape.circle.mRadius = radius;
518
519    PathTexture* texture = get(entry);
520
521    if (!texture) {
522        SkPath path;
523        path.addCircle(radius, radius, radius, SkPath::kCW_Direction);
524
525        texture = addTexture(entry, &path, paint);
526    }
527
528    return texture;
529}
530
531///////////////////////////////////////////////////////////////////////////////
532// Ovals
533///////////////////////////////////////////////////////////////////////////////
534
535PathTexture* PathCache::getOval(float width, float height, SkPaint* paint) {
536    PathDescription entry(kShapeOval, paint);
537    entry.shape.oval.mWidth = width;
538    entry.shape.oval.mHeight = height;
539
540    PathTexture* texture = get(entry);
541
542    if (!texture) {
543        SkPath path;
544        SkRect r;
545        r.set(0.0f, 0.0f, width, height);
546        path.addOval(r, SkPath::kCW_Direction);
547
548        texture = addTexture(entry, &path, paint);
549    }
550
551    return texture;
552}
553
554///////////////////////////////////////////////////////////////////////////////
555// Rects
556///////////////////////////////////////////////////////////////////////////////
557
558PathTexture* PathCache::getRect(float width, float height, SkPaint* paint) {
559    PathDescription entry(kShapeRect, paint);
560    entry.shape.rect.mWidth = width;
561    entry.shape.rect.mHeight = height;
562
563    PathTexture* texture = get(entry);
564
565    if (!texture) {
566        SkPath path;
567        SkRect r;
568        r.set(0.0f, 0.0f, width, height);
569        path.addRect(r, SkPath::kCW_Direction);
570
571        texture = addTexture(entry, &path, paint);
572    }
573
574    return texture;
575}
576
577///////////////////////////////////////////////////////////////////////////////
578// Arcs
579///////////////////////////////////////////////////////////////////////////////
580
581PathTexture* PathCache::getArc(float width, float height,
582        float startAngle, float sweepAngle, bool useCenter, SkPaint* paint) {
583    PathDescription entry(kShapeArc, paint);
584    entry.shape.arc.mWidth = width;
585    entry.shape.arc.mHeight = height;
586    entry.shape.arc.mStartAngle = startAngle;
587    entry.shape.arc.mSweepAngle = sweepAngle;
588    entry.shape.arc.mUseCenter = useCenter;
589
590    PathTexture* texture = get(entry);
591
592    if (!texture) {
593        SkPath path;
594        SkRect r;
595        r.set(0.0f, 0.0f, width, height);
596        if (useCenter) {
597            path.moveTo(r.centerX(), r.centerY());
598        }
599        path.arcTo(r, startAngle, sweepAngle, !useCenter);
600        if (useCenter) {
601            path.close();
602        }
603
604        texture = addTexture(entry, &path, paint);
605    }
606
607    return texture;
608}
609
610}; // namespace uirenderer
611}; // namespace android
612