Blender V5.3
format_webp.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#ifdef _WIN32
10# include <io.h>
11#else
12# include <unistd.h>
13#endif
14
15#include <fcntl.h>
16#include <string>
17#include <webp/decode.h>
18
20
21#include "BLI_fileops.hh"
22#include "BLI_mmap.hh"
23
24#include "IMB_filetype.hh"
25#include "IMB_imbuf.hh"
26#include "IMB_imbuf_types.hh"
27
28#include "CLG_log.h"
29
30namespace blender {
31
32const char *imb_file_extensions_webp[] = {".webp", nullptr};
33
34static CLG_LogRef LOG = {"image.webp"};
35
36OIIO_NAMESPACE_USING
37using namespace blender::imbuf;
38
39bool imb_is_a_webp(const uchar *mem, size_t size)
40{
41 return imb_oiio_check(mem, size, "webp");
42}
43
45 size_t size,
46 ImBufFlags flags,
47 ImFileColorSpace &r_colorspace)
48{
49 ImageSpec config, spec;
50 config.attribute("oiio:UnassociatedAlpha", 1);
51
52 ReadContext ctx{mem, size, "webp", IMB_FTYPE_WEBP, flags};
53 ImBuf *ibuf = imb_oiio_read(ctx, config, r_colorspace, spec);
54
55 r_colorspace.is_hdr_float = false;
56 return ibuf;
57}
58
60 const ImBufFlags /*flags*/,
61 const size_t max_thumb_size,
62 ImFileColorSpace & /*r_colorspace*/,
63 size_t *r_width,
64 size_t *r_height)
65{
66 const int file = BLI_open(filepath, O_BINARY | O_RDONLY, 0);
67 if (file == -1) {
68 return nullptr;
69 }
70
71 BLI_mmap_file *mmap_file = BLI_mmap_open(file);
72 close(file);
73 if (mmap_file == nullptr) {
74 return nullptr;
75 }
76
77 const uchar *data = static_cast<const uchar *>(BLI_mmap_get_pointer(mmap_file));
78 const size_t data_size = BLI_mmap_get_length(mmap_file);
79
80 WebPDecoderConfig config;
81 if (!data || !WebPInitDecoderConfig(&config) ||
82 WebPGetFeatures(data, data_size, &config.input) != VP8_STATUS_OK ||
83 BLI_mmap_any_io_error(mmap_file))
84 {
85 CLOG_ERROR(&LOG, "Invalid file");
86 BLI_mmap_free(mmap_file);
87 return nullptr;
88 }
89
90 /* Return full size of the image. */
91 *r_width = size_t(config.input.width);
92 *r_height = size_t(config.input.height);
93
94 const float scale = float(max_thumb_size) / std::max(config.input.width, config.input.height);
95 const int dest_w = std::max(int(config.input.width * scale), 1);
96 const int dest_h = std::max(int(config.input.height * scale), 1);
97
98 ImBuf *ibuf = IMB_allocImBuf(dest_w, dest_h, ImBufFlags::ByteData);
99 if (ibuf == nullptr) {
100 CLOG_ERROR(&LOG, "Failed to allocate image memory");
101 BLI_mmap_free(mmap_file);
102 return nullptr;
103 }
104
105 config.options.no_fancy_upsampling = 1;
106 config.options.use_scaling = 1;
107 config.options.scaled_width = dest_w;
108 config.options.scaled_height = dest_h;
109 config.options.bypass_filtering = 1;
110 config.options.use_threads = 0;
111 config.options.flip = 1;
112 config.output.is_external_memory = 1;
113 config.output.colorspace = MODE_RGBA;
114 config.output.u.RGBA.rgba = ibuf->byte_data_for_write();
115 config.output.u.RGBA.stride = 4 * ibuf->x;
116 config.output.u.RGBA.size = size_t(config.output.u.RGBA.stride) * size_t(ibuf->y);
117
118 if (WebPDecode(data, data_size, &config) != VP8_STATUS_OK || BLI_mmap_any_io_error(mmap_file)) {
119 CLOG_ERROR(&LOG, "Failed to decode image");
120 IMB_freeImBuf(ibuf);
121 BLI_mmap_free(mmap_file);
122 return nullptr;
123 }
124
125 /* Free the output buffer. */
126 WebPFreeDecBuffer(&config.output);
127
128 BLI_mmap_free(mmap_file);
129
130 return ibuf;
131}
132
133static std::tuple<WriteContext, ImageSpec> prepare_save_webp(ImBuf *ibuf, ImBufFlags flags)
134{
135 int file_channels = ibuf->color_mode_channels_get();
136 /* WebP does not support 2-channel (gray + alpha) writes; promote to RGBA. */
137 if (file_channels == 2) {
138 file_channels = 4;
139 }
140 const TypeDesc data_format = TypeDesc::UINT8;
141
142 WriteContext ctx = imb_create_write_context("webp", ibuf, flags, false);
143 ImageSpec file_spec = imb_create_write_spec(ctx, file_channels, data_format);
144
145 file_spec.attribute("oiio:UnassociatedAlpha", 1);
146
147 /* A general quality/speed trade-off (0=fast, 6=slower-better). 4 matches historical value. */
148 file_spec.attribute("webp:method", 4);
149
150 if (ibuf->foptions.quality == 100.0f) {
151 /* Lossless compression. */
152 /* Use 70 to match historical value (see libwebp's LOSSLESS_DEFAULT_QUALITY). */
153 file_spec.attribute("compression", "lossless:70");
154 }
155 else {
156 /* Lossy compression. */
157 file_spec.attribute("compression",
158 std::string("webp:") + std::to_string(ibuf->foptions.quality));
159 }
160 return {ctx, file_spec};
161}
162
163bool imb_savewebp(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
164{
165 const auto [ctx, file_spec] = prepare_save_webp(ibuf, flags);
166 return imb_oiio_write(ctx, filepath, file_spec);
167}
168
170{
171 const auto [ctx, file_spec] = prepare_save_webp(ibuf, flags);
172 return imb_oiio_write_buffer(ctx, file_spec);
173}
174
175} // namespace blender
File and directory operations.
#define O_BINARY
#define CLOG_ERROR(clg_ref,...)
Definition CLG_log.h:188
float3x3 scale(float3x3 mat, float2 scale)
bool imb_oiio_write(const WriteContext &ctx, const char *filepath, const ImageSpec &file_spec)
ImBuf * imb_oiio_read(const ReadContext &ctx, const ImageSpec &config, ImFileColorSpace &r_colorspace, ImageSpec &r_newspec)
bool imb_oiio_check(const uchar *mem, size_t mem_size, const char *file_format)
ImageSpec imb_create_write_spec(const WriteContext &ctx, int file_channels, TypeDesc data_format)
WriteContext imb_create_write_context(const char *file_format, const ImBuf *ibuf, ImBufFlags flags, bool prefer_float)
Vector< uint8_t > imb_oiio_write_buffer(const WriteContext &ctx, const ImageSpec &file_spec)
BMesh Iterators.
const char * imb_file_extensions_webp[]
size_t BLI_mmap_get_length(const BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
Definition BLI_mmap.cc:484
BLI_mmap_file * BLI_mmap_open(int fd) ATTR_MALLOC ATTR_WARN_UNUSED_RESULT
Definition BLI_mmap.cc:369
int BLI_open(const char *filepath, int oflag, int pmode) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void BLI_mmap_free(BLI_mmap_file *file) ATTR_NONNULL(1)
Definition BLI_mmap.cc:494
ImBuf * imb_loadwebp(const uchar *mem, size_t size, ImBufFlags flags, ImFileColorSpace &r_colorspace)
void IMB_freeImBuf(ImBuf *ibuf)
unsigned char uchar
Definition BKE_text.h:58
Vector< uint8_t > imb_save_buffer_webp(ImBuf *ibuf, ImBufFlags flags)
BMesh const char void * data
ImBuf * imb_load_filepath_thumbnail_webp(const char *filepath, const ImBufFlags, const size_t max_thumb_size, ImFileColorSpace &, size_t *r_width, size_t *r_height)
bool imb_savewebp(ImBuf *ibuf, const char *filepath, ImBufFlags flags)
bool BLI_mmap_any_io_error(const BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
Definition BLI_mmap.cc:489
ImBuf * IMB_allocImBuf(unsigned int x, unsigned int y, ImBufFlags flags)
void * BLI_mmap_get_pointer(BLI_mmap_file *file) ATTR_WARN_UNUSED_RESULT
Definition BLI_mmap.cc:479
static CLG_LogRef LOG
Definition logging.cpp:12
static std::tuple< WriteContext, ImageSpec > prepare_save_webp(ImBuf *ibuf, ImBufFlags flags)
bool imb_is_a_webp(const uchar *mem, size_t size)
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
ImbFormatOptions foptions
uint8_t * byte_data_for_write()
Definition allocimbuf.cc:60
int color_mode_channels_get() const