reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 1 | /* |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 2 | * Copyright 2008 The Android Open Source Project |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 3 | * |
epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 6 | */ |
| 7 | |
| 8 | #ifndef SkPixelRef_DEFINED |
| 9 | #define SkPixelRef_DEFINED |
| 10 | |
herb | e6e41a8 | 2015-09-28 11:24:13 -0700 | [diff] [blame] | 11 | #include "../private/SkAtomics.h" |
senorblanco@chromium.org | ef843cd | 2011-12-02 19:11:17 +0000 | [diff] [blame] | 12 | #include "SkBitmap.h" |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 13 | #include "SkFilterQuality.h" |
mtklein | 86821b5 | 2015-02-24 14:38:12 -0800 | [diff] [blame] | 14 | #include "SkImageInfo.h" |
herb | 62a69c2 | 2015-09-29 11:47:45 -0700 | [diff] [blame] | 15 | #include "../private/SkMutex.h" |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 16 | #include "SkPixmap.h" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 17 | #include "SkRefCnt.h" |
sugoi | 518d83d | 2014-07-21 11:37:39 -0700 | [diff] [blame] | 18 | #include "SkSize.h" |
mtklein | 86821b5 | 2015-02-24 14:38:12 -0800 | [diff] [blame] | 19 | #include "SkString.h" |
commit-bot@chromium.org | 50a3043 | 2013-10-24 17:44:27 +0000 | [diff] [blame] | 20 | #include "SkTDArray.h" |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 21 | |
| 22 | class SkColorTable; |
reed@google.com | eb77612 | 2012-12-06 14:26:02 +0000 | [diff] [blame] | 23 | class SkData; |
reed@google.com | 50dfa01 | 2011-04-01 19:05:36 +0000 | [diff] [blame] | 24 | struct SkIRect; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 25 | |
commit-bot@chromium.org | b8d00db | 2013-06-26 19:18:23 +0000 | [diff] [blame] | 26 | class GrTexture; |
reed | 216b643 | 2015-08-19 12:25:40 -0700 | [diff] [blame] | 27 | class SkDiscardableMemory; |
reed@android.com | ce4e53a | 2010-09-09 16:01:26 +0000 | [diff] [blame] | 28 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 29 | /** \class SkPixelRef |
| 30 | |
| 31 | This class is the smart container for pixel memory, and is used with |
| 32 | SkBitmap. A pixelref is installed into a bitmap, and then the bitmap can |
| 33 | access the actual pixel memory by calling lockPixels/unlockPixels. |
| 34 | |
| 35 | This class can be shared/accessed between multiple threads. |
| 36 | */ |
reed | ed45868 | 2014-07-14 09:21:31 -0700 | [diff] [blame] | 37 | class SK_API SkPixelRef : public SkRefCnt { |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 38 | public: |
reed@google.com | f171570 | 2013-12-06 22:07:17 +0000 | [diff] [blame] | 39 | explicit SkPixelRef(const SkImageInfo&); |
commit-bot@chromium.org | 50a3043 | 2013-10-24 17:44:27 +0000 | [diff] [blame] | 40 | virtual ~SkPixelRef(); |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 41 | |
reed@google.com | 9230ea2 | 2013-12-09 22:01:03 +0000 | [diff] [blame] | 42 | const SkImageInfo& info() const { |
| 43 | return fInfo; |
| 44 | } |
| 45 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 46 | /** Return the pixel memory returned from lockPixels, or null if the |
| 47 | lockCount is 0. |
| 48 | */ |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 49 | void* pixels() const { return fRec.fPixels; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 50 | |
| 51 | /** Return the current colorTable (if any) if pixels are locked, or null. |
| 52 | */ |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 53 | SkColorTable* colorTable() const { return fRec.fColorTable; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 54 | |
reed@google.com | 672588b | 2014-01-08 15:42:01 +0000 | [diff] [blame] | 55 | size_t rowBytes() const { return fRec.fRowBytes; } |
| 56 | |
reed@google.com | ff0da4f | 2012-05-17 13:14:52 +0000 | [diff] [blame] | 57 | /** |
reed@google.com | 9271389 | 2014-01-03 17:58:57 +0000 | [diff] [blame] | 58 | * To access the actual pixels of a pixelref, it must be "locked". |
| 59 | * Calling lockPixels returns a LockRec struct (on success). |
| 60 | */ |
| 61 | struct LockRec { |
reed | db74f62 | 2015-05-30 13:41:15 -0700 | [diff] [blame] | 62 | LockRec() : fPixels(NULL), fColorTable(NULL) {} |
| 63 | |
reed@google.com | 9271389 | 2014-01-03 17:58:57 +0000 | [diff] [blame] | 64 | void* fPixels; |
| 65 | SkColorTable* fColorTable; |
| 66 | size_t fRowBytes; |
skia.committer@gmail.com | 98272d9 | 2014-01-04 07:01:40 +0000 | [diff] [blame] | 67 | |
reed@google.com | 9271389 | 2014-01-03 17:58:57 +0000 | [diff] [blame] | 68 | void zero() { sk_bzero(this, sizeof(*this)); } |
| 69 | |
| 70 | bool isZero() const { |
| 71 | return NULL == fPixels && NULL == fColorTable && 0 == fRowBytes; |
| 72 | } |
| 73 | }; |
skia.committer@gmail.com | 98272d9 | 2014-01-04 07:01:40 +0000 | [diff] [blame] | 74 | |
mtklein | 96d68b7 | 2015-02-20 12:40:40 -0800 | [diff] [blame] | 75 | SkDEBUGCODE(bool isLocked() const { return fLockCount > 0; }) |
reed@google.com | ea03360 | 2012-12-14 13:13:55 +0000 | [diff] [blame] | 76 | SkDEBUGCODE(int getLockCount() const { return fLockCount; }) |
| 77 | |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 78 | /** |
| 79 | * Call to access the pixel memory. Return true on success. Balance this |
| 80 | * with a call to unlockPixels(). |
| 81 | */ |
| 82 | bool lockPixels(); |
| 83 | |
| 84 | /** |
| 85 | * Call to access the pixel memory. On success, return true and fill out |
| 86 | * the specified rec. On failure, return false and ignore the rec parameter. |
| 87 | * Balance this with a call to unlockPixels(). |
| 88 | */ |
| 89 | bool lockPixels(LockRec* rec); |
| 90 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 91 | /** Call to balanace a previous call to lockPixels(). Returns the pixels |
| 92 | (or null) after the unlock. NOTE: lock calls can be nested, but the |
| 93 | matching number of unlock calls must be made in order to free the |
| 94 | memory (if the subclass implements caching/deferred-decoding.) |
| 95 | */ |
| 96 | void unlockPixels(); |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 97 | |
reed@google.com | 9c49bc3 | 2011-07-07 13:42:37 +0000 | [diff] [blame] | 98 | /** |
| 99 | * Some bitmaps can return a copy of their pixels for lockPixels(), but |
| 100 | * that copy, if modified, will not be pushed back. These bitmaps should |
| 101 | * not be used as targets for a raster device/canvas (since all pixels |
| 102 | * modifications will be lost when unlockPixels() is called.) |
| 103 | */ |
| 104 | bool lockPixelsAreWritable() const; |
| 105 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 106 | /** Returns a non-zero, unique value corresponding to the pixels in this |
| 107 | pixelref. Each time the pixels are changed (and notifyPixelsChanged is |
| 108 | called), a different generation ID will be returned. |
| 109 | */ |
| 110 | uint32_t getGenerationID() const; |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 111 | |
scroggo | f3ca41c | 2014-11-25 13:42:12 -0800 | [diff] [blame] | 112 | #ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK |
| 113 | /** Returns a non-zero, unique value corresponding to this SkPixelRef. |
| 114 | Unlike the generation ID, this ID remains the same even when the pixels |
| 115 | are changed. IDs are not reused (until uint32_t wraps), so it is safe |
| 116 | to consider this ID unique even after this SkPixelRef is deleted. |
| 117 | |
| 118 | Can be used as a key which uniquely identifies this SkPixelRef |
| 119 | regardless of changes to its pixels or deletion of this object. |
| 120 | */ |
| 121 | uint32_t getStableID() const { return fStableID; } |
| 122 | #endif |
| 123 | |
commit-bot@chromium.org | 0e8d0d6 | 2014-01-27 15:41:07 +0000 | [diff] [blame] | 124 | /** |
| 125 | * Call this if you have changed the contents of the pixels. This will in- |
| 126 | * turn cause a different generation ID value to be returned from |
| 127 | * getGenerationID(). |
commit-bot@chromium.org | 0e8d0d6 | 2014-01-27 15:41:07 +0000 | [diff] [blame] | 128 | */ |
reed@google.com | c1587f9 | 2014-01-28 16:05:39 +0000 | [diff] [blame] | 129 | void notifyPixelsChanged(); |
| 130 | |
| 131 | /** |
| 132 | * Change the info's AlphaType. Note that this does not automatically |
| 133 | * invalidate the generation ID. If the pixel values themselves have |
| 134 | * changed, then you must explicitly call notifyPixelsChanged() as well. |
| 135 | */ |
| 136 | void changeAlphaType(SkAlphaType at); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 137 | |
| 138 | /** Returns true if this pixelref is marked as immutable, meaning that the |
| 139 | contents of its pixels will not change for the lifetime of the pixelref. |
| 140 | */ |
reed | 26e0e58 | 2015-07-29 11:44:52 -0700 | [diff] [blame] | 141 | bool isImmutable() const { return fMutability != kMutable; } |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 142 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 143 | /** Marks this pixelref is immutable, meaning that the contents of its |
| 144 | pixels will not change for the lifetime of the pixelref. This state can |
| 145 | be set on a pixelref, but it cannot be cleared once it is set. |
| 146 | */ |
| 147 | void setImmutable(); |
| 148 | |
| 149 | /** Return the optional URI string associated with this pixelref. May be |
| 150 | null. |
| 151 | */ |
| 152 | const char* getURI() const { return fURI.size() ? fURI.c_str() : NULL; } |
| 153 | |
| 154 | /** Copy a URI string to this pixelref, or clear the URI if the uri is null |
| 155 | */ |
| 156 | void setURI(const char uri[]) { |
| 157 | fURI.set(uri); |
| 158 | } |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 159 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 160 | /** Copy a URI string to this pixelref |
| 161 | */ |
| 162 | void setURI(const char uri[], size_t len) { |
| 163 | fURI.set(uri, len); |
| 164 | } |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 165 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 166 | /** Assign a URI string to this pixelref. |
| 167 | */ |
| 168 | void setURI(const SkString& uri) { fURI = uri; } |
| 169 | |
reed@google.com | eb77612 | 2012-12-06 14:26:02 +0000 | [diff] [blame] | 170 | /** |
| 171 | * If the pixelRef has an encoded (i.e. compressed) representation, |
| 172 | * return a ref to its data. If the pixelRef |
| 173 | * is uncompressed or otherwise does not have this form, return NULL. |
| 174 | * |
| 175 | * If non-null is returned, the caller is responsible for calling unref() |
| 176 | * on the data when it is finished. |
| 177 | */ |
| 178 | SkData* refEncodedData() { |
| 179 | return this->onRefEncodedData(); |
| 180 | } |
| 181 | |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 182 | struct LockRequest { |
| 183 | SkISize fSize; |
| 184 | SkFilterQuality fQuality; |
| 185 | }; |
| 186 | |
| 187 | struct LockResult { |
reed | db74f62 | 2015-05-30 13:41:15 -0700 | [diff] [blame] | 188 | LockResult() : fPixels(NULL), fCTable(NULL) {} |
| 189 | |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 190 | void (*fUnlockProc)(void* ctx); |
| 191 | void* fUnlockContext; |
| 192 | |
reed | 11e833d | 2015-05-30 09:20:29 -0700 | [diff] [blame] | 193 | const void* fPixels; |
reed | db74f62 | 2015-05-30 13:41:15 -0700 | [diff] [blame] | 194 | SkColorTable* fCTable; // should be NULL unless colortype is kIndex8 |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 195 | size_t fRowBytes; |
| 196 | SkISize fSize; |
| 197 | |
| 198 | void unlock() { |
| 199 | if (fUnlockProc) { |
| 200 | fUnlockProc(fUnlockContext); |
| 201 | fUnlockProc = NULL; // can't unlock twice! |
| 202 | } |
| 203 | } |
| 204 | }; |
| 205 | |
| 206 | bool requestLock(const LockRequest&, LockResult*); |
| 207 | |
reed@android.com | ce4e53a | 2010-09-09 16:01:26 +0000 | [diff] [blame] | 208 | /** Are we really wrapping a texture instead of a bitmap? |
| 209 | */ |
commit-bot@chromium.org | b8d00db | 2013-06-26 19:18:23 +0000 | [diff] [blame] | 210 | virtual GrTexture* getTexture() { return NULL; } |
reed@android.com | ce4e53a | 2010-09-09 16:01:26 +0000 | [diff] [blame] | 211 | |
sugoi | 518d83d | 2014-07-21 11:37:39 -0700 | [diff] [blame] | 212 | /** |
| 213 | * If any planes or rowBytes is NULL, this should output the sizes and return true |
| 214 | * if it can efficiently return YUV planar data. If it cannot, it should return false. |
| 215 | * |
| 216 | * If all planes and rowBytes are not NULL, then it should copy the associated Y,U,V data |
| 217 | * into those planes of memory supplied by the caller. It should validate that the sizes |
| 218 | * match what it expected. If the sizes do not match, it should return false. |
rileya | abaef86 | 2014-09-12 17:45:58 -0700 | [diff] [blame] | 219 | * |
| 220 | * If colorSpace is not NULL, the YUV color space of the data should be stored in the address |
| 221 | * it points at. |
sugoi | 518d83d | 2014-07-21 11:37:39 -0700 | [diff] [blame] | 222 | */ |
rileya | abaef86 | 2014-09-12 17:45:58 -0700 | [diff] [blame] | 223 | bool getYUV8Planes(SkISize sizes[3], void* planes[3], size_t rowBytes[3], |
| 224 | SkYUVColorSpace* colorSpace) { |
| 225 | return this->onGetYUV8Planes(sizes, planes, rowBytes, colorSpace); |
sugoi | 518d83d | 2014-07-21 11:37:39 -0700 | [diff] [blame] | 226 | } |
| 227 | |
bsalomon | 9d22fd6 | 2016-01-11 11:14:17 -0800 | [diff] [blame^] | 228 | /** Populates dst with the pixels of this pixelRef, converting them to colorType. */ |
| 229 | bool readPixels(SkBitmap* dst, SkColorType colorType, const SkIRect* subset = NULL); |
reed@google.com | 50dfa01 | 2011-04-01 19:05:36 +0000 | [diff] [blame] | 230 | |
scroggo@google.com | a2a3192 | 2012-12-07 19:14:45 +0000 | [diff] [blame] | 231 | /** |
| 232 | * Makes a deep copy of this PixelRef, respecting the requested config. |
reed | e4538f5 | 2014-06-11 06:09:50 -0700 | [diff] [blame] | 233 | * @param colorType Desired colortype. |
jvanverth | fa1e8a7 | 2014-12-22 08:31:49 -0800 | [diff] [blame] | 234 | * @param profileType Desired colorprofiletype. |
scroggo@google.com | a2a3192 | 2012-12-07 19:14:45 +0000 | [diff] [blame] | 235 | * @param subset Subset of this PixelRef to copy. Must be fully contained within the bounds of |
| 236 | * of this PixelRef. |
| 237 | * @return A new SkPixelRef, or NULL if either there is an error (e.g. the destination could |
| 238 | * not be created with the given config), or this PixelRef does not support deep |
| 239 | * copies. |
| 240 | */ |
jvanverth | fa1e8a7 | 2014-12-22 08:31:49 -0800 | [diff] [blame] | 241 | virtual SkPixelRef* deepCopy(SkColorType, SkColorProfileType, const SkIRect* /*subset*/) { |
scroggo@google.com | a2a3192 | 2012-12-07 19:14:45 +0000 | [diff] [blame] | 242 | return NULL; |
| 243 | } |
senorblanco@chromium.org | ef843cd | 2011-12-02 19:11:17 +0000 | [diff] [blame] | 244 | |
commit-bot@chromium.org | 50a3043 | 2013-10-24 17:44:27 +0000 | [diff] [blame] | 245 | // Register a listener that may be called the next time our generation ID changes. |
| 246 | // |
| 247 | // We'll only call the listener if we're confident that we are the only SkPixelRef with this |
| 248 | // generation ID. If our generation ID changes and we decide not to call the listener, we'll |
| 249 | // never call it: you must add a new listener for each generation ID change. We also won't call |
| 250 | // the listener when we're certain no one knows what our generation ID is. |
| 251 | // |
| 252 | // This can be used to invalidate caches keyed by SkPixelRef generation ID. |
| 253 | struct GenIDChangeListener { |
| 254 | virtual ~GenIDChangeListener() {} |
| 255 | virtual void onChange() = 0; |
| 256 | }; |
| 257 | |
| 258 | // Takes ownership of listener. |
| 259 | void addGenIDChangeListener(GenIDChangeListener* listener); |
| 260 | |
reed | 83787d0 | 2015-02-25 07:17:11 -0800 | [diff] [blame] | 261 | // Call when this pixelref is part of the key to a resourcecache entry. This allows the cache |
| 262 | // to know automatically those entries can be purged when this pixelref is changed or deleted. |
| 263 | void notifyAddedToCache() { |
mtklein | 6101077 | 2015-02-25 08:27:41 -0800 | [diff] [blame] | 264 | fAddedToCache.store(true); |
reed | 83787d0 | 2015-02-25 07:17:11 -0800 | [diff] [blame] | 265 | } |
| 266 | |
reed | 216b643 | 2015-08-19 12:25:40 -0700 | [diff] [blame] | 267 | virtual SkDiscardableMemory* diagnostic_only_getDiscardable() const { return NULL; } |
| 268 | |
fmalita | ddbbdda | 2015-08-20 08:47:26 -0700 | [diff] [blame] | 269 | /** |
| 270 | * Returns true if the pixels are generated on-the-fly (when required). |
| 271 | */ |
| 272 | bool isLazyGenerated() const { return this->onIsLazyGenerated(); } |
| 273 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 274 | protected: |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 275 | /** |
| 276 | * On success, returns true and fills out the LockRec for the pixels. On |
| 277 | * failure returns false and ignores the LockRec parameter. |
| 278 | * |
| 279 | * The caller will have already acquired a mutex for thread safety, so this |
| 280 | * method need not do that. |
| 281 | */ |
| 282 | virtual bool onNewLockPixels(LockRec*) = 0; |
skia.committer@gmail.com | 96f5fa0 | 2013-12-16 07:01:40 +0000 | [diff] [blame] | 283 | |
reed@google.com | c83a91f | 2013-12-13 13:41:14 +0000 | [diff] [blame] | 284 | /** |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 285 | * Balancing the previous successful call to onNewLockPixels. The locked |
| 286 | * pixel address will no longer be referenced, so the subclass is free to |
| 287 | * move or discard that memory. |
reed@google.com | c83a91f | 2013-12-13 13:41:14 +0000 | [diff] [blame] | 288 | * |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 289 | * The caller will have already acquired a mutex for thread safety, so this |
| 290 | * method need not do that. |
reed@google.com | c83a91f | 2013-12-13 13:41:14 +0000 | [diff] [blame] | 291 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 292 | virtual void onUnlockPixels() = 0; |
| 293 | |
reed@google.com | 9c49bc3 | 2011-07-07 13:42:37 +0000 | [diff] [blame] | 294 | /** Default impl returns true */ |
| 295 | virtual bool onLockPixelsAreWritable() const; |
| 296 | |
reed@google.com | 50dfa01 | 2011-04-01 19:05:36 +0000 | [diff] [blame] | 297 | /** |
| 298 | * For pixelrefs that don't have access to their raw pixels, they may be |
| 299 | * able to make a copy of them (e.g. if the pixels are on the GPU). |
| 300 | * |
| 301 | * The base class implementation returns false; |
| 302 | */ |
bsalomon | 9d22fd6 | 2016-01-11 11:14:17 -0800 | [diff] [blame^] | 303 | virtual bool onReadPixels(SkBitmap* dst, SkColorType colorType, const SkIRect* subsetOrNull); |
reed@google.com | 50dfa01 | 2011-04-01 19:05:36 +0000 | [diff] [blame] | 304 | |
reed@google.com | eb77612 | 2012-12-06 14:26:02 +0000 | [diff] [blame] | 305 | // default impl returns NULL. |
| 306 | virtual SkData* onRefEncodedData(); |
| 307 | |
junov | da5469d | 2015-06-15 09:48:15 -0700 | [diff] [blame] | 308 | // default impl does nothing. |
| 309 | virtual void onNotifyPixelsChanged(); |
| 310 | |
sugoi | 518d83d | 2014-07-21 11:37:39 -0700 | [diff] [blame] | 311 | // default impl returns false. |
rileya | abaef86 | 2014-09-12 17:45:58 -0700 | [diff] [blame] | 312 | virtual bool onGetYUV8Planes(SkISize sizes[3], void* planes[3], size_t rowBytes[3], |
| 313 | SkYUVColorSpace* colorSpace); |
sugoi | 518d83d | 2014-07-21 11:37:39 -0700 | [diff] [blame] | 314 | |
commit-bot@chromium.org | cd3b15c | 2013-12-04 17:06:49 +0000 | [diff] [blame] | 315 | /** |
| 316 | * Returns the size (in bytes) of the internally allocated memory. |
| 317 | * This should be implemented in all serializable SkPixelRef derived classes. |
| 318 | * SkBitmap::fPixelRefOffset + SkBitmap::getSafeSize() should never overflow this value, |
| 319 | * otherwise the rendering code may attempt to read memory out of bounds. |
| 320 | * |
| 321 | * @return default impl returns 0. |
| 322 | */ |
| 323 | virtual size_t getAllocatedSizeInBytes() const; |
| 324 | |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 325 | virtual bool onRequestLock(const LockRequest&, LockResult*); |
| 326 | |
fmalita | ddbbdda | 2015-08-20 08:47:26 -0700 | [diff] [blame] | 327 | virtual bool onIsLazyGenerated() const { return false; } |
| 328 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 329 | /** Return the mutex associated with this pixelref. This value is assigned |
| 330 | in the constructor, and cannot change during the lifetime of the object. |
| 331 | */ |
mtklein | 7e6d9c0 | 2015-08-13 14:02:06 -0700 | [diff] [blame] | 332 | SkBaseMutex* mutex() const { return &fMutex; } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 333 | |
reed@google.com | ff0da4f | 2012-05-17 13:14:52 +0000 | [diff] [blame] | 334 | // only call from constructor. Flags this to always be locked, removing |
| 335 | // the need to grab the mutex and call onLockPixels/onUnlockPixels. |
| 336 | // Performance tweak to avoid those calls (esp. in multi-thread use case). |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 337 | void setPreLocked(void*, size_t rowBytes, SkColorTable*); |
reed@google.com | ff0da4f | 2012-05-17 13:14:52 +0000 | [diff] [blame] | 338 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 339 | private: |
mtklein | 7e6d9c0 | 2015-08-13 14:02:06 -0700 | [diff] [blame] | 340 | mutable SkMutex fMutex; |
reed@google.com | 33cc989 | 2014-01-02 18:07:46 +0000 | [diff] [blame] | 341 | |
commit-bot@chromium.org | 0e8d0d6 | 2014-01-27 15:41:07 +0000 | [diff] [blame] | 342 | // mostly const. fInfo.fAlpahType can be changed at runtime. |
reed@google.com | 33cc989 | 2014-01-02 18:07:46 +0000 | [diff] [blame] | 343 | const SkImageInfo fInfo; |
robertphillips@google.com | 0daa1ad | 2013-12-13 15:24:37 +0000 | [diff] [blame] | 344 | |
reed@google.com | d0419b1 | 2014-01-06 17:08:27 +0000 | [diff] [blame] | 345 | // LockRec is only valid if we're in a locked state (isLocked()) |
| 346 | LockRec fRec; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 347 | int fLockCount; |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 348 | |
reed | db74f62 | 2015-05-30 13:41:15 -0700 | [diff] [blame] | 349 | bool lockPixelsInsideMutex(); |
reed | 92fc2ae | 2015-05-22 08:06:21 -0700 | [diff] [blame] | 350 | |
mtklein | 63d0024 | 2015-02-25 09:10:57 -0800 | [diff] [blame] | 351 | // Bottom bit indicates the Gen ID is unique. |
| 352 | bool genIDIsUnique() const { return SkToBool(fTaggedGenID.load() & 1); } |
| 353 | mutable SkAtomic<uint32_t> fTaggedGenID; |
| 354 | |
scroggo | f3ca41c | 2014-11-25 13:42:12 -0800 | [diff] [blame] | 355 | #ifdef SK_BUILD_FOR_ANDROID_FRAMEWORK |
| 356 | const uint32_t fStableID; |
| 357 | #endif |
reed@google.com | 93c5f9e | 2011-02-24 18:09:46 +0000 | [diff] [blame] | 358 | |
commit-bot@chromium.org | 50a3043 | 2013-10-24 17:44:27 +0000 | [diff] [blame] | 359 | SkTDArray<GenIDChangeListener*> fGenIDChangeListeners; // pointers are owned |
scroggo@google.com | d5764e8 | 2012-08-22 15:00:05 +0000 | [diff] [blame] | 360 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 361 | SkString fURI; |
| 362 | |
mtklein | 63d0024 | 2015-02-25 09:10:57 -0800 | [diff] [blame] | 363 | // Set true by caches when they cache content that's derived from the current pixels. |
| 364 | SkAtomic<bool> fAddedToCache; |
reed | 26e0e58 | 2015-07-29 11:44:52 -0700 | [diff] [blame] | 365 | |
| 366 | enum { |
| 367 | kMutable, // PixelRefs begin mutable. |
| 368 | kTemporarilyImmutable, // Considered immutable, but can revert to mutable. |
| 369 | kImmutable, // Once set to this state, it never leaves. |
| 370 | } fMutability : 8; // easily fits inside a byte |
| 371 | |
reed@google.com | ff0da4f | 2012-05-17 13:14:52 +0000 | [diff] [blame] | 372 | // only ever set in constructor, const after that |
mtklein | 63d0024 | 2015-02-25 09:10:57 -0800 | [diff] [blame] | 373 | bool fPreLocked; |
reed@google.com | ff0da4f | 2012-05-17 13:14:52 +0000 | [diff] [blame] | 374 | |
commit-bot@chromium.org | 50a3043 | 2013-10-24 17:44:27 +0000 | [diff] [blame] | 375 | void needsNewGenID(); |
| 376 | void callGenIDChangeListeners(); |
| 377 | |
reed | 26e0e58 | 2015-07-29 11:44:52 -0700 | [diff] [blame] | 378 | void setTemporarilyImmutable(); |
| 379 | void restoreMutability(); |
| 380 | friend class SkSurface_Raster; // For the two methods above. |
| 381 | |
reed | 02d91d1 | 2015-07-30 20:13:43 -0700 | [diff] [blame] | 382 | bool isPreLocked() const { return fPreLocked; } |
| 383 | friend class SkImage_Raster; |
| 384 | |
commit-bot@chromium.org | 50a3043 | 2013-10-24 17:44:27 +0000 | [diff] [blame] | 385 | // When copying a bitmap to another with the same shape and config, we can safely |
| 386 | // clone the pixelref generation ID too, which makes them equivalent under caching. |
| 387 | friend class SkBitmap; // only for cloneGenID |
| 388 | void cloneGenID(const SkPixelRef&); |
| 389 | |
reed | 6f1216a | 2015-08-04 08:10:13 -0700 | [diff] [blame] | 390 | void setImmutableWithID(uint32_t genID); |
| 391 | friend class SkImage_Gpu; |
reed | 8f34372 | 2015-08-13 13:32:39 -0700 | [diff] [blame] | 392 | friend class SkImageCacherator; |
reed | 6f1216a | 2015-08-04 08:10:13 -0700 | [diff] [blame] | 393 | |
reed | ed45868 | 2014-07-14 09:21:31 -0700 | [diff] [blame] | 394 | typedef SkRefCnt INHERITED; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 395 | }; |
| 396 | |
reed@google.com | 9ebcac5 | 2014-01-24 18:53:42 +0000 | [diff] [blame] | 397 | class SkPixelRefFactory : public SkRefCnt { |
| 398 | public: |
| 399 | /** |
| 400 | * Allocate a new pixelref matching the specified ImageInfo, allocating |
| 401 | * the memory for the pixels. If the ImageInfo requires a ColorTable, |
| 402 | * the pixelref will ref() the colortable. |
| 403 | * On failure return NULL. |
| 404 | */ |
reed | f0aed97 | 2014-07-01 12:48:11 -0700 | [diff] [blame] | 405 | virtual SkPixelRef* create(const SkImageInfo&, size_t rowBytes, SkColorTable*) = 0; |
reed@google.com | 9ebcac5 | 2014-01-24 18:53:42 +0000 | [diff] [blame] | 406 | }; |
| 407 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 408 | #endif |