epoger@google.com | ec3ed6a | 2011-07-28 14:26:00 +0000 | [diff] [blame] | 1 | |
| 2 | /* |
| 3 | * Copyright 2011 Google Inc. |
| 4 | * |
| 5 | * Use of this source code is governed by a BSD-style license that can be |
| 6 | * found in the LICENSE file. |
| 7 | */ |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 8 | #ifndef SkPictureRecord_DEFINED |
| 9 | #define SkPictureRecord_DEFINED |
| 10 | |
| 11 | #include "SkCanvas.h" |
| 12 | #include "SkFlattenable.h" |
| 13 | #include "SkPathHeap.h" |
| 14 | #include "SkPicture.h" |
| 15 | #include "SkPictureFlat.h" |
| 16 | #include "SkTemplates.h" |
| 17 | #include "SkWriter32.h" |
| 18 | |
rileya@google.com | 9f5898d | 2012-09-11 20:21:44 +0000 | [diff] [blame] | 19 | class SkPictureStateTree; |
| 20 | class SkBBoxHierarchy; |
| 21 | |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 22 | // These macros help with packing and unpacking a single byte value and |
| 23 | // a 3 byte value into/out of a uint32_t |
| 24 | #define MASK_24 0x00FFFFFF |
| 25 | #define UNPACK_8_24(combined, small, large) \ |
| 26 | small = (combined >> 24) & 0xFF; \ |
| 27 | large = combined & MASK_24; |
| 28 | #define PACK_8_24(small, large) ((small << 24) | large) |
| 29 | |
| 30 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 31 | class SkPictureRecord : public SkCanvas { |
| 32 | public: |
reed@google.com | d86e7ab | 2012-09-27 20:31:31 +0000 | [diff] [blame] | 33 | SkPictureRecord(uint32_t recordFlags, SkDevice*); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 34 | virtual ~SkPictureRecord(); |
| 35 | |
junov@chromium.org | 4e6dfa5 | 2012-07-16 14:04:59 +0000 | [diff] [blame] | 36 | virtual SkDevice* setDevice(SkDevice* device) SK_OVERRIDE; |
| 37 | |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 38 | virtual int save(SaveFlags) SK_OVERRIDE; |
| 39 | virtual int saveLayer(const SkRect* bounds, const SkPaint*, SaveFlags) SK_OVERRIDE; |
| 40 | virtual void restore() SK_OVERRIDE; |
| 41 | virtual bool translate(SkScalar dx, SkScalar dy) SK_OVERRIDE; |
| 42 | virtual bool scale(SkScalar sx, SkScalar sy) SK_OVERRIDE; |
| 43 | virtual bool rotate(SkScalar degrees) SK_OVERRIDE; |
| 44 | virtual bool skew(SkScalar sx, SkScalar sy) SK_OVERRIDE; |
| 45 | virtual bool concat(const SkMatrix& matrix) SK_OVERRIDE; |
| 46 | virtual void setMatrix(const SkMatrix& matrix) SK_OVERRIDE; |
reed@google.com | 071eef9 | 2011-10-12 11:52:53 +0000 | [diff] [blame] | 47 | virtual bool clipRect(const SkRect&, SkRegion::Op, bool) SK_OVERRIDE; |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 48 | virtual bool clipRRect(const SkRRect&, SkRegion::Op, bool) SK_OVERRIDE; |
reed@google.com | 071eef9 | 2011-10-12 11:52:53 +0000 | [diff] [blame] | 49 | virtual bool clipPath(const SkPath&, SkRegion::Op, bool) SK_OVERRIDE; |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 50 | virtual bool clipRegion(const SkRegion& region, SkRegion::Op op) SK_OVERRIDE; |
| 51 | virtual void clear(SkColor) SK_OVERRIDE; |
| 52 | virtual void drawPaint(const SkPaint& paint) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 53 | virtual void drawPoints(PointMode, size_t count, const SkPoint pts[], |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 54 | const SkPaint&) SK_OVERRIDE; |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 55 | virtual void drawOval(const SkRect&, const SkPaint&) SK_OVERRIDE; |
| 56 | virtual void drawRect(const SkRect&, const SkPaint&) SK_OVERRIDE; |
| 57 | virtual void drawRRect(const SkRRect&, const SkPaint&) SK_OVERRIDE; |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 58 | virtual void drawPath(const SkPath& path, const SkPaint&) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 59 | virtual void drawBitmap(const SkBitmap&, SkScalar left, SkScalar top, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 60 | const SkPaint*) SK_OVERRIDE; |
reed@google.com | 7112173 | 2012-09-18 15:14:33 +0000 | [diff] [blame] | 61 | virtual void drawBitmapRectToRect(const SkBitmap&, const SkRect* src, |
| 62 | const SkRect& dst, const SkPaint*) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 63 | virtual void drawBitmapMatrix(const SkBitmap&, const SkMatrix&, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 64 | const SkPaint*) SK_OVERRIDE; |
reed@google.com | f0b5e11 | 2011-09-07 11:57:34 +0000 | [diff] [blame] | 65 | virtual void drawBitmapNine(const SkBitmap& bitmap, const SkIRect& center, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 66 | const SkRect& dst, const SkPaint*) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 67 | virtual void drawSprite(const SkBitmap&, int left, int top, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 68 | const SkPaint*) SK_OVERRIDE; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 69 | virtual void drawText(const void* text, size_t byteLength, SkScalar x, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 70 | SkScalar y, const SkPaint&) SK_OVERRIDE; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 71 | virtual void drawPosText(const void* text, size_t byteLength, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 72 | const SkPoint pos[], const SkPaint&) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 73 | virtual void drawPosTextH(const void* text, size_t byteLength, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 74 | const SkScalar xpos[], SkScalar constY, const SkPaint&) SK_OVERRIDE; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 75 | virtual void drawTextOnPath(const void* text, size_t byteLength, |
| 76 | const SkPath& path, const SkMatrix* matrix, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 77 | const SkPaint&) SK_OVERRIDE; |
| 78 | virtual void drawPicture(SkPicture& picture) SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 79 | virtual void drawVertices(VertexMode, int vertexCount, |
| 80 | const SkPoint vertices[], const SkPoint texs[], |
| 81 | const SkColor colors[], SkXfermode*, |
| 82 | const uint16_t indices[], int indexCount, |
reed@google.com | 2d4297c | 2011-10-06 13:14:12 +0000 | [diff] [blame] | 83 | const SkPaint&) SK_OVERRIDE; |
| 84 | virtual void drawData(const void*, size_t) SK_OVERRIDE; |
junov@chromium.org | 8f9ecbd | 2012-02-13 21:53:45 +0000 | [diff] [blame] | 85 | virtual bool isDrawingToLayer() const SK_OVERRIDE; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 86 | |
junov@chromium.org | 3f5ecd6 | 2013-01-22 18:01:26 +0000 | [diff] [blame] | 87 | void addFontMetricsTopBottom(const SkPaint& paint, const SkFlatData&, |
reed@google.com | 4595426 | 2012-12-07 17:14:40 +0000 | [diff] [blame] | 88 | SkScalar minY, SkScalar maxY); |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 89 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 90 | const SkTDArray<SkPicture* >& getPictureRefs() const { |
| 91 | return fPictureRefs; |
| 92 | } |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 93 | |
junov@chromium.org | 4866cc0 | 2012-06-01 21:23:07 +0000 | [diff] [blame] | 94 | void setFlags(uint32_t recordFlags) { |
| 95 | fRecordFlags = recordFlags; |
| 96 | } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 97 | |
| 98 | const SkWriter32& writeStream() const { |
| 99 | return fWriter; |
| 100 | } |
| 101 | |
reed@google.com | d86e7ab | 2012-09-27 20:31:31 +0000 | [diff] [blame] | 102 | void beginRecording(); |
junov@chromium.org | a6c9e0e | 2012-07-12 17:47:34 +0000 | [diff] [blame] | 103 | void endRecording(); |
reed@google.com | d86e7ab | 2012-09-27 20:31:31 +0000 | [diff] [blame] | 104 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 105 | private: |
junov@chromium.org | e3dbedb | 2012-07-09 16:03:55 +0000 | [diff] [blame] | 106 | void recordRestoreOffsetPlaceholder(SkRegion::Op); |
| 107 | void fillRestoreOffsetPlaceholdersForCurrentStackLevel( |
| 108 | uint32_t restoreOffset); |
| 109 | |
reed@google.com | ffacd3c | 2012-08-30 15:31:23 +0000 | [diff] [blame] | 110 | SkTDArray<int32_t> fRestoreOffsetStack; |
junov@chromium.org | 8f9ecbd | 2012-02-13 21:53:45 +0000 | [diff] [blame] | 111 | int fFirstSavedLayerIndex; |
| 112 | enum { |
| 113 | kNoSavedLayerIndex = -1 |
| 114 | }; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 115 | |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 116 | /* |
| 117 | * Write the 'drawType' operation and chunk size to the skp. 'size' |
| 118 | * can potentially be increased if the chunk size needs its own storage |
| 119 | * location (i.e., it overflows 24 bits). |
| 120 | * Returns the start offset of the chunk. This is the location at which |
| 121 | * the opcode & size are stored. |
| 122 | * TODO: since we are handing the size into here we could call reserve |
| 123 | * and then return a pointer to the memory storage. This could decrease |
| 124 | * allocation overhead but could lead to more wasted space (the tail |
| 125 | * end of blocks could go unused). Possibly add a second addDraw that |
| 126 | * operates in this manner. |
| 127 | */ |
| 128 | uint32_t addDraw(DrawType drawType, uint32_t* size) { |
| 129 | uint32_t offset = fWriter.size(); |
| 130 | |
reed@google.com | 97af1a6 | 2012-08-28 12:19:02 +0000 | [diff] [blame] | 131 | this->predrawNotify(); |
| 132 | |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 133 | #ifdef SK_DEBUG_TRACE |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 134 | SkDebugf("add %s\n", DrawTypeToString(drawType)); |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 135 | #endif |
| 136 | |
| 137 | SkASSERT(0 != *size); |
| 138 | SkASSERT(((uint8_t) drawType) == drawType); |
| 139 | |
| 140 | if (0 != (*size & ~MASK_24) || *size == MASK_24) { |
| 141 | fWriter.writeInt(PACK_8_24(drawType, MASK_24)); |
| 142 | *size += 1; |
| 143 | fWriter.writeInt(*size); |
| 144 | } else { |
| 145 | fWriter.writeInt(PACK_8_24(drawType, *size)); |
| 146 | } |
| 147 | |
| 148 | return offset; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 149 | } |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 150 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 151 | void addInt(int value) { |
| 152 | fWriter.writeInt(value); |
| 153 | } |
| 154 | void addScalar(SkScalar scalar) { |
| 155 | fWriter.writeScalar(scalar); |
| 156 | } |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 157 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 158 | void addBitmap(const SkBitmap& bitmap); |
| 159 | void addMatrix(const SkMatrix& matrix); |
| 160 | void addMatrixPtr(const SkMatrix* matrix); |
junov@chromium.org | f3b1223 | 2013-01-22 17:50:47 +0000 | [diff] [blame] | 161 | const SkFlatData* addPaint(const SkPaint& paint) { return this->addPaintPtr(&paint); } |
| 162 | const SkFlatData* addPaintPtr(const SkPaint* paint); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 163 | void addPath(const SkPath& path); |
| 164 | void addPicture(SkPicture& picture); |
| 165 | void addPoint(const SkPoint& point); |
| 166 | void addPoints(const SkPoint pts[], int count); |
| 167 | void addRect(const SkRect& rect); |
| 168 | void addRectPtr(const SkRect* rect); |
reed@google.com | f0b5e11 | 2011-09-07 11:57:34 +0000 | [diff] [blame] | 169 | void addIRect(const SkIRect& rect); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 170 | void addIRectPtr(const SkIRect* rect); |
reed@google.com | 4ed0fb7 | 2012-12-12 20:48:18 +0000 | [diff] [blame] | 171 | void addRRect(const SkRRect&); |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 172 | void addRegion(const SkRegion& region); |
| 173 | void addText(const void* text, size_t byteLength); |
| 174 | |
junov@chromium.org | 4866cc0 | 2012-06-01 21:23:07 +0000 | [diff] [blame] | 175 | int find(const SkBitmap& bitmap); |
| 176 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 177 | #ifdef SK_DEBUG_DUMP |
| 178 | public: |
| 179 | void dumpMatrices(); |
| 180 | void dumpPaints(); |
| 181 | #endif |
| 182 | |
| 183 | #ifdef SK_DEBUG_SIZE |
| 184 | public: |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 185 | size_t size() const; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 186 | int bitmaps(size_t* size) const; |
| 187 | int matrices(size_t* size) const; |
| 188 | int paints(size_t* size) const; |
| 189 | int paths(size_t* size) const; |
| 190 | int regions(size_t* size) const; |
| 191 | size_t streamlen() const; |
vandebo@chromium.org | 74b4619 | 2012-01-28 01:45:11 +0000 | [diff] [blame] | 192 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 193 | size_t fPointBytes, fRectBytes, fTextBytes; |
| 194 | int fPointWrites, fRectWrites, fTextWrites; |
| 195 | #endif |
| 196 | |
| 197 | #ifdef SK_DEBUG_VALIDATE |
| 198 | public: |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 199 | void validate(uint32_t initialOffset, uint32_t size) const; |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 200 | private: |
| 201 | void validateBitmaps() const; |
| 202 | void validateMatrices() const; |
| 203 | void validatePaints() const; |
| 204 | void validatePaths() const; |
| 205 | void validateRegions() const; |
| 206 | #else |
| 207 | public: |
robertphillips@google.com | 2ca1aaa | 2013-02-15 13:47:37 +0000 | [diff] [blame^] | 208 | void validate(uint32_t initialOffset, uint32_t size) const { |
| 209 | SkASSERT(fWriter.size() == initialOffset + size); |
| 210 | } |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 211 | #endif |
| 212 | |
rileya@google.com | 9f5898d | 2012-09-11 20:21:44 +0000 | [diff] [blame] | 213 | protected: |
| 214 | |
| 215 | // These are set to NULL in our constructor, but may be changed by |
| 216 | // subclasses, in which case they will be SkSafeUnref'd in our destructor. |
| 217 | SkBBoxHierarchy* fBoundingHierarchy; |
| 218 | SkPictureStateTree* fStateTree; |
| 219 | |
robertphillips@google.com | 801cee1 | 2012-10-19 19:06:11 +0000 | [diff] [blame] | 220 | // Allocated in the constructor and managed by this class. |
djsollen@google.com | c9ab987 | 2012-08-29 18:52:07 +0000 | [diff] [blame] | 221 | SkBitmapHeap* fBitmapHeap; |
robertphillips@google.com | 801cee1 | 2012-10-19 19:06:11 +0000 | [diff] [blame] | 222 | |
| 223 | private: |
djsollen@google.com | 21830d9 | 2012-08-07 19:49:41 +0000 | [diff] [blame] | 224 | SkChunkFlatController fFlattenableHeap; |
junov@chromium.org | 4866cc0 | 2012-06-01 21:23:07 +0000 | [diff] [blame] | 225 | |
djsollen@google.com | d2700ee | 2012-05-30 16:54:13 +0000 | [diff] [blame] | 226 | SkMatrixDictionary fMatrices; |
| 227 | SkPaintDictionary fPaints; |
| 228 | SkRegionDictionary fRegions; |
| 229 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 230 | SkPathHeap* fPathHeap; // reference counted |
| 231 | SkWriter32 fWriter; |
| 232 | |
reed@android.com | 09b84a0 | 2009-06-26 20:22:26 +0000 | [diff] [blame] | 233 | // we ref each item in these arrays |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 234 | SkTDArray<SkPicture*> fPictureRefs; |
| 235 | |
reed@android.com | ae814c8 | 2009-02-13 14:56:09 +0000 | [diff] [blame] | 236 | uint32_t fRecordFlags; |
junov@chromium.org | 4e6dfa5 | 2012-07-16 14:04:59 +0000 | [diff] [blame] | 237 | int fInitialSaveCount; |
reed@android.com | ae814c8 | 2009-02-13 14:56:09 +0000 | [diff] [blame] | 238 | |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 239 | friend class SkPicturePlayback; |
junov@chromium.org | 1cc8f6f | 2012-02-22 21:00:42 +0000 | [diff] [blame] | 240 | friend class SkPictureTester; // for unit testing |
reed@android.com | 8a1c16f | 2008-12-17 15:59:43 +0000 | [diff] [blame] | 241 | |
| 242 | typedef SkCanvas INHERITED; |
| 243 | }; |
| 244 | |
| 245 | #endif |