COM_keying_screen.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include <cstdint>
#include <memory>
#include <string>
 
#include "BLI_map.hh"
#include "BLI_math_vector_types.hh"
 
#include "DNA_movieclip_types.h"
#include "DNA_tracking_types.h"
 
#include "COM_cached_resource.hh"
#include "COM_result.hh"
 
namespace blender::compositor {
 
class Context;
 
/* ------------------------------------------------------------------------------------------------
 * Keying Screen Key.
 */
class KeyingScreenKey {
 public:
  int2 frame;
  float smoothness;
 
  KeyingScreenKey(int frame, float smoothness);
 
  uint64_t hash() const;
};
 
bool operator==(const KeyingScreenKey &a, const KeyingScreenKey &b);
 
/* -------------------------------------------------------------------------------------------------
 * Keying Screen.
 *
 * A cached resource that computes and caches a result containing the keying screen computed by
 * interpolating the markers of the given movie tracking object in the given movie clip. */
class KeyingScreen : public CachedResource {
 public:
  Result result;
 
  KeyingScreen(Context &context,
               MovieClip *movie_clip,
               MovieTrackingObject *movie_tracking_object,
               const float smoothness);
 
  ~KeyingScreen();
 
 private:
  void compute_gpu(Context &context,
                   const float smoothness,
                   Vector<float2> &marker_positions,
                   const Vector<float4> &marker_colors);
 
  void compute_cpu(const float smoothness,
                   const Vector<float2> &marker_positions,
                   const Vector<float4> &marker_colors);
};
 
/* ------------------------------------------------------------------------------------------------
 * Keying Screen Container.
 */
class KeyingScreenContainer : CachedResourceContainer {
 private:
  Map<std::string, Map<KeyingScreenKey, std::unique_ptr<KeyingScreen>>> map_;
 
  /* A map that stores the update counts of the keying screens at the moment they were cached. */
  Map<std::string, uint64_t> update_counts_;
 
 public:
  void reset() override;
 
  /* Check if the given movie clip ID has changed since the last time it was retrieved through its
   * recalculate flag, and if so, invalidate its corresponding cached keying screens and reset the
   * recalculate flag to ready it to track the next change. Then, check if there is an available
   * KeyingScreen cached resource with the given parameters in the container, if one exists, return
   * it, otherwise, return a newly created one and add it to the container. In both cases, tag the
   * cached resource as needed to keep it cached for the next evaluation. */
  Result &get(Context &context,
              MovieClip *movie_clip,
              MovieTrackingObject *movie_tracking_object,
              float smoothness);
};
 
}  // namespace blender::compositor