COM_ViewerOperation.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2011 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#include "COM_ViewerOperation.h"
#include "BKE_image.hh"
#include "BKE_scene.hh"
#include "COM_ExecutionSystem.h"
 
#include "IMB_colormanagement.hh"
#include "IMB_imbuf.hh"
#include "IMB_imbuf_types.hh"
 
namespace blender::compositor {
 
ViewerOperation::ViewerOperation()
{
  this->set_image(nullptr);
  this->set_image_user(nullptr);
  output_buffer_ = nullptr;
  active_ = false;
  view_settings_ = nullptr;
  display_settings_ = nullptr;
  use_alpha_input_ = false;
 
  this->add_input_socket(DataType::Color);
  this->add_input_socket(DataType::Value);
 
  rd_ = nullptr;
  view_name_ = nullptr;
  flags_.use_viewer_border = true;
  flags_.is_viewer_operation = true;
}
 
void ViewerOperation::init_execution()
{
  if (is_active_viewer_output() && !exec_system_->is_breaked()) {
    init_image();
  }
}
 
void ViewerOperation::deinit_execution()
{
  output_buffer_ = nullptr;
}
 
void ViewerOperation::determine_canvas(const rcti &preferred_area, rcti &r_area)
{
  int scene_render_width, scene_render_height;
  BKE_render_resolution(rd_, false, &scene_render_width, &scene_render_height);
 
  rcti local_preferred = preferred_area;
  local_preferred.xmax = local_preferred.xmin + scene_render_width;
  local_preferred.ymax = local_preferred.ymin + scene_render_height;
 
  NodeOperation::determine_canvas(local_preferred, r_area);
}
 
void ViewerOperation::init_image()
{
  Image *ima = image_;
  ImageUser iuser = *image_user_;
  void *lock;
  ImBuf *ibuf;
 
  /* make sure the image has the correct number of views */
  if (ima && BKE_scene_multiview_is_render_view_first(rd_, view_name_)) {
    BKE_image_ensure_viewer_views(rd_, ima, image_user_);
  }
 
  BLI_thread_lock(LOCK_DRAW_IMAGE);
 
  /* local changes to the original ImageUser */
  iuser.multi_index = BKE_scene_multiview_view_id_get(rd_, view_name_);
  ibuf = BKE_image_acquire_ibuf(ima, &iuser, &lock);
 
  if (!ibuf) {
    BLI_thread_unlock(LOCK_DRAW_IMAGE);
    return;
  }
 
  if (ibuf->x != get_width() || ibuf->y != get_height()) {
 
    imb_freerectImBuf(ibuf);
    imb_freerectfloatImBuf(ibuf);
    ibuf->x = get_width();
    ibuf->y = get_height();
    /* zero size can happen if no image buffers exist to define a sensible resolution */
    if (ibuf->x > 0 && ibuf->y > 0) {
      imb_addrectfloatImBuf(ibuf, 4);
    }
 
    ibuf->userflags |= IB_DISPLAY_BUFFER_INVALID;
  }
 
  /* now we combine the input with ibuf */
  output_buffer_ = ibuf->float_buffer.data;
 
  /* needed for display buffer update */
  ibuf_ = ibuf;
 
  BKE_image_release_ibuf(image_, ibuf_, lock);
 
  BLI_thread_unlock(LOCK_DRAW_IMAGE);
}
 
void ViewerOperation::update_image(const rcti *rect)
{
  if (exec_system_->is_breaked()) {
    return;
  }
 
  image_->runtime.backdrop_offset[0] = canvas_.xmin;
  image_->runtime.backdrop_offset[1] = canvas_.ymin;
  float *buffer = output_buffer_;
  IMB_partial_display_buffer_update(ibuf_,
                                    buffer,
                                    nullptr,
                                    get_width(),
                                    0,
                                    0,
                                    view_settings_,
                                    display_settings_,
                                    rect->xmin,
                                    rect->ymin,
                                    rect->xmax,
                                    rect->ymax);
 
  /* This could be improved to use partial updates. For now disabled as the full frame compositor
   * would not use partial frames anymore and the image engine requires more testing. */
  BKE_image_partial_update_mark_full_update(image_);
  this->update_draw();
}
 
eCompositorPriority ViewerOperation::get_render_priority() const
{
  if (this->is_active_viewer_output()) {
    return eCompositorPriority::High;
  }
 
  return eCompositorPriority::Low;
}
 
void ViewerOperation::update_memory_buffer_partial(MemoryBuffer * /*output*/,
                                                   const rcti &area,
                                                   Span<MemoryBuffer *> inputs)
{
  if (!output_buffer_) {
    return;
  }
 
  MemoryBuffer output_buffer(
      output_buffer_, COM_DATA_TYPE_COLOR_CHANNELS, get_width(), get_height());
  const MemoryBuffer *input_image = inputs[0];
  output_buffer.copy_from(input_image, area);
  if (use_alpha_input_) {
    const MemoryBuffer *input_alpha = inputs[1];
    output_buffer.copy_from(input_alpha, area, 0, COM_DATA_TYPE_VALUE_CHANNELS, 3);
  }
 
  update_image(&area);
}
 
void ViewerOperation::update_memory_buffer_finished(MemoryBuffer * /*output*/,
                                                    const rcti & /*area*/,
                                                    Span<MemoryBuffer *> /*inputs*/)
{
  if (!image_) {
    return;
  }
 
  const std::unique_ptr<MetaData> meta_data =
      this->get_input_socket(0)->get_reader()->get_meta_data();
 
  if (meta_data && meta_data->is_data) {
    image_->flag &= ~IMA_VIEW_AS_RENDER;
    /* TODO: Assign image buffer's color space to either non-color or linear, to be fully correct
     * about the content of the pixels. This needs to happen consistently with the GPU compositor,
     * and also consistently with the ibuf_ acquired as a state of this operation (which is not
     * always guaranteed to happen here. */
  }
  else {
    image_->flag |= IMA_VIEW_AS_RENDER;
  }
}
 
void ViewerOperation::clear_display_buffer()
{
  BLI_assert(is_active_viewer_output());
  if (exec_system_->is_breaked()) {
    return;
  }
 
  init_image();
  if (output_buffer_ == nullptr) {
    return;
  }
 
  size_t buf_bytes = size_t(ibuf_->y) * ibuf_->x * COM_DATA_TYPE_COLOR_CHANNELS * sizeof(float);
  if (buf_bytes > 0) {
    memset(output_buffer_, 0, buf_bytes);
    rcti display_area;
    BLI_rcti_init(&display_area, 0, ibuf_->x, 0, ibuf_->y);
    update_image(&display_area);
  }
}
 
}  // namespace blender::compositor