test/source/blender/blenkernel/BKE_bake_geometry_nodes_modifier.hh

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup bke
 */

#pragma once

#include "BLI_mutex.hh"
#include "BLI_sub_frame.hh"

#include "BKE_bake_items.hh"
#include "BKE_bake_items_paths.hh"
#include "BKE_bake_items_serialize.hh"

#include "DNA_modifier_types.h"

struct NodesModifierData;
struct Main;
struct Object;
struct Scene;

namespace blender::bke::bake {

enum class CacheStatus {
  /** The cache is up-to-date with the inputs. */
  Valid,
  /**
   * Nodes or input values have changed since the cache was created, i.e. the output would be
   * different if the simulation was run again.
   */
  Invalid,
  /** The cache has been baked and will not be invalidated by changing inputs. */
  Baked,
};

/**
 * Stores the state for a specific frame.
 */
struct FrameCache {
  SubFrame frame;
  BakeState state;
  /**
   * Used when the baked data is loaded lazily. The meta data either has to be loaded from a file
   * or from an in-memory buffer.
   */
  std::optional<std::variant<std::string, Span<std::byte>>> meta_data_source;
};

/**
 * Stores the state after the previous simulation step. This is only used, when the frame-cache is
 * not used.
 */
struct PrevCache {
  BakeState state;
  SubFrame frame;
};

/**
 * Baked data that corresponds to either a Simulation Output or Bake node.
 */
struct NodeBakeCache {
  /** All cached frames sorted by frame. */
  Vector<std::unique_ptr<FrameCache>> frames;

  /** Loads blob data from memory when the bake is packed. */
  std::unique_ptr<MemoryBlobReader> memory_blob_reader;
  /** Where to load blobs from disk when loading the baked data lazily from disk. */
  std::optional<std::string> blobs_dir;

  /** Used to avoid reading blobs multiple times for different frames. */
  std::unique_ptr<BlobReadSharing> blob_sharing;
  /** Used to avoid checking if a bake exists many times. */
  bool failed_finding_bake = false;

  /** Range spanning from the first to the last baked frame. */
  IndexRange frame_range() const;

  void reset();
};

struct SimulationNodeCache {
  NodeBakeCache bake;

  CacheStatus cache_status = CacheStatus::Valid;

  /** Previous simulation state when only that is stored (instead of the state for every frame). */
  std::optional<PrevCache> prev_cache;

  void reset();
};

struct BakeNodeCache {
  NodeBakeCache bake;

  void reset();
};

struct ModifierCache {
  mutable Mutex mutex;
  /**
   * Set of nested node IDs (see #bNestedNodeRef) that is expected to be baked in the next
   * evaluation. This is filled and cleared by the bake operator.
   */
  Set<int> requested_bakes;
  Map<int, std::unique_ptr<SimulationNodeCache>> simulation_cache_by_id;
  Map<int, std::unique_ptr<BakeNodeCache>> bake_cache_by_id;

  SimulationNodeCache *get_simulation_node_cache(const int id);
  BakeNodeCache *get_bake_node_cache(const int id);
  NodeBakeCache *get_node_bake_cache(const int id);

  void reset_cache(int id);
};

/**
 * Reset all simulation caches in the scene, for use when some fundamental change made them
 * impossible to reuse.
 */
void scene_simulation_states_reset(Scene &scene);

std::optional<NodesModifierBakeTarget> get_node_bake_target(const Object &object,
                                                            const NodesModifierData &nmd,
                                                            int node_id);
std::optional<BakePath> get_node_bake_path(const Main &bmain,
                                           const Object &object,
                                           const NodesModifierData &nmd,
                                           int node_id);
std::optional<IndexRange> get_node_bake_frame_range(const Scene &scene,
                                                    const Object &object,
                                                    const NodesModifierData &nmd,
                                                    int node_id);
std::optional<std::string> get_modifier_bake_path(const Main &bmain,
                                                  const Object &object,
                                                  const NodesModifierData &nmd);

/**
 * Get default directory for baking modifier to disk.
 */
std::string get_default_modifier_bake_directory(const Main &bmain,
                                                const Object &object,
                                                const NodesModifierData &nmd);
std::string get_default_node_bake_directory(const Main &bmain,
                                            const Object &object,
                                            const NodesModifierData &nmd,
                                            int node_id);

}  // namespace blender::bke::bake