godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
d022f361d3
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.

basis_universal

Files extracted from upstream source:

  • encoder/ and transcoder/ folders
  • LICENSE

bullet

Files extracted from upstream source:

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

certs

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

Files extracted from upstream source:

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

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.10.4 (6a2b3e4007e794bfc6c91030d0ed987f925164a8, 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}

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 (except glslang/HLSL), OGLCompilersDLL, SPIRV
  • StandAlone/{DirStackFileIncluder.h,ResourceLimits.{cpp,h}}
  • Run cmake . && make and copy generated include/glslang/build_info.h to glslang/build_info.h
  • LICENSE.txt
  • Unnecessary files like CMakeLists.txt and updateGrammar removed.

graphite

Files extracted from upstream source:

  • the include folder
  • the src folder
  • COPYING, ChangeLog

harfbuzz

Files extracted from upstream source:

  • the src folder
  • AUTHORS, COPYING, NEWS, THANKS

icu4c

Files extracted from upstream source:

  • the common folder
  • LICENSE

Files generated from upstream source:

jpeg-compressor

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

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

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

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:

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

libvpx

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

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.10 (d61fa61bef06b64132e3490543c81b8ee40fbee3, 2021)
  • 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.

meshoptimizer

Files extracted from upstream repository:

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

An experimental upstream feature, has been backported, see patch in patches directory.

miniupnpc

Files extracted from upstream source:

  • All *.c and *.h files from miniupnpc to thirdparty/miniupnpc/miniupnpc
  • Remove the following test or sample files: listdevices.c minihttptestserver.c miniupnpcmodule.c upnpc.c upnperrors.* test* wingenminiupnpcstrings.c
  • LICENSE

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

Note: The following upstream patch has been applied, remove this notice on next update. 3a08dd4b89

minizip

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.

nanosvg

Files extracted from the upstream source:

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

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)

opus

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

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

Files extracted from upstream source:

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

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

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}

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.

vulkan

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

vk_mem_alloc.h is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator Version: 2.3.0 (2019) vk_mem_alloc.cpp and android/vk_mem_alloc.cpp are Godot files and should be preserved on updates.

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

wslay

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

Files extracted from upstream source:

  • 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}
  • LICENSE