godot/drivers/png/png_driver_common.cpp
Braden Bodily 71d71d55b5 Replace 'ERR_EXPLAIN' with 'ERR_FAIL_*_MSG' in 'core/' and 'editor/'
Condensed some if and ERR statements. Added dots to end of error messages

Couldn't figure out EXPLAINC. These files gave me trouble: core/error_macros.h, core/io/file_access_buffered_fa.h (where is it?),
core/os/memory.cpp,
drivers/png/png_driver_common.cpp,
drivers/xaudio2/audio_driver_xaudio2.cpp (where is it?)
2019-08-17 12:33:15 +02:00

205 lines
7.2 KiB
C++

/*************************************************************************/
/* png_driver_common.cpp */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
/* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2019 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 "png_driver_common.h"
#include "core/os/os.h"
#include <png.h>
#include <string.h>
namespace PNGDriverCommon {
// Print any warnings.
// On error, set explain and return true.
// Call should be wrapped in ERR_FAIL_COND
static bool check_error(const png_image &image) {
const png_uint_32 failed = PNG_IMAGE_FAILED(image);
if (failed & PNG_IMAGE_ERROR) {
ERR_EXPLAINC(image.message);
return true;
} else if (failed) {
#ifdef TOOLS_ENABLED
// suppress this warning, to avoid log spam when opening assetlib
const static char *const noisy = "iCCP: known incorrect sRGB profile";
const Engine *const eng = Engine::get_singleton();
if (eng && eng->is_editor_hint() && !strcmp(image.message, noisy)) {
return false;
}
#endif
WARN_PRINT(image.message);
}
return false;
}
Error png_to_image(const uint8_t *p_source, size_t p_size, Ref<Image> p_image) {
png_image png_img;
zeromem(&png_img, sizeof(png_img));
png_img.version = PNG_IMAGE_VERSION;
// fetch image properties
int success = png_image_begin_read_from_memory(&png_img, p_source, p_size);
ERR_FAIL_COND_V(check_error(png_img), ERR_FILE_CORRUPT);
ERR_FAIL_COND_V(!success, ERR_FILE_CORRUPT);
// flags to be masked out of input format to give target format
const png_uint_32 format_mask = ~(
// convert component order to RGBA
PNG_FORMAT_FLAG_BGR | PNG_FORMAT_FLAG_AFIRST
// convert 16 bit components to 8 bit
| PNG_FORMAT_FLAG_LINEAR
// convert indexed image to direct color
| PNG_FORMAT_FLAG_COLORMAP);
png_img.format &= format_mask;
Image::Format dest_format;
switch (png_img.format) {
case PNG_FORMAT_GRAY:
dest_format = Image::FORMAT_L8;
break;
case PNG_FORMAT_GA:
dest_format = Image::FORMAT_LA8;
break;
case PNG_FORMAT_RGB:
dest_format = Image::FORMAT_RGB8;
break;
case PNG_FORMAT_RGBA:
dest_format = Image::FORMAT_RGBA8;
break;
default:
png_image_free(&png_img); // only required when we return before finish_read
ERR_PRINT("Unsupported png format.");
return ERR_UNAVAILABLE;
}
const png_uint_32 stride = PNG_IMAGE_ROW_STRIDE(png_img);
PoolVector<uint8_t> buffer;
Error err = buffer.resize(PNG_IMAGE_BUFFER_SIZE(png_img, stride));
if (err) {
png_image_free(&png_img); // only required when we return before finish_read
return err;
}
PoolVector<uint8_t>::Write writer = buffer.write();
// read image data to buffer and release libpng resources
success = png_image_finish_read(&png_img, NULL, writer.ptr(), stride, NULL);
ERR_FAIL_COND_V(check_error(png_img), ERR_FILE_CORRUPT);
ERR_FAIL_COND_V(!success, ERR_FILE_CORRUPT);
p_image->create(png_img.width, png_img.height, 0, dest_format, buffer);
return OK;
}
Error image_to_png(const Ref<Image> &p_image, PoolVector<uint8_t> &p_buffer) {
Ref<Image> source_image = p_image->duplicate();
if (source_image->is_compressed())
source_image->decompress();
ERR_FAIL_COND_V(source_image->is_compressed(), FAILED);
png_image png_img;
zeromem(&png_img, sizeof(png_img));
png_img.version = PNG_IMAGE_VERSION;
png_img.width = source_image->get_width();
png_img.height = source_image->get_height();
switch (source_image->get_format()) {
case Image::FORMAT_L8:
png_img.format = PNG_FORMAT_GRAY;
break;
case Image::FORMAT_LA8:
png_img.format = PNG_FORMAT_GA;
break;
case Image::FORMAT_RGB8:
png_img.format = PNG_FORMAT_RGB;
break;
case Image::FORMAT_RGBA8:
png_img.format = PNG_FORMAT_RGBA;
break;
default:
if (source_image->detect_alpha()) {
source_image->convert(Image::FORMAT_RGBA8);
png_img.format = PNG_FORMAT_RGBA;
} else {
source_image->convert(Image::FORMAT_RGB8);
png_img.format = PNG_FORMAT_RGB;
}
}
const PoolVector<uint8_t> image_data = source_image->get_data();
const PoolVector<uint8_t>::Read reader = image_data.read();
// we may be passed a buffer with existing content we're expected to append to
const int buffer_offset = p_buffer.size();
const size_t png_size_estimate = PNG_IMAGE_PNG_SIZE_MAX(png_img);
// try with estimated size
size_t compressed_size = png_size_estimate;
int success = 0;
{ // scope writer lifetime
Error err = p_buffer.resize(buffer_offset + png_size_estimate);
ERR_FAIL_COND_V(err, err);
PoolVector<uint8_t>::Write writer = p_buffer.write();
success = png_image_write_to_memory(&png_img, &writer[buffer_offset],
&compressed_size, 0, reader.ptr(), 0, NULL);
ERR_FAIL_COND_V(check_error(png_img), FAILED);
}
if (!success) {
// buffer was big enough, must be some other error
ERR_FAIL_COND_V(compressed_size <= png_size_estimate, FAILED);
// write failed due to buffer size, resize and retry
Error err = p_buffer.resize(buffer_offset + compressed_size);
ERR_FAIL_COND_V(err, err);
PoolVector<uint8_t>::Write writer = p_buffer.write();
success = png_image_write_to_memory(&png_img, &writer[buffer_offset],
&compressed_size, 0, reader.ptr(), 0, NULL);
ERR_FAIL_COND_V(check_error(png_img), FAILED);
ERR_FAIL_COND_V(!success, FAILED);
}
// trim buffer size to content
Error err = p_buffer.resize(buffer_offset + compressed_size);
ERR_FAIL_COND_V(err, err);
return OK;
}
} // namespace PNGDriverCommon