Merge pull request #15549 from SaracenOne/bmp

BMP module

6 files changed, 370 insertions, 0 deletions

diff --git a/modules/bmp/SCsub b/modules/bmp/SCsub
new file mode 100644
index 0000000000..e7da7cf108
--- /dev/null
+++ b/modules/bmp/SCsub
@@ -0,0 +1,9 @@
+#!/usr/bin/env python
+
+Import('env')
+Import('env_modules')
+
+env_bmp = env_modules.Clone()
+
+# Godot's own source files
+env_bmp.add_source_files(env.modules_sources, "*.cpp")
diff --git a/modules/bmp/config.py b/modules/bmp/config.py
new file mode 100644
index 0000000000..fb920482f5
--- /dev/null
+++ b/modules/bmp/config.py
@@ -0,0 +1,7 @@
+
+def can_build(platform):
+    return True
+
+
+def configure(env):
+    pass
diff --git a/modules/bmp/image_loader_bmp.cpp b/modules/bmp/image_loader_bmp.cpp
new file mode 100644
index 0000000000..769119a0dc
--- /dev/null
+++ b/modules/bmp/image_loader_bmp.cpp
@@ -0,0 +1,194 @@
+/*************************************************************************/
+/*  image_loader_bmp.cpp                                                 */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2018 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 "image_loader_bmp.h"
+
+Error ImageLoaderBMP::convert_to_image(Ref<Image> p_image,
+		const uint8_t *p_buffer,
+		const uint8_t *p_color_buffer,
+		const bmp_header_s &p_header) {
+
+	Error err = OK;
+
+	if (p_buffer == NULL)
+		err = FAILED;
+
+	if (err == OK) {
+		size_t index = 0;
+		size_t width =
+				static_cast<size_t>(p_header.bmp_info_header.bmp_width < 0 ? -p_header.bmp_info_header.bmp_width : p_header.bmp_info_header.bmp_width);
+		size_t height =
+				static_cast<size_t>(p_header.bmp_info_header.bmp_height < 0 ? -p_header.bmp_info_header.bmp_height : p_header.bmp_info_header.bmp_height);
+		size_t bits_per_pixel =
+				static_cast<size_t>(p_header.bmp_info_header.bmp_bit_count);
+
+		if (p_header.bmp_info_header.bmp_compression != 0) {
+			err = FAILED;
+		}
+
+		if (bits_per_pixel != 24 || bits_per_pixel != 32) {
+			err = FAILED;
+		}
+
+		if (err == OK) {
+
+			uint32_t line_width = ((p_header.bmp_info_header.bmp_width *
+										   p_header.bmp_info_header.bmp_bit_count / 8) +
+										  3) &
+								  ~3;
+
+			PoolVector<uint8_t> image_data;
+			err = image_data.resize(width * height * 4);
+
+			PoolVector<uint8_t>::Write image_data_w = image_data.write();
+			uint8_t *write_buffer = image_data_w.ptr();
+
+			const uint8_t *line = p_buffer + (line_width * (height - 1));
+			for (unsigned int i = 0; i < height; i++) {
+				const uint8_t *line_ptr = line;
+				for (unsigned int j = 0; j < width; j++) {
+					switch (bits_per_pixel) {
+						case 24: {
+							uint32_t color = *((uint32_t *)line_ptr);
+
+							write_buffer[index + 2] = color & 0xff;
+							write_buffer[index + 1] = (color >> 8) & 0xff;
+							write_buffer[index + 0] = (color >> 16) & 0xff;
+							write_buffer[index + 3] = 0xff;
+							index += 4;
+							line_ptr += 3;
+						} break;
+						case 32: {
+							uint32_t color = *((uint32_t *)line_ptr);
+
+							write_buffer[index + 2] = color & 0xff;
+							write_buffer[index + 1] = (color >> 8) & 0xff;
+							write_buffer[index + 0] = (color >> 16) & 0xff;
+							write_buffer[index + 3] = color >> 24;
+							index += 4;
+							line_ptr += 4;
+						} break;
+					}
+				}
+				line -= line_width;
+			}
+			p_image->create(width, height, 0, Image::FORMAT_RGBA8, image_data);
+		}
+	}
+	return err;
+}
+
+Error ImageLoaderBMP::load_image(Ref<Image> p_image, FileAccess *f,
+		bool p_force_linear, float p_scale) {
+
+	bmp_header_s bmp_header;
+	Error err = ERR_INVALID_DATA;
+
+	if (f->get_len() > sizeof(bmp_header)) {
+		// File Header
+		bmp_header.bmp_file_header.bmp_signature = f->get_16();
+		if (bmp_header.bmp_file_header.bmp_signature == BITMAP_SIGNATURE) {
+			bmp_header.bmp_file_header.bmp_file_size = f->get_32();
+			bmp_header.bmp_file_header.bmp_file_padding = f->get_32();
+			bmp_header.bmp_file_header.bmp_file_offset = f->get_32();
+
+			// Info Header
+			bmp_header.bmp_info_header.bmp_header_size = f->get_32();
+			bmp_header.bmp_info_header.bmp_width = f->get_32();
+			bmp_header.bmp_info_header.bmp_height = f->get_32();
+			bmp_header.bmp_info_header.bmp_planes = f->get_16();
+			bmp_header.bmp_info_header.bmp_bit_count = f->get_16();
+			bmp_header.bmp_info_header.bmp_compression = f->get_32();
+			bmp_header.bmp_info_header.bmp_size_image = f->get_32();
+			bmp_header.bmp_info_header.bmp_pixels_per_meter_x = f->get_32();
+			bmp_header.bmp_info_header.bmp_pixels_per_meter_y = f->get_32();
+			bmp_header.bmp_info_header.bmp_colors_used = f->get_32();
+			bmp_header.bmp_info_header.bmp_important_colors = f->get_32();
+
+			bmp_header.bmp_info_header.bmp_red_mask = f->get_32();
+			bmp_header.bmp_info_header.bmp_green_mask = f->get_32();
+			bmp_header.bmp_info_header.bmp_blue_mask = f->get_32();
+			bmp_header.bmp_info_header.bmp_alpha_mask = f->get_32();
+			bmp_header.bmp_info_header.bmp_cs_type = f->get_32();
+			for (int i = 0; i < 9; i++)
+				bmp_header.bmp_info_header.bmp_endpoints[i] = f->get_32();
+
+			bmp_header.bmp_info_header.bmp_gamma_red = f->get_32();
+			bmp_header.bmp_info_header.bmp_gamma_green = f->get_32();
+			bmp_header.bmp_info_header.bmp_gamma_blue = f->get_32();
+
+			f->seek(sizeof(bmp_header.bmp_file_header) +
+					bmp_header.bmp_info_header.bmp_header_size);
+
+			uint32_t color_table_size = 0;
+			if (bmp_header.bmp_info_header.bmp_bit_count == 1)
+				color_table_size = 2;
+			else if (bmp_header.bmp_info_header.bmp_bit_count == 4)
+				color_table_size = 16;
+			else if (bmp_header.bmp_info_header.bmp_bit_count == 8)
+				color_table_size = 256;
+
+			PoolVector<uint8_t> bmp_color_table;
+			if (color_table_size > 0) {
+				err = bmp_color_table.resize(color_table_size * 4);
+				PoolVector<uint8_t>::Write bmp_color_table_w = bmp_color_table.write();
+				f->get_buffer(bmp_color_table_w.ptr(),
+						bmp_header.bmp_info_header.bmp_colors_used * 4);
+			}
+
+			f->seek(bmp_header.bmp_file_header.bmp_file_offset);
+
+			uint32_t bmp_buffer_size = (bmp_header.bmp_file_header.bmp_file_size -
+										bmp_header.bmp_file_header.bmp_file_offset);
+
+			PoolVector<uint8_t> bmp_buffer;
+			err = bmp_buffer.resize(bmp_buffer_size);
+			if (err == OK) {
+				PoolVector<uint8_t>::Write bmp_buffer_w = bmp_buffer.write();
+				f->get_buffer(bmp_buffer_w.ptr(), bmp_buffer_size);
+
+				PoolVector<uint8_t>::Read bmp_buffer_r = bmp_buffer.read();
+				PoolVector<uint8_t>::Read bmp_color_table_r = bmp_color_table.read();
+				err = convert_to_image(p_image, bmp_buffer_r.ptr(),
+						bmp_color_table_r.ptr(), bmp_header);
+			}
+			f->close();
+		}
+	}
+	return err;
+}
+
+void ImageLoaderBMP::get_recognized_extensions(
+		List<String> *p_extensions) const {
+
+	p_extensions->push_back("bmp");
+}
+
+ImageLoaderBMP::ImageLoaderBMP() {}
diff --git a/modules/bmp/image_loader_bmp.h b/modules/bmp/image_loader_bmp.h
new file mode 100644
index 0000000000..3fa7481287
--- /dev/null
+++ b/modules/bmp/image_loader_bmp.h
@@ -0,0 +1,84 @@
+/*************************************************************************/
+/*  image_loader_bmp.h                                                   */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2018 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 IMAGE_LOADER_BMP_H
+#define IMAGE_LOADER_BMP_H
+
+#include "io/image_loader.h"
+
+class ImageLoaderBMP : public ImageFormatLoader {
+protected:
+	static const unsigned BITMAP_SIGNATURE = 0x4d42;
+
+	struct bmp_header_s {
+		struct bmp_file_header_s {
+			uint16_t bmp_signature;
+			uint32_t bmp_file_size;
+			uint32_t bmp_file_padding;
+			uint32_t bmp_file_offset;
+		} bmp_file_header;
+
+		struct bmp_info_header_s {
+			uint32_t bmp_header_size;
+			uint32_t bmp_width;
+			uint32_t bmp_height;
+			uint16_t bmp_planes;
+			uint16_t bmp_bit_count;
+			uint32_t bmp_compression;
+			uint32_t bmp_size_image;
+			uint32_t bmp_pixels_per_meter_x;
+			uint32_t bmp_pixels_per_meter_y;
+			uint32_t bmp_colors_used;
+			uint32_t bmp_important_colors;
+			uint32_t bmp_red_mask;
+			uint32_t bmp_green_mask;
+			uint32_t bmp_blue_mask;
+			uint32_t bmp_alpha_mask;
+			uint32_t bmp_cs_type;
+			uint32_t bmp_endpoints[9];
+			uint32_t bmp_gamma_red;
+			uint32_t bmp_gamma_green;
+			uint32_t bmp_gamma_blue;
+		} bmp_info_header;
+	};
+
+	static Error convert_to_image(Ref<Image> p_image,
+			const uint8_t *p_buffer,
+			const uint8_t *p_color_buffer,
+			const bmp_header_s &p_header);
+
+public:
+	virtual Error load_image(Ref<Image> p_image, FileAccess *f,
+			bool p_force_linear, float p_scale);
+	virtual void get_recognized_extensions(List<String> *p_extensions) const;
+	ImageLoaderBMP();
+};
+
+#endif // IMAGE_LOADER_BMP_H
diff --git a/modules/bmp/register_types.cpp b/modules/bmp/register_types.cpp
new file mode 100644
index 0000000000..1f68a03e85
--- /dev/null
+++ b/modules/bmp/register_types.cpp
@@ -0,0 +1,44 @@
+/*************************************************************************/
+/*  register_types.cpp                                                   */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2018 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 "register_types.h"
+
+#include "image_loader_bmp.h"
+
+static ImageLoaderBMP *image_loader_bmp = NULL;
+
+void register_bmp_types() {
+	image_loader_bmp = memnew(ImageLoaderBMP);
+	ImageLoader::add_image_format_loader(image_loader_bmp);
+}
+
+void unregister_bmp_types() {
+	memdelete(image_loader_bmp);
+}
diff --git a/modules/bmp/register_types.h b/modules/bmp/register_types.h
new file mode 100644
index 0000000000..d8755db397
--- /dev/null
+++ b/modules/bmp/register_types.h
@@ -0,0 +1,32 @@
+/*************************************************************************/
+/*  register_types.h                                                     */
+/*************************************************************************/
+/*                       This file is part of:                           */
+/*                           GODOT ENGINE                                */
+/*                      https://godotengine.org                          */
+/*************************************************************************/
+/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur.                 */
+/* Copyright (c) 2014-2018 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.                */
+/*************************************************************************/
+
+void register_bmp_types();
+void unregister_bmp_types();