src/image-load-jpegxl.cc

   1 /*
   2  * Copyright (C) 2021- The Geeqie Team
   3  *
   4  * Author: Colin Clark
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  *
  21  * Including parts:
  22  *
  23  * Copyright (c) the JPEG XL Project Authors.
  24  * All rights reserved.
  25  *
  26  * Redistribution and use in source and binary forms, with or without
  27  * modification, are permitted provided that the following conditions are met:
  28  *
  29  * 1. Redistributions of source code must retain the above copyright notice, this
  30  *    list of conditions and the following disclaimer.
  31  *
  32  * 2. Redistributions in binary form must reproduce the above copyright notice,
  33  *    this list of conditions and the following disclaimer in the documentation
  34  *    and/or other materials provided with the distribution.
  35  *
  36  * 3. Neither the name of the copyright holder nor the names of its
  37  *    contributors may be used to endorse or promote products derived from
  38  *    this software without specific prior written permission.
  39  *
  40  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  41  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  42  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  43  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  44  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  45  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  46  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  47  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  48  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  49  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  50  *
  51  */
  52
  53 #include <config.h>
  54
  55 #if HAVE_JPEGXL
  56
  57 #include "image-load-jpegxl.h"
  58
  59 #include <cstdint>
  60 #include <cstdlib>
  61 #include <memory>
  62
  63 #include <gdk-pixbuf/gdk-pixbuf.h>
  64 #include <glib-object.h>
  65 #include <glib.h>
  66 #include <jxl/codestream_header.h>
  67 #include <jxl/decode.h> //TODO Use decode_cxx.h?
  68 #include <jxl/types.h>
  69
  70 #include "debug.h"
  71 #include "image-load.h"
  72
  73 struct ImageLoaderJPEGXL {
  74         ImageLoaderBackendCbAreaUpdated area_updated_cb;
  75         ImageLoaderBackendCbSize size_cb;
  76         ImageLoaderBackendCbAreaPrepared area_prepared_cb;
  77         gpointer data;
  78         GdkPixbuf *pixbuf;
  79         guint requested_width;
  80         guint requested_height;
  81         gboolean abort;
  82 };
  83
  84 static void free_buffer(guchar *pixels, gpointer)
  85 {
  86         g_free(pixels);
  87 }
  88
  89 static uint8_t *JxlMemoryToPixels(const uint8_t *next_in, size_t size, size_t &xsize, size_t &ysize, size_t &stride)
  90 {
  91         std::unique_ptr<JxlDecoder, decltype(&JxlDecoderDestroy)> dec{JxlDecoderCreate(nullptr), JxlDecoderDestroy};
  92         if (!dec)
  93                 {
  94                 log_printf("JxlDecoderCreate failed\n");
  95                 return nullptr;
  96                 }
  97         if (JXL_DEC_SUCCESS != JxlDecoderSubscribeEvents(dec.get(), JXL_DEC_BASIC_INFO | JXL_DEC_FULL_IMAGE))
  98                 {
  99                 log_printf("JxlDecoderSubscribeEvents failed\n");
 100                 return nullptr;
 101                 }
 102
 103         /* Avoid compiler warning - used uninitialized */
 104         /* This file will be replaced by libjxl at some time */
 105         ysize = 0;
 106         stride = 0;
 107
 108         std::unique_ptr<uint8_t, decltype(&free)> pixels{nullptr, free};
 109         JxlBasicInfo info;
 110         JxlPixelFormat format = {4, JXL_TYPE_UINT8, JXL_NATIVE_ENDIAN, 0};
 111         JxlDecoderSetInput(dec.get(), next_in, size);
 112
 113         for (;;)
 114                 {
 115                 JxlDecoderStatus status = JxlDecoderProcessInput(dec.get());
 116
 117                 switch (status)
 118                         {
 119                         case JXL_DEC_ERROR:
 120                                 log_printf("Decoder error\n");
 121                                 return nullptr;
 122                         case JXL_DEC_NEED_MORE_INPUT:
 123                                 log_printf("Error, already provided all input\n");
 124                                 return nullptr;
 125                         case JXL_DEC_BASIC_INFO:
 126                                 if (JXL_DEC_SUCCESS != JxlDecoderGetBasicInfo(dec.get(), &info))
 127                                         {
 128                                         log_printf("JxlDecoderGetBasicInfo failed\n");
 129                                         return nullptr;
 130                                         }
 131                                 xsize = info.xsize;
 132                                 ysize = info.ysize;
 133                                 stride = info.xsize * 4;
 134                                 break;
 135                         case JXL_DEC_NEED_IMAGE_OUT_BUFFER:
 136                                 {
 137                                 size_t buffer_size;
 138                                 if (JXL_DEC_SUCCESS != JxlDecoderImageOutBufferSize(dec.get(), &format, &buffer_size))
 139                                         {
 140                                         log_printf("JxlDecoderImageOutBufferSize failed\n");
 141                                         return nullptr;
 142                                         }
 143                                 if (buffer_size != stride * ysize)
 144                                         {
 145                                         log_printf("Invalid out buffer size %zu %zu\n", buffer_size, stride * ysize);
 146                                         return nullptr;
 147                                         }
 148                                 size_t pixels_buffer_size = buffer_size * sizeof(uint8_t);
 149                                 pixels.reset(static_cast<uint8_t *>(malloc(pixels_buffer_size)));
 150                                 if (JXL_DEC_SUCCESS != JxlDecoderSetImageOutBuffer(dec.get(), &format, pixels.get(), pixels_buffer_size))
 151                                         {
 152                                         log_printf("JxlDecoderSetImageOutBuffer failed\n");
 153                                         return nullptr;
 154                                         }
 155                                 }
 156                                 break;
 157                         case JXL_DEC_FULL_IMAGE:
 158                                 // This means the decoder has decoded all pixels into the buffer.
 159                                 return pixels.release();
 160                         case JXL_DEC_SUCCESS:
 161                                 log_printf("Decoding finished before receiving pixel data\n");
 162                                 return nullptr;
 163                         default:
 164                                 log_printf("Unexpected decoder status: %d\n", status);
 165                                 return nullptr;
 166                         }
 167                 }
 168
 169         return nullptr;
 170 }
 171
 172 static gboolean image_loader_jpegxl_load(gpointer loader, const guchar *buf, gsize count, GError **)
 173 {
 174         auto ld = static_cast<ImageLoaderJPEGXL *>(loader);
 175         gboolean ret = FALSE;
 176         size_t xsize;
 177         size_t ysize;
 178         size_t stride;
 179         uint8_t *decoded = nullptr;
 180
 181         decoded = JxlMemoryToPixels(buf, count, xsize, ysize, stride);
 182
 183         if (decoded)
 184                 {
 185                 ld->pixbuf = gdk_pixbuf_new_from_data(decoded, GDK_COLORSPACE_RGB, TRUE, 8, xsize, ysize, stride, free_buffer, nullptr);
 186
 187                 ld->area_updated_cb(loader, 0, 0, xsize, ysize, ld->data);
 188
 189                 ret = TRUE;
 190                 }
 191
 192         return ret;
 193 }
 194
 195 static gpointer image_loader_jpegxl_new(ImageLoaderBackendCbAreaUpdated area_updated_cb, ImageLoaderBackendCbSize size_cb, ImageLoaderBackendCbAreaPrepared area_prepared_cb, gpointer data)
 196 {
 197         auto loader = g_new0(ImageLoaderJPEGXL, 1);
 198         loader->area_updated_cb = area_updated_cb;
 199         loader->size_cb = size_cb;
 200         loader->area_prepared_cb = area_prepared_cb;
 201         loader->data = data;
 202         return loader;
 203 }
 204
 205 static void image_loader_jpegxl_set_size(gpointer loader, int width, int height)
 206 {
 207         auto ld = static_cast<ImageLoaderJPEGXL *>(loader);
 208         ld->requested_width = width;
 209         ld->requested_height = height;
 210 }
 211
 212 static GdkPixbuf* image_loader_jpegxl_get_pixbuf(gpointer loader)
 213 {
 214         auto ld = static_cast<ImageLoaderJPEGXL *>(loader);
 215         return ld->pixbuf;
 216 }
 217
 218 static gchar* image_loader_jpegxl_get_format_name(gpointer)
 219 {
 220         return g_strdup("jxl");
 221 }
 222
 223 static gchar** image_loader_jpegxl_get_format_mime_types(gpointer)
 224 {
 225         static const gchar *mime[] = {"image/jxl", nullptr};
 226         return g_strdupv(const_cast<gchar **>(mime));
 227 }
 228
 229 static gboolean image_loader_jpegxl_close(gpointer, GError **)
 230 {
 231         return TRUE;
 232 }
 233
 234 static void image_loader_jpegxl_abort(gpointer loader)
 235 {
 236         auto ld = static_cast<ImageLoaderJPEGXL *>(loader);
 237         ld->abort = TRUE;
 238 }
 239
 240 static void image_loader_jpegxl_free(gpointer loader)
 241 {
 242         auto ld = static_cast<ImageLoaderJPEGXL *>(loader);
 243         if (ld->pixbuf) g_object_unref(ld->pixbuf);
 244         g_free(ld);
 245 }
 246
 247 void image_loader_backend_set_jpegxl(ImageLoaderBackend *funcs)
 248 {
 249         funcs->loader_new = image_loader_jpegxl_new;
 250         funcs->set_size = image_loader_jpegxl_set_size;
 251         funcs->load = image_loader_jpegxl_load;
 252         funcs->write = nullptr;
 253         funcs->get_pixbuf = image_loader_jpegxl_get_pixbuf;
 254         funcs->close = image_loader_jpegxl_close;
 255         funcs->abort = image_loader_jpegxl_abort;
 256         funcs->free = image_loader_jpegxl_free;
 257         funcs->get_format_name = image_loader_jpegxl_get_format_name;
 258         funcs->get_format_mime_types = image_loader_jpegxl_get_format_mime_types;
 259 }
 260
 261 #endif
 262 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */