BKE_cryptomatte.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2020 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <algorithm>
#include <optional>
#include <string>
 
#include "BKE_cryptomatte.h"
 
#include "BLI_hash_mm3.hh"
#include "BLI_map.hh"
#include "BLI_string_ref.hh"
 
struct ID;
 
namespace blender::bke::cryptomatte {
 
std::string BKE_cryptomatte_meta_data_key(StringRef layer_name, StringRefNull key_name);
 
StringRef BKE_cryptomatte_extract_layer_name(StringRef render_pass_name);
 
struct CryptomatteHash {
  uint32_t hash;
 
  CryptomatteHash(uint32_t hash);
  CryptomatteHash(const char *name, int name_len)
  {
    hash = BLI_hash_mm3((const unsigned char *)name, name_len, 0);
  }
 
  static CryptomatteHash from_hex_encoded(blender::StringRef hex_encoded);
  std::string hex_encoded() const;
 
  float float_encoded() const
  {
    uint32_t mantissa = hash & ((1 << 23) - 1);
    uint32_t exponent = (hash >> 23) & ((1 << 8) - 1);
    exponent = std::max(exponent, uint32_t(1));
    exponent = std::min(exponent, uint32_t(254));
    exponent = exponent << 23;
    uint32_t sign = (hash >> 31);
    sign = sign << 31;
    uint32_t float_bits = sign | exponent | mantissa;
    float f;
    memcpy(&f, &float_bits, sizeof(uint32_t));
    return f;
  }
};
 
struct CryptomatteLayer {
  blender::Map<std::string, CryptomatteHash> hashes;
 
  MEM_CXX_CLASS_ALLOC_FUNCS("cryptomatte:CryptomatteLayer")
 
  static std::unique_ptr<CryptomatteLayer> read_from_manifest(blender::StringRefNull manifest);
  uint32_t add_ID(const ID &id);
  void add_hash(blender::StringRef name, CryptomatteHash cryptomatte_hash);
  std::string manifest() const;
 
  std::optional<std::string> operator[](float encoded_hash) const;
};
 
struct CryptomatteStampDataCallbackData {
  CryptomatteSession *session;
  blender::Map<std::string, std::string> hash_to_layer_name;
 
  static blender::StringRef extract_layer_hash(blender::StringRefNull key);
 
  /* C type callback function (StampCallback). */
  static void extract_layer_names(void *_data,
                                  const char *propname,
                                  char *propvalue,
                                  int propvalue_maxncpy);
  /* C type callback function (StampCallback). */
  static void extract_layer_manifest(void *_data,
                                     const char *propname,
                                     char *propvalue,
                                     int propvalue_maxncpy);
};
 
const blender::Vector<std::string> &BKE_cryptomatte_layer_names_get(
    const CryptomatteSession &session);
CryptomatteLayer *BKE_cryptomatte_layer_get(CryptomatteSession &session, StringRef layer_name);
 
struct CryptomatteSessionDeleter {
  void operator()(CryptomatteSession *session)
  {
    BKE_cryptomatte_free(session);
  }
};
 
using CryptomatteSessionPtr = std::unique_ptr<CryptomatteSession, CryptomatteSessionDeleter>;
 
}  // namespace blender::bke::cryptomatte