object_bake_simulation.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include <sstream>
 
#include "BLI_fileops.hh"
#include "BLI_listbase.h"
#include "BLI_path_utils.hh"
#include "BLI_string.h"
#include "BLI_vector.hh"
 
#include "BLT_translation.hh"
 
#include "WM_api.hh"
#include "WM_types.hh"
 
#include "ED_object.hh"
#include "ED_screen.hh"
 
#include "DNA_array_utils.hh"
#include "DNA_modifier_types.h"
#include "DNA_windowmanager_types.h"
 
#include "BKE_bake_geometry_nodes_modifier.hh"
#include "BKE_bake_geometry_nodes_modifier_pack.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_lib_id.hh"
#include "BKE_library.hh"
#include "BKE_main.hh"
#include "BKE_modifier.hh"
#include "BKE_node_legacy_types.hh"
#include "BKE_node_runtime.hh"
#include "BKE_packedFile.hh"
#include "BKE_report.hh"
#include "BKE_scene.hh"
 
#include "RNA_access.hh"
#include "RNA_define.hh"
 
#include "DEG_depsgraph.hh"
 
#include "MOD_nodes.hh"
 
#include "object_intern.hh"
 
#include "UI_interface.hh"
#include "UI_interface_layout.hh"
 
namespace bake = blender::bke::bake;
 
namespace blender::ed::object::bake_simulation {
 
static bool simulate_to_frame_poll(bContext *C)
{
  if (!ED_operator_object_active(C)) {
    return false;
  }
  return true;
}
 
struct SimulateToFrameJob {
  wmWindowManager *wm;
  Main *bmain;
  Depsgraph *depsgraph;
  Scene *scene;
  Vector<Object *> objects;
  int start_frame;
  int end_frame;
};
 
static void simulate_to_frame_startjob(void *customdata, wmJobWorkerStatus *worker_status)
{
  SimulateToFrameJob &job = *static_cast<SimulateToFrameJob *>(customdata);
  G.is_rendering = true;
  G.is_break = false;
  WM_locked_interface_set(job.wm, true);
 
  Vector<Object *> objects_to_calc;
  for (Object *object : job.objects) {
    if (!BKE_id_is_editable(job.bmain, &object->id)) {
      continue;
    }
    LISTBASE_FOREACH (ModifierData *, md, &object->modifiers) {
      if (md->type != eModifierType_Nodes) {
        continue;
      }
      NodesModifierData *nmd = reinterpret_cast<NodesModifierData *>(md);
      if (!nmd->runtime->cache) {
        continue;
      }
      for (auto item : nmd->runtime->cache->simulation_cache_by_id.items()) {
        if (item.value->cache_status != bake::CacheStatus::Baked) {
          item.value->reset();
        }
      }
    }
    objects_to_calc.append(object);
  }
 
  worker_status->progress = 0.0f;
  worker_status->do_update = true;
 
  const float frame_step_size = 1.0f;
  const float progress_per_frame = 1.0f /
                                   (float(job.end_frame - job.start_frame + 1) / frame_step_size);
  const int old_frame = job.scene->r.cfra;
 
  for (float frame_f = job.start_frame; frame_f <= job.end_frame; frame_f += frame_step_size) {
    const SubFrame frame{frame_f};
 
    if (G.is_break || worker_status->stop) {
      break;
    }
 
    job.scene->r.cfra = frame.frame();
    job.scene->r.subframe = frame.subframe();
 
    BKE_scene_graph_update_for_newframe(job.depsgraph);
 
    worker_status->progress += progress_per_frame;
    worker_status->do_update = true;
  }
 
  job.scene->r.cfra = old_frame;
  DEG_time_tag_update(job.bmain);
 
  worker_status->progress = 1.0f;
  worker_status->do_update = true;
}
 
static void simulate_to_frame_endjob(void *customdata)
{
  SimulateToFrameJob &job = *static_cast<SimulateToFrameJob *>(customdata);
  WM_locked_interface_set(job.wm, false);
  G.is_rendering = false;
  WM_main_add_notifier(NC_OBJECT | ND_MODIFIER, nullptr);
}
 
static wmOperatorStatus simulate_to_frame_invoke(bContext *C,
                                                 wmOperator *op,
                                                 const wmEvent * /*event*/)
{
  wmWindowManager *wm = CTX_wm_manager(C);
  Scene *scene = CTX_data_scene(C);
  Depsgraph *depsgraph = CTX_data_depsgraph_pointer(C);
  Main *bmain = CTX_data_main(C);
 
  SimulateToFrameJob *job = MEM_new<SimulateToFrameJob>(__func__);
  job->wm = wm;
  job->bmain = bmain;
  job->depsgraph = depsgraph;
  job->scene = scene;
  job->start_frame = scene->r.sfra;
  job->end_frame = scene->r.cfra;
 
  if (RNA_boolean_get(op->ptr, "selected")) {
    CTX_DATA_BEGIN (C, Object *, object, selected_objects) {
      job->objects.append(object);
    }
    CTX_DATA_END;
  }
  else {
    if (Object *object = CTX_data_active_object(C)) {
      job->objects.append(object);
    }
  }
 
  wmJob *wm_job = WM_jobs_get(wm,
                              CTX_wm_window(C),
                              CTX_data_scene(C),
                              "Calculating simulation...",
                              WM_JOB_PROGRESS,
                              WM_JOB_TYPE_CALCULATE_SIMULATION_NODES);
 
  WM_jobs_customdata_set(
      wm_job, job, [](void *job) { MEM_delete(static_cast<SimulateToFrameJob *>(job)); });
  WM_jobs_timer(wm_job, 0.1, NC_OBJECT | ND_MODIFIER, NC_OBJECT | ND_MODIFIER);
  WM_jobs_callbacks(
      wm_job, simulate_to_frame_startjob, nullptr, nullptr, simulate_to_frame_endjob);
 
  WM_jobs_start(CTX_wm_manager(C), wm_job);
  WM_event_add_modal_handler(C, op);
  return OPERATOR_RUNNING_MODAL;
}
 
static wmOperatorStatus simulate_to_frame_modal(bContext *C,
                                                wmOperator * /*op*/,
                                                const wmEvent * /*event*/)
{
  if (!WM_jobs_test(CTX_wm_manager(C), CTX_data_scene(C), WM_JOB_TYPE_CALCULATE_SIMULATION_NODES))
  {
    return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
  }
  return OPERATOR_PASS_THROUGH;
}
 
static bool bake_simulation_poll(bContext *C)
{
  if (!ED_operator_object_active(C)) {
    return false;
  }
  Object *ob = context_active_object(C);
  const bool use_frame_cache = ob->flag & OB_FLAG_USE_SIMULATION_CACHE;
  if (!use_frame_cache) {
    CTX_wm_operator_poll_msg_set(C, "Cache has to be enabled");
    return false;
  }
  return true;
}
 
struct NodeBakeRequest {
  Object *object;
  NodesModifierData *nmd;
  int bake_id;
  int node_type;

  std::optional<bake::BakePath> path;
  int frame_start;
  int frame_end;
  std::unique_ptr<bake::BlobWriteSharing> blob_sharing;
};
 
struct BakeGeometryNodesJob {
  wmWindowManager *wm;
  Main *bmain;
  Depsgraph *depsgraph;
  Scene *scene;
  Vector<NodeBakeRequest> bake_requests;
  wmOperator *op;
  std::string error_message;
};
 
static void try_delete_bake(
    Main *bmain, Object &object, NodesModifierData &nmd, const int bake_id, ReportList *reports);
static void reset_old_bake_cache(NodeBakeRequest &request);
 
static void request_bakes_in_modifier_cache(BakeGeometryNodesJob &job)
{
  for (NodeBakeRequest &request : job.bake_requests) {
    request.nmd->runtime->cache->requested_bakes.add(request.bake_id);
    /* Using #DEG_id_tag_update would tag this as user-modified which is not the case here and has
     * the issue that it invalidates simulation caches. */
    DEG_id_tag_update_for_side_effect_request(
        job.depsgraph, &request.object->id, ID_RECALC_GEOMETRY);
  }
}
 
static void clear_requested_bakes_in_modifier_cache(BakeGeometryNodesJob &job)
{
  for (NodeBakeRequest &request : job.bake_requests) {
    request.nmd->runtime->cache->requested_bakes.clear();
  }
}
 
static void bake_geometry_nodes_startjob(void *customdata, wmJobWorkerStatus *worker_status)
{
  BakeGeometryNodesJob &job = *static_cast<BakeGeometryNodesJob *>(customdata);
  G.is_rendering = true;
  G.is_break = false;
 
  int global_bake_start_frame = INT32_MAX;
  int global_bake_end_frame = INT32_MIN;
 
  for (NodeBakeRequest &request : job.bake_requests) {
    global_bake_start_frame = std::min(global_bake_start_frame, request.frame_start);
    global_bake_end_frame = std::max(global_bake_end_frame, request.frame_end);
  }
 
  worker_status->progress = 0.0f;
  worker_status->do_update = true;
 
  const int frames_to_bake = global_bake_end_frame - global_bake_start_frame + 1;
 
  const float frame_step_size = 1.0f;
  const float progress_per_frame = frame_step_size / frames_to_bake;
  const int old_frame = job.scene->r.cfra;
 
  struct MemoryBakeFile {
    std::string name;
    std::string data;
  };
 
  struct PackedBake {
    Vector<MemoryBakeFile> meta_files;
    Vector<MemoryBakeFile> blob_files;
  };
 
  Map<NodeBakeRequest *, PackedBake> packed_data_by_bake;
  Map<NodeBakeRequest *, int64_t> size_by_bake;
 
  for (float frame_f = global_bake_start_frame; frame_f <= global_bake_end_frame;
       frame_f += frame_step_size)
  {
    const SubFrame frame{frame_f};
 
    if (G.is_break || worker_status->stop) {
      break;
    }
 
    job.scene->r.cfra = frame.frame();
    job.scene->r.subframe = frame.subframe();
 
    request_bakes_in_modifier_cache(job);
 
    BKE_scene_graph_update_for_newframe(job.depsgraph);
 
    clear_requested_bakes_in_modifier_cache(job);
 
    const std::string frame_file_name = bake::frame_to_file_name(frame);
 
    for (NodeBakeRequest &request : job.bake_requests) {
      NodesModifierData &nmd = *request.nmd;
      bake::ModifierCache &modifier_cache = *nmd.runtime->cache;
      const bake::NodeBakeCache *bake_cache = modifier_cache.get_node_bake_cache(request.bake_id);
      if (bake_cache == nullptr) {
        continue;
      }
      if (bake_cache->frames.is_empty()) {
        continue;
      }
      const bake::FrameCache &frame_cache = *bake_cache->frames.last();
      if (frame_cache.frame != frame) {
        continue;
      }
 
      int64_t &written_size = size_by_bake.lookup_or_add(&request, 0);
 
      if (request.path.has_value()) {
        char meta_path[FILE_MAX];
        BLI_path_join(meta_path,
                      sizeof(meta_path),
                      request.path->meta_dir.c_str(),
                      (frame_file_name + ".json").c_str());
        BLI_file_ensure_parent_dir_exists(meta_path);
        bake::DiskBlobWriter blob_writer{request.path->blobs_dir, frame_file_name};
        fstream meta_file{meta_path, std::ios::out};
        bake::serialize_bake(frame_cache.state, blob_writer, *request.blob_sharing, meta_file);
        written_size += blob_writer.written_size();
        written_size += meta_file.tellp();
      }
      else {
        PackedBake &packed_data = packed_data_by_bake.lookup_or_add_default(&request);
 
        bake::MemoryBlobWriter blob_writer{frame_file_name};
        std::ostringstream meta_file{std::ios::binary};
        bake::serialize_bake(frame_cache.state, blob_writer, *request.blob_sharing, meta_file);
 
        packed_data.meta_files.append({frame_file_name + ".json", meta_file.str()});
        const Map<std::string, bake::MemoryBlobWriter::OutputStream> &blob_stream_by_name =
            blob_writer.get_stream_by_name();
        for (auto &&item : blob_stream_by_name.items()) {
          std::string data = item.value.stream->str();
          if (data.empty()) {
            continue;
          }
          if (data.size() > PACKED_FILE_MAX_SIZE) {
            job.error_message = TIP_("A file is too large to be packed (>2GB).");
            return;
          }
          packed_data.blob_files.append({item.key, std::move(data)});
        }
        written_size += blob_writer.written_size();
        written_size += meta_file.tellp();
      }
    }
 
    worker_status->progress += progress_per_frame;
    worker_status->do_update = true;
  }
 
  /* Update bake sizes. */
  for (NodeBakeRequest &request : job.bake_requests) {
    NodesModifierBake *bake = request.nmd->find_bake(request.bake_id);
    bake->bake_size = size_by_bake.lookup_default(&request, 0);
  }
 
  /* Store gathered data as packed data. */
  for (NodeBakeRequest &request : job.bake_requests) {
    NodesModifierBake *bake = request.nmd->find_bake(request.bake_id);
 
    PackedBake *packed_data = packed_data_by_bake.lookup_ptr(&request);
    if (!packed_data) {
      continue;
    }
 
    NodesModifierPackedBake *packed_bake = MEM_callocN<NodesModifierPackedBake>(__func__);
 
    packed_bake->meta_files_num = packed_data->meta_files.size();
    packed_bake->blob_files_num = packed_data->blob_files.size();
 
    packed_bake->meta_files = MEM_calloc_arrayN<NodesModifierBakeFile>(packed_bake->meta_files_num,
                                                                       __func__);
    packed_bake->blob_files = MEM_calloc_arrayN<NodesModifierBakeFile>(packed_bake->blob_files_num,
                                                                       __func__);
 
    auto transfer_to_bake =
        [&](NodesModifierBakeFile *bake_files, MemoryBakeFile *memory_bake_files, const int num) {
          for (const int i : IndexRange(num)) {
            NodesModifierBakeFile &bake_file = bake_files[i];
            MemoryBakeFile &memory = memory_bake_files[i];
            bake_file.name = BLI_strdup_null(memory.name.c_str());
            const int64_t data_size = memory.data.size();
            if (data_size == 0) {
              continue;
            }
            const auto *sharing_info = new blender::ImplicitSharedValue<std::string>(
                std::move(memory.data));
            const void *data = sharing_info->data.data();
            bake_file.packed_file = BKE_packedfile_new_from_memory(data, data_size, sharing_info);
          }
        };
 
    transfer_to_bake(
        packed_bake->meta_files, packed_data->meta_files.data(), packed_bake->meta_files_num);
    transfer_to_bake(
        packed_bake->blob_files, packed_data->blob_files.data(), packed_bake->blob_files_num);
 
    /* Should have been freed before. */
    BLI_assert(bake->packed == nullptr);
    bake->packed = packed_bake;
  }
 
  /* Tag simulations as being baked. */
  for (NodeBakeRequest &request : job.bake_requests) {
    if (request.node_type != GEO_NODE_SIMULATION_OUTPUT) {
      continue;
    }
    NodesModifierData &nmd = *request.nmd;
    if (bake::SimulationNodeCache *node_cache = nmd.runtime->cache->get_simulation_node_cache(
            request.bake_id))
    {
      if (!node_cache->bake.frames.is_empty()) {
        /* Tag the caches as being baked so that they are not changed anymore. */
        node_cache->cache_status = bake::CacheStatus::Baked;
      }
    }
    DEG_id_tag_update(&request.object->id, ID_RECALC_GEOMETRY);
  }
 
  job.scene->r.cfra = old_frame;
  DEG_time_tag_update(job.bmain);
 
  worker_status->progress = 1.0f;
  worker_status->do_update = true;
}
 
static void bake_geometry_nodes_endjob(void *customdata)
{
  BakeGeometryNodesJob &job = *static_cast<BakeGeometryNodesJob *>(customdata);
  WM_locked_interface_set(job.wm, false);
  G.is_rendering = false;
  WM_main_add_notifier(NC_OBJECT | ND_MODIFIER, nullptr);
  WM_main_add_notifier(NC_NODE | ND_DISPLAY, nullptr);
  WM_main_add_notifier(NC_SPACE | ND_SPACE_VIEW3D | NS_VIEW3D_SHADING, nullptr);
 
  if (!job.error_message.empty()) {
    for (NodeBakeRequest &request : job.bake_requests) {
      reset_old_bake_cache(request);
      try_delete_bake(job.bmain, *request.object, *request.nmd, request.bake_id, job.op->reports);
    }
    BKE_report(job.op->reports, RPT_ERROR, job.error_message.c_str());
  }
}
 
static void clear_data_block_references(NodesModifierBake &bake)
{
  dna::array::clear<NodesModifierDataBlock>(&bake.data_blocks,
                                            &bake.data_blocks_num,
                                            &bake.active_data_block,
                                            [](NodesModifierDataBlock *data_block) {
                                              nodes_modifier_data_block_destruct(data_block, true);
                                            });
}
 
static void reset_old_bake_cache(NodeBakeRequest &request)
{
  switch (request.node_type) {
    case GEO_NODE_SIMULATION_OUTPUT: {
      if (bake::SimulationNodeCache *node_cache =
              request.nmd->runtime->cache->get_simulation_node_cache(request.bake_id))
      {
        node_cache->reset();
      }
      break;
    }
    case GEO_NODE_BAKE: {
      if (bake::BakeNodeCache *node_cache = request.nmd->runtime->cache->get_bake_node_cache(
              request.bake_id))
      {
        node_cache->reset();
      }
      break;
    }
  }
}
 
static void try_delete_bake(
    Main *bmain, Object &object, NodesModifierData &nmd, const int bake_id, ReportList *reports)
{
  if (!nmd.runtime->cache) {
    return;
  }
  bake::ModifierCache &modifier_cache = *nmd.runtime->cache;
  std::lock_guard lock{modifier_cache.mutex};
  if (auto *node_cache = modifier_cache.simulation_cache_by_id.lookup_ptr(bake_id)) {
    (*node_cache)->reset();
  }
  else if (auto *node_cache = modifier_cache.bake_cache_by_id.lookup_ptr(bake_id)) {
    (*node_cache)->reset();
  }
  NodesModifierBake *bake = nmd.find_bake(bake_id);
  if (!bake) {
    return;
  }
  clear_data_block_references(*bake);
 
  if (bake->packed) {
    nodes_modifier_packed_bake_free(bake->packed);
    bake->packed = nullptr;
  }
 
  const std::optional<bake::BakePath> bake_path = bake::get_node_bake_path(
      *bmain, object, nmd, bake_id);
  if (!bake_path) {
    return;
  }
  const char *meta_dir = bake_path->meta_dir.c_str();
  if (BLI_exists(meta_dir)) {
    if (BLI_delete(meta_dir, true, true)) {
      BKE_reportf(reports, RPT_ERROR, "Failed to remove metadata directory %s", meta_dir);
    }
  }
  const char *blobs_dir = bake_path->blobs_dir.c_str();
  if (BLI_exists(blobs_dir)) {
    if (BLI_delete(blobs_dir, true, true)) {
      BKE_reportf(reports, RPT_ERROR, "Failed to remove blobs directory %s", blobs_dir);
    }
  }
  if (bake_path->bake_dir.has_value()) {
    const char *zone_bake_dir = bake_path->bake_dir->c_str();
    /* Try to delete zone bake directory if it is empty. */
    BLI_delete(zone_bake_dir, true, false);
  }
  if (const std::optional<std::string> modifier_bake_dir = bake::get_modifier_bake_path(
          *bmain, object, nmd))
  {
    /* Try to delete modifier bake directory if it is empty. */
    BLI_delete(modifier_bake_dir->c_str(), true, false);
  }
}
 
enum class BakeRequestsMode {
  Sync,
  Async
};
 
static wmOperatorStatus start_bake_job(bContext *C,
                                       Vector<NodeBakeRequest> requests,
                                       wmOperator *op,
                                       const BakeRequestsMode mode)
{
  Main *bmain = CTX_data_main(C);
  for (NodeBakeRequest &request : requests) {
    reset_old_bake_cache(request);
    if (NodesModifierBake *bake = request.nmd->find_bake(request.bake_id)) {
      clear_data_block_references(*bake);
    }
    try_delete_bake(bmain, *request.object, *request.nmd, request.bake_id, op->reports);
  }
 
  BakeGeometryNodesJob *job = MEM_new<BakeGeometryNodesJob>(__func__);
  job->wm = CTX_wm_manager(C);
  job->bmain = CTX_data_main(C);
  job->depsgraph = CTX_data_depsgraph_pointer(C);
  job->scene = CTX_data_scene(C);
  job->bake_requests = std::move(requests);
  job->op = op;
  WM_locked_interface_set(job->wm, true);
 
  if (mode == BakeRequestsMode::Sync) {
    wmJobWorkerStatus worker_status{};
    bake_geometry_nodes_startjob(job, &worker_status);
    bake_geometry_nodes_endjob(job);
    MEM_delete(job);
    return OPERATOR_FINISHED;
  }
 
  wmJob *wm_job = WM_jobs_get(job->wm,
                              CTX_wm_window(C),
                              job->scene,
                              "Baking nodes...",
                              WM_JOB_PROGRESS,
                              WM_JOB_TYPE_BAKE_GEOMETRY_NODES);
 
  WM_jobs_customdata_set(
      wm_job, job, [](void *job) { MEM_delete(static_cast<BakeGeometryNodesJob *>(job)); });
  WM_jobs_timer(wm_job, 0.1, NC_OBJECT | ND_MODIFIER, NC_OBJECT | ND_MODIFIER);
  WM_jobs_callbacks(
      wm_job, bake_geometry_nodes_startjob, nullptr, nullptr, bake_geometry_nodes_endjob);
 
  WM_jobs_start(CTX_wm_manager(C), wm_job);
  WM_event_add_modal_handler(C, op);
  return OPERATOR_RUNNING_MODAL;
}
 
static Vector<NodeBakeRequest> collect_simulations_to_bake(Main &bmain,
                                                           Scene &scene,
                                                           const Span<Object *> objects)
{
  Vector<NodeBakeRequest> requests;
  for (Object *object : objects) {
    if (!BKE_id_is_editable(&bmain, &object->id)) {
      continue;
    }
    LISTBASE_FOREACH (ModifierData *, md, &object->modifiers) {
      if (md->type != eModifierType_Nodes) {
        continue;
      }
      if (!BKE_modifier_is_enabled(&scene, md, eModifierMode_Realtime)) {
        continue;
      }
      NodesModifierData *nmd = reinterpret_cast<NodesModifierData *>(md);
      if (!nmd->node_group) {
        continue;
      }
      if (!nmd->runtime->cache) {
        continue;
      }
      for (const bNestedNodeRef &nested_node_ref : nmd->node_group->nested_node_refs_span()) {
        const int id = nested_node_ref.id;
        const bNode *node = nmd->node_group->find_nested_node(id);
        if (node->type_legacy != GEO_NODE_SIMULATION_OUTPUT) {
          continue;
        }
        NodeBakeRequest request;
        request.object = object;
        request.nmd = nmd;
        request.bake_id = id;
        request.node_type = node->type_legacy;
        request.blob_sharing = std::make_unique<bake::BlobWriteSharing>();
        if (bake::get_node_bake_target(*object, *nmd, id) == NODES_MODIFIER_BAKE_TARGET_DISK) {
          request.path = bake::get_node_bake_path(bmain, *object, *nmd, id);
        }
        std::optional<IndexRange> frame_range = bake::get_node_bake_frame_range(
            scene, *object, *nmd, id);
        if (!frame_range) {
          continue;
        }
        request.frame_start = frame_range->first();
        request.frame_end = frame_range->last();
 
        requests.append(std::move(request));
      }
    }
  }
  return requests;
}
 
static Vector<NodeBakeRequest> bake_simulation_gather_requests(bContext *C, wmOperator *op)
{
  Scene *scene = CTX_data_scene(C);
  Main *bmain = CTX_data_main(C);
 
  Vector<Object *> objects;
  if (RNA_boolean_get(op->ptr, "selected")) {
    CTX_DATA_BEGIN (C, Object *, object, selected_objects) {
      objects.append(object);
    }
    CTX_DATA_END;
  }
  else {
    if (Object *object = CTX_data_active_object(C)) {
      objects.append(object);
    }
  }
 
  return collect_simulations_to_bake(*bmain, *scene, objects);
}
 
static wmOperatorStatus bake_simulation_exec(bContext *C, wmOperator *op)
{
  Vector<NodeBakeRequest> requests = bake_simulation_gather_requests(C, op);
  return start_bake_job(C, std::move(requests), op, BakeRequestsMode::Sync);
}
 
struct PathStringHash {
  uint64_t operator()(const StringRef s) const
  {
    /* Normalize the paths so we can compare them. */
    DynamicStackBuffer<256> norm_buf(s.size() + 1, 8);
    memcpy(norm_buf.buffer(), s.data(), s.size() + 1);
    char *norm = static_cast<char *>(norm_buf.buffer());
 
    BLI_path_slash_native(norm);
 
    /* Strip ending slash. */
    BLI_path_slash_rstrip(norm);
 
    BLI_path_normalize(norm);
    return get_default_hash(norm);
  }
};
 
struct PathStringEquality {
  bool operator()(const StringRef a, const StringRef b) const
  {
    return BLI_path_cmp_normalized(a.data(), b.data()) == 0;
  }
};
 
static bool bake_directory_has_data(const StringRefNull absolute_bake_dir)
{
  char meta_dir[FILE_MAX];
  BLI_path_join(meta_dir, sizeof(meta_dir), absolute_bake_dir.c_str(), "meta");
  char blobs_dir[FILE_MAX];
  BLI_path_join(blobs_dir, sizeof(blobs_dir), absolute_bake_dir.c_str(), "blobs");
 
  if (!BLI_is_dir(meta_dir) || !BLI_is_dir(blobs_dir)) {
    return false;
  }
 
  return true;
}
 
static bool may_have_disk_bake(const NodesModifierData &nmd)
{
  if (nmd.bake_target == NODES_MODIFIER_BAKE_TARGET_DISK) {
    return true;
  }
  for (const NodesModifierBake &bake : Span{nmd.bakes, nmd.bakes_num}) {
    if (bake.bake_target == NODES_MODIFIER_BAKE_TARGET_DISK) {
      return true;
    }
  }
  return false;
}
 
static void initialize_modifier_bake_directory_if_necessary(bContext *C,
                                                            Object &object,
                                                            NodesModifierData &nmd,
                                                            wmOperator *op)
{
  const bool bake_directory_set = !StringRef(nmd.bake_directory).is_empty();
  if (bake_directory_set) {
    return;
  }
  if (!may_have_disk_bake(nmd)) {
    return;
  }
 
  Main *bmain = CTX_data_main(C);
 
  BKE_reportf(op->reports,
              RPT_INFO,
              "Bake directory of object %s, modifier %s is empty, setting default path",
              object.id.name + 2,
              nmd.modifier.name);
 
  nmd.bake_directory = BLI_strdup(
      bake::get_default_modifier_bake_directory(*bmain, object, nmd).c_str());
}
 
static void bake_simulation_validate_paths(bContext *C,
                                           wmOperator *op,
                                           const Span<Object *> objects)
{
  Main *bmain = CTX_data_main(C);
 
  for (Object *object : objects) {
    if (!BKE_id_is_editable(bmain, &object->id)) {
      continue;
    }
 
    LISTBASE_FOREACH (ModifierData *, md, &object->modifiers) {
      if (md->type != eModifierType_Nodes) {
        continue;
      }
      NodesModifierData *nmd = reinterpret_cast<NodesModifierData *>(md);
      initialize_modifier_bake_directory_if_necessary(C, *object, *nmd, op);
    }
  }
}
 
/* Map for counting path references. */
using PathUsersMap = Map<std::string,
                         int,
                         default_inline_buffer_capacity(sizeof(std::string)),
                         DefaultProbingStrategy,
                         PathStringHash,
                         PathStringEquality>;
 
static PathUsersMap bake_simulation_get_path_users(bContext *C, const Span<Object *> objects)
{
  Main *bmain = CTX_data_main(C);
 
  PathUsersMap path_users;
  for (const Object *object : objects) {
    const char *base_path = ID_BLEND_PATH(bmain, &object->id);
 
    LISTBASE_FOREACH (const ModifierData *, md, &object->modifiers) {
      if (md->type != eModifierType_Nodes) {
        continue;
      }
      const NodesModifierData *nmd = reinterpret_cast<const NodesModifierData *>(md);
      if (StringRef(nmd->bake_directory).is_empty()) {
        continue;
      }
 
      char absolute_bake_dir[FILE_MAX];
      STRNCPY(absolute_bake_dir, nmd->bake_directory);
      BLI_path_abs(absolute_bake_dir, base_path);
      path_users.add_or_modify(
          absolute_bake_dir, [](int *value) { *value = 1; }, [](int *value) { ++(*value); });
    }
  }
 
  return path_users;
}
 
static wmOperatorStatus bake_simulation_invoke(bContext *C,
                                               wmOperator *op,
                                               const wmEvent * /*event*/)
{
  Vector<Object *> objects;
  if (RNA_boolean_get(op->ptr, "selected")) {
    CTX_DATA_BEGIN (C, Object *, object, selected_objects) {
      objects.append(object);
    }
    CTX_DATA_END;
  }
  else {
    if (Object *object = CTX_data_active_object(C)) {
      objects.append(object);
    }
  }
 
  /* Set empty paths to default if necessary. */
  bake_simulation_validate_paths(C, op, objects);
 
  PathUsersMap path_users = bake_simulation_get_path_users(C, objects);
  bool has_path_conflict = false;
  bool has_existing_bake_data = false;
  for (const auto &item : path_users.items()) {
    /* Check if multiple caches are writing to the same bake directory. */
    if (item.value > 1) {
      BKE_reportf(op->reports,
                  RPT_ERROR,
                  "Path conflict: %d caches set to path %s",
                  item.value,
                  item.key.data());
      has_path_conflict = true;
    }
 
    /* Check if path exists and contains bake data already. */
    if (bake_directory_has_data(item.key.data())) {
      has_existing_bake_data = true;
    }
  }
 
  if (has_path_conflict) {
    UI_popup_menu_reports(C, op->reports);
    return OPERATOR_CANCELLED;
  }
  if (has_existing_bake_data) {
    return WM_operator_confirm_ex(C,
                                  op,
                                  IFACE_("Overwrite existing bake data?"),
                                  nullptr,
                                  IFACE_("Bake"),
                                  ALERT_ICON_NONE,
                                  false);
  }
  Vector<NodeBakeRequest> requests = bake_simulation_gather_requests(C, op);
  return start_bake_job(C, std::move(requests), op, BakeRequestsMode::Async);
}
 
static wmOperatorStatus bake_simulation_modal(bContext *C,
                                              wmOperator * /*op*/,
                                              const wmEvent * /*event*/)
{
  if (!WM_jobs_test(CTX_wm_manager(C), CTX_data_scene(C), WM_JOB_TYPE_BAKE_GEOMETRY_NODES)) {
    return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
  }
  return OPERATOR_PASS_THROUGH;
}
 
static wmOperatorStatus delete_baked_simulation_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
 
  Vector<Object *> objects;
  if (RNA_boolean_get(op->ptr, "selected")) {
    CTX_DATA_BEGIN (C, Object *, object, selected_objects) {
      objects.append(object);
    }
    CTX_DATA_END;
  }
  else {
    if (Object *object = CTX_data_active_object(C)) {
      objects.append(object);
    }
  }
 
  if (objects.is_empty()) {
    return OPERATOR_CANCELLED;
  }
 
  for (Object *object : objects) {
    LISTBASE_FOREACH (ModifierData *, md, &object->modifiers) {
      if (md->type == eModifierType_Nodes) {
        NodesModifierData *nmd = reinterpret_cast<NodesModifierData *>(md);
        for (const NodesModifierBake &bake : Span(nmd->bakes, nmd->bakes_num)) {
          try_delete_bake(bmain, *object, *nmd, bake.id, op->reports);
        }
      }
    }
 
    DEG_id_tag_update(&object->id, ID_RECALC_GEOMETRY);
  }
 
  WM_event_add_notifier(C, NC_OBJECT | ND_MODIFIER, nullptr);
 
  return OPERATOR_FINISHED;
}
 
static Vector<NodeBakeRequest> bake_single_node_gather_bake_request(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Scene *scene = CTX_data_scene(C);
  Object *object = reinterpret_cast<Object *>(
      WM_operator_properties_id_lookup_from_name_or_session_uid(bmain, op->ptr, ID_OB));
  if (object == nullptr) {
    return {};
  }
  std::string modifier_name = RNA_string_get(op->ptr, "modifier_name");
  ModifierData *md = BKE_modifiers_findby_name(object, modifier_name.c_str());
  if (md == nullptr) {
    return {};
  }
  NodesModifierData &nmd = *reinterpret_cast<NodesModifierData *>(md);
  if (nmd.node_group == nullptr) {
    return {};
  }
  if (!BKE_modifier_is_enabled(scene, md, eModifierMode_Realtime)) {
    BKE_report(op->reports, RPT_ERROR, "Modifier containing the node is disabled");
    return {};
  }
 
  initialize_modifier_bake_directory_if_necessary(C, *object, nmd, op);
 
  const int bake_id = RNA_int_get(op->ptr, "bake_id");
  const bNode *node = nmd.node_group->find_nested_node(bake_id);
  if (node == nullptr) {
    return {};
  }
  if (!ELEM(node->type_legacy, GEO_NODE_SIMULATION_OUTPUT, GEO_NODE_BAKE)) {
    return {};
  }
 
  NodeBakeRequest request;
  request.object = object;
  request.nmd = &nmd;
  request.bake_id = bake_id;
  request.node_type = node->type_legacy;
  request.blob_sharing = std::make_unique<bake::BlobWriteSharing>();
 
  const NodesModifierBake *bake = nmd.find_bake(bake_id);
  if (!bake) {
    return {};
  }
  if (bake::get_node_bake_target(*object, nmd, bake_id) == NODES_MODIFIER_BAKE_TARGET_DISK) {
    request.path = bake::get_node_bake_path(*bmain, *object, nmd, bake_id);
    if (!request.path) {
      BKE_report(op->reports,
                 RPT_INFO,
                 "Cannot determine bake location on disk. Falling back to packed bake.");
    }
  }
 
  if (node->type_legacy == GEO_NODE_BAKE && bake->bake_mode == NODES_MODIFIER_BAKE_MODE_STILL) {
    const int current_frame = scene->r.cfra;
    request.frame_start = current_frame;
    request.frame_end = current_frame;
    /* Delete old bake because otherwise this wouldn't be a still frame bake. This is not done for
     * other bakes to avoid loosing data when starting a bake. */
    try_delete_bake(bmain, *object, nmd, bake_id, op->reports);
  }
  else {
    const std::optional<IndexRange> frame_range = bake::get_node_bake_frame_range(
        *scene, *object, nmd, bake_id);
    if (!frame_range.has_value()) {
      return {};
    }
    if (frame_range->is_empty()) {
      return {};
    }
    request.frame_start = frame_range->first();
    request.frame_end = frame_range->last();
  }
 
  Vector<NodeBakeRequest> requests;
  requests.append(std::move(request));
  return requests;
}
 
static wmOperatorStatus bake_single_node_invoke(bContext *C,
                                                wmOperator *op,
                                                const wmEvent * /*event*/)
{
  Vector<NodeBakeRequest> requests = bake_single_node_gather_bake_request(C, op);
  if (requests.is_empty()) {
    return OPERATOR_CANCELLED;
  }
  return start_bake_job(C, std::move(requests), op, BakeRequestsMode::Async);
}
 
static wmOperatorStatus bake_single_node_exec(bContext *C, wmOperator *op)
{
  Vector<NodeBakeRequest> requests = bake_single_node_gather_bake_request(C, op);
  if (requests.is_empty()) {
    return OPERATOR_CANCELLED;
  }
  return start_bake_job(C, std::move(requests), op, BakeRequestsMode::Sync);
}
 
static wmOperatorStatus bake_single_node_modal(bContext *C,
                                               wmOperator * /*op*/,
                                               const wmEvent * /*event*/)
{
  if (!WM_jobs_test(CTX_wm_manager(C), CTX_data_scene(C), WM_JOB_TYPE_BAKE_GEOMETRY_NODES)) {
    return OPERATOR_FINISHED | OPERATOR_PASS_THROUGH;
  }
  return OPERATOR_PASS_THROUGH;
}
 
static wmOperatorStatus delete_single_bake_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Object *object = reinterpret_cast<Object *>(
      WM_operator_properties_id_lookup_from_name_or_session_uid(bmain, op->ptr, ID_OB));
  if (object == nullptr) {
    return OPERATOR_CANCELLED;
  }
  std::string modifier_name = RNA_string_get(op->ptr, "modifier_name");
  ModifierData *md = BKE_modifiers_findby_name(object, modifier_name.c_str());
  if (md == nullptr) {
    return OPERATOR_CANCELLED;
  }
  NodesModifierData &nmd = *reinterpret_cast<NodesModifierData *>(md);
  const int bake_id = RNA_int_get(op->ptr, "bake_id");
 
  try_delete_bake(bmain, *object, nmd, bake_id, op->reports);
 
  DEG_id_tag_update(&object->id, ID_RECALC_GEOMETRY);
  WM_main_add_notifier(NC_OBJECT | ND_MODIFIER, nullptr);
  WM_main_add_notifier(NC_NODE, nullptr);
  return OPERATOR_FINISHED;
}
 
static wmOperatorStatus pack_single_bake_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Object *object = reinterpret_cast<Object *>(
      WM_operator_properties_id_lookup_from_name_or_session_uid(bmain, op->ptr, ID_OB));
  if (object == nullptr) {
    return OPERATOR_CANCELLED;
  }
  std::string modifier_name = RNA_string_get(op->ptr, "modifier_name");
  ModifierData *md = BKE_modifiers_findby_name(object, modifier_name.c_str());
  if (md == nullptr) {
    return OPERATOR_CANCELLED;
  }
  NodesModifierData &nmd = *reinterpret_cast<NodesModifierData *>(md);
  const int bake_id = RNA_int_get(op->ptr, "bake_id");
 
  const std::optional<bake::BakePath> bake_path = bake::get_node_bake_path(
      *bmain, *object, nmd, bake_id);
  if (!bake_path) {
    return OPERATOR_CANCELLED;
  }
  NodesModifierBake *bake = nmd.find_bake(bake_id);
  if (!bake) {
    return OPERATOR_CANCELLED;
  }
 
  bake::pack_geometry_nodes_bake(*bmain, op->reports, *object, nmd, *bake);
 
  WM_main_add_notifier(NC_OBJECT | ND_MODIFIER, nullptr);
  WM_main_add_notifier(NC_NODE, nullptr);
  return OPERATOR_FINISHED;
}
 
static wmOperatorStatus unpack_single_bake_invoke(bContext *C,
                                                  wmOperator *op,
                                                  const wmEvent * /*event*/)
{
  uiPopupMenu *pup;
  uiLayout *layout;
 
  pup = UI_popup_menu_begin(C, IFACE_("Unpack"), ICON_NONE);
  layout = UI_popup_menu_layout(pup);
 
  layout->operator_context_set(wm::OpCallContext::ExecDefault);
  layout->op_enum(op->type->idname,
                  "method",
                  static_cast<IDProperty *>(op->ptr->data),
                  wm::OpCallContext::ExecRegionWin,
                  UI_ITEM_NONE);
 
  UI_popup_menu_end(C, pup);
 
  return OPERATOR_INTERFACE;
}
 
static wmOperatorStatus unpack_single_bake_exec(bContext *C, wmOperator *op)
{
  Main *bmain = CTX_data_main(C);
  Object *object = reinterpret_cast<Object *>(
      WM_operator_properties_id_lookup_from_name_or_session_uid(bmain, op->ptr, ID_OB));
  if (object == nullptr) {
    return OPERATOR_CANCELLED;
  }
  std::string modifier_name = RNA_string_get(op->ptr, "modifier_name");
  ModifierData *md = BKE_modifiers_findby_name(object, modifier_name.c_str());
  if (md == nullptr) {
    return OPERATOR_CANCELLED;
  }
  NodesModifierData &nmd = *reinterpret_cast<NodesModifierData *>(md);
  const int bake_id = RNA_int_get(op->ptr, "bake_id");
  NodesModifierBake *bake = nmd.find_bake(bake_id);
  if (!bake) {
    return OPERATOR_CANCELLED;
  }
 
  const ePF_FileStatus method = ePF_FileStatus(RNA_enum_get(op->ptr, "method"));
 
  bake::UnpackGeometryNodesBakeResult result = bake::unpack_geometry_nodes_bake(
      *bmain, op->reports, *object, nmd, *bake, method);
  if (result != bake::UnpackGeometryNodesBakeResult::Success) {
    return OPERATOR_CANCELLED;
  }
 
  WM_main_add_notifier(NC_OBJECT | ND_MODIFIER, nullptr);
  WM_main_add_notifier(NC_NODE, nullptr);
  return OPERATOR_FINISHED;
}
 
void OBJECT_OT_simulation_nodes_cache_calculate_to_frame(wmOperatorType *ot)
{
  ot->name = "Calculate Simulation to Frame";
  ot->description =
      "Calculate simulations in geometry nodes modifiers from the start to current frame";
  ot->idname = __func__;
 
  ot->invoke = simulate_to_frame_invoke;
  ot->modal = simulate_to_frame_modal;
  ot->poll = simulate_to_frame_poll;
 
  RNA_def_boolean(ot->srna,
                  "selected",
                  false,
                  "Selected",
                  "Calculate all selected objects instead of just the active object");
}
 
void OBJECT_OT_simulation_nodes_cache_bake(wmOperatorType *ot)
{
  ot->name = "Bake Simulation";
  ot->description = "Bake simulations in geometry nodes modifiers";
  ot->idname = __func__;
 
  ot->exec = bake_simulation_exec;
  ot->invoke = bake_simulation_invoke;
  ot->modal = bake_simulation_modal;
  ot->poll = bake_simulation_poll;
 
  RNA_def_boolean(ot->srna, "selected", false, "Selected", "Bake cache on all selected objects");
}
 
void OBJECT_OT_simulation_nodes_cache_delete(wmOperatorType *ot)
{
  ot->name = "Delete Cached Simulation";
  ot->description = "Delete cached/baked simulations in geometry nodes modifiers";
  ot->idname = __func__;
 
  ot->exec = delete_baked_simulation_exec;
  ot->poll = ED_operator_object_active;
 
  RNA_def_boolean(ot->srna, "selected", false, "Selected", "Delete cache on all selected objects");
}
 
static void single_bake_operator_props(wmOperatorType *ot)
{
  WM_operator_properties_id_lookup(ot, false);
 
  RNA_def_string(ot->srna,
                 "modifier_name",
                 nullptr,
                 0,
                 "Modifier Name",
                 "Name of the modifier that contains the node");
  RNA_def_int(
      ot->srna, "bake_id", 0, 0, INT32_MAX, "Bake ID", "Nested node id of the node", 0, INT32_MAX);
}
 
void OBJECT_OT_geometry_node_bake_single(wmOperatorType *ot)
{
  ot->name = "Bake Geometry Node";
  ot->description = "Bake a single bake node or simulation";
  ot->idname = "OBJECT_OT_geometry_node_bake_single";
 
  ot->invoke = bake_single_node_invoke;
  ot->exec = bake_single_node_exec;
  ot->modal = bake_single_node_modal;
 
  single_bake_operator_props(ot);
}
 
void OBJECT_OT_geometry_node_bake_delete_single(wmOperatorType *ot)
{
  ot->name = "Delete Geometry Node Bake";
  ot->description = "Delete baked data of a single bake node or simulation";
  ot->idname = "OBJECT_OT_geometry_node_bake_delete_single";
 
  ot->exec = delete_single_bake_exec;
 
  single_bake_operator_props(ot);
}
 
void OBJECT_OT_geometry_node_bake_pack_single(wmOperatorType *ot)
{
  ot->name = "Pack Geometry Node Bake";
  ot->description = "Pack baked data from disk into the .blend file";
  ot->idname = "OBJECT_OT_geometry_node_bake_pack_single";
 
  ot->exec = pack_single_bake_exec;
 
  single_bake_operator_props(ot);
}
 
void OBJECT_OT_geometry_node_bake_unpack_single(wmOperatorType *ot)
{
  ot->name = "Unpack Geometry Node Bake";
  ot->description = "Unpack baked data from the .blend file to disk";
  ot->idname = "OBJECT_OT_geometry_node_bake_unpack_single";
 
  ot->exec = unpack_single_bake_exec;
  ot->invoke = unpack_single_bake_invoke;
 
  single_bake_operator_props(ot);
 
  static const EnumPropertyItem method_items[] = {
      {PF_USE_LOCAL,
       "USE_LOCAL",
       0,
       "Use bake from current directory (create when necessary)",
       ""},
      {PF_WRITE_LOCAL,
       "WRITE_LOCAL",
       0,
       "Write bake to current directory (overwrite existing bake)",
       ""},
      {PF_USE_ORIGINAL,
       "USE_ORIGINAL",
       0,
       "Use bake in original location (create when necessary)",
       ""},
      {PF_WRITE_ORIGINAL,
       "WRITE_ORIGINAL",
       0,
       "Write bake to original location (overwrite existing file)",
       ""},
      {0, nullptr, 0, nullptr, nullptr},
  };
 
  RNA_def_enum(ot->srna, "method", method_items, PF_USE_LOCAL, "Method", "How to unpack");
}
 
}  // namespace blender::ed::object::bake_simulation