From b0f8aef057a62579825d7f71e6a10f9248817a8b Mon Sep 17 00:00:00 2001 From: bunnei Date: Sun, 19 Feb 2023 00:38:59 -0800 Subject: [PATCH] android: frontend: Add support for GPU driver selection. --- src/android/app/src/main/AndroidManifest.xml | 1 + .../java/org/yuzu/yuzu_emu/NativeLibrary.java | 2 +- .../org/yuzu/yuzu_emu/YuzuApplication.java | 3 +- .../yuzu/yuzu_emu/ui/main/MainActivity.java | 53 ++++++- .../yuzu/yuzu_emu/ui/main/MainPresenter.java | 5 + .../yuzu/yuzu_emu/utils/GpuDriverHelper.java | 130 ++++++++++++++++++ .../yuzu_emu/utils/GpuDriverMetadata.java | 45 ++++++ .../app/src/main/res/menu/menu_game_grid.xml | 5 + .../app/src/main/res/values/strings.xml | 10 ++ 9 files changed, 251 insertions(+), 3 deletions(-) create mode 100644 src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverHelper.java create mode 100644 src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverMetadata.java diff --git a/src/android/app/src/main/AndroidManifest.xml b/src/android/app/src/main/AndroidManifest.xml index 88e1669cd5..de4dbb948f 100644 --- a/src/android/app/src/main/AndroidManifest.xml +++ b/src/android/app/src/main/AndroidManifest.xml @@ -27,6 +27,7 @@ android:supportsRtl="true" android:isGame="true" android:banner="@mipmap/ic_launcher" + android:extractNativeLibs="true" android:requestLegacyExternalStorage="true"> + { + GpuDriverHelper.installDefaultDriver(this); + Toast.makeText(this, R.string.select_gpu_driver_use_default, Toast.LENGTH_SHORT).show(); + }); + + // Use the file picker to install a custom driver. + builder.setNeutralButton(R.string.select_gpu_driver_install, (dialogInterface, i) -> { + FileBrowserHelper.openFilePicker(this, + MainPresenter.REQUEST_SELECT_GPU_DRIVER, + R.string.select_gpu_driver); + }); + + // Show the dialog. + AlertDialog alertDialog = builder.create(); + alertDialog.show(); + + break; } } @@ -163,12 +200,26 @@ public final class MainActivity extends AppCompatActivity implements MainView { Toast.makeText(this, R.string.install_keys_success, Toast.LENGTH_SHORT).show(); refreshFragment(); } else { - Toast.makeText(this, R.string.install_keys_failure, Toast.LENGTH_SHORT).show(); + Toast.makeText(this, R.string.install_keys_failure, Toast.LENGTH_LONG).show(); launchFileListActivity(MainPresenter.REQUEST_INSTALL_KEYS); } } } break; + + case MainPresenter.REQUEST_SELECT_GPU_DRIVER: + if (resultCode == MainActivity.RESULT_OK) { + int takeFlags = (Intent.FLAG_GRANT_WRITE_URI_PERMISSION | Intent.FLAG_GRANT_READ_URI_PERMISSION); + getContentResolver().takePersistableUriPermission(Uri.parse(result.getDataString()), takeFlags); + GpuDriverHelper.installCustomDriver(this, result.getData()); + String driverName = GpuDriverHelper.getCustomDriverName(); + if (driverName != null) { + Toast.makeText(this, getString(R.string.select_gpu_driver_install_success) + " " + driverName, Toast.LENGTH_SHORT).show(); + } else { + Toast.makeText(this, R.string.select_gpu_driver_error, Toast.LENGTH_LONG).show(); + } + } + break; } } diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/ui/main/MainPresenter.java b/src/android/app/src/main/java/org/yuzu/yuzu_emu/ui/main/MainPresenter.java index 82667a98fc..d2ef753bc4 100644 --- a/src/android/app/src/main/java/org/yuzu/yuzu_emu/ui/main/MainPresenter.java +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/ui/main/MainPresenter.java @@ -12,6 +12,7 @@ import org.yuzu.yuzu_emu.utils.AddDirectoryHelper; public final class MainPresenter { public static final int REQUEST_ADD_DIRECTORY = 1; public static final int REQUEST_INSTALL_KEYS = 2; + public static final int REQUEST_SELECT_GPU_DRIVER = 3; private final MainView mView; private String mDirToAdd; private long mLastClickTime = 0; @@ -51,6 +52,10 @@ public final class MainPresenter { case R.id.button_install_keys: launchFileListActivity(REQUEST_INSTALL_KEYS); return true; + + case R.id.button_select_gpu_driver: + launchFileListActivity(REQUEST_SELECT_GPU_DRIVER); + return true; } return false; diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverHelper.java b/src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverHelper.java new file mode 100644 index 0000000000..822a3f1f96 --- /dev/null +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverHelper.java @@ -0,0 +1,130 @@ +package org.yuzu.yuzu_emu.utils; + +import android.content.Context; +import android.net.Uri; + +import org.yuzu.yuzu_emu.NativeLibrary; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; + +public class GpuDriverHelper { + private static final String META_JSON_FILENAME = "meta.json"; + private static final String DRIVER_INTERNAL_FILENAME = "gpu_driver.zip"; + private static String fileRedirectionPath; + private static String driverInstallationPath; + private static String hookLibPath; + + private static void unzip(String zipFilePath, String destDir) throws IOException { + File dir = new File(destDir); + + // Create output directory if it doesn't exist + if (!dir.exists()) dir.mkdirs(); + + // Unpack the files. + ZipInputStream zis = new ZipInputStream(new FileInputStream(zipFilePath)); + byte[] buffer = new byte[1024]; + ZipEntry ze = zis.getNextEntry(); + while (ze != null) { + String fileName = ze.getName(); + File newFile = new File(destDir + fileName); + newFile.getParentFile().mkdirs(); + FileOutputStream fos = new FileOutputStream(newFile); + int len; + while ((len = zis.read(buffer)) > 0) { + fos.write(buffer, 0, len); + } + fos.close(); + zis.closeEntry(); + ze = zis.getNextEntry(); + } + zis.closeEntry(); + } + + public static void initializeDriverParameters(Context context) { + try { + // Initialize the file redirection directory. + fileRedirectionPath = context.getExternalFilesDir(null).getCanonicalPath() + "/gpu/vk_file_redirect/"; + + // Initialize the driver installation directory. + driverInstallationPath = context.getFilesDir().getCanonicalPath() + "/gpu_driver/"; + } catch (IOException e) { + throw new RuntimeException(e); + } + + // Initialize directories. + initializeDirectories(); + + // Initialize hook libraries directory. + hookLibPath = context.getApplicationInfo().nativeLibraryDir + "/"; + + // Initialize GPU driver. + NativeLibrary.InitializeGpuDriver(hookLibPath, driverInstallationPath, getCustomDriverLibraryName(), fileRedirectionPath); + } + + public static void installDefaultDriver(Context context) { + // Removing the installed driver will result in the backend using the default system driver. + File driverInstallationDir = new File(driverInstallationPath); + deleteRecursive(driverInstallationDir); + initializeDriverParameters(context); + } + + public static void installCustomDriver(Context context, Uri driverPathUri) { + // Revert to system default in the event the specified driver is bad. + installDefaultDriver(context); + + // Ensure we have directories. + initializeDirectories(); + + // Copy the zip file URI into our private storage. + FileUtil.copyUriToInternalStorage(context, driverPathUri, driverInstallationPath, DRIVER_INTERNAL_FILENAME); + + // Unzip the driver. + try { + unzip(driverInstallationPath + DRIVER_INTERNAL_FILENAME, driverInstallationPath); + } catch (IOException e) { + throw new RuntimeException(e); + } + + // Initialize the driver parameters. + initializeDriverParameters(context); + } + + public static String getCustomDriverName() { + // Parse the custom driver metadata to retrieve the name. + GpuDriverMetadata metadata = new GpuDriverMetadata(driverInstallationPath + META_JSON_FILENAME); + return metadata.name; + } + + private static String getCustomDriverLibraryName() { + // Parse the custom driver metadata to retrieve the library name. + GpuDriverMetadata metadata = new GpuDriverMetadata(driverInstallationPath + META_JSON_FILENAME); + return metadata.libraryName; + } + + private static void initializeDirectories() { + // Ensure the file redirection directory exists. + File fileRedirectionDir = new File(fileRedirectionPath); + if (!fileRedirectionDir.exists()) { + fileRedirectionDir.mkdirs(); + } + // Ensure the driver installation directory exists. + File driverInstallationDir = new File(driverInstallationPath); + if (!driverInstallationDir.exists()) { + driverInstallationDir.mkdirs(); + } + } + + private static void deleteRecursive(File fileOrDirectory) { + if (fileOrDirectory.isDirectory()) { + for (File child : fileOrDirectory.listFiles()) { + deleteRecursive(child); + } + } + fileOrDirectory.delete(); + } +} diff --git a/src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverMetadata.java b/src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverMetadata.java new file mode 100644 index 0000000000..d2bb2dd231 --- /dev/null +++ b/src/android/app/src/main/java/org/yuzu/yuzu_emu/utils/GpuDriverMetadata.java @@ -0,0 +1,45 @@ +package org.yuzu.yuzu_emu.utils; + +import org.json.JSONException; +import org.json.JSONObject; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; + +public class GpuDriverMetadata { + + public String name; + public String description; + public String author; + public String vendor; + public String driverVersion; + public int minApi; + public String libraryName; + + public GpuDriverMetadata(String metadataFilePath) { + try { + JSONObject json = new JSONObject(getStringFromFile(metadataFilePath)); + name = json.getString("name"); + description = json.getString("description"); + author = json.getString("author"); + vendor = json.getString("vendor"); + driverVersion = json.getString("driverVersion"); + minApi = json.getInt("minApi"); + libraryName = json.getString("libraryName"); + } catch (JSONException e) { + // JSON is malformed, ignore and treat as unsupported metadata. + } catch (IOException e) { + // File is inaccessible, ignore and treat as unsupported metadata. + } + } + + private static String getStringFromFile(String filePath) throws IOException { + Path path = Paths.get(filePath); + byte[] bytes = Files.readAllBytes(path); + return new String(bytes, StandardCharsets.UTF_8); + } + +} diff --git a/src/android/app/src/main/res/menu/menu_game_grid.xml b/src/android/app/src/main/res/menu/menu_game_grid.xml index 3eb8cf817d..6211f54942 100644 --- a/src/android/app/src/main/res/menu/menu_game_grid.xml +++ b/src/android/app/src/main/res/menu/menu_game_grid.xml @@ -18,6 +18,11 @@ android:icon="@drawable/ic_install" android:title="@string/install_keys" app:showAsAction="ifRoom" /> + Keys successfully installed Keys file (prod.keys) is invalid + + Select GPU driver + Would you like to replace your current GPU driver? + Install + Default + Installed + Using default GPU driver + Invalid driver selected, using system default! + System GPU driver + Settings General