Update to Cubism 5 SDK for Java R4

Author: wada-at-live2d-com

CHANGELOG.md

@@ -5,6 +5,30 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 
+## [5-r.4] - 2025-05-15
+
+### Added
+
+* Add an API to `CubismMotionJson` for verifying the consistency of `motion3.json`.
+* Add a flag to the arguments of the following methods to enable the function that verifies the consistency of `motion3.json`:
+  * `CubismUserModel.loadMotion()`
+  * `CubismMotion.create()`
+  * `CubismMotion.parse()`
+* Add parameter repeat processing that connects the right and left ends of the parameter to create a loop, allowing the motion to repeat.
+  * Add the variable `isOverriddenParameterRepeat` to the `CubismModel` class for managing parameter repeat flags at the model level.
+  * Add the variable `userParameterRepeatDataList` to the `CubismModel` class for managing parameter repeat flags for each parameter.
+* Add a `getPartParentPartIndices()` function.
+
+### Changed
+
+* Change the access level of the private members in the `CubismModelSettingJson` class to protected.
+* Change the default JDK version for compilation to 17 using Gradle's Java toolchain.
+
+### Fixed
+
+* Fix an issue in the `CubismPose` class where the opacity calculation for non-displayed parts differed from the implementation in the other Cubism SDK.
+
+
 ## [5-r.3] - 2025-02-18
 
 ### Added
@@ -52,6 +76,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ### Changed
 
+* Change an expression "overwrite" to "override" for multiply color, screen color, and culling to adapt the actual behavior.
 * Change the access level of `CubismMotionJson` class to public.
 * Change the threshold for enabling anisotropic filtering.
 
@@ -239,6 +264,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * New released!
 
 
+[5-r.4]: https://github.com/Live2D/CubismJavaFramework/compare/5-r.3...5-r.4
 [5-r.3]: https://github.com/Live2D/CubismJavaFramework/compare/5-r.2...5-r.3
 [5-r.2]: https://github.com/Live2D/CubismJavaFramework/compare/5-r.1...5-r.2
 [5-r.1]: https://github.com/Live2D/CubismJavaFramework/compare/5-r.1-beta.3...5-r.1

framework/build.gradle

@@ -28,6 +28,12 @@ android {
     }
 }
 
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(17)
+    }
+}
+
 dependencies {
     compileOnly(fileTree(dir: '../../Core/android', include: ['Live2DCubismCore.aar']))
 

framework/src/main/java/com/live2d/sdk/cubism/framework/CubismModelSettingJson.java

@@ -324,7 +324,7 @@ public CubismId getLipSyncParameterId(int index) {
     /**
      * Enum class for frequent nodes.
      */
-    private enum FrequentNode {
+    protected enum FrequentNode {
         GROUPS(0),
         MOC(1),
         MOTIONS(2),
@@ -335,14 +335,14 @@ private enum FrequentNode {
         POSE(7),
         HIT_AREAS(8);
 
-        private final int id;
+        protected final int id;
 
         FrequentNode(final int id) {
             this.id = id;
         }
     }
 
-    private enum JsonKey {
+    protected enum JsonKey {
         VERSION("Version"),
         FILE_REFERENCES("FileReferences"),
         GROUPS("Groups"),
@@ -392,7 +392,7 @@ private enum JsonKey {
         INIT_PARTS_VISIBLE("init_parts_visible"),
         VAL("val");
 
-        private final String key;
+        protected final String key;
 
         JsonKey(String key) {
             this.key = key;
@@ -401,71 +401,71 @@ private enum JsonKey {
 
 
     // キーが存在するかどうかのチェック
-    private boolean existsModelFile() {
+    protected boolean existsModelFile() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.MOC.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsTextureFiles() {
+    protected boolean existsTextureFiles() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.TEXTURES.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsHitAreas() {
+    protected boolean existsHitAreas() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.HIT_AREAS.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsPhysicsFile() {
+    protected boolean existsPhysicsFile() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.PHYSICS.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsPoseFile() {
+    protected boolean existsPoseFile() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.POSE.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsDisplayInfoFile() {
+    protected boolean existsDisplayInfoFile() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.DISPLAY_INFO.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsExpressionFile() {
+    protected boolean existsExpressionFile() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.EXPRESSIONS.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsMotionGroups() {
+    protected boolean existsMotionGroups() {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.MOTIONS.id);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsMotionGroupName(String groupName) {
+    protected boolean existsMotionGroupName(String groupName) {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.MOTIONS.id).get(groupName);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsMotionSoundFile(String groupName, int index) {
+    protected boolean existsMotionSoundFile(String groupName, int index) {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.MOTIONS.id).get(groupName).get(index).get(JsonKey.SOUND_PATH.key);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsMotionFadeIn(String groupName, int index) {
+    protected boolean existsMotionFadeIn(String groupName, int index) {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.MOTIONS.id).get(groupName).get(index).get(JsonKey.FADE_IN_TIME.key);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsMotionFadeOut(String groupName, int index) {
+    protected boolean existsMotionFadeOut(String groupName, int index) {
         ACubismJsonValue node = jsonFrequencyValue.get(FrequentNode.MOTIONS.id).get(groupName).get(index).get(JsonKey.FADE_OUT_TIME.key);
         return !node.isNull() && !node.isError();
     }
 
-    private boolean existsUserDataFile() {
+    protected boolean existsUserDataFile() {
         return !json.getRoot().get(JsonKey.FILE_REFERENCES.key).get(JsonKey.USER_DATA.key).isNull();
     }
 
-    private boolean existsEyeBlinkParameters() {
+    protected boolean existsEyeBlinkParameters() {
         if (jsonFrequencyValue.get(FrequentNode.GROUPS.id).isNull() || jsonFrequencyValue.get(FrequentNode.GROUPS.id).isError()) {
             return false;
         }
@@ -479,7 +479,7 @@ private boolean existsEyeBlinkParameters() {
         return false;
     }
 
-    private boolean existsLipSyncParameters() {
+    protected boolean existsLipSyncParameters() {
         if (jsonFrequencyValue.get(FrequentNode.GROUPS.id).isNull() || jsonFrequencyValue.get(FrequentNode.GROUPS.id).isError()) {
             return false;
         }
@@ -495,9 +495,9 @@ private boolean existsLipSyncParameters() {
     /**
      * model3.json data
      */
-    private final CubismJson json;
+    protected final CubismJson json;
     /**
      * Frequent nodes in the _json data
      */
-    private List<ACubismJsonValue> jsonFrequencyValue;
+    protected List<ACubismJsonValue> jsonFrequencyValue;
 }

framework/src/main/java/com/live2d/sdk/cubism/framework/effect/CubismPose.java

@@ -339,7 +339,7 @@ private float calcNonDisplayedPartsOpacity(float currentOpacity, final float new
         float a1; // opacity to be calculated
         if (newOpacity < PHI) {
             // Linear equation passing through (0,1),(PHI,PHI)
-            a1 = newOpacity * (PHI - 1.0f) / (PHI + 1.0f);
+            a1 = newOpacity * (PHI - 1) / PHI + 1.0f;
         } else {
             a1 = (1 - newOpacity) * PHI / (1.0f - PHI);
         }

framework/src/main/java/com/live2d/sdk/cubism/framework/math/CubismMath.java

@@ -16,6 +16,16 @@ public class CubismMath {
     public static final float PI = 3.1415926535897932384626433832795f;
     public static final float EPSILON = 0.00001f;
 
+    public static float clampF(float val, float min, float max) {
+        if (val < min) {
+            return min;
+        } else if (max < val) {
+            return max;
+        }
+
+        return val;
+    }
+
     /**
      * Returns the value of the first argument in the range of minimum and maximum values.
      *