jak3: speedrunner mode (#3761)

Base implementation of the popup menu and speedrunner mode in Jak 3.
Autosplitter is untested because I'm on Linux.

Also a couple of other misc changes:

- Model replacements can now have custom bone weights. Needs the "Use
Custom Bone Weights" property (provided by the OpenGOAL Blender plugin)
enabled in Blender.
- Better error message for lump syntax errors in custom level JSON
files.

custom_assets/blender_plugins/opengoal.py

@@ -90,6 +90,7 @@ def draw_func_ob(self, context):
     layout = self.layout
     ob = context.object
     layout.prop(ob, "set_invisible")
+    layout.prop(ob, "enable_custom_weights")
     layout.prop(ob, "set_collision")
     if (ob.set_collision):
         layout.prop(ob, "ignore")
@@ -116,6 +117,7 @@ def register():
 
     bpy.types.Object.set_invisible = bpy.props.BoolProperty(name="Invisible")
     bpy.types.Object.set_collision = bpy.props.BoolProperty(name="Apply Collision Properties")
+    bpy.types.Object.enable_custom_weights = bpy.props.BoolProperty(name="Use Custom Bone Weights")
     bpy.types.Object.ignore = bpy.props.BoolProperty(name="ignore")
     bpy.types.Object.noedge = bpy.props.BoolProperty(name="No-Edge")
     bpy.types.Object.noentity = bpy.props.BoolProperty(name="No-Entity")

decompiler/level_extractor/merc_replacement.cpp

@@ -9,7 +9,8 @@ void extract(const std::string& name,
              const std::vector<NodeWithTransform>& all_nodes,
              u32 index_offset,
              u32 vertex_offset,
-             u32 tex_offset) {
+             u32 tex_offset,
+             bool& has_custom_weights) {
   ASSERT(out.new_vertices.empty());
 
   std::map<int, tfrag3::MercDraw> draw_by_material;
@@ -24,6 +25,8 @@ void extract(const std::string& name,
     if (node.mesh >= 0) {
       const auto& mesh = model.meshes[node.mesh];
       mesh_count++;
+      has_custom_weights = node.extras.Has("enable_custom_weights") &&
+                           node.extras.Get("enable_custom_weights").Get<int>();
       for (const auto& prim : mesh.primitives) {
         prim_count++;
         // extract index buffer
@@ -39,6 +42,21 @@ void extract(const std::string& name,
         out.normals.insert(out.normals.end(), verts.normals.begin(), verts.normals.end());
         ASSERT(out.new_colors.size() == out.new_vertices.size());
 
+        if (prim.attributes.count("JOINTS_0") && prim.attributes.count("WEIGHTS_0")) {
+          auto joints_and_weights = gltf_util::extract_and_flatten_joints_and_weights(model, prim);
+          ASSERT(joints_and_weights.size() == verts.vtx.size());
+          out.joints_and_weights.insert(out.joints_and_weights.end(), joints_and_weights.begin(),
+                                        joints_and_weights.end());
+        } else {
+          // add fake data for vertices without this data
+          gltf_util::JointsAndWeights dummy;
+          dummy.joints[0] = 3;
+          dummy.weights[0] = 1.f;
+          for (size_t i = 0; i < out.new_vertices.size(); i++) {
+            out.joints_and_weights.push_back(dummy);
+          }
+        }
+
         // TODO: just putting it all in one material
         auto& draw = draw_by_material[prim.material];
         draw.mode = gltf_util::make_default_draw_mode();  // todo rm
@@ -119,14 +137,16 @@ const tfrag3::MercVertex& find_closest(const std::vector<tfrag3::MercVertex>& ol
 
 void merc_convert_replacement(MercSwapData& out,
                               const MercExtractData& in,
-                              const std::vector<tfrag3::MercVertex>& old_verts) {
+                              const std::vector<tfrag3::MercVertex>& old_verts,
+                              bool use_custom_weights) {
   out.new_model = in.new_model;
   out.new_indices = in.new_indices;
   out.new_textures = in.tex_pool.textures_by_idx;
 
   // convert vertices
   for (size_t i = 0; i < in.new_vertices.size(); i++) {
     const auto& y = in.new_vertices[i];
+
     const auto& copy_from = find_closest(old_verts, y.x, y.y, y.z);
     auto& x = out.new_vertices.emplace_back();
     x.pos[0] = y.x;
@@ -135,18 +155,27 @@ void merc_convert_replacement(MercSwapData& out,
     x.normal[0] = in.normals.at(i).x();
     x.normal[1] = in.normals.at(i).y();
     x.normal[2] = in.normals.at(i).z();
-    x.weights[0] = copy_from.weights[0];
-    x.weights[1] = copy_from.weights[1];
-    x.weights[2] = copy_from.weights[2];
+    if (use_custom_weights) {
+      x.weights[0] = in.joints_and_weights.at(i).weights[0];
+      x.weights[1] = in.joints_and_weights.at(i).weights[1];
+      x.weights[2] = in.joints_and_weights.at(i).weights[2];
+      x.mats[0] = in.joints_and_weights.at(i).joints[0];
+      x.mats[1] = in.joints_and_weights.at(i).joints[1];
+      x.mats[2] = in.joints_and_weights.at(i).joints[2];
+    } else {
+      x.weights[0] = copy_from.weights[0];
+      x.weights[1] = copy_from.weights[1];
+      x.weights[2] = copy_from.weights[2];
+      x.mats[0] = copy_from.mats[0];
+      x.mats[1] = copy_from.mats[1];
+      x.mats[2] = copy_from.mats[2];
+    }
     x.st[0] = y.s;
     x.st[1] = y.t;
     x.rgba[0] = in.new_colors[i][0];
     x.rgba[1] = in.new_colors[i][1];
     x.rgba[2] = in.new_colors[i][2];
     x.rgba[3] = in.new_colors[i][3];
-    x.mats[0] = copy_from.mats[0];
-    x.mats[1] = copy_from.mats[1];
-    x.mats[2] = copy_from.mats[2];
   }
 }
 
@@ -165,18 +194,18 @@ void merc_convert_custom(MercSwapData& out, const MercExtractData& in) {
     x.normal[0] = in.normals.at(i).x();
     x.normal[1] = in.normals.at(i).y();
     x.normal[2] = in.normals.at(i).z();
-    x.weights[0] = 1.0f;
-    x.weights[1] = 0.0f;
-    x.weights[2] = 0.0f;
+    x.weights[0] = in.joints_and_weights.at(i).weights[0];
+    x.weights[1] = in.joints_and_weights.at(i).weights[1];
+    x.weights[2] = in.joints_and_weights.at(i).weights[2];
     x.st[0] = y.s;
     x.st[1] = y.t;
     x.rgba[0] = in.new_colors[i][0];
     x.rgba[1] = in.new_colors[i][1];
     x.rgba[2] = in.new_colors[i][2];
     x.rgba[3] = in.new_colors[i][3];
-    x.mats[0] = 3;
-    x.mats[1] = 0;
-    x.mats[2] = 0;
+    x.mats[0] = in.joints_and_weights.at(i).joints[0];
+    x.mats[1] = in.joints_and_weights.at(i).joints[1];
+    x.mats[2] = in.joints_and_weights.at(i).joints[2];
   }
 }
 
@@ -199,12 +228,13 @@ MercSwapData load_replacement_merc_model(const std::string& name,
   auto all_nodes = flatten_nodes_from_all_scenes(model);
 
   MercExtractData extract_data;
+  auto has_custom_weights = false;
   extract(name, extract_data, model, all_nodes, current_idx_count, current_vtx_count,
-          current_tex_count);
+          current_tex_count, has_custom_weights);
   if (custom_mdl) {
     merc_convert_custom(result, extract_data);
   } else {
-    merc_convert_replacement(result, extract_data, old_verts);
+    merc_convert_replacement(result, extract_data, old_verts, has_custom_weights);
   }
 
   return result;

decompiler/level_extractor/merc_replacement.h

@@ -10,7 +10,7 @@ struct MercExtractData {
   std::vector<tfrag3::PreloadedVertex> new_vertices;
   std::vector<math::Vector<u8, 4>> new_colors;
   std::vector<math::Vector3f> normals;
-
+  std::vector<gltf_util::JointsAndWeights> joints_and_weights;
   tfrag3::MercModel new_model;
 };
 

game/kernel/jak2/kmachine_extras.h

@@ -11,8 +11,6 @@ void pc_set_levels(u32 lev_list);
 void pc_set_active_levels(u32 lev_list);
 u32 alloc_vagdir_names(u32 heap_sym);
 inline u64 bool_to_symbol(const bool val);
-// TODO - move to common
-void encode_utf8_string(u32 src_str_ptr, u32 str_dest_ptr);
 void init_autosplit_struct();
 void callback_fetch_external_speedrun_times(bool success,
                                             const std::string& cache_id,

game/kernel/jak3/kmachine.cpp

@@ -369,7 +369,8 @@ void InitMachine_PCPort() {
   make_function_symbol_from_c("__pc-set-active-levels",
                               (void*)kmachine_extras::pc_set_active_levels);
   make_function_symbol_from_c("__pc-get-tex-remap", (void*)lookup_jak3_texture_dest_offset);
-  // make_function_symbol_from_c("pc-init-autosplitter-struct", (void*)init_autosplit_struct);
+  make_function_symbol_from_c("pc-init-autosplitter-struct",
+                              (void*)kmachine_extras::init_autosplit_struct);
 
   // discord rich presence
   make_function_symbol_from_c("pc-discord-rpc-update", (void*)kmachine_extras::update_discord_rpc);
@@ -395,6 +396,45 @@ void InitMachine_PCPort() {
                               (void*)pc_get_num_external_highscores);
  */
 
+  // speedrunning stuff
+  make_function_symbol_from_c("pc-sr-mode-get-practice-entries-amount",
+                              (void*)kmachine_extras::pc_sr_mode_get_practice_entries_amount);
+  make_function_symbol_from_c("pc-sr-mode-get-practice-entry-name",
+                              (void*)kmachine_extras::pc_sr_mode_get_practice_entry_name);
+  make_function_symbol_from_c("pc-sr-mode-get-practice-entry-continue-point",
+                              (void*)kmachine_extras::pc_sr_mode_get_practice_entry_continue_point);
+  make_function_symbol_from_c(
+      "pc-sr-mode-get-practice-entry-history-success",
+      (void*)kmachine_extras::pc_sr_mode_get_practice_entry_history_success);
+  make_function_symbol_from_c(
+      "pc-sr-mode-get-practice-entry-history-attempts",
+      (void*)kmachine_extras::pc_sr_mode_get_practice_entry_history_attempts);
+  make_function_symbol_from_c(
+      "pc-sr-mode-get-practice-entry-session-success",
+      (void*)kmachine_extras::pc_sr_mode_get_practice_entry_session_success);
+  make_function_symbol_from_c(
+      "pc-sr-mode-get-practice-entry-session-attempts",
+      (void*)kmachine_extras::pc_sr_mode_get_practice_entry_session_attempts);
+  make_function_symbol_from_c("pc-sr-mode-get-practice-entry-avg-time",
+                              (void*)kmachine_extras::pc_sr_mode_get_practice_entry_avg_time);
+  make_function_symbol_from_c("pc-sr-mode-get-practice-entry-fastest-time",
+                              (void*)kmachine_extras::pc_sr_mode_get_practice_entry_fastest_time);
+  make_function_symbol_from_c("pc-sr-mode-record-practice-entry-attempt!",
+                              (void*)kmachine_extras::pc_sr_mode_record_practice_entry_attempt);
+  make_function_symbol_from_c("pc-sr-mode-init-practice-info!",
+                              (void*)kmachine_extras::pc_sr_mode_init_practice_info);
+  make_function_symbol_from_c("pc-sr-mode-get-custom-category-amount",
+                              (void*)kmachine_extras::pc_sr_mode_get_custom_category_amount);
+  make_function_symbol_from_c("pc-sr-mode-get-custom-category-name",
+                              (void*)kmachine_extras::pc_sr_mode_get_custom_category_name);
+  make_function_symbol_from_c(
+      "pc-sr-mode-get-custom-category-continue-point",
+      (void*)kmachine_extras::pc_sr_mode_get_custom_category_continue_point);
+  make_function_symbol_from_c("pc-sr-mode-init-custom-category-info!",
+                              (void*)kmachine_extras::pc_sr_mode_init_custom_category_info);
+  make_function_symbol_from_c("pc-sr-mode-dump-new-custom-category",
+                              (void*)kmachine_extras::pc_sr_mode_dump_new_custom_category);
+
   // setup string constants
   auto user_dir_path = file_util::get_user_config_dir();
   intern_from_c(-1, 0, "*pc-user-dir-base-path*")->value() =