1 /*
2 * Copyright 2015 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 "include/core/SkColorFilter.h"
9 #include "include/gpu/GrContext.h"
10 #include "src/core/SkMaskFilterBase.h"
11 #include "src/core/SkPaintPriv.h"
12 #include "src/gpu/GrBlurUtils.h"
13 #include "src/gpu/GrClip.h"
14 #include "src/gpu/GrStyle.h"
15 #include "src/gpu/geometry/GrShape.h"
16 #include "src/gpu/ops/GrAtlasTextOp.h"
17 #include "src/gpu/text/GrTextBlob.h"
18 #include "src/gpu/text/GrTextTarget.h"
19
20 #include <new>
21
sk_align(size_t s)22 template <size_t N> static size_t sk_align(size_t s) {
23 return ((s + (N-1)) / N) * N;
24 }
25
Make(int glyphCount,int runCount,GrColor color,GrStrikeCache * strikeCache)26 sk_sp<GrTextBlob> GrTextBlob::Make(int glyphCount,
27 int runCount,
28 GrColor color,
29 GrStrikeCache* strikeCache) {
30 // We allocate size for the GrTextBlob itself, plus size for the vertices array,
31 // and size for the glyphIds array.
32 size_t verticesCount = glyphCount * kVerticesPerGlyph * kMaxVASize;
33
34 size_t blobStart = 0;
35 size_t vertex = sk_align<alignof(char)> (blobStart + sizeof(GrTextBlob) * 1);
36 size_t glyphs = sk_align<alignof(GrGlyph*)> (vertex + sizeof(char) * verticesCount);
37 size_t runs = sk_align<alignof(GrTextBlob::Run)>(glyphs + sizeof(GrGlyph*) * glyphCount);
38 size_t size = (runs + sizeof(GrTextBlob::Run) * runCount);
39
40 void* allocation = ::operator new (size);
41
42 if (CACHE_SANITY_CHECK) {
43 sk_bzero(allocation, size);
44 }
45
46 sk_sp<GrTextBlob> blob{new (allocation) GrTextBlob{strikeCache}};
47 blob->fSize = size;
48
49 // setup offsets for vertices / glyphs
50 blob->fVertices = SkTAddOffset<char>(blob.get(), vertex);
51 blob->fGlyphs = SkTAddOffset<GrGlyph*>(blob.get(), glyphs);
52 blob->fRuns = SkTAddOffset<GrTextBlob::Run>(blob.get(), runs);
53
54 // Initialize runs
55 for (int i = 0; i < runCount; i++) {
56 new (&blob->fRuns[i]) GrTextBlob::Run{blob.get(), color};
57 }
58 blob->fRunCountLimit = runCount;
59 return blob;
60 }
61
setupFont(const SkStrikeSpec & strikeSpec)62 void GrTextBlob::Run::setupFont(const SkStrikeSpec& strikeSpec) {
63
64 if (fFallbackStrikeSpec != nullptr) {
65 *fFallbackStrikeSpec = strikeSpec;
66 } else {
67 fStrikeSpec = strikeSpec;
68 }
69 }
70
appendPathGlyph(const SkPath & path,SkPoint position,SkScalar scale,bool preTransformed)71 void GrTextBlob::Run::appendPathGlyph(const SkPath& path, SkPoint position,
72 SkScalar scale, bool preTransformed) {
73 fPathGlyphs.push_back(PathGlyph(path, position.x(), position.y(), scale, preTransformed));
74 }
75
mustRegenerate(const SkPaint & paint,bool anyRunHasSubpixelPosition,const SkMaskFilterBase::BlurRec & blurRec,const SkMatrix & viewMatrix,SkScalar x,SkScalar y)76 bool GrTextBlob::mustRegenerate(const SkPaint& paint, bool anyRunHasSubpixelPosition,
77 const SkMaskFilterBase::BlurRec& blurRec,
78 const SkMatrix& viewMatrix, SkScalar x, SkScalar y) {
79 // If we have LCD text then our canonical color will be set to transparent, in this case we have
80 // to regenerate the blob on any color change
81 // We use the grPaint to get any color filter effects
82 if (fKey.fCanonicalColor == SK_ColorTRANSPARENT &&
83 fLuminanceColor != SkPaintPriv::ComputeLuminanceColor(paint)) {
84 return true;
85 }
86
87 if (fInitialViewMatrix.hasPerspective() != viewMatrix.hasPerspective()) {
88 return true;
89 }
90
91 /** This could be relaxed for blobs with only distance field glyphs. */
92 if (fInitialViewMatrix.hasPerspective() && !fInitialViewMatrix.cheapEqualTo(viewMatrix)) {
93 return true;
94 }
95
96 // We only cache one masked version
97 if (fKey.fHasBlur &&
98 (fBlurRec.fSigma != blurRec.fSigma || fBlurRec.fStyle != blurRec.fStyle)) {
99 return true;
100 }
101
102 // Similarly, we only cache one version for each style
103 if (fKey.fStyle != SkPaint::kFill_Style &&
104 (fStrokeInfo.fFrameWidth != paint.getStrokeWidth() ||
105 fStrokeInfo.fMiterLimit != paint.getStrokeMiter() ||
106 fStrokeInfo.fJoin != paint.getStrokeJoin())) {
107 return true;
108 }
109
110 // Mixed blobs must be regenerated. We could probably figure out a way to do integer scrolls
111 // for mixed blobs if this becomes an issue.
112 if (this->hasBitmap() && this->hasDistanceField()) {
113 // Identical viewmatrices and we can reuse in all cases
114 if (fInitialViewMatrix.cheapEqualTo(viewMatrix) && x == fInitialX && y == fInitialY) {
115 return false;
116 }
117 return true;
118 }
119
120 if (this->hasBitmap()) {
121 if (fInitialViewMatrix.getScaleX() != viewMatrix.getScaleX() ||
122 fInitialViewMatrix.getScaleY() != viewMatrix.getScaleY() ||
123 fInitialViewMatrix.getSkewX() != viewMatrix.getSkewX() ||
124 fInitialViewMatrix.getSkewY() != viewMatrix.getSkewY()) {
125 return true;
126 }
127
128 // If the text blob only has full pixel glyphs, then fractional part of the position does
129 // not affect the SkGlyphs used.
130 if (anyRunHasSubpixelPosition) {
131 // We can update the positions in the text blob without regenerating the whole
132 // blob, but only for integer translations.
133 // This cool bit of math will determine the necessary translation to apply to the
134 // already generated vertex coordinates to move them to the correct position.
135 SkScalar transX = viewMatrix.getTranslateX() +
136 viewMatrix.getScaleX() * (x - fInitialX) +
137 viewMatrix.getSkewX() * (y - fInitialY) -
138 fInitialViewMatrix.getTranslateX();
139 SkScalar transY = viewMatrix.getTranslateY() +
140 viewMatrix.getSkewY() * (x - fInitialX) +
141 viewMatrix.getScaleY() * (y - fInitialY) -
142 fInitialViewMatrix.getTranslateY();
143 if (!SkScalarIsInt(transX) || !SkScalarIsInt(transY)) {
144 return true;
145 }
146 }
147 } else if (this->hasDistanceField()) {
148 // A scale outside of [blob.fMaxMinScale, blob.fMinMaxScale] would result in a different
149 // distance field being generated, so we have to regenerate in those cases
150 SkScalar newMaxScale = viewMatrix.getMaxScale();
151 SkScalar oldMaxScale = fInitialViewMatrix.getMaxScale();
152 SkScalar scaleAdjust = newMaxScale / oldMaxScale;
153 if (scaleAdjust < fMaxMinScale || scaleAdjust > fMinMaxScale) {
154 return true;
155 }
156 }
157
158 // It is possible that a blob has neither distanceField nor bitmaptext. This is in the case
159 // when all of the runs inside the blob are drawn as paths. In this case, we always regenerate
160 // the blob anyways at flush time, so no need to regenerate explicitly
161 return false;
162 }
163
makeOp(const SubRun & info,int glyphCount,uint16_t run,uint16_t subRun,const SkMatrix & viewMatrix,SkScalar x,SkScalar y,const SkIRect & clipRect,const SkPaint & paint,const SkPMColor4f & filteredColor,const SkSurfaceProps & props,const GrDistanceFieldAdjustTable * distanceAdjustTable,GrTextTarget * target)164 inline std::unique_ptr<GrAtlasTextOp> GrTextBlob::makeOp(
165 const SubRun& info, int glyphCount, uint16_t run, uint16_t subRun,
166 const SkMatrix& viewMatrix, SkScalar x, SkScalar y, const SkIRect& clipRect,
167 const SkPaint& paint, const SkPMColor4f& filteredColor, const SkSurfaceProps& props,
168 const GrDistanceFieldAdjustTable* distanceAdjustTable, GrTextTarget* target) {
169 GrMaskFormat format = info.maskFormat();
170
171 GrPaint grPaint;
172 target->makeGrPaint(info.maskFormat(), paint, viewMatrix, &grPaint);
173 std::unique_ptr<GrAtlasTextOp> op;
174 if (info.drawAsDistanceFields()) {
175 // TODO: Can we be even smarter based on the dest transfer function?
176 op = GrAtlasTextOp::MakeDistanceField(
177 target->getContext(), std::move(grPaint), glyphCount, distanceAdjustTable,
178 target->colorSpaceInfo().isLinearlyBlended(),
179 SkPaintPriv::ComputeLuminanceColor(paint),
180 props, info.isAntiAliased(), info.hasUseLCDText());
181 } else {
182 op = GrAtlasTextOp::MakeBitmap(target->getContext(), std::move(grPaint), format, glyphCount,
183 info.needsTransform());
184 }
185 GrAtlasTextOp::Geometry& geometry = op->geometry();
186 geometry.fViewMatrix = viewMatrix;
187 geometry.fClipRect = clipRect;
188 geometry.fBlob = SkRef(this);
189 geometry.fRun = run;
190 geometry.fSubRun = subRun;
191 geometry.fColor = info.maskFormat() == kARGB_GrMaskFormat ? SK_PMColor4fWHITE : filteredColor;
192 geometry.fX = x;
193 geometry.fY = y;
194 op->init();
195 return op;
196 }
197
calculate_translation(bool applyVM,const SkMatrix & newViewMatrix,SkScalar newX,SkScalar newY,const SkMatrix & currentViewMatrix,SkScalar currentX,SkScalar currentY,SkScalar * transX,SkScalar * transY)198 static void calculate_translation(bool applyVM,
199 const SkMatrix& newViewMatrix, SkScalar newX, SkScalar newY,
200 const SkMatrix& currentViewMatrix, SkScalar currentX,
201 SkScalar currentY, SkScalar* transX, SkScalar* transY) {
202 if (applyVM) {
203 *transX = newViewMatrix.getTranslateX() +
204 newViewMatrix.getScaleX() * (newX - currentX) +
205 newViewMatrix.getSkewX() * (newY - currentY) -
206 currentViewMatrix.getTranslateX();
207
208 *transY = newViewMatrix.getTranslateY() +
209 newViewMatrix.getSkewY() * (newX - currentX) +
210 newViewMatrix.getScaleY() * (newY - currentY) -
211 currentViewMatrix.getTranslateY();
212 } else {
213 *transX = newX - currentX;
214 *transY = newY - currentY;
215 }
216 }
217
flush(GrTextTarget * target,const SkSurfaceProps & props,const GrDistanceFieldAdjustTable * distanceAdjustTable,const SkPaint & paint,const SkPMColor4f & filteredColor,const GrClip & clip,const SkMatrix & viewMatrix,SkScalar x,SkScalar y)218 void GrTextBlob::flush(GrTextTarget* target, const SkSurfaceProps& props,
219 const GrDistanceFieldAdjustTable* distanceAdjustTable,
220 const SkPaint& paint, const SkPMColor4f& filteredColor, const GrClip& clip,
221 const SkMatrix& viewMatrix, SkScalar x, SkScalar y) {
222
223 // GrTextBlob::makeOp only takes uint16_t values for run and subRun indices.
224 // Encountering something larger than this is highly unlikely, so we'll just not draw it.
225 int lastRun = SkTMin(fRunCountLimit, (1 << 16)) - 1;
226 // For each run in the GrTextBlob we're going to churn through all the glyphs.
227 // Each run is broken into a path part and a Mask / DFT / ARGB part.
228 for (int runIndex = 0; runIndex <= lastRun; runIndex++) {
229
230 Run& run = fRuns[runIndex];
231
232 // first flush any path glyphs
233 if (run.fPathGlyphs.count()) {
234 SkPaint runPaint{paint};
235 runPaint.setAntiAlias(run.fAntiAlias);
236
237 for (int i = 0; i < run.fPathGlyphs.count(); i++) {
238 GrTextBlob::Run::PathGlyph& pathGlyph = run.fPathGlyphs[i];
239
240 SkMatrix ctm;
241 const SkPath* path = &pathGlyph.fPath;
242
243 // TmpPath must be in the same scope as GrShape shape below.
244 SkTLazy<SkPath> tmpPath;
245
246 // The glyph positions and glyph outlines are either in device space or in source
247 // space based on fPreTransformed.
248 if (!pathGlyph.fPreTransformed) {
249 // Positions and outlines are in source space.
250
251 ctm = viewMatrix;
252
253 SkMatrix pathMatrix = SkMatrix::MakeScale(pathGlyph.fScale, pathGlyph.fScale);
254
255 // The origin for the blob may have changed, so figure out the delta.
256 SkVector originShift = SkPoint{x, y} - SkPoint{fInitialX, fInitialY};
257
258 // Shift the original glyph location in source space to the position of the new
259 // blob.
260 pathMatrix.postTranslate(originShift.x() + pathGlyph.fX,
261 originShift.y() + pathGlyph.fY);
262
263 // If there are shaders, blurs or styles, the path must be scaled into source
264 // space independently of the CTM. This allows the CTM to be correct for the
265 // different effects.
266 GrStyle style(runPaint);
267 bool scalePath = runPaint.getShader()
268 || style.applies()
269 || runPaint.getMaskFilter();
270 if (!scalePath) {
271 // Scale can be applied to CTM -- no effects.
272
273 ctm.preConcat(pathMatrix);
274 } else {
275 // Scale the outline into source space.
276
277 // Transform the path form the normalized outline to source space. This
278 // way the CTM will remain the same so it can be used by the effects.
279 SkPath* sourceOutline = tmpPath.init();
280 path->transform(pathMatrix, sourceOutline);
281 sourceOutline->setIsVolatile(true);
282 path = sourceOutline;
283 }
284
285
286 } else {
287 // Positions and outlines are in device space.
288
289 SkPoint originalOrigin = {fInitialX, fInitialY};
290 fInitialViewMatrix.mapPoints(&originalOrigin, 1);
291
292 SkPoint newOrigin = {x, y};
293 viewMatrix.mapPoints(&newOrigin, 1);
294
295 // The origin shift in device space.
296 SkPoint originShift = newOrigin - originalOrigin;
297
298 // Shift the original glyph location in device space to the position of the
299 // new blob.
300 ctm = SkMatrix::MakeTrans(originShift.x() + pathGlyph.fX,
301 originShift.y() + pathGlyph.fY);
302 }
303
304 // TODO: we are losing the mutability of the path here
305 GrShape shape(*path, paint);
306
307 target->drawShape(clip, runPaint, ctm, shape);
308 }
309 }
310
311 // then flush each subrun, if any
312 if (!run.fInitialized) {
313 continue;
314 }
315
316 int lastSubRun = SkTMin(run.fSubRunInfo.count(), 1 << 16) - 1;
317 for (int subRun = 0; subRun <= lastSubRun; subRun++) {
318 const SubRun& info = run.fSubRunInfo[subRun];
319 int glyphCount = info.glyphCount();
320 if (0 == glyphCount) {
321 continue;
322 }
323
324 bool skipClip = false;
325 bool submitOp = true;
326 SkIRect clipRect = SkIRect::MakeEmpty();
327 SkRect rtBounds = SkRect::MakeWH(target->width(), target->height());
328 SkRRect clipRRect;
329 GrAA aa;
330 // We can clip geometrically if we're not using SDFs or transformed glyphs,
331 // and we have an axis-aligned rectangular non-AA clip
332 if (!info.drawAsDistanceFields() && !info.needsTransform() &&
333 clip.isRRect(rtBounds, &clipRRect, &aa) &&
334 clipRRect.isRect() && GrAA::kNo == aa) {
335 skipClip = true;
336 // We only need to do clipping work if the subrun isn't contained by the clip
337 SkRect subRunBounds;
338 this->computeSubRunBounds(&subRunBounds, runIndex, subRun, viewMatrix, x, y,
339 false);
340 if (!clipRRect.getBounds().contains(subRunBounds)) {
341 // If the subrun is completely outside, don't add an op for it
342 if (!clipRRect.getBounds().intersects(subRunBounds)) {
343 submitOp = false;
344 }
345 else {
346 clipRRect.getBounds().round(&clipRect);
347 }
348 }
349 }
350
351 if (submitOp) {
352 auto op = this->makeOp(info, glyphCount, runIndex, subRun, viewMatrix, x, y,
353 clipRect, paint, filteredColor, props, distanceAdjustTable,
354 target);
355 if (op) {
356 if (skipClip) {
357 target->addDrawOp(GrNoClip(), std::move(op));
358 }
359 else {
360 target->addDrawOp(clip, std::move(op));
361 }
362 }
363 }
364 }
365
366 }
367 }
368
test_makeOp(int glyphCount,uint16_t run,uint16_t subRun,const SkMatrix & viewMatrix,SkScalar x,SkScalar y,const SkPaint & paint,const SkPMColor4f & filteredColor,const SkSurfaceProps & props,const GrDistanceFieldAdjustTable * distanceAdjustTable,GrTextTarget * target)369 std::unique_ptr<GrDrawOp> GrTextBlob::test_makeOp(
370 int glyphCount, uint16_t run, uint16_t subRun, const SkMatrix& viewMatrix,
371 SkScalar x, SkScalar y, const SkPaint& paint, const SkPMColor4f& filteredColor,
372 const SkSurfaceProps& props, const GrDistanceFieldAdjustTable* distanceAdjustTable,
373 GrTextTarget* target) {
374 const GrTextBlob::SubRun& info = fRuns[run].fSubRunInfo[subRun];
375 SkIRect emptyRect = SkIRect::MakeEmpty();
376 return this->makeOp(info, glyphCount, run, subRun, viewMatrix, x, y, emptyRect,
377 paint, filteredColor, props, distanceAdjustTable, target);
378 }
379
AssertEqual(const GrTextBlob & l,const GrTextBlob & r)380 void GrTextBlob::AssertEqual(const GrTextBlob& l, const GrTextBlob& r) {
381 SkASSERT_RELEASE(l.fSize == r.fSize);
382
383 SkASSERT_RELEASE(l.fBlurRec.fSigma == r.fBlurRec.fSigma);
384 SkASSERT_RELEASE(l.fBlurRec.fStyle == r.fBlurRec.fStyle);
385
386 SkASSERT_RELEASE(l.fStrokeInfo.fFrameWidth == r.fStrokeInfo.fFrameWidth);
387 SkASSERT_RELEASE(l.fStrokeInfo.fMiterLimit == r.fStrokeInfo.fMiterLimit);
388 SkASSERT_RELEASE(l.fStrokeInfo.fJoin == r.fStrokeInfo.fJoin);
389
390 SkASSERT_RELEASE(l.fKey == r.fKey);
391 //SkASSERT_RELEASE(l.fPaintColor == r.fPaintColor); // Colors might not actually be identical
392 SkASSERT_RELEASE(l.fMaxMinScale == r.fMaxMinScale);
393 SkASSERT_RELEASE(l.fMinMaxScale == r.fMinMaxScale);
394 SkASSERT_RELEASE(l.fTextType == r.fTextType);
395
396 SkASSERT_RELEASE(l.fRunCountLimit == r.fRunCountLimit);
397 for (int i = 0; i < l.fRunCountLimit; i++) {
398 const Run& lRun = l.fRuns[i];
399 const Run& rRun = r.fRuns[i];
400
401 SkASSERT_RELEASE(lRun.fStrikeSpec.descriptor() == rRun.fStrikeSpec.descriptor());
402
403 // color can be changed
404 //SkASSERT(lRun.fColor == rRun.fColor);
405 SkASSERT_RELEASE(lRun.fInitialized == rRun.fInitialized);
406
407 SkASSERT_RELEASE(lRun.fSubRunInfo.count() == rRun.fSubRunInfo.count());
408 for(int j = 0; j < lRun.fSubRunInfo.count(); j++) {
409 const SubRun& lSubRun = lRun.fSubRunInfo[j];
410 const SubRun& rSubRun = rRun.fSubRunInfo[j];
411
412 // TODO we can do this check, but we have to apply the VM to the old vertex bounds
413 //SkASSERT_RELEASE(lSubRun.vertexBounds() == rSubRun.vertexBounds());
414
415 if (lSubRun.strike()) {
416 SkASSERT_RELEASE(rSubRun.strike());
417 SkASSERT_RELEASE(GrTextStrike::GetKey(*lSubRun.strike()) ==
418 GrTextStrike::GetKey(*rSubRun.strike()));
419
420 } else {
421 SkASSERT_RELEASE(!rSubRun.strike());
422 }
423
424 SkASSERT_RELEASE(lSubRun.vertexStartIndex() == rSubRun.vertexStartIndex());
425 SkASSERT_RELEASE(lSubRun.vertexEndIndex() == rSubRun.vertexEndIndex());
426 SkASSERT_RELEASE(lSubRun.glyphStartIndex() == rSubRun.glyphStartIndex());
427 SkASSERT_RELEASE(lSubRun.glyphEndIndex() == rSubRun.glyphEndIndex());
428 SkASSERT_RELEASE(lSubRun.maskFormat() == rSubRun.maskFormat());
429 SkASSERT_RELEASE(lSubRun.drawAsDistanceFields() == rSubRun.drawAsDistanceFields());
430 SkASSERT_RELEASE(lSubRun.hasUseLCDText() == rSubRun.hasUseLCDText());
431 }
432
433 SkASSERT_RELEASE(lRun.fPathGlyphs.count() == rRun.fPathGlyphs.count());
434 for (int i = 0; i < lRun.fPathGlyphs.count(); i++) {
435 const Run::PathGlyph& lPathGlyph = lRun.fPathGlyphs[i];
436 const Run::PathGlyph& rPathGlyph = rRun.fPathGlyphs[i];
437
438 SkASSERT_RELEASE(lPathGlyph.fPath == rPathGlyph.fPath);
439 // We can't assert that these have the same translations
440 }
441 }
442 }
443
computeTranslation(const SkMatrix & viewMatrix,SkScalar x,SkScalar y,SkScalar * transX,SkScalar * transY)444 void GrTextBlob::SubRun::computeTranslation(const SkMatrix& viewMatrix,
445 SkScalar x, SkScalar y, SkScalar* transX,
446 SkScalar* transY) {
447 // Don't use the matrix to translate on distance field for fallback subruns.
448 calculate_translation(!this->drawAsDistanceFields() && !this->isFallback(), viewMatrix,
449 x, y, fCurrentViewMatrix, fX, fY, transX, transY);
450 fCurrentViewMatrix = viewMatrix;
451 fX = x;
452 fY = y;
453 }
454