Cleanup: move image_save.c to c++

1 files changed, 451 insertions, 0 deletions

diff --git a/source/blender/blenkernel/intern/image_save.cc b/source/blender/blenkernel/intern/image_save.cc
new file mode 100644
index 00000000000..180008e0f64
--- /dev/null
+++ b/source/blender/blenkernel/intern/image_save.cc
@@ -0,0 +1,451 @@
+/* SPDX-License-Identifier: GPL-2.0-or-later
+ * Copyright 2001-2002 NaN Holding BV. All rights reserved. */
+
+/** \file
+ * \ingroup bke
+ */
+
+#include <errno.h>
+#include <string.h>
+
+#include "BLI_listbase.h"
+#include "BLI_path_util.h"
+#include "BLI_string.h"
+
+#include "DNA_image_types.h"
+
+#include "MEM_guardedalloc.h"
+
+#include "IMB_colormanagement.h"
+#include "IMB_imbuf.h"
+#include "IMB_imbuf_types.h"
+
+#include "BKE_colortools.h"
+#include "BKE_image.h"
+#include "BKE_image_format.h"
+#include "BKE_image_save.h"
+#include "BKE_main.h"
+#include "BKE_report.h"
+#include "BKE_scene.h"
+
+#include "RE_pipeline.h"
+
+void BKE_image_save_options_init(ImageSaveOptions *opts, Main *bmain, Scene *scene)
+{
+  memset(opts, 0, sizeof(*opts));
+
+  opts->bmain = bmain;
+  opts->scene = scene;
+
+  BKE_image_format_init(&opts->im_format, false);
+}
+
+void BKE_image_save_options_free(ImageSaveOptions *opts)
+{
+  BKE_image_format_free(&opts->im_format);
+}
+
+static void image_save_post(ReportList *reports,
+                            Image *ima,
+                            ImBuf *ibuf,
+                            int ok,
+                            ImageSaveOptions *opts,
+                            int save_copy,
+                            const char *filepath,
+                            bool *r_colorspace_changed)
+{
+  if (!ok) {
+    BKE_reportf(reports, RPT_ERROR, "Could not write image: %s", strerror(errno));
+    return;
+  }
+
+  if (save_copy) {
+    return;
+  }
+
+  if (opts->do_newpath) {
+    BLI_strncpy(ibuf->name, filepath, sizeof(ibuf->name));
+    BLI_strncpy(ima->filepath, filepath, sizeof(ima->filepath));
+  }
+
+  ibuf->userflags &= ~IB_BITMAPDIRTY;
+
+  /* change type? */
+  if (ima->type == IMA_TYPE_R_RESULT) {
+    ima->type = IMA_TYPE_IMAGE;
+
+    /* workaround to ensure the render result buffer is no longer used
+     * by this image, otherwise can crash when a new render result is
+     * created. */
+    if (ibuf->rect && !(ibuf->mall & IB_rect)) {
+      imb_freerectImBuf(ibuf);
+    }
+    if (ibuf->rect_float && !(ibuf->mall & IB_rectfloat)) {
+      imb_freerectfloatImBuf(ibuf);
+    }
+    if (ibuf->zbuf && !(ibuf->mall & IB_zbuf)) {
+      IMB_freezbufImBuf(ibuf);
+    }
+    if (ibuf->zbuf_float && !(ibuf->mall & IB_zbuffloat)) {
+      IMB_freezbuffloatImBuf(ibuf);
+    }
+  }
+  if (ELEM(ima->source, IMA_SRC_GENERATED, IMA_SRC_VIEWER)) {
+    ima->source = IMA_SRC_FILE;
+    ima->type = IMA_TYPE_IMAGE;
+  }
+
+  /* only image path, never ibuf */
+  if (opts->relative) {
+    const char *relbase = ID_BLEND_PATH(opts->bmain, &ima->id);
+    BLI_path_rel(ima->filepath, relbase); /* only after saving */
+  }
+
+  ColorManagedColorspaceSettings old_colorspace_settings;
+  BKE_color_managed_colorspace_settings_copy(&old_colorspace_settings, &ima->colorspace_settings);
+  IMB_colormanagement_colorspace_from_ibuf_ftype(&ima->colorspace_settings, ibuf);
+  if (!BKE_color_managed_colorspace_settings_equals(&old_colorspace_settings,
+                                                    &ima->colorspace_settings)) {
+    *r_colorspace_changed = true;
+  }
+}
+
+static void imbuf_save_post(ImBuf *ibuf, ImBuf *colormanaged_ibuf)
+{
+  if (colormanaged_ibuf != ibuf) {
+    /* This guys might be modified by image buffer write functions,
+     * need to copy them back from color managed image buffer to an
+     * original one, so file type of image is being properly updated.
+     */
+    ibuf->ftype = colormanaged_ibuf->ftype;
+    ibuf->foptions = colormanaged_ibuf->foptions;
+    ibuf->planes = colormanaged_ibuf->planes;
+
+    IMB_freeImBuf(colormanaged_ibuf);
+  }
+}
+
+/**
+ * \return success.
+ * \note `ima->filepath` and `ibuf->name` should end up the same.
+ * \note for multi-view the first `ibuf` is important to get the settings.
+ */
+static bool image_save_single(ReportList *reports,
+                              Image *ima,
+                              ImageUser *iuser,
+                              ImageSaveOptions *opts,
+                              bool *r_colorspace_changed)
+{
+  void *lock;
+  ImBuf *ibuf = BKE_image_acquire_ibuf(ima, iuser, &lock);
+  RenderResult *rr = nullptr;
+  bool ok = false;
+
+  if (ibuf == nullptr || (ibuf->rect == nullptr && ibuf->rect_float == nullptr)) {
+    BKE_image_release_ibuf(ima, ibuf, lock);
+    return ok;
+  }
+
+  ImBuf *colormanaged_ibuf = nullptr;
+  const bool save_copy = opts->save_copy;
+  const bool save_as_render = opts->save_as_render;
+  ImageFormatData *imf = &opts->im_format;
+
+  if (ima->type == IMA_TYPE_R_RESULT) {
+    /* enforce user setting for RGB or RGBA, but skip BW */
+    if (opts->im_format.planes == R_IMF_PLANES_RGBA) {
+      ibuf->planes = R_IMF_PLANES_RGBA;
+    }
+    else if (opts->im_format.planes == R_IMF_PLANES_RGB) {
+      ibuf->planes = R_IMF_PLANES_RGB;
+    }
+  }
+  else {
+    /* TODO: better solution, if a 24bit image is painted onto it may contain alpha. */
+    if ((opts->im_format.planes == R_IMF_PLANES_RGBA) &&
+        /* it has been painted onto */
+        (ibuf->userflags & IB_BITMAPDIRTY)) {
+      /* checks each pixel, not ideal */
+      ibuf->planes = BKE_imbuf_alpha_test(ibuf) ? R_IMF_PLANES_RGBA : R_IMF_PLANES_RGB;
+    }
+  }
+
+  /* we need renderresult for exr and rendered multiview */
+  rr = BKE_image_acquire_renderresult(opts->scene, ima);
+  bool is_mono = rr ? BLI_listbase_count_at_most(&rr->views, 2) < 2 :
+                      BLI_listbase_count_at_most(&ima->views, 2) < 2;
+  bool is_exr_rr = rr && ELEM(imf->imtype, R_IMF_IMTYPE_OPENEXR, R_IMF_IMTYPE_MULTILAYER) &&
+                   RE_HasFloatPixels(rr);
+  bool is_multilayer = is_exr_rr && (imf->imtype == R_IMF_IMTYPE_MULTILAYER);
+  int layer = (iuser && !is_multilayer) ? iuser->layer : -1;
+
+  /* error handling */
+  if (rr == nullptr) {
+    if (imf->imtype == R_IMF_IMTYPE_MULTILAYER) {
+      BKE_report(reports, RPT_ERROR, "Did not write, no Multilayer Image");
+      BKE_image_release_ibuf(ima, ibuf, lock);
+      return ok;
+    }
+  }
+  else {
+    if (imf->views_format == R_IMF_VIEWS_STEREO_3D) {
+      if (!BKE_image_is_stereo(ima)) {
+        BKE_reportf(reports,
+                    RPT_ERROR,
+                    "Did not write, the image doesn't have a \"%s\" and \"%s\" views",
+                    STEREO_LEFT_NAME,
+                    STEREO_RIGHT_NAME);
+        BKE_image_release_ibuf(ima, ibuf, lock);
+        BKE_image_release_renderresult(opts->scene, ima);
+        return ok;
+      }
+
+      /* It shouldn't ever happen. */
+      if ((BLI_findstring(&rr->views, STEREO_LEFT_NAME, offsetof(RenderView, name)) == nullptr) ||
+          (BLI_findstring(&rr->views, STEREO_RIGHT_NAME, offsetof(RenderView, name)) == nullptr)) {
+        BKE_reportf(reports,
+                    RPT_ERROR,
+                    "Did not write, the image doesn't have a \"%s\" and \"%s\" views",
+                    STEREO_LEFT_NAME,
+                    STEREO_RIGHT_NAME);
+        BKE_image_release_ibuf(ima, ibuf, lock);
+        BKE_image_release_renderresult(opts->scene, ima);
+        return ok;
+      }
+    }
+    BKE_imbuf_stamp_info(rr, ibuf);
+  }
+
+  /* fancy multiview OpenEXR */
+  if (imf->views_format == R_IMF_VIEWS_MULTIVIEW && is_exr_rr) {
+    /* save render result */
+    ok = RE_WriteRenderResult(reports, rr, opts->filepath, imf, nullptr, layer);
+    image_save_post(reports, ima, ibuf, ok, opts, true, opts->filepath, r_colorspace_changed);
+    BKE_image_release_ibuf(ima, ibuf, lock);
+  }
+  /* regular mono pipeline */
+  else if (is_mono) {
+    if (is_exr_rr) {
+      ok = RE_WriteRenderResult(reports, rr, opts->filepath, imf, nullptr, layer);
+    }
+    else {
+      colormanaged_ibuf = IMB_colormanagement_imbuf_for_write(
+          ibuf, save_as_render, true, &imf->view_settings, &imf->display_settings, imf);
+      ok = BKE_imbuf_write_as(colormanaged_ibuf, opts->filepath, imf, save_copy);
+      imbuf_save_post(ibuf, colormanaged_ibuf);
+    }
+    image_save_post(reports,
+                    ima,
+                    ibuf,
+                    ok,
+                    opts,
+                    (is_exr_rr ? true : save_copy),
+                    opts->filepath,
+                    r_colorspace_changed);
+    BKE_image_release_ibuf(ima, ibuf, lock);
+  }
+  /* individual multiview images */
+  else if (imf->views_format == R_IMF_VIEWS_INDIVIDUAL) {
+    unsigned char planes = ibuf->planes;
+    const int totviews = (rr ? BLI_listbase_count(&rr->views) : BLI_listbase_count(&ima->views));
+
+    if (!is_exr_rr) {
+      BKE_image_release_ibuf(ima, ibuf, lock);
+    }
+
+    for (int i = 0; i < totviews; i++) {
+      char filepath[FILE_MAX];
+      bool ok_view = false;
+      const char *view = rr ? ((RenderView *)BLI_findlink(&rr->views, i))->name :
+                              ((ImageView *)BLI_findlink(&ima->views, i))->name;
+
+      if (is_exr_rr) {
+        BKE_scene_multiview_view_filepath_get(&opts->scene->r, opts->filepath, view, filepath);
+        ok_view = RE_WriteRenderResult(reports, rr, filepath, imf, view, layer);
+        image_save_post(reports, ima, ibuf, ok_view, opts, true, filepath, r_colorspace_changed);
+      }
+      else {
+        /* copy iuser to get the correct ibuf for this view */
+        ImageUser view_iuser;
+
+        if (iuser) {
+          /* copy iuser to get the correct ibuf for this view */
+          view_iuser = *iuser;
+        }
+        else {
+          BKE_imageuser_default(&view_iuser);
+        }
+
+        view_iuser.view = i;
+        view_iuser.flag &= ~IMA_SHOW_STEREO;
+
+        if (rr) {
+          BKE_image_multilayer_index(rr, &view_iuser);
+        }
+        else {
+          BKE_image_multiview_index(ima, &view_iuser);
+        }
+
+        ibuf = BKE_image_acquire_ibuf(ima, &view_iuser, &lock);
+        ibuf->planes = planes;
+
+        BKE_scene_multiview_view_filepath_get(&opts->scene->r, opts->filepath, view, filepath);
+
+        colormanaged_ibuf = IMB_colormanagement_imbuf_for_write(
+            ibuf, save_as_render, true, &imf->view_settings, &imf->display_settings, imf);
+        ok_view = BKE_imbuf_write_as(colormanaged_ibuf, filepath, &opts->im_format, save_copy);
+        imbuf_save_post(ibuf, colormanaged_ibuf);
+        image_save_post(reports, ima, ibuf, ok_view, opts, true, filepath, r_colorspace_changed);
+        BKE_image_release_ibuf(ima, ibuf, lock);
+      }
+      ok &= ok_view;
+    }
+
+    if (is_exr_rr) {
+      BKE_image_release_ibuf(ima, ibuf, lock);
+    }
+  }
+  /* stereo (multiview) images */
+  else if (opts->im_format.views_format == R_IMF_VIEWS_STEREO_3D) {
+    if (imf->imtype == R_IMF_IMTYPE_MULTILAYER) {
+      ok = RE_WriteRenderResult(reports, rr, opts->filepath, imf, nullptr, layer);
+      image_save_post(reports, ima, ibuf, ok, opts, true, opts->filepath, r_colorspace_changed);
+      BKE_image_release_ibuf(ima, ibuf, lock);
+    }
+    else {
+      ImBuf *ibuf_stereo[2] = {nullptr};
+
+      unsigned char planes = ibuf->planes;
+      const char *names[2] = {STEREO_LEFT_NAME, STEREO_RIGHT_NAME};
+
+      /* we need to get the specific per-view buffers */
+      BKE_image_release_ibuf(ima, ibuf, lock);
+      bool stereo_ok = true;
+
+      for (int i = 0; i < 2; i++) {
+        ImageUser view_iuser;
+
+        if (iuser) {
+          view_iuser = *iuser;
+        }
+        else {
+          BKE_imageuser_default(&view_iuser);
+        }
+
+        view_iuser.flag &= ~IMA_SHOW_STEREO;
+
+        if (rr) {
+          int id = BLI_findstringindex(&rr->views, names[i], offsetof(RenderView, name));
+          view_iuser.view = id;
+          BKE_image_multilayer_index(rr, &view_iuser);
+        }
+        else {
+          view_iuser.view = i;
+          BKE_image_multiview_index(ima, &view_iuser);
+        }
+
+        ibuf = BKE_image_acquire_ibuf(ima, &view_iuser, &lock);
+
+        if (ibuf == nullptr) {
+          BKE_report(
+              reports, RPT_ERROR, "Did not write, unexpected error when saving stereo image");
+          BKE_image_release_ibuf(ima, ibuf, lock);
+          stereo_ok = false;
+          break;
+        }
+
+        ibuf->planes = planes;
+
+        /* color manage the ImBuf leaving it ready for saving */
+        colormanaged_ibuf = IMB_colormanagement_imbuf_for_write(
+            ibuf, save_as_render, true, &imf->view_settings, &imf->display_settings, imf);
+
+        BKE_image_format_to_imbuf(colormanaged_ibuf, imf);
+        IMB_prepare_write_ImBuf(IMB_isfloat(colormanaged_ibuf), colormanaged_ibuf);
+
+        /* duplicate buffer to prevent locker issue when using render result */
+        ibuf_stereo[i] = IMB_dupImBuf(colormanaged_ibuf);
+
+        imbuf_save_post(ibuf, colormanaged_ibuf);
+
+        BKE_image_release_ibuf(ima, ibuf, lock);
+      }
+
+      if (stereo_ok) {
+        ibuf = IMB_stereo3d_ImBuf(imf, ibuf_stereo[0], ibuf_stereo[1]);
+
+        /* save via traditional path */
+        ok = BKE_imbuf_write_as(ibuf, opts->filepath, imf, save_copy);
+
+        IMB_freeImBuf(ibuf);
+      }
+
+      for (int i = 0; i < 2; i++) {
+        IMB_freeImBuf(ibuf_stereo[i]);
+      }
+    }
+  }
+
+  return ok;
+}
+
+bool BKE_image_save(
+    ReportList *reports, Main *bmain, Image *ima, ImageUser *iuser, ImageSaveOptions *opts)
+{
+  ImageUser save_iuser;
+  BKE_imageuser_default(&save_iuser);
+
+  bool colorspace_changed = false;
+
+  eUDIM_TILE_FORMAT tile_format;
+  char *udim_pattern = nullptr;
+
+  if (ima->source == IMA_SRC_TILED) {
+    /* Verify filepath for tiled images contains a valid UDIM marker. */
+    udim_pattern = BKE_image_get_tile_strformat(opts->filepath, &tile_format);
+    if (tile_format == UDIM_TILE_FORMAT_NONE) {
+      BKE_reportf(reports,
+                  RPT_ERROR,
+                  "When saving a tiled image, the path '%s' must contain a valid UDIM marker",
+                  opts->filepath);
+      return false;
+    }
+
+    /* For saving a tiled image we need an iuser, so use a local one if there isn't already one.
+     */
+    if (iuser == nullptr) {
+      iuser = &save_iuser;
+    }
+  }
+
+  /* Save images */
+  bool ok = false;
+  if (ima->source != IMA_SRC_TILED) {
+    ok = image_save_single(reports, ima, iuser, opts, &colorspace_changed);
+  }
+  else {
+    char filepath[FILE_MAX];
+    BLI_strncpy(filepath, opts->filepath, sizeof(filepath));
+
+    /* Save all the tiles. */
+    LISTBASE_FOREACH (ImageTile *, tile, &ima->tiles) {
+      BKE_image_set_filepath_from_tile_number(
+          opts->filepath, udim_pattern, tile_format, tile->tile_number);
+
+      iuser->tile = tile->tile_number;
+      ok = image_save_single(reports, ima, iuser, opts, &colorspace_changed);
+      if (!ok) {
+        break;
+      }
+    }
+    BLI_strncpy(ima->filepath, filepath, sizeof(ima->filepath));
+    BLI_strncpy(opts->filepath, filepath, sizeof(opts->filepath));
+    MEM_freeN(udim_pattern);
+  }
+
+  if (colorspace_changed) {
+    BKE_image_signal(bmain, ima, nullptr, IMA_SIGNAL_COLORMANAGE);
+  }
+
+  return ok;
+}