Reworked PNG and JPEG image decoding to fix incompatibility of setjmp with c++ destructors. Added JPEG and PNG encoding/decoding tests

2 files changed, 199 insertions, 0 deletions

diff --git a/TextureLoader/include/JPEGCodec.h b/TextureLoader/include/JPEGCodec.h
new file mode 100644
index 0000000..4755a5a
--- /dev/null
+++ b/TextureLoader/include/JPEGCodec.h
@@ -0,0 +1,95 @@
+/*
+ *  Copyright 2019-2020 Diligent Graphics LLC
+ *  Copyright 2015-2019 Egor Yusov
+ *  
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *  
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *  
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence), 
+ *  contract, or otherwise, unless required by applicable law (such as deliberate 
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental, 
+ *  or consequential damages of any character arising as a result of this License or 
+ *  out of the use or inability to use the software (including but not limited to damages 
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
+ *  all other commercial damages or losses), even if such Contributor has been advised 
+ *  of the possibility of such damages.
+ */
+
+#include "../interface/Image.h"
+
+DILIGENT_BEGIN_NAMESPACE(Diligent)
+
+// clang-format off
+
+/// JPEG image decoding result.
+DILIGENT_TYPED_ENUM(DECODE_JPEG_RESULT, Uint32)
+{
+    /// JPEG image was decoded successfully.
+    DECODE_JPEG_RESULT_OK = 0,
+
+    /// Invalid arguments (e.g. null pointer).
+    DECODE_JPEG_RESULT_INVALID_ARGUMENTS,
+
+    /// Failed to initialize the decoder.
+    DECODE_JPEG_RESULT_INITIALIZATION_FAILED,
+
+    /// An unexpected error occurred while decoding the file.
+    DECODE_JPEG_RESULT_DECODING_ERROR
+};
+typedef enum DECODE_JPEG_RESULT DECODE_JPEG_RESULT;
+
+/// JPEG image encoding result.
+DILIGENT_TYPED_ENUM(ENCODE_JPEG_RESULT, Uint32)
+{
+    /// Encoding finished successfully.
+    ENCODE_JPEG_RESULT_OK = 0,
+
+    /// Invalid arguments (e.g. null pointer).
+    ENCODE_JPEG_RESULT_INVALID_ARGUMENTS,
+
+    /// Failed to initialize the encoder.
+    ENCODE_JPEG_RESULT_INITIALIZATION_FAILED
+};
+typedef enum ENCODE_JPEG_RESULT ENCODE_JPEG_RESULT;
+// clang-format on
+
+
+/// Decodes jpeg image.
+
+/// \param [in]  pSrcJpegBits - JPEG image encoded bits.
+/// \param [out] pDstPixels   - Decoded pixels data blob. The pixels are always tightly packed
+///                             (for instance, components of 3-channel image will be written as |r|g|b|r|g|b|r|g|b|...).
+/// \param [out] pDstImgDesc  - Decoded image description.
+/// \return                     Decoding result, see Diligent::DECODE_JPEG_RESULT.
+DECODE_JPEG_RESULT DILIGENT_GLOBAL_FUNCTION(DecodeJpeg)(IDataBlob* pSrcJpegBits,
+                                                        IDataBlob* pDstPixels,
+                                                        ImageDesc* pDstImgDesc);
+
+
+/// Encodes an image jpeg PNG format.
+
+/// \param [in] pSrcPixels    - Source pixels. The pixels must be tightly packed
+///                             (for instance, components of 3-channel image must be stored as |r|g|b|r|g|b|r|g|b|...).
+///                             At the moment, only RGB images are supported.
+/// \param [in] Width         - Image width.
+/// \param [in] Height        - Image height.
+/// \param [in] quality       - JPEG encoding qulaity, in the range from 0 to 100.
+/// \param [out] pDstJpegBits - Encoded JPEG image bits.
+/// \return                     Encoding result, see Diligent::ENCODE_JPEG_RESULT.
+ENCODE_JPEG_RESULT DILIGENT_GLOBAL_FUNCTION(EncodeJpeg)(Uint8*     pSrcRGBPixels,
+                                                        Uint32     Width,
+                                                        Uint32     Height,
+                                                        int        quality,
+                                                        IDataBlob* pDstJpegBits);
+
+DILIGENT_END_NAMESPACE // namespace Diligent
diff --git a/TextureLoader/include/PNGCodec.h b/TextureLoader/include/PNGCodec.h
new file mode 100644
index 0000000..0cc045a
--- /dev/null
+++ b/TextureLoader/include/PNGCodec.h
@@ -0,0 +1,104 @@
+/*
+ *  Copyright 2019-2020 Diligent Graphics LLC
+ *  Copyright 2015-2019 Egor Yusov
+ *  
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *  
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *  
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ *  In no event and under no legal theory, whether in tort (including negligence), 
+ *  contract, or otherwise, unless required by applicable law (such as deliberate 
+ *  and grossly negligent acts) or agreed to in writing, shall any Contributor be
+ *  liable for any damages, including any direct, indirect, special, incidental, 
+ *  or consequential damages of any character arising as a result of this License or 
+ *  out of the use or inability to use the software (including but not limited to damages 
+ *  for loss of goodwill, work stoppage, computer failure or malfunction, or any and 
+ *  all other commercial damages or losses), even if such Contributor has been advised 
+ *  of the possibility of such damages.
+ */
+
+#include "../interface/Image.h"
+
+DILIGENT_BEGIN_NAMESPACE(Diligent)
+
+// clang-format off
+
+/// PNG decoding result.
+DILIGENT_TYPED_ENUM(DECODE_PNG_RESULT, Uint32)
+{
+    /// Decoding was successfull.
+    DECODE_PNG_RESULT_OK = 0,
+
+    /// Invalid arguments (e.g. null pointer).
+    DECODE_PNG_RESULT_INVALID_ARGUMENTS,
+
+    /// Invalid signature (the encoded file is not a PNG file).
+    DECODE_PNG_RESULT_INVALID_SIGNATURE,
+
+    /// Failed to initialize the decoder.
+    DECODE_PNG_RESULT_INITIALIZATION_FAILED,
+
+    /// Invalid bit depth.
+    DECODE_PNG_RESULT_INVALID_BIT_DEPTH,
+
+    /// An unexpected error occurred while decoding the file.
+    DECODE_PNG_RESULT_DECODING_ERROR
+};
+typedef enum DECODE_PNG_RESULT DECODE_PNG_RESULT;
+
+/// PNG encoding result
+DILIGENT_TYPED_ENUM(ENCODE_PNG_RESULT, Uint32)
+{
+    /// Encoding finished successfully.
+    ENCODE_PNG_RESULT_OK = 0,
+
+    /// Invalid arguments (e.g. null pointer).
+    ENCODE_PNG_RESULT_INVALID_ARGUMENTS,
+
+    /// Failed to initialize the encoder.
+    ENCODE_PNG_RESULT_INITIALIZATION_FAILED
+};
+typedef enum ENCODE_PNG_RESULT ENCODE_PNG_RESULT;
+// clang-format on
+
+
+/// Decodes png image.
+
+/// \param [in]  pSrcPngBits - PNG image encoded bits.
+/// \param [out] pDstPixels  - Decoded pixels data blob. The pixels are always tightly packed
+///                            (for instance, components of 3-channel image will be written as |r|g|b|r|g|b|r|g|b|...).
+/// \param [out] pDstImgDesc - Decoded image description.
+/// \return                    Decoding result, see Diligent::DECODE_PNG_RESULT.
+DECODE_PNG_RESULT DILIGENT_GLOBAL_FUNCTION(DecodePng)(IDataBlob* pSrcPngBits,
+                                                      IDataBlob* pDstPixels,
+                                                      ImageDesc* pDstImgDesc);
+
+/// Encodes an image into PNG format.
+
+/// \param [in] pSrcPixels    - Source pixels. The pixels must be tightly packed
+///                             (for instance, components of 3-channel image must be stored as |r|g|b|r|g|b|r|g|b|...).
+///                             The number of components is defined by the PngColorType parameter.
+/// \param [in] Width         - Image width.
+/// \param [in] Height        - Image height.
+/// \param [in] StrideInBytes - Image data stride, in bytes.
+/// \param [in] PngColorType  - PNG color type (PNG_COLOR_TYPE_RGB, PNG_COLOR_TYPE_RGBA, etc.).
+///                             The color type defines the number of color components, which must be
+///                             tightly packed.
+/// \param [out] pDstPngBits  - Encoded PNG image bits.
+/// \return                     Encoding result, see Diligent::ENCODE_PNG_RESULT.
+ENCODE_PNG_RESULT DILIGENT_GLOBAL_FUNCTION(EncodePng)(const Uint8* pSrcPixels,
+                                                      Uint32       Width,
+                                                      Uint32       Height,
+                                                      Uint32       StrideInBytes,
+                                                      int          PngColorType,
+                                                      IDataBlob*   pDstPngBits);
+
+DILIGENT_END_NAMESPACE // namespace Diligent