Basic MCC Mozz support

reclaimer/__init__.py

@@ -12,8 +12,8 @@
 # ##############
 __author__ = "Sigmmma"
 #           YYYY.MM.DD
-__date__ = "2021.03.23"
-__version__ = (2, 11, 2)
+__date__ = "2024.03.18"
+__version__ = (2, 22, 0)
 __website__ = "https://github.com/Sigmmma/reclaimer"
 __all__ = (
     "animation", "bitmaps", "h2", "h3", "halo_script", "hek", "meta", "misc",

reclaimer/animation/animation_compilation.py

@@ -19,7 +19,7 @@
            "ANIMATION_COMPILE_MODE_NEW", "ANIMATION_COMPILE_MODE_PRESERVE",
            "ANIMATION_COMPILE_MODE_ADDITIVE")
 
-ANIMATION_COMPILE_MODE_NEW = 0
+ANIMATION_COMPILE_MODE_NEW      = 0
 ANIMATION_COMPILE_MODE_PRESERVE = 1
 ANIMATION_COMPILE_MODE_ADDITIVE = 2
 
@@ -39,9 +39,9 @@ def compile_animation(anim, jma_anim, ignore_size_limits=False, endian=">"):
     default_data_size = jma_anim.default_data_size
     frame_data_size   = jma_anim.frame_data_frame_size * stored_frame_count
 
-    max_frame_info_size   = anim.frame_info.get_desc('MAX', 'size')
-    max_default_data_size = anim.default_data.get_desc('MAX', 'size')
-    max_frame_data_size   = anim.frame_data.get_desc('MAX', 'size')
+    max_frame_info_size   = util.get_block_max(anim.frame_info)
+    max_default_data_size = util.get_block_max(anim.default_data)
+    max_frame_data_size   = util.get_block_max(anim.frame_data)
 
     if not ignore_size_limits:
         if frame_info_size > max_frame_info_size:
@@ -103,10 +103,10 @@ def compile_animation(anim, jma_anim, ignore_size_limits=False, endian=">"):
     return errors
 
 
-def compile_model_animations(antr_tag, jma_anim_set, ignore_size_limits=False,
-                             animation_count_limit=256, delta_tolerance=None,
-                             update_mode=ANIMATION_COMPILE_MODE_PRESERVE,
-                             mod2_nodes=None):
+def compile_model_animations(
+        antr_tag, jma_anim_set, ignore_size_limits=False, delta_tolerance=None,
+        update_mode=ANIMATION_COMPILE_MODE_PRESERVE, mod2_nodes=None
+        ):
     errors = []
 
     tagdata = antr_tag.data.tagdata
@@ -220,7 +220,7 @@ def compile_model_animations(antr_tag, jma_anim_set, ignore_size_limits=False,
         anim_index = antr_indices_by_type_strings.get(
             name_pieces, len(antr_anims))
 
-        if anim_index >= animation_count_limit:
+        if anim_index >= util.get_block_max(tagdata.animations):
             errors.append(
                 "Too many animations. Cannot add '%s'" % jma_anim_name)
             continue

reclaimer/animation/jma.py

@@ -27,6 +27,18 @@
     ".jma", ".jmm", ".jmo", ".jmr", ".jmt", ".jmw", ".jmz",
     )
 
+JMA_VER_HALO_1_OLDEST_KNOWN   = 16390
+JMA_VER_HALO_1_NODE_NAMES     = 16391
+JMA_VER_HALO_1_NODE_HIERARCHY = 16392
+JMA_VER_HALO_1_RETAIL         = JMA_VER_HALO_1_NODE_HIERARCHY
+
+JMA_VER_ALL = frozenset((
+    JMA_VER_HALO_1_OLDEST_KNOWN,
+    JMA_VER_HALO_1_NODE_NAMES,
+    JMA_VER_HALO_1_NODE_HIERARCHY,
+    JMA_VER_HALO_1_RETAIL,
+    ))
+
 
 def get_anim_ext(anim_type, frame_info_type, world_relative=False):
     anim_type = anim_type.lower()
@@ -150,6 +162,7 @@ class JmaAnimation:
     node_list_checksum = 0
     nodes = ()
     frames = ()
+    version = 0
 
     rot_keyframes = ()
     trans_keyframes = ()
@@ -173,7 +186,9 @@ class JmaAnimation:
 
     def __init__(self, name="", node_list_checksum=0,
                  anim_type="", frame_info_type="", world_relative=False,
-                 nodes=None, frames=None, actors=None, frame_rate=30):
+                 nodes=None, frames=None, actors=None, frame_rate=30,
+                 version=JMA_VER_HALO_1_RETAIL,
+                 ):
 
         self.name = name.strip(" ")
         self.node_list_checksum = node_list_checksum
@@ -184,6 +199,7 @@ def __init__(self, name="", node_list_checksum=0,
         self.frame_info_type = frame_info_type
         self.frame_rate = frame_rate
         self.actors = actors if actors else ["unnamedActor"]
+        self.version = version
 
         self.root_node_info = []
         self.setup_keyframes()
@@ -203,6 +219,11 @@ def has_keyframe_data(self):
             return False
         return True
 
+    @property
+    def has_node_names(self): return self.version >= JMA_VER_HALO_1_NODE_NAMES
+    @property
+    def has_node_hierarchy(self): return self.version >= JMA_VER_HALO_1_NODE_HIERARCHY
+
     @property
     def ext(self):
         return get_anim_ext(self.anim_type, self.frame_info_type,
@@ -438,8 +459,27 @@ def calculate_root_node_info(self):
             z += dz
             yaw += dyaw
 
-    verify_nodes_valid = JmsModel.verify_nodes_valid
-    get_node_depths = JmsModel.get_node_depths
+    def get_node_depths(self):
+        if self.has_node_hierarchy:
+            return JmsModel.get_node_depths(self)
+        return []
+
+    def verify_nodes_valid(self):
+        errors = []
+        if self.has_node_hierarchy or len(self.nodes) not in range(1, 64):
+            return JmsModel.verify_nodes_valid(self)
+        elif self.has_node_names:
+            seen_names = set()
+            for i in range(len(self.nodes)):
+                n = self.nodes[i]
+                if len(n.name) >= 32:
+                    errors.append("Node name node '%s' is too long." % n.name)
+                elif n.name.lower() in seen_names:
+                    errors.append("Multiple nodes named '%s'." % n.name)
+
+                seen_names.add(n.name.lower())
+
+        return errors
 
     def calculate_animation_flags(self, tolerance=None):
         if tolerance is None:
@@ -486,9 +526,15 @@ def verify_animations_match(self, other_jma):
             errors.append("Node counts do not match.")
             return errors
 
-        for i in range(len(self.nodes)):
-            if not self.nodes[i].is_node_hierarchy_equal(other_jma.nodes[i]):
-                errors.append("Nodes '%s' do not match." % i)
+        if self.has_node_names and other_jma.has_node_names:
+            for i in range(len(self.nodes)):
+                if not self.nodes[i].is_node_hierarchy_equal(
+                        other_jma.nodes[i], not (
+                            self.has_node_hierarchy and 
+                            other_jma.has_node_hierarchy
+                            )
+                        ):
+                    errors.append("Nodes '%s' do not match." % i)
 
         return errors
 
@@ -516,6 +562,7 @@ class JmaAnimationSet:
     node_list_checksum = 0
     nodes = ()
     animations = ()
+    version = JMA_VER_HALO_1_OLDEST_KNOWN
 
     def __init__(self, *jma_animations):
         self.nodes = []
@@ -526,14 +573,27 @@ def __init__(self, *jma_animations):
 
     verify_animations_match = JmaAnimation.verify_animations_match
 
+    @property
+    def has_node_names(self): return self.version >= JMA_VER_HALO_1_NODE_NAMES
+    @property
+    def has_node_hierarchy(self): return self.version >= JMA_VER_HALO_1_NODE_HIERARCHY
+
     def merge_jma_animation(self, other_jma):
         assert isinstance(other_jma, JmaAnimation)
 
         if not other_jma:
             return
 
+        if other_jma.version > self.version and self.nodes:
+            # if the other jma's version is newer, grab its nodes if they
+            # match well enough, since they'll contain more detailed data
+            if (self.node_list_checksum == other_jma.node_list_checksum and 
+                not self.verify_animations_match(other_jma)):
+                self.nodes = []
+
         if not self.nodes:
             self.node_list_checksum = other_jma.node_list_checksum
+            self.version = other_jma.version
             self.nodes = []
             for node in other_jma.nodes:
                 self.nodes.append(
@@ -559,15 +619,18 @@ def read_jma(jma_string, stop_at="", anim_name=""):
     anim_name, ext = os.path.splitext(anim_name)
     anim_type, frame_info_type, world_relative = get_anim_types(ext)
 
-    jma_anim = JmaAnimation(anim_name, 0, anim_type,
-                            frame_info_type, world_relative)
     jma_string = jma_string.replace("\n", "\t")
 
     data = tuple(d for d in jma_string.split("\t") if d)
     dat_i = 0
+    version = parse_jm_int(data[dat_i])
 
-    if parse_jm_int(data[dat_i]) != 16392:
-        print("JMA identifier '16392' not found.")
+    jma_anim = JmaAnimation(anim_name, 0, anim_type,
+                            frame_info_type, world_relative,
+                            version=version)
+
+    if version not in JMA_VER_ALL:
+        print("Unknown JMA version '%s' found." % version)
         return jma_anim
 
     dat_i += 1
@@ -640,17 +703,31 @@ def read_jma(jma_string, stop_at="", anim_name=""):
             print("Could not read node list checksum.")
             return jma_anim
 
+        if jma_anim.node_list_checksum >= 0x80000000:
+            # jma gave us an unsigned checksum.... sign it
+            jma_anim.node_list_checksum -= 0x100000000
+
         if stop_at == "nodes": continue
 
         # read the nodes
         try:
             i = 0  # make sure i is defined in case of exception
             nodes[:] = [None] * node_count
             for i in range(node_count):
-                nodes[i] = JmsNode(
-                    data[dat_i], parse_jm_int(data[dat_i+1]), parse_jm_int(data[dat_i+2])
-                    )
-                dat_i += 3
+                if jma_anim.has_node_hierarchy:
+                    node_data = (
+                        data[dat_i],
+                        parse_jm_int(data[dat_i+1]),
+                        parse_jm_int(data[dat_i+2])
+                        )
+                    dat_i += 3
+                elif jma_anim.has_node_names:
+                    node_data = (data[dat_i], )
+                    dat_i += 1
+                else:
+                    node_data = ("fake_node_%d" % i, )
+
+                nodes[i] = JmsNode(*node_data)
             JmsNode.setup_node_hierarchy(nodes)
         except Exception:
             print(traceback.format_exc())
@@ -705,7 +782,7 @@ def write_jma(filepath, jma_anim, use_blitzkrieg_rounding=False):
         jma_anim.apply_root_node_info_to_states()
 
     with filepath.open("w", encoding='latin1', newline="\r\n") as f:
-        f.write("16392\n")  # version number
+        f.write("%d\n" % jma_anim.version)
         f.write("%s\n" % jma_anim.frame_count)
         f.write("%s\n" % jma_anim.frame_rate)
 
@@ -720,10 +797,14 @@ def write_jma(filepath, jma_anim, use_blitzkrieg_rounding=False):
             f.write("%s\n" % len(nodes))
             f.write("%s\n" % int(jma_anim.node_list_checksum))
 
-            for node in nodes:
-                f.write("%s\n%s\n%s\n" %
-                    (node.name[: 31], node.first_child, node.sibling_index)
-                )
+            if jma_anim.has_node_hierarchy:
+                for node in nodes:
+                    f.write("%s\n%s\n%s\n" %
+                        (node.name[: 31], node.first_child, node.sibling_index)
+                    )
+            elif jma_anim.has_node_names:
+                for node in nodes:
+                    f.write("%s\n" % node.name[: 31])
 
             for frame in frames:
                 for nf in frame:

reclaimer/animation/util.py

@@ -11,9 +11,10 @@
 
 from math import pi
 
+from reclaimer.util import get_block_max
 from reclaimer.enums import unit_animation_names, unit_weapon_animation_names,\
      unit_weapon_type_animation_names, vehicle_animation_names,\
-     weapon_animation_names, device_animation_names, fp_animation_names,\
+     weapon_animation_names, device_animation_names, fp_animation_names_mcc,\
      unit_damage_animation_names
 from reclaimer.hek.defs.mod2 import TagDef, Pad, marker as mod2_marker_desc,\
      node as mod2_node_desc, reflexive, Struct
@@ -89,7 +90,7 @@ def split_anim_name_into_type_strings(anim_name):
         if part3: remainder = " ".join((part3, remainder))
 
         part2, part2_sani, perm_num = split_permutation_number(part2, remainder)
-        if ((part1_sani == "first-person" and part2_sani in fp_animation_names) or
+        if ((part1_sani == "first-person" and part2_sani in fp_animation_names_mcc) or
             (part1_sani == "vehicle" and part2_sani in vehicle_animation_names) or
             (part1_sani == "device"  and part2_sani in device_animation_names)):
             type_strings = part1_sani, part2_sani, perm_num
@@ -215,9 +216,10 @@ def set_animation_index(antr_tag, anim_name, anim_index,
 
     if part1 == "suspension":
         anim_name = anim_name.split(" ", 1)[1]
-        anim_enums = antr_vehicles[0].suspension_animations.STEPTREE
-        if len(anim_enums) >= 8:
-            # max of 8 suspension animations
+        susp_anims = antr_vehicles[0].suspension_animations
+        anim_enums = susp_anims.STEPTREE
+        if len(anim_enums) >= get_block_max(susp_anims):
+            # at the limit of suspension animations
             return False
 
         anim_enums.append()
@@ -226,7 +228,8 @@ def set_animation_index(antr_tag, anim_name, anim_index,
 
     elif part1 in ("first-person", "device", "vehicle"):
         if part1 == "first-person":
-            options = fp_animation_names
+            # NOTE: using mcc because they're the same, with an extension
+            options = fp_animation_names_mcc
             block = antr_fp_animations
         elif part1 == "device":
             options = device_animation_names
@@ -238,6 +241,10 @@ def set_animation_index(antr_tag, anim_name, anim_index,
         if not block:
             block.append()
 
+        # trim the options to how many are actually allowed
+        # NOTE: this is really just for fp_animation_names_mcc
+        max_anims   = get_block_max(block[0].animations)
+        options     = options[:max_anims]
         try:
             enum_index = options.index(part2)
         except ValueError:
@@ -338,7 +345,7 @@ def set_animation_index(antr_tag, anim_name, anim_index,
             break
 
     if unit is None:
-        if len(antr_units) >= antr_units.MAX:
+        if len(antr_units) >= get_block_max(antr_units.parent):
             return False
 
         antr_units.append()
@@ -369,7 +376,7 @@ def set_animation_index(antr_tag, anim_name, anim_index,
             break
 
     if unit_weap is None:
-        if len(unit_weaps) >= unit_weaps.MAX:
+        if len(unit_weaps) >= get_block_max(unit_weaps.parent):
             return False
 
         unit_weaps.append()
@@ -397,7 +404,7 @@ def set_animation_index(antr_tag, anim_name, anim_index,
             break
 
     if unit_weap_type is None:
-        if len(unit_weap_types) >= unit_weap_types.MAX:
+        if len(unit_weap_types) >= get_block_max(unit_weap_types.parent):
             return False
 
         unit_weap_types.append()