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 #ifndef ToolUtils_DEFINED
9 #define ToolUtils_DEFINED
10
11 #include "include/core/SkColor.h"
12 #include "include/core/SkData.h"
13 #include "include/core/SkEncodedImageFormat.h"
14 #include "include/core/SkFont.h"
15 #include "include/core/SkFontStyle.h"
16 #include "include/core/SkFontTypes.h"
17 #include "include/core/SkImageEncoder.h"
18 #include "include/core/SkImageInfo.h"
19 #include "include/core/SkPixmap.h"
20 #include "include/core/SkRect.h"
21 #include "include/core/SkRefCnt.h"
22 #include "include/core/SkScalar.h"
23 #include "include/core/SkStream.h"
24 #include "include/core/SkSurface.h"
25 #include "include/core/SkTypeface.h"
26 #include "include/core/SkTypes.h"
27 #include "include/private/SkTArray.h"
28 #include "include/private/SkTDArray.h"
29 #include "include/utils/SkRandom.h"
30 #include "src/core/SkTInternalLList.h"
31
32 class SkBitmap;
33 class SkCanvas;
34 class SkFontStyle;
35 class SkImage;
36 class SkPath;
37 class SkPixmap;
38 class SkRRect;
39 class SkShader;
40 class SkSurface;
41 class SkSurfaceProps;
42 class SkTextBlobBuilder;
43 class SkTypeface;
44
45 namespace ToolUtils {
46
47 const char* alphatype_name (SkAlphaType);
48 const char* colortype_name (SkColorType);
49 const char* colortype_depth(SkColorType); // like colortype_name, but channel order agnostic
50 const char* tilemode_name(SkTileMode);
51
52 /**
53 * Map opaque colors from 8888 to 565.
54 */
55 SkColor color_to_565(SkColor color);
56
57 /* Return a color emoji typeface with planets to scale if available. */
58 sk_sp<SkTypeface> planet_typeface();
59
60 /** Return a color emoji typeface if available. */
61 sk_sp<SkTypeface> emoji_typeface();
62
63 /** Sample text for the emoji_typeface font. */
64 const char* emoji_sample_text();
65
66 /** A simple SkUserTypeface for testing. */
67 sk_sp<SkTypeface> sample_user_typeface();
68
69 /**
70 * Returns a platform-independent text renderer.
71 */
72 sk_sp<SkTypeface> create_portable_typeface(const char* name, SkFontStyle style);
73
create_portable_typeface()74 static inline sk_sp<SkTypeface> create_portable_typeface() {
75 return create_portable_typeface(nullptr, SkFontStyle());
76 }
77
78 void get_text_path(const SkFont&,
79 const void* text,
80 size_t length,
81 SkTextEncoding,
82 SkPath*,
83 const SkPoint* positions = nullptr);
84
85 /**
86 * Returns true iff all of the pixels between the two images are identical.
87 *
88 * If the configs differ, return false.
89 */
90 bool equal_pixels(const SkPixmap&, const SkPixmap&);
91 bool equal_pixels(const SkBitmap&, const SkBitmap&);
92 bool equal_pixels(const SkImage* a, const SkImage* b);
93
94 /** Returns a newly created CheckerboardShader. */
95 sk_sp<SkShader> create_checkerboard_shader(SkColor c1, SkColor c2, int size);
96
97 /** Draw a checkerboard pattern in the current canvas, restricted to
98 the current clip, using SkXfermode::kSrc_Mode. */
99 void draw_checkerboard(SkCanvas* canvas, SkColor color1, SkColor color2, int checkSize);
100
101 /** Make it easier to create a bitmap-based checkerboard */
102 SkBitmap create_checkerboard_bitmap(int w, int h, SkColor c1, SkColor c2, int checkSize);
103
104 sk_sp<SkImage> create_checkerboard_image(int w, int h, SkColor c1, SkColor c2, int checkSize);
105
106 /** A default checkerboard. */
draw_checkerboard(SkCanvas * canvas)107 inline void draw_checkerboard(SkCanvas* canvas) {
108 ToolUtils::draw_checkerboard(canvas, 0xFF999999, 0xFF666666, 8);
109 }
110
111 SkBitmap create_string_bitmap(int w, int h, SkColor c, int x, int y, int textSize, const char* str);
112 sk_sp<SkImage> create_string_image(int w, int h, SkColor c, int x, int y, int textSize, const char* str);
113
114 // If the canvas does't make a surface (e.g. recording), make a raster surface
115 sk_sp<SkSurface> makeSurface(SkCanvas*, const SkImageInfo&, const SkSurfaceProps* = nullptr);
116
117 // A helper for inserting a drawtext call into a SkTextBlobBuilder
118 void add_to_text_blob_w_len(SkTextBlobBuilder*,
119 const char* text,
120 size_t len,
121 SkTextEncoding,
122 const SkFont&,
123 SkScalar x,
124 SkScalar y);
125
126 void add_to_text_blob(SkTextBlobBuilder*, const char* text, const SkFont&, SkScalar x, SkScalar y);
127
128 // Constructs a star by walking a 'numPts'-sided regular polygon with even/odd fill:
129 //
130 // moveTo(pts[0]);
131 // lineTo(pts[step % numPts]);
132 // ...
133 // lineTo(pts[(step * (N - 1)) % numPts]);
134 //
135 // numPts=5, step=2 will produce a classic five-point star.
136 //
137 // numPts and step must be co-prime.
138 SkPath make_star(const SkRect& bounds, int numPts = 5, int step = 2);
139
140 void create_hemi_normal_map(SkBitmap* bm, const SkIRect& dst);
141
142 void create_frustum_normal_map(SkBitmap* bm, const SkIRect& dst);
143
144 void create_tetra_normal_map(SkBitmap* bm, const SkIRect& dst);
145
146 // A helper object to test the topological sorting code (TopoSortBench.cpp & TopoSortTest.cpp)
147 class TopoTestNode : public SkRefCnt {
148 public:
TopoTestNode(int id)149 TopoTestNode(int id) : fID(id) {}
150
dependsOn(TopoTestNode * src)151 void dependsOn(TopoTestNode* src) { *fDependencies.append() = src; }
targets(uint32_t target)152 void targets(uint32_t target) { *fTargets.append() = target; }
153
id()154 int id() const { return fID; }
reset()155 void reset() {
156 fOutputPos = 0;
157 fTempMark = false;
158 fWasOutput = false;
159 }
160
outputPos()161 uint32_t outputPos() const {
162 SkASSERT(fWasOutput);
163 return fOutputPos;
164 }
165
166 // check that the topological sort is valid for this node
check()167 bool check() {
168 if (!fWasOutput) {
169 return false;
170 }
171
172 for (int i = 0; i < fDependencies.count(); ++i) {
173 if (!fDependencies[i]->fWasOutput) {
174 return false;
175 }
176 // This node should've been output after all the nodes on which it depends
177 if (fOutputPos < fDependencies[i]->outputPos()) {
178 return false;
179 }
180 }
181
182 return true;
183 }
184
185 // The following 7 methods are needed by the topological sort
SetTempMark(TopoTestNode * node)186 static void SetTempMark(TopoTestNode* node) { node->fTempMark = true; }
ResetTempMark(TopoTestNode * node)187 static void ResetTempMark(TopoTestNode* node) { node->fTempMark = false; }
IsTempMarked(TopoTestNode * node)188 static bool IsTempMarked(TopoTestNode* node) { return node->fTempMark; }
Output(TopoTestNode * node,uint32_t outputPos)189 static void Output(TopoTestNode* node, uint32_t outputPos) {
190 SkASSERT(!node->fWasOutput);
191 node->fOutputPos = outputPos;
192 node->fWasOutput = true;
193 }
WasOutput(TopoTestNode * node)194 static bool WasOutput(TopoTestNode* node) { return node->fWasOutput; }
GetIndex(TopoTestNode * node)195 static uint32_t GetIndex(TopoTestNode* node) { return node->outputPos(); }
NumDependencies(TopoTestNode * node)196 static int NumDependencies(TopoTestNode* node) { return node->fDependencies.count(); }
Dependency(TopoTestNode * node,int index)197 static TopoTestNode* Dependency(TopoTestNode* node, int index) {
198 return node->fDependencies[index];
199 }
NumTargets(TopoTestNode * node)200 static int NumTargets(TopoTestNode* node) { return node->fTargets.count(); }
GetTarget(TopoTestNode * node,int i)201 static uint32_t GetTarget(TopoTestNode* node, int i) { return node->fTargets[i]; }
GetID(TopoTestNode * node)202 static uint32_t GetID(TopoTestNode* node) { return node->id(); }
203
204 // Helper functions for TopoSortBench & TopoSortTest
AllocNodes(SkTArray<sk_sp<ToolUtils::TopoTestNode>> * graph,int num)205 static void AllocNodes(SkTArray<sk_sp<ToolUtils::TopoTestNode>>* graph, int num) {
206 graph->reserve_back(num);
207
208 for (int i = 0; i < num; ++i) {
209 graph->push_back(sk_sp<TopoTestNode>(new TopoTestNode(i)));
210 }
211 }
212
213 #ifdef SK_DEBUG
Print(const SkTArray<TopoTestNode * > & graph)214 static void Print(const SkTArray<TopoTestNode*>& graph) {
215 for (int i = 0; i < graph.count(); ++i) {
216 SkDebugf("%d, ", graph[i]->id());
217 }
218 SkDebugf("\n");
219 }
220 #endif
221
222 // randomize the array
Shuffle(SkTArray<sk_sp<TopoTestNode>> * graph,SkRandom * rand)223 static void Shuffle(SkTArray<sk_sp<TopoTestNode>>* graph, SkRandom* rand) {
224 for (int i = graph->count() - 1; i > 0; --i) {
225 int swap = rand->nextU() % (i + 1);
226
227 (*graph)[i].swap((*graph)[swap]);
228 }
229 }
230
231 SK_DECLARE_INTERNAL_LLIST_INTERFACE(TopoTestNode);
232
233 private:
234 int fID;
235 uint32_t fOutputPos = 0;
236 bool fTempMark = false;
237 bool fWasOutput = false;
238
239 SkTDArray<TopoTestNode*> fDependencies;
240 SkTDArray<uint32_t> fTargets;
241 };
242
243 template <typename T>
EncodeImageToFile(const char * path,const T & src,SkEncodedImageFormat f,int q)244 inline bool EncodeImageToFile(const char* path, const T& src, SkEncodedImageFormat f, int q) {
245 SkFILEWStream file(path);
246 return file.isValid() && SkEncodeImage(&file, src, f, q);
247 }
248
249 bool copy_to(SkBitmap* dst, SkColorType dstCT, const SkBitmap& src);
250 void copy_to_g8(SkBitmap* dst, const SkBitmap& src);
251
252 class PixelIter {
253 public:
254 PixelIter();
PixelIter(SkSurface * surf)255 PixelIter(SkSurface* surf) {
256 SkPixmap pm;
257 if (!surf->peekPixels(&pm)) {
258 pm.reset();
259 }
260 this->reset(pm);
261 }
262
reset(const SkPixmap & pm)263 void reset(const SkPixmap& pm) {
264 fPM = pm;
265 fLoc = {-1, 0};
266 }
267
268 void* next(SkIPoint* loc = nullptr) {
269 if (!fPM.addr()) {
270 return nullptr;
271 }
272 fLoc.fX += 1;
273 if (fLoc.fX >= fPM.width()) {
274 fLoc.fX = 0;
275 if (++fLoc.fY >= fPM.height()) {
276 this->setDone();
277 return nullptr;
278 }
279 }
280 if (loc) {
281 *loc = fLoc;
282 }
283 return fPM.writable_addr(fLoc.fX, fLoc.fY);
284 }
285
setDone()286 void setDone() { fPM.reset(); }
287
288 private:
289 SkPixmap fPM;
290 SkIPoint fLoc;
291 };
292
293 using PathSniffCallback = void(const SkMatrix&, const SkPath&, const SkPaint&);
294
295 // Calls the provided PathSniffCallback for each path in the given file.
296 // Supported file formats are .svg and .skp.
297 void sniff_paths(const char filepath[], std::function<PathSniffCallback>);
298
299 } // namespace ToolUtils
300
301 #endif // ToolUtils_DEFINED
302