Hash :
e0216987
Author :
Date :
2025-03-04T16:44:31
Preserve window format when resizing on Android On some devices acquiring next swapchain image after window format change (without resize) does not return VK_ERROR_OUT_OF_DATE_KHR. Further rendering into the acquired image and/or presenting that image may produce undefined results. Try to preserve current window format to avoid such problem. Note, window format is automatically set after swapchain create based on the create info imageFormat. Bug: angleproject:397848903 Bug: angleproject:42260362 Change-Id: Ibada10befd2938f1bcf018c399ce8cc015541e60 Reviewed-on: https://chromium-review.googlesource.com/c/angle/angle/+/6322789 Reviewed-by: Shahbaz Youssefi <syoussefi@chromium.org> Reviewed-by: Geoff Lang <geofflang@chromium.org> Commit-Queue: Igor Nazarov <i.nazarov@samsung.com>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
//
// Copyright 2016 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//
// AndroidWindow.cpp: Implementation of OSWindow for Android
#include "util/android/AndroidWindow.h"
#include <pthread.h>
#include <filesystem>
#include <iostream>
#include "common/debug.h"
#include "util/android/third_party/android_native_app_glue.h"
namespace
{
struct android_app *sApp = nullptr;
pthread_mutex_t sInitWindowMutex;
pthread_cond_t sInitWindowCond;
bool sInitWindowDone = false;
JNIEnv *gJni = nullptr;
// SCREEN_ORIENTATION_LANDSCAPE and SCREEN_ORIENTATION_PORTRAIT are
// available from Android API level 1
// https://developer.android.com/reference/android/app/Activity#setRequestedOrientation(int)
const int kScreenOrientationLandscape = 0;
const int kScreenOrientationPortrait = 1;
JNIEnv *GetJniEnv()
{
if (gJni)
return gJni;
sApp->activity->vm->AttachCurrentThread(&gJni, NULL);
return gJni;
}
int SetScreenOrientation(struct android_app *app, int orientation)
{
// Use reverse JNI to call the Java entry point that rotates the
// display to respect width and height
JNIEnv *jni = GetJniEnv();
if (!jni)
{
std::cerr << "Failed to get JNI env for screen rotation";
return JNI_ERR;
}
jclass clazz = jni->GetObjectClass(app->activity->clazz);
jmethodID methodID = jni->GetMethodID(clazz, "setRequestedOrientation", "(I)V");
jni->CallVoidMethod(app->activity->clazz, methodID, orientation);
return 0;
}
} // namespace
AndroidWindow::AndroidWindow() {}
AndroidWindow::~AndroidWindow() {}
bool AndroidWindow::initializeImpl(const std::string &name, int width, int height)
{
return resize(width, height);
}
void AndroidWindow::destroy() {}
void AndroidWindow::disableErrorMessageDialog() {}
void AndroidWindow::resetNativeWindow() {}
EGLNativeWindowType AndroidWindow::getNativeWindow() const
{
// Return the entire Activity Surface for now
// sApp->window is valid only after sInitWindowDone, which is true after initializeImpl()
return sApp->window;
}
EGLNativeDisplayType AndroidWindow::getNativeDisplay() const
{
return EGL_DEFAULT_DISPLAY;
}
void AndroidWindow::messageLoop()
{
// TODO: accumulate events in the real message loop of android_main,
// and process them here
}
void AndroidWindow::setMousePosition(int x, int y)
{
UNIMPLEMENTED();
}
bool AndroidWindow::setOrientation(int width, int height)
{
// Set tests to run in correct orientation
int32_t err = SetScreenOrientation(
sApp, (width > height) ? kScreenOrientationLandscape : kScreenOrientationPortrait);
return err == 0;
}
bool AndroidWindow::setPosition(int x, int y)
{
UNIMPLEMENTED();
return false;
}
bool AndroidWindow::resize(int width, int height)
{
mWidth = width;
mHeight = height;
// sApp->window used below is valid only after Activity Surface is created
pthread_mutex_lock(&sInitWindowMutex);
while (!sInitWindowDone)
{
pthread_cond_wait(&sInitWindowCond, &sInitWindowMutex);
}
pthread_mutex_unlock(&sInitWindowMutex);
if (sApp->window == nullptr)
{
// Note: logging isn't initalized yet but this message shows up in logcat.
FATAL() << "Window is NULL (is screen locked? e.g. SplashScreen in logcat)";
}
// On some devices acquiring next swapchain image after window format change (without resize)
// does not return VK_ERROR_OUT_OF_DATE_KHR. Further rendering into the acquired image and/or
// presenting that image may produce undefined results. Try to preserve current window format
// to avoid such problem. Note, window format is automatically set after swapchain create based
// on the create info imageFormat.
int32_t currentFormat = ANativeWindow_getFormat(sApp->window);
if (currentFormat < 0)
{
ERR() << "ANativeWindow_getFormat() failed: " << currentFormat;
currentFormat = 0;
}
int32_t err = ANativeWindow_setBuffersGeometry(sApp->window, mWidth, mHeight, currentFormat);
return err == 0;
}
void AndroidWindow::setVisible(bool isVisible) {}
void AndroidWindow::signalTestEvent()
{
UNIMPLEMENTED();
}
static void onAppCmd(struct android_app *app, int32_t cmd)
{
switch (cmd)
{
case APP_CMD_INIT_WINDOW:
pthread_mutex_lock(&sInitWindowMutex);
sInitWindowDone = true;
pthread_cond_broadcast(&sInitWindowCond);
pthread_mutex_unlock(&sInitWindowMutex);
break;
case APP_CMD_DESTROY:
if (gJni)
{
sApp->activity->vm->DetachCurrentThread();
}
gJni = nullptr;
break;
// TODO: process other commands and pass them to AndroidWindow for handling
// TODO: figure out how to handle APP_CMD_PAUSE,
// which should immediately halt all the rendering,
// since Activity Surface is no longer available.
// Currently tests crash when paused, for example, due to device changing orientation
}
}
static int32_t onInputEvent(struct android_app *app, AInputEvent *event)
{
// TODO: Handle input events
return 0; // 0 == not handled
}
static bool validPollResult(int result)
{
return result >= 0 || result == ALOOPER_POLL_CALLBACK;
}
void android_main(struct android_app *app)
{
int events;
struct android_poll_source *source;
sApp = app;
pthread_mutex_init(&sInitWindowMutex, nullptr);
pthread_cond_init(&sInitWindowCond, nullptr);
// Event handlers, invoked from source->process()
app->onAppCmd = onAppCmd;
app->onInputEvent = onInputEvent;
// Message loop, polling for events indefinitely (due to -1 timeout)
// Must be here in order to handle APP_CMD_INIT_WINDOW event,
// which occurs after AndroidWindow::initializeImpl(), but before AndroidWindow::messageLoop
while (
validPollResult(ALooper_pollOnce(-1, nullptr, &events, reinterpret_cast<void **>(&source))))
{
if (source != nullptr)
{
source->process(app, source);
}
}
}
std::string AndroidWindow::GetApplicationDirectory()
{
// Use reverse JNI.
JNIEnv *jni = GetJniEnv();
if (!jni)
{
std::cerr << "GetApplicationDirectory:: Failed to get JNI env";
return "";
}
// Get the ANativeActivity class
jclass nativeActivityClass = jni->GetObjectClass(sApp->activity->clazz);
if (!nativeActivityClass)
{
std::cerr << "GetApplicationDirectory: Failed to get ANativeActivity class";
return "";
}
// Get the getApplicationContext() method ID
jmethodID getApplicationContextMethod = jni->GetMethodID(
nativeActivityClass, "getApplicationContext", "()Landroid/content/Context;");
if (!getApplicationContextMethod)
{
std::cerr << "GetApplicationDirectory: Failed to find getApplicationContext method";
return "";
}
// Call getApplicationContext() to get the Context object
jobject context = jni->CallObjectMethod(sApp->activity->clazz, getApplicationContextMethod);
if (!context)
{
std::cerr << "GetApplicationDirectory: Failed to get Context object";
return "";
}
// Get the Context class
jclass contextClass = jni->GetObjectClass(context);
if (!contextClass)
{
std::cerr << "GetApplicationDirectory: Failed to get Context class";
return "";
}
// Get the getFilesDir() method ID
jmethodID getFilesDirMethod = jni->GetMethodID(contextClass, "getFilesDir", "()Ljava/io/File;");
if (!getFilesDirMethod)
{
std::cerr << "GetApplicationDirectory: Failed to find getFilesDir method";
return "";
}
// Call getFilesDir() to get the File object
jobject fileObject = jni->CallObjectMethod(context, getFilesDirMethod);
if (!fileObject)
{
std::cerr << "GetApplicationDirectory: Failed to get File object";
return "";
}
// Get the File class
jclass fileClass = jni->GetObjectClass(fileObject);
if (!fileClass)
{
std::cerr << "GetApplicationDirectory: Failed to get File class";
return "";
}
// Get the getAbsolutePath() method ID
jmethodID getAbsolutePathMethod =
jni->GetMethodID(fileClass, "getAbsolutePath", "()Ljava/lang/String;");
if (!getAbsolutePathMethod)
{
std::cerr << "GetApplicationDirectory: Failed to find getAbsolutePath method";
return "";
}
// Call getAbsolutePath() to get the path as a jstring
jstring pathString = (jstring)jni->CallObjectMethod(fileObject, getAbsolutePathMethod);
if (!pathString)
{
std::cerr << "GetApplicationDirectory: Failed to get path string";
return "";
}
// Convert the jstring to a std::string
const char *pathChars = jni->GetStringUTFChars(pathString, nullptr);
std::string filesDirPath(pathChars);
jni->ReleaseStringUTFChars(pathString, pathChars);
// Return the base directory, stripping "files" essentially
std::filesystem::path fullPath(filesDirPath);
return fullPath.parent_path();
}
// static
std::string AndroidWindow::GetExternalStorageDirectory()
{
// Use reverse JNI.
JNIEnv *jni = GetJniEnv();
if (!jni)
{
std::cerr << "GetExternalStorageDirectory:: Failed to get JNI env";
return "";
}
jclass classEnvironment = jni->FindClass("android/os/Environment");
if (classEnvironment == 0)
{
std::cerr << "GetExternalStorageDirectory: Failed to find Environment";
return "";
}
// public static File getExternalStorageDirectory ()
jmethodID methodIDgetExternalStorageDirectory =
jni->GetStaticMethodID(classEnvironment, "getExternalStorageDirectory", "()Ljava/io/File;");
if (methodIDgetExternalStorageDirectory == 0)
{
std::cerr << "GetExternalStorageDirectory: Failed to get static method";
return "";
}
jobject objectFile =
jni->CallStaticObjectMethod(classEnvironment, methodIDgetExternalStorageDirectory);
jthrowable exception = jni->ExceptionOccurred();
if (exception != 0)
{
jni->ExceptionDescribe();
jni->ExceptionClear();
std::cerr << "GetExternalStorageDirectory: Failed because of exception";
return "";
}
// Call method on File object to retrieve String object.
jclass classFile = jni->GetObjectClass(objectFile);
if (classEnvironment == 0)
{
std::cerr << "GetExternalStorageDirectory: Failed to find object class";
return "";
}
jmethodID methodIDgetAbsolutePath =
jni->GetMethodID(classFile, "getAbsolutePath", "()Ljava/lang/String;");
if (methodIDgetAbsolutePath == 0)
{
std::cerr << "GetExternalStorageDirectory: Failed to get method ID";
return "";
}
jstring stringPath =
static_cast<jstring>(jni->CallObjectMethod(objectFile, methodIDgetAbsolutePath));
// TODO(jmadill): Find how to pass the root test directory to ANGLE. http://crbug.com/1097957
// // https://stackoverflow.com/questions/12841240/android-pass-parameter-to-native-activity
// jclass clazz = jni->GetObjectClass(sApp->activity->clazz);
// if (clazz == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Bad activity";
// return "";
// }
// jmethodID giid = jni->GetMethodID(clazz, "getIntent", "()Landroid/content/Intent;");
// if (giid == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Could not find getIntent";
// return "";
// }
// jobject intent = jni->CallObjectMethod(sApp->activity->clazz, giid);
// if (intent == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Error calling getIntent";
// return "";
// }
// jclass icl = jni->GetObjectClass(intent);
// if (icl == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Error getting getIntent class";
// return "";
// }
// jmethodID gseid =
// jni->GetMethodID(icl, "getStringExtra", "(Ljava/lang/String;)Ljava/lang/String;");
// if (gseid == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Could not find getStringExtra";
// return "";
// }
// jstring stringPath = static_cast<jstring>(jni->CallObjectMethod(
// intent, gseid, jni->NewStringUTF("org.chromium.base.test.util.UrlUtils.RootDirectory")));
// if (stringPath != 0)
// {
// const char *path = jni->GetStringUTFChars(stringPath, nullptr);
// return std::string(path) + "/chromium_tests_root";
// }
// jclass environment = jni->FindClass("org/chromium/base/test/util/UrlUtils");
// if (environment == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Failed to find Environment";
// return "";
// }
// jmethodID getDir =
// jni->GetStaticMethodID(environment, "getIsolatedTestRoot", "()Ljava/lang/String;");
// if (getDir == 0)
// {
// std::cerr << "GetExternalStorageDirectory: Failed to get static method";
// return "";
// }
// stringPath = static_cast<jstring>(jni->CallStaticObjectMethod(environment, getDir));
exception = jni->ExceptionOccurred();
if (exception != 0)
{
jni->ExceptionDescribe();
jni->ExceptionClear();
std::cerr << "GetExternalStorageDirectory: Failed because of exception";
return "";
}
const char *path = jni->GetStringUTFChars(stringPath, nullptr);
return std::string(path) + "/chromium_tests_root";
}
// static
OSWindow *OSWindow::New()
{
// There should be only one live instance of AndroidWindow at a time,
// as there is only one Activity Surface behind it.
// Creating a new AndroidWindow each time works for ANGLETest,
// as it destroys an old window before creating a new one.
// TODO: use GLSurfaceView to support multiple windows
return new AndroidWindow();
}