Merge pull request #65 from Faless/bump/beta3

[Upstream] Update to Godot Beta 3

.github/workflows/build_release.yml

@@ -1,13 +1,17 @@
 name: 🔧 Build -> Package 📦
 on: [push, pull_request]
 
+env:
+  # Only used for the cache key. Increment version to force clean build.
+  GODOT_BASE_BRANCH: master
+
 jobs:
   static-checks:
     name: 📊 Static Checks (clang-format, black format, file format)
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Install dependencies
         run: |
@@ -42,24 +46,27 @@ jobs:
             gdnative_flags: 'android_arch=x86_64'
             sconsflags: ''
             os: 'ubuntu-20.04'
+            cache-name: android-x86_64
           - platform: android
             arch: 'arm64'
             gdnative_flags: 'android_arch=arm64v8'
             sconsflags: ''
             os: 'ubuntu-20.04'
+            cache-name: android-arm64
 
           # iOS
           - platform: ios
             arch: 'x86_64'
             gdnative_flags: 'ios_arch=x86_64'
             sconsflags: 'ios_simulator=true'
-            os: 'macos-latest'
+            os: 'macos-11'
+            cache-name: ios-x86_64-simulator
           - platform: ios
             arch: 'arm64'
             gdnative_flags: 'ios_arch=arm64'
             sconsflags: ''
             os: 'macos-11'
-
+            cache-name: ios-arm64
 
           # Linux
           - platform: linux
@@ -67,11 +74,13 @@ jobs:
             gdnative_flags: 'bits=32'
             sconsflags: ''
             os: 'ubuntu-20.04'
+            cache-name: linux-x86_32
           - platform: linux
             arch: 'x86_64'
             gdnative_flags: 'bits=64'
             sconsflags: ''
             os: 'ubuntu-20.04'
+            cache-name: linux-x86_64
 
           # macOS
           - platform: macos
@@ -79,11 +88,13 @@ jobs:
             gdnative_flags: 'macos_arch=x86_64 bits=64'
             sconsflags: ''
             os: 'macos-11'
+            cache-name: macos-x86_64
           - platform: macos
             gdnative_flags: 'macos_arch=arm64 bits=64'
             arch: 'arm64'
             sconsflags: ''
             os: 'macos-11'
+            cache-name: macos-arm64
 
           # Windows
           - platform: windows
@@ -92,14 +103,17 @@ jobs:
             sconsflags: 'use_mingw=yes'
             os: 'ubuntu-20.04'
             msvc_arch: amd64_x86
+            cache-name: win-x86_32
           - platform: windows
             arch: 'x86_64'
             gdnative_flags: 'bits=64'
             sconsflags: 'use_mingw=yes'
             os: 'ubuntu-20.04'
             msvc_arch: amd64
+            cache-name: win-x86_64
 
     env:
+      SCONS_CACHE: ${{ github.workspace }}/.scons-cache/
       SCONSFLAGS: ${{ matrix.sconsflags }} platform=${{ matrix.platform }} arch=${{ matrix.arch }} --jobs=2
 
     defaults:
@@ -107,10 +121,16 @@ jobs:
         shell: bash
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: recursive
 
+      - name: Setup Godot build cache
+        uses: ./godot-cpp/.github/actions/godot-cache
+        with:
+          cache-name: ${{ matrix.cache-name }}
+        continue-on-error: true
+
       - name: Install Windows build dependencies
         if: ${{ matrix.platform == 'windows' }}
         run: |
@@ -129,7 +149,7 @@ jobs:
           sudo apt-get install build-essential gcc-multilib g++-multilib
 
       - name: Set up Python 3.x
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: '3.x'
           architecture: 'x64'
@@ -142,21 +162,17 @@ jobs:
           scons --version
           cmake --version
 
-      - name: Compile Extension - debug - ${{ matrix.platform }} - ${{ matrix.arch }}
+      - name: Compile Extension - template_debug - ${{ matrix.platform }} - ${{ matrix.arch }}
         run: |
-          scons target=debug generate_bindings=yes
+          scons target=template_debug generate_bindings=yes
 
-      - name: Compile GDNative - debug - ${{ matrix.platform }} - ${{ matrix.arch }}
+      - name: Compile Extension - template_release - ${{ matrix.platform }} - ${{ matrix.arch }}
         run: |
-          scons target=debug generate_bindings=yes ${{ matrix.gdnative_flags }} godot_version=3
-
-      - name: Compile Extension - release - ${{ matrix.platform }} - ${{ matrix.arch }}
-        run: |
-          scons target=release
+          scons target=template_release
 
       - name: Compile GDNative - release ${{ matrix.platform }} - ${{ matrix.arch }}
         run: |
-          scons target=release ${{ matrix.gdnative_flags }} godot_version=3
+          scons target=release generate_bindings=yes ${{ matrix.gdnative_flags }} godot_version=3
 
       - uses: actions/upload-artifact@v3
         with:
@@ -168,7 +184,7 @@ jobs:
     needs: build
     runs-on: "ubuntu-latest"
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: recursive
 
@@ -188,28 +204,15 @@ jobs:
           cp deps/libdatachannel/deps/plog/LICENSE artifacts/LICENSE.plog
 
       - name: Package artifacts for release
+        env:
+          DESTINATION: "release"
         run: |
           mkdir release
-          cd release
 
-          ls -R
+          VERSION="extension" TYPE="webrtc" ./misc/scripts/package_release.sh
+          VERSION="gdnative" TYPE="webrtc" ./misc/scripts/package_release.sh
 
-          for version in extension gdnative
-          do
-            for name in webrtc webrtc_debug
-            do
-              destdir="${version}/${name}"
-              mkdir -p ${destdir}/lib
-              find ../artifacts -wholename "*/${destdir}/lib/*" | xargs cp -t ${destdir}/lib/
-              find ../artifacts -wholename "*/${destdir}/${name}.tres" -or -wholename "*/${destdir}/${name}.gdextension" | head -n 1 | xargs cp -t ${destdir}/
-              find ../artifacts -wholename "*/LICENSE*" | xargs cp -t ${destdir}/
-              cd ${version}
-              zip -r ../godot-${version}-${name}.zip ${name}
-              cd ..
-            done
-          done
-
-          ls -R
+          ls -R release
 
       - uses: actions/upload-artifact@v3
         with:

SConstruct

@@ -26,6 +26,11 @@ if env["godot_version"] == "3":
     if "platform" in ARGUMENTS and ARGUMENTS["platform"] == "macos":
         ARGUMENTS["platform"] = "osx"  # compatibility with old osx name
 
+    scons_cache_path = os.environ.get("SCONS_CACHE")
+    if scons_cache_path is not None:
+        CacheDir(scons_cache_path)
+        Decider("MD5")
+
     env = SConscript("godot-cpp-3.x/SConstruct")
 
     # Patch base env
@@ -52,7 +57,7 @@ if env["godot_version"] == "3":
     if env["platform"] in ["windows", "linux"]:
         env["arch"] = "x86_32" if env["bits"] == "32" else "x86_64"
         env["arch_suffix"] = env["arch"]
-    elif env["platform"] == "osx":
+    elif env["platform"] == "macos":
         env["arch"] = env["macos_arch"]
         env["arch_suffix"] = env["arch"]
     elif env["platform"] == "ios":
@@ -66,6 +71,10 @@ if env["godot_version"] == "3":
             "x86_64": "x86_64",
         }[env["android_arch"]]
         env["arch_suffix"] = env["arch"]
+
+    target_compat = "template_" + env["target"]
+    env["suffix"] = ".{}.{}.{}".format(env["platform"], target_compat, env["arch_suffix"])
+    env["debug_symbols"] = False
 else:
     ARGUMENTS["ios_min_version"] = "11.0"
     env = SConscript("godot-cpp/SConstruct").Clone()
@@ -77,7 +86,10 @@ if env["platform"] == "windows" and env["use_mingw"]:
 opts.Update(env)
 
 target = env["target"]
-result_path = os.path.join("bin", "gdnative" if env["godot_version"] == "3" else "extension", "webrtc" if env["target"] == "release" else "webrtc_debug")
+if env["godot_version"] == "3":
+    result_path = os.path.join("bin", "gdnative", "webrtc" if env["target"] == "release" else "webrtc_debug")
+else:
+    result_path = os.path.join("bin", "extension", "webrtc")
 
 # Dependencies
 deps_source_dir = "deps"
@@ -88,6 +100,7 @@ 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.Prepend(CPPPATH=[builders.get_ssl_include_dir(env)])
 env.Prepend(LIBPATH=[builders.get_ssl_build_dir(env)])
@@ -95,6 +108,7 @@ env.Append(LIBS=[ssl])
 
 # 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.Append(LIBPATH=[builders.get_rtc_build_dir(env)])
 env.Append(CPPPATH=[builders.get_rtc_include_dir(env)])
@@ -119,7 +133,7 @@ else:
 env.Depends(sources, [ssl, rtc])
 
 # Make the shared library
-result_name = "webrtc_native.{}.{}.{}{}".format(env["platform"], env["target"], env["arch_suffix"], env["SHLIBSUFFIX"])
+result_name = "webrtc_native{}{}".format(env["suffix"], env["SHLIBSUFFIX"])
 env.Depends(sources, ssl)
 
 if env["platform"] == "windows" and env["use_mingw"]:
@@ -129,12 +143,13 @@ library = env.SharedLibrary(target=os.path.join(result_path, "lib", result_name)
 Default(library)
 
 # GDNativeLibrary
-gdnlib = "webrtc"
-if target != "release":
-    gdnlib += "_debug"
-ext = ".tres" if env["godot_version"] == "3" else ".gdextension"
-extfile = env.Substfile(os.path.join(result_path, gdnlib + ext), "misc/webrtc" + ext, SUBST_DICT={
-    "{GDNATIVE_PATH}": gdnlib,
-    "{TARGET}": env["target"],
-})
+if env["godot_version"] == "3":
+    gdnlib = "webrtc" if target != "debug" else "webrtc_debug"
+    ext = ".tres"
+    extfile = env.Substfile(os.path.join(result_path, gdnlib + ext), "misc/webrtc" + ext, SUBST_DICT={
+        "{GDNATIVE_PATH}": gdnlib,
+        "{TARGET}": "template_" + env["target"],
+    })
+else:
+    extfile = env.InstallAs(os.path.join(result_path, "webrtc.gdextension"), "misc/webrtc.gdextension")
 Default(extfile)

builders.py

@@ -11,7 +11,7 @@ def get_deps_dir(env):
 
 
 def get_deps_build_dir(env):
-    return get_deps_dir(env) + "/build/{}.{}.{}.dir".format(env["platform"], env["target"], env["arch_suffix"])
+    return get_deps_dir(env) + "/build/build{}.{}.dir".format(env["suffix"], "RelWithDebInfo" if env["debug_symbols"] else "Release")
 
 
 def get_rtc_source_dir(env):
@@ -63,7 +63,7 @@ def ssl_action(target, source, env):
         "--prefix=%s" % install_dir,
         "--openssldir=%s" % install_dir,
     ]
-    if env["target"] == "debug":
+    if env["debug_symbols"]:
         args.append("-d")
 
     if env["platform"] != "windows":
@@ -163,7 +163,7 @@ def rtc_action(target, source, env):
         "-DOPENSSL_INCLUDE_DIR=%s" % get_ssl_include_dir(env),
         "-DOPENSSL_SSL_LIBRARY=%s/libssl.a" % get_ssl_build_dir(env),
         "-DOPENSSL_CRYPTO_LIBRARY=%s/libcrypto.a" % get_ssl_build_dir(env),
-        "-DCMAKE_BUILD_TYPE=%s" % ("Release" if env["target"] == "release" else "Debug"),
+        "-DCMAKE_BUILD_TYPE=%s" % ("RelWithDebInfo" if env["debug_symbols"] else "Release"),
     ]
     if env["platform"] == "android":
         abi = {

misc/scripts/package_release.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+set -e
+set -x
+
+ARTIFACTS=${ARTIFACTS:-"artifacts"}
+DESTINATION=${DESTIONATION:-"release"}
+VERSION=${VERSION:-"extension"}
+TYPE=${TYPE:-"webrtc"}
+
+mkdir -p ${DESTINATION}
+ls -R ${DESTINATION}
+
+DESTDIR="${DESTINATION}/${VERSION}/${TYPE}"
+
+mkdir -p ${DESTDIR}/lib
+
+find "${ARTIFACTS}" -wholename "*/${VERSION}/${TYPE}/lib/*" | xargs cp -t "${DESTDIR}/lib/"
+find "${ARTIFACTS}" -wholename "*/LICENSE*" | xargs cp -t "${DESTDIR}/"
+
+if [ $VERSION = "extension" ]; then
+    find "${ARTIFACTS}" -wholename "*/${VERSION}/${TYPE}/${TYPE}.gdextension" | head -n 1 | xargs cp -t "${DESTDIR}/"
+else
+    find "${ARTIFACTS}" -wholename "*/${VERSION}/${TYPE}/${TYPE}.tres" | head -n 1 | xargs cp -t "${DESTDIR}/"
+fi
+
+CURDIR=$(pwd)
+cd "${DESTINATION}/${VERSION}"
+zip -r ../godot-${VERSION}-${TYPE}.zip ${TYPE}
+cd "$CURDIR"
+
+ls -R ${DESTINATION}

misc/webrtc.gdextension

@@ -4,13 +4,24 @@ entry_symbol = "webrtc_extension_init"
 
 [libraries]
 
-linux.x86_64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.linux.{TARGET}.x86_64.so"
-linux.x86_32 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.linux.{TARGET}.x86_32.so"
-osx.x86_64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.osx.{TARGET}.x86_64.dylib"
-osx.arm64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.osx.{TARGET}.arm64.dylib"
-windows.x86_64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.windows.{TARGET}.x86_64.dll"
-windows.x86_32 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.windows.{TARGET}.x86_32.dll"
-android.arm64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.android.{TARGET}.arm64.so"
-android.x86_64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.android.{TARGET}.x86_64.so"
-ios.arm64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.ios.{TARGET}.arm64.dylib"
-ios.x86_64 = "res://{GDNATIVE_PATH}/lib/libwebrtc_native.ios.{TARGET}.x86_64.simulator.dylib"
+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"
+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"
+android.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.android.template_debug.x86_64.so"
+ios.debug.arm64 = "res://webrtc/lib/libwebrtc_native.ios.template_debug.arm64.dylib"
+ios.debug.x86_64 = "res://webrtc/lib/libwebrtc_native.ios.template_debug.x86_64.simulator.dylib"
+
+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"
+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"
+android.release.x86_64 = "res://webrtc/lib/libwebrtc_native.android.template_release.x86_64.so"
+ios.release.arm64 = "res://webrtc/lib/libwebrtc_native.ios.template_release.arm64.dylib"
+ios.release.x86_64 = "res://webrtc/lib/libwebrtc_native.ios.template_release.x86_64.simulator.dylib"

src/WebRTCLibDataChannel.hpp

@@ -40,6 +40,8 @@
 #define GDCLASS(arg1, arg2) GODOT_CLASS(arg1, arg2)
 #endif
 #else
+#include <godot_cpp/core/binder_common.hpp>
+
 #include <godot_cpp/classes/global_constants_binds.hpp>
 #include <godot_cpp/classes/web_rtc_data_channel_extension.hpp>
 #endif

src/WebRTCLibPeerConnection.cpp

@@ -130,6 +130,42 @@ WebRTCPeerConnection::ConnectionState WebRTCLibPeerConnection::_get_connection_s
 	}
 }
 
+WebRTCLibPeerConnection::GatheringState WebRTCLibPeerConnection::_get_gathering_state() const {
+	ERR_FAIL_COND_V(peer_connection == nullptr, GATHERING_STATE_NEW);
+
+	rtc::PeerConnection::GatheringState state = peer_connection->gatheringState();
+	switch (state) {
+		case rtc::PeerConnection::GatheringState::New:
+			return GATHERING_STATE_NEW;
+		case rtc::PeerConnection::GatheringState::InProgress:
+			return GATHERING_STATE_GATHERING;
+		case rtc::PeerConnection::GatheringState::Complete:
+			return GATHERING_STATE_COMPLETE;
+		default:
+			return GATHERING_STATE_NEW;
+	}
+}
+
+WebRTCLibPeerConnection::SignalingState WebRTCLibPeerConnection::_get_signaling_state() const {
+	ERR_FAIL_COND_V(peer_connection == nullptr, SIGNALING_STATE_CLOSED);
+
+	rtc::PeerConnection::SignalingState state = peer_connection->signalingState();
+	switch (state) {
+		case rtc::PeerConnection::SignalingState::Stable:
+			return SIGNALING_STATE_STABLE;
+		case rtc::PeerConnection::SignalingState::HaveLocalOffer:
+			return SIGNALING_STATE_HAVE_LOCAL_OFFER;
+		case rtc::PeerConnection::SignalingState::HaveRemoteOffer:
+			return SIGNALING_STATE_HAVE_REMOTE_OFFER;
+		case rtc::PeerConnection::SignalingState::HaveLocalPranswer:
+			return SIGNALING_STATE_HAVE_LOCAL_PRANSWER;
+		case rtc::PeerConnection::SignalingState::HaveRemotePranswer:
+			return SIGNALING_STATE_HAVE_REMOTE_PRANSWER;
+		default:
+			return SIGNALING_STATE_CLOSED;
+	}
+}
+
 Error WebRTCLibPeerConnection::_initialize(const Dictionary &p_config) {
 	rtc::Configuration config = {};
 	if (p_config.has("iceServers") && p_config["iceServers"].get_type() == Variant::ARRAY) {

src/WebRTCLibPeerConnection.hpp

@@ -40,6 +40,8 @@
 #define GDCLASS(arg1, arg2) GODOT_CLASS(arg1, arg2)
 #endif
 #else
+#include <godot_cpp/core/binder_common.hpp>
+
 #include <godot_cpp/classes/global_constants_binds.hpp>
 #include <godot_cpp/classes/web_rtc_peer_connection_extension.hpp>
 #endif
@@ -73,6 +75,8 @@ public:
 	void _init();
 
 	ConnectionState _get_connection_state() const override;
+	GatheringState _get_gathering_state() const override;
+	SignalingState _get_signaling_state() const override;
 
 	godot::Error _initialize(const godot::Dictionary &p_config) override;
 	godot::Object *_create_data_channel(const godot::String &p_channel, const godot::Dictionary &p_channel_config) override;

src/net/WebRTCPeerConnectionNative.hpp

@@ -75,6 +75,21 @@ protected:
 	};
 
 public:
+	enum GatheringState {
+		GATHERING_STATE_NEW,
+		GATHERING_STATE_GATHERING,
+		GATHERING_STATE_COMPLETE,
+	};
+
+	enum SignalingState {
+		SIGNALING_STATE_STABLE,
+		SIGNALING_STATE_HAVE_LOCAL_OFFER,
+		SIGNALING_STATE_HAVE_REMOTE_OFFER,
+		SIGNALING_STATE_HAVE_LOCAL_PRANSWER,
+		SIGNALING_STATE_HAVE_REMOTE_PRANSWER,
+		SIGNALING_STATE_CLOSED,
+	};
+
 	static void _register_methods();
 	static const godot_gdnative_ext_net_3_2_api_struct *_net_api;
 
@@ -82,6 +97,8 @@ public:
 	void register_interface(const godot_net_webrtc_peer_connection *interface);
 
 	virtual ConnectionState _get_connection_state() const = 0;
+	virtual GatheringState _get_gathering_state() const = 0;
+	virtual SignalingState _get_signaling_state() const = 0;
 
 	virtual godot::Error _initialize(const godot::Dictionary &p_config) = 0;
 	virtual godot::Object *_create_data_channel(const godot::String &p_channel, const godot::Dictionary &p_channel_config) = 0;