• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2011 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 #ifndef SkWriteBuffer_DEFINED
9 #define SkWriteBuffer_DEFINED
10 
11 #include "include/core/SkColor.h"
12 #include "include/core/SkData.h"
13 #include "include/core/SkRefCnt.h"
14 #include "include/core/SkSamplingOptions.h"
15 #include "include/core/SkScalar.h"
16 #include "include/core/SkSerialProcs.h"
17 #include "src/core/SkTHash.h"
18 #include "src/core/SkWriter32.h"
19 
20 #include <cstddef>
21 #include <cstdint>
22 #include <string_view>
23 
24 class SkFactorySet;
25 class SkFlattenable;
26 class SkImage;
27 class SkM44;
28 class SkMatrix;
29 class SkPaint;
30 class SkPath;
31 class SkRefCntSet;
32 class SkRegion;
33 class SkStream;
34 class SkTypeface;
35 class SkWStream;
36 struct SkIRect;
37 struct SkPoint3;
38 struct SkPoint;
39 struct SkRect;
40 
41 class SkWriteBuffer {
42 public:
SkWriteBuffer()43     SkWriteBuffer() {}
~SkWriteBuffer()44     virtual ~SkWriteBuffer() {}
45 
46     virtual void writePad32(const void* buffer, size_t bytes) = 0;
47 
48     virtual void writeByteArray(const void* data, size_t size) = 0;
writeDataAsByteArray(const SkData * data)49     void writeDataAsByteArray(const SkData* data) {
50         if (!data) {
51             this->write32(0);
52         } else {
53             this->writeByteArray(data->data(), data->size());
54         }
55     }
56 
57     virtual void writeBool(bool value) = 0;
58     virtual void writeScalar(SkScalar value) = 0;
59     virtual void writeScalarArray(const SkScalar* value, uint32_t count) = 0;
60     virtual void writeInt(int32_t value) = 0;
61     virtual void writeIntArray(const int32_t* value, uint32_t count) = 0;
62     virtual void writeUInt(uint32_t value) = 0;
write32(int32_t value)63     void write32(int32_t value) {
64         this->writeInt(value);
65     }
66     virtual void writeString(std::string_view value) = 0;
67 
68     virtual void writeFlattenable(const SkFlattenable* flattenable) = 0;
69     virtual void writeColor(SkColor color) = 0;
70     virtual void writeColorArray(const SkColor* color, uint32_t count) = 0;
71     virtual void writeColor4f(const SkColor4f& color) = 0;
72     virtual void writeColor4fArray(const SkColor4f* color, uint32_t count) = 0;
73     virtual void writePoint(const SkPoint& point) = 0;
74     virtual void writePointArray(const SkPoint* point, uint32_t count) = 0;
75     virtual void writePoint3(const SkPoint3& point) = 0;
76     virtual void write(const SkM44&) = 0;
77     virtual void writeMatrix(const SkMatrix& matrix) = 0;
78     virtual void writeIRect(const SkIRect& rect) = 0;
79     virtual void writeRect(const SkRect& rect) = 0;
80     virtual void writeRegion(const SkRegion& region) = 0;
81     virtual void writeSampling(const SkSamplingOptions&) = 0;
82     virtual void writePath(const SkPath& path) = 0;
83     virtual size_t writeStream(SkStream* stream, size_t length) = 0;
84     virtual void writeImage(const SkImage*) = 0;
85     virtual void writeTypeface(SkTypeface* typeface) = 0;
86     virtual void writePaint(const SkPaint& paint) = 0;
87 
setSerialProcs(const SkSerialProcs & procs)88     void setSerialProcs(const SkSerialProcs& procs) { fProcs = procs; }
89 
90 protected:
91     SkSerialProcs   fProcs;
92 
93     friend class SkPicturePriv; // fProcs
94 };
95 
96 /**
97  * Concrete implementation that serializes to a flat binary blob.
98  */
99 class SkBinaryWriteBuffer : public SkWriteBuffer {
100 public:
101     SkBinaryWriteBuffer();
102     SkBinaryWriteBuffer(void* initialStorage, size_t storageSize);
103     ~SkBinaryWriteBuffer() override;
104 
write(const void * buffer,size_t bytes)105     void write(const void* buffer, size_t bytes) {
106         fWriter.write(buffer, bytes);
107     }
writePad32(const void * buffer,size_t bytes)108     void writePad32(const void* buffer, size_t bytes) override {
109         fWriter.writePad(buffer, bytes);
110     }
111 
112     void reset(void* storage = nullptr, size_t storageSize = 0) {
113         fWriter.reset(storage, storageSize);
114     }
115 
bytesWritten()116     size_t bytesWritten() const { return fWriter.bytesWritten(); }
117 
118     // Returns true iff all of the bytes written so far are stored in the initial storage
119     // buffer provided in the constructor or the most recent call to reset.
120     bool usingInitialStorage() const;
121 
122     void writeByteArray(const void* data, size_t size) override;
123     void writeBool(bool value) override;
124     void writeScalar(SkScalar value) override;
125     void writeScalarArray(const SkScalar* value, uint32_t count) override;
126     void writeInt(int32_t value) override;
127     void writeIntArray(const int32_t* value, uint32_t count) override;
128     void writeUInt(uint32_t value) override;
129     void writeString(std::string_view value) override;
130 
131     void writeFlattenable(const SkFlattenable* flattenable) override;
132     void writeColor(SkColor color) override;
133     void writeColorArray(const SkColor* color, uint32_t count) override;
134     void writeColor4f(const SkColor4f& color) override;
135     void writeColor4fArray(const SkColor4f* color, uint32_t count) override;
136     void writePoint(const SkPoint& point) override;
137     void writePointArray(const SkPoint* point, uint32_t count) override;
138     void writePoint3(const SkPoint3& point) override;
139     void write(const SkM44&) override;
140     void writeMatrix(const SkMatrix& matrix) override;
141     void writeIRect(const SkIRect& rect) override;
142     void writeRect(const SkRect& rect) override;
143     void writeRegion(const SkRegion& region) override;
144     void writeSampling(const SkSamplingOptions&) override;
145     void writePath(const SkPath& path) override;
146     size_t writeStream(SkStream* stream, size_t length) override;
147     void writeImage(const SkImage*) override;
148     void writeTypeface(SkTypeface* typeface) override;
149     void writePaint(const SkPaint& paint) override;
150 
151     bool writeToStream(SkWStream*) const;
writeToMemory(void * dst)152     void writeToMemory(void* dst) const { fWriter.flatten(dst); }
snapshotAsData()153     sk_sp<SkData> snapshotAsData() const { return fWriter.snapshotAsData(); }
154 
155     void setFactoryRecorder(sk_sp<SkFactorySet>);
156     void setTypefaceRecorder(sk_sp<SkRefCntSet>);
157 
158 private:
159     sk_sp<SkFactorySet> fFactorySet;
160     sk_sp<SkRefCntSet> fTFSet;
161 
162     SkWriter32 fWriter;
163 
164     // Only used if we do not have an fFactorySet
165     SkTHashMap<const char*, uint32_t> fFlattenableDict;
166 };
167 
168 enum SkWriteBufferImageFlags {
169     kVersion_bits   = 8,
170     kCurrVersion    = 0,
171 
172     kHasSubsetRect  = 1 << 8,
173     kHasMipmap      = 1 << 9,
174     kUnpremul       = 1 << 10,
175 };
176 
177 
178 #endif // SkWriteBuffer_DEFINED
179