| Flutter Impeller |

golden_playground_test_mac.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4
5 #include <dlfcn.h>
6 #include <filesystem>
7 #include <memory>
8
9 #include "display_list/display_list.h"
10 #include "flutter/impeller/golden_tests/golden_playground_test.h"
11
12 #include "flutter/impeller/golden_tests/golden_digest.h"
13 #include "flutter/impeller/golden_tests/metal_screenshotter.h"
14 #include "flutter/impeller/golden_tests/vulkan_screenshotter.h"
15 #include "flutter/third_party/abseil-cpp/absl/base/no_destructor.h"
16 #include "fml/closure.h"
17 #include "impeller/display_list/aiks_context.h"
18 #include "impeller/display_list/dl_dispatcher.h"
19 #include "impeller/display_list/dl_image_impeller.h"
20 #include "impeller/typographer/backends/skia/typographer_context_skia.h"
21 #include "impeller/typographer/typographer_context.h"
22
23 #define GLFW_INCLUDE_NONE
24 #include "third_party/glfw/include/GLFW/glfw3.h"
25
26 namespace impeller {
27
28 namespace {
29 std::unique_ptr<PlaygroundImpl> MakeVulkanPlayground(bool enable_validations) {
30 FML_CHECK(::glfwInit() == GLFW_TRUE);
31 PlaygroundSwitches playground_switches;
32 playground_switches.enable_vulkan_validation = enable_validations;
33 return PlaygroundImpl::Create(PlaygroundBackend::kVulkan,
34 playground_switches);
35 }
36
37 // Returns a static instance to a playground that can be used across tests.
38 const std::unique_ptr<PlaygroundImpl>& GetSharedVulkanPlayground(
39 bool enable_validations) {
40 if (enable_validations) {
41 static absl::NoDestructor<std::unique_ptr<PlaygroundImpl>>
42 vulkan_validation_playground(
43 MakeVulkanPlayground(/*enable_validations=*/true));
44 // TODO(142237): This can be removed when the thread local storage is
45 // removed.
46 static fml::ScopedCleanupClosure context_cleanup(
47 [&] { (*vulkan_validation_playground)->GetContext()->Shutdown(); });
48 return *vulkan_validation_playground;
49 } else {
50 static absl::NoDestructor<std::unique_ptr<PlaygroundImpl>>
51 vulkan_playground(MakeVulkanPlayground(/*enable_validations=*/false));
52 // TODO(142237): This can be removed when the thread local storage is
53 // removed.
54 static fml::ScopedCleanupClosure context_cleanup(
55 [&] { (*vulkan_playground)->GetContext()->Shutdown(); });
56 return *vulkan_playground;
57 }
58 }
59
60 } // namespace
61
62 #define IMP_AIKSTEST(name) \
63 "impeller_Play_AiksTest_" #name "_Metal", \
64 "impeller_Play_AiksTest_" #name "_OpenGLES", \
65 "impeller_Play_AiksTest_" #name "_Vulkan"
66
67 // If you add a new playground test to the aiks unittests and you do not want it
68 // to also be a golden test, then add the test name here.
69 static const std::vector<std::string> kSkipTests = {
70 // TextRotated is flakey and we can't seem to get it to stabilize on Skia
71 // Gold.
72 IMP_AIKSTEST(TextRotated),
73 // Runtime stage based tests get confused with a Metal context.
74 "impeller_Play_AiksTest_CanRenderClippedRuntimeEffects_Vulkan",
75 };
76
77 namespace {
78 std::string GetTestName() {
79 std::string suite_name =
80 ::testing::UnitTest::GetInstance()->current_test_suite()->name();
81 std::string test_name =
82 ::testing::UnitTest::GetInstance()->current_test_info()->name();
83 std::stringstream ss;
84 ss << "impeller_" << suite_name << "_" << test_name;
85 std::string result = ss.str();
86 // Make sure there are no slashes in the test name.
87 std::replace(result.begin(), result.end(), '/', '_');
88 return result;
89 }
90
91 std::string GetGoldenFilename(const std::string& postfix) {
92 return GetTestName() + postfix + ".png";
93 }
94 } // namespace
95
96 bool GoldenPlaygroundTest::SaveScreenshot(
97 std::unique_ptr<testing::Screenshot> screenshot,
98 const std::string& postfix) {
99 if (!screenshot || !screenshot->GetBytes()) {
100 FML_LOG(ERROR) << "Failed to collect screenshot for test " << GetTestName();
101 return false;
102 }
103 std::string test_name = GetTestName();
104 std::string filename = GetGoldenFilename(postfix);
105 testing::GoldenDigest::Instance()->AddImage(
106 test_name, filename, screenshot->GetWidth(), screenshot->GetHeight());
107 if (!screenshot->WriteToPNG(
108 testing::WorkingDirectory::Instance()->GetFilenamePath(filename))) {
109 FML_LOG(ERROR) << "Failed to write screenshot to " << filename;
110 return false;
111 }
112 return true;
113 }
114
115 struct GoldenPlaygroundTest::GoldenPlaygroundTestImpl {
116 std::unique_ptr<PlaygroundImpl> test_vulkan_playground;
117 std::unique_ptr<PlaygroundImpl> test_opengl_playground;
118 std::unique_ptr<testing::Screenshotter> screenshotter;
119 ISize window_size = ISize{1024, 768};
120 };
121
122 GoldenPlaygroundTest::GoldenPlaygroundTest()
123 : typographer_context_(TypographerContextSkia::Make()),
124 pimpl_(new GoldenPlaygroundTest::GoldenPlaygroundTestImpl()) {}
125
126 GoldenPlaygroundTest::~GoldenPlaygroundTest() = default;
127
128 void GoldenPlaygroundTest::SetTypographerContext(
129 std::shared_ptr<TypographerContext> typographer_context) {
130 typographer_context_ = std::move(typographer_context);
131 };
132
133 void GoldenPlaygroundTest::TearDown() {
134 ASSERT_FALSE(dlopen("/usr/local/lib/libMoltenVK.dylib", RTLD_NOLOAD));
135 }
136
137 namespace {
138 bool DoesSupportWideGamutTests() {
139 #ifdef __arm64__
140 return true;
141 #else
142 return false;
143 #endif
144 }
145 } // namespace
146
147 void GoldenPlaygroundTest::SetUp() {
148 std::filesystem::path testing_assets_path =
149 flutter::testing::GetTestingAssetsPath();
150 std::filesystem::path target_path = testing_assets_path.parent_path()
151 .parent_path()
152 .parent_path()
153 .parent_path();
154 std::filesystem::path icd_path = target_path / "vk_swiftshader_icd.json";
155 setenv("VK_ICD_FILENAMES", icd_path.c_str(), 1);
156
157 std::string test_name = GetTestName();
158 bool enable_wide_gamut = test_name.find("WideGamut_") != std::string::npos;
159 switch (GetParam()) {
160 case PlaygroundBackend::kMetal:
161 if (!DoesSupportWideGamutTests()) {
162 GTEST_SKIP()
163 << "This metal device doesn't support wide gamut golden tests.";
164 }
165 pimpl_->screenshotter =
166 std::make_unique<testing::MetalScreenshotter>(enable_wide_gamut);
167 break;
168 case PlaygroundBackend::kVulkan: {
169 if (enable_wide_gamut) {
170 GTEST_SKIP() << "Vulkan doesn't support wide gamut golden tests.";
171 }
172 const std::unique_ptr<PlaygroundImpl>& playground =
173 GetSharedVulkanPlayground(/*enable_validations=*/true);
174 pimpl_->screenshotter =
175 std::make_unique<testing::VulkanScreenshotter>(playground);
176 break;
177 }
178 case PlaygroundBackend::kOpenGLES: {
179 if (enable_wide_gamut) {
180 GTEST_SKIP() << "OpenGLES doesn't support wide gamut golden tests.";
181 }
182 FML_CHECK(::glfwInit() == GLFW_TRUE);
183 PlaygroundSwitches playground_switches;
184 playground_switches.use_angle = true;
185 pimpl_->test_opengl_playground = PlaygroundImpl::Create(
186 PlaygroundBackend::kOpenGLES, playground_switches);
187 pimpl_->screenshotter = std::make_unique<testing::VulkanScreenshotter>(
188 pimpl_->test_opengl_playground);
189 break;
190 }
191 }
192
193 if (std::find(kSkipTests.begin(), kSkipTests.end(), test_name) !=
194 kSkipTests.end()) {
195 GTEST_SKIP()
196 << "GoldenPlaygroundTest doesn't support interactive playground tests "
197 "yet.";
198 }
199
200 testing::GoldenDigest::Instance()->AddDimension(
201 "gpu_string", GetContext()->DescribeGpuModel());
202 }
203
204 PlaygroundBackend GoldenPlaygroundTest::GetBackend() const {
205 return GetParam();
206 }
207
208 bool GoldenPlaygroundTest::OpenPlaygroundHere(
209 const AiksDlPlaygroundCallback& callback) {
210 AiksContext renderer(GetContext(), typographer_context_);
211
212 std::unique_ptr<testing::Screenshot> screenshot;
213 for (int i = 0; i < 2; ++i) {
214 auto display_list = callback();
215 auto texture =
216 DisplayListToTexture(display_list, pimpl_->window_size, renderer);
217 screenshot = pimpl_->screenshotter->MakeScreenshot(renderer, texture);
218 }
219 return SaveScreenshot(std::move(screenshot));
220 }
221
222 bool GoldenPlaygroundTest::OpenPlaygroundHere(
223 const sk_sp<flutter::DisplayList>& list) {
224 return OpenPlaygroundHere([&list]() { return list; });
225 }
226
227 bool GoldenPlaygroundTest::ImGuiBegin(const char* name,
228 bool* p_open,
229 ImGuiWindowFlags flags) {
230 return false;
231 }
232
233 std::shared_ptr<Texture> GoldenPlaygroundTest::CreateTextureForFixture(
234 const char* fixture_name,
235 bool enable_mipmapping) const {
236 std::shared_ptr<fml::Mapping> mapping =
237 flutter::testing::OpenFixtureAsMapping(fixture_name);
238 auto result = Playground::CreateTextureForMapping(GetContext(), mapping,
239 enable_mipmapping);
240 if (result) {
241 result->SetLabel(fixture_name);
242 }
243 return result;
244 }
245
246 sk_sp<flutter::DlImage> GoldenPlaygroundTest::CreateDlImageForFixture(
247 const char* fixture_name,
248 bool enable_mipmapping) const {
249 std::shared_ptr<Texture> texture =
250 CreateTextureForFixture(fixture_name, enable_mipmapping);
251 return DlImageImpeller::Make(texture);
252 }
253
254 RuntimeStage::Map GoldenPlaygroundTest::OpenAssetAsRuntimeStage(
255 const char* asset_name) const {
256 const std::shared_ptr<fml::Mapping> fixture =
257 flutter::testing::OpenFixtureAsMapping(asset_name);
258 if (!fixture || fixture->GetSize() == 0) {
259 return {};
260 }
261 return RuntimeStage::DecodeRuntimeStages(fixture);
262 }
263
264 std::shared_ptr<Context> GoldenPlaygroundTest::GetContext() const {
265 return pimpl_->screenshotter->GetPlayground().GetContext();
266 }
267
268 std::shared_ptr<Context> GoldenPlaygroundTest::MakeContext() const {
269 if (GetParam() == PlaygroundBackend::kMetal) {
270 /// On Metal we create a context for each test.
271 return GetContext();
272 } else if (GetParam() == PlaygroundBackend::kVulkan) {
273 bool enable_vulkan_validations = true;
274 FML_CHECK(!pimpl_->test_vulkan_playground)
275 << "We don't support creating multiple contexts for one test";
276 pimpl_->test_vulkan_playground =
277 MakeVulkanPlayground(enable_vulkan_validations);
278 pimpl_->screenshotter = std::make_unique<testing::VulkanScreenshotter>(
279 pimpl_->test_vulkan_playground);
280 return pimpl_->test_vulkan_playground->GetContext();
281 } else {
282 /// On OpenGL we create a context for each test.
283 return GetContext();
284 }
285 }
286
287 Point GoldenPlaygroundTest::GetContentScale() const {
288 return pimpl_->screenshotter->GetPlayground().GetContentScale();
289 }
290
291 Scalar GoldenPlaygroundTest::GetSecondsElapsed() const {
292 return 0.0f;
293 }
294
295 ISize GoldenPlaygroundTest::GetWindowSize() const {
296 return pimpl_->window_size;
297 }
298
299 void GoldenPlaygroundTest::GoldenPlaygroundTest::SetWindowSize(ISize size) {
300 pimpl_->window_size = size;
301 }
302
303 fml::Status GoldenPlaygroundTest::SetCapabilities(
304 const std::shared_ptr<Capabilities>& capabilities) {
305 return pimpl_->screenshotter->GetPlayground().SetCapabilities(capabilities);
306 }
307
308 std::unique_ptr<testing::Screenshot> GoldenPlaygroundTest::MakeScreenshot(
309 const sk_sp<flutter::DisplayList>& list) {
310 AiksContext renderer(GetContext(), typographer_context_);
311
312 return pimpl_->screenshotter->MakeScreenshot(
313 renderer, DisplayListToTexture(list, pimpl_->window_size, renderer));
314 }
315
316 } // namespace impeller
impeller::GoldenPlaygroundTest::ImGuiBegin
static bool ImGuiBegin(const char *name, bool *p_open, ImGuiWindowFlags flags)
Definition: golden_playground_test_mac.cc:227
impeller::GoldenPlaygroundTest::GetContentScale
Point GetContentScale() const
Definition: golden_playground_test_mac.cc:287
impeller::PlaygroundBackend::kVulkan
@ kVulkan
impeller::GoldenPlaygroundTest::SetCapabilities
fml::Status SetCapabilities(const std::shared_ptr< Capabilities > &capabilities)
Definition: golden_playground_test_mac.cc:303
impeller::Scalar
float Scalar
Definition: scalar.h:18
impeller::AiksContext
Definition: aiks_context.h:19
vulkan_screenshotter.h
impeller::GoldenPlaygroundTest::MakeContext
std::shared_ptr< Context > MakeContext() const
Definition: golden_playground_test_mac.cc:268
impeller::GoldenPlaygroundTest::MakeScreenshot
std::unique_ptr< testing::Screenshot > MakeScreenshot(const sk_sp< flutter::DisplayList > &list)
Definition: golden_playground_test_mac.cc:308
golden_digest.h
impeller::RuntimeStage::DecodeRuntimeStages
static Map DecodeRuntimeStages(const std::shared_ptr< fml::Mapping > &payload)
Definition: runtime_stage.cc:61
impeller::PlaygroundBackend::kMetal
@ kMetal
aiks_context.h
dl_dispatcher.h
impeller::PlaygroundBackend
PlaygroundBackend
Definition: playground.h:27
impeller::GoldenPlaygroundTest::OpenPlaygroundHere
bool OpenPlaygroundHere(Picture picture)
typographer_context.h
impeller::testing::GoldenDigest::AddImage
void AddImage(const std::string &test_name, const std::string &filename, int32_t width, int32_t height)
Definition: golden_digest.cc:34
impeller::GoldenPlaygroundTest::GetContext
std::shared_ptr< Context > GetContext() const
Definition: golden_playground_test_mac.cc:264
impeller::GoldenPlaygroundTest::GoldenPlaygroundTestImpl
Definition: golden_playground_test_mac.cc:115
IMP_AIKSTEST
#define IMP_AIKSTEST(name)
Definition: golden_playground_test_mac.cc:62
impeller::GoldenPlaygroundTest::~GoldenPlaygroundTest
~GoldenPlaygroundTest() override
impeller::GoldenPlaygroundTest::SaveScreenshot
static bool SaveScreenshot(std::unique_ptr< testing::Screenshot > screenshot, const std::string &postfix="")
Definition: golden_playground_test_mac.cc:96
impeller::DlImageImpeller::Make
static sk_sp< DlImageImpeller > Make(std::shared_ptr< Texture > texture, OwningContext owning_context=OwningContext::kIO)
Definition: dl_image_impeller.cc:23
typographer_context_skia.h
impeller::GoldenPlaygroundTest::SetTypographerContext
void SetTypographerContext(std::shared_ptr< TypographerContext > typographer_context)
Definition: golden_playground_test_mac.cc:128
impeller::TSize
Definition: size.h:25
impeller::GoldenPlaygroundTest::GoldenPlaygroundTest
GoldenPlaygroundTest()
Definition: golden_playground_test_mac.cc:122
impeller::GoldenPlaygroundTest::GetBackend
PlaygroundBackend GetBackend() const
Definition: golden_playground_test_mac.cc:204
impeller::kSkipTests
static const std::vector< std::string > kSkipTests
Definition: golden_playground_test_mac.cc:69
impeller::GoldenPlaygroundTest::GoldenPlaygroundTestImpl::test_vulkan_playground
std::unique_ptr< PlaygroundImpl > test_vulkan_playground
Definition: golden_playground_test_mac.cc:116
impeller::GoldenPlaygroundTest::SetUp
void SetUp()
Definition: golden_playground_test_mac.cc:147
impeller::GoldenPlaygroundTest::GoldenPlaygroundTestImpl::screenshotter
std::unique_ptr< testing::Screenshotter > screenshotter
Definition: golden_playground_test_mac.cc:118
impeller::GoldenPlaygroundTest
Definition: golden_playground_test.h:26
impeller::testing::WorkingDirectory::GetFilenamePath
std::string GetFilenamePath(const std::string &filename) const
Definition: working_directory.cc:23
impeller::GoldenPlaygroundTest::CreateTextureForFixture
std::shared_ptr< Texture > CreateTextureForFixture(const char *fixture_name, bool enable_mipmapping=false) const
Definition: golden_playground_test_mac.cc:233
golden_playground_test.h
impeller::TypographerContextSkia
Definition: typographer_context_skia.h:12
impeller::PlaygroundImpl::Create
static std::unique_ptr< PlaygroundImpl > Create(PlaygroundBackend backend, PlaygroundSwitches switches)
Definition: playground_impl.cc:25
impeller::GoldenPlaygroundTest::CreateDlImageForFixture
sk_sp< flutter::DlImage > CreateDlImageForFixture(const char *fixture_name, bool enable_mipmapping=false) const
Definition: golden_playground_test_mac.cc:246
impeller::GoldenPlaygroundTest::AiksDlPlaygroundCallback
std::function< sk_sp< flutter::DisplayList >()> AiksDlPlaygroundCallback
Definition: golden_playground_test.h:32
impeller::PlaygroundSwitches::use_angle
bool use_angle
Definition: switches.h:33
impeller::PlaygroundBackend::kOpenGLES
@ kOpenGLES
impeller::Playground::CreateTextureForMapping
static std::shared_ptr< Texture > CreateTextureForMapping(const std::shared_ptr< Context > &context, std::shared_ptr< fml::Mapping > mapping, bool enable_mipmapping=false)
Definition: playground.cc:432
impeller::GoldenPlaygroundTest::GetSecondsElapsed
Scalar GetSecondsElapsed() const
Definition: golden_playground_test_mac.cc:291
impeller::PlaygroundSwitches
Definition: switches.h:15
impeller::GoldenPlaygroundTest::TearDown
void TearDown()
Definition: golden_playground_test_mac.cc:133
impeller::TPoint< Scalar >
impeller::testing::GoldenDigest::Instance
static GoldenDigest * Instance()
Definition: golden_digest.cc:18
impeller::testing::GoldenDigest::AddDimension
void AddDimension(const std::string &name, const std::string &value)
Definition: golden_digest.cc:27
impeller::testing::WorkingDirectory::Instance
static WorkingDirectory * Instance()
Definition: working_directory.cc:16
impeller::DisplayListToTexture
std::shared_ptr< Texture > DisplayListToTexture(const sk_sp< flutter::DisplayList > &display_list, ISize size, AiksContext &context, bool reset_host_buffer, bool generate_mips)
Render the provided display list to a texture with the given size.
Definition: dl_dispatcher.cc:1249
impeller::GoldenPlaygroundTest::GoldenPlaygroundTestImpl::test_opengl_playground
std::unique_ptr< PlaygroundImpl > test_opengl_playground
Definition: golden_playground_test_mac.cc:117
impeller::GoldenPlaygroundTest::GoldenPlaygroundTestImpl::window_size
ISize window_size
Definition: golden_playground_test_mac.cc:119
metal_screenshotter.h
impeller
Definition: allocation.cc:12
impeller::GoldenPlaygroundTest::GetWindowSize
ISize GetWindowSize() const
Definition: golden_playground_test_mac.cc:295
impeller::GoldenPlaygroundTest::OpenAssetAsRuntimeStage
RuntimeStage::Map OpenAssetAsRuntimeStage(const char *asset_name) const
Definition: golden_playground_test_mac.cc:254
impeller::RuntimeStage::Map
std::map< RuntimeStageBackend, std::shared_ptr< RuntimeStage > > Map
Definition: runtime_stage.h:24
dl_image_impeller.h