Add WebP support (#1512)

- Added a new dependency on libwebp, updated NOTICES, etc.
- Added new CMake option to remove webp support as this dependency costs
~200KB to the final disk footprint.
- Updated some CMake variables in dependencies to use local variables
instead of cached variables.
- Added a test for a glTF with WebP textures coming from the Babylon.js side.

Author: bghgary

Apps/Playground/ReferenceImages/webp.png

@@ -52,6 +52,11 @@
             "playgroundId": "#2FDQT5#1508",
             "referenceImage": "iridescence_gltf.png"
         },
+        {
+            "title": "EXT_texture_webp",
+            "playgroundId": "#LSAUH2#6",
+            "referenceImage": "webp.png"
+        },
         {
             "title": "GLTF Animation Skin Type",
             "playgroundId": "#DS8AA7#27",

Apps/Playground/Scripts/config.json

@@ -47,28 +47,27 @@ FetchContent_Declare(OpenXR-SDK
 FetchContent_Declare(SPIRV-Cross
     GIT_REPOSITORY https://github.com/BabylonJS/SPIRV-Cross.git
     GIT_TAG 578a291759db6fe7c3f4735d3512c0526ad18efc)
+FetchContent_Declare(libwebp
+    GIT_REPOSITORY https://github.com/webmproject/libwebp.git
+    GIT_TAG 57e324e2eb99be46df46d77b65705e34a7ae616c)
 # --------------------------------------------------
 
 FetchContent_MakeAvailable(CMakeExtensions)
 
-
 if(VISIONOS)
     FetchContent_MakeAvailable_With_Message(ios-cmake)
     set(CMAKE_TOOLCHAIN_FILE "${ios-cmake_SOURCE_DIR}/ios.toolchain.cmake" CACHE PATH "")
     set(PLATFORM "VISIONOSCOMBINED" CACHE STRING "")
     set(DEPLOYMENT_TARGET "1.0" CACHE STRING "")
     set(ENABLE_ARC OFF CACHE STRING "Enables or disables ARC support.")
-endif()
-
-if(IOS)
+elseif(IOS)
     FetchContent_MakeAvailable_With_Message(ios-cmake)
     set(CMAKE_TOOLCHAIN_FILE "${ios-cmake_SOURCE_DIR}/ios.toolchain.cmake" CACHE PATH "")
     set(PLATFORM "OS64COMBINED" CACHE STRING "")
     set(DEPLOYMENT_TARGET "13" CACHE STRING "")
     set(ENABLE_ARC OFF CACHE STRING "Enables or disables ARC support.")
 endif()
 
-
 project(BabylonNative)
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)
@@ -93,6 +92,7 @@ option(BABYLON_NATIVE_PLUGIN_EXTERNALTEXTURE "Include Babylon Native Plugin Exte
 option(BABYLON_NATIVE_PLUGIN_NATIVECAMERA "Include Babylon Native Plugin NativeCamera." ON)
 option(BABYLON_NATIVE_PLUGIN_NATIVECAPTURE "Include Babylon Native Plugin NativeCapture." ON)
 option(BABYLON_NATIVE_PLUGIN_NATIVEENGINE "Include Babylon Native Plugin NativeEngine." ON)
+option(BABYLON_NATIVE_PLUGIN_NATIVEENGINE_WEBP "Include Babylon Native Plugin NativeEngine - WebP." ON)
 option(BABYLON_NATIVE_PLUGIN_NATIVEINPUT "Include Babylon Native Plugin NativeInput." ON)
 option(BABYLON_NATIVE_PLUGIN_NATIVEOPTIMIZATIONS "Include Babylon Native Plugin NativeOptimizations." ON)
 option(BABYLON_NATIVE_PLUGIN_NATIVETRACING "Include Babylon Native Plugin NativeTracing." ON)

CMakeLists.txt

@@ -1,3 +1,5 @@
+set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
+
 # --------------------------------------------------
 # AndroidExtensions
 # --------------------------------------------------
@@ -28,12 +30,12 @@ target_include_directories(base-n INTERFACE "${base-n_SOURCE_DIR}/include")
 # --------------------------------------------------
 # bgfx.cmake
 # --------------------------------------------------
-set(BGFX_BUILD_TOOLS OFF CACHE BOOL "")
-set(BGFX_BUILD_EXAMPLES OFF CACHE BOOL "")
-set(BGFX_INSTALL OFF CACHE BOOL "")
-set(BGFX_CUSTOM_TARGETS OFF CACHE BOOL "")
-set(BGFX_USE_DEBUG_SUFFIX OFF CACHE BOOL "")
-set(BGFX_OPENGL_USE_EGL ON CACHE BOOL "")
+set(BGFX_BUILD_TOOLS OFF)
+set(BGFX_BUILD_EXAMPLES OFF)
+set(BGFX_INSTALL OFF)
+set(BGFX_CUSTOM_TARGETS OFF)
+set(BGFX_USE_DEBUG_SUFFIX OFF)
+set(BGFX_OPENGL_USE_EGL ON)
 FetchContent_MakeAvailable_With_Message(bgfx.cmake)
 
 target_compile_definitions(bgfx PRIVATE BGFX_CONFIG_MULTITHREADED=1)
@@ -78,15 +80,15 @@ endif()
 # --------------------------------------------------
 # glslang
 # --------------------------------------------------
-set(BUILD_EXTERNAL OFF CACHE BOOL "")
-set(ENABLE_SPVREMAPPER OFF CACHE BOOL "")
-set(ENABLE_GLSLANG_BINARIES OFF CACHE BOOL "")
-set(ENABLE_HLSL OFF CACHE BOOL "")
-set(ENABLE_OPT OFF CACHE BOOL "")
-set(ENABLE_CTEST OFF CACHE BOOL "")
-set(SKIP_GLSLANG_INSTALL ON CACHE BOOL "")
-set(ENABLE_GLSLANG_WEBMIN ON CACHE BOOL "")
-set(ENABLE_GLSLANG_WEBMIN_DEVEL OFF CACHE BOOL "")
+set(BUILD_EXTERNAL OFF)
+set(ENABLE_SPVREMAPPER OFF)
+set(ENABLE_GLSLANG_BINARIES OFF)
+set(ENABLE_HLSL OFF)
+set(ENABLE_OPT OFF)
+set(ENABLE_CTEST OFF)
+set(SKIP_GLSLANG_INSTALL ON)
+set(ENABLE_GLSLANG_WEBMIN ON)
+set(ENABLE_GLSLANG_WEBMIN_DEVEL OFF)
 
 if(NOT TARGET glslang)
     FetchContent_MakeAvailable_With_Message(glslang)
@@ -109,7 +111,7 @@ if(BABYLON_NATIVE_BUILD_APPS AND (WIN32 OR (APPLE AND NOT IOS AND NOT VISIONOS)
         # Default build type for my test projects are /MDd (MultiThreaded DLL) but GTests default to /MTd (MultiTreaded)
         # see https://github.com/google/googletest/blob/main/googletest/README.md
         # "Enabling this option will make gtest link the runtimes dynamically too, and match the project in which it is included."
-        set(gtest_force_shared_crt OFF CACHE BOOL "" FORCE)
+        set(gtest_force_shared_crt OFF)
     endif()
 
     FetchContent_MakeAvailable_With_Message(googletest)
@@ -138,22 +140,22 @@ endif()
 # --------------------------------------------------
 # SPIRV-Cross
 # --------------------------------------------------
-set(SPIRV_CROSS_CLI OFF CACHE BOOL "")
-set(SPIRV_CROSS_ENABLE_TESTS OFF CACHE BOOL "")
-set(SPIRV_CROSS_ENABLE_CPP OFF CACHE BOOL "")
-set(SPIRV_CROSS_ENABLE_REFLECT OFF CACHE BOOL "")
-set(SPIRV_CROSS_ENABLE_C_API OFF CACHE BOOL "")
-set(SPIRV_CROSS_ENABLE_UTIL OFF CACHE BOOL "")
-set(SPIRV_CROSS_SKIP_INSTALL ON CACHE BOOL "")
-set(SPIRV_CROSS_ENABLE_WEBMIN ON CACHE BOOL "")
+set(SPIRV_CROSS_CLI OFF)
+set(SPIRV_CROSS_ENABLE_TESTS OFF)
+set(SPIRV_CROSS_ENABLE_CPP OFF)
+set(SPIRV_CROSS_ENABLE_REFLECT OFF)
+set(SPIRV_CROSS_ENABLE_C_API OFF)
+set(SPIRV_CROSS_ENABLE_UTIL OFF)
+set(SPIRV_CROSS_SKIP_INSTALL ON)
+set(SPIRV_CROSS_ENABLE_WEBMIN ON)
 if(NOT GRAPHICS_API STREQUAL "OpenGL")
-    set(SPIRV_CROSS_ENABLE_GLSL OFF CACHE BOOL "")
+    set(SPIRV_CROSS_ENABLE_GLSL OFF)
 endif()
 if(NOT GRAPHICS_API STREQUAL "Metal")
-    set(SPIRV_CROSS_ENABLE_MSL OFF CACHE BOOL "")
+    set(SPIRV_CROSS_ENABLE_MSL OFF)
 endif()
 if(NOT GRAPHICS_API STREQUAL "D3D11" AND NOT GRAPHICS_API STREQUAL "D3D12")
-    set(SPIRV_CROSS_ENABLE_HLSL OFF CACHE BOOL "")
+    set(SPIRV_CROSS_ENABLE_HLSL OFF)
 endif()
 FetchContent_MakeAvailable_With_Message(SPIRV-Cross)
 set_property(TARGET spirv-cross-core PROPERTY FOLDER Dependencies/SPIRV-Cross)
@@ -176,7 +178,7 @@ foreach(target spirv-cross-core spirv-cross-glsl spirv-cross-msl spirv-cross-hls
     endif()
 endforeach()
 
-# seen with Sergio, disable warnings until unused parameter [-Wunused-parameter] get fixed. 
+# Disable warnings until unused parameter [-Wunused-parameter] get fixed.
 if(TARGET SPIRV)
     disable_warnings(SPIRV)
 endif()
@@ -194,6 +196,35 @@ if(BABYLON_NATIVE_PLUGIN_NATIVEXR AND (WIN32 OR ANDROID OR IOS))
     warnings_as_errors(xr)
 endif()
 
+# --------------------------------------------------
+# WebP
+# --------------------------------------------------
+if(BABYLON_NATIVE_PLUGIN_NATIVEENGINE_WEBP)
+    set(WEBP_BUILD_ANIM_UTILS OFF)
+    set(WEBP_BUILD_CWEBP OFF)
+    set(WEBP_BUILD_DWEBP OFF)
+    set(WEBP_BUILD_GIF2WEBP OFF)
+    set(WEBP_BUILD_IMG2WEBP OFF)
+    set(WEBP_BUILD_VWEBP OFF)
+    set(WEBP_BUILD_WEBPINFO OFF)
+    set(WEBP_BUILD_LIBWEBPMUX OFF)
+    set(WEBP_BUILD_WEBPMUX OFF)
+    set(WEBP_BUILD_EXTRAS OFF)
+    FetchContent_MakeAvailable_With_Message(libwebp)
+
+    set_property(TARGET sharpyuv PROPERTY UNITY_BUILD false)
+    set_property(TARGET sharpyuv PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webp PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webpdecode PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webpdecoder PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webpdemux PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webpdsp PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webpdspdecode PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webpencode PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webputils PROPERTY FOLDER Dependencies/libwebp)
+    set_property(TARGET webputilsdecode PROPERTY FOLDER Dependencies/libwebp)
+endif()
+
 # --------------------------------------------------
 # WindowsAppSDK
 # --------------------------------------------------

Dependencies/CMakeLists.txt

@@ -416,6 +416,40 @@ NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 \\****************************************************************************/
 ```
 
+# libwebp
+
+```
+Copyright (c) 2010, Google Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Neither the name of Google nor the names of its contributors may
+    be used to endorse or promote products derived from this software
+    without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+```
+
 # Node.js
 
 ```

NOTICE.md

@@ -29,14 +29,14 @@ endif()
 
 add_library(NativeEngine ${SOURCES})
 
+warnings_as_errors(NativeEngine)
+
 target_include_directories(NativeEngine
     PUBLIC "Include"
     PRIVATE "${BIMG_DIR}/3rdparty")
 
 target_link_libraries(NativeEngine
     PUBLIC napi
-    PRIVATE JsRuntime
-    PRIVATE GraphicsDevice
     PRIVATE arcana
     PRIVATE bgfx
     PRIVATE bimg
@@ -45,9 +45,17 @@ target_link_libraries(NativeEngine
     PRIVATE bx
     PRIVATE glslang
     PRIVATE glslang-default-resource-limits
-    PRIVATE SPIRV
-    PRIVATE GraphicsDeviceContext)
-warnings_as_errors(NativeEngine)
+    PRIVATE GraphicsDevice
+    PRIVATE GraphicsDeviceContext
+    PRIVATE JsRuntime
+    PRIVATE SPIRV)
+
+if(BABYLON_NATIVE_PLUGIN_NATIVEENGINE_WEBP)
+    target_compile_definitions(NativeEngine
+        PRIVATE WEBP)
+    target_link_libraries(NativeEngine
+        PRIVATE webp)
+endif()
 
 if(TARGET spirv-cross-hlsl)
     target_link_libraries(NativeEngine

Plugins/NativeEngine/CMakeLists.txt

@@ -25,6 +25,10 @@
 #include <Babylon/ShaderCache.h>
 #include "ShaderCache.h"
 
+#ifdef WEBP
+#include <webp/decode.h>
+#endif
+
 namespace Babylon
 {
     namespace
@@ -186,6 +190,19 @@ namespace Babylon
             bimg::ImageContainer* image{bimg::imageParse(&allocator, data.data(), static_cast<uint32_t>(data.size()))};
             if (image == nullptr)
             {
+#ifdef WEBP
+                int width;
+                int height;
+                if (WebPGetInfo(data.data(), data.size(), &width, &height))
+                {
+                    image = bimg::imageAlloc(&allocator, bimg::TextureFormat::RGBA8, static_cast<uint16_t>(width), static_cast<uint16_t>(height), 1, 1, false, false);
+                    if (WebPDecodeRGBAInto(data.data(), data.size(), static_cast<uint8_t*>(image->m_data), static_cast<size_t>(image->m_size), width * 4))
+                    {
+                        return image;
+                    }
+                }
+#endif
+
                 throw std::runtime_error{"Failed to parse image."};
             }