[v3.8.5] Reduce package size for spine module #17783

dumganhar · 2024-10-29T08:44:03Z

■3.8.4
-rw-r--r-- 1 james staff 653581 Oct 11 14:08 spine.asm.js
-rw-r--r-- 1 james staff 57346 Oct 11 14:08 spine.js.mem
-rwxr-xr-x 1 james staff 351821 Oct 11 14:08 spine.wasm
-rw-r--r-- 1 james staff 56455 Oct 11 14:08 spine.wasm.js
■3.8.5
-rw-r--r--@ 1 james staff 377837 Nov 1 06:36 spine.asm.js ( save 42% )
-rw-r--r--@ 1 james staff 19563 Nov 1 06:36 spine.js.mem （ save 65%）
-rwxr-xr-x@ 1 james staff 198881 Nov 1 06:36 spine.wasm ( save 43%）
-rw-r--r--@ 1 james staff 21944 Nov 1 06:36 spine.wasm.js （save 61%）

Changelog

Continuous Integration

This pull request:

needs automatic test cases check.

Manual trigger with @cocos-robot run test cases afterward.
does not change any runtime related code or build configuration

If any reviewer thinks the CI checks are needed, please uncheck this option, then close and reopen the issue.

Compatibility Check

This pull request:

changes public API, and have ensured backward compatibility with deprecated features.
affects platform compatibility, e.g. system version, browser version, platform sdk version, platform toolchain, language version, hardware compatibility etc.
affects file structure of the build package or build configuration which requires user project upgrade.
introduces breaking changes, please list all changes, affected features and the scope of violation.

native/cocos/editor-support/spine/Extension.cpp

minggo · 2024-11-01T06:31:06Z

native/cocos/editor-support/spine/IkConstraintData.h

@@ -39,6 +39,7 @@ namespace spine {
 class BoneData;

 class SP_API IkConstraintData : public ConstraintData {
+    RTTI_DECL


Why need it?

Because we don't want the default c++ rtti support which will make the package size 20KB bigger.
Spine has already provoided RTTI strategy, so we use RTTI_DECL/RTTI_IMPL to mark the classes that need the RTTI information. RTTI information is used in getting a unique type id for a instance which like c++ typeid(*pointer).

With the RTTI information, a c++ function return a Base pointer which points a Sub instance will be downcast to Sub JS object in emscripten layer. Otherwise, without the RTTI info, in JS layer, we only could see Base class.

// c++

class Base {}; class Sub {}; class Foo { Base* getBase() { return new Sub(); } };

// js

const instance = foo.getBase(); // it's a Base instance without RTTI info, but in fact, it should be seen as a `Sub` instance.

minggo · 2024-11-01T06:32:55Z

native/cocos/editor-support/spine/MathUtil.cpp

-}
+RTTI_IMPL_NOPARENT(Interpolation)
+RTTI_IMPL(PowInterpolation, Interpolation)
+RTTI_IMPL(PowOutInterpolation, Interpolation)


Why need it?

Explained above.

native/cocos/editor-support/spine/TransformConstraint.h

dumganhar · 2024-11-05T06:37:35Z

native/cocos/editor-support/spine-wasm/spine-type-export.cpp

+
+#define ENABLE_EMBIND_TEST 0
+
+#if ENABLE_EMBIND_TEST


Add some embind test and disable it by default.

dumganhar · 2024-11-05T06:54:14Z

native/cocos/editor-support/spine/Atlas.cpp

@@ -51,7 +51,7 @@ Atlas::Atlas(const String &path, TextureLoader *textureLoader, bool createTextur
    const char *lastSlash = lastForwardSlash > lastBackwardSlash ? lastForwardSlash : lastBackwardSlash;
    if (lastSlash == path) lastSlash++; /* Never drop starting slash. */
    dirLength = (int)(lastSlash ? lastSlash - path.buffer() : 0);
-    dir = SpineExtension::calloc<char>(dirLength + 1, __FILE__, __LINE__);
+    dir = SpineExtension::calloc<char>(dirLength + 1, __SPINE_FILE__, __SPINE_LINE__);


SPINE_FILE is defined to empty string for emscripten build. That will save some bytes.

dumganhar · 2024-11-05T06:57:09Z

native/cocos/editor-support/spine/Bone.cpp

-    _a *= _skeleton.getScaleX();
-    _b *= _skeleton.getScaleX();
-    _c *= _skeleton.getScaleY();
-    _d *= _skeleton.getScaleY();


Refactor Bone::updateWorldTransform, save some directives by invoking the getter at the beginning of the function.

dumganhar · 2024-11-05T07:01:01Z

native/cocos/editor-support/spine/Bone.cpp

-}
-
-void Bone::setWorldY(float inValue) {
-    _worldY = inValue;


Move the implementation of getter/setter to header and inline them.
Inlining them could make wasm/asmjs package size smaller and improve performance a little bit.

dumganhar · 2024-11-05T07:02:12Z

native/cocos/editor-support/spine/Constraint.h

@@ -43,8 +43,6 @@ class SP_API Constraint : public Updatable {

    virtual ~Constraint();

-    virtual void update() = 0;


update function was already defined in its parent class Updatable. No need to define it here again.

dumganhar · 2024-11-05T07:11:44Z

native/cocos/editor-support/spine/CurveTimeline.h

@@ -45,8 +45,6 @@ class SP_API CurveTimeline : public Timeline {

    virtual void apply(Skeleton& skeleton, float lastTime, float time, Vector<Event*>* pEvents, float alpha, MixBlend blend, MixDirection direction) = 0;

-    virtual int getPropertyId() = 0;


getPropertyId is defined in Timeline, doesn't need to define the pure virtual function here again.

dumganhar · 2024-11-05T07:13:05Z

native/cocos/editor-support/spine/Json.cpp

+            result |= (c - 'a' + 10);
+        }
+    }
+    return true;


A simpler version of sscanf(ptr + 1, "%4x", &uc); which could make the package size smaller.

dumganhar · 2024-11-05T07:15:12Z

native/cocos/editor-support/spine/Json.cpp

@@ -378,15 +415,15 @@ const char *Json::parseNumber(Json *item, const char *num) {
        }

        while (*ptr >= '0' && *ptr <= '9') {
-            exponent = (exponent * 10.0) + (*ptr - '0');
+            exponent = (exponent * 10) + (*ptr - '0');


*ptr is a value between 0 and 9, exponent could only be an integer. So define it as uint32_t and use integer version of pow funciton (MathUtil::ipow) could make the package size smaller again.

dumganhar · 2024-11-05T07:22:32Z

native/cocos/editor-support/spine/MathUtil.cpp

-float MathUtil::pow(float a, float b) {
-    return (float)::pow(a, b);
-}
+uint64_t MathUtil::ipow(uint64_t base, uint32_t exp) {


Add an integer version of pow function. It's simpler and higher performance than the builtin float version.

dumganhar · 2024-11-05T07:34:12Z

native/cocos/editor-support/spine/MathUtil.h


 namespace spine {

-class SP_API MathUtil : public SpineObject {
+class SP_API MathUtil {


MathUtil doesn't need to be implemented from 'SpineObject'.

…85-spine-aot

dumganhar · 2024-11-05T08:42:44Z

@cocos-robot run test cases

dumganhar · 2024-11-05T09:16:00Z

native/cocos/editor-support/spine/SpineString.h

-        bool same = other._buffer == _buffer;
-        _buffer = SpineExtension::realloc(_buffer, _length + 1, __FILE__, __LINE__);
-        memcpy((void *)(_buffer + thisLen), (void *)(same ? _buffer : other._buffer), len + 1);
-        return *this;


Moving most methods of spine::String to .cpp to avoid inline too many code.

dumganhar · 2024-11-05T09:18:58Z

native/cocos/editor-support/spine/TwoColorTimeline.cpp

-                darkColor.r += (darkColor.r - slot._data.getDarkColor().r) * alpha;
-                darkColor.g += (darkColor.g - slot._data.getDarkColor().g) * alpha;
-                darkColor.b += (darkColor.b - slot._data.getDarkColor().b) * alpha;
+                color.r += (color.r - dataColor.r) * alpha;


Don't invoke getColor, getDarkColor many times.

dumganhar · 2024-11-05T09:23:31Z

native/cocos/editor-support/spine/Vector.h

@@ -72,14 +75,14 @@ class SP_API Vector : public SpineObject {
        return _size;
    }

-    inline void setSize(size_t newSize, const T &defaultValue) {
+    void setSize(size_t newSize, const T &defaultValue) {


Remove inline keyword of function that contains many lines. Let compiler deside whether it should be inlined.

dumganhar · 2024-11-05T09:24:34Z

native/cocos/editor-support/spine/Vector.h

@@ -164,6 +167,12 @@ class SP_API Vector : public SpineObject {
        return _buffer[inIndex];
    }

+    inline const T &operator[](size_t inIndex) const {


Add const version of [] accessor.

github-actions · 2024-11-05T10:15:45Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.5
Task Result: PASS
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/878d4f6f-4c75-4db5-a14e-0a3c40d3aafc/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/11680485802

Task Details

github-actions · 2024-11-05T10:15:46Z

@dumganhar, Please check the result of run test cases:

Test Platform: PR-Test
Editor Version: v3.8.5
Task Result: PASS
Task URL: https://cctest.cocos.org/#/reportview/PR-TEST/53e83654-3fec-4885-b1d9-1e818c3a957c/-1
GitHub Action: https://github.com/cocos/cocos-engine/actions/runs/11680485802

Task Details

dumganhar added 30 commits October 23, 2024 23:13

AOT test

53844c9

Add size_type, value_type for spine::Vector

e150e61

spine::Vector getX/Y should be const functions.

befaa70

spine::Vector getX/Y should be const functions.

83a596e

cleanup spine-wasm/CMakeLists.txt

f8ffec0

Refactor spine-type-export.cpp, remove unused apply binding.

ccb8ddf

Remove extra spine:: namespace in SkeletonData.h

a46a5dd

Update spine-type-export.cpp

93d649b

Don't using namespace in header files.

31445e1

Update spine-wasm/CMakeLists.txt

b7f87e5

Use select_overload

d5f1d86

Bind spine::String, treat it as std::string.

09d6f22

Fix setFrame binding

96d95a8

fix spine::String binding

4d613ae

Move implementation of spine::String to .cpp

de446fd

opt start.

564e677

disable RTTI

c6838d8

update sp[ine-define.ts, don't hack String.

aa9f33e

embind property

0a5d159

Temp

e6a72db

Add ENABLE_JSON_PARSER configuration

4f8aa6c

Update

88e1e61

Update

6fd4e42

Update

5b59d17

Add ENABLE_BINARY_PARSER and fix the binding of addAnimationWith

bf60723

Check whether skin name is valid.

c823316

Use malloc/free to implement WasmSpineExtension.

bf87c3d

update spine_new

865a444

virtual function, isActive, setActive

e130811

fix a typo in spine.-core.d.ts

22b7e19

minggo reviewed Nov 1, 2024

View reviewed changes

native/cocos/editor-support/spine/Extension.cpp Show resolved Hide resolved

minggo reviewed Nov 1, 2024

View reviewed changes

native/cocos/editor-support/spine/TransformConstraint.h Show resolved Hide resolved

Revert wasmSpineExtension.cpp, return nullptr if size is zero.

c6439cc

minggo approved these changes Nov 5, 2024

View reviewed changes

bofeng-song approved these changes Nov 5, 2024

View reviewed changes

dumganhar commented Nov 5, 2024

View reviewed changes

dumganhar added 3 commits November 5, 2024 15:44

Fix memory leak in _realloc if size is zero.

492ae95

Update external

bd05c2b

Merge branch 'v3.8.5' of https://github.com/cocos/cocos-engine into 3…

9247851

…85-spine-aot

dumganhar commented Nov 5, 2024

View reviewed changes

bofeng-song approved these changes Nov 5, 2024

View reviewed changes

dumganhar merged commit 102d05e into cocos:v3.8.5 Nov 5, 2024
26 checks passed

dumganhar mentioned this pull request Dec 15, 2024

[v3.8.5] Fix constructing spine::String with null pointer. #18038

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[v3.8.5] Reduce package size for spine module #17783

[v3.8.5] Reduce package size for spine module #17783

dumganhar commented Oct 29, 2024 •

edited

Loading

minggo Nov 1, 2024

dumganhar Nov 5, 2024 •

edited

Loading

minggo Nov 1, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar commented Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

dumganhar Nov 5, 2024

github-actions bot commented Nov 5, 2024

github-actions bot commented Nov 5, 2024

		@@ -43,8 +43,6 @@ class SP_API Constraint : public Updatable {

		virtual ~Constraint();

		virtual void update() = 0;

		@@ -45,8 +45,6 @@ class SP_API CurveTimeline : public Timeline {

		virtual void apply(Skeleton& skeleton, float lastTime, float time, Vector<Event> pEvents, float alpha, MixBlend blend, MixDirection direction) = 0;

		virtual int getPropertyId() = 0;


		#define ENABLE_EMBIND_TEST 0

		#if ENABLE_EMBIND_TEST

[v3.8.5] Reduce package size for spine module #17783

[v3.8.5] Reduce package size for spine module #17783

Conversation

dumganhar commented Oct 29, 2024 • edited Loading

Changelog

Continuous Integration

Compatibility Check

Choose a reason for hiding this comment

dumganhar Nov 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dumganhar commented Nov 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 5, 2024

Task Details

github-actions bot commented Nov 5, 2024

Task Details

dumganhar commented Oct 29, 2024 •

edited

Loading

dumganhar Nov 5, 2024 •

edited

Loading