Add a new argument sio_root for Socket.IO headers. (#686)

* Add a new argument sio_root for Socket.IO headers.

With this argument, it would be easier for developers to upgrade
Socket.IO cpp lib.

* Remove check for socket.io from GN.

setup-gn.py automatically generate configured build directories for iOS,
which reports error because owt_sio_header_root is not set at that
moment.

https://chromium.googlesource.com/chromium/src/+/refs/heads/main/docs/ios/build_instructions.md#setting-up-the-build

Author: jianjunz

README.md

@@ -65,12 +65,13 @@ Common build options shared by Windows and Linux:
   - By default `x86|Debug` library will be created. Specify `--arch x64` if you want to build x64 libraries; Specify `--scheme release` if release version of library is to be built.
   - The built binary will be under path specified by `--output_path`. If `--output_path` is not set, the built binary will be under `src/out` directory.
   - The optional `--ssl_root` should be set to the root directory of lastest OpenSSL 3.0 series directory. If specified, build tool will search external OpenSSL headers in `ssl_root/include` and OpenSSL binaries in `ssl_root/lib`. But binaries are not included in OWT SDK, so applications still need to link libcrypto and libssl.
+  - The argument `--sio_root` should be set to the root directory of Socket.IO cpp 3.x SDK, with headers in `include` sub-folder, libsioclient_tls.a in `lib` sub-folder.
   - Use `--gn_gen` to generate args.gn during the first build or when you change either `ssl_root`/`msdk_root` options.
   - The optional `--tests` will trigger unit tests after build.
   - Run `build*.py` with `--help` for argument description.
 
 #### iOS
-Update to latest macOS(Big Sur) and Xcode. iOS SDK can only be built on macOS.
+Update to latest macOS and Xcode. iOS SDK can only be built on macOS.
 1. Replace the last line of .gclient with target_os=["ios"]
 1. Run `gclient sync`. It may take a long time to download a large amount of data.
 1. Run `scripts\build.py`.

scripts/build-win.py

@@ -37,7 +37,7 @@
     ]
 
 
-def gngen(arch, ssl_root, msdk_root, quic_root, scheme, tests, runtime, cloud_gaming):
+def gngen(arch, sio_root, ssl_root, msdk_root, quic_root, scheme, tests, runtime, cloud_gaming):
     gn_args = list(GN_ARGS)
     gn_args.append('target_cpu="%s"' % arch)
     using_llvm = False
@@ -86,6 +86,9 @@ def gngen(arch, ssl_root, msdk_root, quic_root, scheme, tests, runtime, cloud_ga
         gn_args.append('owt_include_tests=false')
     if cloud_gaming:
         gn_args.append('owt_cloud_gaming=true')
+    if sio_root:
+        # If sio_root is not specified, conference SDK is not able to build.
+        gn_args.append('owt_sio_header_root="%s"' % (sio_root + r'\include'))
     flattened_args = ' '.join(gn_args)
     ret = subprocess.call(['gn.bat', 'gen', getoutputpath(arch, scheme), '--args=%s' % flattened_args],
                           cwd=HOME_PATH, shell=False)
@@ -100,7 +103,7 @@ def getoutputpath(arch, scheme):
 
 def ninjabuild(arch, scheme):
     out_path = getoutputpath(arch, scheme)
-    if subprocess.call(['ninja', '-C', out_path], cwd=HOME_PATH) != 0:
+    if subprocess.call(['ninja.bat', '-C', out_path], cwd=HOME_PATH) != 0:
         return False
     return True
 
@@ -169,6 +172,7 @@ def main():
     parser.add_argument('--ssl_root', help='Path for OpenSSL.')
     parser.add_argument('--msdk_root', help='Path for MSDK.')
     parser.add_argument('--quic_root', help='Path to QUIC library. Not supported yet.')
+    parser.add_argument('--sio_root', required=True, help='Path to Socket.IO cpp. Headers in include sub-folder, libsioclient_tls.a in lib sub-folder.')
     parser.add_argument('--scheme', default='debug', choices=('debug', 'release'),
                         help='Schemes for building. Supported value: debug, release')
     parser.add_argument('--gn_gen', default=False, action='store_true',
@@ -195,7 +199,7 @@ def main():
         print('Invalid quic_root')
         return 1
     if opts.gn_gen:
-        if not gngen(opts.arch, opts.ssl_root, opts.msdk_root, opts.quic_root,
+        if not gngen(opts.arch, opts.sio_root, opts.ssl_root, opts.msdk_root, opts.quic_root,
                      opts.scheme, opts.tests, opts.runtime, opts.cloud_gaming):
             return 1
     if opts.sdk:

scripts/build.py

@@ -53,7 +53,7 @@
 TEST_SCHEME = 'debug'
 TEST_SIMULATOR_DEVICE = 'iPhone X'
 
-def gngen(arch, ssl_root, scheme):
+def gngen(arch, sio_root, ssl_root, scheme):
   gn_args = 'target_os="ios" target_cpu="%s" is_component_build=false '\
       'ios_enable_code_signing=false ios_deployment_target="11.0" '\
       'rtc_enable_symbol_export=true enable_dsyms=true use_custom_libcxx=false '\
@@ -62,6 +62,9 @@ def gngen(arch, ssl_root, scheme):
     gn_args += (' is_debug=false enable_stripping=true')
   else:
     gn_args += (' is_debug=true')
+  if sio_root:
+    # If sio_root is not specified, conference SDK is not able to build.
+    gn_args += (' owt_sio_header_root="%s"' % (sio_root + '/include'))
   if ssl_root:
     gn_args += (' rtc_build_ssl=false rtc_ssl_root="%s" '\
         'libsrtp_ssl_root="%s"'%(ssl_root+'/include', ssl_root+'/include'))
@@ -164,6 +167,7 @@ def main():
   parser.add_argument('--arch', default='arm64', dest='target_arch',
       help='Target architectures. Could be multiple values separated by comma.')
   parser.add_argument('--ssl_root', help='Path for OpenSSL. Headers in include sub-folder, libcrypto.a and libssl.a in lib sub-folder.')
+  parser.add_argument('--sio_root', required=True, help='Path to Socket.IO cpp. Headers in include sub-folder, libsioclient_tls.a in lib sub-folder.')
   parser.add_argument('--scheme', default='debug',
       help='Schemes for building. Supported value: debug, release')
   parser.add_argument('--skip_gn_gen', default=False, action='store_true',
@@ -186,14 +190,14 @@ def main():
       return 1
     else:
       if not opts.skip_gn_gen:
-        if not gngen(arch_item, opts.ssl_root, opts.scheme):
+        if not gngen(arch_item, opts.sio_root, opts.ssl_root, opts.scheme):
           return 1
       if not ninjabuild(arch_item, opts.scheme, SDK_TARGETS):
         return 1
   dist(opts.arch, opts.scheme)
   if not opts.skip_tests:
     if not opts.skip_gn_gen:
-      if not gngen(TEST_ARCH, opts.ssl_root, TEST_SCHEME):
+      if not gngen(TEST_ARCH, opts.sio_root, opts.ssl_root, TEST_SCHEME):
         return 1
     if not runtest(opts.ssl_root):
       return 1

talk/owt/BUILD.gn

@@ -11,6 +11,7 @@ declare_args() {
   include_internal_audio_device = true
   owt_msdk_lib_root = ""
   owt_msdk_header_root = ""
+  owt_sio_header_root = ""
 }
 
 # Introduced for using libvpx config files. We only enable libvpx rate
@@ -71,6 +72,8 @@ config("owt_common") {
 static_library("owt_deps") {
   deps = [
     "//third_party/webrtc/api:create_peerconnection_factory",
+    "//third_party/webrtc/api/video_codecs:builtin_video_decoder_factory",
+    "//third_party/webrtc/api/video_codecs:builtin_video_encoder_factory",
     "//third_party/webrtc/rtc_base:rtc_json",
   ]
 
@@ -417,6 +420,9 @@ static_library("owt_sdk_conf") {
     "sdk/include/cpp",
     "//third_party",
   ]
+  if (owt_sio_header_root != "") {
+    include_dirs += [ owt_sio_header_root ]
+  }
   sources = [
     "sdk/conference/conferenceclient.cc",
     "sdk/conference/conferencepeerconnectionchannel.cc",
@@ -466,6 +472,9 @@ if (is_ios) {
       "sdk/include/cpp",
       "sdk/include/objc",
     ]
+    if (owt_sio_header_root != "") {
+      include_dirs += [ owt_sio_header_root ]
+    }
     configs += [
       "//build/config/compiler:enable_arc",
       ":owt_sdk_objc_warnings_config",

talk/owt/docs/cpp/cpp.md

@@ -19,8 +19,8 @@ channel implementation, you can optionally link sioclient.lib or sioclient_tls.l
 OWT, please define WEBRTC_WIN for Windows build. If the OWT lib was built with Intel Media SDK (msdk_root is specified for
 build-win.py, or owt_msdk_header_root is defined in GN args), your app needs to define OWT_USE_MSDK as well.
 # 4 Socket.IO {#section4}
-Socket.IO cpp client is an open source project hosted on [Github](https://github.com/socketio/socket.io-client-cpp). Please follow official guide on GitHub to build and link it. The version works with OWT is b1216ee428dd7d1e72368da9b12aa43bfc487c93.
-The Socket.IO TLS feature is determined at compile time and cannot be switched at runtime. If you are using secure connections, link your application statically with sioclient_tls.lib; otherwise, link it with sioclient.lib. Please be noted the SDK library is linking to OpenSSL 1.1.1, so sioclient_tls.lib must be compiled using the same OpenSSL version.
+Socket.IO cpp client is an open source project hosted on [Github](https://github.com/socketio/socket.io-client-cpp). Please follow official guide on GitHub to build and link it. The version tested is 3e01111ddf9778a162c4c4bb91f795d2dd59f065.
+The Socket.IO TLS feature is determined at compile time and cannot be switched at runtime. If you are using secure connections, link your application statically with sioclient_tls.lib; otherwise, link it with sioclient.lib. Please be noted the SDK library and sioclient_tls.lib must be compiled using the same OpenSSL version.
 # 5 NAT and firewall traversal {#section5}
 Open WebRTC Toolkit Client SDK for Windows fully supports NAT and firewall traversal with STUN / TURN / ICE. The Coturn TURN server from https://github.com/coturn/coturn can be one choice.
 # 6 Customize signaling channel {#section6}

talk/owt/docs/ios/ios.md

@@ -7,16 +7,16 @@ Refer to the Release Notes for the latest information in the SDK release package
 # 2 Supported platforms {#section2}
 Open WebRTC Toolkit Client SDK for iOS supports in iOS 9.0 and later versions.
 The following devices have been tested using this SDK:
-- iPhone* 6, 7 Plus and X.
-- iPad Air*
+- iPhone* X
+- iPad* Air
 # 3 Getting started {#section3}
 The release package includes two sample applications to get you started quickly with the SDK. The following three static libraries are provided in the SDK along with their respective headers:
 - OWT.framework - a framework providing the abilities to connect to conference server or another Open WebRTC Toolkit P2P endpoints.
 - WebRTC.framework - a framework providing WebRTC features. You can find its source code at https://webrtc.googlesource.com/src. We modified some code make it work with OpenSSL.
 
 Please add -ObjC to "Other Linker Flags" in the your project's build settings.
 # 4 Socket.IO {#section4}
-OWT iOS SDK depends on Socket.IO cpp client, which is an open source project host on [Github](https://github.com/socketio/socket.io-client-cpp). Please follow official guide on GitHub to build and link it. The version works with OWT is b1216ee428dd7d1e72368da9b12aa43bfc487c93. OpenSSL version is 1.1.1 with the latest patch release.
+OWT iOS SDK depends on Socket.IO cpp client, which is an open source project host on [Github](https://github.com/socketio/socket.io-client-cpp). Please follow official guide on GitHub to build and link it. The version tested with OWT is 3e01111ddf9778a162c4c4bb91f795d2dd59f065. OpenSSL version is 1.1.1 with the latest patch release.
 Please make sure your app has network access before making Socket.IO connection. As Socket.IO cpp client uses low level network APIs, iOS system may not ask user for network permission. Thus, Socket.IO connection will fail because app does not have network access.
 The Socket.IO TLS feature is determined at compile time and cannot be switched at runtime. If you are using secure connections, link your application with libsioclient_tls.a; otherwise, link it with libsioclient.a.
 # 5 Background modes {#section5}