feat: Add Device API (#8210)

The goal is to simplify and abstract feature logic detection. Currently
lots of places depend on various calls to `shaka.util.Platform` and
mainteinance of this is hard & not easy to read.

By introducing device API ideally rest of the player logic would look
into device features instead of directly checking platform. Additionally
we can more easily cache needed values, so we won't have to parse user
agent several times anymore.

---------

Co-authored-by: Álvaro Velad Galván <[email protected]>

Author: tykus160

build/types/complete

@@ -12,4 +12,5 @@
 +@text
 +@optionalText
 +@transmuxer
++@devices
 +@ui

build/types/core

@@ -20,6 +20,12 @@
 +../../lib/deprecate/enforcer.js
 +../../lib/deprecate/version.js
 
++../../lib/device/abstract_device.js
++../../lib/device/apple_browser.js
++../../lib/device/default_browser.js
++../../lib/device/device_factory.js
++../../lib/device/i_device.js
+
 +../../lib/drm/drm_engine.js
 +../../lib/drm/drm_utils.js
 +../../lib/drm/fairplay.js
@@ -113,7 +119,6 @@
 +../../lib/util/object_utils.js
 +../../lib/util/operation_manager.js
 +../../lib/util/periods.js
-+../../lib/util/platform.js
 +../../lib/util/player_configuration.js
 +../../lib/util/pssh.js
 +../../lib/util/public_promise.js

build/types/devices

@@ -0,0 +1,10 @@
+# Device
+
++../../lib/device/chromecast.js
++../../lib/device/hisense.js
++../../lib/device/playstation.js
++../../lib/device/tizen.js
++../../lib/device/vizio.js
++../../lib/device/webkit_stb.js
++../../lib/device/webos.js
++../../lib/device/xbox.js

externs/xbox.js

@@ -61,3 +61,10 @@ chrome.webview.hostObjects.sync = {};
 
 /** @const */
 chrome.webview.hostObjects.sync.Windows = Windows;
+
+/**
+ * Typedef for the module interface.
+ *
+ * @typedef {typeof Windows}
+ */
+var WinRT;

lib/ads/interstitial_ad_manager.js

@@ -12,6 +12,8 @@ goog.require('shaka.Player');
 goog.require('shaka.ads.InterstitialAd');
 goog.require('shaka.ads.InterstitialStaticAd');
 goog.require('shaka.ads.Utils');
+goog.require('shaka.device.DeviceFactory');
+goog.require('shaka.device.IDevice');
 goog.require('shaka.log');
 goog.require('shaka.media.PreloadManager');
 goog.require('shaka.net.NetworkingEngine');
@@ -21,7 +23,6 @@ goog.require('shaka.util.Error');
 goog.require('shaka.util.EventManager');
 goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.IReleasable');
-goog.require('shaka.util.Platform');
 goog.require('shaka.util.PublicPromise');
 goog.require('shaka.util.StringUtils');
 goog.require('shaka.util.Timer');
@@ -251,8 +252,7 @@ shaka.ads.InterstitialAdManager = class {
         this.baseVideo_, 'seeked', this.onSeeked_);
     this.eventManager_.listen(
         this.baseVideo_, 'ended', this.checkForInterstitials_);
-    if ('requestVideoFrameCallback' in this.baseVideo_ &&
-        !shaka.util.Platform.isSmartTV()) {
+    if ('requestVideoFrameCallback' in this.baseVideo_ && !this.isSmartTV_()) {
       const baseVideo = /** @type {!HTMLVideoElement} */ (this.baseVideo_);
       const videoFrameCallback = (now, metadata) => {
         if (this.videoCallbackId_ == -1) {
@@ -1080,7 +1080,7 @@ shaka.ads.InterstitialAdManager = class {
       const detachBasePlayerPromise = new shaka.util.PublicPromise();
       const checkState = async (e) => {
         if (e['state'] == 'detach') {
-          if (shaka.util.Platform.isSmartTV()) {
+          if (this.isSmartTV_()) {
             await new Promise(
                 (resolve) => new shaka.util.Timer(resolve).tickAfter(0.1));
           }
@@ -1747,6 +1747,20 @@ shaka.ads.InterstitialAdManager = class {
     return Array.from(this.interstitials_);
   }
 
+  /**
+   * @return {boolean}
+   * @private
+   */
+  isSmartTV_() {
+    const device = shaka.device.DeviceFactory.getDevice();
+    const deviceType = device.getDeviceType();
+    if (deviceType == shaka.device.IDevice.DeviceType.TV ||
+        deviceType == shaka.device.IDevice.DeviceType.CONSOLE ||
+        deviceType == shaka.device.IDevice.DeviceType.CAST) {
+      return true;
+    }
+    return false;
+  }
 
   /**
    * @param {!shaka.extern.AdInterstitial} interstitial

lib/cast/cast_receiver.js

@@ -9,13 +9,14 @@ goog.provide('shaka.cast.CastReceiver');
 goog.require('goog.asserts');
 goog.require('shaka.Player');
 goog.require('shaka.cast.CastUtils');
+goog.require('shaka.device.DeviceFactory');
+goog.require('shaka.device.IDevice');
 goog.require('shaka.log');
 goog.require('shaka.util.Error');
 goog.require('shaka.util.EventManager');
 goog.require('shaka.util.FakeEvent');
 goog.require('shaka.util.FakeEventTarget');
 goog.require('shaka.util.IDestroyable');
-goog.require('shaka.util.Platform');
 goog.require('shaka.util.Timer');
 
 
@@ -271,7 +272,9 @@ shaka.cast.CastReceiver = class extends shaka.util.FakeEventTarget {
       // browser is a Chromecast before starting the receiver manager.  We
       // wouldn't do browser detection except for debugging, so only do this in
       // uncompiled mode.
-      if (shaka.util.Platform.isChromecast()) {
+      const device = shaka.device.DeviceFactory.getDevice();
+      const deviceType = device.getDeviceType();
+      if (deviceType === shaka.device.IDevice.DeviceType.CAST) {
         manager.start();
       }
     } else {