blob: 35a885f469195aaf9f1e372708027351698b06a8 [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 Nifongd2e49a22019-06-24 15:07:34 -040027#include <SkSerialProcs.h>
Fedor Kudasov90df0562019-06-19 11:41:34 +010028#include "LightingInfo.h"
Stan Iliev23c38a92017-03-23 00:12:50 -040029#include "VectorDrawable.h"
John Reck322b8ab2019-03-14 13:15:28 -070030#include "thread/CommonPool.h"
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040031#include "tools/SkSharingProc.h"
John Reck1bcacfd2017-11-03 10:12:19 -070032#include "utils/TraceUtils.h"
Nathaniel Nifong2945bff2019-11-25 09:34:21 -050033#include "utils/String8.h"
Stan Iliev500a0c32016-10-26 10:30:09 -040034
Ben Wagner3aeda5c2017-03-17 17:22:01 -040035#include <unistd.h>
36
Jerome Gaillarda02a12d2019-05-28 18:07:56 +010037#include <android-base/properties.h>
38
Stan Iliev500a0c32016-10-26 10:30:09 -040039using namespace android::uirenderer::renderthread;
40
41namespace android {
42namespace uirenderer {
43namespace skiapipeline {
44
John Reck1bcacfd2017-11-03 10:12:19 -070045SkiaPipeline::SkiaPipeline(RenderThread& thread) : mRenderThread(thread) {
Stan Iliev23c38a92017-03-23 00:12:50 -040046}
Stan Iliev500a0c32016-10-26 10:30:09 -040047
Stan Iliev232f3622017-08-23 17:15:09 -040048SkiaPipeline::~SkiaPipeline() {
49 unpinImages();
50}
51
Stan Iliev500a0c32016-10-26 10:30:09 -040052void SkiaPipeline::onDestroyHardwareResources() {
Derek Sollenberger92a9eb92018-04-12 13:42:19 -040053 unpinImages();
Derek Sollenbergerf9e45d12017-06-01 13:07:39 -040054 mRenderThread.cacheManager().trimStaleResources();
Stan Iliev500a0c32016-10-26 10:30:09 -040055}
56
Derek Sollenbergerb7d34b62016-11-04 10:46:18 -040057bool SkiaPipeline::pinImages(std::vector<SkImage*>& mutableImages) {
58 for (SkImage* image : mutableImages) {
Derek Sollenberger189e8742016-11-16 16:00:17 -050059 if (SkImage_pinAsTexture(image, mRenderThread.getGrContext())) {
60 mPinnedImages.emplace_back(sk_ref_sp(image));
61 } else {
62 return false;
63 }
Derek Sollenbergerb7d34b62016-11-04 10:46:18 -040064 }
65 return true;
66}
67
68void SkiaPipeline::unpinImages() {
69 for (auto& image : mPinnedImages) {
70 SkImage_unpinAsTexture(image.get(), mRenderThread.getGrContext());
71 }
72 mPinnedImages.clear();
73}
74
John Reckd9d7f122018-05-03 14:40:56 -070075void SkiaPipeline::renderLayers(const LightGeometry& lightGeometry,
John Reck1bcacfd2017-11-03 10:12:19 -070076 LayerUpdateQueue* layerUpdateQueue, bool opaque,
Peiyong Lin1f6aa122018-09-10 16:28:08 -070077 const LightInfo& lightInfo) {
Fedor Kudasov90df0562019-06-19 11:41:34 +010078 LightingInfo::updateLighting(lightGeometry, lightInfo);
Stan Iliev500a0c32016-10-26 10:30:09 -040079 ATRACE_NAME("draw layers");
Peiyong Lin1f6aa122018-09-10 16:28:08 -070080 renderLayersImpl(*layerUpdateQueue, opaque);
Stan Iliev500a0c32016-10-26 10:30:09 -040081 layerUpdateQueue->clear();
82}
83
Peiyong Lin1f6aa122018-09-10 16:28:08 -070084void SkiaPipeline::renderLayersImpl(const LayerUpdateQueue& layers, bool opaque) {
Derek Sollenbergerf7df1842017-09-05 11:15:58 -040085 sk_sp<GrContext> cachedContext;
86
Stan Iliev500a0c32016-10-26 10:30:09 -040087 // Render all layers that need to be updated, in order.
88 for (size_t i = 0; i < layers.entries().size(); i++) {
John Reckfc29f7acd2017-03-02 13:23:16 -080089 RenderNode* layerNode = layers.entries()[i].renderNode.get();
Stan Iliev500a0c32016-10-26 10:30:09 -040090 // only schedule repaint if node still on layer - possible it may have been
91 // removed during a dropped frame, but layers may still remain scheduled so
92 // as not to lose info on what portion is damaged
Nathaniel Nifong2945bff2019-11-25 09:34:21 -050093 if (CC_UNLIKELY(layerNode->getLayerSurface() == nullptr)) {
94 continue;
95 }
96 SkASSERT(layerNode->getLayerSurface());
97 SkiaDisplayList* displayList = (SkiaDisplayList*)layerNode->getDisplayList();
98 if (!displayList || displayList->isEmpty()) {
99 ALOGE("%p drawLayers(%s) : missing drawable", layerNode, layerNode->getName());
100 return;
101 }
102
103 const Rect& layerDamage = layers.entries()[i].damage;
104
105 SkCanvas* layerCanvas = layerNode->getLayerSurface()->getCanvas();
106
107 int saveCount = layerCanvas->save();
108 SkASSERT(saveCount == 1);
109
110 layerCanvas->androidFramework_setDeviceClipRestriction(layerDamage.toSkIRect());
111
112 // TODO: put localized light center calculation and storage to a drawable related code.
113 // It does not seem right to store something localized in a global state
114 // fix here and in recordLayers
115 const Vector3 savedLightCenter(LightingInfo::getLightCenterRaw());
116 Vector3 transformedLightCenter(savedLightCenter);
117 // map current light center into RenderNode's coordinate space
118 layerNode->getSkiaLayer()->inverseTransformInWindow.mapPoint3d(transformedLightCenter);
119 LightingInfo::setLightCenterRaw(transformedLightCenter);
120
121 const RenderProperties& properties = layerNode->properties();
122 const SkRect bounds = SkRect::MakeWH(properties.getWidth(), properties.getHeight());
123 if (properties.getClipToBounds() && layerCanvas->quickReject(bounds)) {
124 return;
125 }
126
127 ATRACE_FORMAT("drawLayer [%s] %.1f x %.1f", layerNode->getName(), bounds.width(),
128 bounds.height());
129
130 layerNode->getSkiaLayer()->hasRenderedSinceRepaint = false;
131 layerCanvas->clear(SK_ColorTRANSPARENT);
132
133 RenderNodeDrawable root(layerNode, layerCanvas, false);
134 root.forceDraw(layerCanvas);
135 layerCanvas->restoreToCount(saveCount);
136
137 LightingInfo::setLightCenterRaw(savedLightCenter);
138
139 // cache the current context so that we can defer flushing it until
140 // either all the layers have been rendered or the context changes
141 GrContext* currentContext = layerNode->getLayerSurface()->getCanvas()->getGrContext();
142 if (cachedContext.get() != currentContext) {
143 if (cachedContext.get()) {
144 ATRACE_NAME("flush layers (context changed)");
145 cachedContext->flush();
Stan Iliev500a0c32016-10-26 10:30:09 -0400146 }
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500147 cachedContext.reset(SkSafeRef(currentContext));
Stan Iliev500a0c32016-10-26 10:30:09 -0400148 }
149 }
Derek Sollenbergerf7df1842017-09-05 11:15:58 -0400150
151 if (cachedContext.get()) {
Derek Sollenbergerbe3876c2018-04-20 16:13:31 -0400152 ATRACE_NAME("flush layers");
Derek Sollenbergerf7df1842017-09-05 11:15:58 -0400153 cachedContext->flush();
154 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400155}
156
John Reck1bcacfd2017-11-03 10:12:19 -0700157bool SkiaPipeline::createOrUpdateLayer(RenderNode* node, const DamageAccumulator& damageAccumulator,
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700158 ErrorHandler* errorHandler) {
Derek Sollenberger03e6cff72017-12-04 15:07:08 -0500159 // compute the size of the surface (i.e. texture) to be allocated for this layer
160 const int surfaceWidth = ceilf(node->getWidth() / float(LAYER_SIZE)) * LAYER_SIZE;
161 const int surfaceHeight = ceilf(node->getHeight() / float(LAYER_SIZE)) * LAYER_SIZE;
162
Stan Iliev500a0c32016-10-26 10:30:09 -0400163 SkSurface* layer = node->getLayerSurface();
Derek Sollenberger03e6cff72017-12-04 15:07:08 -0500164 if (!layer || layer->width() != surfaceWidth || layer->height() != surfaceHeight) {
Stan Iliev08fc19a2017-07-24 10:20:33 -0400165 SkImageInfo info;
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700166 info = SkImageInfo::Make(surfaceWidth, surfaceHeight, getSurfaceColorType(),
Derek Sollenbergerd01b5912018-10-19 15:55:33 -0400167 kPremul_SkAlphaType, getSurfaceColorSpace());
Stan Iliev500a0c32016-10-26 10:30:09 -0400168 SkSurfaceProps props(0, kUnknown_SkPixelGeometry);
169 SkASSERT(mRenderThread.getGrContext() != nullptr);
John Reck1bcacfd2017-11-03 10:12:19 -0700170 node->setLayerSurface(SkSurface::MakeRenderTarget(mRenderThread.getGrContext(),
Derek Sollenberger25833d22019-01-14 13:55:55 -0500171 SkBudgeted::kYes, info, 0,
172 this->getSurfaceOrigin(), &props));
Stan Iliev500a0c32016-10-26 10:30:09 -0400173 if (node->getLayerSurface()) {
174 // update the transform in window of the layer to reset its origin wrt light source
175 // position
176 Matrix4 windowTransform;
177 damageAccumulator.computeCurrentTransform(&windowTransform);
Stan Ilievda7c19c2019-05-22 14:43:44 -0400178 node->getSkiaLayer()->inverseTransformInWindow.loadInverse(windowTransform);
Stan Iliev216b1572018-03-26 14:29:50 -0400179 } else {
180 String8 cachesOutput;
181 mRenderThread.cacheManager().dumpMemoryUsage(cachesOutput,
John Reck283bb462018-12-13 16:40:14 -0800182 &mRenderThread.renderState());
Stan Iliev216b1572018-03-26 14:29:50 -0400183 ALOGE("%s", cachesOutput.string());
184 if (errorHandler) {
185 std::ostringstream err;
186 err << "Unable to create layer for " << node->getName();
187 const int maxTextureSize = DeviceInfo::get()->maxTextureSize();
188 err << ", size " << info.width() << "x" << info.height() << " max size "
John Reck283bb462018-12-13 16:40:14 -0800189 << maxTextureSize << " color type " << (int)info.colorType() << " has context "
190 << (int)(mRenderThread.getGrContext() != nullptr);
Stan Iliev216b1572018-03-26 14:29:50 -0400191 errorHandler->onError(err.str());
192 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400193 }
194 return true;
195 }
196 return false;
197}
198
Stan Iliev500a0c32016-10-26 10:30:09 -0400199void SkiaPipeline::prepareToDraw(const RenderThread& thread, Bitmap* bitmap) {
200 GrContext* context = thread.getGrContext();
201 if (context) {
202 ATRACE_FORMAT("Bitmap#prepareToDraw %dx%d", bitmap->width(), bitmap->height());
Derek Sollenbergerd01b5912018-10-19 15:55:33 -0400203 auto image = bitmap->makeImage();
Stan Iliev7bc3bc62017-05-24 13:28:36 -0400204 if (image.get() && !bitmap->isHardware()) {
205 SkImage_pinAsTexture(image.get(), context);
206 SkImage_unpinAsTexture(image.get(), context);
207 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400208 }
209}
210
John Reck322b8ab2019-03-14 13:15:28 -0700211static void savePictureAsync(const sk_sp<SkData>& data, const std::string& filename) {
212 CommonPool::post([data, filename] {
213 if (0 == access(filename.c_str(), F_OK)) {
Stan Ilieve9d00122017-09-19 12:07:10 -0400214 return;
215 }
216
John Reck322b8ab2019-03-14 13:15:28 -0700217 SkFILEWStream stream(filename.c_str());
Stan Ilieve9d00122017-09-19 12:07:10 -0400218 if (stream.isValid()) {
John Reck322b8ab2019-03-14 13:15:28 -0700219 stream.write(data->data(), data->size());
Stan Ilieve9d00122017-09-19 12:07:10 -0400220 stream.flush();
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400221 ALOGD("SKP Captured Drawing Output (%zu bytes) for frame. %s", stream.bytesWritten(),
John Reck322b8ab2019-03-14 13:15:28 -0700222 filename.c_str());
Stan Ilieve9d00122017-09-19 12:07:10 -0400223 }
John Reck322b8ab2019-03-14 13:15:28 -0700224 });
225}
Stan Ilieve9d00122017-09-19 12:07:10 -0400226
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400227// Note multiple SkiaPipeline instances may be loaded if more than one app is visible.
228// Each instance may observe the filename changing and try to record to a file of the same name.
229// Only the first one will succeed. There is no scope available here where we could coordinate
230// to cause this function to return true for only one of the instances.
231bool SkiaPipeline::shouldStartNewFileCapture() {
232 // Don't start a new file based capture if one is currently ongoing.
233 if (mCaptureMode != CaptureMode::None) { return false; }
234
235 // A new capture is started when the filename property changes.
236 // Read the filename property.
237 std::string prop = base::GetProperty(PROPERTY_CAPTURE_SKP_FILENAME, "0");
238 // if the filename property changed to a valid value
239 if (prop[0] != '0' && mCapturedFile != prop) {
240 // remember this new filename
241 mCapturedFile = prop;
242 // and get a property indicating how many frames to capture.
243 mCaptureSequence = base::GetIntProperty(PROPERTY_CAPTURE_SKP_FRAMES, 1);
John Reck5cca8f22018-12-10 17:06:22 -0800244 if (mCaptureSequence <= 0) {
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400245 return false;
246 } else if (mCaptureSequence == 1) {
247 mCaptureMode = CaptureMode::SingleFrameSKP;
248 } else {
249 mCaptureMode = CaptureMode::MultiFrameSKP;
Stan Ilieve9d00122017-09-19 12:07:10 -0400250 }
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400251 return true;
252 }
253 return false;
254}
255
256// performs the first-frame work of a multi frame SKP capture. Returns true if successful.
257bool SkiaPipeline::setupMultiFrameCapture() {
258 ALOGD("Set up multi-frame capture, frames = %d", mCaptureSequence);
259 // We own this stream and need to hold it until close() finishes.
260 auto stream = std::make_unique<SkFILEWStream>(mCapturedFile.c_str());
261 if (stream->isValid()) {
262 mOpenMultiPicStream = std::move(stream);
263 mSerialContext.reset(new SkSharingSerialContext());
264 SkSerialProcs procs;
265 procs.fImageProc = SkSharingSerialContext::serializeImage;
266 procs.fImageCtx = mSerialContext.get();
267 // SkDocuments don't take owership of the streams they write.
268 // we need to keep it until after mMultiPic.close()
269 // procs is passed as a pointer, but just as a method of having an optional default.
270 // procs doesn't need to outlive this Make call.
271 mMultiPic = SkMakeMultiPictureDocument(mOpenMultiPicStream.get(), &procs);
272 return true;
273 } else {
274 ALOGE("Could not open \"%s\" for writing.", mCapturedFile.c_str());
275 mCaptureSequence = 0;
276 mCaptureMode = CaptureMode::None;
277 return false;
278 }
279}
280
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500281// recurse through the rendernode's children, add any nodes which are layers to the queue.
282static void collectLayers(RenderNode* node, LayerUpdateQueue* layers) {
283 SkiaDisplayList* dl = (SkiaDisplayList*)node->getDisplayList();
284 if (dl) {
285 const auto& prop = node->properties();
286 if (node->hasLayer()) {
287 layers->enqueueLayerWithDamage(node, Rect(prop.getWidth(), prop.getHeight()));
288 }
289 // The way to recurse through rendernodes is to call this with a lambda.
290 dl->updateChildren([&](RenderNode* child) { collectLayers(child, layers); });
291 }
292}
293
294// record the provided layers to the provided canvas as self-contained skpictures.
295static void recordLayers(const LayerUpdateQueue& layers,
296 SkCanvas* mskpCanvas) {
297 const Vector3 savedLightCenter(LightingInfo::getLightCenterRaw());
298 // Record the commands to re-draw each dirty layer into an SkPicture
299 for (size_t i = 0; i < layers.entries().size(); i++) {
300 RenderNode* layerNode = layers.entries()[i].renderNode.get();
301 const Rect& layerDamage = layers.entries()[i].damage;
302 const RenderProperties& properties = layerNode->properties();
303
304 // Temporarily map current light center into RenderNode's coordinate space
305 Vector3 transformedLightCenter(savedLightCenter);
306 layerNode->getSkiaLayer()->inverseTransformInWindow.mapPoint3d(transformedLightCenter);
307 LightingInfo::setLightCenterRaw(transformedLightCenter);
308
309 SkPictureRecorder layerRec;
310 auto* recCanvas = layerRec.beginRecording(properties.getWidth(),
311 properties.getHeight());
312 // This is not recorded but still causes clipping.
313 recCanvas->androidFramework_setDeviceClipRestriction(layerDamage.toSkIRect());
314 RenderNodeDrawable root(layerNode, recCanvas, false);
315 root.forceDraw(recCanvas);
316 // Now write this picture into the SKP canvas with an annotation indicating what it is
317 mskpCanvas->drawAnnotation(layerDamage.toSkRect(), String8::format(
318 "OffscreenLayerDraw|%" PRId64, layerNode->uniqueId()).c_str(), nullptr);
319 mskpCanvas->drawPicture(layerRec.finishRecordingAsPicture());
320 }
321 LightingInfo::setLightCenterRaw(savedLightCenter);
322}
323
324SkCanvas* SkiaPipeline::tryCapture(SkSurface* surface, RenderNode* root,
325 const LayerUpdateQueue& dirtyLayers) {
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400326 if (CC_LIKELY(!Properties::skpCaptureEnabled)) {
327 return surface->getCanvas(); // Bail out early when capture is not turned on.
328 }
329 // Note that shouldStartNewFileCapture tells us if this is the *first* frame of a capture.
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500330 bool firstFrameOfAnim = false;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400331 if (shouldStartNewFileCapture() && mCaptureMode == CaptureMode::MultiFrameSKP) {
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500332 // set a reminder to record every layer near the end of this method, after we have set up
333 // the nway canvas.
334 firstFrameOfAnim = true;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400335 if (!setupMultiFrameCapture()) {
336 return surface->getCanvas();
Stan Ilieve9d00122017-09-19 12:07:10 -0400337 }
338 }
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400339
340 // Create a canvas pointer, fill it depending on what kind of capture is requested (if any)
341 SkCanvas* pictureCanvas = nullptr;
342 switch (mCaptureMode) {
343 case CaptureMode::CallbackAPI:
344 case CaptureMode::SingleFrameSKP:
345 mRecorder.reset(new SkPictureRecorder());
Nathaniel Nifong31fee3a2019-07-11 16:27:14 -0400346 pictureCanvas = mRecorder->beginRecording(surface->width(), surface->height());
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400347 break;
348 case CaptureMode::MultiFrameSKP:
349 // If a multi frame recording is active, initialize recording for a single frame of a
350 // multi frame file.
351 pictureCanvas = mMultiPic->beginPage(surface->width(), surface->height());
352 break;
353 case CaptureMode::None:
354 // Returning here in the non-capture case means we can count on pictureCanvas being
355 // non-null below.
356 return surface->getCanvas();
357 }
358
359 // Setting up an nway canvas is common to any kind of capture.
360 mNwayCanvas = std::make_unique<SkNWayCanvas>(surface->width(), surface->height());
361 mNwayCanvas->addCanvas(surface->getCanvas());
362 mNwayCanvas->addCanvas(pictureCanvas);
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500363
364 if (firstFrameOfAnim) {
365 // On the first frame of any mskp capture we want to record any layers that are needed in
366 // frame but may have been rendered offscreen before recording began.
367 // We do not maintain a list of all layers, since it isn't needed outside this rare,
368 // recording use case. Traverse the tree to find them and put them in this LayerUpdateQueue.
369 LayerUpdateQueue luq;
370 collectLayers(root, &luq);
371 recordLayers(luq, mNwayCanvas.get());
372 } else {
373 // on non-first frames, we record any normal layer draws (dirty regions)
374 recordLayers(dirtyLayers, mNwayCanvas.get());
375 }
376
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400377 return mNwayCanvas.get();
Stan Ilieve9d00122017-09-19 12:07:10 -0400378}
379
380void SkiaPipeline::endCapture(SkSurface* surface) {
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400381 if (CC_LIKELY(mCaptureMode == CaptureMode::None)) { return; }
John Reck5cca8f22018-12-10 17:06:22 -0800382 mNwayCanvas.reset();
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400383 ATRACE_CALL();
384 if (mCaptureSequence > 0 && mCaptureMode == CaptureMode::MultiFrameSKP) {
385 mMultiPic->endPage();
386 mCaptureSequence--;
387 if (mCaptureSequence == 0) {
388 mCaptureMode = CaptureMode::None;
389 // Pass mMultiPic and mOpenMultiPicStream to a background thread, which will handle
390 // the heavyweight serialization work and destroy them. mOpenMultiPicStream is released
391 // to a bare pointer because keeping it in a smart pointer makes the lambda
392 // non-copyable. The lambda is only called once, so this is safe.
393 SkFILEWStream* stream = mOpenMultiPicStream.release();
394 CommonPool::post([doc = std::move(mMultiPic), stream]{
395 ALOGD("Finalizing multi frame SKP");
396 doc->close();
397 delete stream;
398 ALOGD("Multi frame SKP complete.");
399 });
400 }
401 } else {
Stan Ilieve9d00122017-09-19 12:07:10 -0400402 sk_sp<SkPicture> picture = mRecorder->finishRecordingAsPicture();
Stan Ilieve9d00122017-09-19 12:07:10 -0400403 if (picture->approximateOpCount() > 0) {
John Reck5cca8f22018-12-10 17:06:22 -0800404 if (mPictureCapturedCallback) {
405 std::invoke(mPictureCapturedCallback, std::move(picture));
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400406 } else {
407 // single frame skp to file
408 auto data = picture->serialize();
409 savePictureAsync(data, mCapturedFile);
410 mCaptureSequence = 0;
Stan Ilieve9d00122017-09-19 12:07:10 -0400411 }
Stan Ilieve9d00122017-09-19 12:07:10 -0400412 }
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400413 mCaptureMode = CaptureMode::None;
Stan Ilieve9d00122017-09-19 12:07:10 -0400414 mRecorder.reset();
415 }
416}
417
Stan Iliev500a0c32016-10-26 10:30:09 -0400418void SkiaPipeline::renderFrame(const LayerUpdateQueue& layers, const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -0700419 const std::vector<sp<RenderNode>>& nodes, bool opaque,
Greg Danielc4076782019-01-08 16:01:18 -0500420 const Rect& contentDrawBounds, sk_sp<SkSurface> surface,
421 const SkMatrix& preTransform) {
John Reck5cca8f22018-12-10 17:06:22 -0800422 bool previousSkpEnabled = Properties::skpCaptureEnabled;
423 if (mPictureCapturedCallback) {
424 Properties::skpCaptureEnabled = true;
425 }
426
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500427 // Initialize the canvas for the current frame, that might be a recording canvas if SKP
428 // capture is enabled.
429 SkCanvas* canvas = tryCapture(surface.get(), nodes[0].get(), layers);
430
Stan Iliev500a0c32016-10-26 10:30:09 -0400431 // draw all layers up front
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700432 renderLayersImpl(layers, opaque);
Stan Iliev500a0c32016-10-26 10:30:09 -0400433
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500434 renderFrameImpl(clip, nodes, opaque, contentDrawBounds, canvas, preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -0500435
Stan Ilieve9d00122017-09-19 12:07:10 -0400436 endCapture(surface.get());
Matt Sarettf58cc922016-11-14 18:33:38 -0500437
438 if (CC_UNLIKELY(Properties::debugOverdraw)) {
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500439 renderOverdraw(clip, nodes, contentDrawBounds, surface, preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -0500440 }
441
442 ATRACE_NAME("flush commands");
Stan Ilieve9d00122017-09-19 12:07:10 -0400443 surface->getCanvas()->flush();
John Reck5cca8f22018-12-10 17:06:22 -0800444
445 Properties::skpCaptureEnabled = previousSkpEnabled;
Matt Sarettf58cc922016-11-14 18:33:38 -0500446}
447
Stan Iliev52771272016-11-17 09:54:38 -0500448namespace {
449static Rect nodeBounds(RenderNode& node) {
450 auto& props = node.properties();
John Reck1bcacfd2017-11-03 10:12:19 -0700451 return Rect(props.getLeft(), props.getTop(), props.getRight(), props.getBottom());
Stan Iliev52771272016-11-17 09:54:38 -0500452}
John Reck0fa0cbc2019-04-05 16:57:46 -0700453} // namespace
Stan Iliev52771272016-11-17 09:54:38 -0500454
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500455void SkiaPipeline::renderFrameImpl(const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -0700456 const std::vector<sp<RenderNode>>& nodes, bool opaque,
Greg Danielc4076782019-01-08 16:01:18 -0500457 const Rect& contentDrawBounds, SkCanvas* canvas,
458 const SkMatrix& preTransform) {
Stan Ilievb66b8bb2016-12-15 18:17:42 -0500459 SkAutoCanvasRestore saver(canvas, true);
Nathaniel Nifongcff969f2020-01-09 14:03:49 -0500460 auto clipRestriction = preTransform.mapRect(clip).roundOut();
461 canvas->androidFramework_setDeviceClipRestriction(clipRestriction);
462 canvas->drawAnnotation(SkRect::Make(clipRestriction), "AndroidDeviceClipRestriction",
463 nullptr);
Greg Danielc4076782019-01-08 16:01:18 -0500464 canvas->concat(preTransform);
Stan Iliev500a0c32016-10-26 10:30:09 -0400465
Stan Ilievaadc0322018-03-23 10:50:11 -0400466 // STOPSHIP: Revert, temporary workaround to clear always F16 frame buffer for b/74976293
Peiyong Lin1f6aa122018-09-10 16:28:08 -0700467 if (!opaque || getSurfaceColorType() == kRGBA_F16_SkColorType) {
Stan Iliev500a0c32016-10-26 10:30:09 -0400468 canvas->clear(SK_ColorTRANSPARENT);
469 }
470
Stan Iliev52771272016-11-17 09:54:38 -0500471 if (1 == nodes.size()) {
472 if (!nodes[0]->nothingToDraw()) {
Stan Iliev52771272016-11-17 09:54:38 -0500473 RenderNodeDrawable root(nodes[0].get(), canvas);
474 root.draw(canvas);
475 }
476 } else if (0 == nodes.size()) {
John Reck1bcacfd2017-11-03 10:12:19 -0700477 // nothing to draw
Stan Iliev52771272016-11-17 09:54:38 -0500478 } else {
479 // It there are multiple render nodes, they are laid out as follows:
480 // #0 - backdrop (content + caption)
481 // #1 - content (local bounds are at (0,0), will be translated and clipped to backdrop)
482 // #2 - additional overlay nodes
John Reck1bcacfd2017-11-03 10:12:19 -0700483 // Usually the backdrop cannot be seen since it will be entirely covered by the content.
484 // While
485 // resizing however it might become partially visible. The following render loop will crop
486 // the
487 // backdrop against the content and draw the remaining part of it. It will then draw the
488 // content
Stan Iliev52771272016-11-17 09:54:38 -0500489 // cropped to the backdrop (since that indicates a shrinking of the window).
490 //
491 // Additional nodes will be drawn on top with no particular clipping semantics.
Stan Iliev500a0c32016-10-26 10:30:09 -0400492
Stan Iliev52771272016-11-17 09:54:38 -0500493 // Usually the contents bounds should be mContentDrawBounds - however - we will
494 // move it towards the fixed edge to give it a more stable appearance (for the moment).
495 // If there is no content bounds we ignore the layering as stated above and start with 2.
Stan Iliev500a0c32016-10-26 10:30:09 -0400496
Stan Iliev52771272016-11-17 09:54:38 -0500497 // Backdrop bounds in render target space
498 const Rect backdrop = nodeBounds(*nodes[0]);
Stan Iliev500a0c32016-10-26 10:30:09 -0400499
John Reck1bcacfd2017-11-03 10:12:19 -0700500 // Bounds that content will fill in render target space (note content node bounds may be
501 // bigger)
Stan Iliev52771272016-11-17 09:54:38 -0500502 Rect content(contentDrawBounds.getWidth(), contentDrawBounds.getHeight());
503 content.translate(backdrop.left, backdrop.top);
504 if (!content.contains(backdrop) && !nodes[0]->nothingToDraw()) {
505 // Content doesn't entirely overlap backdrop, so fill around content (right/bottom)
Stan Iliev500a0c32016-10-26 10:30:09 -0400506
Stan Iliev52771272016-11-17 09:54:38 -0500507 // 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 -0700508 // also fill left/top. Currently, both 2up and freeform position content at the top/left
509 // of
Stan Iliev52771272016-11-17 09:54:38 -0500510 // the backdrop, so this isn't necessary.
511 RenderNodeDrawable backdropNode(nodes[0].get(), canvas);
512 if (content.right < backdrop.right) {
513 // draw backdrop to right side of content
514 SkAutoCanvasRestore acr(canvas, true);
John Reck1bcacfd2017-11-03 10:12:19 -0700515 canvas->clipRect(SkRect::MakeLTRB(content.right, backdrop.top, backdrop.right,
516 backdrop.bottom));
Stan Iliev52771272016-11-17 09:54:38 -0500517 backdropNode.draw(canvas);
518 }
519 if (content.bottom < backdrop.bottom) {
520 // draw backdrop to bottom of content
521 // Note: bottom fill uses content left/right, to avoid overdrawing left/right fill
522 SkAutoCanvasRestore acr(canvas, true);
John Reck1bcacfd2017-11-03 10:12:19 -0700523 canvas->clipRect(SkRect::MakeLTRB(content.left, content.bottom, content.right,
524 backdrop.bottom));
Stan Iliev52771272016-11-17 09:54:38 -0500525 backdropNode.draw(canvas);
526 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400527 }
528
Stan Iliev52771272016-11-17 09:54:38 -0500529 RenderNodeDrawable contentNode(nodes[1].get(), canvas);
530 if (!backdrop.isEmpty()) {
531 // content node translation to catch up with backdrop
532 float dx = backdrop.left - contentDrawBounds.left;
533 float dy = backdrop.top - contentDrawBounds.top;
534
535 SkAutoCanvasRestore acr(canvas, true);
536 canvas->translate(dx, dy);
John Reck1bcacfd2017-11-03 10:12:19 -0700537 const SkRect contentLocalClip =
538 SkRect::MakeXYWH(contentDrawBounds.left, contentDrawBounds.top,
539 backdrop.getWidth(), backdrop.getHeight());
Stan Iliev52771272016-11-17 09:54:38 -0500540 canvas->clipRect(contentLocalClip);
541 contentNode.draw(canvas);
542 } else {
543 SkAutoCanvasRestore acr(canvas, true);
544 contentNode.draw(canvas);
545 }
546
547 // remaining overlay nodes, simply defer
548 for (size_t index = 2; index < nodes.size(); index++) {
549 if (!nodes[index]->nothingToDraw()) {
550 SkAutoCanvasRestore acr(canvas, true);
551 RenderNodeDrawable overlayNode(nodes[index].get(), canvas);
552 overlayNode.draw(canvas);
553 }
554 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400555 }
Stan Iliev500a0c32016-10-26 10:30:09 -0400556}
557
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500558void SkiaPipeline::dumpResourceCacheUsage() const {
Robert Phillips57bb0bf2019-09-06 13:18:17 -0400559 int resources;
560 size_t bytes;
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500561 mRenderThread.getGrContext()->getResourceCacheUsage(&resources, &bytes);
Robert Phillips57bb0bf2019-09-06 13:18:17 -0400562 size_t maxBytes = mRenderThread.getGrContext()->getResourceCacheLimit();
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500563
564 SkString log("Resource Cache Usage:\n");
Robert Phillips57bb0bf2019-09-06 13:18:17 -0400565 log.appendf("%8d items\n", resources);
John Reck1bcacfd2017-11-03 10:12:19 -0700566 log.appendf("%8zu bytes (%.2f MB) out of %.2f MB maximum\n", bytes,
567 bytes * (1.0f / (1024.0f * 1024.0f)), maxBytes * (1.0f / (1024.0f * 1024.0f)));
Matt Sarett4bda6bf2016-11-07 15:43:41 -0500568
569 ALOGD("%s", log.c_str());
570}
571
Peiyong Lin3bff1352018-12-11 07:56:07 -0800572void SkiaPipeline::setSurfaceColorProperties(ColorMode colorMode) {
573 if (colorMode == ColorMode::SRGB) {
574 mSurfaceColorType = SkColorType::kN32_SkColorType;
Peiyong Lin3bff1352018-12-11 07:56:07 -0800575 mSurfaceColorSpace = SkColorSpace::MakeSRGB();
576 } else if (colorMode == ColorMode::WideColorGamut) {
577 mSurfaceColorType = DeviceInfo::get()->getWideColorType();
Peiyong Lin3bff1352018-12-11 07:56:07 -0800578 mSurfaceColorSpace = DeviceInfo::get()->getWideColorSpace();
579 } else {
580 LOG_ALWAYS_FATAL("Unreachable: unsupported color mode.");
581 }
582}
583
Matt Sarettf58cc922016-11-14 18:33:38 -0500584// Overdraw debugging
585
586// These colors should be kept in sync with Caches::getOverdrawColor() with a few differences.
587// This implementation:
588// (1) Requires transparent entries for "no overdraw" and "single draws".
589// (2) Requires premul colors (instead of unpremul).
590// (3) Requires RGBA colors (instead of BGRA).
591static const uint32_t kOverdrawColors[2][6] = {
John Reck1bcacfd2017-11-03 10:12:19 -0700592 {
John Reck0fa0cbc2019-04-05 16:57:46 -0700593 0x00000000,
594 0x00000000,
595 0x2f2f0000,
596 0x2f002f00,
597 0x3f00003f,
598 0x7f00007f,
John Reck1bcacfd2017-11-03 10:12:19 -0700599 },
600 {
John Reck0fa0cbc2019-04-05 16:57:46 -0700601 0x00000000,
602 0x00000000,
603 0x2f2f0000,
604 0x4f004f4f,
605 0x5f50335f,
606 0x7f00007f,
John Reck1bcacfd2017-11-03 10:12:19 -0700607 },
Matt Sarettf58cc922016-11-14 18:33:38 -0500608};
609
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500610void SkiaPipeline::renderOverdraw(const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -0700611 const std::vector<sp<RenderNode>>& nodes,
Greg Danielc4076782019-01-08 16:01:18 -0500612 const Rect& contentDrawBounds, sk_sp<SkSurface> surface,
613 const SkMatrix& preTransform) {
Matt Sarettf58cc922016-11-14 18:33:38 -0500614 // Set up the overdraw canvas.
615 SkImageInfo offscreenInfo = SkImageInfo::MakeA8(surface->width(), surface->height());
616 sk_sp<SkSurface> offscreen = surface->makeSurface(offscreenInfo);
Nathaniel Nifongfe05b7c2019-09-17 12:52:52 -0400617 LOG_ALWAYS_FATAL_IF(!offscreen, "Failed to create offscreen SkSurface for overdraw viz.");
Matt Sarettf58cc922016-11-14 18:33:38 -0500618 SkOverdrawCanvas overdrawCanvas(offscreen->getCanvas());
619
620 // Fake a redraw to replay the draw commands. This will increment the alpha channel
621 // each time a pixel would have been drawn.
622 // Pass true for opaque so we skip the clear - the overdrawCanvas is already zero
623 // initialized.
Nathaniel Nifongdc19a652019-11-11 11:47:50 -0500624 renderFrameImpl(clip, nodes, true, contentDrawBounds, &overdrawCanvas, preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -0500625 sk_sp<SkImage> counts = offscreen->makeImageSnapshot();
626
627 // Draw overdraw colors to the canvas. The color filter will convert counts to colors.
628 SkPaint paint;
629 const SkPMColor* colors = kOverdrawColors[static_cast<int>(Properties::overdrawColorSet)];
630 paint.setColorFilter(SkOverdrawColorFilter::Make(colors));
631 surface->getCanvas()->drawImage(counts.get(), 0.0f, 0.0f, &paint);
632}
633
Stan Iliev500a0c32016-10-26 10:30:09 -0400634} /* namespace skiapipeline */
635} /* namespace uirenderer */
636} /* namespace android */