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 "image-load-jpegxl.h"
  54
  55 #include <cstdint>
  56 #include <cstdlib>
  57 #include <memory>
  58
  59 #include <gdk-pixbuf/gdk-pixbuf.h>
  60 #include <glib-object.h>
  61 #include <glib.h>
  62 #include <jxl/codestream_header.h>
  63 #include <jxl/decode.h> //TODO Use decode_cxx.h?
  64 #include <jxl/types.h>
  65
  66 #include "debug.h"
  67 #include "image-load.h"
  68
  69 namespace
  70 {
  71
  72 struct ImageLoaderJPEGXL : public ImageLoaderBackend
  73 {
  74 public:
  75         ~ImageLoaderJPEGXL() override;
  76
  77         void init(AreaUpdatedCb area_updated_cb, SizePreparedCb size_prepared_cb, AreaPreparedCb area_prepared_cb, gpointer data) override;
  78         gboolean write(const guchar *buf, gsize &chunk_size, gsize count, GError **error) override;
  79         GdkPixbuf *get_pixbuf() override;
  80         gchar *get_format_name() override;
  81         gchar **get_format_mime_types() override;
  82
  83 private:
  84         AreaUpdatedCb area_updated_cb;
  85         gpointer data;
  86
  87         GdkPixbuf *pixbuf;
  88 };
  89
  90 void free_buffer(guchar *pixels, gpointer)
  91 {
  92         g_free(pixels);
  93 }
  94
  95 uint8_t *JxlMemoryToPixels(const uint8_t *next_in, size_t size, size_t &xsize, size_t &ysize, size_t &stride)
  96 {
  97         std::unique_ptr<JxlDecoder, decltype(&JxlDecoderDestroy)> dec{JxlDecoderCreate(nullptr), JxlDecoderDestroy};
  98         if (!dec)
  99                 {
 100                 log_printf("JxlDecoderCreate failed\n");
 101                 return nullptr;
 102                 }
 103         if (JXL_DEC_SUCCESS != JxlDecoderSubscribeEvents(dec.get(), JXL_DEC_BASIC_INFO | JXL_DEC_FULL_IMAGE))
 104                 {
 105                 log_printf("JxlDecoderSubscribeEvents failed\n");
 106                 return nullptr;
 107                 }
 108
 109         /* Avoid compiler warning - used uninitialized */
 110         /* This file will be replaced by libjxl at some time */
 111         ysize = 0;
 112         stride = 0;
 113
 114         std::unique_ptr<uint8_t, decltype(&free)> pixels{nullptr, free};
 115         JxlBasicInfo info;
 116         JxlPixelFormat format = {4, JXL_TYPE_UINT8, JXL_NATIVE_ENDIAN, 0};
 117         JxlDecoderSetInput(dec.get(), next_in, size);
 118
 119         for (;;)
 120                 {
 121                 JxlDecoderStatus status = JxlDecoderProcessInput(dec.get());
 122
 123                 switch (status)
 124                         {
 125                         case JXL_DEC_ERROR:
 126                                 log_printf("Decoder error\n");
 127                                 return nullptr;
 128                         case JXL_DEC_NEED_MORE_INPUT:
 129                                 log_printf("Error, already provided all input\n");
 130                                 return nullptr;
 131                         case JXL_DEC_BASIC_INFO:
 132                                 if (JXL_DEC_SUCCESS != JxlDecoderGetBasicInfo(dec.get(), &info))
 133                                         {
 134                                         log_printf("JxlDecoderGetBasicInfo failed\n");
 135                                         return nullptr;
 136                                         }
 137                                 xsize = info.xsize;
 138                                 ysize = info.ysize;
 139                                 stride = info.xsize * 4;
 140                                 break;
 141                         case JXL_DEC_NEED_IMAGE_OUT_BUFFER:
 142                                 {
 143                                 size_t buffer_size;
 144                                 if (JXL_DEC_SUCCESS != JxlDecoderImageOutBufferSize(dec.get(), &format, &buffer_size))
 145                                         {
 146                                         log_printf("JxlDecoderImageOutBufferSize failed\n");
 147                                         return nullptr;
 148                                         }
 149                                 if (buffer_size != stride * ysize)
 150                                         {
 151                                         log_printf("Invalid out buffer size %zu %zu\n", buffer_size, stride * ysize);
 152                                         return nullptr;
 153                                         }
 154                                 size_t pixels_buffer_size = buffer_size * sizeof(uint8_t);
 155                                 pixels.reset(static_cast<uint8_t *>(malloc(pixels_buffer_size)));
 156                                 if (JXL_DEC_SUCCESS != JxlDecoderSetImageOutBuffer(dec.get(), &format, pixels.get(), pixels_buffer_size))
 157                                         {
 158                                         log_printf("JxlDecoderSetImageOutBuffer failed\n");
 159                                         return nullptr;
 160                                         }
 161                                 }
 162                                 break;
 163                         case JXL_DEC_FULL_IMAGE:
 164                                 // This means the decoder has decoded all pixels into the buffer.
 165                                 return pixels.release();
 166                         case JXL_DEC_SUCCESS:
 167                                 log_printf("Decoding finished before receiving pixel data\n");
 168                                 return nullptr;
 169                         default:
 170                                 log_printf("Unexpected decoder status: %d\n", status);
 171                                 return nullptr;
 172                         }
 173                 }
 174
 175         return nullptr;
 176 }
 177
 178 gboolean ImageLoaderJPEGXL::write(const guchar *buf, gsize &chunk_size, gsize count, GError **)
 179 {
 180         gboolean ret = FALSE;
 181         size_t xsize;
 182         size_t ysize;
 183         size_t stride;
 184         uint8_t *pixels = nullptr;
 185
 186         pixels = JxlMemoryToPixels(buf, count, xsize, ysize, stride);
 187
 188         if (pixels)
 189                 {
 190                 pixbuf = gdk_pixbuf_new_from_data(pixels, GDK_COLORSPACE_RGB, TRUE, 8, xsize, ysize, stride, free_buffer, nullptr);
 191
 192                 area_updated_cb(nullptr, 0, 0, xsize, ysize, data);
 193
 194                 chunk_size = count;
 195                 ret = TRUE;
 196                 }
 197
 198         return ret;
 199 }
 200
 201 void ImageLoaderJPEGXL::init(AreaUpdatedCb area_updated_cb, SizePreparedCb, AreaPreparedCb, gpointer data)
 202 {
 203         this->area_updated_cb = area_updated_cb;
 204         this->data = data;
 205 }
 206
 207 GdkPixbuf *ImageLoaderJPEGXL::get_pixbuf()
 208 {
 209         return pixbuf;
 210 }
 211
 212 gchar *ImageLoaderJPEGXL::get_format_name()
 213 {
 214         return g_strdup("jxl");
 215 }
 216
 217 gchar **ImageLoaderJPEGXL::get_format_mime_types()
 218 {
 219         static const gchar *mime[] = {"image/jxl", nullptr};
 220         return g_strdupv(const_cast<gchar **>(mime));
 221 }
 222
 223 ImageLoaderJPEGXL::~ImageLoaderJPEGXL()
 224 {
 225         if (pixbuf) g_object_unref(pixbuf);
 226 }
 227
 228 } // namespace
 229
 230 std::unique_ptr<ImageLoaderBackend> get_image_loader_backend_jpegxl()
 231 {
 232         return std::make_unique<ImageLoaderJPEGXL>();
 233 }
 234
 235 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */