godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
fd6eb2c2d2
godot/thirdparty/README.md

21 KiB
Vendored
Raw Blame History

Third party libraries

Please keep categories (## level) listed alphabetically and matching their respective folder names. Use two empty lines to separate categories for readability.

amd-fsr

Files extracted from upstream source:

  • ffx_a.h and ffx_fsr1.h from ffx-fsr
  • license.txt

basis_universal

Files extracted from upstream source:

  • encoder/ and transcoder/ folders
  • LICENSE

brotli

Files extracted from upstream source:

  • common/, dec/ and include/ folders
  • LICENSE

certs

cvtt

Files extracted from upstream source:

  • all .cpp, .h, and .txt files except the folders MakeTables and etc2packer.

doctest

Extracted from .zip provided. Extracted license and header only.

embree

Files extracted from upstream:

  • All cpp files listed in modules/raycast/godot_update_embree.py
  • All header files in the directories listed in modules/raycast/godot_update_embree.py

The modules/raycast/godot_update_embree.py script can be used to pull the relevant files from the latest Embree release and apply some automatic changes.

Some changes have been made in order to remove exceptions and fix minor build errors. They are marked with // -- GODOT start -- and // -- GODOT end -- comments. Apply the patches in the patches/ folder when syncing on newer upstream commits.

enet

  • Upstream: http://enet.bespin.org
  • Version: 1.3.17 (e0e7045b7e056b454b5093cb34df49dc4cee0bee, 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's socket implementation and allow IPv6 and DTLS. Apply the patches in the patches/ folder when syncing on newer upstream commits.

Three files (godot.cpp, enet/godot.h, enet/godot_ext.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.

etcpak

Files extracted from upstream source:

  • Only the files relevant for compression (i.e. Process*.cpp and their deps): 
    Dither.{cpp,hpp} ForceInline.hpp Math.hpp ProcessCommon.hpp ProcessRGB.{cpp,hpp}
ProcessDxtc.{cpp,hpp} Tables.{cpp,hpp} Vector.hpp
  • AUTHORS.txt and LICENSE.txt

fonts

freetype

  • Upstream: https://www.freetype.org
  • Version: 2.12.1 (e8ebfe988b5f57bfb9a3ecb13c70d9791bce9ecf, 2022)
  • License: FreeType License (BSD-like)

Files extracted from upstream source:

  • the src/ folder, minus the .mk files and the dlg and tools subfolders
  • the include/ folder, minus the dlg subfolder
  • LICENSE.TXT and docs/FTL.TXT

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

When updating, also review that our modules/glslang/glslang_resource_limits.h copy of DefaultTBuiltInResource is in sync with the one defined upstream in StandAlone/ResourceLimits.cpp.

Files extracted from upstream source:

  • glslang (except glslang/HLSL and glslang/ExtensionHeaders), OGLCompilersDLL, SPIRV, w/o CInterface folders (depend on StandAlone)
  • Run cmake . && make and copy generated include/glslang/build_info.h to glslang/build_info.h
  • LICENSE.txt
  • Unnecessary files like CMakeLists.txt, *.m4 and updateGrammar removed.

graphite

Files extracted from upstream source:

  • the include folder
  • the src folder (minus CMakeLists.txt and files.mk)
  • COPYING

harfbuzz

Files extracted from upstream source:

  • the src folder
  • AUTHORS, COPYING, THANKS

icu4c

Files extracted from upstream source:

  • the common folder
  • LICENSE

Files generated from upstream source:

  • the icudt71l.dat built with the provided godot_data.json config file (see https://github.com/unicode-org/icu/blob/master/docs/userguide/icu_data/buildtool.md for instructions).

  • Step 1: Build ICU with default options - ./runConfigureICU {PLATFORM} && make.

  • Step 2: Reconfigure ICU with custom data config - ICU_DATA_FILTER_FILE={GODOT_SOURCE}/thirdparty/icu4c/godot_data.json ./runConfigureICU {PLATFORM} --with-data-packaging=common.

  • Step 3: Delete data/out folder and rebuild data - cd data && rm -rf ./out && make.

  • Step 4: Copy source/data/out/icudt71l.dat to the {GODOT_SOURCE}/thirdparty/icu4c/icudt71l.dat.

jpeg-compressor

Files extracted from upstream source:

  • jpgd*.{c,h}

libogg

  • Upstream: https://www.xiph.org/ogg
  • Version: 1.3.5 (e1774cd77f471443541596e09078e78fdc342e4f, 2021)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • src/*.{c,h}
  • include/ogg/*.h in ogg/ (run configure to generate config_types.h)
  • COPYING

libpng

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

libtheora

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

Files extracted from upstream source:

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

libwebp

Files extracted from upstream source:

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

mbedtls

  • Upstream: https://tls.mbed.org/
  • Version: 2.16.12 (cf4667126010c665341f9e50ef691b7ef8294188, 2021)
  • License: Apache 2.0

File extracted from upstream release tarball:

  • All *.h from include/mbedtls/ to thirdparty/mbedtls/include/mbedtls/ except config_psa.h and psa_util.h.
  • All *.c and *.h from library/ to thirdparty/mbedtls/library/ except those starting with psa_*.
  • LICENSE and apache-2.0.txt files.
  • Applied the patch in patches/1453.diff (upstream PR: https://github.com/ARMmbed/mbedtls/pull/1453).
  • Added 2 files godot_core_mbedtls_platform.c and godot_core_mbedtls_config.h providing configuration for light bundling with core.

meshoptimizer

Files extracted from upstream repository:

  • All files in src/.
  • LICENSE.md.

An experimental upstream feature, has been backported. On top of that, it was modified to report only distance error metrics instead of a combination of distance and attribute errors. Patches for both changes can be found in the patches directory.

minimp3

Files extracted from upstream repository:

  • minimp3.h
  • minimp3_ex.h
  • LICENSE

miniupnpc

Files extracted from upstream source:

  • Copy miniupnpc/src and miniupnpc/include to thirdparty/miniupnpc
  • Remove the following test or sample files: listdevices.c minihttptestserver.c miniupnpcmodule.c upnpc.c upnperrors.* test*
  • LICENSE

The only modified file is src/miniupnpcstrings.h, which was created for Godot (it is usually autogenerated by cmake). Bump the version number for miniupnpc in that file when upgrading.

minizip

Files extracted from the upstream source:

  • contrib/minizip/{crypt.h,ioapi.{c,h},unzip.{c,h},zip.{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 patches folder.

misc

Collection of single-file libraries used in Godot components.

msdfgen

Files extracted from the upstream source:

  • msdfgen.h
  • Files in core/ folder.
  • LICENSE.txt and CHANGELOG.md

oidn

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)

openxr

Files extracted from upstream source:

  • include/
  • src/common/
  • src/loader/
  • src/*.{c,h}
  • src/external/jsoncpp/include/
  • src/external/jsoncpp/src/lib_json/
  • LICENSE and COPYING.adoc

Exclude:

  • src/external/android-jni-wrappers and src/external/jnipp (not used yet)
  • All CMake stuff: cmake/, CMakeLists.txt and *.cmake
  • All Gradle stuff: gradle, AndroidManifest.xml
  • All following files (and their .license files): *.{def,in,json,map,pom,rc}

pcre2

  • Upstream: http://www.pcre.org
  • Version: 10.40 (3103b8f20a3b9944b177e812fde29fbfb8b90558, 2022)
  • 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

recastnavigation

Files extracted from upstream source:

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

rvo2

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.

spirv-reflect

Does not track Vulkan SDK releases closely, but try to package a commit newer than the matching glslang and Vulkan headers, just in case.

Files extracted from upstream source:

  • spirv_reflect.{c,h}
  • include folder
  • LICENSE

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

squish

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

Files extracted from upstream source:

  • tinyexr.{cc,h}

The tinyexr.cc file was modified to include zlib.h which we provide, instead of miniz.h as an external dependency.

thorvg

Files extracted from upstream source:

See thorvg/update-thorvg.sh for extraction instructions. Set the version number and run the script.

vhacd

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.

volk

Unless there is a specific reason to package a more recent version, please stick to tagged releases. All Vulkan libraries and headers should be kept in sync so:

  • Update Vulkan SDK components to the matching tag (see "vulkan").
  • Update glslang (see "glslang").
  • Update spirv-reflect (see "spirv-reflect").

Files extracted from upstream source:

  • volk.h, volk.c
  • LICENSE.md

vulkan

The vendored version should be kept in sync with volk, see above.

Files extracted from upstream source:

  • include/
  • 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

vk_mem_alloc.h is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator Version: 3.0.1-development (2022-03-28), commit 5b598e0a359381d7e2a94149210a1b7642024ae5 vk_mem_alloc.cpp is a Godot file and should be preserved on updates.

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

wslay

File extracted from upstream release tarball:

  • Run cmake . to generate config.h and wslayver.h. Contents might need tweaking for Godot, review diff.
  • All *.c and *.h files from lib/
  • All *.h in lib/includes/wslay/ as wslay/
  • wslay/wslay.h has a small Godot addition to fix MSVC build. See patches/msvcfix.diff
  • COPYING

xatlas

Files extracted from upstream source:

  • source/xatlas/xatlas.{cpp,h}
  • LICENSE

zlib

Files extracted from upstream source:

  • all .c and .h files

zstd

Files extracted from upstream source:

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