virtualx-engine/thirdparty/README.md

Third party libraries

Please keep categories (## level) listed alphabetically and matching their respective folder names. Use two empty lines to separate categories for readability. Subcategories (### level) where needed are separated by a single empty line.

assimp

• Upstream: http://github.com/assimp/assimp
• Version: git (308db73d0b3c2d1870cd3e465eaa283692a4cf23, 2019)
• License: BSD-3-Clause

Files extracted from upstream source:

• Run cmake . in root folder to generate files
• code/{CApi,Common,FBX,Material,PostProcessing}/
• contrib/utf8cpp/source/
• include/
• revision.h
• CREDITS and LICENSE files
• rm -f code/Common/ZipArchiveIOSystem.cpp include/assimp/ZipArchiveIOSystem.h include/assimp/irrXMLWrapper.h

basis_universal

• Upstream: https://github.com/BinomialLLC/basis_universal
• Version: git (895ee8ee7e04f22267f8d16d46de04d5a01d63ac, 2020)
• License: Apache 2.0

Files extracted from upstream source:

• .cpp and .h files in root folder except for basisu_tool.cpp (contains main and can cause link error)
• .cpp, .h and .inc files in transcoder/, keeping folder structure
• LICENSE

bullet

• Upstream: https://github.com/bulletphysics/bullet3
• Version: git pre-2.90 (cd8cf7521cbb8b7808126a6adebd47bb83ea166a, 2020)
• License: zlib

Important: Synced with a pre-release version of bullet 2.90 from the master branch.

Files extracted from upstream source:

• src/* apart from CMakeLists.txt and premake4.lua files
• LICENSE.txt

certs

• Upstream: Mozilla, via https://apps.fedoraproject.org/packages/ca-certificates
• Version: 2018.2.26 (2018)
• License: MPL 2.0

File extracted from a recent Fedora install: /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem (It can't be extracted directly from the package, as it's generated on the user's system.)

cvtt

• Upstream: https://github.com/elasota/cvtt
• Version: 1.0.0-beta4 (2018)
• License: MIT

Files extracted from upstream source:

• all .cpp, .h, and .txt files in ConvectionKernels/

enet

• Upstream: http://enet.bespin.org
• Version: 1.3.15 (224f31101fc60939c02f6bbe8e8fc810a7db306b, 2020)
• License: MIT

Files extracted from upstream source:

• all .c files in the main directory (except unix.c win32.c)
• the include/enet/ folder as enet/ (except unix.h win32.h)
• LICENSE file

Important: enet.h, host.c, protocol.c have been slightly modified to be usable by godot socket implementation and allow IPv6 and DTLS. Apply the patches in the patches/ folder when syncing on newer upstream commits.

Two files (godot.cpp and enet/godot.h) have been added to provide enet socket implementation using Godot classes.

It is still possible to build against a system wide ENet but doing so will limit its functionality to IPv4 only.

etc2comp

• Upstream: https://github.com/google/etc2comp
• Version: git (9cd0f9cae0f32338943699bb418107db61bb66f2, 2017)
• License: Apache 2.0

Files extracted from upstream source:

• all .cpp and .h files in EtcLib/
• README.md, LICENSE, AUTHORS

Important: Some files have Godot-made changes. They are marked with // -- GODOT start -- and // -- GODOT end -- comments.

fonts

Noto Sans

• Upstream: https://github.com/googlei18n/noto-fonts
• Version: 1.06 (2017)
• License: OFL-1.1

Use UI font variant if available, because it has tight vertical metrics and good for UI.

Hack Regular

• Upstream: https://github.com/source-foundry/Hack
• Version: 3.003 (2018)
• License: MIT + Bitstream Vera License

DroidSans*.ttf

• Upstream: https://android.googlesource.com/platform/frameworks/base/+/master/data/fonts/
• Version: ? (pre-2014 commit when DroidSansJapanese.ttf was obsoleted)
• License: Apache 2.0

freetype

• Upstream: https://www.freetype.org
• Version: 2.10.2 (2020)
• License: FreeType License (BSD-like)

Files extracted from upstream source:

• the src/ folder, stripped of the Jamfile files and the tools subfolder
• the include/ folder
• docs/{FTL.TXT,LICENSE.TXT}

glad

• Upstream: https://github.com/Dav1dde/glad
• Version: 0.1.33 (2019)
• License: MIT

The files we package are automatically generated. See the header of glad.c for instructions on how to generate them for the GLES version Godot targets.

glslang

• Upstream: https://github.com/KhronosGroup/glslang
• Version: git (4fc7a33910fb8e40b970d160e1b38ab3f67fe0f3, 2020)
• License: glslang

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section). Check Vulkan-ValidationLayers at the matching SDK tag for the known good glslang commit: https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/scripts/known_good.json

Files extracted from upstream source:

• glslang, OGLCompilersDLL, SPIRV
• LICENSE.txt
• Unnecessary files like CMakeLists.txt, revision.template and updateGrammar removed.

Patches in the patches directory should be re-applied after updates.

jpeg-compressor

• Upstream: https://github.com/richgel999/jpeg-compressor
• Version: 2.00 (aeb7d3b463aa8228b87a28013c15ee50a7e6fcf3, 2020)
• License: Public domain

Files extracted from upstream source:

• jpgd*.{c,h}

libogg

• Upstream: https://www.xiph.org/ogg
• Version: git (c8fca6b4a02d695b1ceea39b330d4406001c03ed, 2019)
• License: BSD-3-Clause

Files extracted from upstream source:

• src/*.{c,h}
• include/ogg/*.h in ogg/
• COPYING

libpng

• Upstream: http://libpng.org/pub/png/libpng.html
• Version: 1.6.37 (2019)
• License: libpng/zlib

Files extracted from upstream source:

• all .c and .h files of the main directory, except from example.c and pngtest.c
• the arm/ folder
• scripts/pnglibconf.h.prebuilt as pnglibconf.h
• LICENSE

libsimplewebm

• Upstream: https://github.com/zaps166/libsimplewebm
• Version: git (fe57fd3cfe6c0af4c6af110b1f84a90cf191d943, 2019)
• License: MIT (main), BSD-3-Clause (libwebm)

This contains libwebm, but the version in use is updated from the one used by libsimplewebm, and may have unmarked alterations from that.

Files extracted from upstream source:

• all the .cpp, .hpp files in the main folder except example.cpp
• LICENSE

Important: Some files have Godot-made changes. They are marked with // -- GODOT start -- and // -- GODOT end -- comments.

libtheora

• Upstream: https://www.theora.org
• Version: 1.1.1 (2010)
• License: BSD-3-Clause

Files extracted from upstream source:

• all .c, .h in lib/
• all .h files in include/theora/ as theora/
• COPYING and LICENSE

Upstream patches included in the patches directory have been applied on top of the 1.1.1 source (not included in any stable release yet).

libvorbis

• Upstream: https://www.xiph.org/vorbis
• Version: 1.3.6 (2018)
• License: BSD-3-Clause

Files extracted from upstream source:

• src/* except from: lookups.pl, Makefile.*
• include/vorbis/*.h as vorbis/
• COPYING

libvpx

• Upstream: https://chromium.googlesource.com/webm/libvpx/
• Version: 1.6.0 (2016)
• License: BSD-3-Clause

Files extracted from upstream source:

TODO.

Important: File libvpx/vpx_dsp/x86/vpx_subpixel_8t_intrin_avx2.c has Godot-made change marked with // -- GODOT -- comments.

The files libvpx/third_party/android/cpu-features.{c,h} were copied from the Android NDK r18.

libwebp

• Upstream: https://chromium.googlesource.com/webm/libwebp/
• Version: 1.1.0 (2020)
• License: BSD-3-Clause

Files extracted from upstream source:

• src/* except from: .am, .rc and .in files
• AUTHORS, COPYING, PATENTS

Important: The files utils/bit_reader_utils.{c,h} have Godot-made changes to ensure they build for Javascript/HTML5. Those changes are marked with // -- GODOT -- comments.

mbedtls

• Upstream: https://tls.mbed.org/
• Version: 2.16.7 (2020)
• License: Apache 2.0

File extracted from upstream release tarball:

• All *.h from include/mbedtls/ to thirdparty/mbedtls/include/mbedtls/
• All *.c from library/ to thirdparty/mbedtls/library/
• LICENSE and apache-2.0.txt files
• Applied the patch in thirdparty/mbedtls/patches/1453.diff (PR 1453). Soon to be merged upstream. Check it out at next update.
• Applied the patch in thirdparty/mbedtls/patches/padlock.diff. This disables VIA padlock support which defines a symbol unsupported which clashes with a pre-defined symbol.
• Added 2 files godot_core_mbedtls_platform.{c,h} providing configuration for light bundling with core.

miniupnpc

• Upstream: https://github.com/miniupnp/miniupnp/tree/master/miniupnpc
• Version: git (44366328661826603982d1e0d7ebb4062c5f2bfc, 2020)
• License: BSD-3-Clause

Files extracted from upstream source:

• All *.c and *.h files from miniupnpc to thirdparty/miniupnpc/miniupnpc
• Remove test*, minihttptestserver.c and wingenminiupnpcstrings.c

The patch windows_fix.diff is applied to minissdpc.c to fix an upstream issue. The only modified file is miniupnpcstrings.h, which was created for Godot (it is usually autogenerated by cmake).

minizip

• Upstream: http://www.zlib.net
• Version: 1.2.11 (zlib contrib, 2017)
• License: zlib

Files extracted from the upstream source:

• contrib/minizip/{crypt.h,ioapi.{c,h},zip.{c,h},unzip.{c,h}}

Important: Some files have Godot-made changes for use in core/io. They are marked with /* GODOT start */ and /* GODOT end */ comments and a patch is provided in the minizip/ folder.

misc

Collection of single-file libraries used in Godot components.

core

• clipper.{cpp,hpp}
  • Upstream: https://sourceforge.net/projects/polyclipping
  • Version: 6.4.2 (2017) + Godot changes (added optional exceptions handling)
  • License: BSL-1.0
• cubemap_coeffs.h
  • Upstream: https://research.activision.com/publications/archives/fast-filtering-of-reflection-probes File coeffs_const_8.txt (retrieved April 2020)
  • License: MIT
• fastlz.{c,h}
  • Upstream: https://github.com/ariya/FastLZ
  • Version: 0.5.0 (4f20f54d46f5a6dd4fae4def134933369b7602d2, 2020)
  • License: MIT
• hq2x.{cpp,h}
  • Upstream: https://github.com/brunexgeek/hqx
  • Version: TBD, file structure differs
  • License: Apache 2.0
• open-simplex-noise.{c,h}
  • Upstream: https://github.com/smcameron/open-simplex-noise-in-c
  • Version: git (0d555e7f40527d0870906fe9469a3b1bb4020b7f, 2015) + custom changes
  • License: Unlicense
• pcg.{cpp,h}
  • Upstream: http://www.pcg-random.org
  • Version: minimal C implementation, http://www.pcg-random.org/download.html
  • License: Apache 2.0
• r128.h
  • Upstream: https://github.com/fahickman/r128
  • Version: git (423f693617faafd01de21e92818add4208eb8bd1, 2020)
  • License: Public Domain
• smaz.{c,h}
  • Upstream: https://github.com/antirez/smaz
  • Version: git (150e125cbae2e8fd20dd332432776ce13395d4d4, 2009)
  • License: BSD-3-Clause
  • Modifications: use const char* instead of char* for input string
• stb_rect_pack.h
  • Upstream: https://github.com/nothings/stb
  • Version: 1.00 (2019)
  • License: Public Domain (Unlicense) or MIT
• triangulator.{cpp,h}
  • Upstream: https://github.com/ivanfratric/polypartition (src/polypartition.cpp)
  • Version: TBD, class was renamed
  • License: MIT

modules

• yuv2rgb.h
  • Upstream: http://wss.co.uk/pinknoise/yuv2rgb/ (to check)
  • Version: ?
  • License: BSD

platform

• ifaddrs-android.{cc,h}
  • Upstream: https://chromium.googlesource.com/external/webrtc/stable/talk/+/master/base/ifaddrs-android.h
  • Version: git (5976650443d68ccfadf1dea24999ee459dd2819d, 2013)
  • License: BSD-3-Clause

scene

• easing_equations.cpp
  • Upstream: http://robertpenner.com/easing/ via https://github.com/jesusgollonet/ofpennereasing (modified to fit Godot types)
  • Version: git (af72c147c3a74e7e872aa28c7e2abfcced04fdce, 2008) + Godot types and style changes
  • License: BSD-3-Clause
• mikktspace.{c,h}
  • Upstream: https://archive.blender.org/wiki/index.php/Dev:Shading/Tangent_Space_Normal_Maps/
  • Version: 1.0 (2011)
  • License: zlib
• stb_vorbis.c
  • Upstream: https://github.com/nothings/stb
  • Version: 1.20
  • License: Public Domain (Unlicense) or MIT

nanosvg

• Upstream: https://github.com/memononen/nanosvg
• Version: git (25241c5a8f8451d41ab1b02ab2d865b01600d949, 2019)
• License: zlib

Files extracted from the upstream source:

• All .h files in src/
• LICENSE.txt

oidn

• Upstream: https://github.com/OpenImageDenoise/oidn
• Version: 1.1.0 (c58c5216db05ceef4cde5a096862f2eeffd14c06, 2019)
• License: Apache 2.0

Files extracted from upstream source:

common/* (except tasking.* and CMakeLists.txt) core/* include/OpenImageDenoise/* (except version.h.in) LICENSE.txt mkl-dnn/include/* mkl-dnn/src/* (except CMakeLists.txt) weights/rtlightmap_hdr.tza scripts/resource_to_cpp.py

Modified files: Modifications are marked with // -- GODOT start -- and // -- GODOT end --. Patch files are provided in oidn/patches/.

core/autoencoder.cpp core/autoencoder.h core/common.h core/device.cpp core/device.h core/transfer_function.cpp

scripts/resource_to_cpp.py (used in modules/denoise/resource_to_cpp.py)

opus

• Upstream: https://opus-codec.org
• Version: 1.1.5 (opus) and 0.8 (opusfile) (2017)
• License: BSD-3-Clause

Files extracted from upstream source:

• all .c and .h files in src/ (both opus and opusfile)
• all .h files in include/ (both opus and opusfile) as opus/
• remove unused opus_demo.c,
• remove http.c, wincerts.c and winerrno.h (part of unused libopusurl)
• celt/ and silk/ subfolders
• COPYING

pcre2

• Upstream: http://www.pcre.org
• Version: 10.34 (2019)
• License: BSD-3-Clause

Files extracted from upstream source:

• Files listed in the file NON-AUTOTOOLS-BUILD steps 1-4
• All .h files in src/ apart from pcre2posix.h
• src/pcre2_jit_match.c
• src/pcre2_jit_misc.c
• src/sljit/*
• AUTHORS and LICENCE

pvrtccompressor

• Upstream: https://bitbucket.org/jthlim/pvrtccompressor
• Version: hg (cf7177748ee0dcdccfe89716dc11a47d2dc81af5, 2015)
• License: BSD-3-Clause

Files extracted from upstream source:

• all .cpp and .h files apart from main.cpp
• LICENSE.TXT

recastnavigation

• Upstream: https://github.com/recastnavigation/recastnavigation
• Version: git (57610fa6ef31b39020231906f8c5d40eaa8294ae, 2019)
• License: zlib

Files extracted from upstream source:

• Recast/ folder without CMakeLists.txt
• License.txt

rvo2

• Upstream: http://gamma.cs.unc.edu/RVO2/
• Version: 3D - 1.0.1 (2016)
• License: Apache 2.0

Files extracted from upstream source:

• All .cpp and .h files in the src/ folder except for RVO.h, RVOSimulator.cpp and RVOSimulator.h
• LICENSE

Important: Some files have Godot-made changes; so to enrich the features originally proposed by this library and better integrate this library with Godot. Please check the file to know what's new.

squish

• Upstream: https://sourceforge.net/projects/libsquish
• Version: 1.15 (2017)
• License: MIT

Files extracted from upstream source:

• all .cpp, .h and .inl files

Important: Some files have Godot-made changes. They are marked with // -- GODOT start -- and // -- GODOT end -- comments and a patch is provided in the squish/ folder.

tinyexr

• Upstream: https://github.com/syoyo/tinyexr
• Version: git (4dbd05a22f51a2d7462311569b8b0cba0bbe2ac5, 2020)
• License: BSD-3-Clause

Files extracted from upstream source:

• tinyexr.{cc,h}

vhacd

• Upstream: https://github.com/kmammou/v-hacd
• Version: git (b07958e18e01d504e3af80eeaeb9f033226533d7, 2019)
• License: BSD-3-Clause

Files extracted from upstream source:

• From src/VHACD_Lib/: inc, public and src
• LICENSE

Some downstream changes have been made and are identified by // -- GODOT start -- and // -- GODOT end -- comments. They can be reapplied using the patches included in the vhacd folder.

vulkan

• Upstream: https://github.com/KhronosGroup/Vulkan-Loader
• Version: sdk-1.2.131.2 (2020)
• License: Apache 2.0

Unless there is a specific reason to package a more recent version, please stick to Vulkan SDK releases (prefixed by sdk-) for all components.

NOTE: Use scripts/update_deps.py --ref <version> in the Loader git repository to retrieve the Vulkan-Headers repository matching the loader version.

Files extracted from upstream source:

• Vulkan-Headers/include/ as include/
• All .c and .h files in loader/ and loader/generated/, put in a common loader/ folder
• LICENSE.txt

vk_enum_string_helper.h is taken from the matching Vulkan-ValidationLayers SDK release: https://github.com/KhronosGroup/Vulkan-ValidationLayers/blob/master/layers/generated/vk_enum_string_helper.h Includes custom change to disable MSVC pragma, might be upstreamed via: https://github.com/KhronosGroup/Vulkan-ValidationLayers/pull/1666

vk_mem_alloc.h is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator Version: 2.3.0 (2019)

Patches in the patches directory should be re-applied after updates.

wslay

• Upstream: https://github.com/tatsuhiro-t/wslay
• Version: 1.1.1 (2020)
• License: MIT

File extracted from upstream release tarball:

• All *.c and *.h in lib/ and lib/includes/
• wslay.h has a small Godot addition to fix MSVC build. See thirdparty/wslay/msvcfix.diff

xatlas

• Upstream: https://github.com/jpcy/xatlas
• Version: git (470576d3516f7e6d8b4554e7c941194a935969fd, 2020)
• License: MIT

Files extracted from upstream source:

• xatlas.{cpp,h}
• LICENSE

zlib

• Upstream: http://www.zlib.net
• Version: 1.2.11 (2017)
• License: zlib

Files extracted from upstream source:

• all .c and .h files

zstd

• Upstream: https://github.com/facebook/zstd
• Version: 1.4.4 (2019)
• License: BSD-3-Clause

Files extracted from upstream source:

• lib/{common/,compress/,decompress/,zstd.h}
• LICENSE