virtualx-engine/thirdparty/README.md
2022-05-18 11:57:15 +02:00

16 KiB
Vendored

Third party libraries

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

brotli

Files extracted from upstream source:

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

bullet

Files extracted from upstream source:

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

Includes some patches in the patches folder which have been sent upstream.

certs

cvtt

Files extracted from upstream source:

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

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.

etc2comp

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

freetype

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

Files extracted from upstream source:

  • src/ folder, minus the dlg and tools subfolders
    • These files can be removed: .dat, .diff, .mk, .rc, README*
  • include/ folder, minus the dlg subfolder
  • LICENSE.TXT and docs/FTL.TXT

glad

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.

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

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:

  • lib/* 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

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.

minimp3

Files extracted from upstream repository:

  • minimp3.h
  • minimp3_ex.h
  • LICENSE

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},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.

nanosvg

Files extracted from the upstream source:

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

nanosvg.cc is a custom file added to configure the build of the header only library.

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

  • 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

A sljit patch from upstream was backported to fix macOS < 11.0 compilation in 10.40, it can be found in the patches folder.

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.

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.

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.

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