abc_util.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
#pragma once
 
#include "abc_reader_object.h"
 
#include <Alembic/Abc/Foundation.h>
#include <Alembic/Abc/ICompoundProperty.h>
#include <Alembic/Abc/IObject.h>
#include <Alembic/Abc/ISampleSelector.h>
#include <Alembic/Abc/TypedArraySample.h>
#include <Alembic/AbcCoreAbstract/Foundation.h>
#include <Alembic/AbcCoreAbstract/TimeSampling.h>
#include <Alembic/AbcGeom/IXform.h>
 
#include <fstream>
#include <optional>
#include <string>
#include <vector>
 
using Alembic::Abc::chrono_t;
using Alembic::Abc::V3fArraySamplePtr;
 
struct ID;
struct Object;
 
namespace blender::io::alembic {
 
class AbcObjectReader;
struct ImportSettings;
 
std::string get_id_name(const ID *const id);
std::string get_id_name(const Object *const ob);
std::string get_valid_abc_name(const char *name);
std::string get_object_dag_path_name(const Object *const ob, Object *dupli_parent);
 
/* Convert from float to Alembic matrix representations. Does NOT convert from Z-up to Y-up. */
Imath::M44d convert_matrix_datatype(const float mat[4][4]);
/* Convert from Alembic to float matrix representations. Does NOT convert from Y-up to Z-up. */
void convert_matrix_datatype(const Imath::M44d &xform, float r_mat[4][4]);
 
void split(const std::string &s, char delim, std::vector<std::string> &tokens);
 
template<class TContainer> bool begins_with(const TContainer &input, const TContainer &match)
{
  return input.size() >= match.size() && std::equal(match.begin(), match.end(), input.begin());
}
 
template<typename Schema>
void get_min_max_time_ex(const Schema &schema, chrono_t &min, chrono_t &max)
{
  const Alembic::Abc::TimeSamplingPtr &time_samp = schema.getTimeSampling();
 
  if (!schema.isConstant()) {
    const size_t num_samps = schema.getNumSamples();
 
    if (num_samps > 0) {
      const chrono_t min_time = time_samp->getSampleTime(0);
      min = std::min(min, min_time);
 
      const chrono_t max_time = time_samp->getSampleTime(num_samps - 1);
      max = std::max(max, max_time);
    }
  }
}
 
template<typename Schema>
void get_min_max_time(const Alembic::AbcGeom::IObject &object,
                      const Schema &schema,
                      chrono_t &min,
                      chrono_t &max)
{
  get_min_max_time_ex(schema, min, max);
 
  const Alembic::AbcGeom::IObject &parent = object.getParent();
  if (parent.valid() && Alembic::AbcGeom::IXform::matches(parent.getMetaData())) {
    Alembic::AbcGeom::IXform xform(parent, Alembic::AbcGeom::kWrapExisting);
    get_min_max_time_ex(xform.getSchema(), min, max);
  }
}
 
bool has_property(const Alembic::Abc::ICompoundProperty &prop, const std::string &name);
V3fArraySamplePtr get_velocity_prop(const Alembic::Abc::ICompoundProperty &schema,
                                    const Alembic::AbcGeom::ISampleSelector &selector,
                                    const std::string &name);
 
struct SampleInterpolationSettings {
  /* Index of the first ("floor") sample. */
  Alembic::AbcGeom::index_t index;
  /* Index of the second ("ceil") sample. */
  Alembic::AbcGeom::index_t ceil_index;
  /* Factor to interpolate between the `index` and `ceil_index`. */
  double weight;
};
 
std::optional<SampleInterpolationSettings> get_sample_interpolation_settings(
    const Alembic::AbcGeom::ISampleSelector &selector,
    const Alembic::AbcCoreAbstract::TimeSamplingPtr &time_sampling,
    size_t samples_number);
 
AbcObjectReader *create_reader(const Alembic::AbcGeom::IObject &object, ImportSettings &settings);
 
/* *************************** */
 
#undef ABC_DEBUG_TIME
 
class ScopeTimer {
  const char *m_message;
  double m_start;
 
 public:
  ScopeTimer(const char *message);
  ~ScopeTimer();
};
 
#ifdef ABC_DEBUG_TIME
#  define SCOPE_TIMER(message) ScopeTimer prof(message)
#else
#  define SCOPE_TIMER(message)
#endif
 
/* *************************** */
 
class SimpleLogger {
  std::ostringstream m_stream;
 
 public:
  std::string str() const;
 
  void clear();
 
  std::ostringstream &stream();
};
 
#define ABC_LOG(logger) logger.stream()
 
std::ostream &operator<<(std::ostream &os, const SimpleLogger &logger);
 
}  // namespace blender::io::alembic