feat: Add support for Modern EME and legacy Apple Media Keys for Fair…

…Play (shaka-project#4309)

build/types/complete

@@ -2,6 +2,7 @@
 
 +@ads
 +@cast
++@fairplay
 +@networking
 +@manifests
 +@polyfill

build/types/core

@@ -68,7 +68,6 @@
 +../../lib/util/ebml_parser.js
 +../../lib/util/error.js
 +../../lib/util/event_manager.js
-+../../lib/util/fairplay_utils.js
 +../../lib/util/fake_event.js
 +../../lib/util/fake_event_target.js
 +../../lib/util/functional.js

build/types/fairplay

@@ -0,0 +1,3 @@
+# FairPlay
+
++../../lib/util/fairplay_utils.js

build/types/polyfill

@@ -7,6 +7,7 @@
 +../../lib/polyfill/mediasource.js
 +../../lib/polyfill/media_capabilities.js
 +../../lib/polyfill/orientation.js
++../../lib/polyfill/patchedmediakeys_apple.js
 +../../lib/polyfill/patchedmediakeys_nop.js
 +../../lib/polyfill/patchedmediakeys_webkit.js
 +../../lib/polyfill/pip_webkit.js

docs/tutorials/fairplay.md

@@ -1,8 +1,41 @@
 # FairPlay Support
 
 We support FairPlay with EME on compatible environments or native `src=`.
+
+By default Shaka Player supports Modern EME, if your provider doesn't support
+Modern EME yet, you can use legacy Apple Media Keys with:
+```js
+shaka.polyfill.PatchedMediaKeysApple.install();
+```
+
+The support in each case would be the following:
+
+|            |Modern EME |legacy Apple Media Keys|
+|:----------:|:---------:|:---------------------:|
+|src= (CMAF) |**Y**      |**Y**                  |
+|src= (TS)   |**Y**      |**Y**                  |
+|MSE (CMAF)  |**Y**      | -                     |
+|MSE (TS)    | -         | -                     |
+
+
 Adding FairPlay support involves a bit more work than other key systems.
 
+
+## Keysystem used in EME
+
+Depending on the EME implementation that is being used, the Fairplay keysystem
+varies.
+
+For Modern EME:
+```
+com.apple.fps
+```
+
+For legacy Apple Media Keys:
+```
+com.apple.fps.1_0
+```
+
 ## Server certificate
 
 All FairPlay content requires setting a server certificate. You can either
@@ -22,6 +55,27 @@ player.configure('drm.advanced.com\\.apple\\.fps\\.serverCertificateUri',
                  'https://example.com/cert.der');
 ```
 
+## Content ID
+
+Note: Normally only applies to legacy Apple Media Keys but some providers also
+need it in Modern EME.
+
+Some FairPlay content use custom signaling for the content ID.  The content ID
+is used by the browser to generate the license request.  If you don't use the
+default content ID derivation, you need to specify a custom init data transform:
+
+```js
+player.configure('drm.initDataTransform', (initData, initDataType) => {
+  if (initDataType != 'skd')
+    return initData;
+  // 'initData' is a buffer containing an 'skd://' URL as a UTF-8 string.
+  const skdUri = shaka.util.StringUtils.fromBytesAutoDetect(initData);
+  const contentId = getMyContentId(skdUri);
+  const cert = player.drmInfo().serverCertificate;
+  return shaka.util.FairPlayUtils.initDataTransform(initData, contentId, cert);
+});
+```
+
 ## License wrapping
 
 Some FairPlay servers need to accept the license request in a different format
@@ -61,3 +115,98 @@ player.getNetworkingEngine().registerResponseFilter((type, response) => {
   response.data = shaka.util.Uint8ArrayUtils.fromBase64(responseText).buffer;
 });
 ```
+
+### Integration with some DRMs providers
+
+Note: Some providers support both Modern EME and legacy Apple Media Keys.
+
+#### EZDRM (Modern EME)
+
+For integration with EZDRM the following can be used:
+
+```js
+const FairPlayUtils = shaka.util.FairPlayUtils;
+player.getNetworkingEngine()
+    .registerRequestFilter(FairPlayUtils.ezdrmFairPlayRequest);
+player.getNetworkingEngine()
+    .registerResponseFilter(FairPlayUtils.commonFairPlayResponse);
+```
+
+Note: If the url of the license server has to undergo any transformation
+(eg: add the contentId), you would have to create your filter manually.
+
+```js
+player.getNetworkingEngine().registerRequestFilter((type, request) => {
+  if (type != shaka.net.NetworkingEngine.RequestType.LICENSE) {
+    return;
+  }
+  const uri = request.uris[0];
+  const FairPlayUtils = shaka.util.FairPlayUtils;
+  const contentId = FairPlayUtils.defaultGetContentId(request.initData);
+  const newUri = uri.replace('^assetId^', contentId);
+  request.uris = [newUri];
+  request.headers['Content-Type'] = 'application/octet-stream'
+});
+```
+
+#### EZDRM (legacy Apple Media Keys)
+
+For integration with EZDRM the following can be used:
+
+```js
+shaka.polyfill.PatchedMediaKeysApple.install();
+const FairPlayUtils = shaka.util.FairPlayUtils;
+player.getNetworkingEngine()
+    .registerRequestFilter(FairPlayUtils.ezdrmFairPlayRequest);
+player.getNetworkingEngine()
+    .registerResponseFilter(FairPlayUtils.commonFairPlayResponse);
+player.configure('drm.initDataTransform',
+                 FairPlayUtils.ezdrmInitDataTransform);
+```
+
+Note: If the url of the license server has to undergo any transformation
+(eg: add the contentId), you would have to create your filter manually.
+
+```js
+player.getNetworkingEngine().registerRequestFilter((type, request) => {
+  if (type != shaka.net.NetworkingEngine.RequestType.LICENSE) {
+    return;
+  }
+  const uri = request.uris[0];
+  const FairPlayUtils = shaka.util.FairPlayUtils;
+  const contentId = FairPlayUtils.defaultGetContentId(request.initData);
+  const newUri = uri.replace('^assetId^', contentId);
+  request.uris = [newUri];
+  request.headers['Content-Type'] = 'application/octet-stream'
+});
+```
+
+#### Verimatrix (legacy Apple Media Keys)
+
+For integration with Verimatrix the following can be used:
+
+```js
+shaka.polyfill.PatchedMediaKeysApple.install();
+const FairPlayUtils = shaka.util.FairPlayUtils;
+player.getNetworkingEngine()
+    .registerRequestFilter(FairPlayUtils.verimatrixFairPlayRequest);
+player.getNetworkingEngine()
+    .registerResponseFilter(FairPlayUtils.commonFairPlayResponse);
+player.configure('drm.initDataTransform',
+                 FairPlayUtils.verimatrixInitDataTransform);
+```
+
+#### Conax (legacy Apple Media Keys)
+
+For integration with Conax the following can be used:
+
+```js
+shaka.polyfill.PatchedMediaKeysApple.install();
+const FairPlayUtils = shaka.util.FairPlayUtils;
+player.getNetworkingEngine()
+    .registerRequestFilter(FairPlayUtils.conaxFairPlayRequest);
+player.getNetworkingEngine()
+    .registerResponseFilter(FairPlayUtils.commonFairPlayResponse);
+player.configure('drm.initDataTransform',
+                 FairPlayUtils.conaxInitDataTransform);
+```

lib/hls/hls_parser.js

@@ -2607,6 +2607,14 @@ shaka.hls.HlsParser = class {
           shaka.util.Error.Code.HLS_MSE_ENCRYPTED_MP2T_NOT_SUPPORTED);
     }
 
+    if (shaka.util.Platform.isMediaKeysPolyfilled()) {
+      throw new shaka.util.Error(
+          shaka.util.Error.Severity.CRITICAL,
+          shaka.util.Error.Category.MANIFEST,
+          shaka.util.Error.Code
+              .HLS_MSE_ENCRYPTED_LEGACY_APPLE_MEDIA_KEYS_NOT_SUPPORTED);
+    }
+
     /*
      * Even if we're not able to construct initData through the HLS tag, adding
      * a DRMInfo will allow DRM Engine to request a media key system access

lib/media/drm_engine.js

@@ -1668,8 +1668,6 @@ shaka.media.DrmEngine = class {
       'com.widevine.alpha',
       'com.microsoft.playready',
       'com.microsoft.playready.recommendation',
-      'com.apple.fps.3_0',
-      'com.apple.fps.2_0',
       'com.apple.fps.1_0',
       'com.apple.fps',
       'com.adobe.primetime',