Update to Cubism 5 SDK for Native R1 beta4

Author: wada-at-live2d-com

CHANGELOG.md

@@ -5,6 +5,18 @@ 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.1-beta.4] - 2024-01-25
+
+### Fixed
+
+* Fix memory leak in DX11.
+* Fix an issue where models with a specific number of masks could not be drawn correctly.
+* Fix to check for null when reading json.
+* Fix an issue that caused some graphics drivers to not render correctly in Vulkan.
+* Fix errors related to semaphore waiting stages.
+* Fix errors that occurs when building with x86 in vulkan.
+
+
 ## [5-r.1-beta.3] - 2023-10-12
 
 ### Added
@@ -326,6 +338,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Fix invalid expressions of `CubismCdiJson`.
 
 
+[5-r.1-beta.4]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.1-beta.3...5-r.1-beta.4
 [5-r.1-beta.3]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.1-beta.2...5-r.1-beta.3
 [5-r.1-beta.2]: https://github.com/Live2D/CubismNativeFramework/compare/5-r.1-beta.1...5-r.1-beta.2
 [5-r.1-beta.1]: https://github.com/Live2D/CubismNativeFramework/compare/4-r.7...5-r.1-beta.1

src/CubismFramework.cpp

@@ -83,9 +83,9 @@ csmBool CubismFramework::StartUp(ICubismAllocator* allocator, const Option* opti
         const csmUint32 major = static_cast<csmUint32>((version & 0xFF000000) >> 24);
         const csmUint32 minor = static_cast<csmUint32>((version & 0x00FF0000) >> 16);
         const csmUint32 patch = static_cast<csmUint32>((version & 0x0000FFFF));
-        const csmUint32 vesionNumber = version;
+        const csmUint32 versionNumber = version;
 
-        CubismLogInfo("Live2D Cubism Core version: %02d.%02d.%04d (%d)", major, minor, patch, vesionNumber);
+        CubismLogInfo("Live2D Cubism Core version: %02d.%02d.%04d (%d)", major, minor, patch, versionNumber);
     }
 
     CubismLogInfo("CubismFramework::StartUp() is complete.");

src/Effect/CubismPose.cpp

@@ -70,8 +70,12 @@ CubismPose::~CubismPose()
 
 CubismPose* CubismPose::Create(const csmByte* pose3json, csmSizeInt size)
 {
-    CubismPose*         ret = CSM_NEW CubismPose();
     Utils::CubismJson*  json = Utils::CubismJson::Create(pose3json, size);
+    if (!json)
+    {
+        return NULL;
+    }
+    CubismPose* ret = CSM_NEW CubismPose();
     Utils::Value&       root = json->GetRoot();
 
     // フェード時間の指定

src/Model/CubismModelUserData.cpp

@@ -47,6 +47,12 @@ void CubismModelUserData::ParseUserData(const csmByte* buffer, const csmSizeInt
 {
     CubismModelUserDataJson* json = CSM_NEW CubismModelUserDataJson(buffer, size);
 
+    if (!json->IsValid())
+    {
+        CSM_DELETE(json);
+        return;
+    }
+
     const ModelUserDataType typeOfArtMesh = CubismFramework::GetIdManager()->GetId(ArtMesh);
 
     const csmUint32 nodeCount = json->GetUserDataCount();

src/Model/CubismUserModel.cpp

@@ -102,21 +102,41 @@ void CubismUserModel::LoadModel(const csmByte* buffer, csmSizeInt size, csmBool
 
 ACubismMotion* CubismUserModel::LoadExpression(const csmByte* buffer, csmSizeInt size, const csmChar* name)
 {
+    if (!buffer)
+    {
+        CubismLogError("Failed to LoadExpression().");
+        return NULL;
+    }
+
     return CubismExpressionMotion::Create(buffer, size);
 }
 
 void CubismUserModel::LoadPose(const csmByte* buffer, csmSizeInt size)
 {
     _pose = CubismPose::Create(buffer, size);
+    if (!_pose)
+    {
+        CubismLogError("Failed to LoadPose().");
+    }
 }
 
 void CubismUserModel::LoadPhysics(const csmByte* buffer, csmSizeInt size)
 {
     _physics = CubismPhysics::Create(buffer, size);
+    if (!_physics)
+    {
+        CubismLogError("Failed to LoadPhysics().");
+    }
 }
 
 void CubismUserModel::LoadUserData(const csmByte* buffer, csmSizeInt size)
 {
+    if (!buffer)
+    {
+        CubismLogError("Failed to LoadUserData().");
+        return;
+    }
+
     _modelUserData = CubismModelUserData::Create(buffer, size);
 }
 csmBool CubismUserModel::IsHit(CubismIdHandle drawableId, csmFloat32 pointX, csmFloat32 pointY)
@@ -170,6 +190,11 @@ csmBool CubismUserModel::IsHit(CubismIdHandle drawableId, csmFloat32 pointX, csm
 
 ACubismMotion* CubismUserModel::LoadMotion(const csmByte* buffer, csmSizeInt size, const csmChar* name, ACubismMotion::FinishedMotionCallback onFinishedMotionHandler)
 {
+    if (!buffer)
+    {
+        CubismLogError("Failed to LoadMotion().");
+        return NULL;
+    }
     return CubismMotion::Create(buffer, size, onFinishedMotionHandler);
 }
 

src/Motion/CubismExpressionMotion.cpp

@@ -198,6 +198,11 @@ csmFloat32 CubismExpressionMotion::GetFadeWeight()
 void CubismExpressionMotion::Parse(const csmByte* buffer, csmSizeInt size)
 {
     Utils::CubismJson* json = Utils::CubismJson::Create(buffer, size);
+    if (!json)
+    {
+        return;
+    }
+
     Utils::Value& root = json->GetRoot();
 
     SetFadeInTime(root[ExpressionKeyFadeIn].ToFloat(DefaultFadeTime));   // フェードイン

src/Motion/CubismMotion.cpp

@@ -527,6 +527,12 @@ void CubismMotion::Parse(const csmByte* motionJson, const csmSizeInt size)
 
     CubismMotionJson* json = CSM_NEW CubismMotionJson(motionJson, size);
 
+    if (!json->IsValid())
+    {
+        CSM_DELETE(json);
+        return;
+    }
+
     _motionData->Duration = json->GetMotionDuration();
     _motionData->Loop = json->IsMotionLoop();
     _motionData->CurveCount = json->GetMotionCurveCount();

src/Rendering/Cocos2d/CubismRenderer_Cocos2dx.cpp

@@ -639,9 +639,9 @@ void CubismRenderer_Cocos2dx::RestoreProfile()
     _rendererProfile.Restore();
 }
 
-void CubismRenderer_Cocos2dx::BindTexture(csmUint32 modelTextureNo, cocos2d::Texture2D* texture)
+void CubismRenderer_Cocos2dx::BindTexture(csmUint32 modelTextureIndex, cocos2d::Texture2D* texture)
 {
-    _textures[modelTextureNo] = texture;
+    _textures[modelTextureIndex] = texture;
 }
 
 const csmMap<csmInt32, cocos2d::Texture2D*>& CubismRenderer_Cocos2dx::GetBindedTextures() const
@@ -712,9 +712,9 @@ const csmBool CubismRenderer_Cocos2dx::IsGeneratingMask() const
     return GetClippingContextBufferForMask() != NULL;
 }
 
-cocos2d::Texture2D* CubismRenderer_Cocos2dx::GetBindedTexture(csmInt32 textureNo)
+cocos2d::Texture2D* CubismRenderer_Cocos2dx::GetBindedTexture(csmInt32 textureIndex)
 {
-    return _textures[textureNo];
+    return _textures[textureIndex];
 }
 
 }}}}

src/Rendering/Cocos2d/CubismRenderer_Cocos2dx.hpp

@@ -170,11 +170,11 @@ class CubismRenderer_Cocos2dx : public CubismRenderer
      * @brief   OpenGLテクスチャのバインド処理<br>
      *           CubismRendererにテクスチャを設定し、CubismRenderer中でその画像を参照するためのIndex値を戻り値とする
      *
-     * @param[in]   modelTextureNo  ->  セットするモデルテクスチャの番号
+     * @param[in]   modelTextureIndex  ->  セットするモデルテクスチャの番号
      * @param[in]   texture     ->  バックエンドテクスチャ
      *
      */
-    void BindTexture(csmUint32 modelTextureNo, cocos2d::Texture2D* texture);
+    void BindTexture(csmUint32 modelTextureIndex, cocos2d::Texture2D* texture);
 
     /**
      * @brief   OpenGLにバインドされたテクスチャのリストを取得する
@@ -340,7 +340,7 @@ class CubismRenderer_Cocos2dx : public CubismRenderer
      *
      * @return  バインドされたテクスチャ
      */
-    cocos2d::Texture2D* GetBindedTexture(csmInt32 textureNo);
+    cocos2d::Texture2D* GetBindedTexture(csmInt32 textureIndex);
 
 
     csmMap<csmInt32, cocos2d::Texture2D*> _textures;                      ///< モデルが参照するテクスチャとレンダラでバインドしているテクスチャとのマップ

src/Rendering/Cocos2d/CubismShader_Cocos2dx.cpp

@@ -784,8 +784,8 @@ void CubismShader_Cocos2dx::SetupShaderProgramForMask(CubismCommandBuffer_Cocos2
 
 
     //テクスチャ設定
-    const csmInt32 textureNo = model.GetDrawableTextureIndex(index);
-    cocos2d::Texture2D* texture = renderer->GetBindedTexture(textureNo);
+    const csmInt32 textureIndex = model.GetDrawableTextureIndex(index);
+    cocos2d::Texture2D* texture = renderer->GetBindedTexture(textureIndex);
     programState->setTexture(shaderSet->SamplerTexture0Location, 0, texture->getBackendTexture());
 
     // 頂点配列の設定
@@ -794,8 +794,8 @@ void CubismShader_Cocos2dx::SetupShaderProgramForMask(CubismCommandBuffer_Cocos2
     programState->getVertexLayout()->setAttribute("a_texCoord", shaderSet->AttributeTexCoordLocation, cocos2d::backend::VertexFormat::FLOAT2, sizeof(csmFloat32) * 2, false);
 
     // チャンネル
-    const csmInt32 channelNo = renderer->GetClippingContextBufferForMask()->_layoutChannelNo;
-    CubismRenderer::CubismTextureColor* colorChannel = renderer->GetClippingContextBufferForMask()->GetClippingManager()->GetChannelFlagAsColor(channelNo);
+    const csmInt32 channelIndex = renderer->GetClippingContextBufferForMask()->_layoutChannelIndex;
+    CubismRenderer::CubismTextureColor* colorChannel = renderer->GetClippingContextBufferForMask()->GetClippingManager()->GetChannelFlagAsColor(channelIndex);
     csmFloat32 colorFlag[4] = { colorChannel->R, colorChannel->G, colorChannel->B, colorChannel->A };
     programState->setUniform(shaderSet->UnifromChannelFlagLocation, colorFlag, sizeof(float) * 4);
 
@@ -901,15 +901,15 @@ void CubismShader_Cocos2dx::SetupShaderProgramForDraw(CubismCommandBuffer_Cocos2
                                  sizeof(float) * 16);
 
         // 使用するカラーチャンネルを設定
-        const csmInt32 channelNo = renderer->GetClippingContextBufferForDraw()->_layoutChannelNo;
-        CubismRenderer::CubismTextureColor* colorChannel = renderer->GetClippingContextBufferForDraw()->GetClippingManager()->GetChannelFlagAsColor(channelNo);
+        const csmInt32 channelIndex = renderer->GetClippingContextBufferForDraw()->_layoutChannelIndex;
+        CubismRenderer::CubismTextureColor* colorChannel = renderer->GetClippingContextBufferForDraw()->GetClippingManager()->GetChannelFlagAsColor(channelIndex);
         csmFloat32 colorFlag[4] = { colorChannel->R, colorChannel->G, colorChannel->B, colorChannel->A };
         programState->setUniform(shaderSet->UnifromChannelFlagLocation, colorFlag, sizeof(float) * 4);
     }
 
     //テクスチャ設定
-    const csmInt32 textureNo = model.GetDrawableTextureIndex(index);
-    cocos2d::Texture2D* texture = renderer->GetBindedTexture(textureNo);
+    const csmInt32 textureIndex = model.GetDrawableTextureIndex(index);
+    cocos2d::Texture2D* texture = renderer->GetBindedTexture(textureIndex);
     programState->setTexture(shaderSet->SamplerTexture0Location, 0, texture->getBackendTexture());
 
     //座標変換