[WIP] Android build #88

ciciplusplus · 2023-03-21T22:54:21Z

What is this all about?

This is a WIP Android build, supporting aarch64 devices

What was tested?

~~Super Monkey Ball 1.02 on Google Pixel 3a (playable, but tilt controls not working, so not that playable)~~ All supported apps (fully playable!)
touchHLE build for macOS (builds, runs)

I've not tested Windows version after the changes

How to use

Refer to BUILDING.md in android folder for building instruction.

IMPORTANT: in the current state Android app expects a particular setup for file folder to work.
In particular, /data/data/org.touchhle.android/files folder on your device should contain:

~~Super Monkey Ball v1.02 .ipa (legally obtained and owned; note 2 spaces between Ball and v1.02)~~ a touchHLE_apps folder with your apps
touchHLE_fonts and touchHLE_dylibs folders from touchHLE source or binary distribution

Important changes

Introduction of android project, which is a copy of SDL2 2.26.4 android template project with small modifications (zlib LICENSE.txt file, cargo-ndk plugin and some cosmetic changes)
~~main.rs is split now to lib.rs (android build) and main.rs (desktop build)~~
passing from [bundled, static-link] mode to [bundled] for sdl2 dependency
~~introducing OpenGL ES 1.1 native implementation~~
Android app has org.touchhle.android bundle
SDL source is added to vendor/ folder, used only for Android build

Known issues

~~No mechanism for app/ipa selection/loading~~
~~Tilt controls are not implemented~~
Splash screen is disabled
~~App scale/orientation is hardcoded~~
Only arm64-v8a arch is supported
~~SDL is built twice: once with rust-sdl2 and once specifically for Android~~
SDL 2.26.6 version was patched here (and as consequence sdl2-rust as well) to workaround SDL build issue with ANDROID_NDK not set... Something is wrong here on one of the crate among cmake, cargo-ndk, sdl2-rust or cargo itself, as locally I can do build SDL from sources (and it's also done during gradle build). Maybe it's related to the changes of Android tooling itself. Or maybe it's cmake config of SDL2 which is wrong. Or...
Some GL functions in update_renderbuffers do not have equivalents in Gles 1.1, so i just commented them out. While I've not observed any visible glitches, the cleaning/restoring of gl context may not work perfectly here.
Logging with println!() is not working. Normally, with android_log it should be redirected to logcat, but, firstly, log dependency of it conflicts with internal log module and, secondly, even if fixed, it's still not working. At the brighter side, sdl2::log works, so all log!() calls using it instead

References

P.S.

Hope that my monkey patching (pun intended) it's not too big to review 😸

…f0cbde4cb3802d87fa (as advised for "complex projects" here https://github.com/libsdl-org/SDL/blob/release-2.26.4/docs/README-android.md)

(this is needed for Android build)

we now build SDL twice: once under rust-sdl2 and second time for Android from source

- switch to rust-sdl2 version where hidapi wasn't removed - remove CmakeFiles

- Cherry pick 981e206 with small modification to work on both Android and macOS - Remove unused code

…ps://raw.githubusercontent.com/libsdl-org/SDL/release-2.26.x/LICENSE.txt

hikari-no-yume · 2023-03-21T22:57:24Z

Congratulations on getting this in a good enough state to open a pull request? And thanks for your efforts on this, I know it's been a lot of work!

To others: please do not comment on this PR asking when this will be merged, thanks in advance.

ciciplusplus · 2023-03-25T16:54:27Z

Congratulations on getting this in a good enough state to open a pull request? And thanks for your efforts on this, I know it's been a lot of work!

Thanks and sorry, in case it wasn't clear, I think it's ready to be reviewed.

It would be great to receive at least high level feedback, like which parts are absolutely necessary to be reworked and which are ok to merge in the current state.

src/cpu/dynarmic_wrapper/build.rs

src/frameworks/opengles.rs

hikari-no-yume · 2023-04-03T20:28:04Z

src/frameworks/opengles/eagl.rs

+/// Variant of present_renderbuffer but for Android
+/// Instead of blitting between framebuffers, we use CopyTexImage2D to copy renderbuffers to a texture
+/// TODO: refactor common parts with present_renderbuffer
+#[cfg(target_os = "android")]


I'm not sure how realistic this is, but can we share most of the code rather than duplicating the whole function?

Well, I see 2 possibilities:

use present_renderbuffer's platform specific versions

have single function filled with platform specific branching inside function body

I opted for first one for the sake of readability, but can try to implement second option if you think it's preferable

Oh wait I forgot that it bypasses the API abstraction, so it is actually API-specific right now :(

I guess this conflicts with what I said above about wanting GLES1Native to be available on desktop. Okay, I guess we'll leave it as-is for now and we can clean it up later.

src/fs.rs

android/app/src/main/java/org/libsdl/app/HIDDeviceBLESteamController.java

This re-uses the fullscreen mode to fix the positioning and scaling issues, and adds Android-specific code to handle rotation.

I reworked things a bit when merging to minimize the diff from trunk.

This might save some compilation time?

This is derived from ciciplusplus's commit a768067 but has a number of changes.

I refuse to commit huge scripts and binaries I didn't write, and which don't have license headers, to git. That gradle is hard to use without them is gradle's problem.

ciciplusplus and others added 22 commits March 16, 2023 00:23

WIP buildable lib for android

328312b

first working android version!

8e7956d

Copy of android-project from SDL 2.26.4 commit 07d0f51fa292895443f563…

1a2135f

…f0cbde4cb3802d87fa (as advised for "complex projects" here https://github.com/libsdl-org/SDL/blob/release-2.26.4/docs/README-android.md)

SDL2 as submodule

03035ab

(this is needed for Android build)

WIP build SDL in android studio

da94f17

WIP proper android build

5894d0c

we now build SDL twice: once under rust-sdl2 and second time for Android from source

Cleaning 1:

1c0c3d7

- switch to rust-sdl2 version where hidapi wasn't removed - remove CmakeFiles

Revert logg change

d2a4c40

WIP conditionals for android platform

c0218be

Cleaning 2: remove Gles31

e6f0d93

WIP introduce gles1_native

b288f32

present_renderbuffer for Android

ddda95c

remove useless assezt

aef8036

More Android specific confitionals

faedf83

- Use update version of SDL 2.26.4 (with a ANDROID_NDK hack)

9c91ce9

- Cherry pick 981e206 with small modification to work on both Android and macOS - Remove unused code

Default for android SMB

f0387dd

Separate lib.rs and main.rs

e3c2f3c

Add building instructions

92cb0be

More cleanup + LICENSE file for android, copied from SDL2 sources htt…

412c5f1

…ps://raw.githubusercontent.com/libsdl-org/SDL/release-2.26.x/LICENSE.txt

cargo fmt

7bc01ba

cargo clippy

9d09e6f

Merge branch 'trunk' into android

9a4e97c

ciciplusplus marked this pull request as ready for review March 21, 2023 23:30

hikari-no-yume reviewed Apr 3, 2023

View reviewed changes

src/cpu/dynarmic_wrapper/build.rs Outdated Show resolved Hide resolved

hikari-no-yume reviewed Apr 3, 2023

View reviewed changes

src/frameworks/opengles.rs Outdated Show resolved Hide resolved

hikari-no-yume reviewed Apr 3, 2023

View reviewed changes

src/fs.rs Outdated Show resolved Hide resolved

hikari-no-yume reviewed Apr 3, 2023

View reviewed changes

android/app/src/main/java/org/libsdl/app/HIDDeviceBLESteamController.java Outdated Show resolved Hide resolved

hikari-no-yume added 3 commits April 8, 2023 15:26

Restore dynamic linking when building for Android

2b27a64

Merge branch 'trunk' into android

2f052ab

Disable x86_64 Android build

258c41b

hikari-no-yume force-pushed the android branch from 509096d to 258c41b Compare April 17, 2023 21:09

Merge branch 'trunk' into android

176ae2d

ciciplusplus force-pushed the android branch from aa47380 to 176ae2d Compare April 21, 2023 21:15

hikari-no-yume added 11 commits April 27, 2023 15:39

Merge branch 'trunk' into android (replaces OpenGL ES implementation)

1149e3d

Fix screen positioning, scaling and rotation on Android

c251c72

This re-uses the fullscreen mode to fix the positioning and scaling issues, and adds Android-specific code to handle rotation.

Merge branch 'trunk' into android (lib/bin split, echo! macro)

ac3be7c

I reworked things a bit when merging to minimize the diff from trunk.

Only compile lib when building for Android

a43199f

This might save some compilation time?

Merge branch 'trunk' into android

85566b4

Use app picker on Android instead of a hardcoded app name

bc7eb35

Build SDL only once, in Rust (sdl2-sys)

78f38a8

This is derived from ciciplusplus's commit a768067 but has a number of changes.

Move -lOpenSLES to OpenAL Soft build script

ca7c0d9

Make release builds debuggable to allow file transfer

d50201c

Remove unnecessary Android theme files, name app "touchHLE"

9e9e441

Prevent CMake dir reuse to fix weird macOS Android build issues

5948574

hikari-no-yume force-pushed the android branch from 0a23c30 to 5948574 Compare May 6, 2023 13:02

hikari-no-yume added 2 commits May 6, 2023 15:21

Remove useless proguard rules file

3de8c3e

Remove gradle wrapper

eedb1e3

I refuse to commit huge scripts and binaries I didn't write, and which don't have license headers, to git. That gradle is hard to use without them is gradle's problem.

hikari-no-yume force-pushed the android branch from 3addfe7 to eedb1e3 Compare May 6, 2023 18:35

hikari-no-yume added 6 commits May 6, 2023 20:53

Bump minSdkVersion to 21 since that was de-facto used anyway

d3ecb66

Clarify licensing (per-file license header)

a7a42c7

Sync Application.mk with build.gradle (does this mean anything?)

9bff221

Reformat gradle files

b75a805

Use a different fix for rust-sdl2 Android build issues

56d9c06

Final cleanups, documentation updates etc before Android merge

3c517a3

hikari-no-yume closed this in b7792fa May 6, 2023

touchHLE deleted a comment from Boom20230908 Oct 7, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] Android build #88

[WIP] Android build #88

ciciplusplus commented Mar 21, 2023 •

edited

hikari-no-yume commented Mar 21, 2023

ciciplusplus commented Mar 25, 2023

hikari-no-yume Apr 3, 2023

ciciplusplus Apr 3, 2023

hikari-no-yume Apr 5, 2023

[WIP] Android build #88

[WIP] Android build #88

Conversation

ciciplusplus commented Mar 21, 2023 • edited

What is this all about?

What was tested?

How to use

Important changes

Known issues

References

P.S.

hikari-no-yume commented Mar 21, 2023

ciciplusplus commented Mar 25, 2023

hikari-no-yume Apr 3, 2023

Choose a reason for hiding this comment

ciciplusplus Apr 3, 2023

Choose a reason for hiding this comment

hikari-no-yume Apr 5, 2023

Choose a reason for hiding this comment

ciciplusplus commented Mar 21, 2023 •

edited