Cg client build support (#705)

* Add support for both CG server and client build.

Update scripts and GN files to support CG client build on Windows. Macro
OWT_CLOUD_GAMING will be removed soon, please move to OWT_CG_SERVER.

* Build client without MSDK support.

This allows building the dxva based decoder without dependency to MSDK.

---------

Co-authored-by: Jianjun Zhu <[email protected]>

Author: taste1981

DEPS

@@ -98,7 +98,7 @@ deps = {
     Var('chromium_git') + '/chromium/src/third_party' + '@' + 'cd30703e732f3436f72f63c13f16ebb19803ddd6',
   # WebRTC-only dependencies (not present in Chromium).
   'src/third_party/webrtc':
-    Var('deps_owt_git') + '/owt-deps-webrtc' + '@' + '15bb85d7886c653bba004f2b2826bc471d07fd96',
+    Var('deps_owt_git') + '/owt-deps-webrtc' + '@' + 'c34716479181dfaac4635098422ed3914d9555c3',
   # Gradle 4.3-rc4. Used for testing Android Studio project generation for WebRTC.
   'src/third_party/webrtc/examples/androidtests/third_party/gradle': {
     'url': Var('chromium_git') + '/external/github.com/gradle/gradle.git' + '@' +

build_overrides/build.gni

@@ -69,6 +69,7 @@ declare_args() {
   # Enable HEVC for WebRTC.
   rtc_use_h265 = false
 
-  # Build OWT for cloud gaming. It enables low latency features, and disables audio processing. It may break normal WebRTC features, is not intended for general use.
-  owt_cloud_gaming = false
+  # Build OWT for cloud gaming. It enables low latency features, and disables audio processing for server side. It may break normal WebRTC features, is not intended for general use.
+  owt_cg_server = false
+  owt_cg_client = false
 }

scripts/build-win.py

@@ -33,7 +33,7 @@
     ]
 
 
-def gngen(arch, sio_root, ffmpeg_root, ssl_root, msdk_root, quic_root, scheme, tests, runtime, cloud_gaming):
+def gngen(arch, sio_root, ffmpeg_root, ssl_root, msdk_root, quic_root, scheme, tests, runtime, cg_server, cg_client):
     gn_args = list(GN_ARGS)
     gn_args.append('target_cpu="%s"' % arch)
     using_llvm = False
@@ -80,21 +80,24 @@ def gngen(arch, sio_root, ffmpeg_root, ssl_root, msdk_root, quic_root, scheme, t
     else:
         gn_args.append('rtc_include_tests=false')
         gn_args.append('owt_include_tests=false')
-    if cloud_gaming:
+    if cg_server:
         gn_args.append('rtc_enable_protobuf=false')
         gn_args.append('rtc_enable_win_wgc=false')
-        gn_args.append('owt_cloud_gaming=true')
+        gn_args.append('owt_cg_server=true')
         gn_args.append('enable_libaom=false')
     else:
         gn_args.append('enable_libaom=true')
+    if cg_client:
+        gn_args.append('owt_cg_client=true')
+        gn_args.append('rtc_enable_protobuf=false')
     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'))
     if ffmpeg_root:
         gn_args.append('owt_ffmpeg_header_root="%s"'%(ffmpeg_root+r'\include'))
-    if ffmpeg_root or msdk_root or cloud_gaming:
+    if ffmpeg_root or msdk_root or cg_server:
         gn_args.append('rtc_use_h264=true')
-    if msdk_root or cloud_gaming:
+    if msdk_root or cg_server:
         gn_args.append('rtc_use_h265=true')
     flattened_args = ' '.join(gn_args)
     ret = subprocess.call(['gn.bat', 'gen', getoutputpath(arch, scheme), '--args=%s' % flattened_args],
@@ -139,7 +142,6 @@ def runtest(arch, scheme):
 
 
 def gendocs():
-    print('start ninja file generatio!')
     cmd_path = os.path.join(HOME_PATH, r'talk\owt\docs\cpp')
     doc_path = os.path.join(cmd_path, r'html')
     if os.path.exists(doc_path):
@@ -192,10 +194,19 @@ def main():
     parser.add_argument('--docs', default=False, action='store_true',
                         help='To generate the API document.')
     parser.add_argument('--output_path', help='Path to copy sdk.')
+    parser.add_argument('--cg_server', default=False,
+                        help='Build for cloud gaming server. This option is not intended to be used in general purpose. Setting to true may result unexpected behaviors. Default to false.', action='store_true')
     parser.add_argument('--cloud_gaming', default=False,
-                        help='Build for cloud gaming. This option is not intended to be used in general purpose. Setting to true may result unexpected behaviors. Default to false.', action='store_true')
+                        help='Deprecated. Please use cg_server instead.', action='store_true')
+    parser.add_argument('--cg_client', default=False,
+                        help='Build for cloud gaming client. This option is not intended to be used in general purpose. Setting to true may result unexpected behaviors. Default to false.', action='store_true')
     opts = parser.parse_args()
-    if not opts.sio_root and not opts.cloud_gaming:
+    if opts.cg_server and opts.cg_client:
+        print('Cannot build for both cloud gaming server and client.')
+        return 1
+    if opts.cloud_gaming:
+        opts.cg_server = True
+    if not opts.sio_root and not opts.cg_server and not opts.cg_client:
         print("sio_root is missing.")
         return 1
     if opts.ssl_root and not os.path.exists(os.path.expanduser(opts.ssl_root)):
@@ -211,7 +222,7 @@ def main():
         return 1
     if opts.gn_gen:
         if not gngen(opts.arch, opts.sio_root, opts.ffmpeg_root, opts.ssl_root, opts.msdk_root, opts.quic_root,
-                     opts.scheme, opts.tests, opts.runtime, opts.cloud_gaming):
+                     opts.scheme, opts.tests, opts.runtime, opts.cg_server, opts.cg_client):
             return 1
     if opts.sdk:
         if not ninjabuild(opts.arch, opts.scheme):

scripts/build_linux.py

@@ -39,7 +39,7 @@ def gen_lib_path(scheme):
     out_lib = OUT_LIB % {'scheme': scheme}
     return os.path.join(HOME_PATH + r'/out', out_lib)
 
-def gngen(arch, sio_root, ffmpeg_root, ssl_root, msdk_root, quic_root, scheme, tests, use_gcc, fake_audio, shared, cloud_gaming):
+def gngen(arch, sio_root, ffmpeg_root, ssl_root, msdk_root, quic_root, scheme, tests, use_gcc, fake_audio, shared, cg_server):
     gn_args = list(GN_ARGS)
     gn_args.append('target_cpu="%s"' % arch)
     if scheme == 'release':
@@ -89,15 +89,15 @@ def gngen(arch, sio_root, ffmpeg_root, ssl_root, msdk_root, quic_root, scheme, t
         gn_args.extend(['rtc_enable_protobuf=false', 'is_component_build=true'])
     else:
         gn_args.extend(['is_component_build=false'])
-    if cloud_gaming:
-        gn_args.extend(['owt_cloud_gaming=true', 'enable_libaom=false'])
+    if cg_server:
+        gn_args.extend(['owt_cg_server=true', 'enable_libaom=false'])
     else:
         gn_args.extend(['enable_libaom=true'])
     if ffmpeg_root:
         gn_args.append('owt_ffmpeg_header_root="%s"'%(ffmpeg_root+'/include'))
-    if ffmpeg_root or msdk_root or cloud_gaming:
+    if ffmpeg_root or msdk_root or cg_server:
         gn_args.append('rtc_use_h264=true')
-    if msdk_root or cloud_gaming:
+    if msdk_root or cg_server:
         gn_args.append('rtc_use_h265=true')
 
     flattened_args = ' '.join(gn_args)
@@ -200,13 +200,18 @@ def main():
     parser.add_argument('--output_path', help='Path to copy sdk.')
     parser.add_argument('--use_gcc', help='Compile with GCC and libstdc++. Default is clang and libc++.', action='store_true')
     parser.add_argument('--shared', default=False,  help='Build shared libraries. Default to static.', action='store_true')
-    parser.add_argument('--cloud_gaming', default=False,  help='Build for cloud gaming. This option is not intended to be used in general purpose. Setting to true may result unexpected behaviors. Default to false.', action='store_true')
+    parser.add_argument('--cg_server', default=False,
+                        help='Build for cloud gaming server. This option is not intended to be used in general purpose. Setting to true may result unexpected behaviors. Default to false.', action='store_true')
+    parser.add_argument('--cloud_gaming', default=False,
+                        help='Deprecated. Please use cg_server instead.', action='store_true')
     opts = parser.parse_args()
-    if not opts.sio_root and not opts.cloud_gaming:
+    if opts.cloud_gaming:
+        opts.cg_server = True
+    if not opts.sio_root and not opts.cg_server:
         print("sio_root is missing.")
         return 1
     if opts.gn_gen:
-        if not gngen(opts.arch, opts.sio_root, opts.ffmpeg_root, opts.ssl_root, opts.msdk_root, opts.quic_root, opts.scheme, opts.tests, opts.use_gcc, opts.fake_audio, opts.shared, opts.cloud_gaming):
+        if not gngen(opts.arch, opts.sio_root, opts.ffmpeg_root, opts.ssl_root, opts.msdk_root, opts.quic_root, opts.scheme, opts.tests, opts.use_gcc, opts.fake_audio, opts.shared, opts.cg_server):
             return 1
     if opts.sdk:
          if not ninjabuild(opts.arch, opts.scheme, opts.shared):

talk/owt/BUILD.gn

@@ -92,7 +92,7 @@ static_library("owt_deps") {
 if (!is_ios) {
   if (is_component_build) {
     # Component build is only supported by cloud gaming mode on Linux.
-    assert(owt_cloud_gaming)
+    assert(owt_cg_server)
     shared_library("owt") {
       visibility = [ "*" ]
       deps = [
@@ -113,7 +113,7 @@ if (!is_ios) {
         "//third_party/webrtc:webrtc",
         "//third_party/webrtc/api:libjingle_peerconnection_api",
       ]
-      if (!owt_cloud_gaming) {
+      if (!owt_cg_server && !owt_cg_client) {
         deps += [ ":owt_sdk_conf" ]
       }
       complete_static_lib = true
@@ -414,8 +414,8 @@ static_library("owt_sdk_p2p") {
     configs -= [ "//build/config/clang:find_bad_constructs" ]
   }
   configs += [ ":owt_common" ]
-  if (owt_cloud_gaming) {
-    defines = [ "OWT_CLOUD_GAMING" ]
+  if (owt_cg_server) {
+    defines = [ "OWT_CG_SERVER" ]
   }
 }
 static_library("owt_sdk_conf") {

talk/owt/sdk/base/win/d3d11device.cc

@@ -7,12 +7,12 @@
 #include "talk/owt/sdk/base/win/d3d11device.h"
 #include "rtc_base/logging.h"
 
-#define MSDK_D3D11_CHECK(result) \
-  {                        \
-    if (FAILED(result)) {  \
+#define MSDK_D3D11_CHECK(result)                            \
+  {                                                         \
+    if (FAILED(result)) {                                   \
       RTC_LOG(LS_ERROR) << "Failed with result:" << result; \
-      return MFX_ERR_DEVICE_FAILED;  \
-    }  \
+      return false;                                         \
+    }                                                       \
   }
 
 namespace owt {
@@ -25,8 +25,9 @@ RTCD3D11Device::~RTCD3D11Device() {
   Close();
 }
 
-mfxStatus RTCD3D11Device::Init(mfxHDL window,
-  mfxU32 adapter_num, ID3D11Device* device) {
+bool RTCD3D11Device::Init(mfxHDL window,
+                          int adapter_num,
+                          ID3D11Device* device) {
   window_handle_ = static_cast<HWND>(window);
   HRESULT hr;
 
@@ -36,26 +37,26 @@ mfxStatus RTCD3D11Device::Init(mfxHDL window,
     // First get the immediate device context;
     device->GetImmediateContext(&external_d3d11_device_context_);
     if (external_d3d11_device_context_ == nullptr)
-      return MFX_ERR_DEVICE_FAILED;
+      return false;
 
     // Get the ID3D11VideoDevice handle as well.
     hr = device->QueryInterface(__uuidof(ID3D11VideoDevice),
                                 (void**)&external_d3d11_video_device_);
     if (FAILED(hr))
-      return MFX_ERR_DEVICE_FAILED;
+      return false;
 
     hr = external_d3d11_device_context_->QueryInterface(__uuidof(ID3D11VideoContext),
                                 (void**)&external_d3d11_video_context_);
     if (FAILED(hr))
-      return MFX_ERR_DEVICE_FAILED;
+      return false;
 
     CComQIPtr<ID3D10Multithread> p_mt(external_d3d11_video_context_);
     if (p_mt) {
       p_mt->SetMultithreadProtected(true);
     } else {
-      return MFX_ERR_DEVICE_FAILED;
+      return false;
     }
-    return MFX_ERR_NONE;
+    return true;
   }
 
   RTC_LOG(LS_ERROR) << "In d3d11device: Before create the dxgi factory.";
@@ -74,18 +75,18 @@ mfxStatus RTCD3D11Device::Init(mfxHDL window,
   MSDK_D3D11_CHECK(dxgi_factory_->EnumAdapters(adapter_num, &dxgi_adapter_));
 
   RTC_LOG(LS_ERROR) << "In d3d11device: Before D3D11CreateDevice.";
-  MSDK_D3D11_CHECK(D3D11CreateDevice(dxgi_adapter_, D3D_DRIVER_TYPE_UNKNOWN, nullptr, 0,
-                           feature_levels, MSDK_ARRAY_LEN(feature_levels),
-                           D3D11_SDK_VERSION, &d3d11_device_,
-                           &feature_levels_out, &d3d11_device_context_));
+  MSDK_D3D11_CHECK(D3D11CreateDevice(
+      dxgi_adapter_, D3D_DRIVER_TYPE_UNKNOWN, nullptr, 0, feature_levels,
+      sizeof(feature_levels), D3D11_SDK_VERSION, &d3d11_device_,
+      &feature_levels_out, &d3d11_device_context_));
 
   dxgi_device_ = d3d11_device_;
   d3d11_video_device_ = d3d11_device_;
   d3d11_video_context_ = d3d11_device_context_;
 
   if (!dxgi_device_.p || !d3d11_video_device_.p || !d3d11_video_context_.p) {
     RTC_LOG(LS_ERROR) << "d3d11 device or context nullptr";
-    return MFX_ERR_NULL_PTR;
+    return false;
   }
 
   // Turn on multi-threading for the context
@@ -94,32 +95,32 @@ mfxStatus RTCD3D11Device::Init(mfxHDL window,
     p_mt->SetMultithreadProtected(true);
   } else {
     RTC_LOG(LS_ERROR) << "Failed to turn on multi-threading for the context.";
-    return MFX_ERR_DEVICE_FAILED;
+    return false;
   }
 
-  return MFX_ERR_NONE;
+  return true;
 }
 
-mfxStatus RTCD3D11Device::Reset() {
+bool RTCD3D11Device::Reset() {
   // Currently do nothing.
-  return MFX_ERR_NONE;
+  return true;
 }
 
-mfxStatus RTCD3D11Device::SetHandle(mfxHandleType handle_type, mfxHDL handle) {
+bool RTCD3D11Device::SetHandle(mfxHandleType handle_type, mfxHDL handle) {
   if (handle != nullptr) {
     window_handle_ = static_cast<HWND>(handle);
-    return MFX_ERR_NONE;
+    return true;
   }
-  return MFX_ERR_UNSUPPORTED;
+  return false;
 }
 
-mfxStatus RTCD3D11Device::GetHandle(mfxHandleType handle_type, mfxHDL* handle) {
+bool RTCD3D11Device::GetHandle(mfxHandleType handle_type, mfxHDL* handle) {
   if (MFX_HANDLE_D3D11_DEVICE == handle_type) {
     *handle = external_d3d11_device_ != nullptr ? external_d3d11_device_
                                                 : d3d11_device_.p;
-    return MFX_ERR_NONE;
+    return true;
   }
-  return MFX_ERR_UNSUPPORTED;
+  return false;
 }
 
 void RTCD3D11Device::Close() {

talk/owt/sdk/base/win/d3d11device.h

@@ -8,21 +8,37 @@
 #include <d3d11.h>
 #include <dxgi1_2.h>
 #include <windows.h>
-
+#ifdef OWT_USE_MSDK
 #include "talk/owt/sdk/base/win/msdkvideobase.h"
+#endif
 
 namespace owt {
 namespace base {
 
+#ifndef OWT_USE_MSDK
+typedef enum {
+  MFX_HANDLE_DIRECT3D_DEVICE_MANAGER9 = 1, /* IDirect3DDeviceManager9      */
+  MFX_HANDLE_D3D9_DEVICE_MANAGER = MFX_HANDLE_DIRECT3D_DEVICE_MANAGER9,
+  MFX_HANDLE_RESERVED1 = 2,
+  MFX_HANDLE_D3D11_DEVICE = 3,
+  MFX_HANDLE_VA_DISPLAY = 4,
+  MFX_HANDLE_RESERVED3 = 5,
+} mfxHandleType;
+
+typedef void* mfxHDL;
+typedef unsigned int mfxU32;
+typedef unsigned char mfxU8;
+#endif
+
 class RTCD3D11Device {
  public:
   RTCD3D11Device();
   virtual ~RTCD3D11Device();
 
-  mfxStatus Init(mfxHDL window, mfxU32 adapter_idx, ID3D11Device* device);
-  mfxStatus Reset();
-  mfxStatus SetHandle(mfxHandleType handle_type, mfxHDL handle);
-  mfxStatus GetHandle(mfxHandleType handle_type, mfxHDL* handle);
+  bool Init(mfxHDL window, int adapter_idx, ID3D11Device* device);
+  bool Reset();
+  bool SetHandle(mfxHandleType handle_type, mfxHDL handle);
+  bool GetHandle(mfxHandleType handle_type, mfxHDL* handle);
   void Close();
 
   ID3D11Device* GetD3D11Device() const {