テクスチャ結合で出力されるjpegが、Unrealで読み込めない問題 (Synesthesias#194)

* TexturePackerでファイルが存在することのテストを記述

* TexturePackerのテストで出力ファイルを画像として読めるかのテストを追加

* TexturePacker微修正

* 微修正

* リファクタ: 要らないメソッドを削除

* JpegTextureImageの初期化タイミングをコンストラクタに限定

* PngTextureImageの初期化タイミングをコンストラクタに限定

* TiffTextureImageの初期化タイミングをコンストラクタに限定

* TextureImageロードエラー処理

* TextureImageの初期化タイミングをコンストラクタに限定

* 微修正

* 未初期化で不要だったデフォルトカラーのインスタンス変数を削除

* TexturePackerのclearでクリアし忘れていたメンバ変数を修正

* 不要関数削除とエラー処理追加

* JpegTextureImageの警告に対処

* 微修正

* 警告に対処

* TexturePack後のテクスチャサイズのテスト

* TexturePackerの初期化タイミングをコンストラクタ時に限定

* AtlasInfoの初期化タイミングをコンストラクタに限定

* JpegTextureImage, PngTextureImage, TiffTextureImageの3つをポリモーフィズムで扱うようにした

* コード整理

* fix mac error

* 微修正

* Fix Valgrind Warning in JpegTextureImage

* 微修正

* libjpegのread apiをjpet-turbo api に置き換え

* unique_ptrのdeleteでfree漏れ防止

* same as above

* 微修正

* 微修正

* jpeg書き込みもtjに置き換え中

* 微修正

* texturePacker調整

* Pngの出力とTexturePackを実装し、TexturePackerの出力をjpgからpngに変更

* PngTextureImage修正

* コメント追記

Author: linoal

.idea/inspectionProfiles/Project_Default.xml

@@ -5,52 +5,85 @@
 #include <memory>
 #include <string>
 #include <vector>
+#include <stdexcept>
 
 #include "png_texture_image.h"
+#include <plateau/texture/texture_image_base.h>
 
 struct jpeg_error_mgr;
 
 namespace plateau::texture {
-    class JpegTextureImage {
+    /**
+     * jpeg画像を扱うクラスです。
+     *
+     * 重要：
+     * このクラスではjpegの読込はできますが、書き込みにはバグがあります。
+     * このクラスでMacで書き込んだjpegファイルは、MacのUnrealで7割くらいの確率で読込に失敗します。
+     * 書き込んだjpegに問題があるようです。
+     * 問題の画像(7割の確率で問題画像になる)はMacの標準ビューワーでは開くので一見すると大丈夫そうですが、Gimpで開くと警告ダイアログが出現し、Unrealではインポートできません。
+     * 私はこのバグの解決に20時間以上を費やしましたが解決せず、結局pngで実装し直すことで事なきを得ました。
+     * 画像の出力にはPngTextureImageを利用してください。
+     */
+    class JpegTextureImage : public TextureImageBase {
     public:
-        explicit JpegTextureImage() {
-        }
 
-        ~JpegTextureImage() = default;
+        /**
+         * jpegファイルをロードします。
+         */
+        explicit JpegTextureImage(const std::string& file_name, size_t height_limit) :
+            load_succeed_(init(file_name, height_limit))
+        {
+        };
 
         /**
-         * \brief 指定されたファイルから画像を読み込み、テクスチャ画像を作成します。
-         * \param file_name 画像ファイルのパス
-         * \param height_limit 画像の高さがこの値を超える場合画像データは読み込まれません。
-         * \return 読み込みに成功した場合true、それ以外はfalse
+         * 新規の画像をメモリ上に作ります。
          */
-        bool init(const std::string& file_name, const size_t height_limit);
-        void init(size_t width, size_t height, size_t color);
+        explicit JpegTextureImage(size_t width, size_t height, uint8_t color){
+            init(width, height, color);
+        };
 
-        size_t getWidth() const {
+        size_t getWidth() const override {
             return image_width_;
-        }
+        };
 
-        size_t getHeight() const {
+        size_t getHeight() const override {
             return image_height;
-        }
+        };
+
+        const std::string& getFilePath() const override{
+            return filePath;
+        };
 
-        std::vector<uint8_t>& getBitmapData() {
+        std::vector<uint8_t>& getBitmapData() override {
             return bitmap_data_;
-        }
+        };
+
+        virtual bool loadSucceed() const override {
+            return load_succeed_;
+        };
+
+        bool save(const std::string& file_path) override;
+
+        void packTo(TextureImageBase* dest, const size_t x_delta, const size_t y_delta) override;
 
-        bool save(const std::string& file_name);
-        void pack(size_t x_delta, size_t y_delta, const JpegTextureImage& image);
-        void packPng(const size_t x_delta, const size_t y_delta, PngTextureImage& image);
 
     private:
+        /**
+         * \brief 指定されたファイルから画像を読み込み、テクスチャ画像を作成します。
+         * \param file_name 画像ファイルのパス
+         * \param height_limit 画像の高さがこの値を超える場合画像データは読み込まれません。
+         * \return 読み込みに成功した場合true、それ以外はfalse
+         */
+        bool init(const std::string& file_name, size_t height_limit);
+        void init(size_t width, size_t height, uint8_t color);
+
         std::shared_ptr<::jpeg_error_mgr> jpegErrorManager;
         std::vector<uint8_t> bitmap_data_;
         std::string                       filePath;
-        size_t                            image_width_;
-        size_t                            image_height;
-        size_t                            image_channels_;
-        int                               colourSpace;
+        size_t                            image_width_ = 0;
+        size_t                            image_height = 0;
+        int                            image_channels_ = 0;
+        bool load_succeed_;
     };
 
 } // namespace plateau::texture

…スト/test_texture_packer/test_image_16.jpg …スト/test_texture_packer/test_image_15.jpgdata/日本語パステスト/test_texture_packer/test_image_16.jpg renamed to data/日本語パステスト/test_texture_packer/test_image_15.jpg data/日本語パステスト/test_texture_packer/test_image_16.jpg renamed to data/日本語パステスト/test_texture_packer/test_image_15.jpg

@@ -1,36 +1,54 @@
 
 #pragma once
 
-#include <plateau/texture/png_texture_image.h>
-
+#include <plateau/texture/texture_image_base.h>
 #include <cstdint>
 #include <string>
 #include <vector>
+#include <stdexcept>
 
 namespace plateau::texture {
-    class PngTextureImage {
+    /**
+     * png画像を扱うクラスです。
+     */
+    class PngTextureImage : public TextureImageBase {
     public:
-        explicit PngTextureImage();
-
-        ~PngTextureImage() {
-        }
+        explicit PngTextureImage(const std::string& file_path) :
+                file_path_(file_path),
+                load_succeed(init(file_path)) {
+        };
 
-        bool init(const std::string& file_name);
+        PngTextureImage(size_t width, size_t height, uint8_t initial_color);
 
-        size_t getWidth() const {
+        size_t getWidth() const override {
             return image_width_;
         }
 
-        size_t getHeight() const {
+        size_t getHeight() const override {
             return image_height_;
         }
 
-        std::vector<std::vector<uint8_t>>& getBitmapData();
+        bool save(const std::string& file_path) override;
+
+        void packTo(TextureImageBase* dest, size_t x_delta, size_t y_delta) override;
+
+        const std::string& getFilePath() const override {
+            return file_path_;
+        }
+
+        virtual bool loadSucceed() const override {
+            return load_succeed;
+        }
+
+        virtual std::vector<uint8_t>& getBitmapData() override;
 
     private:
-        std::vector<std::vector<uint8_t>> bitmap_data_;
-        unsigned int image_width_;
-        unsigned int image_height_;
-        unsigned int image_channels_;
+        bool init(const std::string& file_name);
+        std::vector<uint8_t> bitmap_data_;
+        unsigned int image_width_ = 0;
+        unsigned int image_height_ = 0;
+        unsigned int image_channels_ = 0;
+        bool load_succeed;
+        std::string file_path_;
     };
 }