OSDN Git Service

DO NOT MERGE. KEY_INTENT shouldn't grant permissions. am: 1f2a5d3622 -s ours am...
[android-x86/frameworks-base.git] / libs / hwui / VectorDrawable.cpp
1 /*
2  * Copyright (C) 2015 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #include "VectorDrawable.h"
18
19 #include "PathParser.h"
20 #include "SkColorFilter.h"
21 #include "SkImageInfo.h"
22 #include "SkShader.h"
23 #include <utils/Log.h>
24 #include "utils/Macros.h"
25 #include "utils/VectorDrawableUtils.h"
26
27 #include <math.h>
28 #include <string.h>
29
30 namespace android {
31 namespace uirenderer {
32 namespace VectorDrawable {
33
34 const int Tree::MAX_CACHED_BITMAP_SIZE = 2048;
35
36 void Path::draw(SkCanvas* outCanvas, const SkMatrix& groupStackedMatrix, float scaleX, float scaleY,
37         bool useStagingData) {
38     float matrixScale = getMatrixScale(groupStackedMatrix);
39     if (matrixScale == 0) {
40         // When either x or y is scaled to 0, we don't need to draw anything.
41         return;
42     }
43
44     SkMatrix pathMatrix(groupStackedMatrix);
45     pathMatrix.postScale(scaleX, scaleY);
46
47     //TODO: try apply the path matrix to the canvas instead of creating a new path.
48     SkPath renderPath;
49     renderPath.reset();
50
51     if (useStagingData) {
52         SkPath tmpPath;
53         getStagingPath(&tmpPath);
54         renderPath.addPath(tmpPath, pathMatrix);
55     } else {
56         renderPath.addPath(getUpdatedPath(), pathMatrix);
57     }
58
59     float minScale = fmin(scaleX, scaleY);
60     float strokeScale = minScale * matrixScale;
61     drawPath(outCanvas, renderPath, strokeScale, pathMatrix, useStagingData);
62 }
63
64 void Path::dump() {
65     ALOGD("Path: %s has %zu points", mName.c_str(), mProperties.getData().points.size());
66 }
67
68 float Path::getMatrixScale(const SkMatrix& groupStackedMatrix) {
69     // Given unit vectors A = (0, 1) and B = (1, 0).
70     // After matrix mapping, we got A' and B'. Let theta = the angel b/t A' and B'.
71     // Therefore, the final scale we want is min(|A'| * sin(theta), |B'| * sin(theta)),
72     // which is (|A'| * |B'| * sin(theta)) / max (|A'|, |B'|);
73     // If  max (|A'|, |B'|) = 0, that means either x or y has a scale of 0.
74     //
75     // For non-skew case, which is most of the cases, matrix scale is computing exactly the
76     // scale on x and y axis, and take the minimal of these two.
77     // For skew case, an unit square will mapped to a parallelogram. And this function will
78     // return the minimal height of the 2 bases.
79     SkVector skVectors[2];
80     skVectors[0].set(0, 1);
81     skVectors[1].set(1, 0);
82     groupStackedMatrix.mapVectors(skVectors, 2);
83     float scaleX = hypotf(skVectors[0].fX, skVectors[0].fY);
84     float scaleY = hypotf(skVectors[1].fX, skVectors[1].fY);
85     float crossProduct = skVectors[0].cross(skVectors[1]);
86     float maxScale = fmax(scaleX, scaleY);
87
88     float matrixScale = 0;
89     if (maxScale > 0) {
90         matrixScale = fabs(crossProduct) / maxScale;
91     }
92     return matrixScale;
93 }
94
95 // Called from UI thread during the initial setup/theme change.
96 Path::Path(const char* pathStr, size_t strLength) {
97     PathParser::ParseResult result;
98     Data data;
99     PathParser::getPathDataFromAsciiString(&data, &result, pathStr, strLength);
100     mStagingProperties.setData(data);
101 }
102
103 Path::Path(const Path& path) : Node(path) {
104     mStagingProperties.syncProperties(path.mStagingProperties);
105 }
106
107 const SkPath& Path::getUpdatedPath() {
108     if (mSkPathDirty) {
109         mSkPath.reset();
110         VectorDrawableUtils::verbsToPath(&mSkPath, mProperties.getData());
111         mSkPathDirty = false;
112     }
113     return mSkPath;
114 }
115
116 void Path::getStagingPath(SkPath* outPath) {
117     outPath->reset();
118     VectorDrawableUtils::verbsToPath(outPath, mStagingProperties.getData());
119 }
120
121 void Path::syncProperties() {
122     if (mStagingPropertiesDirty) {
123         mProperties.syncProperties(mStagingProperties);
124     } else {
125         mStagingProperties.syncProperties(mProperties);
126     }
127     mStagingPropertiesDirty = false;
128 }
129
130 FullPath::FullPath(const FullPath& path) : Path(path) {
131     mStagingProperties.syncProperties(path.mStagingProperties);
132 }
133
134 static void applyTrim(SkPath* outPath, const SkPath& inPath, float trimPathStart, float trimPathEnd,
135         float trimPathOffset) {
136     if (trimPathStart == 0.0f && trimPathEnd == 1.0f) {
137         *outPath = inPath;
138         return;
139     }
140     outPath->reset();
141     if (trimPathStart == trimPathEnd) {
142         // Trimmed path should be empty.
143         return;
144     }
145     SkPathMeasure measure(inPath, false);
146     float len = SkScalarToFloat(measure.getLength());
147     float start = len * fmod((trimPathStart + trimPathOffset), 1.0f);
148     float end = len * fmod((trimPathEnd + trimPathOffset), 1.0f);
149
150     if (start > end) {
151         measure.getSegment(start, len, outPath, true);
152         if (end > 0) {
153             measure.getSegment(0, end, outPath, true);
154         }
155     } else {
156         measure.getSegment(start, end, outPath, true);
157     }
158 }
159
160 const SkPath& FullPath::getUpdatedPath() {
161     if (!mSkPathDirty && !mProperties.mTrimDirty) {
162         return mTrimmedSkPath;
163     }
164     Path::getUpdatedPath();
165     if (mProperties.getTrimPathStart() != 0.0f || mProperties.getTrimPathEnd() != 1.0f) {
166         mProperties.mTrimDirty = false;
167         applyTrim(&mTrimmedSkPath, mSkPath, mProperties.getTrimPathStart(),
168                 mProperties.getTrimPathEnd(), mProperties.getTrimPathOffset());
169         return mTrimmedSkPath;
170     } else {
171         return mSkPath;
172     }
173 }
174
175 void FullPath::getStagingPath(SkPath* outPath) {
176     Path::getStagingPath(outPath);
177     SkPath inPath = *outPath;
178     applyTrim(outPath, inPath, mStagingProperties.getTrimPathStart(),
179             mStagingProperties.getTrimPathEnd(), mStagingProperties.getTrimPathOffset());
180 }
181
182 void FullPath::dump() {
183     Path::dump();
184     ALOGD("stroke width, color, alpha: %f, %d, %f, fill color, alpha: %d, %f",
185             mProperties.getStrokeWidth(), mProperties.getStrokeColor(), mProperties.getStrokeAlpha(),
186             mProperties.getFillColor(), mProperties.getFillAlpha());
187 }
188
189
190 inline SkColor applyAlpha(SkColor color, float alpha) {
191     int alphaBytes = SkColorGetA(color);
192     return SkColorSetA(color, alphaBytes * alpha);
193 }
194
195 void FullPath::drawPath(SkCanvas* outCanvas, SkPath& renderPath, float strokeScale,
196                         const SkMatrix& matrix, bool useStagingData){
197     const FullPathProperties& properties = useStagingData ? mStagingProperties : mProperties;
198
199     // Draw path's fill, if fill color or gradient is valid
200     bool needsFill = false;
201     SkPaint paint;
202     if (properties.getFillGradient() != nullptr) {
203         paint.setColor(applyAlpha(SK_ColorBLACK, properties.getFillAlpha()));
204         SkShader* newShader = properties.getFillGradient()->newWithLocalMatrix(matrix);
205         paint.setShader(newShader);
206         needsFill = true;
207     } else if (properties.getFillColor() != SK_ColorTRANSPARENT) {
208         paint.setColor(applyAlpha(properties.getFillColor(), properties.getFillAlpha()));
209         needsFill = true;
210     }
211
212     if (needsFill) {
213         paint.setStyle(SkPaint::Style::kFill_Style);
214         paint.setAntiAlias(true);
215         SkPath::FillType ft = static_cast<SkPath::FillType>(properties.getFillType());
216         renderPath.setFillType(ft);
217         outCanvas->drawPath(renderPath, paint);
218     }
219
220     // Draw path's stroke, if stroke color or Gradient is valid
221     bool needsStroke = false;
222     if (properties.getStrokeGradient() != nullptr) {
223         paint.setColor(applyAlpha(SK_ColorBLACK, properties.getStrokeAlpha()));
224         SkShader* newShader = properties.getStrokeGradient()->newWithLocalMatrix(matrix);
225         paint.setShader(newShader);
226         needsStroke = true;
227     } else if (properties.getStrokeColor() != SK_ColorTRANSPARENT) {
228         paint.setColor(applyAlpha(properties.getStrokeColor(), properties.getStrokeAlpha()));
229         needsStroke = true;
230     }
231     if (needsStroke) {
232         paint.setStyle(SkPaint::Style::kStroke_Style);
233         paint.setAntiAlias(true);
234         paint.setStrokeJoin(SkPaint::Join(properties.getStrokeLineJoin()));
235         paint.setStrokeCap(SkPaint::Cap(properties.getStrokeLineCap()));
236         paint.setStrokeMiter(properties.getStrokeMiterLimit());
237         paint.setStrokeWidth(properties.getStrokeWidth() * strokeScale);
238         outCanvas->drawPath(renderPath, paint);
239     }
240 }
241
242 void FullPath::syncProperties() {
243     Path::syncProperties();
244
245     if (mStagingPropertiesDirty) {
246         mProperties.syncProperties(mStagingProperties);
247     } else {
248         // Update staging property with property values from animation.
249         mStagingProperties.syncProperties(mProperties);
250     }
251     mStagingPropertiesDirty = false;
252 }
253
254 REQUIRE_COMPATIBLE_LAYOUT(FullPath::FullPathProperties::PrimitiveFields);
255
256 static_assert(sizeof(float) == sizeof(int32_t), "float is not the same size as int32_t");
257 static_assert(sizeof(SkColor) == sizeof(int32_t), "SkColor is not the same size as int32_t");
258
259 bool FullPath::FullPathProperties::copyProperties(int8_t* outProperties, int length) const {
260     int propertyDataSize = sizeof(FullPathProperties::PrimitiveFields);
261     if (length != propertyDataSize) {
262         LOG_ALWAYS_FATAL("Properties needs exactly %d bytes, a byte array of size %d is provided",
263                 propertyDataSize, length);
264         return false;
265     }
266
267     PrimitiveFields* out = reinterpret_cast<PrimitiveFields*>(outProperties);
268     *out = mPrimitiveFields;
269     return true;
270 }
271
272 void FullPath::FullPathProperties::setColorPropertyValue(int propertyId, int32_t value) {
273     Property currentProperty = static_cast<Property>(propertyId);
274     if (currentProperty == Property::strokeColor) {
275         setStrokeColor(value);
276     } else if (currentProperty == Property::fillColor) {
277         setFillColor(value);
278     } else {
279         LOG_ALWAYS_FATAL("Error setting color property on FullPath: No valid property"
280                 " with id: %d", propertyId);
281     }
282 }
283
284 void FullPath::FullPathProperties::setPropertyValue(int propertyId, float value) {
285     Property property = static_cast<Property>(propertyId);
286     switch (property) {
287     case Property::strokeWidth:
288         setStrokeWidth(value);
289         break;
290     case Property::strokeAlpha:
291         setStrokeAlpha(value);
292         break;
293     case Property::fillAlpha:
294         setFillAlpha(value);
295         break;
296     case Property::trimPathStart:
297         setTrimPathStart(value);
298         break;
299     case Property::trimPathEnd:
300         setTrimPathEnd(value);
301         break;
302     case Property::trimPathOffset:
303         setTrimPathOffset(value);
304         break;
305     default:
306         LOG_ALWAYS_FATAL("Invalid property id: %d for animation", propertyId);
307         break;
308     }
309 }
310
311 void ClipPath::drawPath(SkCanvas* outCanvas, SkPath& renderPath,
312         float strokeScale, const SkMatrix& matrix, bool useStagingData){
313     outCanvas->clipPath(renderPath, SkRegion::kIntersect_Op);
314 }
315
316 Group::Group(const Group& group) : Node(group) {
317     mStagingProperties.syncProperties(group.mStagingProperties);
318 }
319
320 void Group::draw(SkCanvas* outCanvas, const SkMatrix& currentMatrix, float scaleX,
321         float scaleY, bool useStagingData) {
322     // TODO: Try apply the matrix to the canvas instead of passing it down the tree
323
324     // Calculate current group's matrix by preConcat the parent's and
325     // and the current one on the top of the stack.
326     // Basically the Mfinal = Mviewport * M0 * M1 * M2;
327     // Mi the local matrix at level i of the group tree.
328     SkMatrix stackedMatrix;
329     const GroupProperties& prop = useStagingData ? mStagingProperties : mProperties;
330     getLocalMatrix(&stackedMatrix, prop);
331     stackedMatrix.postConcat(currentMatrix);
332
333     // Save the current clip information, which is local to this group.
334     outCanvas->save();
335     // Draw the group tree in the same order as the XML file.
336     for (auto& child : mChildren) {
337         child->draw(outCanvas, stackedMatrix, scaleX, scaleY, useStagingData);
338     }
339     // Restore the previous clip information.
340     outCanvas->restore();
341 }
342
343 void Group::dump() {
344     ALOGD("Group %s has %zu children: ", mName.c_str(), mChildren.size());
345     ALOGD("Group translateX, Y : %f, %f, scaleX, Y: %f, %f", mProperties.getTranslateX(),
346             mProperties.getTranslateY(), mProperties.getScaleX(), mProperties.getScaleY());
347     for (size_t i = 0; i < mChildren.size(); i++) {
348         mChildren[i]->dump();
349     }
350 }
351
352 void Group::syncProperties() {
353     // Copy over the dirty staging properties
354     if (mStagingPropertiesDirty) {
355         mProperties.syncProperties(mStagingProperties);
356     } else {
357         mStagingProperties.syncProperties(mProperties);
358     }
359     mStagingPropertiesDirty = false;
360     for (auto& child : mChildren) {
361         child->syncProperties();
362     }
363 }
364
365 void Group::getLocalMatrix(SkMatrix* outMatrix, const GroupProperties& properties) {
366     outMatrix->reset();
367     // TODO: use rotate(mRotate, mPivotX, mPivotY) and scale with pivot point, instead of
368     // translating to pivot for rotating and scaling, then translating back.
369     outMatrix->postTranslate(-properties.getPivotX(), -properties.getPivotY());
370     outMatrix->postScale(properties.getScaleX(), properties.getScaleY());
371     outMatrix->postRotate(properties.getRotation(), 0, 0);
372     outMatrix->postTranslate(properties.getTranslateX() + properties.getPivotX(),
373             properties.getTranslateY() + properties.getPivotY());
374 }
375
376 void Group::addChild(Node* child) {
377     mChildren.emplace_back(child);
378     if (mPropertyChangedListener != nullptr) {
379         child->setPropertyChangedListener(mPropertyChangedListener);
380     }
381 }
382
383 bool Group::GroupProperties::copyProperties(float* outProperties, int length) const {
384     int propertyCount = static_cast<int>(Property::count);
385     if (length != propertyCount) {
386         LOG_ALWAYS_FATAL("Properties needs exactly %d bytes, a byte array of size %d is provided",
387                 propertyCount, length);
388         return false;
389     }
390
391     PrimitiveFields* out = reinterpret_cast<PrimitiveFields*>(outProperties);
392     *out = mPrimitiveFields;
393     return true;
394 }
395
396 // TODO: Consider animating the properties as float pointers
397 // Called on render thread
398 float Group::GroupProperties::getPropertyValue(int propertyId) const {
399     Property currentProperty = static_cast<Property>(propertyId);
400     switch (currentProperty) {
401     case Property::rotate:
402         return getRotation();
403     case Property::pivotX:
404         return getPivotX();
405     case Property::pivotY:
406         return getPivotY();
407     case Property::scaleX:
408         return getScaleX();
409     case Property::scaleY:
410         return getScaleY();
411     case Property::translateX:
412         return getTranslateX();
413     case Property::translateY:
414         return getTranslateY();
415     default:
416         LOG_ALWAYS_FATAL("Invalid property index: %d", propertyId);
417         return 0;
418     }
419 }
420
421 // Called on render thread
422 void Group::GroupProperties::setPropertyValue(int propertyId, float value) {
423     Property currentProperty = static_cast<Property>(propertyId);
424     switch (currentProperty) {
425     case Property::rotate:
426         setRotation(value);
427         break;
428     case Property::pivotX:
429         setPivotX(value);
430         break;
431     case Property::pivotY:
432         setPivotY(value);
433         break;
434     case Property::scaleX:
435         setScaleX(value);
436         break;
437     case Property::scaleY:
438         setScaleY(value);
439         break;
440     case Property::translateX:
441         setTranslateX(value);
442         break;
443     case Property::translateY:
444         setTranslateY(value);
445         break;
446     default:
447         LOG_ALWAYS_FATAL("Invalid property index: %d", propertyId);
448     }
449 }
450
451 bool Group::isValidProperty(int propertyId) {
452     return GroupProperties::isValidProperty(propertyId);
453 }
454
455 bool Group::GroupProperties::isValidProperty(int propertyId) {
456     return propertyId >= 0 && propertyId < static_cast<int>(Property::count);
457 }
458
459 int Tree::draw(Canvas* outCanvas, SkColorFilter* colorFilter,
460         const SkRect& bounds, bool needsMirroring, bool canReuseCache) {
461     // The imageView can scale the canvas in different ways, in order to
462     // avoid blurry scaling, we have to draw into a bitmap with exact pixel
463     // size first. This bitmap size is determined by the bounds and the
464     // canvas scale.
465     SkMatrix canvasMatrix;
466     outCanvas->getMatrix(&canvasMatrix);
467     float canvasScaleX = 1.0f;
468     float canvasScaleY = 1.0f;
469     if (canvasMatrix.getSkewX() == 0 && canvasMatrix.getSkewY() == 0) {
470         // Only use the scale value when there's no skew or rotation in the canvas matrix.
471         // TODO: Add a cts test for drawing VD on a canvas with negative scaling factors.
472         canvasScaleX = fabs(canvasMatrix.getScaleX());
473         canvasScaleY = fabs(canvasMatrix.getScaleY());
474     }
475     int scaledWidth = (int) (bounds.width() * canvasScaleX);
476     int scaledHeight = (int) (bounds.height() * canvasScaleY);
477     scaledWidth = std::min(Tree::MAX_CACHED_BITMAP_SIZE, scaledWidth);
478     scaledHeight = std::min(Tree::MAX_CACHED_BITMAP_SIZE, scaledHeight);
479
480     if (scaledWidth <= 0 || scaledHeight <= 0) {
481         return 0;
482     }
483
484     mStagingProperties.setScaledSize(scaledWidth, scaledHeight);
485     int saveCount = outCanvas->save(SaveFlags::MatrixClip);
486     outCanvas->translate(bounds.fLeft, bounds.fTop);
487
488     // Handle RTL mirroring.
489     if (needsMirroring) {
490         outCanvas->translate(bounds.width(), 0);
491         outCanvas->scale(-1.0f, 1.0f);
492     }
493     mStagingProperties.setColorFilter(colorFilter);
494
495     // At this point, canvas has been translated to the right position.
496     // And we use this bound for the destination rect for the drawBitmap, so
497     // we offset to (0, 0);
498     SkRect tmpBounds = bounds;
499     tmpBounds.offsetTo(0, 0);
500     mStagingProperties.setBounds(tmpBounds);
501     outCanvas->drawVectorDrawable(this);
502     outCanvas->restoreToCount(saveCount);
503     return scaledWidth * scaledHeight;
504 }
505
506 void Tree::drawStaging(Canvas* outCanvas) {
507     bool redrawNeeded = allocateBitmapIfNeeded(&mStagingCache.bitmap,
508             mStagingProperties.getScaledWidth(), mStagingProperties.getScaledHeight());
509     // draw bitmap cache
510     if (redrawNeeded || mStagingCache.dirty) {
511         updateBitmapCache(&mStagingCache.bitmap, true);
512         mStagingCache.dirty = false;
513     }
514
515     SkPaint tmpPaint;
516     SkPaint* paint = updatePaint(&tmpPaint, &mStagingProperties);
517     outCanvas->drawBitmap(mStagingCache.bitmap, 0, 0,
518             mStagingCache.bitmap.width(), mStagingCache.bitmap.height(),
519             mStagingProperties.getBounds().left(), mStagingProperties.getBounds().top(),
520             mStagingProperties.getBounds().right(), mStagingProperties.getBounds().bottom(), paint);
521 }
522
523 SkPaint* Tree::getPaint() {
524     return updatePaint(&mPaint, &mProperties);
525 }
526
527 // Update the given paint with alpha and color filter. Return nullptr if no color filter is
528 // specified and root alpha is 1. Otherwise, return updated paint.
529 SkPaint* Tree::updatePaint(SkPaint* outPaint, TreeProperties* prop) {
530     if (prop->getRootAlpha() == 1.0f && prop->getColorFilter() == nullptr) {
531         return nullptr;
532     } else {
533         outPaint->setColorFilter(prop->getColorFilter());
534         outPaint->setFilterQuality(kLow_SkFilterQuality);
535         outPaint->setAlpha(prop->getRootAlpha() * 255);
536         return outPaint;
537     }
538 }
539
540 const SkBitmap& Tree::getBitmapUpdateIfDirty() {
541     bool redrawNeeded = allocateBitmapIfNeeded(&mCache.bitmap, mProperties.getScaledWidth(),
542             mProperties.getScaledHeight());
543     if (redrawNeeded || mCache.dirty) {
544         updateBitmapCache(&mCache.bitmap, false);
545         mCache.dirty = false;
546     }
547     return mCache.bitmap;
548 }
549
550 void Tree::updateBitmapCache(SkBitmap* outCache, bool useStagingData) {
551     outCache->eraseColor(SK_ColorTRANSPARENT);
552     SkCanvas outCanvas(*outCache);
553     float viewportWidth = useStagingData ?
554             mStagingProperties.getViewportWidth() : mProperties.getViewportWidth();
555     float viewportHeight = useStagingData ?
556             mStagingProperties.getViewportHeight() : mProperties.getViewportHeight();
557     float scaleX = outCache->width() / viewportWidth;
558     float scaleY = outCache->height() / viewportHeight;
559     mRootNode->draw(&outCanvas, SkMatrix::I(), scaleX, scaleY, useStagingData);
560 }
561
562 bool Tree::allocateBitmapIfNeeded(SkBitmap* outCache, int width, int height) {
563     if (!canReuseBitmap(*outCache, width, height)) {
564         SkImageInfo info = SkImageInfo::Make(width, height,
565                 kN32_SkColorType, kPremul_SkAlphaType);
566         outCache->setInfo(info);
567         // TODO: Count the bitmap cache against app's java heap
568         outCache->allocPixels(info);
569         return true;
570     }
571     return false;
572 }
573
574 bool Tree::canReuseBitmap(const SkBitmap& bitmap, int width, int height) {
575     return width == bitmap.width() && height == bitmap.height();
576 }
577
578 void Tree::onPropertyChanged(TreeProperties* prop) {
579     if (prop == &mStagingProperties) {
580         mStagingCache.dirty = true;
581     } else {
582         mCache.dirty = true;
583     }
584 }
585
586 }; // namespace VectorDrawable
587
588 }; // namespace uirenderer
589 }; // namespace android