feat(HLS): Add an option to ignore DRM info (#7986)

Fixes #7985.

---------

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

Author: JulianDomingo

demo/config.js

@@ -227,14 +227,14 @@ shakaDemo.Config = class {
         .addBoolInput_('Ignore supplemental codecs',
             'manifest.ignoreSupplementalCodecs')
         .addNumberInput_('Override the Update time of the manifest',
-            'manifest.updatePeriod');
+            'manifest.updatePeriod')
+        .addBoolInput_('Ignore DRM Info', 'manifest.ignoreDrmInfo');
   }
 
   /** @private */
   addDashManifestSection_() {
     const docLink = this.resolveExternLink_('.ManifestConfiguration');
     this.addSection_('DASH Manifest', docLink)
-        .addBoolInput_('Ignore DASH DRM Info', 'manifest.dash.ignoreDrmInfo')
         .addBoolInput_('Auto-Correct DASH Drift',
             'manifest.dash.autoCorrectDrift')
         .addBoolInput_('Disable Xlink processing',

externs/shaka/player.js

@@ -1080,7 +1080,6 @@ shaka.extern.xml.Node;
 /**
  * @typedef {{
  *   clockSyncUri: string,
- *   ignoreDrmInfo: boolean,
  *   disableXlinkProcessing: boolean,
  *   xlinkFailGracefully: boolean,
  *   ignoreMinBufferTime: boolean,
@@ -1104,12 +1103,6 @@ shaka.extern.xml.Node;
  *   URI will be used to determine the current time.
  *   <br>
  *   Defaults to <code>''</code>.
- * @property {boolean} ignoreDrmInfo
- *   If true will cause DASH parser to ignore DRM information specified
- *   by the manifest and treat it as if it signaled no particular key
- *   system and contained no init data.
- *   <br>
- *   Defaults to <code>false</code>.
  * @property {boolean} disableXlinkProcessing
  *   If true, xlink-related processing will be disabled.
  *   <br>
@@ -1355,7 +1348,8 @@ shaka.extern.MssManifestConfiguration;
  *   raiseFatalErrorOnManifestUpdateRequestFailure: boolean,
  *   continueLoadingWhenPaused: boolean,
  *   ignoreSupplementalCodecs: boolean,
- *   updatePeriod: number
+ *   updatePeriod: number,
+ *   ignoreDrmInfo: boolean
  * }}
  *
  * @property {shaka.extern.RetryParameters} retryParameters
@@ -1436,6 +1430,12 @@ shaka.extern.MssManifestConfiguration;
  *   trigger a new download of the manifest.
  *   <br>
  *   Defaults to <code>-1</code>.
+ * @property {boolean} ignoreDrmInfo
+ *   If true will cause DASH/HLS parser to ignore DRM information specified
+ *   by the manifest and treat it as if it signaled no particular key
+ *   system and contained no init data.
+ *   <br>
+ *   Defaults to <code>false</code>.
  * @exportDoc
  */
 shaka.extern.ManifestConfiguration;

lib/dash/dash_parser.js

@@ -1964,7 +1964,7 @@ shaka.dash.DashParser = class {
         TXml.findChildren(elem, 'ContentProtection');
     const contentProtection = ContentProtection.parseFromAdaptationSet(
         contentProtectionElements,
-        this.config_.dash.ignoreDrmInfo,
+        this.config_.ignoreDrmInfo,
         this.config_.dash.keySystemsByURI);
 
     const language = shaka.util.LanguageUtils.normalize(
@@ -2295,7 +2295,7 @@ shaka.dash.DashParser = class {
         TXml.findChildren(node, 'ContentProtection');
     const keyId = shaka.dash.ContentProtection.parseFromRepresentation(
         contentProtectionElements, contentProtection,
-        this.config_.dash.ignoreDrmInfo,
+        this.config_.ignoreDrmInfo,
         this.config_.dash.keySystemsByURI);
     const keyIds = new Set(keyId ? [keyId] : []);
 

lib/hls/hls_parser.js

@@ -1584,7 +1584,7 @@ shaka.hls.HlsParser = class {
     // EXT-X-SESSION-KEY processing
     const drmInfos = [];
     const keyIds = new Set();
-    if (sessionKeyTags.length > 0) {
+    if (!this.config_.ignoreDrmInfo && sessionKeyTags.length > 0) {
       for (const drmTag of sessionKeyTags) {
         const method = drmTag.getRequiredAttrValue('METHOD');
         // According to the HLS spec, KEYFORMAT is optional and implicitly
@@ -3189,7 +3189,7 @@ shaka.hls.HlsParser = class {
   async parseDrmInfo_(playlist, mimeType, getUris, variables) {
     /** @type {!Map<!shaka.hls.Tag, ?shaka.media.InitSegmentReference>} */
     const drmTagsMap = new Map();
-    if (playlist.segments) {
+    if (!this.config_.ignoreDrmInfo && playlist.segments) {
       for (const segment of playlist.segments) {
         const segmentKeyTags = shaka.hls.Utils.filterTagsByName(segment.tags,
             'EXT-X-KEY');

lib/player.js

@@ -4115,6 +4115,17 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
       delete config['manifest']['hls']['updatePeriod'];
     }
 
+    // Deprecate 'manifest.dash.ignoreDrmInfo' configuration.
+    if (config['manifest'] && config['manifest']['dash'] &&
+        'ignoreDrmInfo' in config['manifest']['dash']) {
+      shaka.Deprecate.deprecateFeature(5,
+          'manifest.dash.ignoreDrmInfo configuration',
+          'Please Use manifest.ignoreDrmInfo instead.');
+      config['manifest']['ignoreDrmInfo'] =
+          config['manifest']['dash']['ignoreDrmInfo'];
+      delete config['manifest']['dash']['ignoreDrmInfo'];
+    }
+
     // Deprecate AdvancedDrmConfiguration's videoRobustness and audioRobustness
     // as a string. It's now an array of strings.
     if (config['drm'] && config['drm']['advanced']) {

lib/util/player_configuration.js

@@ -128,9 +128,9 @@ shaka.util.PlayerConfiguration = class {
       continueLoadingWhenPaused: true,
       ignoreSupplementalCodecs: false,
       updatePeriod: -1,
+      ignoreDrmInfo: false,
       dash: {
         clockSyncUri: '',
-        ignoreDrmInfo: false,
         disableXlinkProcessing: true,
         xlinkFailGracefully: false,
         ignoreMinBufferTime: false,

test/dash/dash_parser_content_protection_unit.js

@@ -29,7 +29,7 @@ describe('DashParser ContentProtection', () => {
     const dashParser = new shaka.dash.DashParser();
 
     const config = shaka.util.PlayerConfiguration.createDefault().manifest;
-    config.dash.ignoreDrmInfo = ignoreDrmInfo || false;
+    config.ignoreDrmInfo = ignoreDrmInfo || false;
     dashParser.configure(config);
 
     const playerInterface = {

test/hls/hls_parser_unit.js

@@ -3714,6 +3714,49 @@ describe('HlsParser', () => {
     }
   });
 
+  it('does not construct DrmInfo with ignoreDrmInfo = true', async () => {
+    const master = [
+      '#EXTM3U\n',
+      '#EXT-X-STREAM-INF:BANDWIDTH=200,CODECS="avc1.4d401f",',
+      'RESOLUTION=960x540,FRAME-RATE=60\n',
+      'video\n',
+    ].join('');
+
+    const initDataBase64 =
+        'dGhpcyBpbml0IGRhdGEgY29udGFpbnMgaGlkZGVuIHNlY3JldHMhISE=';
+
+    const keyId = 'abc123';
+
+    const media = [
+      '#EXTM3U\n',
+      '#EXT-X-TARGETDURATION:6\n',
+      '#EXT-X-PLAYLIST-TYPE:VOD\n',
+      '#EXT-X-KEY:METHOD=SAMPLE-AES-CTR,',
+      'KEYID=0X' + keyId + ',',
+      'KEYFORMAT="urn:uuid:edef8ba9-79d6-4ace-a3c8-27dcd51d21ed",',
+      'URI="data:text/plain;base64,',
+      initDataBase64, '",\n',
+      '#EXT-X-MAP:URI="init.mp4"\n',
+      '#EXTINF:5,\n',
+      '#EXT-X-BYTERANGE:121090@616\n',
+      'main.mp4',
+    ].join('');
+
+    const manifest = shaka.test.ManifestGenerator.generate((manifest) => {
+      manifest.anyTimeline();
+      manifest.addPartialVariant((variant) => {
+        variant.addPartialStream(ContentType.VIDEO, (stream) => {
+        });
+      });
+      manifest.sequenceMode = sequenceMode;
+      manifest.type = shaka.media.ManifestParser.HLS;
+    });
+
+    config.ignoreDrmInfo = true;
+    await testHlsParser(master, media, manifest);
+    expect(newDrmInfoSpy).not.toHaveBeenCalled();
+  });
+
   it('constructs DrmInfo for Widevine', async () => {
     const master = [
       '#EXTM3U\n',