Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 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 | #ifndef TEST_UTILS_H |
| 17 | #define TEST_UTILS_H |
| 18 | |
Chris Craik | 76caecf | 2015-11-02 19:17:45 -0800 | [diff] [blame] | 19 | #include <DeviceInfo.h> |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 20 | #include <DisplayList.h> |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 21 | #include <Matrix.h> |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 22 | #include <Rect.h> |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 23 | #include <RenderNode.h> |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 24 | #include <renderstate/RenderState.h> |
| 25 | #include <renderthread/RenderThread.h> |
| 26 | #include <Snapshot.h> |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 27 | |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 28 | #if HWUI_NEW_OPS |
| 29 | #include <RecordedOp.h> |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 30 | #include <RecordingCanvas.h> |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 31 | #else |
| 32 | #include <DisplayListOp.h> |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 33 | #include <DisplayListCanvas.h> |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 34 | #endif |
| 35 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 36 | #include <memory> |
| 37 | |
| 38 | namespace android { |
| 39 | namespace uirenderer { |
| 40 | |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 41 | #if HWUI_NEW_OPS |
| 42 | typedef RecordingCanvas TestCanvas; |
| 43 | #else |
| 44 | typedef DisplayListCanvas TestCanvas; |
| 45 | #endif |
| 46 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 47 | #define EXPECT_MATRIX_APPROX_EQ(a, b) \ |
| 48 | EXPECT_TRUE(TestUtils::matricesAreApproxEqual(a, b)) |
| 49 | |
Chris Craik | 6fe991e5 | 2015-10-20 09:39:42 -0700 | [diff] [blame] | 50 | #define EXPECT_RECT_APPROX_EQ(a, b) \ |
Chih-Hung Hsieh | 474081e | 2016-08-26 15:19:47 -0700 | [diff] [blame] | 51 | EXPECT_TRUE(MathUtils::areEqual((a).left, (b).left) \ |
| 52 | && MathUtils::areEqual((a).top, (b).top) \ |
| 53 | && MathUtils::areEqual((a).right, (b).right) \ |
| 54 | && MathUtils::areEqual((a).bottom, (b).bottom)); |
Chris Craik | 6fe991e5 | 2015-10-20 09:39:42 -0700 | [diff] [blame] | 55 | |
Chris Craik | 7435eb1 | 2016-01-07 17:41:40 -0800 | [diff] [blame] | 56 | #define EXPECT_CLIP_RECT(expRect, clipStatePtr) \ |
| 57 | EXPECT_NE(nullptr, (clipStatePtr)) << "Op is unclipped"; \ |
| 58 | if ((clipStatePtr)->mode == ClipMode::Rectangle) { \ |
| 59 | EXPECT_EQ((expRect), reinterpret_cast<const ClipRect*>(clipStatePtr)->rect); \ |
| 60 | } else { \ |
| 61 | ADD_FAILURE() << "ClipState not a rect"; \ |
| 62 | } |
Chris Craik | 98787e6 | 2015-11-13 10:55:30 -0800 | [diff] [blame] | 63 | /** |
| 64 | * Like gtest's TEST, but runs on the RenderThread, and 'renderThread' is passed, in top level scope |
| 65 | * (for e.g. accessing its RenderState) |
| 66 | */ |
| 67 | #define RENDERTHREAD_TEST(test_case_name, test_name) \ |
| 68 | class test_case_name##_##test_name##_RenderThreadTest { \ |
| 69 | public: \ |
| 70 | static void doTheThing(renderthread::RenderThread& renderThread); \ |
| 71 | }; \ |
| 72 | TEST(test_case_name, test_name) { \ |
| 73 | TestUtils::runOnRenderThread(test_case_name##_##test_name##_RenderThreadTest::doTheThing); \ |
| 74 | }; \ |
| 75 | void test_case_name##_##test_name##_RenderThreadTest::doTheThing(renderthread::RenderThread& renderThread) |
| 76 | |
Chris Craik | 3741328 | 2016-05-12 17:48:51 -0700 | [diff] [blame] | 77 | /** |
| 78 | * Sets a property value temporarily, generally for the duration of a test, restoring the previous |
| 79 | * value when going out of scope. |
| 80 | * |
| 81 | * Can be used e.g. to test behavior only active while Properties::debugOverdraw is enabled. |
| 82 | */ |
| 83 | template <typename T> |
| 84 | class ScopedProperty { |
| 85 | public: |
| 86 | ScopedProperty(T& property, T newValue) |
| 87 | : mPropertyPtr(&property) |
| 88 | , mOldValue(property) { |
| 89 | property = newValue; |
| 90 | } |
| 91 | ~ScopedProperty() { |
| 92 | *mPropertyPtr = mOldValue; |
| 93 | } |
| 94 | private: |
| 95 | T* mPropertyPtr; |
| 96 | T mOldValue; |
| 97 | }; |
| 98 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 99 | class TestUtils { |
| 100 | public: |
Chris Craik | 76ace11 | 2015-10-29 12:46:19 -0700 | [diff] [blame] | 101 | class SignalingDtor { |
| 102 | public: |
| 103 | SignalingDtor() |
| 104 | : mSignal(nullptr) {} |
Chih-Hung Hsieh | a619ec7 | 2016-08-29 14:52:43 -0700 | [diff] [blame] | 105 | explicit SignalingDtor(int* signal) |
Chris Craik | 76ace11 | 2015-10-29 12:46:19 -0700 | [diff] [blame] | 106 | : mSignal(signal) {} |
| 107 | void setSignal(int* signal) { |
| 108 | mSignal = signal; |
| 109 | } |
| 110 | ~SignalingDtor() { |
| 111 | if (mSignal) { |
| 112 | (*mSignal)++; |
| 113 | } |
| 114 | } |
| 115 | private: |
| 116 | int* mSignal; |
| 117 | }; |
| 118 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 119 | static bool matricesAreApproxEqual(const Matrix4& a, const Matrix4& b) { |
| 120 | for (int i = 0; i < 16; i++) { |
| 121 | if (!MathUtils::areEqual(a[i], b[i])) { |
| 122 | return false; |
| 123 | } |
| 124 | } |
| 125 | return true; |
| 126 | } |
| 127 | |
| 128 | static std::unique_ptr<Snapshot> makeSnapshot(const Matrix4& transform, const Rect& clip) { |
| 129 | std::unique_ptr<Snapshot> snapshot(new Snapshot()); |
Chris Craik | a2a7072 | 2015-12-17 12:58:24 -0800 | [diff] [blame] | 130 | snapshot->clip(clip, SkRegion::kReplace_Op); // store clip first, so it isn't transformed |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 131 | *(snapshot->transform) = transform; |
| 132 | return snapshot; |
| 133 | } |
| 134 | |
Chris Craik | 15c3f19 | 2015-12-03 12:16:56 -0800 | [diff] [blame] | 135 | static SkBitmap createSkBitmap(int width, int height, |
| 136 | SkColorType colorType = kN32_SkColorType) { |
Chris Craik | ddf2215 | 2015-10-14 17:42:47 -0700 | [diff] [blame] | 137 | SkBitmap bitmap; |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 138 | SkImageInfo info = SkImageInfo::Make(width, height, |
Chris Craik | 15c3f19 | 2015-12-03 12:16:56 -0800 | [diff] [blame] | 139 | colorType, kPremul_SkAlphaType); |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 140 | bitmap.setInfo(info); |
| 141 | bitmap.allocPixels(info); |
Chris Craik | ddf2215 | 2015-10-14 17:42:47 -0700 | [diff] [blame] | 142 | return bitmap; |
| 143 | } |
| 144 | |
Chris Craik | d2dfd8f | 2015-12-16 14:27:20 -0800 | [diff] [blame] | 145 | static sp<DeferredLayerUpdater> createTextureLayerUpdater( |
| 146 | renderthread::RenderThread& renderThread, uint32_t width, uint32_t height, |
Chris Craik | 243e85b | 2016-03-25 15:26:11 -0700 | [diff] [blame] | 147 | const SkMatrix& transform); |
Chris Craik | d2dfd8f | 2015-12-16 14:27:20 -0800 | [diff] [blame] | 148 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 149 | template<class CanvasType> |
Chris Craik | 003cc3d | 2015-10-16 10:24:55 -0700 | [diff] [blame] | 150 | static std::unique_ptr<DisplayList> createDisplayList(int width, int height, |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 151 | std::function<void(CanvasType& canvas)> canvasCallback) { |
| 152 | CanvasType canvas(width, height); |
| 153 | canvasCallback(canvas); |
Chris Craik | 003cc3d | 2015-10-16 10:24:55 -0700 | [diff] [blame] | 154 | return std::unique_ptr<DisplayList>(canvas.finishRecording()); |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 155 | } |
| 156 | |
Chris Craik | d3daa31 | 2015-11-06 10:59:56 -0800 | [diff] [blame] | 157 | static sp<RenderNode> createNode(int left, int top, int right, int bottom, |
Chris Craik | 8d1f212 | 2015-11-24 16:40:09 -0800 | [diff] [blame] | 158 | std::function<void(RenderProperties& props, TestCanvas& canvas)> setup) { |
Chris Craik | 9fded23 | 2015-11-11 16:42:34 -0800 | [diff] [blame] | 159 | #if HWUI_NULL_GPU |
Chris Craik | 76caecf | 2015-11-02 19:17:45 -0800 | [diff] [blame] | 160 | // if RenderNodes are being sync'd/used, device info will be needed, since |
| 161 | // DeviceInfo::maxTextureSize() affects layer property |
| 162 | DeviceInfo::initialize(); |
Chris Craik | 9fded23 | 2015-11-11 16:42:34 -0800 | [diff] [blame] | 163 | #endif |
Chris Craik | 76caecf | 2015-11-02 19:17:45 -0800 | [diff] [blame] | 164 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 165 | sp<RenderNode> node = new RenderNode(); |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 166 | RenderProperties& props = node->mutateStagingProperties(); |
| 167 | props.setLeftTopRightBottom(left, top, right, bottom); |
| 168 | if (setup) { |
| 169 | TestCanvas canvas(props.getWidth(), props.getHeight()); |
| 170 | setup(props, canvas); |
John Reck | 51f2d60 | 2016-04-06 07:50:47 -0700 | [diff] [blame] | 171 | node->setStagingDisplayList(canvas.finishRecording(), nullptr); |
Chris Craik | 0b7e824 | 2015-10-28 16:50:44 -0700 | [diff] [blame] | 172 | } |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 173 | node->setPropertyFieldsDirty(0xFFFFFFFF); |
Chris Craik | 0b7e824 | 2015-10-28 16:50:44 -0700 | [diff] [blame] | 174 | return node; |
| 175 | } |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 176 | |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 177 | static void recordNode(RenderNode& node, |
| 178 | std::function<void(TestCanvas&)> contentCallback) { |
| 179 | TestCanvas canvas(node.stagingProperties().getWidth(), |
| 180 | node.stagingProperties().getHeight()); |
| 181 | contentCallback(canvas); |
John Reck | 51f2d60 | 2016-04-06 07:50:47 -0700 | [diff] [blame] | 182 | node.setStagingDisplayList(canvas.finishRecording(), nullptr); |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 183 | } |
| 184 | |
Chris Craik | 8d1f212 | 2015-11-24 16:40:09 -0800 | [diff] [blame] | 185 | /** |
| 186 | * Forces a sync of a tree of RenderNode, such that every descendant will have its staging |
| 187 | * properties and DisplayList moved to the render copies. |
| 188 | * |
| 189 | * Note: does not check dirtiness bits, so any non-staging DisplayLists will be discarded. |
| 190 | * For this reason, this should generally only be called once on a tree. |
| 191 | */ |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 192 | static void syncHierarchyPropertiesAndDisplayList(sp<RenderNode>& node) { |
| 193 | syncHierarchyPropertiesAndDisplayListImpl(node.get()); |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 194 | } |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 195 | |
Chris Craik | 9cd1bbe | 2016-04-14 16:08:25 -0700 | [diff] [blame] | 196 | static sp<RenderNode>& getSyncedNode(sp<RenderNode>& node) { |
| 197 | syncHierarchyPropertiesAndDisplayList(node); |
| 198 | return node; |
John Reck | 7db5ffb | 2016-01-15 13:17:09 -0800 | [diff] [blame] | 199 | } |
| 200 | |
Chris Craik | 0b7e824 | 2015-10-28 16:50:44 -0700 | [diff] [blame] | 201 | typedef std::function<void(renderthread::RenderThread& thread)> RtCallback; |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 202 | |
| 203 | class TestTask : public renderthread::RenderTask { |
| 204 | public: |
Chih-Hung Hsieh | a619ec7 | 2016-08-29 14:52:43 -0700 | [diff] [blame] | 205 | explicit TestTask(RtCallback rtCallback) |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 206 | : rtCallback(rtCallback) {} |
| 207 | virtual ~TestTask() {} |
John Reck | e5da4ef | 2016-01-14 12:34:46 -0800 | [diff] [blame] | 208 | virtual void run() override; |
Chris Craik | 0a24b14 | 2015-10-19 17:10:19 -0700 | [diff] [blame] | 209 | RtCallback rtCallback; |
| 210 | }; |
| 211 | |
| 212 | /** |
| 213 | * NOTE: requires surfaceflinger to run, otherwise this method will wait indefinitely. |
| 214 | */ |
| 215 | static void runOnRenderThread(RtCallback rtCallback) { |
| 216 | TestTask task(rtCallback); |
| 217 | renderthread::RenderThread::getInstance().queueAndWait(&task); |
| 218 | } |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 219 | |
John Reck | 38e0c32 | 2015-11-10 12:19:17 -0800 | [diff] [blame] | 220 | static bool isRenderThreadRunning() { |
| 221 | return renderthread::RenderThread::hasInstance(); |
| 222 | } |
| 223 | |
John Reck | 16c9d6a | 2015-11-17 15:51:08 -0800 | [diff] [blame] | 224 | static SkColor interpolateColor(float fraction, SkColor start, SkColor end); |
| 225 | |
Chris Craik | e8c3c81 | 2016-02-05 20:10:50 -0800 | [diff] [blame] | 226 | static void layoutTextUnscaled(const SkPaint& paint, const char* text, |
| 227 | std::vector<glyph_t>* outGlyphs, std::vector<float>* outPositions, |
| 228 | float* outTotalAdvance, Rect* outBounds); |
| 229 | |
Derek Sollenberger | 79abbf2 | 2016-03-24 11:07:19 -0400 | [diff] [blame] | 230 | static void drawUtf8ToCanvas(Canvas* canvas, const char* text, |
Chris Craik | 42a5407 | 2015-11-24 11:41:54 -0800 | [diff] [blame] | 231 | const SkPaint& paint, float x, float y); |
Chris Craik | a171727 | 2015-11-19 13:02:43 -0800 | [diff] [blame] | 232 | |
Derek Sollenberger | 79abbf2 | 2016-03-24 11:07:19 -0400 | [diff] [blame] | 233 | static void drawUtf8ToCanvas(Canvas* canvas, const char* text, |
Chris Craik | d7448e6 | 2015-12-15 10:34:36 -0800 | [diff] [blame] | 234 | const SkPaint& paint, const SkPath& path); |
| 235 | |
Derek Sollenberger | 79abbf2 | 2016-03-24 11:07:19 -0400 | [diff] [blame] | 236 | static std::unique_ptr<uint16_t[]> asciiToUtf16(const char* str); |
sergeyv | dccca44 | 2016-03-21 15:38:21 -0700 | [diff] [blame] | 237 | |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 238 | private: |
| 239 | static void syncHierarchyPropertiesAndDisplayListImpl(RenderNode* node) { |
| 240 | node->syncProperties(); |
John Reck | 44b49f0 | 2016-03-25 14:29:48 -0700 | [diff] [blame] | 241 | node->syncDisplayList(nullptr); |
Chris Craik | 161f54b | 2015-11-05 11:08:52 -0800 | [diff] [blame] | 242 | auto displayList = node->getDisplayList(); |
| 243 | if (displayList) { |
| 244 | for (auto&& childOp : displayList->getChildren()) { |
| 245 | syncHierarchyPropertiesAndDisplayListImpl(childOp->renderNode); |
| 246 | } |
| 247 | } |
| 248 | } |
| 249 | |
Chris Craik | b565df1 | 2015-10-05 13:00:52 -0700 | [diff] [blame] | 250 | }; // class TestUtils |
| 251 | |
| 252 | } /* namespace uirenderer */ |
| 253 | } /* namespace android */ |
| 254 | |
| 255 | #endif /* TEST_UTILS_H */ |