blob: bc8a5659dd83cbaae902335645db107283f5771b [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#pragma once
18
Stan Iliev500a0c32016-10-26 10:30:09 -040019#include <SkSurface.h>
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040020#include <SkDocument.h>
21#include <SkMultiPictureDocument.h>
John Reckd9d7f122018-05-03 14:40:56 -070022#include "Lighting.h"
Derek Sollenberger2d142132018-01-22 10:25:26 -050023#include "hwui/AnimatedImageDrawable.h"
John Reck1bcacfd2017-11-03 10:12:19 -070024#include "renderthread/CanvasContext.h"
25#include "renderthread/IRenderPipeline.h"
Stan Iliev500a0c32016-10-26 10:30:09 -040026
Stan Ilieve9d00122017-09-19 12:07:10 -040027class SkPictureRecorder;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040028struct SkSharingSerialContext;
Stan Ilieve9d00122017-09-19 12:07:10 -040029
Stan Iliev500a0c32016-10-26 10:30:09 -040030namespace android {
31namespace uirenderer {
32namespace skiapipeline {
33
34class SkiaPipeline : public renderthread::IRenderPipeline {
35public:
Chih-Hung Hsiehf9336412018-12-20 13:48:57 -080036 explicit SkiaPipeline(renderthread::RenderThread& thread);
Stan Iliev232f3622017-08-23 17:15:09 -040037 virtual ~SkiaPipeline();
Stan Iliev500a0c32016-10-26 10:30:09 -040038
Stan Iliev500a0c32016-10-26 10:30:09 -040039 void onDestroyHardwareResources() override;
40
Derek Sollenbergerb7d34b62016-11-04 10:46:18 -040041 bool pinImages(std::vector<SkImage*>& mutableImages) override;
42 bool pinImages(LsaVector<sk_sp<Bitmap>>& images) override { return false; }
43 void unpinImages() override;
44
Peiyong Lin1f6aa122018-09-10 16:28:08 -070045 void renderLayers(const LightGeometry& lightGeometry, LayerUpdateQueue* layerUpdateQueue,
46 bool opaque, const LightInfo& lightInfo) override;
Stan Iliev500a0c32016-10-26 10:30:09 -040047
Nathaniel Nifong2945bff2019-11-25 09:34:21 -050048 // If the given node didn't have a layer surface, or had one of the wrong size, this method
49 // creates a new one and returns true. Otherwise does nothing and returns false.
John Reck1bcacfd2017-11-03 10:12:19 -070050 bool createOrUpdateLayer(RenderNode* node, const DamageAccumulator& damageAccumulator,
Peiyong Lin1f6aa122018-09-10 16:28:08 -070051 ErrorHandler* errorHandler) override;
Stan Iliev500a0c32016-10-26 10:30:09 -040052
John Reckb36bfdd2020-07-23 13:47:49 -070053 void setSurfaceColorProperties(ColorMode colorMode) override;
Derek Sollenberger25833d22019-01-14 13:55:55 -050054 SkColorType getSurfaceColorType() const override { return mSurfaceColorType; }
Peiyong Lin189021b2018-09-27 16:41:40 -070055 sk_sp<SkColorSpace> getSurfaceColorSpace() override { return mSurfaceColorSpace; }
56
Stan Iliev500a0c32016-10-26 10:30:09 -040057 void renderFrame(const LayerUpdateQueue& layers, const SkRect& clip,
Peiyong Lin1f6aa122018-09-10 16:28:08 -070058 const std::vector<sp<RenderNode>>& nodes, bool opaque,
Greg Danielc4076782019-01-08 16:01:18 -050059 const Rect& contentDrawBounds, sk_sp<SkSurface> surface,
60 const SkMatrix& preTransform);
Stan Iliev500a0c32016-10-26 10:30:09 -040061
Stan Iliev500a0c32016-10-26 10:30:09 -040062 static void prepareToDraw(const renderthread::RenderThread& thread, Bitmap* bitmap);
63
Peiyong Lin1f6aa122018-09-10 16:28:08 -070064 void renderLayersImpl(const LayerUpdateQueue& layers, bool opaque);
Stan Iliev500a0c32016-10-26 10:30:09 -040065
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040066 // Sets the recording callback to the provided function and the recording mode
67 // to CallbackAPI
John Reck5cca8f22018-12-10 17:06:22 -080068 void setPictureCapturedCallback(
69 const std::function<void(sk_sp<SkPicture>&&)>& callback) override {
70 mPictureCapturedCallback = callback;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040071 mCaptureMode = callback ? CaptureMode::CallbackAPI : CaptureMode::None;
John Reck5cca8f22018-12-10 17:06:22 -080072 }
73
Stan Iliev500a0c32016-10-26 10:30:09 -040074protected:
Matt Sarett4bda6bf2016-11-07 15:43:41 -050075 void dumpResourceCacheUsage() const;
76
Stan Iliev500a0c32016-10-26 10:30:09 -040077 renderthread::RenderThread& mRenderThread;
Derek Sollenberger1863d942020-02-05 15:41:51 -050078
John Reckb36bfdd2020-07-23 13:47:49 -070079 ColorMode mColorMode = ColorMode::Default;
Peiyong Lin189021b2018-09-27 16:41:40 -070080 SkColorType mSurfaceColorType;
81 sk_sp<SkColorSpace> mSurfaceColorSpace;
Stan Iliev500a0c32016-10-26 10:30:09 -040082
John Reck76005182021-06-09 22:43:05 -040083 bool isCapturingSkp() const { return mCaptureMode != CaptureMode::None; }
84
Stan Iliev500a0c32016-10-26 10:30:09 -040085private:
Nathaniel Nifongdc19a652019-11-11 11:47:50 -050086 void renderFrameImpl(const SkRect& clip,
Peiyong Lin1f6aa122018-09-10 16:28:08 -070087 const std::vector<sp<RenderNode>>& nodes, bool opaque,
Greg Danielc4076782019-01-08 16:01:18 -050088 const Rect& contentDrawBounds, SkCanvas* canvas,
89 const SkMatrix& preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -050090
91 /**
92 * Debugging feature. Draws a semi-transparent overlay on each pixel, indicating
93 * how many times it has been drawn.
94 */
Nathaniel Nifongdc19a652019-11-11 11:47:50 -050095 void renderOverdraw(const SkRect& clip,
John Reck1bcacfd2017-11-03 10:12:19 -070096 const std::vector<sp<RenderNode>>& nodes, const Rect& contentDrawBounds,
Greg Danielc4076782019-01-08 16:01:18 -050097 sk_sp<SkSurface> surface, const SkMatrix& preTransform);
Matt Sarettf58cc922016-11-14 18:33:38 -050098
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -040099 // Called every frame. Normally returns early with screen canvas.
100 // But when capture is enabled, returns an nwaycanvas where commands are also recorded.
Nathaniel Nifong2945bff2019-11-25 09:34:21 -0500101 SkCanvas* tryCapture(SkSurface* surface, RenderNode* root, const LayerUpdateQueue& dirtyLayers);
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400102 // Called at the end of every frame, closes the recording if necessary.
Stan Ilieve9d00122017-09-19 12:07:10 -0400103 void endCapture(SkSurface* surface);
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400104 // Determine if a new file-based capture should be started.
105 // If so, sets mCapturedFile and mCaptureSequence and returns true.
106 // Should be called every frame when capture is enabled.
107 // sets mCaptureMode.
108 bool shouldStartNewFileCapture();
109 // Set up a multi frame capture.
110 bool setupMultiFrameCapture();
Stan Ilieve9d00122017-09-19 12:07:10 -0400111
Derek Sollenbergerb7d34b62016-11-04 10:46:18 -0400112 std::vector<sk_sp<SkImage>> mPinnedImages;
Stan Iliev23c38a92017-03-23 00:12:50 -0400113
Stan Ilieve9d00122017-09-19 12:07:10 -0400114 // Block of properties used only for debugging to record a SkPicture and save it in a file.
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400115 // There are three possible ways of recording drawing commands.
116 enum class CaptureMode {
117 // return to this mode when capture stops.
118 None,
119 // A mode where every frame is recorded into an SkPicture and sent to a provided callback,
120 // until that callback is cleared
121 CallbackAPI,
122 // A mode where a finite number of frames are recorded to a file with
123 // SkMultiPictureDocument
124 MultiFrameSKP,
125 // A mode which records a single frame to a normal SKP file.
126 SingleFrameSKP,
127 };
128 CaptureMode mCaptureMode = CaptureMode::None;
129
Stan Ilieve9d00122017-09-19 12:07:10 -0400130 /**
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400131 * mCapturedFile - the filename to write a recorded SKP to in either MultiFrameSKP or
132 * SingleFrameSKP mode.
Stan Ilieve9d00122017-09-19 12:07:10 -0400133 */
134 std::string mCapturedFile;
135 /**
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400136 * mCaptureSequence counts down how many frames are left to take in the sequence. Applicable
137 * only to MultiFrameSKP or SingleFrameSKP mode.
Stan Ilieve9d00122017-09-19 12:07:10 -0400138 */
139 int mCaptureSequence = 0;
John Reck322b8ab2019-03-14 13:15:28 -0700140
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400141 // Multi frame serialization stream and writer used when serializing more than one frame.
Ady Abrahamb1547922021-05-10 21:20:25 -0700142 std::unique_ptr<SkSharingSerialContext> mSerialContext; // Must be declared before any other
143 // serializing member
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400144 std::unique_ptr<SkFILEWStream> mOpenMultiPicStream;
145 sk_sp<SkDocument> mMultiPic;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400146
Stan Ilieve9d00122017-09-19 12:07:10 -0400147 /**
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400148 * mRecorder holds the current picture recorder when serializing in either SingleFrameSKP or
149 * CallbackAPI modes.
Stan Ilieve9d00122017-09-19 12:07:10 -0400150 */
151 std::unique_ptr<SkPictureRecorder> mRecorder;
John Reck5cca8f22018-12-10 17:06:22 -0800152 std::unique_ptr<SkNWayCanvas> mNwayCanvas;
Nathaniel Nifongd2e49a22019-06-24 15:07:34 -0400153
154 // Set by setPictureCapturedCallback and when set, CallbackAPI mode recording is ongoing.
155 // Not used in other recording modes.
John Reck5cca8f22018-12-10 17:06:22 -0800156 std::function<void(sk_sp<SkPicture>&&)> mPictureCapturedCallback;
Stan Iliev500a0c32016-10-26 10:30:09 -0400157};
158
159} /* namespace skiapipeline */
160} /* namespace uirenderer */
161} /* namespace android */