FrameAnimationMsgPack.h

#pragma once

#include <cstdint>
#include <cstddef>

/**
 * @brief MessagePack-based frame animation cache format
 *
 * References sprite frames by GUID rather than pixel coordinates.
 * Supports multiple animations per file (e.g., idle, walk, run).
 *
 * The cache format is generated, not hand-written: FrameAnimationData is a
 * DEKI_SERIALIZABLE struct, so the reflection codegen emits Serialize<T> (save)
 * and DeserializeMsgPack (load). Keys are the struct field names, hashed the same
 * way as component fields, so the map is:
 *   { "spritesheet_guid": "...", "animations": [
 *       { "name": "idle", "frames": [ { "frame_guid": "...", "duration": 100 } ],
 *         "loop": true } ] }
 * To change the format, change the struct fields and re-export the .anim assets.
 */

// Forward declarations
struct FrameAnimationData;

/**
 * @brief File extension for frame animation files
 */
constexpr const char* FRAMEANIM_EXTENSION = ".anim";

/**
 * @brief Helper class for frame animation MessagePack format
 */
class FrameAnimationMsgPackHelper
{
public:
    /**
     * @brief Load frame animation from MessagePack format
     * @param msgpack_path Path to .frameanim MessagePack file
     * @param out_data Output animation data structure
     * @return true on success
     */
    static bool LoadAnimation(const char* msgpack_path, FrameAnimationData* out_data);

    /**
     * @brief Load frame animation from memory buffer
     * @param data Pointer to MessagePack data
     * @param size Size of data in bytes
     * @param out_data Output animation data structure
     * @return true on success
     */
    static bool LoadAnimationFromMemory(const uint8_t* data, size_t size, FrameAnimationData* out_data);

#ifdef DEKI_EDITOR
    /**
     * @brief Save frame animation to MessagePack format (editor only)
     * @param msgpack_path Output path for .frameanim file
     * @param anim_data Animation data to save
     * @return true on success
     */
    static bool SaveAnimation(const char* msgpack_path, const FrameAnimationData* anim_data);
#endif
};