Merge pull request #75 from Faless/bump/beta8

Bump godot-cpp to beta8, libdatachannel to v0.18.0

.github/workflows/build_release.yml

@@ -177,7 +177,9 @@ jobs:
       - uses: actions/upload-artifact@v3
         with:
           name: ${{ github.job }}-${{ matrix.platform }}-${{ matrix.arch }}
-          path: bin/*
+          path: |
+            bin/
+            !bin/thirdparty/
 
   package:
     name: 📦 Package
@@ -195,13 +197,13 @@ jobs:
       - name: Bundle licenses.
         run: |
           cp LICENSE artifacts/LICENSE.webrtc-native
-          cp deps/libdatachannel/LICENSE artifacts/LICENSE.libdatachannel
-          cp deps/openssl/LICENSE.txt artifacts/LICENSE.openssl
-          cp deps/libdatachannel/deps/libjuice/LICENSE artifacts/LICENSE.libjuice
-          cp deps/libdatachannel/deps/usrsctp/LICENSE.md artifacts/LICENSE.usrsctp
-          cp deps/libdatachannel/deps/libsrtp/LICENSE artifacts/LICENSE.libsrtp
-          cp deps/libdatachannel/deps/json/LICENSE.MIT artifacts/LICENSE.json
-          cp deps/libdatachannel/deps/plog/LICENSE artifacts/LICENSE.plog
+          cp thirdparty/libdatachannel/LICENSE artifacts/LICENSE.libdatachannel
+          cp thirdparty/openssl/LICENSE.txt artifacts/LICENSE.openssl
+          cp thirdparty/libdatachannel/deps/libjuice/LICENSE artifacts/LICENSE.libjuice
+          cp thirdparty/libdatachannel/deps/usrsctp/LICENSE.md artifacts/LICENSE.usrsctp
+          cp thirdparty/libdatachannel/deps/libsrtp/LICENSE artifacts/LICENSE.libsrtp
+          cp thirdparty/libdatachannel/deps/json/LICENSE.MIT artifacts/LICENSE.json
+          cp thirdparty/libdatachannel/deps/plog/LICENSE artifacts/LICENSE.plog
 
       - name: Package artifacts for release
         env:

.gitmodules

@@ -5,8 +5,8 @@
 	path = godot-cpp
 	url = https://github.com/godotengine/godot-cpp.git
 [submodule "libdatachannel"]
-	path = deps/libdatachannel
+	path = thirdparty/libdatachannel
 	url = https://github.com/paullouisageneau/libdatachannel.git
 [submodule "openssl"]
-	path = deps/openssl
+	path = thirdparty/openssl
 	url = https://github.com/openssl/openssl.git

README.md

@@ -45,6 +45,4 @@ You simply need to copy that folder to the root folder of your project. Note tha
 
 ### License
 
-The `webrtc-native` plugin is licensed under the MIT license (see [LICENSE](https://github.com/godotengine/webrtc-native/blob/master/LICENSE)), while `libdatachannel` and one of its dependencies (`libjuice`) are licensed under LGPLv2.1 or later, see [libdatachannel LICENSE](https://github.com/paullouisageneau/libdatachannel/blob/master/LICENSE) and [libjuice LICENSE](https://github.com/paullouisageneau/libjuice/blob/master/LICENSE).
-
-Make sure you understand and comply with the LGPLv2.1 license when redistributing this plugin.
+The `webrtc-native` plugin is licensed under the MIT license (see [LICENSE](https://github.com/godotengine/webrtc-native/blob/master/LICENSE)), while `libdatachannel` and its dependencies are licensed under other permissive open source licences. Please see [`thirdparty/README.md`](thirdparty/README.md) for more informations.

SConstruct

@@ -79,6 +79,15 @@ else:
     ARGUMENTS["ios_min_version"] = "11.0"
     env = SConscript("godot-cpp/SConstruct").Clone()
 
+# Should probably go to upstream godot-cpp.
+# We let SCons build its default ENV as it includes OS-specific things which we don't
+# want to have to pull in manually.
+# Then we prepend PATH to make it take precedence, while preserving SCons' own entries.
+env.PrependENVPath("PATH", os.getenv("PATH"))
+env.PrependENVPath("PKG_CONFIG_PATH", os.getenv("PKG_CONFIG_PATH"))
+if "TERM" in os.environ: # Used for colored output.
+    env["ENV"]["TERM"] = os.environ["TERM"]
+
 # Patch mingw SHLIBSUFFIX.
 if env["platform"] == "windows" and env["use_mingw"]:
     env["SHLIBSUFFIX"] = ".dll"
@@ -92,7 +101,6 @@ else:
     result_path = os.path.join("bin", "extension", "webrtc")
 
 # Dependencies
-deps_source_dir = "deps"
 env.Append(BUILDERS={
     "BuildOpenSSL": env.Builder(action=builders.ssl_action, emitter=builders.ssl_emitter),
     "BuildLibDataChannel": env.Builder(action=builders.rtc_action, emitter=builders.rtc_emitter),
@@ -100,22 +108,24 @@ env.Append(BUILDERS={
 
 # SSL
 ssl = env.BuildOpenSSL(env.Dir(builders.get_ssl_build_dir(env)), env.Dir(builders.get_ssl_source_dir(env)))
-env.Depends(ssl, env.File("builders.py"))
+env.Depends(ssl, [env.File("builders.py"), env.File(builders.get_ssl_source_dir(env) + "/VERSION.dat")])
+env.NoCache(ssl) # Needs refactoring to properly cache generated headers.
 
 env.Prepend(CPPPATH=[builders.get_ssl_include_dir(env)])
 env.Prepend(LIBPATH=[builders.get_ssl_build_dir(env)])
-env.Append(LIBS=[ssl])
+env.Append(LIBS=[builders.get_ssl_libs(env)])
 
 # RTC
 rtc = env.BuildLibDataChannel(env.Dir(builders.get_rtc_build_dir(env)), [env.Dir(builders.get_rtc_source_dir(env))] + ssl)
-env.Depends(rtc, env.File("builders.py"))
+env.Depends(rtc, [env.File("builders.py"), env.File(builders.get_rtc_source_dir(env) + "/CMakeLists.txt")])
 
 env.Append(LIBPATH=[builders.get_rtc_build_dir(env)])
 env.Append(CPPPATH=[builders.get_rtc_include_dir(env)])
-env.Prepend(LIBS=[rtc])
+env.Prepend(LIBS=[builders.get_rtc_libs(env)])
 
 # Our includes and sources
 env.Append(CPPPATH=["src/"])
+env.Append(CPPDEFINES=["RTC_STATIC"])
 sources = []
 sources.append(
     [
@@ -130,7 +140,7 @@ else:
     sources.append("src/init_gdnative.cpp")
     add_sources(sources, "src/net/", "cpp")
 
-env.Depends(sources, [ssl, rtc])
+env.Depends(sources, [builders.get_ssl_libs(env), builders.get_rtc_libs(env)])
 
 # Make the shared library
 result_name = "webrtc_native{}{}".format(env["suffix"], env["SHLIBSUFFIX"])

builders.py

@@ -1,4 +1,5 @@
 import os
+from SCons.Defaults import Mkdir
 from SCons.Script import Environment
 
 
@@ -7,11 +8,11 @@ def get_android_api(env):
 
 
 def get_deps_dir(env):
-    return env.Dir("#deps").abspath
+    return env.Dir("#thirdparty").abspath
 
 
 def get_deps_build_dir(env):
-    return get_deps_dir(env) + "/build/build{}.{}.dir".format(env["suffix"], "RelWithDebInfo" if env["debug_symbols"] else "Release")
+    return env.Dir("#bin/thirdparty").abspath + "/{}.{}.dir".format(env["suffix"][1:], "RelWithDebInfo" if env["debug_symbols"] else "Release")
 
 
 def get_rtc_source_dir(env):
@@ -26,6 +27,17 @@ def get_rtc_include_dir(env):
     return get_rtc_source_dir(env) + "/include"
 
 
+def get_rtc_libs(env):
+    bdir = get_rtc_build_dir(env)
+    libs = [
+        "libdatachannel-static.a",
+        "deps/libjuice/libjuice-static.a",
+        "deps/libsrtp/libsrtp2.a",
+        "deps/usrsctp/usrsctplib/libusrsctp.a"
+    ]
+    return [env.File(bdir + "/" + lib) for lib in libs]
+
+
 def get_ssl_source_dir(env):
     return get_deps_dir(env) + "/openssl"
 
@@ -42,19 +54,20 @@ def get_ssl_include_dir(env):
     return get_ssl_install_dir(env) + "/include"
 
 
+def get_ssl_libs(env):
+    bdir = get_ssl_build_dir(env)
+    return [env.File(bdir + "/" + lib) for lib in ["libssl.a", "libcrypto.a"]]
+
+
 def ssl_emitter(target, source, env):
-    build_dir = get_ssl_build_dir(env)
-    libs = ["libssl.a", "libcrypto.a"]
-    install_dir = get_ssl_install_dir(env)
-    ssl_include = os.path.join(source[0].abspath, "include")
-    return [env.File(build_dir + "/" + l) for l in libs], source
+    return get_ssl_libs(env), source
 
 
 def ssl_action(target, source, env):
     build_dir = get_ssl_build_dir(env)
     source_dir = source[0].abspath
 
-    ssl_env = Environment()
+    ssl_env = env.Clone()
     install_dir = get_ssl_install_dir(env)
     args = [
         "no-ssl3",
@@ -126,8 +139,8 @@ def ssl_action(target, source, env):
 
     jobs = env.GetOption("num_jobs")
     ssl_env.Execute([
-            "mkdir -p " + build_dir, # TODO python?
-            ("cd %s && %s/Configure " % (build_dir, source_dir)) + " ".join(args),
+            Mkdir(build_dir),
+            "cd %s && perl %s/Configure %s" % (build_dir, source_dir, " ".join(['"%s"' % a for a in args])),
             "make -C %s -j%s" % (build_dir, jobs),
             "make -C %s install_sw install_ssldirs -j%s" % (build_dir, jobs),
         ]
@@ -136,28 +149,20 @@ def ssl_action(target, source, env):
 
 
 def rtc_emitter(target, source, env):
-    build_dir = get_rtc_build_dir(env)
-    libs = ["libdatachannel-static.a", "libjuice-static.a", "libsrtp2.a", "libusrsctp.a"]
-    lib_paths = [
-        build_dir,
-        os.path.join(build_dir, "deps/libjuice"),
-        os.path.join(build_dir, "deps/libsrtp"),
-        os.path.join(build_dir, "deps/usrsctp/usrsctplib"),
-    ]
-    return [env.File(lib_paths[i] + "/" + libs[i]) for i in range(len(libs))], source
+    return get_rtc_libs(env), source
 
 
 def rtc_action(target, source, env):
     build_dir = get_rtc_build_dir(env)
     source_dir = source[0].abspath
     args = [
+        "cmake",
         "-B",
         build_dir,
         "-DUSE_NICE=0",
         "-DNO_WEBSOCKET=1",
         #"-DNO_MEDIA=1", # Windows builds fail without it.
         "-DNO_EXAMPLES=1",
-        "-DNO_WEBSOCKET=1",
         "-DNO_TESTS=1",
         "-DOPENSSL_USE_STATIC_LIBS=1",
         "-DOPENSSL_INCLUDE_DIR=%s" % get_ssl_include_dir(env),
@@ -215,7 +220,8 @@ def rtc_action(target, source, env):
         if env["arch"] == "x86_32":
             if env["use_mingw"]:
                 args.extend([
-                    "-G 'Unix Makefiles'",
+                    "-G",
+                    "Unix Makefiles",
                     "-DCMAKE_C_COMPILER=i686-w64-mingw32-gcc",
                     "-DCMAKE_CXX_COMPILER=i686-w64-mingw32-g++",
                     "-DCMAKE_SYSTEM_NAME=Windows",
@@ -223,7 +229,8 @@ def rtc_action(target, source, env):
         else:
             if env["use_mingw"]:
                 args.extend([
-                    "-G 'Unix Makefiles'",
+                    "-G",
+                    "Unix Makefiles",
                     "-DCMAKE_C_COMPILER=x86_64-w64-mingw32-gcc",
                     "-DCMAKE_CXX_COMPILER=x86_64-w64-mingw32-g++",
                     "-DCMAKE_SYSTEM_NAME=Windows"
@@ -231,10 +238,10 @@ def rtc_action(target, source, env):
 
     args.append(source_dir)
     jobs = env.GetOption("num_jobs")
-    rtc_env = Environment()
+    rtc_env = env.Clone()
     rtc_env.Execute([
-            "cmake " + " ".join(args),
-            "cmake --build %s -t datachannel-static -j%s" % (build_dir, jobs),
+            " ".join(['"%s"' % a for a in args]),
+            "cmake --build %s -t datachannel-static -j%s" % (build_dir, jobs)
         ]
     )
     return None

misc/webrtc.gdextension

@@ -6,8 +6,8 @@ entry_symbol = "webrtc_extension_init"
 
 linux.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.linux.template_debug.x86_64.so"
 linux.debug.x86_32 = "res://webrtc/lib/libwebrtc_native.linux.template_debug.x86_32.so"
-osx.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.osx.template_debug.x86_64.dylib"
-osx.debug.arm64 = "res://webrtc/lib/libwebrtc_native.osx.template_debug.arm64.dylib"
+macos.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.macos.template_debug.x86_64.dylib"
+macos.debug.arm64 = "res://webrtc/lib/libwebrtc_native.macos.template_debug.arm64.dylib"
 windows.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.windows.template_debug.x86_64.dll"
 windows.debug.x86_32 = "res://webrtc/lib/libwebrtc_native.windows.template_debug.x86_32.dll"
 android.debug.arm64 = "res://webrtc/lib/libwebrtc_native.android.template_debug.arm64.so"
@@ -17,8 +17,8 @@ ios.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.ios.template_debug.x86_64.
 
 linux.release.x86_64 = "res://webrtc/lib/libwebrtc_native.linux.template_release.x86_64.so"
 linux.release.x86_32 = "res://webrtc/lib/libwebrtc_native.linux.template_release.x86_32.so"
-osx.release.x86_64 = "res://webrtc/lib/libwebrtc_native.osx.template_release.x86_64.dylib"
-osx.release.arm64 = "res://webrtc/lib/libwebrtc_native.osx.template_release.arm64.dylib"
+macos.release.x86_64 = "res://webrtc/lib/libwebrtc_native.macos.template_release.x86_64.dylib"
+macos.release.arm64 = "res://webrtc/lib/libwebrtc_native.macos.template_release.arm64.dylib"
 windows.release.x86_64 = "res://webrtc/lib/libwebrtc_native.windows.template_release.x86_64.dll"
 windows.release.x86_32 = "res://webrtc/lib/libwebrtc_native.windows.template_release.x86_32.dll"
 android.release.arm64 = "res://webrtc/lib/libwebrtc_native.android.template_release.arm64.so"

thirdparty/README.md

@@ -0,0 +1,82 @@
+# Third party libraries
+
+Please keep categories (`##` level) listed alphabetically and matching their
+respective folder names. Use two empty lines to separate categories for
+readability.
+
+
+## json
+
+- Upstream: https://github.com/nlohmann/json
+- Version: 3.10.5 (4f8fba14066156b73f1189a2b8bd568bde5284c5, 2022)
+- License: MIT
+
+Module location:
+
+- thirdparty/libdatachannel/deps/json
+
+
+## libdatachannel
+
+- Upstream: https://github.com/paullouisageneau/libdatachannel
+- Version: 0.18.0 (084445012d6c63c9f2cc250d88df553aed2eb189, 2022)
+- License: MPL 2.0
+
+Module location:
+
+- thirdparty/libdatachannel
+
+
+# libjuice
+
+- Upstream: https://github.com/paullouisageneau/libjuice
+- Version: 1.1.0 (0dabc046cd23da6908749e4c6add834ec29a7c49, 2022)
+- License: MPL 2.0
+
+Module location:
+
+- thirdparty/libdatachannel/deps/libjuice
+
+
+## libsrtp
+
+- Upstream: https://github.com/cisco/libsrtp
+- Version: 2.4.2 (90d05bf8980d16e4ac3f16c19b77e296c4bc207b, 2021)
+- License: BSD-3-Clause
+
+Module location:
+
+- thirdparty/libdatachannel/deps/libsrtp
+
+
+## openssl
+
+- Upstream: git://git.openssl.org/openssl.git
+- Version: 3.0.7 (19cc035b6c6f2283573d29c7ea7f7d675cf750ce, 2022)
+- License: Apache 2.0
+
+Module location:
+
+- thirdparty/openssl
+
+
+## plog
+
+- Upstream: https://github.com/SergiusTheBest/plog
+- Version: git (d8461e9d473e59fbcc1f79eee021550dcf81e618, 2021)
+- License: MPL 2.0
+
+Module location:
+
+- thirdparty/libdatachannel/deps/plog
+
+
+## usrsctp
+
+- Upstream: https://github.com/sctplab/usrsctp
+- Version: git (7c31bd35c79ba67084ce029511193a19ceb97447, 2021)
+- License: BSD-3-Clause
+
+Module location:
+
+- thirdparty/libdatachannel/deps/usrsctp