reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #include "SkBitmapCache.h" |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 9 | #include "SkImage.h" |
reed | 011f39a | 2014-08-28 13:35:23 -0700 | [diff] [blame] | 10 | #include "SkResourceCache.h" |
reed | 680fb9e | 2014-08-26 09:08:04 -0700 | [diff] [blame] | 11 | #include "SkMipMap.h" |
reed | 83787d0 | 2015-02-25 07:17:11 -0800 | [diff] [blame] | 12 | #include "SkPixelRef.h" |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 13 | #include "SkRect.h" |
| 14 | |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 15 | /** |
| 16 | * Use this for bitmapcache and mipmapcache entries. |
| 17 | */ |
| 18 | uint64_t SkMakeResourceCacheSharedIDForBitmap(uint32_t bitmapGenID) { |
| 19 | uint64_t sharedID = SkSetFourByteTag('b', 'm', 'a', 'p'); |
| 20 | return (sharedID << 32) | bitmapGenID; |
| 21 | } |
| 22 | |
| 23 | void SkNotifyBitmapGenIDIsStale(uint32_t bitmapGenID) { |
| 24 | SkResourceCache::PostPurgeSharedID(SkMakeResourceCacheSharedIDForBitmap(bitmapGenID)); |
| 25 | } |
| 26 | |
| 27 | /////////////////////////////////////////////////////////////////////////////////////////////////// |
| 28 | |
reed | 14b6aba | 2014-08-29 10:25:26 -0700 | [diff] [blame] | 29 | SkBitmap::Allocator* SkBitmapCache::GetAllocator() { |
| 30 | return SkResourceCache::GetAllocator(); |
| 31 | } |
| 32 | |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 33 | /** |
| 34 | This function finds the bounds of the bitmap *within its pixelRef*. |
| 35 | If the bitmap lacks a pixelRef, it will return an empty rect, since |
| 36 | that doesn't make sense. This may be a useful enough function that |
| 37 | it should be somewhere else (in SkBitmap?). |
| 38 | */ |
| 39 | static SkIRect get_bounds_from_bitmap(const SkBitmap& bm) { |
| 40 | if (!(bm.pixelRef())) { |
| 41 | return SkIRect::MakeEmpty(); |
| 42 | } |
| 43 | SkIPoint origin = bm.pixelRefOrigin(); |
| 44 | return SkIRect::MakeXYWH(origin.fX, origin.fY, bm.width(), bm.height()); |
| 45 | } |
| 46 | |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 47 | /** |
| 48 | * This function finds the bounds of the image. Today this is just the entire bounds, |
| 49 | * but in the future we may support subsets within an image, in which case this should |
| 50 | * return that subset (see get_bounds_from_bitmap). |
| 51 | */ |
| 52 | static SkIRect get_bounds_from_image(const SkImage* image) { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 53 | SkASSERT(image->width() > 0 && image->height() > 0); |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 54 | return SkIRect::MakeWH(image->width(), image->height()); |
| 55 | } |
| 56 | |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 57 | SkBitmapCacheDesc SkBitmapCacheDesc::Make(uint32_t imageID, int origWidth, int origHeight) { |
| 58 | SkASSERT(imageID); |
| 59 | SkASSERT(origWidth > 0 && origHeight > 0); |
| 60 | return { imageID, 0, 0, {0, 0, origWidth, origHeight} }; |
| 61 | } |
| 62 | |
| 63 | SkBitmapCacheDesc SkBitmapCacheDesc::Make(const SkBitmap& bm, int scaledWidth, int scaledHeight) { |
| 64 | SkASSERT(bm.width() > 0 && bm.height() > 0); |
| 65 | SkASSERT(scaledWidth > 0 && scaledHeight > 0); |
| 66 | SkASSERT(scaledWidth != bm.width() || scaledHeight != bm.height()); |
| 67 | |
| 68 | return { bm.getGenerationID(), scaledWidth, scaledHeight, get_bounds_from_bitmap(bm) }; |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 69 | } |
| 70 | |
| 71 | SkBitmapCacheDesc SkBitmapCacheDesc::Make(const SkBitmap& bm) { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 72 | SkASSERT(bm.width() > 0 && bm.height() > 0); |
| 73 | SkASSERT(bm.pixelRefOrigin() == SkIPoint::Make(0, 0)); |
| 74 | |
| 75 | return { bm.getGenerationID(), 0, 0, get_bounds_from_bitmap(bm) }; |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 76 | } |
| 77 | |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 78 | SkBitmapCacheDesc SkBitmapCacheDesc::Make(const SkImage* image, int scaledWidth, int scaledHeight) { |
| 79 | SkASSERT(image->width() > 0 && image->height() > 0); |
| 80 | SkASSERT(scaledWidth > 0 && scaledHeight > 0); |
| 81 | |
| 82 | // If the dimensions are the same, should we set them to 0,0? |
| 83 | //SkASSERT(scaledWidth != image->width() || scaledHeight != image->height()); |
| 84 | |
| 85 | return { image->uniqueID(), scaledWidth, scaledHeight, get_bounds_from_image(image) }; |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 86 | } |
| 87 | |
| 88 | SkBitmapCacheDesc SkBitmapCacheDesc::Make(const SkImage* image) { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 89 | SkASSERT(image->width() > 0 && image->height() > 0); |
| 90 | |
| 91 | return { image->uniqueID(), 0, 0, get_bounds_from_image(image) }; |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 92 | } |
| 93 | |
fmalita | 171e5b7 | 2014-10-22 11:20:40 -0700 | [diff] [blame] | 94 | namespace { |
| 95 | static unsigned gBitmapKeyNamespaceLabel; |
| 96 | |
reed | 011f39a | 2014-08-28 13:35:23 -0700 | [diff] [blame] | 97 | struct BitmapKey : public SkResourceCache::Key { |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 98 | public: |
Mike Reed | d3a2af7 | 2016-11-07 14:30:00 -0500 | [diff] [blame] | 99 | BitmapKey(const SkBitmapCacheDesc& desc) : fDesc(desc) { |
| 100 | this->init(&gBitmapKeyNamespaceLabel, SkMakeResourceCacheSharedIDForBitmap(fDesc.fImageID), |
| 101 | sizeof(fDesc)); |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 102 | } |
qiankun.miao | 045bb7f | 2014-08-25 06:08:25 -0700 | [diff] [blame] | 103 | |
reed | 995b4bd | 2015-09-14 10:27:57 -0700 | [diff] [blame] | 104 | void dump() const { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 105 | SkDebugf("-- add [%d %d] %d [%d %d %d %d]\n", |
| 106 | fDesc.fScaledWidth, fDesc.fScaledHeight, fDesc.fImageID, |
| 107 | fDesc.fSubset.x(), fDesc.fSubset.y(), fDesc.fSubset.width(), fDesc.fSubset.height()); |
reed | 995b4bd | 2015-09-14 10:27:57 -0700 | [diff] [blame] | 108 | } |
| 109 | |
Mike Reed | d3a2af7 | 2016-11-07 14:30:00 -0500 | [diff] [blame] | 110 | const SkBitmapCacheDesc fDesc; |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 111 | }; |
| 112 | |
reed | 011f39a | 2014-08-28 13:35:23 -0700 | [diff] [blame] | 113 | struct BitmapRec : public SkResourceCache::Rec { |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 114 | BitmapRec(const SkBitmapCacheDesc& desc, const SkBitmap& result) |
| 115 | : fKey(desc) |
| 116 | , fBitmap(result) |
| 117 | { |
| 118 | #ifdef TRACE_NEW_BITMAP_CACHE_RECS |
| 119 | fKey.dump(); |
| 120 | #endif |
| 121 | } |
| 122 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 123 | const Key& getKey() const override { return fKey; } |
| 124 | size_t bytesUsed() const override { return sizeof(fKey) + fBitmap.getSize(); } |
reed | 680fb9e | 2014-08-26 09:08:04 -0700 | [diff] [blame] | 125 | |
reed | 216b643 | 2015-08-19 12:25:40 -0700 | [diff] [blame] | 126 | const char* getCategory() const override { return "bitmap"; } |
| 127 | SkDiscardableMemory* diagnostic_only_getDiscardable() const override { |
| 128 | return fBitmap.pixelRef()->diagnostic_only_getDiscardable(); |
| 129 | } |
| 130 | |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 131 | static bool Finder(const SkResourceCache::Rec& baseRec, void* contextBitmap) { |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 132 | const BitmapRec& rec = static_cast<const BitmapRec&>(baseRec); |
| 133 | SkBitmap* result = (SkBitmap*)contextBitmap; |
reed | 595aa05 | 2014-09-15 10:15:18 -0700 | [diff] [blame] | 134 | |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 135 | *result = rec.fBitmap; |
reed | 595aa05 | 2014-09-15 10:15:18 -0700 | [diff] [blame] | 136 | result->lockPixels(); |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 137 | return SkToBool(result->getPixels()); |
reed | 595aa05 | 2014-09-15 10:15:18 -0700 | [diff] [blame] | 138 | } |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 139 | |
| 140 | private: |
| 141 | BitmapKey fKey; |
| 142 | SkBitmap fBitmap; |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 143 | }; |
fmalita | 171e5b7 | 2014-10-22 11:20:40 -0700 | [diff] [blame] | 144 | } // namespace |
reed | 595aa05 | 2014-09-15 10:15:18 -0700 | [diff] [blame] | 145 | |
reed | 30ad530 | 2014-09-16 10:39:55 -0700 | [diff] [blame] | 146 | #define CHECK_LOCAL(localCache, localName, globalName, ...) \ |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 147 | ((localCache) ? localCache->localName(__VA_ARGS__) : SkResourceCache::globalName(__VA_ARGS__)) |
reed | 30ad530 | 2014-09-16 10:39:55 -0700 | [diff] [blame] | 148 | |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 149 | bool SkBitmapCache::Find(const SkBitmapCacheDesc& desc, SkBitmap* result, |
| 150 | SkResourceCache* localCache) { |
| 151 | desc.validate(); |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 152 | return CHECK_LOCAL(localCache, find, Find, BitmapKey(desc), BitmapRec::Finder, result); |
| 153 | } |
| 154 | |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 155 | bool SkBitmapCache::Add(const SkBitmapCacheDesc& desc, const SkBitmap& result, |
| 156 | SkResourceCache* localCache) { |
| 157 | desc.validate(); |
reed | 14b6aba | 2014-08-29 10:25:26 -0700 | [diff] [blame] | 158 | SkASSERT(result.isImmutable()); |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 159 | BitmapRec* rec = new BitmapRec(desc, result); |
reed | 30ad530 | 2014-09-16 10:39:55 -0700 | [diff] [blame] | 160 | CHECK_LOCAL(localCache, add, Add, rec); |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 161 | return true; |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 162 | } |
| 163 | |
reed | 680fb9e | 2014-08-26 09:08:04 -0700 | [diff] [blame] | 164 | ////////////////////////////////////////////////////////////////////////////////////////// |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 165 | ////////////////////////////////////////////////////////////////////////////////////////// |
| 166 | |
| 167 | namespace { |
| 168 | static unsigned gMipMapKeyNamespaceLabel; |
| 169 | |
| 170 | struct MipMapKey : public SkResourceCache::Key { |
| 171 | public: |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 172 | MipMapKey(uint32_t imageID, const SkIRect& subset, SkDestinationSurfaceColorMode colorMode) |
| 173 | : fImageID(imageID) |
| 174 | , fColorMode(static_cast<uint32_t>(colorMode)) |
| 175 | , fSubset(subset) |
reed | 6644d93 | 2016-06-10 11:41:47 -0700 | [diff] [blame] | 176 | { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 177 | SkASSERT(fImageID); |
| 178 | SkASSERT(!subset.isEmpty()); |
| 179 | this->init(&gMipMapKeyNamespaceLabel, SkMakeResourceCacheSharedIDForBitmap(fImageID), |
| 180 | sizeof(fImageID) + sizeof(fColorMode) + sizeof(fSubset)); |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 181 | } |
| 182 | |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 183 | uint32_t fImageID; |
Brian Osman | 7b8400d | 2016-11-08 17:08:54 -0500 | [diff] [blame] | 184 | uint32_t fColorMode; |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 185 | SkIRect fSubset; |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 186 | }; |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 187 | |
reed | 011f39a | 2014-08-28 13:35:23 -0700 | [diff] [blame] | 188 | struct MipMapRec : public SkResourceCache::Rec { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 189 | MipMapRec(uint32_t imageID, const SkIRect& subset, SkDestinationSurfaceColorMode colorMode, |
| 190 | const SkMipMap* result) |
| 191 | : fKey(imageID, subset, colorMode) |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 192 | , fMipMap(result) |
| 193 | { |
| 194 | fMipMap->attachToCacheAndRef(); |
reed | 92561a0 | 2014-10-02 13:47:08 -0700 | [diff] [blame] | 195 | } |
piotaixr | 42b0dfe | 2014-09-03 11:33:13 -0700 | [diff] [blame] | 196 | |
Brian Salomon | d3b6597 | 2017-03-22 12:05:03 -0400 | [diff] [blame] | 197 | ~MipMapRec() override { |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 198 | fMipMap->detachFromCacheAndUnref(); |
| 199 | } |
reed | 37c5a81 | 2014-10-03 13:23:30 -0700 | [diff] [blame] | 200 | |
mtklein | 36352bf | 2015-03-25 18:17:31 -0700 | [diff] [blame] | 201 | const Key& getKey() const override { return fKey; } |
| 202 | size_t bytesUsed() const override { return sizeof(fKey) + fMipMap->size(); } |
reed | 216b643 | 2015-08-19 12:25:40 -0700 | [diff] [blame] | 203 | const char* getCategory() const override { return "mipmap"; } |
| 204 | SkDiscardableMemory* diagnostic_only_getDiscardable() const override { |
| 205 | return fMipMap->diagnostic_only_getDiscardable(); |
| 206 | } |
reed | 680fb9e | 2014-08-26 09:08:04 -0700 | [diff] [blame] | 207 | |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 208 | static bool Finder(const SkResourceCache::Rec& baseRec, void* contextMip) { |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 209 | const MipMapRec& rec = static_cast<const MipMapRec&>(baseRec); |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 210 | const SkMipMap* mm = SkRef(rec.fMipMap); |
| 211 | // the call to ref() above triggers a "lock" in the case of discardable memory, |
| 212 | // which means we can now check for null (in case the lock failed). |
halcanary | 96fcdcc | 2015-08-27 07:41:13 -0700 | [diff] [blame] | 213 | if (nullptr == mm->data()) { |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 214 | mm->unref(); // balance our call to ref() |
| 215 | return false; |
| 216 | } |
| 217 | // the call must call unref() when they are done. |
| 218 | *(const SkMipMap**)contextMip = mm; |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 219 | return true; |
| 220 | } |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 221 | |
| 222 | private: |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 223 | MipMapKey fKey; |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 224 | const SkMipMap* fMipMap; |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 225 | }; |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 226 | } |
reed | 595aa05 | 2014-09-15 10:15:18 -0700 | [diff] [blame] | 227 | |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 228 | const SkMipMap* SkMipMapCache::FindAndRef(const SkBitmapCacheDesc& desc, |
Brian Osman | 7b8400d | 2016-11-08 17:08:54 -0500 | [diff] [blame] | 229 | SkDestinationSurfaceColorMode colorMode, |
reed | 98ed7b6 | 2015-09-15 12:38:12 -0700 | [diff] [blame] | 230 | SkResourceCache* localCache) { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 231 | SkASSERT(desc.fScaledWidth == 0); |
| 232 | SkASSERT(desc.fScaledHeight == 0); |
| 233 | MipMapKey key(desc.fImageID, desc.fSubset, colorMode); |
reed | c90e014 | 2014-09-15 11:39:44 -0700 | [diff] [blame] | 234 | const SkMipMap* result; |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 235 | |
reed | 7eeba25 | 2015-02-24 13:54:23 -0800 | [diff] [blame] | 236 | if (!CHECK_LOCAL(localCache, find, Find, key, MipMapRec::Finder, &result)) { |
halcanary | 96fcdcc | 2015-08-27 07:41:13 -0700 | [diff] [blame] | 237 | result = nullptr; |
reed | 680fb9e | 2014-08-26 09:08:04 -0700 | [diff] [blame] | 238 | } |
| 239 | return result; |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 240 | } |
| 241 | |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 242 | static SkResourceCache::DiscardableFactory get_fact(SkResourceCache* localCache) { |
| 243 | return localCache ? localCache->GetDiscardableFactory() |
| 244 | : SkResourceCache::GetDiscardableFactory(); |
| 245 | } |
| 246 | |
Brian Osman | 7b8400d | 2016-11-08 17:08:54 -0500 | [diff] [blame] | 247 | const SkMipMap* SkMipMapCache::AddAndRef(const SkBitmap& src, |
| 248 | SkDestinationSurfaceColorMode colorMode, |
reed | 6644d93 | 2016-06-10 11:41:47 -0700 | [diff] [blame] | 249 | SkResourceCache* localCache) { |
Brian Osman | 7b8400d | 2016-11-08 17:08:54 -0500 | [diff] [blame] | 250 | SkMipMap* mipmap = SkMipMap::Build(src, colorMode, get_fact(localCache)); |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 251 | if (mipmap) { |
Mike Reed | 5fa3d6d | 2017-03-25 09:51:00 -0400 | [diff] [blame^] | 252 | MipMapRec* rec = new MipMapRec(src.getGenerationID(), get_bounds_from_bitmap(src), |
| 253 | colorMode, mipmap); |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 254 | CHECK_LOCAL(localCache, add, Add, rec); |
reed | 83787d0 | 2015-02-25 07:17:11 -0800 | [diff] [blame] | 255 | src.pixelRef()->notifyAddedToCache(); |
reed | 680fb9e | 2014-08-26 09:08:04 -0700 | [diff] [blame] | 256 | } |
reed | 9d93c2e | 2014-10-08 05:17:12 -0700 | [diff] [blame] | 257 | return mipmap; |
reed | 0461713 | 2014-08-21 09:46:49 -0700 | [diff] [blame] | 258 | } |