| /* |
| * Copyright (C) 2015 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| #pragma once |
| |
| #include <DeviceInfo.h> |
| #include <DisplayList.h> |
| #include <Matrix.h> |
| #include <Properties.h> |
| #include <Rect.h> |
| #include <RenderNode.h> |
| #include <Snapshot.h> |
| #include <hwui/Bitmap.h> |
| #include <pipeline/skia/SkiaRecordingCanvas.h> |
| #include <renderstate/RenderState.h> |
| #include <renderthread/RenderThread.h> |
| |
| #include <RecordedOp.h> |
| #include <RecordingCanvas.h> |
| |
| #include <memory> |
| |
| namespace android { |
| namespace uirenderer { |
| |
| #define EXPECT_MATRIX_APPROX_EQ(a, b) EXPECT_TRUE(TestUtils::matricesAreApproxEqual(a, b)) |
| |
| #define EXPECT_RECT_APPROX_EQ(a, b) \ |
| EXPECT_TRUE(MathUtils::areEqual((a).left, (b).left) && \ |
| MathUtils::areEqual((a).top, (b).top) && \ |
| MathUtils::areEqual((a).right, (b).right) && \ |
| MathUtils::areEqual((a).bottom, (b).bottom)); |
| |
| #define EXPECT_CLIP_RECT(expRect, clipStatePtr) \ |
| EXPECT_NE(nullptr, (clipStatePtr)) << "Op is unclipped"; \ |
| if ((clipStatePtr)->mode == ClipMode::Rectangle) { \ |
| EXPECT_EQ((expRect), reinterpret_cast<const ClipRect*>(clipStatePtr)->rect); \ |
| } else { \ |
| ADD_FAILURE() << "ClipState not a rect"; \ |
| } |
| |
| #define INNER_PIPELINE_TEST(test_case_name, test_name, pipeline, functionCall) \ |
| TEST(test_case_name, test_name##_##pipeline) { \ |
| RenderPipelineType oldType = Properties::getRenderPipelineType(); \ |
| Properties::overrideRenderPipelineType(RenderPipelineType::pipeline); \ |
| functionCall; \ |
| Properties::overrideRenderPipelineType(oldType); \ |
| }; |
| |
| #define INNER_PIPELINE_RENDERTHREAD_TEST(test_case_name, test_name, pipeline) \ |
| INNER_PIPELINE_TEST(test_case_name, test_name, pipeline, \ |
| TestUtils::runOnRenderThread( \ |
| test_case_name##_##test_name##_RenderThreadTest::doTheThing)) |
| |
| /** |
| * Like gtest's TEST, but runs on the RenderThread, and 'renderThread' is passed, in top level scope |
| * (for e.g. accessing its RenderState) |
| */ |
| #define RENDERTHREAD_TEST(test_case_name, test_name) \ |
| class test_case_name##_##test_name##_RenderThreadTest { \ |
| public: \ |
| static void doTheThing(renderthread::RenderThread& renderThread); \ |
| }; \ |
| INNER_PIPELINE_RENDERTHREAD_TEST(test_case_name, test_name, SkiaGL); \ |
| /* Temporarily disabling Vulkan until we can figure out a way to stub out the driver */ \ |
| /* INNER_PIPELINE_RENDERTHREAD_TEST(test_case_name, test_name, SkiaVulkan); */ \ |
| void test_case_name##_##test_name##_RenderThreadTest::doTheThing( \ |
| renderthread::RenderThread& renderThread) |
| |
| /** |
| * Like RENDERTHREAD_TEST, but only runs with the Skia RenderPipelineTypes |
| */ |
| #define RENDERTHREAD_SKIA_PIPELINE_TEST(test_case_name, test_name) \ |
| class test_case_name##_##test_name##_RenderThreadTest { \ |
| public: \ |
| static void doTheThing(renderthread::RenderThread& renderThread); \ |
| }; \ |
| INNER_PIPELINE_RENDERTHREAD_TEST(test_case_name, test_name, SkiaGL); \ |
| /* Temporarily disabling Vulkan until we can figure out a way to stub out the driver */ \ |
| /* INNER_PIPELINE_RENDERTHREAD_TEST(test_case_name, test_name, SkiaVulkan); */ \ |
| void test_case_name##_##test_name##_RenderThreadTest::doTheThing( \ |
| renderthread::RenderThread& renderThread) |
| |
| /** |
| * Sets a property value temporarily, generally for the duration of a test, restoring the previous |
| * value when going out of scope. |
| * |
| * Can be used e.g. to test behavior only active while Properties::debugOverdraw is enabled. |
| */ |
| template <typename T> |
| class ScopedProperty { |
| public: |
| ScopedProperty(T& property, T newValue) : mPropertyPtr(&property), mOldValue(property) { |
| property = newValue; |
| } |
| ~ScopedProperty() { *mPropertyPtr = mOldValue; } |
| |
| private: |
| T* mPropertyPtr; |
| T mOldValue; |
| }; |
| |
| class TestUtils { |
| public: |
| class SignalingDtor { |
| public: |
| SignalingDtor() : mSignal(nullptr) {} |
| explicit SignalingDtor(int* signal) : mSignal(signal) {} |
| void setSignal(int* signal) { mSignal = signal; } |
| ~SignalingDtor() { |
| if (mSignal) { |
| (*mSignal)++; |
| } |
| } |
| |
| private: |
| int* mSignal; |
| }; |
| |
| class MockTreeObserver : public TreeObserver { |
| public: |
| virtual void onMaybeRemovedFromTree(RenderNode* node) {} |
| }; |
| |
| static bool matricesAreApproxEqual(const Matrix4& a, const Matrix4& b) { |
| for (int i = 0; i < 16; i++) { |
| if (!MathUtils::areEqual(a[i], b[i])) { |
| return false; |
| } |
| } |
| return true; |
| } |
| |
| static std::unique_ptr<Snapshot> makeSnapshot(const Matrix4& transform, const Rect& clip) { |
| std::unique_ptr<Snapshot> snapshot(new Snapshot()); |
| // store clip first, so it isn't transformed |
| snapshot->setClip(clip.left, clip.top, clip.right, clip.bottom); |
| *(snapshot->transform) = transform; |
| return snapshot; |
| } |
| |
| static sk_sp<Bitmap> createBitmap(int width, int height, |
| SkColorType colorType = kN32_SkColorType) { |
| SkImageInfo info = SkImageInfo::Make(width, height, colorType, kPremul_SkAlphaType); |
| return Bitmap::allocateHeapBitmap(info); |
| } |
| |
| static sk_sp<Bitmap> createBitmap(int width, int height, SkBitmap* outBitmap) { |
| SkImageInfo info = SkImageInfo::Make(width, height, kN32_SkColorType, kPremul_SkAlphaType); |
| outBitmap->setInfo(info); |
| return Bitmap::allocateHeapBitmap(outBitmap); |
| } |
| |
| static sp<DeferredLayerUpdater> createTextureLayerUpdater( |
| renderthread::RenderThread& renderThread); |
| |
| static sp<DeferredLayerUpdater> createTextureLayerUpdater( |
| renderthread::RenderThread& renderThread, uint32_t width, uint32_t height, |
| const SkMatrix& transform); |
| |
| template <class CanvasType> |
| static std::unique_ptr<DisplayList> createDisplayList( |
| int width, int height, std::function<void(CanvasType& canvas)> canvasCallback) { |
| CanvasType canvas(width, height); |
| canvasCallback(canvas); |
| return std::unique_ptr<DisplayList>(canvas.finishRecording()); |
| } |
| |
| static sp<RenderNode> createNode( |
| int left, int top, int right, int bottom, |
| std::function<void(RenderProperties& props, Canvas& canvas)> setup) { |
| #if HWUI_NULL_GPU |
| // if RenderNodes are being sync'd/used, device info will be needed, since |
| // DeviceInfo::maxTextureSize() affects layer property |
| DeviceInfo::initialize(); |
| #endif |
| |
| sp<RenderNode> node = new RenderNode(); |
| RenderProperties& props = node->mutateStagingProperties(); |
| props.setLeftTopRightBottom(left, top, right, bottom); |
| if (setup) { |
| std::unique_ptr<Canvas> canvas( |
| Canvas::create_recording_canvas(props.getWidth(), props.getHeight())); |
| setup(props, *canvas.get()); |
| node->setStagingDisplayList(canvas->finishRecording()); |
| } |
| node->setPropertyFieldsDirty(0xFFFFFFFF); |
| return node; |
| } |
| |
| template <class RecordingCanvasType> |
| static sp<RenderNode> createNode( |
| int left, int top, int right, int bottom, |
| std::function<void(RenderProperties& props, RecordingCanvasType& canvas)> setup) { |
| #if HWUI_NULL_GPU |
| // if RenderNodes are being sync'd/used, device info will be needed, since |
| // DeviceInfo::maxTextureSize() affects layer property |
| DeviceInfo::initialize(); |
| #endif |
| |
| sp<RenderNode> node = new RenderNode(); |
| RenderProperties& props = node->mutateStagingProperties(); |
| props.setLeftTopRightBottom(left, top, right, bottom); |
| if (setup) { |
| RecordingCanvasType canvas(props.getWidth(), props.getHeight()); |
| setup(props, canvas); |
| node->setStagingDisplayList(canvas.finishRecording()); |
| } |
| node->setPropertyFieldsDirty(0xFFFFFFFF); |
| return node; |
| } |
| |
| static void recordNode(RenderNode& node, std::function<void(Canvas&)> contentCallback) { |
| std::unique_ptr<Canvas> canvas(Canvas::create_recording_canvas( |
| node.stagingProperties().getWidth(), node.stagingProperties().getHeight())); |
| contentCallback(*canvas.get()); |
| node.setStagingDisplayList(canvas->finishRecording()); |
| } |
| |
| static sp<RenderNode> createSkiaNode( |
| int left, int top, int right, int bottom, |
| std::function<void(RenderProperties& props, skiapipeline::SkiaRecordingCanvas& canvas)> |
| setup, |
| const char* name = nullptr, skiapipeline::SkiaDisplayList* displayList = nullptr) { |
| #if HWUI_NULL_GPU |
| // if RenderNodes are being sync'd/used, device info will be needed, since |
| // DeviceInfo::maxTextureSize() affects layer property |
| DeviceInfo::initialize(); |
| #endif |
| sp<RenderNode> node = new RenderNode(); |
| if (name) { |
| node->setName(name); |
| } |
| RenderProperties& props = node->mutateStagingProperties(); |
| props.setLeftTopRightBottom(left, top, right, bottom); |
| if (displayList) { |
| node->setStagingDisplayList(displayList); |
| } |
| if (setup) { |
| std::unique_ptr<skiapipeline::SkiaRecordingCanvas> canvas( |
| new skiapipeline::SkiaRecordingCanvas(nullptr, props.getWidth(), |
| props.getHeight())); |
| setup(props, *canvas.get()); |
| node->setStagingDisplayList(canvas->finishRecording()); |
| } |
| node->setPropertyFieldsDirty(0xFFFFFFFF); |
| TestUtils::syncHierarchyPropertiesAndDisplayList(node); |
| return node; |
| } |
| |
| /** |
| * Forces a sync of a tree of RenderNode, such that every descendant will have its staging |
| * properties and DisplayList moved to the render copies. |
| * |
| * Note: does not check dirtiness bits, so any non-staging DisplayLists will be discarded. |
| * For this reason, this should generally only be called once on a tree. |
| */ |
| static void syncHierarchyPropertiesAndDisplayList(sp<RenderNode>& node) { |
| syncHierarchyPropertiesAndDisplayListImpl(node.get()); |
| } |
| |
| static sp<RenderNode>& getSyncedNode(sp<RenderNode>& node) { |
| syncHierarchyPropertiesAndDisplayList(node); |
| return node; |
| } |
| |
| typedef std::function<void(renderthread::RenderThread& thread)> RtCallback; |
| |
| class TestTask : public renderthread::RenderTask { |
| public: |
| explicit TestTask(RtCallback rtCallback) : rtCallback(rtCallback) {} |
| virtual ~TestTask() {} |
| virtual void run() override; |
| RtCallback rtCallback; |
| }; |
| |
| /** |
| * NOTE: requires surfaceflinger to run, otherwise this method will wait indefinitely. |
| */ |
| static void runOnRenderThread(RtCallback rtCallback) { |
| TestTask task(rtCallback); |
| renderthread::RenderThread::getInstance().queue().runSync([&]() { task.run(); }); |
| } |
| |
| static bool isRenderThreadRunning() { return renderthread::RenderThread::hasInstance(); } |
| |
| static SkColor interpolateColor(float fraction, SkColor start, SkColor end); |
| |
| static void layoutTextUnscaled(const SkPaint& paint, const char* text, |
| std::vector<glyph_t>* outGlyphs, |
| std::vector<float>* outPositions, float* outTotalAdvance, |
| Rect* outBounds); |
| |
| static void drawUtf8ToCanvas(Canvas* canvas, const char* text, const SkPaint& paint, float x, |
| float y); |
| |
| static void drawUtf8ToCanvas(Canvas* canvas, const char* text, const SkPaint& paint, |
| const SkPath& path); |
| |
| static std::unique_ptr<uint16_t[]> asciiToUtf16(const char* str); |
| |
| class MockFunctor : public Functor { |
| public: |
| virtual status_t operator()(int what, void* data) { |
| mLastMode = what; |
| return DrawGlInfo::kStatusDone; |
| } |
| int getLastMode() const { return mLastMode; } |
| |
| private: |
| int mLastMode = -1; |
| }; |
| |
| static SkColor getColor(const sk_sp<SkSurface>& surface, int x, int y); |
| |
| static SkRect getClipBounds(const SkCanvas* canvas); |
| static SkRect getLocalClipBounds(const SkCanvas* canvas); |
| |
| private: |
| static void syncHierarchyPropertiesAndDisplayListImpl(RenderNode* node) { |
| MarkAndSweepRemoved observer(nullptr); |
| node->syncProperties(); |
| if (node->mNeedsDisplayListSync) { |
| node->mNeedsDisplayListSync = false; |
| node->syncDisplayList(observer, nullptr); |
| } |
| auto displayList = node->getDisplayList(); |
| if (displayList) { |
| if (displayList->isSkiaDL()) { |
| for (auto&& childDr : static_cast<skiapipeline::SkiaDisplayList*>( |
| const_cast<DisplayList*>(displayList)) |
| ->mChildNodes) { |
| syncHierarchyPropertiesAndDisplayListImpl(childDr.getRenderNode()); |
| } |
| } else { |
| for (auto&& childOp : displayList->getChildren()) { |
| syncHierarchyPropertiesAndDisplayListImpl(childOp->renderNode); |
| } |
| } |
| } |
| } |
| |
| }; // class TestUtils |
| |
| } /* namespace uirenderer */ |
| } /* namespace android */ |