node_composite_boxmask.cc

Go to the documentation of this file.

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

 
#include <cmath>
 
#include "BLI_math_base.hh"
#include "BLI_math_matrix_types.hh"
#include "BLI_math_vector_types.hh"
 
#include "GPU_shader.hh"
 
#include "BKE_node.hh"
 
#include "COM_node_operation.hh"
#include "COM_utilities.hh"
 
#include "node_composite_util.hh"
 
namespace blender::nodes::node_composite_boxmask_cc {
 
static const EnumPropertyItem operation_items[] = {
    {CMP_NODE_MASKTYPE_ADD, "ADD", 0, N_("Add"), ""},
    {CMP_NODE_MASKTYPE_SUBTRACT, "SUBTRACT", 0, N_("Subtract"), ""},
    {CMP_NODE_MASKTYPE_MULTIPLY, "MULTIPLY", 0, N_("Multiply"), ""},
    {CMP_NODE_MASKTYPE_NOT, "NOT", 0, N_("Not"), ""},
    {0, nullptr, 0, nullptr, nullptr},
};
 
static void cmp_node_boxmask_declare(NodeDeclarationBuilder &b)
{
  b.add_input<decl::Menu>("Operation")
      .default_value(CMP_NODE_MASKTYPE_ADD)
      .static_items(operation_items)
      .optional_label();
  b.add_input<decl::Float>("Mask")
      .subtype(PROP_FACTOR)
      .default_value(0.0f)
      .min(0.0f)
      .max(1.0f)
      .structure_type(StructureType::Dynamic);
  b.add_input<decl::Float>("Value")
      .subtype(PROP_FACTOR)
      .default_value(1.0f)
      .min(0.0f)
      .max(1.0f)
      .structure_type(StructureType::Dynamic);
  b.add_input<decl::Vector>("Position")
      .subtype(PROP_FACTOR)
      .dimensions(2)
      .default_value({0.5f, 0.5f})
      .min(-0.5f)
      .max(1.5f);
  b.add_input<decl::Vector>("Size")
      .subtype(PROP_FACTOR)
      .dimensions(2)
      .default_value({0.2f, 0.1f})
      .min(0.0f)
      .max(1.0f);
  b.add_input<decl::Float>("Rotation").subtype(PROP_ANGLE);
 
  b.add_output<decl::Float>("Mask").structure_type(StructureType::Dynamic);
}
 
using namespace blender::compositor;
 
template<CMPNodeMaskType MaskType>
static void box_mask(const Result &base_mask,
                     const Result &value_mask,
                     Result &output_mask,
                     const int2 &texel,
                     const int2 &domain_size,
                     const float2 &location,
                     const float2 &size,
                     const float cos_angle,
                     const float sin_angle)
{
  float2 uv = float2(texel) / float2(domain_size - int2(1));
  uv -= location;
  uv.y *= float(domain_size.y) / float(domain_size.x);
  uv = float2x2(float2(cos_angle, -sin_angle), float2(sin_angle, cos_angle)) * uv;
  bool is_inside = math::abs(uv.x) < size.x && math::abs(uv.y) < size.y;
 
  float base_mask_value = base_mask.load_pixel<float, true>(texel);
  float value = value_mask.load_pixel<float, true>(texel);
 
  float output_mask_value = 0.0f;
  if constexpr (MaskType == CMP_NODE_MASKTYPE_ADD) {
    output_mask_value = is_inside ? math::max(base_mask_value, value) : base_mask_value;
  }
  else if constexpr (MaskType == CMP_NODE_MASKTYPE_SUBTRACT) {
    output_mask_value = is_inside ? math::clamp(base_mask_value - value, 0.0f, 1.0f) :
                                    base_mask_value;
  }
  else if constexpr (MaskType == CMP_NODE_MASKTYPE_MULTIPLY) {
    output_mask_value = is_inside ? base_mask_value * value : 0.0f;
  }
  else if constexpr (MaskType == CMP_NODE_MASKTYPE_NOT) {
    output_mask_value = is_inside ? (base_mask_value > 0.0f ? 0.0f : value) : base_mask_value;
  }
 
  output_mask.store_pixel(texel, output_mask_value);
}
 
class BoxMaskOperation : public NodeOperation {
 public:
  using NodeOperation::NodeOperation;
 
  void execute() override
  {
    const Result &input_mask = get_input("Mask");
    Result &output_mask = get_result("Mask");
    /* For single value masks, the output will assume the compositing region, so ensure it is valid
     * first. See the compute_domain method. */
    if (input_mask.is_single_value() && !context().is_valid_compositing_region()) {
      output_mask.allocate_invalid();
      return;
    }
 
    if (this->context().use_gpu()) {
      this->execute_gpu();
    }
    else {
      this->execute_cpu();
    }
  }
 
  void execute_gpu()
  {
    gpu::Shader *shader = context().get_shader(get_shader_name());
    GPU_shader_bind(shader);
 
    const Domain domain = compute_domain();
 
    GPU_shader_uniform_2iv(shader, "domain_size", domain.size);
 
    GPU_shader_uniform_2fv(shader, "location", get_location());
    GPU_shader_uniform_2fv(shader, "size", get_size() / 2.0f);
    GPU_shader_uniform_1f(shader, "cos_angle", std::cos(get_angle()));
    GPU_shader_uniform_1f(shader, "sin_angle", std::sin(get_angle()));
 
    const Result &input_mask = get_input("Mask");
    input_mask.bind_as_texture(shader, "base_mask_tx");
 
    const Result &value = get_input("Value");
    value.bind_as_texture(shader, "mask_value_tx");
 
    Result &output_mask = get_result("Mask");
    output_mask.allocate_texture(domain);
    output_mask.bind_as_image(shader, "output_mask_img");
 
    compute_dispatch_threads_at_least(shader, domain.size);
 
    input_mask.unbind_as_texture();
    value.unbind_as_texture();
    output_mask.unbind_as_image();
    GPU_shader_unbind();
  }
 
  const char *get_shader_name()
  {
    switch (this->get_operation()) {
      case CMP_NODE_MASKTYPE_ADD:
        return "compositor_box_mask_add";
      case CMP_NODE_MASKTYPE_SUBTRACT:
        return "compositor_box_mask_subtract";
      case CMP_NODE_MASKTYPE_MULTIPLY:
        return "compositor_box_mask_multiply";
      case CMP_NODE_MASKTYPE_NOT:
        return "compositor_box_mask_not";
    }
 
    return "compositor_box_mask_add";
  }
 
  void execute_cpu()
  {
    const Result &base_mask = this->get_input("Mask");
    const Result &value_mask = this->get_input("Value");
 
    Result &output_mask = get_result("Mask");
    const Domain domain = this->compute_domain();
    output_mask.allocate_texture(domain);
 
    const int2 domain_size = domain.size;
    const float2 location = this->get_location();
    const float2 size = this->get_size() / 2.0f;
    const float cos_angle = math::cos(this->get_angle());
    const float sin_angle = math::sin(this->get_angle());
 
    switch (this->get_operation()) {
      case CMP_NODE_MASKTYPE_ADD:
        parallel_for(domain_size, [&](const int2 texel) {
          box_mask<CMP_NODE_MASKTYPE_ADD>(base_mask,
                                          value_mask,
                                          output_mask,
                                          texel,
                                          domain_size,
                                          location,
                                          size,
                                          cos_angle,
                                          sin_angle);
        });
        return;
      case CMP_NODE_MASKTYPE_SUBTRACT:
        parallel_for(domain_size, [&](const int2 texel) {
          box_mask<CMP_NODE_MASKTYPE_SUBTRACT>(base_mask,
                                               value_mask,
                                               output_mask,
                                               texel,
                                               domain_size,
                                               location,
                                               size,
                                               cos_angle,
                                               sin_angle);
        });
        return;
      case CMP_NODE_MASKTYPE_MULTIPLY:
        parallel_for(domain_size, [&](const int2 texel) {
          box_mask<CMP_NODE_MASKTYPE_MULTIPLY>(base_mask,
                                               value_mask,
                                               output_mask,
                                               texel,
                                               domain_size,
                                               location,
                                               size,
                                               cos_angle,
                                               sin_angle);
        });
        return;
      case CMP_NODE_MASKTYPE_NOT:
        parallel_for(domain_size, [&](const int2 texel) {
          box_mask<CMP_NODE_MASKTYPE_NOT>(base_mask,
                                          value_mask,
                                          output_mask,
                                          texel,
                                          domain_size,
                                          location,
                                          size,
                                          cos_angle,
                                          sin_angle);
        });
        return;
    }
 
    parallel_for(domain_size, [&](const int2 texel) {
      box_mask<CMP_NODE_MASKTYPE_ADD>(base_mask,
                                      value_mask,
                                      output_mask,
                                      texel,
                                      domain_size,
                                      location,
                                      size,
                                      cos_angle,
                                      sin_angle);
    });
  }
 
  Domain compute_domain() override
  {
    if (get_input("Mask").is_single_value()) {
      return Domain(context().get_compositing_region_size());
    }
    return get_input("Mask").domain();
  }
 
  float2 get_location()
  {
    return this->get_input("Position").get_single_value_default(float2(0.5f));
  }
 
  float2 get_size()
  {
    return math::max(float2(0.0f),
                     this->get_input("Size").get_single_value_default(float2(0.2f, 0.1f)));
  }
 
  float get_angle()
  {
    return this->get_input("Rotation").get_single_value_default(0.0f);
  }
 
  CMPNodeMaskType get_operation()
  {
    const Result &input = this->get_input("Operation");
    const MenuValue default_menu_value = MenuValue(CMP_NODE_MASKTYPE_ADD);
    const MenuValue menu_value = input.get_single_value_default(default_menu_value);
    return static_cast<CMPNodeMaskType>(menu_value.value);
  }
};
 
static NodeOperation *get_compositor_operation(Context &context, DNode node)
{
  return new BoxMaskOperation(context, node);
}
 
}  // namespace blender::nodes::node_composite_boxmask_cc
 
static void register_node_type_cmp_boxmask()
{
  namespace file_ns = blender::nodes::node_composite_boxmask_cc;
 
  static blender::bke::bNodeType ntype;
 
  cmp_node_type_base(&ntype, "CompositorNodeBoxMask", CMP_NODE_MASK_BOX);
  ntype.ui_name = "Box Mask";
  ntype.ui_description = "Create rectangular mask suitable for use as a simple matte";
  ntype.enum_name_legacy = "BOXMASK";
  ntype.nclass = NODE_CLASS_MATTE;
  ntype.declare = file_ns::cmp_node_boxmask_declare;
  ntype.get_compositor_operation = file_ns::get_compositor_operation;
 
  blender::bke::node_register_type(ntype);
}
NOD_REGISTER_NODE(register_node_type_cmp_boxmask)