From 8f05bd97b5c03510937270af23cc9f513b33be4b Mon Sep 17 00:00:00 2001 From: Aaron Franke Date: Sat, 4 Jun 2022 16:05:55 -0500 Subject: [PATCH] Add support for saving WebP images --- core/io/image.cpp | 23 ++++ core/io/image.h | 6 + doc/classes/Image.xml | 20 ++- modules/webp/image_loader_webp.cpp | 181 ++----------------------- modules/webp/image_loader_webp.h | 4 +- modules/webp/register_types.cpp | 10 +- modules/webp/resource_saver_webp.cpp | 90 +++++++++++++ modules/webp/resource_saver_webp.h | 49 +++++++ modules/webp/webp_common.cpp | 190 +++++++++++++++++++++++++++ modules/webp/webp_common.h | 45 +++++++ 10 files changed, 441 insertions(+), 177 deletions(-) create mode 100644 modules/webp/resource_saver_webp.cpp create mode 100644 modules/webp/resource_saver_webp.h create mode 100644 modules/webp/webp_common.cpp create mode 100644 modules/webp/webp_common.h diff --git a/core/io/image.cpp b/core/io/image.cpp index 6585fd9adf8..a945d3e6cd4 100644 --- a/core/io/image.cpp +++ b/core/io/image.cpp @@ -87,6 +87,9 @@ SaveEXRFunc Image::save_exr_func = nullptr; SavePNGBufferFunc Image::save_png_buffer_func = nullptr; SaveJPGBufferFunc Image::save_jpg_buffer_func = nullptr; +SaveWebPFunc Image::save_webp_func = nullptr; +SaveWebPBufferFunc Image::save_webp_buffer_func = nullptr; + void Image::_put_pixelb(int p_x, int p_y, uint32_t p_pixel_size, uint8_t *p_data, const uint8_t *p_pixel) { uint32_t ofs = (p_y * width + p_x) * p_pixel_size; memcpy(p_data + ofs, p_pixel, p_pixel_size); @@ -2320,6 +2323,24 @@ Error Image::save_exr(const String &p_path, bool p_grayscale) const { return save_exr_func(p_path, Ref((Image *)this), p_grayscale); } +Error Image::save_webp(const String &p_path, const bool p_lossy, const float p_quality) const { + if (save_webp_func == nullptr) { + return ERR_UNAVAILABLE; + } + ERR_FAIL_COND_V_MSG(p_lossy && !(0.0f <= p_quality && p_quality <= 1.0f), ERR_INVALID_PARAMETER, "The WebP lossy quality was set to " + rtos(p_quality) + ", which is not valid. WebP lossy quality must be between 0.0 and 1.0 (inclusive)."); + + return save_webp_func(p_path, Ref((Image *)this), p_lossy, p_quality); +} + +Vector Image::save_webp_to_buffer(const bool p_lossy, const float p_quality) const { + if (save_webp_buffer_func == nullptr) { + return Vector(); + } + ERR_FAIL_COND_V_MSG(p_lossy && !(0.0f <= p_quality && p_quality <= 1.0f), Vector(), "The WebP lossy quality was set to " + rtos(p_quality) + ", which is not valid. WebP lossy quality must be between 0.0 and 1.0 (inclusive)."); + + return save_webp_buffer_func(Ref((Image *)this), p_lossy, p_quality); +} + int Image::get_image_data_size(int p_width, int p_height, Format p_format, bool p_mipmaps) { int mm; return _get_dst_image_size(p_width, p_height, p_format, mm, p_mipmaps ? -1 : 0); @@ -3159,6 +3180,8 @@ void Image::_bind_methods() { ClassDB::bind_method(D_METHOD("save_jpg", "path", "quality"), &Image::save_jpg, DEFVAL(0.75)); ClassDB::bind_method(D_METHOD("save_jpg_to_buffer", "quality"), &Image::save_jpg_to_buffer, DEFVAL(0.75)); ClassDB::bind_method(D_METHOD("save_exr", "path", "grayscale"), &Image::save_exr, DEFVAL(false)); + ClassDB::bind_method(D_METHOD("save_webp", "path", "lossy", "quality"), &Image::save_webp, DEFVAL(false), DEFVAL(0.75f)); + ClassDB::bind_method(D_METHOD("save_webp_to_buffer", "lossy", "quality"), &Image::save_webp_to_buffer, DEFVAL(false), DEFVAL(0.75f)); ClassDB::bind_method(D_METHOD("detect_alpha"), &Image::detect_alpha); ClassDB::bind_method(D_METHOD("is_invisible"), &Image::is_invisible); diff --git a/core/io/image.h b/core/io/image.h index 88b80dc9842..229103f7928 100644 --- a/core/io/image.h +++ b/core/io/image.h @@ -48,6 +48,8 @@ typedef Vector (*SavePNGBufferFunc)(const Ref &p_img); typedef Error (*SaveJPGFunc)(const String &p_path, const Ref &p_img, float p_quality); typedef Vector (*SaveJPGBufferFunc)(const Ref &p_img, float p_quality); typedef Ref (*ImageMemLoadFunc)(const uint8_t *p_png, int p_size); +typedef Error (*SaveWebPFunc)(const String &p_path, const Ref &p_img, const bool p_lossy, const float p_quality); +typedef Vector (*SaveWebPBufferFunc)(const Ref &p_img, const bool p_lossy, const float p_quality); typedef Error (*SaveEXRFunc)(const String &p_path, const Ref &p_img, bool p_grayscale); @@ -60,6 +62,8 @@ public: static SaveEXRFunc save_exr_func; static SavePNGBufferFunc save_png_buffer_func; static SaveJPGBufferFunc save_jpg_buffer_func; + static SaveWebPFunc save_webp_func; + static SaveWebPBufferFunc save_webp_buffer_func; enum { MAX_WIDTH = (1 << 24), // force a limit somehow @@ -289,6 +293,8 @@ public: Vector save_png_to_buffer() const; Vector save_jpg_to_buffer(float p_quality = 0.75) const; Error save_exr(const String &p_path, bool p_grayscale) const; + Error save_webp(const String &p_path, const bool p_lossy = false, const float p_quality = 0.75f) const; + Vector save_webp_to_buffer(const bool p_lossy = false, const float p_quality = 0.75f) const; void create_empty(int p_width, int p_height, bool p_use_mipmaps, Format p_format) { create(p_width, p_height, p_use_mipmaps, p_format); diff --git a/doc/classes/Image.xml b/doc/classes/Image.xml index 20e26714bc2..5472ffe4dad 100644 --- a/doc/classes/Image.xml +++ b/doc/classes/Image.xml @@ -397,12 +397,30 @@ - Saves the image as a PNG file to [code]path[/code]. + Saves the image as a PNG file to the file at [code]path[/code]. + Saves the image as a PNG file to a byte array. + + + + + + + + + Saves the image as a WebP (Web Picture) file to the file at [code]path[/code]. By default it will save lossless. If [code]lossy[/code] is true, the image will be saved lossy, using the [code]quality[/code] setting between 0.0 and 1.0 (inclusive). + + + + + + + + Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If [code]lossy[/code] is true, the image will be saved lossy, using the [code]quality[/code] setting between 0.0 and 1.0 (inclusive). diff --git a/modules/webp/image_loader_webp.cpp b/modules/webp/image_loader_webp.cpp index 0e41f6c973c..778d5622783 100644 --- a/modules/webp/image_loader_webp.cpp +++ b/modules/webp/image_loader_webp.cpp @@ -34,184 +34,21 @@ #include "core/io/marshalls.h" #include "core/os/os.h" #include "core/string/print_string.h" +#include "webp_common.h" #include #include #include -static Vector _webp_lossy_pack(const Ref &p_image, float p_quality) { - ERR_FAIL_COND_V(p_image.is_null() || p_image->is_empty(), Vector()); - - Ref img = p_image->duplicate(); - if (img->detect_alpha()) { - img->convert(Image::FORMAT_RGBA8); - } else { - img->convert(Image::FORMAT_RGB8); - } - - Size2 s(img->get_width(), img->get_height()); - Vector data = img->get_data(); - const uint8_t *r = data.ptr(); - - uint8_t *dst_buff = nullptr; - size_t dst_size = 0; - if (img->get_format() == Image::FORMAT_RGB8) { - dst_size = WebPEncodeRGB(r, s.width, s.height, 3 * s.width, CLAMP(p_quality * 100.0, 0, 100.0), &dst_buff); - } else { - dst_size = WebPEncodeRGBA(r, s.width, s.height, 4 * s.width, CLAMP(p_quality * 100.0, 0, 100.0), &dst_buff); - } - - ERR_FAIL_COND_V(dst_size == 0, Vector()); - Vector dst; - dst.resize(4 + dst_size); - uint8_t *w = dst.ptrw(); - w[0] = 'W'; - w[1] = 'E'; - w[2] = 'B'; - w[3] = 'P'; - memcpy(&w[4], dst_buff, dst_size); - WebPFree(dst_buff); - - return dst; -} - -static Vector _webp_lossless_pack(const Ref &p_image) { - ERR_FAIL_COND_V(p_image.is_null() || p_image->is_empty(), Vector()); - - int compression_level = ProjectSettings::get_singleton()->get("rendering/textures/lossless_compression/webp_compression_level"); - compression_level = CLAMP(compression_level, 0, 9); - - Ref img = p_image->duplicate(); - if (img->detect_alpha()) { - img->convert(Image::FORMAT_RGBA8); - } else { - img->convert(Image::FORMAT_RGB8); - } - - Size2 s(img->get_width(), img->get_height()); - Vector data = img->get_data(); - const uint8_t *r = data.ptr(); - - // we need to use the more complex API in order to access the 'exact' flag... - - WebPConfig config; - WebPPicture pic; - if (!WebPConfigInit(&config) || !WebPConfigLosslessPreset(&config, compression_level) || !WebPPictureInit(&pic)) { - ERR_FAIL_V(Vector()); - } - - WebPMemoryWriter wrt; - config.exact = 1; - pic.use_argb = 1; - pic.width = s.width; - pic.height = s.height; - pic.writer = WebPMemoryWrite; - pic.custom_ptr = &wrt; - WebPMemoryWriterInit(&wrt); - - bool success_import = false; - if (img->get_format() == Image::FORMAT_RGB8) { - success_import = WebPPictureImportRGB(&pic, r, 3 * s.width); - } else { - success_import = WebPPictureImportRGBA(&pic, r, 4 * s.width); - } - bool success_encode = false; - if (success_import) { - success_encode = WebPEncode(&config, &pic); - } - WebPPictureFree(&pic); - - if (!success_encode) { - WebPMemoryWriterClear(&wrt); - ERR_FAIL_V_MSG(Vector(), "WebP packing failed."); - } - - // copy from wrt - Vector dst; - dst.resize(4 + wrt.size); - uint8_t *w = dst.ptrw(); - w[0] = 'W'; - w[1] = 'E'; - w[2] = 'B'; - w[3] = 'P'; - memcpy(&w[4], wrt.mem, wrt.size); - WebPMemoryWriterClear(&wrt); - - return dst; -} - -static Ref _webp_unpack(const Vector &p_buffer) { - int size = p_buffer.size() - 4; - ERR_FAIL_COND_V(size <= 0, Ref()); - const uint8_t *r = p_buffer.ptr(); - - ERR_FAIL_COND_V(r[0] != 'W' || r[1] != 'E' || r[2] != 'B' || r[3] != 'P', Ref()); - WebPBitstreamFeatures features; - if (WebPGetFeatures(&r[4], size, &features) != VP8_STATUS_OK) { - ERR_FAIL_V_MSG(Ref(), "Error unpacking WEBP image."); - } - - /* - print_line("width: "+itos(features.width)); - print_line("height: "+itos(features.height)); - print_line("alpha: "+itos(features.has_alpha)); - */ - - Vector dst_image; - int datasize = features.width * features.height * (features.has_alpha ? 4 : 3); - dst_image.resize(datasize); - - uint8_t *dst_w = dst_image.ptrw(); - - bool errdec = false; - if (features.has_alpha) { - errdec = WebPDecodeRGBAInto(&r[4], size, dst_w, datasize, 4 * features.width) == nullptr; - } else { - errdec = WebPDecodeRGBInto(&r[4], size, dst_w, datasize, 3 * features.width) == nullptr; - } - - ERR_FAIL_COND_V_MSG(errdec, Ref(), "Failed decoding WebP image."); - - Ref img = memnew(Image(features.width, features.height, 0, features.has_alpha ? Image::FORMAT_RGBA8 : Image::FORMAT_RGB8, dst_image)); - return img; -} - -Error webp_load_image_from_buffer(Image *p_image, const uint8_t *p_buffer, int p_buffer_len) { - ERR_FAIL_NULL_V(p_image, ERR_INVALID_PARAMETER); - - WebPBitstreamFeatures features; - if (WebPGetFeatures(p_buffer, p_buffer_len, &features) != VP8_STATUS_OK) { - ERR_FAIL_V(ERR_FILE_CORRUPT); - } - - Vector dst_image; - int datasize = features.width * features.height * (features.has_alpha ? 4 : 3); - dst_image.resize(datasize); - uint8_t *dst_w = dst_image.ptrw(); - - bool errdec = false; - if (features.has_alpha) { - errdec = WebPDecodeRGBAInto(p_buffer, p_buffer_len, dst_w, datasize, 4 * features.width) == nullptr; - } else { - errdec = WebPDecodeRGBInto(p_buffer, p_buffer_len, dst_w, datasize, 3 * features.width) == nullptr; - } - - ERR_FAIL_COND_V_MSG(errdec, ERR_FILE_CORRUPT, "Failed decoding WebP image."); - - p_image->create(features.width, features.height, false, features.has_alpha ? Image::FORMAT_RGBA8 : Image::FORMAT_RGB8, dst_image); - - return OK; -} - static Ref _webp_mem_loader_func(const uint8_t *p_png, int p_size) { Ref img; img.instantiate(); - Error err = webp_load_image_from_buffer(img.ptr(), p_png, p_size); + Error err = WebPCommon::webp_load_image_from_buffer(img.ptr(), p_png, p_size); ERR_FAIL_COND_V(err, Ref()); return img; } -Error ImageLoaderWEBP::load_image(Ref p_image, Ref f, bool p_force_linear, float p_scale) { +Error ImageLoaderWebP::load_image(Ref p_image, Ref f, bool p_force_linear, float p_scale) { Vector src_image; uint64_t src_image_len = f->get_length(); ERR_FAIL_COND_V(src_image_len == 0, ERR_FILE_CORRUPT); @@ -221,18 +58,18 @@ Error ImageLoaderWEBP::load_image(Ref p_image, Ref f, bool p_ f->get_buffer(&w[0], src_image_len); - Error err = webp_load_image_from_buffer(p_image.ptr(), w, src_image_len); + Error err = WebPCommon::webp_load_image_from_buffer(p_image.ptr(), w, src_image_len); return err; } -void ImageLoaderWEBP::get_recognized_extensions(List *p_extensions) const { +void ImageLoaderWebP::get_recognized_extensions(List *p_extensions) const { p_extensions->push_back("webp"); } -ImageLoaderWEBP::ImageLoaderWEBP() { +ImageLoaderWebP::ImageLoaderWebP() { Image::_webp_mem_loader_func = _webp_mem_loader_func; - Image::webp_lossy_packer = _webp_lossy_pack; - Image::webp_lossless_packer = _webp_lossless_pack; - Image::webp_unpacker = _webp_unpack; + Image::webp_lossy_packer = WebPCommon::_webp_lossy_pack; + Image::webp_lossless_packer = WebPCommon::_webp_lossless_pack; + Image::webp_unpacker = WebPCommon::_webp_unpack; } diff --git a/modules/webp/image_loader_webp.h b/modules/webp/image_loader_webp.h index 1acd1459a00..448f683eb32 100644 --- a/modules/webp/image_loader_webp.h +++ b/modules/webp/image_loader_webp.h @@ -33,11 +33,11 @@ #include "core/io/image_loader.h" -class ImageLoaderWEBP : public ImageFormatLoader { +class ImageLoaderWebP : public ImageFormatLoader { public: virtual Error load_image(Ref p_image, Ref f, bool p_force_linear, float p_scale); virtual void get_recognized_extensions(List *p_extensions) const; - ImageLoaderWEBP(); + ImageLoaderWebP(); }; #endif diff --git a/modules/webp/register_types.cpp b/modules/webp/register_types.cpp index 148e3254980..29f633743e8 100644 --- a/modules/webp/register_types.cpp +++ b/modules/webp/register_types.cpp @@ -31,16 +31,20 @@ #include "register_types.h" #include "image_loader_webp.h" +#include "resource_saver_webp.h" -static ImageLoaderWEBP *image_loader_webp = nullptr; +static ImageLoaderWebP *image_loader_webp = nullptr; +static Ref resource_saver_webp; void initialize_webp_module(ModuleInitializationLevel p_level) { if (p_level != MODULE_INITIALIZATION_LEVEL_SCENE) { return; } - image_loader_webp = memnew(ImageLoaderWEBP); + image_loader_webp = memnew(ImageLoaderWebP); + resource_saver_webp.instantiate(); ImageLoader::add_image_format_loader(image_loader_webp); + ResourceSaver::add_resource_format_saver(resource_saver_webp); } void uninitialize_webp_module(ModuleInitializationLevel p_level) { @@ -49,4 +53,6 @@ void uninitialize_webp_module(ModuleInitializationLevel p_level) { } memdelete(image_loader_webp); + ResourceSaver::remove_resource_format_saver(resource_saver_webp); + resource_saver_webp.unref(); } diff --git a/modules/webp/resource_saver_webp.cpp b/modules/webp/resource_saver_webp.cpp new file mode 100644 index 00000000000..d270d391639 --- /dev/null +++ b/modules/webp/resource_saver_webp.cpp @@ -0,0 +1,90 @@ +/*************************************************************************/ +/* resource_saver_webp.cpp */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ +/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/*************************************************************************/ + +#include "resource_saver_webp.h" + +#include "core/io/file_access.h" +#include "core/io/image.h" +#include "scene/resources/texture.h" +#include "webp_common.h" + +Error ResourceSaverWebP::save(const String &p_path, const Ref &p_resource, uint32_t p_flags) { + Ref texture = p_resource; + + ERR_FAIL_COND_V_MSG(!texture.is_valid(), ERR_INVALID_PARAMETER, "Can't save invalid texture as WEBP."); + ERR_FAIL_COND_V_MSG(!texture->get_width(), ERR_INVALID_PARAMETER, "Can't save empty texture as WEBP."); + + Ref img = texture->get_image(); + + Error err = save_image(p_path, img); + + return err; +} + +Error ResourceSaverWebP::save_image(const String &p_path, const Ref &p_img, const bool p_lossy, const float p_quality) { + Vector buffer = save_image_to_buffer(p_img, p_lossy, p_quality); + Error err; + Ref file = FileAccess::open(p_path, FileAccess::WRITE, &err); + ERR_FAIL_COND_V_MSG(err, err, vformat("Can't save WEBP at path: '%s'.", p_path)); + + const uint8_t *reader = buffer.ptr(); + + file->store_buffer(reader, buffer.size()); + if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) { + return ERR_CANT_CREATE; + } + + return OK; +} + +Vector ResourceSaverWebP::save_image_to_buffer(const Ref &p_img, const bool p_lossy, const float p_quality) { + Vector buffer; + if (p_lossy) { + buffer = WebPCommon::_webp_lossy_pack(p_img, p_quality); + } else { + buffer = WebPCommon::_webp_lossless_pack(p_img); + } + return buffer; +} + +bool ResourceSaverWebP::recognize(const Ref &p_resource) const { + return (p_resource.is_valid() && p_resource->is_class("ImageTexture")); +} + +void ResourceSaverWebP::get_recognized_extensions(const Ref &p_resource, List *p_extensions) const { + if (Object::cast_to(*p_resource)) { + p_extensions->push_back("webp"); + } +} + +ResourceSaverWebP::ResourceSaverWebP() { + Image::save_webp_func = &save_image; + Image::save_webp_buffer_func = &save_image_to_buffer; +} diff --git a/modules/webp/resource_saver_webp.h b/modules/webp/resource_saver_webp.h new file mode 100644 index 00000000000..59e944efa01 --- /dev/null +++ b/modules/webp/resource_saver_webp.h @@ -0,0 +1,49 @@ +/*************************************************************************/ +/* resource_saver_webp.h */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ +/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/*************************************************************************/ + +#ifndef RESOURCE_SAVER_WEBP_H +#define RESOURCE_SAVER_WEBP_H + +#include "core/io/image.h" +#include "core/io/resource_saver.h" + +class ResourceSaverWebP : public ResourceFormatSaver { +public: + static Error save_image(const String &p_path, const Ref &p_img, const bool p_lossy = false, const float p_quality = 0.75f); + static Vector save_image_to_buffer(const Ref &p_img, const bool p_lossy = false, const float p_quality = 0.75f); + + virtual Error save(const String &p_path, const Ref &p_resource, uint32_t p_flags = 0); + virtual bool recognize(const Ref &p_resource) const; + virtual void get_recognized_extensions(const Ref &p_resource, List *p_extensions) const; + + ResourceSaverWebP(); +}; + +#endif // RESOURCE_SAVER_WEBP_H diff --git a/modules/webp/webp_common.cpp b/modules/webp/webp_common.cpp new file mode 100644 index 00000000000..8657a988534 --- /dev/null +++ b/modules/webp/webp_common.cpp @@ -0,0 +1,190 @@ +/*************************************************************************/ +/* webp_common.cpp */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ +/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/*************************************************************************/ + +#include "webp_common.h" + +#include "core/config/project_settings.h" +#include "core/os/os.h" + +#include +#include +#include + +namespace WebPCommon { +Vector _webp_lossy_pack(const Ref &p_image, float p_quality) { + ERR_FAIL_COND_V(p_image.is_null() || p_image->is_empty(), Vector()); + + Ref img = p_image->duplicate(); + if (img->detect_alpha()) { + img->convert(Image::FORMAT_RGBA8); + } else { + img->convert(Image::FORMAT_RGB8); + } + + Size2 s(img->get_width(), img->get_height()); + Vector data = img->get_data(); + const uint8_t *r = data.ptr(); + + uint8_t *dst_buff = nullptr; + size_t dst_size = 0; + if (img->get_format() == Image::FORMAT_RGB8) { + dst_size = WebPEncodeRGB(r, s.width, s.height, 3 * s.width, CLAMP(p_quality * 100.0f, 0.0f, 100.0f), &dst_buff); + } else { + dst_size = WebPEncodeRGBA(r, s.width, s.height, 4 * s.width, CLAMP(p_quality * 100.0f, 0.0f, 100.0f), &dst_buff); + } + + ERR_FAIL_COND_V(dst_size == 0, Vector()); + Vector dst; + dst.resize(dst_size); + uint8_t *w = dst.ptrw(); + memcpy(w, dst_buff, dst_size); + WebPFree(dst_buff); + + return dst; +} + +Vector _webp_lossless_pack(const Ref &p_image) { + ERR_FAIL_COND_V(p_image.is_null() || p_image->is_empty(), Vector()); + + int compression_level = ProjectSettings::get_singleton()->get("rendering/textures/lossless_compression/webp_compression_level"); + compression_level = CLAMP(compression_level, 0, 9); + + Ref img = p_image->duplicate(); + if (img->detect_alpha()) { + img->convert(Image::FORMAT_RGBA8); + } else { + img->convert(Image::FORMAT_RGB8); + } + + Size2 s(img->get_width(), img->get_height()); + Vector data = img->get_data(); + const uint8_t *r = data.ptr(); + + // we need to use the more complex API in order to access the 'exact' flag... + + WebPConfig config; + WebPPicture pic; + if (!WebPConfigInit(&config) || !WebPConfigLosslessPreset(&config, compression_level) || !WebPPictureInit(&pic)) { + ERR_FAIL_V(Vector()); + } + + WebPMemoryWriter wrt; + config.exact = 1; + pic.use_argb = 1; + pic.width = s.width; + pic.height = s.height; + pic.writer = WebPMemoryWrite; + pic.custom_ptr = &wrt; + WebPMemoryWriterInit(&wrt); + + bool success_import = false; + if (img->get_format() == Image::FORMAT_RGB8) { + success_import = WebPPictureImportRGB(&pic, r, 3 * s.width); + } else { + success_import = WebPPictureImportRGBA(&pic, r, 4 * s.width); + } + bool success_encode = false; + if (success_import) { + success_encode = WebPEncode(&config, &pic); + } + WebPPictureFree(&pic); + + if (!success_encode) { + WebPMemoryWriterClear(&wrt); + ERR_FAIL_V_MSG(Vector(), "WebP packing failed."); + } + + // copy from wrt + Vector dst; + dst.resize(wrt.size); + uint8_t *w = dst.ptrw(); + memcpy(w, wrt.mem, wrt.size); + WebPMemoryWriterClear(&wrt); + return dst; +} + +Ref _webp_unpack(const Vector &p_buffer) { + int size = p_buffer.size(); + ERR_FAIL_COND_V(size <= 0, Ref()); + const uint8_t *r = p_buffer.ptr(); + + // A WebP file uses a RIFF header, which starts with "RIFF____WEBP". + 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()); + WebPBitstreamFeatures features; + if (WebPGetFeatures(r, size, &features) != VP8_STATUS_OK) { + ERR_FAIL_V_MSG(Ref(), "Error unpacking WEBP image."); + } + + Vector dst_image; + int datasize = features.width * features.height * (features.has_alpha ? 4 : 3); + dst_image.resize(datasize); + + uint8_t *dst_w = dst_image.ptrw(); + + bool errdec = false; + if (features.has_alpha) { + errdec = WebPDecodeRGBAInto(r, size, dst_w, datasize, 4 * features.width) == nullptr; + } else { + errdec = WebPDecodeRGBInto(r, size, dst_w, datasize, 3 * features.width) == nullptr; + } + + ERR_FAIL_COND_V_MSG(errdec, Ref(), "Failed decoding WebP image."); + + Ref img = memnew(Image(features.width, features.height, 0, features.has_alpha ? Image::FORMAT_RGBA8 : Image::FORMAT_RGB8, dst_image)); + return img; +} + +Error webp_load_image_from_buffer(Image *p_image, const uint8_t *p_buffer, int p_buffer_len) { + ERR_FAIL_NULL_V(p_image, ERR_INVALID_PARAMETER); + + WebPBitstreamFeatures features; + if (WebPGetFeatures(p_buffer, p_buffer_len, &features) != VP8_STATUS_OK) { + ERR_FAIL_V(ERR_FILE_CORRUPT); + } + + Vector dst_image; + int datasize = features.width * features.height * (features.has_alpha ? 4 : 3); + dst_image.resize(datasize); + uint8_t *dst_w = dst_image.ptrw(); + + bool errdec = false; + if (features.has_alpha) { + errdec = WebPDecodeRGBAInto(p_buffer, p_buffer_len, dst_w, datasize, 4 * features.width) == nullptr; + } else { + errdec = WebPDecodeRGBInto(p_buffer, p_buffer_len, dst_w, datasize, 3 * features.width) == nullptr; + } + + ERR_FAIL_COND_V_MSG(errdec, ERR_FILE_CORRUPT, "Failed decoding WebP image."); + + p_image->create(features.width, features.height, false, features.has_alpha ? Image::FORMAT_RGBA8 : Image::FORMAT_RGB8, dst_image); + + return OK; +} +} // namespace WebPCommon diff --git a/modules/webp/webp_common.h b/modules/webp/webp_common.h new file mode 100644 index 00000000000..11bef402567 --- /dev/null +++ b/modules/webp/webp_common.h @@ -0,0 +1,45 @@ +/*************************************************************************/ +/* webp_common.h */ +/*************************************************************************/ +/* This file is part of: */ +/* GODOT ENGINE */ +/* https://godotengine.org */ +/*************************************************************************/ +/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ +/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ +/* */ +/* Permission is hereby granted, free of charge, to any person obtaining */ +/* a copy of this software and associated documentation files (the */ +/* "Software"), to deal in the Software without restriction, including */ +/* without limitation the rights to use, copy, modify, merge, publish, */ +/* distribute, sublicense, and/or sell copies of the Software, and to */ +/* permit persons to whom the Software is furnished to do so, subject to */ +/* the following conditions: */ +/* */ +/* The above copyright notice and this permission notice shall be */ +/* included in all copies or substantial portions of the Software. */ +/* */ +/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ +/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ +/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ +/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ +/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ +/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ +/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ +/*************************************************************************/ + +#ifndef WEBP_COMMON_H +#define WEBP_COMMON_H + +#include "core/io/image.h" + +namespace WebPCommon { +// Given an image, pack this data into a WebP file. +Vector _webp_lossy_pack(const Ref &p_image, float p_quality); +Vector _webp_lossless_pack(const Ref &p_image); +// Given a WebP file, unpack it into an image. +Ref _webp_unpack(const Vector &p_buffer); +Error webp_load_image_from_buffer(Image *p_image, const uint8_t *p_buffer, int p_buffer_len); +} //namespace WebPCommon + +#endif // WEBP_COMMON_H