1/**************************************************************************/
2/* webp_common.cpp */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#include "webp_common.h"
32
33#include "core/config/project_settings.h"
34#include "core/os/os.h"
35
36#include <webp/decode.h>
37#include <webp/encode.h>
38
39#include <string.h>
40
41namespace WebPCommon {
42Vector<uint8_t> _webp_lossy_pack(const Ref<Image> &p_image, float p_quality) {
43 ERR_FAIL_COND_V(p_image.is_null() || p_image->is_empty(), Vector<uint8_t>());
44
45 return _webp_packer(p_image, CLAMP(p_quality * 100.0f, 0.0f, 100.0f), false);
46}
47
48Vector<uint8_t> _webp_lossless_pack(const Ref<Image> &p_image) {
49 ERR_FAIL_COND_V(p_image.is_null() || p_image->is_empty(), Vector<uint8_t>());
50
51 float compression_factor = GLOBAL_GET("rendering/textures/webp_compression/lossless_compression_factor");
52 compression_factor = CLAMP(compression_factor, 0.0f, 100.0f);
53
54 return _webp_packer(p_image, compression_factor, true);
55}
56
57Vector<uint8_t> _webp_packer(const Ref<Image> &p_image, float p_quality, bool p_lossless) {
58 int compression_method = GLOBAL_GET("rendering/textures/webp_compression/compression_method");
59 compression_method = CLAMP(compression_method, 0, 6);
60
61 Ref<Image> img = p_image->duplicate();
62 if (img->detect_alpha()) {
63 img->convert(Image::FORMAT_RGBA8);
64 } else {
65 img->convert(Image::FORMAT_RGB8);
66 }
67
68 Size2 s(img->get_width(), img->get_height());
69 Vector<uint8_t> data = img->get_data();
70 const uint8_t *r = data.ptr();
71
72 // we need to use the more complex API in order to access specific flags...
73
74 WebPConfig config;
75 WebPPicture pic;
76 if (!WebPConfigInit(&config) || !WebPPictureInit(&pic)) {
77 ERR_FAIL_V(Vector<uint8_t>());
78 }
79
80 WebPMemoryWriter wrt;
81 if (p_lossless) {
82 config.lossless = 1;
83 config.exact = 1;
84 }
85 config.method = compression_method;
86 config.quality = p_quality;
87 config.use_sharp_yuv = 1;
88 pic.use_argb = 1;
89 pic.width = s.width;
90 pic.height = s.height;
91 pic.writer = WebPMemoryWrite;
92 pic.custom_ptr = &wrt;
93 WebPMemoryWriterInit(&wrt);
94
95 bool success_import = false;
96 if (img->get_format() == Image::FORMAT_RGB8) {
97 success_import = WebPPictureImportRGB(&pic, r, 3 * s.width);
98 } else {
99 success_import = WebPPictureImportRGBA(&pic, r, 4 * s.width);
100 }
101 bool success_encode = false;
102 if (success_import) {
103 success_encode = WebPEncode(&config, &pic);
104 }
105 WebPPictureFree(&pic);
106
107 if (!success_encode) {
108 WebPMemoryWriterClear(&wrt);
109 ERR_FAIL_V_MSG(Vector<uint8_t>(), "WebP packing failed.");
110 }
111
112 // copy from wrt
113 Vector<uint8_t> dst;
114 dst.resize(wrt.size);
115 uint8_t *w = dst.ptrw();
116 memcpy(w, wrt.mem, wrt.size);
117 WebPMemoryWriterClear(&wrt);
118 return dst;
119}
120
121Ref<Image> _webp_unpack(const Vector<uint8_t> &p_buffer) {
122 int size = p_buffer.size();
123 ERR_FAIL_COND_V(size <= 0, Ref<Image>());
124 const uint8_t *r = p_buffer.ptr();
125
126 // A WebP file uses a RIFF header, which starts with "RIFF____WEBP".
127 ERR_FAIL_COND_V(r[0] != 'R' || r[1] != 'I' || r[2] != 'F' || r[3] != 'F' || r[8] != 'W' || r[9] != 'E' || r[10] != 'B' || r[11] != 'P', Ref<Image>());
128 WebPBitstreamFeatures features;
129 if (WebPGetFeatures(r, size, &features) != VP8_STATUS_OK) {
130 ERR_FAIL_V_MSG(Ref<Image>(), "Error unpacking WebP image.");
131 }
132
133 Vector<uint8_t> dst_image;
134 int datasize = features.width * features.height * (features.has_alpha ? 4 : 3);
135 dst_image.resize(datasize);
136
137 uint8_t *dst_w = dst_image.ptrw();
138
139 bool errdec = false;
140 if (features.has_alpha) {
141 errdec = WebPDecodeRGBAInto(r, size, dst_w, datasize, 4 * features.width) == nullptr;
142 } else {
143 errdec = WebPDecodeRGBInto(r, size, dst_w, datasize, 3 * features.width) == nullptr;
144 }
145
146 ERR_FAIL_COND_V_MSG(errdec, Ref<Image>(), "Failed decoding WebP image.");
147
148 Ref<Image> img = memnew(Image(features.width, features.height, 0, features.has_alpha ? Image::FORMAT_RGBA8 : Image::FORMAT_RGB8, dst_image));
149 return img;
150}
151
152Error webp_load_image_from_buffer(Image *p_image, const uint8_t *p_buffer, int p_buffer_len) {
153 ERR_FAIL_NULL_V(p_image, ERR_INVALID_PARAMETER);
154
155 WebPBitstreamFeatures features;
156 if (WebPGetFeatures(p_buffer, p_buffer_len, &features) != VP8_STATUS_OK) {
157 ERR_FAIL_V(ERR_FILE_CORRUPT);
158 }
159
160 Vector<uint8_t> dst_image;
161 int datasize = features.width * features.height * (features.has_alpha ? 4 : 3);
162 dst_image.resize(datasize);
163 uint8_t *dst_w = dst_image.ptrw();
164
165 bool errdec = false;
166 if (features.has_alpha) {
167 errdec = WebPDecodeRGBAInto(p_buffer, p_buffer_len, dst_w, datasize, 4 * features.width) == nullptr;
168 } else {
169 errdec = WebPDecodeRGBInto(p_buffer, p_buffer_len, dst_w, datasize, 3 * features.width) == nullptr;
170 }
171
172 ERR_FAIL_COND_V_MSG(errdec, ERR_FILE_CORRUPT, "Failed decoding WebP image.");
173
174 p_image->set_data(features.width, features.height, false, features.has_alpha ? Image::FORMAT_RGBA8 : Image::FORMAT_RGB8, dst_image);
175
176 return OK;
177}
178} // namespace WebPCommon
179