From 8c3d303f8d9a164d63662bca5ffd157df772c488 Mon Sep 17 00:00:00 2001
From: 989onan <onanchew@gmail.com>
Date: Sat, 15 Jun 2024 14:27:21 -0400
Subject: [PATCH] fix some things

- got it all the way to bone loading, but it's still broken
-purposeful assert(False) to stop the code. this should be removed later in order for this importer to work
- the reading of bytes is now improved for materials and vertices, so now at least the mesh, it's normal data, and some mangled bones import
---
 core/import_pmx.py | 253 +++++++++++++++++++++++++++++++--------------
 1 file changed, 177 insertions(+), 76 deletions(-)

diff --git a/core/import_pmx.py b/core/import_pmx.py
index bfe57be..67a6ae2 100644
--- a/core/import_pmx.py
+++ b/core/import_pmx.py
@@ -2,6 +2,13 @@ import bpy
 import struct
 import traceback
 
+from mathutils import Matrix, Vector
+
+def replace_char(string, index, character):
+    temp = list(string)
+    temp[index] = character
+    return "".join(temp)
+
 def read_pmx_header(file):
     # Read PMX header information
     magic = file.read(4)
@@ -26,28 +33,73 @@ def read_pmx_header(file):
     model_english_name = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
     
     model_comment = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
-    #print(model_name)
-    #print(model_english_name)
+    print(model_name)
+    print(model_english_name)
+    print(model_comment)
     model_english_comment = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
-    #print(model_english_comment)
+    print(model_english_comment)
     return version, encoding, additional_uvs, vertex_index_size, texture_index_size, material_index_size, bone_index_size, morph_index_size, rigid_body_index_size, model_name, model_english_name, model_comment, model_english_comment
 
-def read_vertex(file, vertex_index_size):
+def read_vertex(file, bone_index_size, additional_uvs):
     position = struct.unpack('<3f', file.read(12))
     normal = struct.unpack('<3f', file.read(12))
     uv = struct.unpack('<2f', file.read(8))
+    additional_uv_read = []
+    for i in range(0,additional_uvs):
+        additional_uv_read.append(struct.unpack('<4f', file.read(16)))
     
-    if vertex_index_size == 1:
-        bone_indices = list(struct.unpack('<4B', file.read(4)))
-    elif vertex_index_size == 2:
-        bone_indices = list(struct.unpack('<4H', file.read(8)))
+    weight_deform_type = struct.unpack('<B', file.read(1))[0]
+    
+    stringbuild = '<??'
+    byte_size = 0
+    
+    if bone_index_size == 1:
+        stringbuild = replace_char(stringbuild, 2, 'B')
+        byte_size = 1
+    elif bone_index_size == 2:
+        stringbuild = replace_char(stringbuild,2,'H')
+        byte_size = 2
     else:
-        bone_indices = list(struct.unpack('<4I', file.read(16)))
+        stringbuild = replace_char(stringbuild,2,'i')
+        byte_size = 4
+    
+    C_num = []
+    R0_num = []
+    R1_num = []
+    
+    #in the if-else chain, multiplying byte_size by a number should reflect the stringbuild's 1st (not 0th) character which is how many bone indices there are.
+    if weight_deform_type == 0: #BDEF 1
+        stringbuild = replace_char(stringbuild,1,'1') #how many bone indices there are
+        bone_indices = list(struct.unpack(stringbuild, file.read(byte_size*1))) 
+        bone_weights = [1.0]
+    elif weight_deform_type == 1: #BDEF2
+        stringbuild = replace_char(stringbuild,1,'2') #how many bone indices there are
+        bone_indices = list(struct.unpack(stringbuild, file.read(byte_size*2)))
+        bone_1_weight = struct.unpack('<f', file.read(4))[0]
+        bone_weights = [bone_1_weight, 1.0-bone_1_weight]
+    elif weight_deform_type == 2: #BDEF4
+        stringbuild = replace_char(stringbuild,1,'4') #how many bone indices there are
+        bone_indices = list(struct.unpack(stringbuild, file.read(byte_size*4))) 
+        bone_weights = list(struct.unpack('<4f', file.read(4*4))) 
+    elif weight_deform_type == 3: #SDEF
+        stringbuild = replace_char(stringbuild,1,'2') #how many bone indices there are
+        bone_indices = list(struct.unpack(stringbuild, file.read(byte_size*2)))
+        bone_1_weight = struct.unpack('<f', file.read(4))[0]
+        bone_weights = [bone_1_weight, 1.0-bone_1_weight]
+        C_num = struct.unpack('<3f', file.read(12))
+        R0_num = struct.unpack('<3f', file.read(12))
+        R1_num = struct.unpack('<3f', file.read(12))
+    elif weight_deform_type == 4: #QDEF
+        stringbuild = replace_char(stringbuild,1,'4') #how many bone indices there are
+        bone_indices = list(struct.unpack(stringbuild, file.read(byte_size*4))) 
+        bone_weights = list(struct.unpack('<4f', file.read(4*4))) 
+    else:
+        raise IOError("Unsupported weight deform type \""+str(weight_deform_type)+"\" for file!")
+    
+    
     
-    bone_weights = list(struct.unpack('<4f', file.read(16)))
     edge_scale = struct.unpack('<f', file.read(4))[0]
-    
-    return position, normal, uv, bone_indices, bone_weights, edge_scale
+    return position, normal, uv, bone_indices, bone_weights, edge_scale, additional_uv_read
 
 def read_material(file, texture_index_size):
     material_name = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
@@ -61,20 +113,33 @@ def read_material(file, texture_index_size):
     flag = struct.unpack('<b', file.read(1))[0]
     edge_color = struct.unpack('<4f', file.read(16))
     edge_size = struct.unpack('<f', file.read(4))[0]
-    texture_index = struct.unpack(f'<{texture_index_size}B', file.read(texture_index_size))[0]
-    sphere_texture_index = struct.unpack(f'<{texture_index_size}B', file.read(texture_index_size))[0]
+    #this is bad don't do this, replaced it.. - @989onan
+    #texture_index = struct.unpack(f'<{texture_index_size}B', file.read(texture_index_size))[0]
+    stringbuild = '<1?'
+    if texture_index_size == 1:
+        stringbuild = replace_char(stringbuild, 2, 'b')
+        byte_size = 1
+    elif texture_index_size == 2:
+        stringbuild = replace_char(stringbuild,2,'h')
+        byte_size = 2
+    else:
+        stringbuild = replace_char(stringbuild,2,'i')
+        byte_size = 4
+    texture_index = struct.unpack(stringbuild, file.read(byte_size))[0]
+    sphere_texture_index = struct.unpack(stringbuild, file.read(byte_size))[0]
     sphere_mode = struct.unpack('<b', file.read(1))[0]
     toon_sharing_flag = struct.unpack('<b', file.read(1))[0]
     
     if toon_sharing_flag == 0:
-        toon_texture_index = struct.unpack(f'<{texture_index_size}B', file.read(texture_index_size))[0]
+        toon_texture_index = struct.unpack(stringbuild, file.read(byte_size))[0]
     else:
         toon_texture_index = struct.unpack('<b', file.read(1))[0]
     
     
     comment = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
+    surface_count = struct.unpack('<i', file.read(4))[0]/3
     
-    return material_name, material_english_name, diffuse_color, specular_color, specular_strength, ambient_color, flag, edge_color, edge_size, texture_index, sphere_texture_index, sphere_mode, toon_sharing_flag, toon_texture_index, comment
+    return material_name, material_english_name, diffuse_color, specular_color, specular_strength, ambient_color, flag, edge_color, edge_size, texture_index, sphere_texture_index, sphere_mode, toon_sharing_flag, toon_texture_index, comment, surface_count
 
 def read_bone(file, bone_index_size):
     bone_name = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
@@ -85,6 +150,20 @@ def read_bone(file, bone_index_size):
     layer = struct.unpack('<i', file.read(4))[0]
     flag = struct.unpack('<H', file.read(2))[0]
     
+    tail_position = [0.0,0.0,0.0]
+    tail_index = 0.0
+    inherit_bone_parent_index = -1
+    inherit_bone_parent_influence = 0.0
+    fixed_axis = [0.0,0.0,0.0]
+    local_x_vector = [0.0,0.0,0.0]
+    local_z_vector = [0.0,0.0,0.0]
+    external_key = 0
+    ik_target_bone_index = 0.0
+    ik_loop_count = -1
+    ik_limit_radian = 0.0
+    ik_link_count = -1
+    
+    
     if flag & 0x0001:
         tail_position = struct.unpack('<3f', file.read(12))
     else:
@@ -104,13 +183,14 @@ def read_bone(file, bone_index_size):
     if flag & 0x2000:
         external_key = struct.unpack('<i', file.read(4))[0]
     
+    ik_links = []
     if flag & 0x0020:
         ik_target_bone_index = struct.unpack(f'<{bone_index_size}B', file.read(bone_index_size))[0]
         ik_loop_count = struct.unpack('<i', file.read(4))[0]
         ik_limit_radian = struct.unpack('<f', file.read(4))[0]
         ik_link_count = struct.unpack('<i', file.read(4))[0]
         
-        ik_links = []
+        
         for _ in range(ik_link_count):
             ik_link_bone_index = struct.unpack(f'<{bone_index_size}B', file.read(bone_index_size))[0]
             ik_link_limit_min = struct.unpack('<3f', file.read(12))
@@ -180,61 +260,82 @@ def read_morph(file, morph_index_size):
 
 def import_pmx(filepath):
     try:
-        with open(filepath, mode='rb') as file:
-            
-            print("stage 1")
-            version, encoding, additional_uvs, vertex_index_size, texture_index_size, material_index_size, bone_index_size, morph_index_size, rigid_body_index_size, model_name, model_english_name, model_comment, model_english_comment = read_pmx_header(file)
-            print("stage 2")
-            # Read vertices
-            print("fix 3")
-            vertex_count = struct.unpack('<i', file.read(4))[0]
-            print("stage 3")
-            print(vertex_count)
-            vertices = []
-            for _ in range(vertex_count):
-                position, normal, uv, bone_indices, bone_weights, edge_scale = read_vertex(file, vertex_index_size)
-                vertices.append((position, normal, uv, bone_indices, bone_weights, edge_scale))
-            
-            # Read faces
-            print("stage 4")
-            face_count = struct.unpack('<i', file.read(4))[0]
-            print("stage 5")
-            print(face_count)
-            print(additional_uvs)
-            print(vertex_index_size)
-            faces = []
-            for _ in range(face_count // 3):
-                face_indices = struct.unpack('<3i', file.read(12))
-                faces.append(face_indices)
-            print("stage 6")
-            # Read textures
-            texture_count = struct.unpack('<i', file.read(4))[0]
-            textures = []
-            for _ in range(texture_count):
-                texture_path = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
-                textures.append(texture_path)
-            print("stage 7")
-            # Read materials
-            material_count = struct.unpack('<i', file.read(4))[0]
-            materials = []
-            for _ in range(material_count):
-                material_name, material_english_name, diffuse_color, specular_color, specular_strength, ambient_color, flag, edge_color, edge_size, texture_index, sphere_texture_index, sphere_mode, toon_sharing_flag, toon_texture_index, comment = read_material(file, texture_index_size)
-                materials.append((material_name, material_english_name, diffuse_color, specular_color, specular_strength, ambient_color, flag, edge_color, edge_size, texture_index, sphere_texture_index, sphere_mode, toon_sharing_flag, toon_texture_index, comment))
-            print("stage 8")
-        # Read bones
-        bone_count = struct.unpack('<i', file.read(4))[0]
+        faces = []
+        vertices = []
+        textures = []
+        materials = []
         bones = []
-        for _ in range(bone_count):
-            bone_name, bone_english_name, position, parent_bone_index, layer, flag, tail_position, inherit_bone_parent_index, inherit_bone_parent_influence, fixed_axis, local_x_vector, local_z_vector, external_key, ik_target_bone_index, ik_loop_count, ik_limit_radian, ik_links = read_bone(file, bone_index_size)
-            bones.append((bone_name, bone_english_name, position, parent_bone_index, layer, flag, tail_position, inherit_bone_parent_index, inherit_bone_parent_influence, fixed_axis, local_x_vector, local_z_vector, external_key, ik_target_bone_index, ik_loop_count, ik_limit_radian, ik_links))
-        
-        # Read morphs
-        morph_count = struct.unpack('<i', file.read(4))[0]
         morphs = []
-        for _ in range(morph_count):
-            morph_name, morph_english_name, panel, morph_type, morph_data = read_morph(file, morph_index_size)
-            morphs.append((morph_name, morph_english_name, panel, morph_type, morph_data))
-        
+        try:
+            
+            with open(filepath, mode='rb') as file:
+                
+                print("stage 1")
+                version, encoding, additional_uvs, vertex_index_size, texture_index_size, material_index_size, bone_index_size, morph_index_size, rigid_body_index_size, model_name, model_english_name, model_comment, model_english_comment = read_pmx_header(file)
+                print("stage 2")
+                # Read vertices
+                print("fix 3")
+                vertex_count = struct.unpack('<i', file.read(4))[0]
+                print("stage 3")
+                print(vertex_count)
+                
+                for _ in range(vertex_count):
+                    position, normal, uv, bone_indices, bone_weights, edge_scale, additional_uv_read = read_vertex(file, bone_index_size, additional_uvs)
+                    vertices.append((position, normal, uv, bone_indices, bone_weights, edge_scale))
+                
+                # Read faces
+                print("stage 4")
+                face_count = struct.unpack('<i', file.read(4))[0]
+                print("stage 5")
+                
+                def read_data(data, length):
+                    return list(struct.unpack(data, file.read(length)))
+                
+                
+                #storing function to use in for-loop to prevent checking the same thing a bajillion times - @989onan
+                face_funct = lambda: print("invalid face funct")
+                if vertex_index_size == 1:
+                    face_funct = lambda: read_data('<3B',3)
+                elif vertex_index_size == 2:
+                    face_funct = lambda: read_data('<3H',6)
+                else:
+                    face_funct = lambda: read_data('<3i',12)
+                for _ in range(face_count // 3):
+                    faces.append(face_funct())
+                print("stage 6")
+                # Read textures
+                texture_count = struct.unpack('<i', file.read(4))[0]
+                
+                for _ in range(texture_count):
+                    texture_path = str(file.read(struct.unpack('<i', file.read(4))[0]), 'utf-16-le', errors='replace')
+                    textures.append(texture_path)
+                print("stage 7")
+                # Read materials
+                material_count = struct.unpack('<i', file.read(4))[0]
+                print("material count "+str(material_count))
+                for _ in range(material_count):
+                    material_name, material_english_name, diffuse_color, specular_color, specular_strength, ambient_color, flag, edge_color, edge_size, texture_index, sphere_texture_index, sphere_mode, toon_sharing_flag, toon_texture_index, comment, surface_count = read_material(file, texture_index_size)
+                    materials.append((material_name, material_english_name, diffuse_color, specular_color, specular_strength, ambient_color, flag, edge_color, edge_size, texture_index, sphere_texture_index, sphere_mode, toon_sharing_flag, toon_texture_index, comment, surface_count))
+                print("stage 8")
+                # Read bones
+                bone_count = struct.unpack('<i', file.read(4))[0]
+                print("bone count: "+str(bone_count))
+                for _ in range(bone_count):
+                    bone_name, bone_english_name, position, parent_bone_index, layer, flag, tail_position, inherit_bone_parent_index, inherit_bone_parent_influence, fixed_axis, local_x_vector, local_z_vector, external_key, ik_target_bone_index, ik_loop_count, ik_limit_radian, ik_links = read_bone(file, bone_index_size)
+                    bones.append((bone_name, bone_english_name, position, parent_bone_index, layer, flag, tail_position, inherit_bone_parent_index, inherit_bone_parent_influence, fixed_axis, local_x_vector, local_z_vector, external_key, ik_target_bone_index, ik_loop_count, ik_limit_radian, ik_links))
+                
+                # Read morphs
+                morph_count = struct.unpack('<i', file.read(4))[0]
+                print("morph count: "+str(morph_count))
+                for _ in range(morph_count):
+                    morph_name, morph_english_name, panel, morph_type, morph_data = read_morph(file, morph_index_size)
+                    morphs.append((morph_name, morph_english_name, panel, morph_type, morph_data))
+                print("finished reading file!")
+        except Exception as e:
+            print(str(e))
+            #pass
+            
+            #raise IOError("Could not read PMX file") from e
         # Create Blender objects and assign PMX data
         mesh = bpy.data.meshes.new(model_name)
         mesh.from_pydata([v[0] for v in vertices], [], faces)
@@ -244,8 +345,8 @@ def import_pmx(filepath):
         bpy.context.collection.objects.link(obj)
         
         # Assign vertex normals
-        for i, vertex in enumerate(vertices):
-            mesh.vertices[i].normal = vertex[1]
+        custom_normals = [(Vector(i[1]).xzy).normalized() for i in vertices]
+        mesh.normals_split_custom_set_from_vertices(custom_normals)
         
         # Assign UV coordinates
         uv_layer = mesh.uv_layers.new()
@@ -258,7 +359,7 @@ def import_pmx(filepath):
             material.diffuse_color = material_data[2]
             material.specular_color = material_data[3]
             material.specular_intensity = material_data[4]
-            material.ambient = material_data[5]
+            #material.ambient = material_data[5] #TODO: this doesn't exist
             # Set other material properties based on the PMX data
             
             mesh.materials.append(material)
@@ -275,18 +376,18 @@ def import_pmx(filepath):
             bone = armature.edit_bones.new(bone_data[0])
             bone.head = bone_data[2]
             bone.tail = bone_data[6]
-            
+            print(bone_data[3])
             if bone_data[3] != -1:
                 parent_bone = armature.edit_bones[bone_data[3]]
                 bone.parent = parent_bone
             
             # Set other bone properties based on the PMX data
-        
+        assert(False)
         bpy.ops.object.mode_set(mode='OBJECT')
         
         # Assign bone weights to the mesh
         for i, vertex in enumerate(vertices):
-            for j in range(4):
+            for j in len(vertex[3]):
                 if vertex[3][j] != -1:
                     bone_name = bones[vertex[3][j]][0]
                     weight = vertex[4][j]