Add Android testing setup

[atsushieno]

context: #875 (comment) / #897 (comment)

Current Android build setup on Azure DevOps misses testing on Android:

fluidsynth/.azure/azure-pipelines-android.yml

Line 586 in f81caf3

enabled: 'false'

Since the tests that are based on ctest are not simply runnable on Android, we first have to convert existing tests into runnable style in Android manner. A dedicated test runner application would suffice.

As commented on the issue linked above, I came up with such a solution (test generator + runnable setup). A PR will follow and be linked here. So far it lacks the actual Azure DevOps setup, but having a locally runnable test app would be a good starter.

[derselbst]

Interim report

The main problem is that the include and library paths are hardcoded in the CMakeLists.txt:

fluidsynth/test-android/app/src/main/cpp/CMakeLists.txt

Lines 66 to 70 in 92089e0

	../../../../../build_${CMAKE_ANDROID_ARCH_ABI}
	../../../../build-scripts/build-artifacts/include
	../../../../build-scripts/android-build-root/${CMAKE_ANDROID_ARCH_ABI}/opt/android/include
	../../../../build-scripts/android-build-root/${CMAKE_ANDROID_ARCH_ABI}/opt/android/include/glib-2.0
	../../../../build-scripts/android-build-root/${CMAKE_ANDROID_ARCH_ABI}/opt/android/lib/glib-2.0/include

When we build in Azure, the paths are different. To circumvent this, we could use the build-scripts in test-android/build-scripts/. Although this would work, it would still mean to have hard-coded paths and increased maintenance effort, as they always need to be kept in sync with the rest of the build.

Instead, I would like to integrate the android CMake part into our main CMake build system. I've already started this on the android-emulator branch, but it's far from being complete. The idea is that CMake should detect, whether it's compiled for ANDROID or not. If complied for ANDROID, it should directly compile all unit tests into a single .so file, which could then be directly consumed by gradle.

I'll keep working on this from time to time. But it will take some...

[syntaro]

Hello, May I cut in ?

This is my CMakeLists.txt for Android project.
And I have an question with it.

Which version FluidSynth.so is not require glib2.0. Is it in the future?
I am importing glib2.0 and std++ both on it. ...

cmake_minimum_required(VERSION 3.4.1)

project(mylib
        VERSION 1.0
        DESCRIPTION "mylib project"
        LANGUAGES CXX
)

add_library(native-lib SHARED src/main/cpp/native-lib.cpp)

# For more information about using CMake with Android Studio, read the
# documentation: https://d.android.com/studio/projects/add-native-code.html

target_compile_features(native-lib PUBLIC cxx_std_20)

# Create a variable fluidsynth_DIR to specify where the fluidsynth library is located.
set(fluidsynth_DIR C:/github/fluidsynth-2.5.0-android24)

#message(“Architecture1 = ${ANDROID_ABI}")
#message(“Architecture2 = ${CMAKE_ANDROID_ARCH_ABI}")

#find_package(OpenMP REQUIRED)
#set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${OpenMP_C_FLAGS}")
#set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${OpenMP_C_FLAGS}")
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS}")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")

set(NDK_DIR C:/Users/yaman/AppData/Local/Android/Sdk/ndk/android-ndk-r26d)
set(NDK_SUBDIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/17.0.2/lib/linux)

set(NDK_DIR C:/Users/yaman/AppData/Local/Android/Sdk/ndk/28.2.13676358)
set(NDK_SUBDIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/19/lib/linux)

set(NDK_DIR C:/Users/yaman/AppData/Local/Android/Sdk/ndk/27.2.12479018)
set(NDK_SUBDIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/18/lib/linux)

set(NDK_DIR C:/Users/yaman/AppData/Local/Android/Sdk/ndk/29.0.13599879)
set(NDK_SUBDIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/20/lib/linux)

#add_library(libclang_rt SHARED IMPORTED)

if (${ANDROID_ABI} STREQUAL "arm64-v8a")
    set(lib_omp_DIR ${NDK_SUBDIR}/aarch64)
    #set(lib_c_DIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/sysroot/usr/lib/aarch64-linux-android)
    #set_target_properties(libclang_rt PROPERTIES IMPORTED_LOCATION ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/18/lib/linux/libclang_rt.asan-aarch64-android.so)
elseif (${ANDROID_ABI} STREQUAL "armeabi-v7a")
    set(lib_omp_DIR ${NDK_SUBDIR}/arm)
    #set(lib_c_DIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/sysroot/usr/lib/arm-linux-androideabi)
    #set_target_properties(libclang_rt PROPERTIES IMPORTED_LOCATION ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/18/lib/linux/libclang_rt.asan-arm-android.so)
elseif (${ANDROID_ABI} STREQUAL "x86_64")
    set(lib_omp_DIR ${NDK_SUBDIR}/x86_64)
    #set(lib_c_DIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/sysroot/usr/lib/x86_64-linux-android)
    #set_target_properties(libclang_rt PROPERTIES IMPORTED_LOCATION ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/18/lib/linux/libclang_rt.asan-x86_64-android.so)
elseif (${ANDROID_ABI} STREQUAL "x86")
    set(lib_omp_DIR ${NDK_SUBDIR}/i386)
    #set(lib_c_DIR ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/sysroot/usr/lib/i686-linux-android)
    #set_target_properties(libclang_rt PROPERTIES IMPORTED_LOCATION ${NDK_DIR}/toolchains/llvm/prebuilt/windows-x86_64/lib/clang/18/lib/linux/libclang_rt.asan-i686-android.so)
endif ()

# Create a variable lib_other_DIR to specify where the other non-fluidsynth libraries is located.
#set(lib_c_DIR C:/github/android-ndk-r27c/toolchains/llvm/prebuilt/windows-x86_64/sysroot/usr/lib/aarch64-linux-android/)
# set(lib_c_DIR C:/github/back/MixAndCC/app/build/intermediates/cxx/Debug/5ea1y5rp/obj/arm64-v8a)
# Fluidsynth library code will be calling some non-fluidsynth functions which are not part of
# default NDK, so we add the binaries as dependencies of our code.

#add_library(libc++_shared SHARED IMPORTED)
#set_target_properties(libc++_shared PROPERTIES IMPORTED_LOCATION ${lib_c_DIR}/libc++_shared.so)

#add_library(libomp SHARED IMPORTED)
#set_target_properties(libomp PROPERTIES IMPORTED_LOCATION ${lib_omp_DIR}/libomp.so)

# Our code (native-lib.cpp) will be calling fluidsynth functions, so adding the fluidsynth binaries as dependencies.

add_library(libFLAC SHARED IMPORTED)
set_target_properties(libFLAC PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libFLAC.so)

add_library(libfluidsynth SHARED IMPORTED)
set_target_properties(libfluidsynth PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libfluidsynth.so)

add_library(libfluidsynth-assetloader SHARED IMPORTED)
set_target_properties(libfluidsynth-assetloader PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libfluidsynth-assetloader.so)

add_library(libgio-2.0 SHARED IMPORTED)
set_target_properties(libgio-2.0 PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libgio-2.0.so)

add_library(libglib-2.0 SHARED IMPORTED)
set_target_properties(libglib-2.0 PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libglib-2.0.so)

add_library(libgmodule-2.0 SHARED IMPORTED)
set_target_properties(libgmodule-2.0 PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libgmodule-2.0.so)

add_library(libgobject-2.0 SHARED IMPORTED)
set_target_properties(libgobject-2.0 PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libgobject-2.0.so)

add_library(libgthread-2.0 SHARED IMPORTED)
set_target_properties(libgthread-2.0 PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libgthread-2.0.so)

add_library(libinstpatch-1.0 SHARED IMPORTED)
set_target_properties(libinstpatch-1.0 PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libinstpatch-1.0.so)

#find_package(PkgConfig REQUIRED)
#pkg_search_module(GLIB REQUIRED glib-2.0)

target_include_directories(native-lib PRIVATE ${GLIB_INCLUDE_DIRS})
target_link_libraries(native-lib INTERFACE ${GLIB_LDFLAGS})

add_library(liboboe SHARED IMPORTED)
set_target_properties(liboboe PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/liboboe.so)

add_library(libogg SHARED IMPORTED)
set_target_properties(libogg PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libogg.so)

add_library(libopus SHARED IMPORTED)
set_target_properties(libopus PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libopus.so)

add_library(libpcre SHARED IMPORTED)
set_target_properties(libpcre PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libpcre.so)

add_library(libsndfile SHARED IMPORTED)
set_target_properties(libsndfile PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libsndfile.so)

add_library(libvorbis SHARED IMPORTED)
set_target_properties(libvorbis PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libvorbis.so)

add_library(libvorbisenc SHARED IMPORTED)
set_target_properties(libvorbisenc PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libvorbisenc.so)

add_library(libvorbisfile SHARED IMPORTED)
set_target_properties(libvorbisfile PROPERTIES IMPORTED_LOCATION ${fluidsynth_DIR}/lib/${ANDROID_ABI}/libvorbisfile.so)

# Specifies the directory where the C or C++ source code will look the #include <yourlibrary.h> header files
target_include_directories(native-lib PRIVATE ${fluidsynth_DIR}/include)

find_library(ANDROID_LIB android)
list(APPEND PAG_SHARED_LIBS ${ANDROID_LIB})


# Link everything all together. Notice that native-lib should be the first element in the list.
target_link_libraries(
        native-lib
        android
        #libclang_rt
        # Non-fluidsynth binaries
        #libomp
        #libc++_shared
        log

        #Gnu Package
        libgmodule-2.0
        libglib-2.0
        libgobject-2.0
        libgthread-2.0
        libgio-2.0
        libinstpatch-1.0

        # fluidsynth binaries
        libFLAC
        libfluidsynth
        libfluidsynth-assetloader
        liboboe
        libogg
        libopus
        libpcre
        libsndfile
        libvorbis
        libvorbisenc
        libvorbisfile
)

[atsushieno]

If you want "fluidsynth without glib" maybe VolcanoMobile fork is what you want. They seem to keep up to date.

[syntaro]

I see. Thank you but. Not for now.

https://github.com/FluidSynth/fluidsynth/releases
wrote

Support for GLib and libinstpatch is hereby deprecated. They will be removed in 2.6.0.

I thought it was 2.5.0. but it seems not changed. (my native language problem?)
That is why I asked. but no problem.I see, Ill wait 2.6.0.
I wrote about Fluid Synth + Android SDK. some Pages on web. I was wondering when my article will get expired.

And minimum binaries is very good for earth. Thank you.

P.S., atsushieno, I bought your books about MIDI2.0. and thought great system, but I have no time to develop (for solo engineer). too bigest architecture.

[atsushieno]

Oh, I was not aware of such a change in direction. In general, "deprecated" components are not immediately removed. They are kept for a while so that any dependent software can migrate to newer version in soft-landing manner. Making those deprecated stuff optional at build could happen sooner, if not yet. (I myself haven't caught up with recent development.)

P.S., atsushieno, I bought your books about MIDI2.0. and thought great system, but I have no time to develop (for solo engineer). too bigest architecture.

Thank you, that's totally unexpected! What I wrote there is rather the entire ecosystem including platform media API, which you usually don't have to do that by yourself ;-) (excuse us for OT)

[syntaro]

I see.

Thanks to yours and big projects. If I could give people little hints too.

,in my voice, also midi 2.0 will need human resource / few library projects to be major architecture too.

Bow

[neoharp-dev]

re 'Fluidsynth without glib', there is now a PR with threading sync code ported from glib: #1718

It is not decided if it will be meged, though, and is currently left open to allow people to provide feedback. If you are interested in 'Fluidsynth without glib', you might have some feedback to leave there.