MOD_meshcache_mdd.cc

Go to the documentation of this file.

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

 
#include <algorithm>
#include <cerrno>
#include <cstdio>
#include <cstring>
 
#include "BLI_endian_switch.h"
#include "BLI_fileops.h"
#include "BLI_math_base.h"
#ifdef WIN32
#  include "BLI_winstuff.h"
#endif
 
#include "BLT_translation.hh"
 
#include "DNA_modifier_types.h"
 
#include "MOD_meshcache_util.hh" /* own include */
 
struct MDDHead {
  int frame_tot;
  int verts_tot;
}; /* frames, verts */
 
static bool meshcache_read_mdd_head(FILE *fp,
                                    const int verts_tot,
                                    MDDHead *mdd_head,
                                    const char **r_err_str)
{
  if (!fread(mdd_head, sizeof(*mdd_head), 1, fp)) {
    *r_err_str = RPT_("Missing header");
    return false;
  }
 
  /* NOTE: this is endianness-sensitive. */
  /* MDD is big-endian, its values need to be switched on little-endian systems. */
  BLI_endian_switch_int32_array((int *)mdd_head, 2);
 
  if (mdd_head->verts_tot != verts_tot) {
    *r_err_str = RPT_("Vertex count mismatch");
    return false;
  }
 
  if (mdd_head->frame_tot <= 0) {
    *r_err_str = RPT_("Invalid frame total");
    return false;
  }
  /* Intentionally don't seek back. */
 
  return true;
}

static bool meshcache_read_mdd_range(FILE *fp,
                                     const int verts_tot,
                                     const float frame,
                                     const char interp,
                                     int r_index_range[2],
                                     float *r_factor,
                                     const char **r_err_str)
{
  MDDHead mdd_head;
 
  /* first check interpolation and get the vert locations */
 
  if (meshcache_read_mdd_head(fp, verts_tot, &mdd_head, r_err_str) == false) {
    return false;
  }
 
  MOD_meshcache_calc_range(frame, interp, mdd_head.frame_tot, r_index_range, r_factor);
 
  return true;
}
 
static bool meshcache_read_mdd_range_from_time(FILE *fp,
                                               const int verts_tot,
                                               const float time,
                                               const float /*fps*/,
                                               float *r_frame,
                                               const char **r_err_str)
{
  MDDHead mdd_head;
  int i;
  float f_time, f_time_prev = FLT_MAX;
  float frame;
 
  if (meshcache_read_mdd_head(fp, verts_tot, &mdd_head, r_err_str) == false) {
    return false;
  }
 
  size_t frames_num_read = 0;
  size_t frames_num_expect = mdd_head.frame_tot;
  errno = 0;
  for (i = 0; i < mdd_head.frame_tot; i++) {
    frames_num_read += fread(&f_time, sizeof(float), 1, fp);
    /* NOTE: this is endianness-sensitive. */
    /* MDD is big-endian, its values need to be switched on little-endian systems. */
    BLI_endian_switch_float(&f_time);
 
    if (f_time >= time) {
      frames_num_expect = i + 1;
      break;
    }
    f_time_prev = f_time;
  }
 
  if (frames_num_read != frames_num_expect) {
    *r_err_str = errno ? strerror(errno) : RPT_("Timestamp read failed");
    return false;
  }
 
  if (UNLIKELY(f_time_prev == FLT_MAX)) {
    frame = 0.0f;
  }
  else {
    const float range = f_time - f_time_prev;
 
    if (range <= FRAME_SNAP_EPS) {
      frame = float(i);
    }
    else {
      frame = float(i - 1) + ((time - f_time_prev) / range);
    }
  }
 
  *r_frame = frame;
  return true;
}
 
bool MOD_meshcache_read_mdd_index(FILE *fp,
                                  float (*vertexCos)[3],
                                  const int verts_tot,
                                  const int index,
                                  const float factor,
                                  const char **r_err_str)
{
  MDDHead mdd_head;
 
  if (meshcache_read_mdd_head(fp, verts_tot, &mdd_head, r_err_str) == false) {
    return false;
  }
 
  if (BLI_fseek(fp, mdd_head.frame_tot * sizeof(int), SEEK_CUR) != 0) {
    *r_err_str = RPT_("Header seek failed");
    return false;
  }
 
  if (BLI_fseek(fp, sizeof(float[3]) * index * mdd_head.verts_tot, SEEK_CUR) != 0) {
    *r_err_str = RPT_("Failed to seek frame");
    return false;
  }
 
  size_t verts_read_num = 0;
  errno = 0;
  if (factor >= 1.0f) {
#if 1
    float *vco = *vertexCos;
    uint i;
    for (i = mdd_head.verts_tot; i != 0; i--, vco += 3) {
      verts_read_num += fread(vco, sizeof(float[3]), 1, fp);
 
      /* NOTE: this is endianness-sensitive. */
      /* MDD is big-endian, its values need to be switched on little-endian systems. */
      BLI_endian_switch_float(vco + 0);
      BLI_endian_switch_float(vco + 1);
      BLI_endian_switch_float(vco + 2);
    }
#else
    /* no blending */
    if (!fread(vertexCos, sizeof(float[3]), mdd_head.verts_tot, f)) {
      *r_err_str = errno ? strerror(errno) : RPT_("Failed to read frame");
      return false;
    }
    /* NOTE: this is endianness-sensitive. */
    /* MDD is big-endian, its values need to be switched on little-endian systems. */
    BLI_endian_switch_float_array(vertexCos[0], mdd_head.verts_tot * 3);
#endif
  }
  else {
    const float ifactor = 1.0f - factor;
    float *vco = *vertexCos;
    uint i;
    for (i = mdd_head.verts_tot; i != 0; i--, vco += 3) {
      float tvec[3];
      verts_read_num += fread(tvec, sizeof(float[3]), 1, fp);
 
      /* NOTE: this is endianness-sensitive. */
      /* MDD is big-endian, its values need to be switched on little-endian systems. */
      BLI_endian_switch_float(tvec + 0);
      BLI_endian_switch_float(tvec + 1);
      BLI_endian_switch_float(tvec + 2);
 
      vco[0] = (vco[0] * ifactor) + (tvec[0] * factor);
      vco[1] = (vco[1] * ifactor) + (tvec[1] * factor);
      vco[2] = (vco[2] * ifactor) + (tvec[2] * factor);
    }
  }
 
  if (verts_read_num != mdd_head.verts_tot) {
    *r_err_str = errno ? strerror(errno) : RPT_("Vertex coordinate read failed");
    return false;
  }
 
  return true;
}
 
bool MOD_meshcache_read_mdd_frame(FILE *fp,
                                  float (*vertexCos)[3],
                                  const int verts_tot,
                                  const char interp,
                                  const float frame,
                                  const char **r_err_str)
{
  int index_range[2];
  float factor;
 
  if (meshcache_read_mdd_range(fp,
                               verts_tot,
                               frame,
                               interp,
                               index_range,
                               &factor, /* read into these values */
                               r_err_str) == false)
  {
    return false;
  }
 
  if (index_range[0] == index_range[1]) {
    /* read single */
    if ((BLI_fseek(fp, 0, SEEK_SET) == 0) &&
        MOD_meshcache_read_mdd_index(fp, vertexCos, verts_tot, index_range[0], 1.0f, r_err_str))
    {
      return true;
    }
 
    return false;
  }
 
  /* read both and interpolate */
  if ((BLI_fseek(fp, 0, SEEK_SET) == 0) &&
      MOD_meshcache_read_mdd_index(fp, vertexCos, verts_tot, index_range[0], 1.0f, r_err_str) &&
      (BLI_fseek(fp, 0, SEEK_SET) == 0) &&
      MOD_meshcache_read_mdd_index(fp, vertexCos, verts_tot, index_range[1], factor, r_err_str))
  {
    return true;
  }
 
  return false;
}
 
bool MOD_meshcache_read_mdd_times(const char *filepath,
                                  float (*vertexCos)[3],
                                  const int verts_tot,
                                  const char interp,
                                  const float time,
                                  const float fps,
                                  const char time_mode,
                                  const char **r_err_str)
{
  float frame;
 
  FILE *fp = BLI_fopen(filepath, "rb");
  bool ok;
 
  if (fp == nullptr) {
    *r_err_str = errno ? strerror(errno) : RPT_("Unknown error opening file");
    return false;
  }
 
  switch (time_mode) {
    case MOD_MESHCACHE_TIME_FRAME: {
      frame = time;
      break;
    }
    case MOD_MESHCACHE_TIME_SECONDS: {
      /* we need to find the closest time */
      if (meshcache_read_mdd_range_from_time(fp, verts_tot, time, fps, &frame, r_err_str) == false)
      {
        fclose(fp);
        return false;
      }
      rewind(fp);
      break;
    }
    case MOD_MESHCACHE_TIME_FACTOR:
    default: {
      MDDHead mdd_head;
      if (meshcache_read_mdd_head(fp, verts_tot, &mdd_head, r_err_str) == false) {
        fclose(fp);
        return false;
      }
 
      frame = std::clamp(time, 0.0f, 1.0f) * float(mdd_head.frame_tot);
      rewind(fp);
      break;
    }
  }
 
  ok = MOD_meshcache_read_mdd_frame(fp, vertexCos, verts_tot, interp, frame, r_err_str);
 
  fclose(fp);
  return ok;
}