blob: 82835d4154bc5d79c59a0dcc45f1ab03f634e165 [file] [log] [blame]
Stan Iliev500a0c32016-10-26 10:30:09 -04001/*
2 * Copyright (C) 2016 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 "SkiaPipeline.h"
18
Hal Canary10219fb2016-11-23 20:41:22 -050019#include <SkImageEncoder.h>
Peiyong Lin3bff1352018-12-11 07:56:07 -080020#include <SkImageInfo.h>
Leon Scroggins IIIee708fa2016-12-12 15:31:39 -050021#include <SkImagePriv.h>
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040022#include <SkMultiPictureDocument.h>
Matt Sarettf58cc922016-11-14 18:33:38 -050023#include <SkOverdrawCanvas.h>
24#include <SkOverdrawColorFilter.h>
Stan Iliev500a0c32016-10-26 10:30:09 -040025#include <SkPicture.h>
26#include <SkPictureRecorder.h>
Nathaniel Nifong429fff42020-01-30 14:38:21 -050027#include <SkTypeface.h>
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040028#include <SkSerialProcs.h>
Fedor Kudasov90df0562019-06-19 11:41:34 +010029#include "LightingInfo.h"
Stan Iliev23c38a92017-03-23 00:12:50 -040030#include "VectorDrawable.h"
John Reck322b8ab2019-03-14 13:15:28 -070031#include "thread/CommonPool.h"
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040032#include "tools/SkSharingProc.h"
John Reck1bcacfd2017-11-03 10:12:19 -070033#include "utils/TraceUtils.h"
Nathaniel Nifong2945bff2019-11-25 09:34:21 -050034#include "utils/String8.h"
Stan Iliev500a0c32016-10-26 10:30:09 -040035
Ben Wagner3aeda5c2017-03-17 17:22:01 -040036#include <unistd.h>
37
Jerome Gaillarda02a12d2019-05-28 18:07:56 +010038#include <android-base/properties.h>
39
Stan Iliev500a0c32016-10-26 10:30:09 -040040using namespace android::uirenderer::renderthread;
41
42namespace android {
43namespace uirenderer {
44namespace skiapipeline {
45
John Reck1bcacfd2017-11-03 10:12:19 -070046SkiaPipeline::SkiaPipeline(RenderThread& thread) : mRenderThread(thread) {
Stan Iliev23c38a92017-03-23 00:12:50 -040047}
Stan Iliev500a0c32016-10-26 10:30:09 -040048
Stan Iliev232f3622017-08-23 17:15:09 -040049SkiaPipeline::~SkiaPipeline() {
50 unpinImages();
51}
52
Stan Iliev500a0c32016-10-26 10:30:09 -040053void SkiaPipeline::onDestroyHardwareResources() {
Derek Sollenberger92a9eb92018-04-12 13:42:19 -040054 unpinImages();
Derek Sollenbergerf9e45d12017-06-01 13:07:39 -040055 mRenderThread.cacheManager().trimStaleResources();
Stan Iliev500a0c32016-10-26 10:30:09 -040056}
57
Derek Sollenbergerb7d34b62016-11-04 10:46:18 -040058bool SkiaPipeline::pinImages(std::vector<SkImage*>& mutableImages) {
59 for (SkImage* image : mutableImages) {
Derek Sollenberger189e8742016-11-16 16:00:17 -050060 if (SkImage_pinAsTexture(image, mRenderThread.getGrContext())) {
61 mPinnedImages.emplace_back(sk_ref_sp(image));
62 } else {
63 return false;
64 }
Derek Sollenbergerb7d34b62016-11-04 10:46:18 -040065 }
66 return true;
67}
68
69void SkiaPipeline::unpinImages() {
70 for (auto& image : mPinnedImages) {
71 SkImage_unpinAsTexture(image.get(), mRenderThread.getGrContext());
72 }
73 mPinnedImages.clear();
74}
75
John Reckd9d7f122018-05-03 14:40:56 -070076void SkiaPipeline::renderLayers(const LightGeometry& lightGeometry,
John Reck1bcacfd2017-11-03 10:12:19 -070077 LayerUpdateQueue* layerUpdateQueue, bool opaque,
Peiyong Lin1f6aa122018-09-10 16:28:08 -070078 const LightInfo& lightInfo) {
Fedor Kudasov90df0562019-06-19 11:41:34 +010079 LightingInfo::updateLighting(lightGeometry, lightInfo);
Stan Iliev500a0c32016-10-26 10:30:09 -040080 ATRACE_NAME("draw layers");
Peiyong Lin1f6aa122018-09-10 16:28:08 -070081 renderLayersImpl(*layerUpdateQueue, opaque);
Stan Iliev500a0c32016-10-26 10:30:09 -040082 layerUpdateQueue->clear();
83}
84
Peiyong Lin1f6aa122018-09-10 16:28:08 -070085void SkiaPipeline::renderLayersImpl(const LayerUpdateQueue& layers, bool opaque) {
Derek Sollenbergerf7df1842017-09-05 11:15:58 -040086 sk_sp<GrContext> cachedContext;
87
Stan Iliev500a0c32016-10-26 10:30:09 -040088 // Render all layers that need to be updated, in order.
89 for (size_t i = 0; i < layers.entries().size(); i++) {
John Reckfc29f7acd2017-03-02 13:23:16 -080090 RenderNode* layerNode = layers.entries()[i].renderNode.get();
Stan Iliev500a0c32016-10-26 10:30:09 -040091 // only schedule repaint if node still on layer - possible it may have been
92 // removed during a dropped frame, but layers may still remain scheduled so
93 // as not to lose info on what portion is damaged
Nathaniel Nifong2945bff2019-11-25 09:34:21 -050094 if (CC_UNLIKELY(layerNode->getLayerSurface() == nullptr)) {
95 continue;
96 }
97 SkASSERT(layerNode->getLayerSurface());
98 SkiaDisplayList* displayList = (SkiaDisplayList*)layerNode->getDisplayList();
99 if (!displayList || displayList->isEmpty()) {
100 ALOGE("%p drawLayers(%s) : missing drawable", layerNode, layerNode->getName());
101 return;
102 }
103
104 const Rect& layerDamage = layers.entries()[i].damage;
105
106 SkCanvas* layerCanvas = layerNode->getLayerSurface()->getCanvas();
107
108 int saveCount = layerCanvas->save();
109 SkASSERT(saveCount == 1);
110
111 layerCanvas->androidFramework_setDeviceClipRestriction(layerDamage.toSkIRect());
112
113 // TODO: put localized light center calculation and storage to a drawable related code.
114 // It does not seem right to store something localized in a global state
115 // fix here and in recordLayers
116 const Vector3 savedLightCenter(LightingInfo::getLightCenterRaw());
117 Vector3 transformedLightCenter(savedLightCenter);
118 // map current light center into RenderNode's coordinate space
119 layerNode->getSkiaLayer()->inverseTransformInWindow.mapPoint3d(transformedLightCenter);
120 LightingInfo::setLightCenterRaw(transformedLightCenter);
121
122 const RenderProperties& properties = layerNode->properties();
123 const SkRect bounds = SkRect::MakeWH(properties.getWidth(), properties.getHeight());
124 if (properties.getClipToBounds() && layerCanvas->quickReject(bounds)) {
125 return;
126 }
127
128 ATRACE_FORMAT("drawLayer [%s] %.1f x %.1f", layerNode->getName(), bounds.width(),
129 bounds.height());
130
131 layerNode->getSkiaLayer()->hasRenderedSinceRepaint = false;
132 layerCanvas->clear(SK_ColorTRANSPARENT);
133
134 RenderNodeDrawable root(layerNode, layerCanvas, false);
135 root.forceDraw(layerCanvas);
136 layerCanvas->restoreToCount(saveCount);
137
138 LightingInfo::setLightCenterRaw(savedLightCenter);
139
140 // cache the current context so that we can defer flushing it until
141 // either all the layers have been rendered or the context changes
142 GrContext* currentContext = layerNode->getLayerSurface()->getCanvas()->getGrContext();
143 if (cachedContext.get() != currentContext) {
144 if (cachedContext.get()) {
145 ATRACE_NAME("flush layers (context changed)");
146 cachedContext->flush();
Stan Iliev500a0c32016-10-26 10:30:09 -0400147 }
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500148 cachedContext.reset(SkSafeRef(currentContext));
Stan Iliev500a0c32016-10-26 10:30:09 -0400149 }
150 }
Derek Sollenbergerf7df1842017-09-05 11:15:58 -0400151
152 if (cachedContext.get()) {
Derek Sollenbergerbe3876c2018-04-20 16:13:31 -0400153 ATRACE_NAME("flush layers");
Derek Sollenbergerf7df1842017-09-05 11:15:58 -0400154 cachedContext->flush();
155 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400156}
157
John Reck1bcacfd2017-11-03 10:12:19 -0700158bool SkiaPipeline::createOrUpdateLayer(RenderNode* node, const DamageAccumulator& damageAccumulator,
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700159 ErrorHandler* errorHandler) {
Derek Sollenberger03e6cff72017-12-04 15:07:08 -0500160 // compute the size of the surface (i.e. texture) to be allocated for this layer
161 const int surfaceWidth = ceilf(node->getWidth() / float(LAYER_SIZE)) * LAYER_SIZE;
162 const int surfaceHeight = ceilf(node->getHeight() / float(LAYER_SIZE)) * LAYER_SIZE;
163
Stan Iliev500a0c32016-10-26 10:30:09 -0400164 SkSurface* layer = node->getLayerSurface();
Derek Sollenberger03e6cff72017-12-04 15:07:08 -0500165 if (!layer || layer->width() != surfaceWidth || layer->height() != surfaceHeight) {
Stan Iliev08fc19a2017-07-24 10:20:33 -0400166 SkImageInfo info;
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700167 info = SkImageInfo::Make(surfaceWidth, surfaceHeight, getSurfaceColorType(),
Derek Sollenbergerd01b5912018-10-19 15:55:33 -0400168 kPremul_SkAlphaType, getSurfaceColorSpace());
Stan Iliev500a0c32016-10-26 10:30:09 -0400169 SkSurfaceProps props(0, kUnknown_SkPixelGeometry);
170 SkASSERT(mRenderThread.getGrContext() != nullptr);
John Reck1bcacfd2017-11-03 10:12:19 -0700171 node->setLayerSurface(SkSurface::MakeRenderTarget(mRenderThread.getGrContext(),
Derek Sollenberger25833d22019-01-14 13:55:55 -0500172 SkBudgeted::kYes, info, 0,
173 this->getSurfaceOrigin(), &props));
Stan Iliev500a0c32016-10-26 10:30:09 -0400174 if (node->getLayerSurface()) {
175 // update the transform in window of the layer to reset its origin wrt light source
176 // position
177 Matrix4 windowTransform;
178 damageAccumulator.computeCurrentTransform(&windowTransform);
Stan Ilievda7c19c2019-05-22 14:43:44 -0400179 node->getSkiaLayer()->inverseTransformInWindow.loadInverse(windowTransform);
Stan Iliev216b1572018-03-26 14:29:50 -0400180 } else {
181 String8 cachesOutput;
182 mRenderThread.cacheManager().dumpMemoryUsage(cachesOutput,
John Reck283bb462018-12-13 16:40:14 -0800183 &mRenderThread.renderState());
Stan Iliev216b1572018-03-26 14:29:50 -0400184 ALOGE("%s", cachesOutput.string());
185 if (errorHandler) {
186 std::ostringstream err;
187 err << "Unable to create layer for " << node->getName();
188 const int maxTextureSize = DeviceInfo::get()->maxTextureSize();
189 err << ", size " << info.width() << "x" << info.height() << " max size "
John Reck283bb462018-12-13 16:40:14 -0800190 << maxTextureSize << " color type " << (int)info.colorType() << " has context "
191 << (int)(mRenderThread.getGrContext() != nullptr);
Stan Iliev216b1572018-03-26 14:29:50 -0400192 errorHandler->onError(err.str());
193 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400194 }
195 return true;
196 }
197 return false;
198}
199
Stan Iliev500a0c32016-10-26 10:30:09 -0400200void SkiaPipeline::prepareToDraw(const RenderThread& thread, Bitmap* bitmap) {
201 GrContext* context = thread.getGrContext();
202 if (context) {
203 ATRACE_FORMAT("Bitmap#prepareToDraw %dx%d", bitmap->width(), bitmap->height());
Derek Sollenbergerd01b5912018-10-19 15:55:33 -0400204 auto image = bitmap->makeImage();
Stan Iliev7bc3bc62017-05-24 13:28:36 -0400205 if (image.get() && !bitmap->isHardware()) {
206 SkImage_pinAsTexture(image.get(), context);
207 SkImage_unpinAsTexture(image.get(), context);
208 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400209 }
210}
211
John Reck322b8ab2019-03-14 13:15:28 -0700212static void savePictureAsync(const sk_sp<SkData>& data, const std::string& filename) {
213 CommonPool::post([data, filename] {
214 if (0 == access(filename.c_str(), F_OK)) {
Stan Ilieve9d00122017-09-19 12:07:10 -0400215 return;
216 }
217
John Reck322b8ab2019-03-14 13:15:28 -0700218 SkFILEWStream stream(filename.c_str());
Stan Ilieve9d00122017-09-19 12:07:10 -0400219 if (stream.isValid()) {
John Reck322b8ab2019-03-14 13:15:28 -0700220 stream.write(data->data(), data->size());
Stan Ilieve9d00122017-09-19 12:07:10 -0400221 stream.flush();
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400222 ALOGD("SKP Captured Drawing Output (%zu bytes) for frame. %s", stream.bytesWritten(),
John Reck322b8ab2019-03-14 13:15:28 -0700223 filename.c_str());
Stan Ilieve9d00122017-09-19 12:07:10 -0400224 }
John Reck322b8ab2019-03-14 13:15:28 -0700225 });
226}
Stan Ilieve9d00122017-09-19 12:07:10 -0400227
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400228// Note multiple SkiaPipeline instances may be loaded if more than one app is visible.
229// Each instance may observe the filename changing and try to record to a file of the same name.
230// Only the first one will succeed. There is no scope available here where we could coordinate
231// to cause this function to return true for only one of the instances.
232bool SkiaPipeline::shouldStartNewFileCapture() {
233 // Don't start a new file based capture if one is currently ongoing.
234 if (mCaptureMode != CaptureMode::None) { return false; }
235
236 // A new capture is started when the filename property changes.
237 // Read the filename property.
238 std::string prop = base::GetProperty(PROPERTY_CAPTURE_SKP_FILENAME, "0");
239 // if the filename property changed to a valid value
240 if (prop[0] != '0' && mCapturedFile != prop) {
241 // remember this new filename
242 mCapturedFile = prop;
243 // and get a property indicating how many frames to capture.
244 mCaptureSequence = base::GetIntProperty(PROPERTY_CAPTURE_SKP_FRAMES, 1);
John Reck5cca8f22018-12-10 17:06:22 -0800245 if (mCaptureSequence <= 0) {
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400246 return false;
247 } else if (mCaptureSequence == 1) {
248 mCaptureMode = CaptureMode::SingleFrameSKP;
249 } else {
250 mCaptureMode = CaptureMode::MultiFrameSKP;
Stan Ilieve9d00122017-09-19 12:07:10 -0400251 }
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400252 return true;
253 }
254 return false;
255}
256
257// performs the first-frame work of a multi frame SKP capture. Returns true if successful.
258bool SkiaPipeline::setupMultiFrameCapture() {
259 ALOGD("Set up multi-frame capture, frames = %d", mCaptureSequence);
260 // We own this stream and need to hold it until close() finishes.
261 auto stream = std::make_unique<SkFILEWStream>(mCapturedFile.c_str());
262 if (stream->isValid()) {
263 mOpenMultiPicStream = std::move(stream);
264 mSerialContext.reset(new SkSharingSerialContext());
265 SkSerialProcs procs;
266 procs.fImageProc = SkSharingSerialContext::serializeImage;
267 procs.fImageCtx = mSerialContext.get();
Nathaniel Nifong429fff42020-01-30 14:38:21 -0500268 procs.fTypefaceProc = [](SkTypeface* tf, void* ctx){
269 return tf->serialize(SkTypeface::SerializeBehavior::kDoIncludeData);
270 };
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400271 // SkDocuments don't take owership of the streams they write.
272 // we need to keep it until after mMultiPic.close()
273 // procs is passed as a pointer, but just as a method of having an optional default.
274 // procs doesn't need to outlive this Make call.
275 mMultiPic = SkMakeMultiPictureDocument(mOpenMultiPicStream.get(), &procs);
276 return true;
277 } else {
278 ALOGE("Could not open \"%s\" for writing.", mCapturedFile.c_str());
279 mCaptureSequence = 0;
280 mCaptureMode = CaptureMode::None;
281 return false;
282 }
283}
284
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500285// recurse through the rendernode's children, add any nodes which are layers to the queue.
286static void collectLayers(RenderNode* node, LayerUpdateQueue* layers) {
287 SkiaDisplayList* dl = (SkiaDisplayList*)node->getDisplayList();
288 if (dl) {
289 const auto& prop = node->properties();
290 if (node->hasLayer()) {
291 layers->enqueueLayerWithDamage(node, Rect(prop.getWidth(), prop.getHeight()));
292 }
293 // The way to recurse through rendernodes is to call this with a lambda.
294 dl->updateChildren([&](RenderNode* child) { collectLayers(child, layers); });
295 }
296}
297
298// record the provided layers to the provided canvas as self-contained skpictures.
299static void recordLayers(const LayerUpdateQueue& layers,
300 SkCanvas* mskpCanvas) {
301 const Vector3 savedLightCenter(LightingInfo::getLightCenterRaw());
302 // Record the commands to re-draw each dirty layer into an SkPicture
303 for (size_t i = 0; i < layers.entries().size(); i++) {
304 RenderNode* layerNode = layers.entries()[i].renderNode.get();
305 const Rect& layerDamage = layers.entries()[i].damage;
306 const RenderProperties& properties = layerNode->properties();
307
308 // Temporarily map current light center into RenderNode's coordinate space
309 Vector3 transformedLightCenter(savedLightCenter);
310 layerNode->getSkiaLayer()->inverseTransformInWindow.mapPoint3d(transformedLightCenter);
311 LightingInfo::setLightCenterRaw(transformedLightCenter);
312
313 SkPictureRecorder layerRec;
314 auto* recCanvas = layerRec.beginRecording(properties.getWidth(),
315 properties.getHeight());
316 // This is not recorded but still causes clipping.
317 recCanvas->androidFramework_setDeviceClipRestriction(layerDamage.toSkIRect());
318 RenderNodeDrawable root(layerNode, recCanvas, false);
319 root.forceDraw(recCanvas);
320 // Now write this picture into the SKP canvas with an annotation indicating what it is
321 mskpCanvas->drawAnnotation(layerDamage.toSkRect(), String8::format(
322 "OffscreenLayerDraw|%" PRId64, layerNode->uniqueId()).c_str(), nullptr);
323 mskpCanvas->drawPicture(layerRec.finishRecordingAsPicture());
324 }
325 LightingInfo::setLightCenterRaw(savedLightCenter);
326}
327
328SkCanvas* SkiaPipeline::tryCapture(SkSurface* surface, RenderNode* root,
329 const LayerUpdateQueue& dirtyLayers) {
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400330 if (CC_LIKELY(!Properties::skpCaptureEnabled)) {
331 return surface->getCanvas(); // Bail out early when capture is not turned on.
332 }
333 // Note that shouldStartNewFileCapture tells us if this is the *first* frame of a capture.
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500334 bool firstFrameOfAnim = false;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400335 if (shouldStartNewFileCapture() && mCaptureMode == CaptureMode::MultiFrameSKP) {
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500336 // set a reminder to record every layer near the end of this method, after we have set up
337 // the nway canvas.
338 firstFrameOfAnim = true;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400339 if (!setupMultiFrameCapture()) {
340 return surface->getCanvas();
Stan Ilieve9d00122017-09-19 12:07:10 -0400341 }
342 }
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400343
344 // Create a canvas pointer, fill it depending on what kind of capture is requested (if any)
345 SkCanvas* pictureCanvas = nullptr;
346 switch (mCaptureMode) {
347 case CaptureMode::CallbackAPI:
348 case CaptureMode::SingleFrameSKP:
349 mRecorder.reset(new SkPictureRecorder());
Nathaniel Nifong31fee3a2019-07-11 16:27:14 -0400350 pictureCanvas = mRecorder->beginRecording(surface->width(), surface->height());
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400351 break;
352 case CaptureMode::MultiFrameSKP:
353 // If a multi frame recording is active, initialize recording for a single frame of a
354 // multi frame file.
355 pictureCanvas = mMultiPic->beginPage(surface->width(), surface->height());
356 break;
357 case CaptureMode::None:
358 // Returning here in the non-capture case means we can count on pictureCanvas being
359 // non-null below.
360 return surface->getCanvas();
361 }
362
363 // Setting up an nway canvas is common to any kind of capture.
364 mNwayCanvas = std::make_unique<SkNWayCanvas>(surface->width(), surface->height());
365 mNwayCanvas->addCanvas(surface->getCanvas());
366 mNwayCanvas->addCanvas(pictureCanvas);
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500367
368 if (firstFrameOfAnim) {
369 // On the first frame of any mskp capture we want to record any layers that are needed in
370 // frame but may have been rendered offscreen before recording began.
371 // We do not maintain a list of all layers, since it isn't needed outside this rare,
372 // recording use case. Traverse the tree to find them and put them in this LayerUpdateQueue.
373 LayerUpdateQueue luq;
374 collectLayers(root, &luq);
375 recordLayers(luq, mNwayCanvas.get());
376 } else {
377 // on non-first frames, we record any normal layer draws (dirty regions)
378 recordLayers(dirtyLayers, mNwayCanvas.get());
379 }
380
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400381 return mNwayCanvas.get();
Stan Ilieve9d00122017-09-19 12:07:10 -0400382}
383
384void SkiaPipeline::endCapture(SkSurface* surface) {
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400385 if (CC_LIKELY(mCaptureMode == CaptureMode::None)) { return; }
John Reck5cca8f22018-12-10 17:06:22 -0800386 mNwayCanvas.reset();
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400387 ATRACE_CALL();
388 if (mCaptureSequence > 0 && mCaptureMode == CaptureMode::MultiFrameSKP) {
389 mMultiPic->endPage();
390 mCaptureSequence--;
391 if (mCaptureSequence == 0) {
392 mCaptureMode = CaptureMode::None;
393 // Pass mMultiPic and mOpenMultiPicStream to a background thread, which will handle
394 // the heavyweight serialization work and destroy them. mOpenMultiPicStream is released
395 // to a bare pointer because keeping it in a smart pointer makes the lambda
396 // non-copyable. The lambda is only called once, so this is safe.
397 SkFILEWStream* stream = mOpenMultiPicStream.release();
398 CommonPool::post([doc = std::move(mMultiPic), stream]{
399 ALOGD("Finalizing multi frame SKP");
400 doc->close();
401 delete stream;
402 ALOGD("Multi frame SKP complete.");
403 });
404 }
405 } else {
Stan Ilieve9d00122017-09-19 12:07:10 -0400406 sk_sp<SkPicture> picture = mRecorder->finishRecordingAsPicture();
Stan Ilieve9d00122017-09-19 12:07:10 -0400407 if (picture->approximateOpCount() > 0) {
John Reck5cca8f22018-12-10 17:06:22 -0800408 if (mPictureCapturedCallback) {
409 std::invoke(mPictureCapturedCallback, std::move(picture));
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400410 } else {
411 // single frame skp to file
Nathaniel Nifong429fff42020-01-30 14:38:21 -0500412 SkSerialProcs procs;
413 procs.fTypefaceProc = [](SkTypeface* tf, void* ctx){
414 return tf->serialize(SkTypeface::SerializeBehavior::kDoIncludeData);
415 };
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400416 auto data = picture->serialize();
417 savePictureAsync(data, mCapturedFile);
418 mCaptureSequence = 0;
Stan Ilieve9d00122017-09-19 12:07:10 -0400419 }
Stan Ilieve9d00122017-09-19 12:07:10 -0400420 }
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400421 mCaptureMode = CaptureMode::None;
Stan Ilieve9d00122017-09-19 12:07:10 -0400422 mRecorder.reset();
423 }
424}
425
Stan Iliev500a0c32016-10-26 10:30:09 -0400426void SkiaPipeline::renderFrame(const LayerUpdateQueue& layers, const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -0700427 const std::vector<sp<RenderNode>>& nodes, bool opaque,
Greg Danielc4076782019-01-08 16:01:18 -0500428 const Rect& contentDrawBounds, sk_sp<SkSurface> surface,
429 const SkMatrix& preTransform) {
John Reck5cca8f22018-12-10 17:06:22 -0800430 bool previousSkpEnabled = Properties::skpCaptureEnabled;
431 if (mPictureCapturedCallback) {
432 Properties::skpCaptureEnabled = true;
433 }
434
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500435 // Initialize the canvas for the current frame, that might be a recording canvas if SKP
436 // capture is enabled.
437 SkCanvas* canvas = tryCapture(surface.get(), nodes[0].get(), layers);
438
Stan Iliev500a0c32016-10-26 10:30:09 -0400439 // draw all layers up front
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700440 renderLayersImpl(layers, opaque);
Stan Iliev500a0c32016-10-26 10:30:09 -0400441
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500442 renderFrameImpl(clip, nodes, opaque, contentDrawBounds, canvas, preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -0500443
Stan Ilieve9d00122017-09-19 12:07:10 -0400444 endCapture(surface.get());
Matt Sarettf58cc922016-11-14 18:33:38 -0500445
446 if (CC_UNLIKELY(Properties::debugOverdraw)) {
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500447 renderOverdraw(clip, nodes, contentDrawBounds, surface, preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -0500448 }
449
450 ATRACE_NAME("flush commands");
Stan Ilieve9d00122017-09-19 12:07:10 -0400451 surface->getCanvas()->flush();
John Reck5cca8f22018-12-10 17:06:22 -0800452
453 Properties::skpCaptureEnabled = previousSkpEnabled;
Matt Sarettf58cc922016-11-14 18:33:38 -0500454}
455
Stan Iliev52771272016-11-17 09:54:38 -0500456namespace {
457static Rect nodeBounds(RenderNode& node) {
458 auto& props = node.properties();
John Reck1bcacfd2017-11-03 10:12:19 -0700459 return Rect(props.getLeft(), props.getTop(), props.getRight(), props.getBottom());
Stan Iliev52771272016-11-17 09:54:38 -0500460}
John Reck0fa0cbc2019-04-05 16:57:46 -0700461} // namespace
Stan Iliev52771272016-11-17 09:54:38 -0500462
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500463void SkiaPipeline::renderFrameImpl(const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -0700464 const std::vector<sp<RenderNode>>& nodes, bool opaque,
Greg Danielc4076782019-01-08 16:01:18 -0500465 const Rect& contentDrawBounds, SkCanvas* canvas,
466 const SkMatrix& preTransform) {
Stan Ilievb66b8bb2016-12-15 18:17:42 -0500467 SkAutoCanvasRestore saver(canvas, true);
Nathaniel Nifongcff969f2020-01-09 14:03:49 -0500468 auto clipRestriction = preTransform.mapRect(clip).roundOut();
469 canvas->androidFramework_setDeviceClipRestriction(clipRestriction);
470 canvas->drawAnnotation(SkRect::Make(clipRestriction), "AndroidDeviceClipRestriction",
471 nullptr);
Greg Danielc4076782019-01-08 16:01:18 -0500472 canvas->concat(preTransform);
Stan Iliev500a0c32016-10-26 10:30:09 -0400473
Stan Ilievaadc0322018-03-23 10:50:11 -0400474 // STOPSHIP: Revert, temporary workaround to clear always F16 frame buffer for b/74976293
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700475 if (!opaque || getSurfaceColorType() == kRGBA_F16_SkColorType) {
Stan Iliev500a0c32016-10-26 10:30:09 -0400476 canvas->clear(SK_ColorTRANSPARENT);
477 }
478
Stan Iliev52771272016-11-17 09:54:38 -0500479 if (1 == nodes.size()) {
480 if (!nodes[0]->nothingToDraw()) {
Stan Iliev52771272016-11-17 09:54:38 -0500481 RenderNodeDrawable root(nodes[0].get(), canvas);
482 root.draw(canvas);
483 }
484 } else if (0 == nodes.size()) {
John Reck1bcacfd2017-11-03 10:12:19 -0700485 // nothing to draw
Stan Iliev52771272016-11-17 09:54:38 -0500486 } else {
487 // It there are multiple render nodes, they are laid out as follows:
488 // #0 - backdrop (content + caption)
489 // #1 - content (local bounds are at (0,0), will be translated and clipped to backdrop)
490 // #2 - additional overlay nodes
John Reck1bcacfd2017-11-03 10:12:19 -0700491 // Usually the backdrop cannot be seen since it will be entirely covered by the content.
492 // While
493 // resizing however it might become partially visible. The following render loop will crop
494 // the
495 // backdrop against the content and draw the remaining part of it. It will then draw the
496 // content
Stan Iliev52771272016-11-17 09:54:38 -0500497 // cropped to the backdrop (since that indicates a shrinking of the window).
498 //
499 // Additional nodes will be drawn on top with no particular clipping semantics.
Stan Iliev500a0c32016-10-26 10:30:09 -0400500
Stan Iliev52771272016-11-17 09:54:38 -0500501 // Usually the contents bounds should be mContentDrawBounds - however - we will
502 // move it towards the fixed edge to give it a more stable appearance (for the moment).
503 // If there is no content bounds we ignore the layering as stated above and start with 2.
Stan Iliev500a0c32016-10-26 10:30:09 -0400504
Stan Iliev52771272016-11-17 09:54:38 -0500505 // Backdrop bounds in render target space
506 const Rect backdrop = nodeBounds(*nodes[0]);
Stan Iliev500a0c32016-10-26 10:30:09 -0400507
John Reck1bcacfd2017-11-03 10:12:19 -0700508 // Bounds that content will fill in render target space (note content node bounds may be
509 // bigger)
Stan Iliev52771272016-11-17 09:54:38 -0500510 Rect content(contentDrawBounds.getWidth(), contentDrawBounds.getHeight());
511 content.translate(backdrop.left, backdrop.top);
512 if (!content.contains(backdrop) && !nodes[0]->nothingToDraw()) {
513 // Content doesn't entirely overlap backdrop, so fill around content (right/bottom)
Stan Iliev500a0c32016-10-26 10:30:09 -0400514
Stan Iliev52771272016-11-17 09:54:38 -0500515 // Note: in the future, if content doesn't snap to backdrop's left/top, this may need to
John Reck1bcacfd2017-11-03 10:12:19 -0700516 // also fill left/top. Currently, both 2up and freeform position content at the top/left
517 // of
Stan Iliev52771272016-11-17 09:54:38 -0500518 // the backdrop, so this isn't necessary.
519 RenderNodeDrawable backdropNode(nodes[0].get(), canvas);
520 if (content.right < backdrop.right) {
521 // draw backdrop to right side of content
522 SkAutoCanvasRestore acr(canvas, true);
John Reck1bcacfd2017-11-03 10:12:19 -0700523 canvas->clipRect(SkRect::MakeLTRB(content.right, backdrop.top, backdrop.right,
524 backdrop.bottom));
Stan Iliev52771272016-11-17 09:54:38 -0500525 backdropNode.draw(canvas);
526 }
527 if (content.bottom < backdrop.bottom) {
528 // draw backdrop to bottom of content
529 // Note: bottom fill uses content left/right, to avoid overdrawing left/right fill
530 SkAutoCanvasRestore acr(canvas, true);
John Reck1bcacfd2017-11-03 10:12:19 -0700531 canvas->clipRect(SkRect::MakeLTRB(content.left, content.bottom, content.right,
532 backdrop.bottom));
Stan Iliev52771272016-11-17 09:54:38 -0500533 backdropNode.draw(canvas);
534 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400535 }
536
Stan Iliev52771272016-11-17 09:54:38 -0500537 RenderNodeDrawable contentNode(nodes[1].get(), canvas);
538 if (!backdrop.isEmpty()) {
539 // content node translation to catch up with backdrop
540 float dx = backdrop.left - contentDrawBounds.left;
541 float dy = backdrop.top - contentDrawBounds.top;
542
543 SkAutoCanvasRestore acr(canvas, true);
544 canvas->translate(dx, dy);
John Reck1bcacfd2017-11-03 10:12:19 -0700545 const SkRect contentLocalClip =
546 SkRect::MakeXYWH(contentDrawBounds.left, contentDrawBounds.top,
547 backdrop.getWidth(), backdrop.getHeight());
Stan Iliev52771272016-11-17 09:54:38 -0500548 canvas->clipRect(contentLocalClip);
549 contentNode.draw(canvas);
550 } else {
551 SkAutoCanvasRestore acr(canvas, true);
552 contentNode.draw(canvas);
553 }
554
555 // remaining overlay nodes, simply defer
556 for (size_t index = 2; index < nodes.size(); index++) {
557 if (!nodes[index]->nothingToDraw()) {
558 SkAutoCanvasRestore acr(canvas, true);
559 RenderNodeDrawable overlayNode(nodes[index].get(), canvas);
560 overlayNode.draw(canvas);
561 }
562 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400563 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400564}
565
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500566void SkiaPipeline::dumpResourceCacheUsage() const {
Robert Phillips57bb0bf2019-09-06 13:18:17 -0400567 int resources;
568 size_t bytes;
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500569 mRenderThread.getGrContext()->getResourceCacheUsage(&resources, &bytes);
Robert Phillips57bb0bf2019-09-06 13:18:17 -0400570 size_t maxBytes = mRenderThread.getGrContext()->getResourceCacheLimit();
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500571
572 SkString log("Resource Cache Usage:\n");
Robert Phillips57bb0bf2019-09-06 13:18:17 -0400573 log.appendf("%8d items\n", resources);
John Reck1bcacfd2017-11-03 10:12:19 -0700574 log.appendf("%8zu bytes (%.2f MB) out of %.2f MB maximum\n", bytes,
575 bytes * (1.0f / (1024.0f * 1024.0f)), maxBytes * (1.0f / (1024.0f * 1024.0f)));
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500576
577 ALOGD("%s", log.c_str());
578}
579
Peiyong Lin3bff1352018-12-11 07:56:07 -0800580void SkiaPipeline::setSurfaceColorProperties(ColorMode colorMode) {
581 if (colorMode == ColorMode::SRGB) {
582 mSurfaceColorType = SkColorType::kN32_SkColorType;
Peiyong Lin3bff1352018-12-11 07:56:07 -0800583 mSurfaceColorSpace = SkColorSpace::MakeSRGB();
584 } else if (colorMode == ColorMode::WideColorGamut) {
585 mSurfaceColorType = DeviceInfo::get()->getWideColorType();
Peiyong Lin3bff1352018-12-11 07:56:07 -0800586 mSurfaceColorSpace = DeviceInfo::get()->getWideColorSpace();
587 } else {
588 LOG_ALWAYS_FATAL("Unreachable: unsupported color mode.");
589 }
590}
591
Matt Sarettf58cc922016-11-14 18:33:38 -0500592// Overdraw debugging
593
594// These colors should be kept in sync with Caches::getOverdrawColor() with a few differences.
595// This implementation:
596// (1) Requires transparent entries for "no overdraw" and "single draws".
597// (2) Requires premul colors (instead of unpremul).
598// (3) Requires RGBA colors (instead of BGRA).
599static const uint32_t kOverdrawColors[2][6] = {
John Reck1bcacfd2017-11-03 10:12:19 -0700600 {
John Reck0fa0cbc2019-04-05 16:57:46 -0700601 0x00000000,
602 0x00000000,
603 0x2f2f0000,
604 0x2f002f00,
605 0x3f00003f,
606 0x7f00007f,
John Reck1bcacfd2017-11-03 10:12:19 -0700607 },
608 {
John Reck0fa0cbc2019-04-05 16:57:46 -0700609 0x00000000,
610 0x00000000,
611 0x2f2f0000,
612 0x4f004f4f,
613 0x5f50335f,
614 0x7f00007f,
John Reck1bcacfd2017-11-03 10:12:19 -0700615 },
Matt Sarettf58cc922016-11-14 18:33:38 -0500616};
617
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500618void SkiaPipeline::renderOverdraw(const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -0700619 const std::vector<sp<RenderNode>>& nodes,
Greg Danielc4076782019-01-08 16:01:18 -0500620 const Rect& contentDrawBounds, sk_sp<SkSurface> surface,
621 const SkMatrix& preTransform) {
Matt Sarettf58cc922016-11-14 18:33:38 -0500622 // Set up the overdraw canvas.
623 SkImageInfo offscreenInfo = SkImageInfo::MakeA8(surface->width(), surface->height());
624 sk_sp<SkSurface> offscreen = surface->makeSurface(offscreenInfo);
Nathaniel Nifongfe05b7c2019-09-17 12:52:52 -0400625 LOG_ALWAYS_FATAL_IF(!offscreen, "Failed to create offscreen SkSurface for overdraw viz.");
Matt Sarettf58cc922016-11-14 18:33:38 -0500626 SkOverdrawCanvas overdrawCanvas(offscreen->getCanvas());
627
628 // Fake a redraw to replay the draw commands. This will increment the alpha channel
629 // each time a pixel would have been drawn.
630 // Pass true for opaque so we skip the clear - the overdrawCanvas is already zero
631 // initialized.
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500632 renderFrameImpl(clip, nodes, true, contentDrawBounds, &overdrawCanvas, preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -0500633 sk_sp<SkImage> counts = offscreen->makeImageSnapshot();
634
635 // Draw overdraw colors to the canvas. The color filter will convert counts to colors.
636 SkPaint paint;
637 const SkPMColor* colors = kOverdrawColors[static_cast<int>(Properties::overdrawColorSet)];
638 paint.setColorFilter(SkOverdrawColorFilter::Make(colors));
639 surface->getCanvas()->drawImage(counts.get(), 0.0f, 0.0f, &paint);
640}
641
Stan Iliev500a0c32016-10-26 10:30:09 -0400642} /* namespace skiapipeline */
643} /* namespace uirenderer */
644} /* namespace android */