Added scripts for creating an AAR package and a local Maven repository with OpenCV library by alexlyulkov · Pull Request #24456 · opencv/opencv

alexlyulkov · 2023-10-26T08:09:00Z

Added scripts for creating an AAR package and a local Maven repository with OpenCV library.

The build_java_shared_aar.py script creates AAR with Java + C++ shared libraries.
The build_static_aar.py script creates AAR with static C++ libraries.

The scripts use an Android project template. The project is almost a default Android AAR library project with empty Java code and one empty C++ library. Only build.gradle.template and CMakeLists.txt.template files contain significant changes.

See README.md for more information.

…tory

asmorkalov · 2023-10-26T14:45:51Z

 platforms/android/aar-creating/build_static_aar.py:119: trailing whitespace.
+        
platforms/android/aar-creating/build_static_aar.py:198: trailing whitespace.
+    
Error: Process completed with exit code 2.

asmorkalov · 2023-10-26T14:47:20Z

I propose to rename aar-creating -> aar-template

asmorkalov · 2023-10-26T15:14:29Z

platforms/android/aar-creating/build_java_shared_aar.py

+    ["sdk/native/libs/<ABI>/libopencv_java4.so", "prefab/modules/opencv_java4/libs/android.<ABI>/libopencv_java4.so"],
+]
+
+ANDROID_PROJECT_TEMPLATE_DIR = "OpenCVAndroidProject"


The script might be executed outside of OpenCV. Please use full path.

Maybe use __file__ constant?

platforms/android/aar-creating/build_static_aar.py

asmorkalov · 2023-10-26T16:43:13Z

platforms/android/aar-creating/build_java_shared_aar.py

+    subprocess.run(["gradlew", "assembleRelease"],
+                shell=True,
+                cwd=ANDROID_PROJECT_DIR)


Please check build status. I get error on the next steps, if something went wrong:

Adding libs to AAR... Traceback (most recent call last): File "./build_java_shared_aar.py", line 92, in <module> main(args.opencv_sdk_path, args.opencv_version) File "./build_java_shared_aar.py", line 60, in main shutil.unpack_archive(COMPILED_AAR_PATH, AAR_UNZIPPED_DIR, "zip") File "/usr/lib/python3.6/shutil.py", line 974, in unpack_archive func(filename, extract_dir, **dict(format_info[2])) File "/usr/lib/python3.6/shutil.py", line 883, in _unpack_zipfile raise ReadError("%s is not a zip file" % filename) shutil.ReadError: build_java_shared/AndroidProject/OpenCV/build/outputs/aar/opencv-release.aar is not a zip file

I probably fixed the problem, please try again

… with 2 package names, minor refactoring

asmorkalov · 2023-10-30T11:10:57Z

python3 /home/alexander/Projects/OpenCV/opencv-master/platforms/android/aar-template/build_java_shared_aar.py /home/alexander/Projects/OpenCV/OpenCV4Android-4.8.1/
Preparing Android project...
Running gradle assembleRelease...
Starting a Gradle Daemon, 1 incompatible Daemon could not be reused, use --status for details

> Configure project :OpenCV
Checking the license for package NDK (Side by side) 25.1.8937393 in /home/alexander/Android2/licenses
License for package NDK (Side by side) 25.1.8937393 accepted.
Preparing "Install NDK (Side by side) 25.1.8937393 (revision: 25.1.8937393)".
"Install NDK (Side by side) 25.1.8937393 (revision: 25.1.8937393)" ready.
Installing NDK (Side by side) 25.1.8937393 in /home/alexander/Android2/ndk/25.1.8937393
"Install NDK (Side by side) 25.1.8937393 (revision: 25.1.8937393)" complete.
"Install NDK (Side by side) 25.1.8937393 (revision: 25.1.8937393)" finished.
Checking the license for package Android SDK Build-Tools 30.0.3 in /home/alexander/Android2/licenses
License for package Android SDK Build-Tools 30.0.3 accepted.
Preparing "Install Android SDK Build-Tools 30.0.3 (revision: 30.0.3)".
"Install Android SDK Build-Tools 30.0.3 (revision: 30.0.3)" ready.
Installing Android SDK Build-Tools 30.0.3 in /home/alexander/Android2/build-tools/30.0.3
"Install Android SDK Build-Tools 30.0.3 (revision: 30.0.3)" complete.
"Install Android SDK Build-Tools 30.0.3 (revision: 30.0.3)" finished.
Checking the license for package Android SDK Platform 33 in /home/alexander/Android2/licenses
License for package Android SDK Platform 33 accepted.
Preparing "Install Android SDK Platform 33 (revision: 3)".
"Install Android SDK Platform 33 (revision: 3)" ready.
Installing Android SDK Platform 33 in /home/alexander/Android2/platforms/android-33
"Install Android SDK Platform 33 (revision: 3)" complete.
"Install Android SDK Platform 33 (revision: 3)" finished.

> Task :OpenCV:compileReleaseJavaWithJavac
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.

BUILD SUCCESSFUL in 2m 45s
39 actionable tasks: 39 executed
Adding libs to AAR...
Creating local maven repo...
Traceback (most recent call last):
  File "/usr/lib/python3.6/shutil.py", line 550, in move
    os.rename(src, real_dst)
FileNotFoundError: [Errno 2] No such file or directory: 'build_java_shared/AndroidProject/OpenCV/build/repo/org/opencv/opencv' -> 'outputs/maven_repo/org/opencv/opencv'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/home/alexander/Projects/OpenCV/opencv-master/platforms/android/aar-template/build_java_shared_aar.py", line 120, in <module>
    main(args.opencv_sdk_path, get_opencv_version(args.opencv_sdk_path))
  File "/home/alexander/Projects/OpenCV/opencv-master/platforms/android/aar-template/build_java_shared_aar.py", line 112, in main
    path.join(FINAL_REPO_PATH, "org/opencv/opencv"))
  File "/usr/lib/python3.6/shutil.py", line 564, in move
    copy_function(src, real_dst)
  File "/usr/lib/python3.6/shutil.py", line 263, in copy2
    copyfile(src, dst, follow_symlinks=follow_symlinks)
  File "/usr/lib/python3.6/shutil.py", line 120, in copyfile
    with open(src, 'rb') as fsrc:
FileNotFoundError: [Errno 2] No such file or directory: 'build_java_shared/AndroidProject/OpenCV/build/repo/org/opencv/opencv'

asmorkalov · 2023-10-30T09:54:19Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/src/main/cpp/CMakeLists.txt.template

@@ -0,0 +1,5 @@
+cmake_minimum_required(VERSION 3.22.1)


Need to reduce required version as low as possible for old NDKs support.

asmorkalov · 2023-10-30T09:54:40Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/build.gradle.template

+    namespace 'org.opencv'
+    compileSdk 33
+
+    defaultConfig {
+        minSdk 21
+        targetSdk 33


To be discussed.

asmorkalov · 2023-10-30T09:54:53Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/build.gradle.template

+    externalNativeBuild {
+        cmake {
+            path file('src/main/cpp/CMakeLists.txt')
+            version '3.22.1'


To be discussed.

asmorkalov · 2023-11-01T12:46:23Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/build.gradle.template

+            groupId = 'org.opencv'
+            artifactId = '${PACKAGE_NAME}'
+            version = '${OPENCV_VERSION}'
+            artifact("opencv-release.aar")


I propose to substitute OpenCV version to the file name.

asmorkalov · 2023-11-01T12:47:31Z

platforms/android/aar-template/build_java_shared_aar.py

+    ["sdk/native/libs/<ABI>/libopencv_java4.so", "jni/<ABI>/libopencv_java4.so"],
+    ["sdk/native/libs/<ABI>/libopencv_java4.so", "prefab/modules/opencv_java4/libs/android.<ABI>/libopencv_java4.so"],


Please use OPENCV_VERSION_MAJOR instead of 4 to prevent issues with 5.x.

asmorkalov · 2023-11-01T12:49:06Z

platforms/android/aar-template/build_java_shared_aar.py

+COMPILED_AAR_PATH_1 = path.join(ANDROID_PROJECT_DIR, "OpenCV/build/outputs/aar/OpenCV-release.aar") # original package name
+COMPILED_AAR_PATH_2 = path.join(ANDROID_PROJECT_DIR, "OpenCV/build/outputs/aar/opencv-release.aar") # lower case package name


Sounds strange. The file name is defined in the project template. Why do you have options here?

For some reason I have different filenames on Windows and Linux. Probably because of different Android SDK versions.

asmorkalov · 2023-11-01T12:51:54Z

platforms/android/aar-template/build_java_shared_aar.py

+    ["sdk/java/res", "OpenCV/src/main/res"]
+]
+
+ABIS = ["arm64-v8a", "armeabi-v7a", "x86", "x86_64"] # if you want to change it, you also need to change Android project template


I propose to build the list of ABIs from SDK content by listing sdk/native/libs. User may build custom SDK for reduced list of architectures. Also I do not see platforms definition in the Android project template.

asmorkalov · 2023-11-01T12:52:36Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/src/main/cpp/include/temp.h

I propose to add brief comment to the file why it's empty.

asmorkalov · 2023-11-01T12:52:45Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/src/main/cpp/native-lib.cpp

The same about empty file.

asmorkalov · 2023-11-01T12:56:53Z

platforms/android/aar-template/OpenCVAndroidProject/OpenCV/.gitignore

It's not required. It's not recommend to build OpenCV inside source tree.

asmorkalov · 2023-11-01T12:58:55Z

platforms/android/aar-template/build_java_shared_aar.py

+COMPILED_AAR_PATH_1 = path.join(ANDROID_PROJECT_DIR, "OpenCV/build/outputs/aar/OpenCV-release.aar") # original package name
+COMPILED_AAR_PATH_2 = path.join(ANDROID_PROJECT_DIR, "OpenCV/build/outputs/aar/opencv-release.aar") # lower case package name
+AAR_UNZIPPED_DIR = "build_java_shared/aar_unzipped"
+FINAL_AAR_PATH = "outputs/opencv_java_shared.aar"


Add version to the file name.

asmorkalov · 2023-11-01T12:59:52Z

platforms/android/aar-template/build_java_shared_aar.py

+    print("Creating local maven repo...")
+
+    shutil.copy(FINAL_AAR_PATH, path.join(ANDROID_PROJECT_DIR, "OpenCV/opencv-release.aar"))
+    subprocess.run(["sh", "gradlew", "publishReleasePublicationToMyrepoRepository"],


let's set executable flag to gradlew and remove sh from command line.

asmorkalov · 2023-11-01T13:03:08Z

Common proposals:

Extract minSdkversion, buildSDK version, CMake version, etc from template and make them command line variables. It allows to build custom aars for newer Android and has different CI configs in different branches.
Move both python scripts from aar-template to just platforms/android and make them executable.

…stomization using cmd arguments, added previous data removing on initialization, other minor changes

asmorkalov

👍

asmorkalov · 2023-11-03T13:02:42Z

@mshabunin @opencv-alalek please review too.

mshabunin · 2023-11-07T11:24:06Z

platforms/android/build_java_shared_aar.py

@@ -0,0 +1,156 @@
+#!/usr/bin/env python


Suggested change

#!/usr/bin/env python

#!/usr/bin/env python3

I'd suggest using pathlib for all path/file related operations (https://docs.python.org/3.8/library/pathlib.html#correspondence-to-tools-in-the-os-module).
We support python 3.8+, do we?

mshabunin · 2023-11-07T11:29:32Z

platforms/android/build_static_aar.py

@@ -0,0 +1,229 @@
+#!/usr/bin/env python


At first glance this file seem to repeat build_java_shared_aar.py in many aspects, is it possible to join these files into a single script with --static/--dynamic flag?

Updated Android samples for modern Android studio. Added OpenCV from Maven support. #24473 Updated samples for recent Android studio: - added namespace field that is required in build.gradle files - replaced _switch_ by _if-else_ because it doesn't work with constants from resources - added missed log library dependency in face-detection/jni/CMakeLists.txt - use local.properties to define NDK location Added support for OpenCV from Maven. Now you can choose 3 possible sources of OpenCV lib in settings.gradle: SDK path, local Maven repository, public Maven repository. (Creating Maven repository from SDK is added here #24456 ) There are differences in project configs for SDK and Maven versions: - different dependencies in build.gradle - different OpenCV library names in CMakeLists.txt - SDK version requires OpenCV_DIR definition Requires: - opencv/ci-gha-workflow#124 - opencv-infrastructure/opencv-gha-dockerfile#26

Added scripts for creating an AAR package and a local Maven repository with OpenCV library opencv#24456 Added scripts for creating an AAR package and a local Maven repository with OpenCV library. The build_java_shared_aar.py script creates AAR with Java + C++ shared libraries. The build_static_aar.py script creates AAR with static C++ libraries. The scripts use an Android project template. The project is almost a default Android AAR library project with empty Java code and one empty C++ library. Only build.gradle.template and CMakeLists.txt.template files contain significant changes. See README.md for more information.

Updated Android samples for modern Android studio. Added OpenCV from Maven support. opencv#24473 Updated samples for recent Android studio: - added namespace field that is required in build.gradle files - replaced _switch_ by _if-else_ because it doesn't work with constants from resources - added missed log library dependency in face-detection/jni/CMakeLists.txt - use local.properties to define NDK location Added support for OpenCV from Maven. Now you can choose 3 possible sources of OpenCV lib in settings.gradle: SDK path, local Maven repository, public Maven repository. (Creating Maven repository from SDK is added here opencv#24456 ) There are differences in project configs for SDK and Maven versions: - different dependencies in build.gradle - different OpenCV library names in CMakeLists.txt - SDK version requires OpenCV_DIR definition Requires: - opencv/ci-gha-workflow#124 - opencv-infrastructure/opencv-gha-dockerfile#26

Added scripts for creating an AAR package and a local Maven repository with OpenCV library opencv#24456 Added scripts for creating an AAR package and a local Maven repository with OpenCV library. The build_java_shared_aar.py script creates AAR with Java + C++ shared libraries. The build_static_aar.py script creates AAR with static C++ libraries. The scripts use an Android project template. The project is almost a default Android AAR library project with empty Java code and one empty C++ library. Only build.gradle.template and CMakeLists.txt.template files contain significant changes. See README.md for more information.

Updated Android samples for modern Android studio. Added OpenCV from Maven support. opencv#24473 Updated samples for recent Android studio: - added namespace field that is required in build.gradle files - replaced _switch_ by _if-else_ because it doesn't work with constants from resources - added missed log library dependency in face-detection/jni/CMakeLists.txt - use local.properties to define NDK location Added support for OpenCV from Maven. Now you can choose 3 possible sources of OpenCV lib in settings.gradle: SDK path, local Maven repository, public Maven repository. (Creating Maven repository from SDK is added here opencv#24456 ) There are differences in project configs for SDK and Maven versions: - different dependencies in build.gradle - different OpenCV library names in CMakeLists.txt - SDK version requires OpenCV_DIR definition Requires: - opencv/ci-gha-workflow#124 - opencv-infrastructure/opencv-gha-dockerfile#26

Added scripts for creating an AAR package and a local Maven repository with OpenCV library opencv#24456 Added scripts for creating an AAR package and a local Maven repository with OpenCV library. The build_java_shared_aar.py script creates AAR with Java + C++ shared libraries. The build_static_aar.py script creates AAR with static C++ libraries. The scripts use an Android project template. The project is almost a default Android AAR library project with empty Java code and one empty C++ library. Only build.gradle.template and CMakeLists.txt.template files contain significant changes. See README.md for more information.

Updated Android samples for modern Android studio. Added OpenCV from Maven support. opencv#24473 Updated samples for recent Android studio: - added namespace field that is required in build.gradle files - replaced _switch_ by _if-else_ because it doesn't work with constants from resources - added missed log library dependency in face-detection/jni/CMakeLists.txt - use local.properties to define NDK location Added support for OpenCV from Maven. Now you can choose 3 possible sources of OpenCV lib in settings.gradle: SDK path, local Maven repository, public Maven repository. (Creating Maven repository from SDK is added here opencv#24456 ) There are differences in project configs for SDK and Maven versions: - different dependencies in build.gradle - different OpenCV library names in CMakeLists.txt - SDK version requires OpenCV_DIR definition Requires: - opencv/ci-gha-workflow#124 - opencv-infrastructure/opencv-gha-dockerfile#26

Alexander Lyulkov and others added 5 commits August 3, 2023 15:13

added scripts for creating Android AAR library and local Maven reposi…

be9088a

…tory

removed unused files

e47c5a6

Added FLATBUFFERS ignoring, added more comments

1101477

Update README.md

885242d

Update README.md

80f25c5

alexlyulkov requested a review from asmorkalov October 26, 2023 08:09

alexlyulkov added 2 commits October 26, 2023 15:13

Update README.md

a2b227d

Update README.md

3477019

asmorkalov added category: build/install platform: android labels Oct 26, 2023

asmorkalov reviewed Oct 26, 2023

View reviewed changes

asmorkalov added this to the 4.9.0 milestone Oct 26, 2023

Alexander Lyulkov added 3 commits October 27, 2023 10:43

Fixed problem with gradlew execution permission denied, fixed problem…

9a50beb

… with 2 package names, minor refactoring

renamed aar-creating to aar-template

384fdbf

added OpenCV version extraction from sdk directory

6247c5f

asmorkalov reviewed Oct 30, 2023

View reviewed changes

alexlyulkov mentioned this pull request Oct 31, 2023

Updated Android samples for modern Android studio. Added OpenCV from Maven support. #24473

Merged

asmorkalov reviewed Nov 1, 2023

View reviewed changes

Alexander Lyulkov added 3 commits November 3, 2023 09:52

Changed java,sdk,cmake versions to the values from SDK, added more cu…

88a28f6

…stomization using cmd arguments, added previous data removing on initialization, other minor changes

moved aar scripts tor platforms/android

83fe965

added execute permissions to the aar scripts and the aar project gradlew

937a014

asmorkalov approved these changes Nov 3, 2023

View reviewed changes

asmorkalov requested review from mshabunin and opencv-alalek November 3, 2023 13:02

asmorkalov merged commit 30549d6 into opencv:4.x Nov 7, 2023

mshabunin reviewed Nov 7, 2023

View reviewed changes

This was referenced Dec 4, 2023

Android install aar #16454

Closed

make the Android Studio integration easier #17100

Closed

asmorkalov mentioned this pull request Dec 21, 2023

Build Javadoc and source package together with AAR #24738

Closed

6 tasks

opencv-alalek removed their request for review December 26, 2023 20:45

asmorkalov mentioned this pull request Jan 19, 2024

5.x merge 4.x #24862

Merged

		["sdk/native/libs/<ABI>/libopencv_java4.so", "jni/<ABI>/libopencv_java4.so"],
		["sdk/native/libs/<ABI>/libopencv_java4.so", "prefab/modules/opencv_java4/libs/android.<ABI>/libopencv_java4.so"],

		COMPILED_AAR_PATH_1 = path.join(ANDROID_PROJECT_DIR, "OpenCV/build/outputs/aar/OpenCV-release.aar") # original package name
		COMPILED_AAR_PATH_2 = path.join(ANDROID_PROJECT_DIR, "OpenCV/build/outputs/aar/opencv-release.aar") # lower case package name

Uh oh!

Conversation

alexlyulkov commented Oct 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

asmorkalov commented Oct 26, 2023

Uh oh!

asmorkalov commented Oct 26, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexlyulkov Oct 26, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asmorkalov commented Oct 30, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

asmorkalov commented Nov 1, 2023

Uh oh!

asmorkalov left a comment

Choose a reason for hiding this comment

Uh oh!

asmorkalov commented Nov 3, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alexlyulkov commented Oct 26, 2023 •

edited

Loading

alexlyulkov Oct 26, 2023 •

edited

Loading