Ticket #1012: collada_alternate_fix-01222012.patch

source/collada/DLL.h

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -41 +41 @@
 
 /* This version number should be bumped whenever incompatible changes
  * are made, to invalidate old caches. */
-#define COLLADA_CONVERTER_VERSION 3
+#define COLLADA_CONVERTER_VERSION 4
 
 EXPORT void set_logger(LogFn logger, void* cb_data);
 EXPORT int set_skeleton_definitions(const char* xml, int length);

source/collada/PMDConvert.cpp

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -252 +252 @@
                     // guaranteed by ReduceInfluences; necessary for avoiding
                     // out-of-bounds writes to the VertexBlend
 
+                if (vertexInfluences[i].GetPairCount() == 0)
+                {
+                    // Blender exports some models with vertices that have no influences,
+                    //  which I've not found details about in the COLLADA spec, however,
+                    //  it seems to work OK to treat these vertices the same as if they
+                    //  were only influenced by the bind-shape matrix (see comment below),
+                    //  so we use the same special case here.
+                    influences.bones[0] = (uint8)jointCount;
+                    influences.weights[0] = 1.0f;
+                }
+
                 for (size_t j = 0; j < vertexInfluences[i].GetPairCount(); ++j)
                 {
-                    uint32 jointIdx = vertexInfluences[i].GetPair(j)->jointIndex;
-                    REQUIRE(jointIdx <= 0xFF, "sensible number of joints (<256)"); // because we only have a u8 to store them in
+                    if (vertexInfluences[i].GetPair(j)->jointIndex == -1)
+                    {
+                        // This is a special case we must handle, according to the COLLADA spec:
+                        //  "An index of -1 into the array of joints refers to the bind shape"
+                        //  which basically means when skinning the vertex it's relative to the
+                        //  bind-shape transform instead of an animated bone. Since our skinning
+                        //  is in world space, we will have already applied the bind-shape transform,
+                        //  so we don't have to worry about that, though we DO have to apply the
+                        //  world space transform of the model for the indicated vertex.
+                        //
+                        //  To handle this special case, we add a zero translation, identity
+                        //  rotation bone to all models, with a bone ID equal to the number of
+                        //  real bones in the COLLADA model.
+                        //  (see http://trac.wildfiregames.com/ticket/1012)
+                        influences.bones[j] = (uint8)jointCount;
+                        influences.weights[j] = vertexInfluences[i].GetPair(j)->weight;
+                    }
+                    else
+                    {
+                        // Check for less than 255 joints because we store them in a u8
+                        //  and 0xFF is a reserved value
+                        uint32 jointIdx = vertexInfluences[i].GetPair(j)->jointIndex;
+                        REQUIRE(jointIdx < 0xFF, "sensible number of joints (<255)");
 
-                    // Find the joint on the skeleton, after checking it really exists
-                    FCDSceneNode* joint = NULL;
-                    if (jointIdx < controllerInstance.GetJointCount())
-                        joint = controllerInstance.GetJoint(jointIdx);
+                        // Find the joint on the skeleton, after checking it really exists
+                        FCDSceneNode* joint = NULL;
+                        if (jointIdx < controllerInstance.GetJointCount())
+                            joint = controllerInstance.GetJoint(jointIdx);
 
-                    // Complain on error
-                    if (! joint)
-                    {
-                        if (! hasComplainedAboutNonexistentJoints)
+                        // Complain on error
+                        if (! joint)
                         {
-                            Log(LOG_WARNING, "Vertexes influenced by nonexistent joint");
-                            hasComplainedAboutNonexistentJoints = true;
+                            if (! hasComplainedAboutNonexistentJoints)
+                            {
+                                Log(LOG_WARNING, "Vertexes influenced by nonexistent joint");
+                                hasComplainedAboutNonexistentJoints = true;
+                            }
+                            continue;
                         }
-                        continue;
-                    }
 
-                    // Store into the VertexBlend
-                    int boneId = skeleton.GetBoneID(joint->GetName().c_str());
-                    if (boneId < 0)
-                    {
-                        // The relevant joint does exist, but it's not a recognised
-                        // bone in our chosen skeleton structure
-                        Log(LOG_ERROR, "Vertex influenced by unrecognised bone '%s'", joint->GetName().c_str());
-                        continue;
+                        // Store into the VertexBlend
+                        int boneId = skeleton.GetBoneID(joint->GetName().c_str());
+                        if (boneId < 0)
+                        {
+                            // The relevant joint does exist, but it's not a recognised
+                            // bone in our chosen skeleton structure
+                            Log(LOG_ERROR, "Vertex influenced by unrecognised bone '%s'", joint->GetName().c_str());
+                            continue;
+                        }
+
+                        influences.bones[j] = (uint8)boneId;
+                        influences.weights[j] = vertexInfluences[i].GetPair(j)->weight;
                     }
-
-                    influences.bones[j] = (uint8)boneId;
-                    influences.weights[j] = vertexInfluences[i].GetPair(j)->weight;
                 }
 
                 boneWeights.push_back(influences);
@@ -292 +325 @@
 
             // Convert the bind pose into BoneTransform structures for the PMD:
 
+            // Add a special zero translation, identity bone (see comments above)
+
             BoneTransform boneDefault  = { { 0, 0, 0 }, { 0, 0, 0, 1 } }; // identity transform
-            std::vector<BoneTransform> boneTransforms (skeleton.GetBoneCount(), boneDefault);
+            std::vector<BoneTransform> boneTransforms (skeleton.GetBoneCount()+1, boneDefault);
 
             for (size_t i = 0; i < jointCount; ++i)
             {
@@ -454 +489 @@
         }
 
         output("PSMD", 4);  // magic number
-        write(output, (uint32)3); // version number
+        write(output, (uint32)4); // version number
         write(output, (uint32)(
             4 + 13*4*vertexCount + // vertices
             4 + 6*faceCount + // faces
@@ -522 +557 @@
     /**
      * Applies world-space transform to vertex data and transforms Collada's right-handed
      *  Y-up / Z-up coordinates to the game's left-handed Y-up coordinate system
+     *
+     * TODO: Maybe we should use FCDocumentTools::StandardizeUpAxisAndLength in addition
+     *      to this, so we'd only have one up-axis case to worry about, but it doesn't seem to
+     *      correctly adjust the prop points in Y_UP models.
      */
     static void TransformStaticModel(float* position, float* normal, size_t vertexCount,
         const FMMatrix44& transform, bool yUp)
@@ -563 +602 @@
     /**
      * Applies world-space transform to vertex data and transforms Collada's right-handed
      *  Y-up / Z-up coordinates to the game's left-handed Y-up coordinate system
+     *
+     * TODO: Maybe we should use FCDocumentTools::StandardizeUpAxisAndLength in addition
+     *      to this, so we'd only have one up-axis case to worry about, but it doesn't seem to
+     *      correctly adjust the prop points in Y_UP models.
      */
     static void TransformSkinnedModel(float* position, float* normal, size_t vertexCount,
         std::vector<BoneTransform>& bones, std::vector<PropPoint>& propPoints,

source/collada/PSAConvert.cpp

@@ -1 @@
-/* Copyright (C) 2009 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -86 +86 @@
             size_t frameCount = (size_t)((timeEnd - timeStart) / frameLength - 0.5f);
             // (TODO: sort out the timing/looping problems)
 
-            size_t boneCount = skeleton.GetBoneCount();
+            // Add a special zero translation, identity bone state (see comments in PMDConvert.cpp)
+            size_t boneCount = skeleton.GetBoneCount()+1;
 
             std::vector<BoneTransform> boneTransforms;
 
@@ -150 +151 @@
     static void WritePSA(OutputCB& output, size_t frameCount, size_t boneCount, const std::vector<BoneTransform>& boneTransforms)
     {
         output("PSSA", 4);  // magic number
-        write(output, (uint32)1); // version number
+        write(output, (uint32)2); // version number
         write(output, (uint32)(
             4 + 0 + // name
             4 + // frameLength

source/graphics/ModelDef.cpp

@@ -1 @@
-/* Copyright (C) 2011 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -259 +259 @@
     unpacker.Read(filename,"PSMD");
             
     // check version
-    if (unpacker.GetVersion()<FILE_READ_VERSION) {
+    if (unpacker.GetVersion() < FILE_READ_VERSION)
+    {
         throw PSERROR_File_InvalidVersion();
     }
 
@@ -269 +270 @@
     // now unpack everything 
     mdef->m_NumVertices = unpacker.UnpackSize();
     mdef->m_pVertices=new SModelVertex[mdef->m_NumVertices];
-    unpacker.UnpackRaw(mdef->m_pVertices,sizeof(SModelVertex)*mdef->m_NumVertices);
+    unpacker.UnpackRaw(mdef->m_pVertices, sizeof(SModelVertex)*mdef->m_NumVertices);
     
     mdef->m_NumFaces = unpacker.UnpackSize();
     mdef->m_pFaces=new SModelFace[mdef->m_NumFaces];
-    unpacker.UnpackRaw(mdef->m_pFaces,sizeof(SModelFace)*mdef->m_NumFaces);
+    unpacker.UnpackRaw(mdef->m_pFaces, sizeof(SModelFace)*mdef->m_NumFaces);
     
     mdef->m_NumBones = unpacker.UnpackSize();
     if (mdef->m_NumBones)
     {
+        size_t numPackedBones = mdef->m_NumBones;
+
+        if (unpacker.GetVersion() < 4)
+        {
+            // For older versions we need to add an extra identity bone
+            // (see http://trac.wildfiregames.com/ticket/1012)
+            mdef->m_NumBones++;
+        }
+
         mdef->m_Bones=new CBoneState[mdef->m_NumBones];
-        unpacker.UnpackRaw(mdef->m_Bones,mdef->m_NumBones*sizeof(CBoneState));
+        unpacker.UnpackRaw(mdef->m_Bones, numPackedBones*sizeof(CBoneState));
 
+        if (unpacker.GetVersion() < 4)
+        {
+            // see above comment
+            CBoneState identityBone;
+            identityBone.m_Rotation = CQuaternion(0.0f, 0.0f, 0.0f, 1.0f);
+            identityBone.m_Translation = CVector3D(0.0f, 0.0f, 0.0f);
+            mdef->m_Bones[mdef->m_NumBones - 1] = identityBone;
+        }
+
         mdef->m_pBlendIndices = new size_t[mdef->m_NumVertices];
         std::vector<SVertexBlend> blends;
         for (size_t i = 0; i < mdef->m_NumVertices; i++)

source/graphics/SkeletonAnimDef.cpp

@@ -1 @@
-/* Copyright (C) 2009 Wildfire Games.
+/* Copyright (C) 2012 Wildfire Games.
  * This file is part of 0 A.D.
  *
  * 0 A.D. is free software: you can redistribute it and/or modify
@@ -93 +93 @@
     unpacker.Read(filename,"PSSA");
             
     // check version
-    if (unpacker.GetVersion()<FILE_READ_VERSION) {
+    if (unpacker.GetVersion() < FILE_READ_VERSION)
+    {
         throw PSERROR_File_InvalidVersion();
     }
 
     // unpack the data
-    CSkeletonAnimDef* anim=new CSkeletonAnimDef;
-    try {
+    CSkeletonAnimDef* anim = new CSkeletonAnimDef;
+    try
+    {
         CStr name; // unused - just here to maintain compatibility with the animation files
         unpacker.UnpackString(name);
-        unpacker.UnpackRaw(&anim->m_FrameTime,sizeof(anim->m_FrameTime));
+        unpacker.UnpackRaw(&anim->m_FrameTime, sizeof(anim->m_FrameTime));
         anim->m_NumKeys = unpacker.UnpackSize();
         anim->m_NumFrames = unpacker.UnpackSize();
-        anim->m_Keys=new Key[anim->m_NumKeys*anim->m_NumFrames];
-        unpacker.UnpackRaw(anim->m_Keys,anim->m_NumKeys*anim->m_NumFrames*sizeof(Key));
-    } catch (PSERROR_File&) {
+
+        anim->m_Keys = new Key[anim->m_NumKeys * anim->m_NumFrames];
+        unpacker.UnpackRaw(anim->m_Keys, anim->m_NumKeys * anim->m_NumFrames * sizeof(Key));
+
+        if (unpacker.GetVersion() < 2)
+        {
+            // For old versions, we need to add an identity bone state in each frame,
+            // to maintain compatibility with new models
+            // (see http://trac.wildfiregames.com/ticket/1012)
+
+            Key specialKey;
+            specialKey.m_Rotation = CQuaternion(0.0f, 0.0f, 0.0f, 1.0f);
+            specialKey.m_Translation = CVector3D(0.0f, 0.0f, 0.0f);
+
+            size_t oldKeysNum = anim->m_NumKeys;
+            size_t newKeysNum = oldKeysNum + 1;
+            
+            Key* newKeys = new Key[newKeysNum * anim->m_NumFrames];
+            
+            for (size_t f = 0; f < anim->m_NumFrames; ++f)
+            {
+                memcpy(&newKeys[f*newKeysNum], &anim->m_Keys[f*oldKeysNum], oldKeysNum*sizeof(Key));
+                newKeys[f*newKeysNum + oldKeysNum] = specialKey;
+            }
+
+            delete anim->m_Keys;
+            anim->m_NumKeys = newKeysNum;
+            anim->m_Keys = newKeys;
+        }
+
+    }
+    catch (PSERROR_File&)
+    {
         delete anim;
         throw;
     }