feat: add mediaSource.addExtraFeaturesToSourceBuffer (#6362)

Closes #6358

demo/config.js

@@ -558,8 +558,6 @@ shakaDemo.Config = class {
 
     const docLink = this.resolveExternLink_('.MediaSourceConfiguration');
     this.addSection_('Media source', docLink)
-        .addTextInput_('Source buffer extra features',
-            'mediaSource.sourceBufferExtraFeatures')
         .addBoolInput_('Force Transmux', 'mediaSource.forceTransmux')
         .addBoolInput_('Insert fake encryption in init segments when needed ' +
             'by the platform.', 'mediaSource.insertFakeEncryptionInInit')

docs/tutorials/upgrade.md

@@ -101,6 +101,7 @@ application:
       `getAttribute()` and `textContent` results must now be decoded if they might contain
       escape sequences. You can use `shaka.util.StringUtils.htmlUnescape` for this purpose.
     - `streaming.useNativeHlsOnSafari` has removed. Now we have another config to do the same for FairPlay `streaming.useNativeHlsForFairPlay` or for HLS (any browser) `streaming.preferNativeHls`.
+    - `mediaSource.sourceBufferExtraFeatures` has been replaced with `mediaSource.addExtraFeaturesToSourceBuffer` callback.
 
   - Plugin changes:
     - `Transmuxer` plugins now has three new parameters in `transmux()` method.

externs/shaka/player.js

@@ -1383,7 +1383,7 @@ shaka.extern.StreamingConfiguration;
 /**
  * @typedef {{
  *   codecSwitchingStrategy: shaka.config.CodecSwitchingStrategy,
- *   sourceBufferExtraFeatures: string,
+ *   addExtraFeaturesToSourceBuffer: function(string): string,
  *   forceTransmux: boolean,
  *   insertFakeEncryptionInInit: boolean,
  *   modifyCueCallback: shaka.extern.TextParser.ModifyCueCallback
@@ -1397,10 +1397,12 @@ shaka.extern.StreamingConfiguration;
  *   SourceBuffer.changeType. RELOAD uses cycling of MediaSource.
  *   Defaults to SMOOTH if SMOOTH codec switching is supported, RELOAD
  *   overwise.
- * @property {string} sourceBufferExtraFeatures
+ * @property {function(string): string} addExtraFeaturesToSourceBuffer
+ *   Callback to generate extra features striug based on used MIME type.
  *   Some platforms may need to pass features when initializing the
  *   sourceBuffer.
- *   This string is ultimately appended to MIME types in addSourceBuffer().
+ *   This string is ultimately appended to a MIME type in addSourceBuffer() &
+ *   changeType().
  * @property {boolean} forceTransmux
  *   If this is <code>true</code>, we will transmux AAC and TS content even if
  *   not strictly necessary for the assets to be played.

lib/media/media_source_engine.js

@@ -507,7 +507,7 @@ shaka.media.MediaSourceEngine = class {
               transmuxer.convertCodecs(contentType, mimeTypeWithAllCodecs);
         }
       }
-      const type = mimeType + this.config_.sourceBufferExtraFeatures;
+      const type = this.addExtraFeaturesToMimeType_(mimeType);
 
       this.destroyer_.ensureNotDestroyed();
 
@@ -1680,7 +1680,7 @@ shaka.media.MediaSourceEngine = class {
       if (transmuxer) {
         this.transmuxers_[contentType] = transmuxer;
       }
-      const type = mimeType + this.config_.sourceBufferExtraFeatures;
+      const type = this.addExtraFeaturesToMimeType_(mimeType);
       this.sourceBuffers_[contentType].changeType(type);
       this.sourceBufferTypes_[contentType] = mimeType;
     } else {
@@ -1997,6 +1997,19 @@ shaka.media.MediaSourceEngine = class {
   updateLcevcDec(lcevcDec) {
     this.lcevcDec_ = lcevcDec;
   }
+
+  /**
+   * @param {string} mimeType
+   * @return {string}
+   * @private
+   */
+  addExtraFeaturesToMimeType_(mimeType) {
+    const extraFeatures = this.config_.addExtraFeaturesToSourceBuffer(mimeType);
+    const extendedType = mimeType + extraFeatures;
+    shaka.log.debug('Using full mime type', extendedType);
+
+    return extendedType;
+  }
 };
 
 

lib/util/player_configuration.js

@@ -346,7 +346,11 @@ shaka.util.PlayerConfiguration = class {
 
     const mediaSource = {
       codecSwitchingStrategy: codecSwitchingStrategy,
-      sourceBufferExtraFeatures: '',
+      addExtraFeaturesToSourceBuffer: (mimeType) => {
+        return shaka.util.ConfigUtils.referenceParametersAndReturn(
+            [mimeType],
+            '');
+      },
       forceTransmux: false,
       insertFakeEncryptionInInit: true,
       modifyCueCallback: (cue, uri) => {

test/media/media_source_engine_unit.js

@@ -315,6 +315,29 @@ describe('MediaSourceEngine', () => {
       expect(shaka.text.TextEngine).not.toHaveBeenCalled();
     });
 
+    it('creates SourceBuffers with extra features', async () => {
+      const config = shaka.util.PlayerConfiguration.createDefault().mediaSource;
+      config.addExtraFeaturesToSourceBuffer = (mimeType) => {
+        if (mimeType.includes('audio')) {
+          return '; extra_audio_param';
+        }
+        if (mimeType.includes('video')) {
+          return '; extra_video_param';
+        }
+        return '';
+      };
+      mediaSourceEngine.configure(config);
+      const initObject = new Map();
+      initObject.set(ContentType.AUDIO, fakeAudioStream);
+      initObject.set(ContentType.VIDEO, fakeVideoStream);
+      await mediaSourceEngine.init(initObject, false);
+      expect(mockMediaSource.addSourceBuffer).toHaveBeenCalledWith(
+          'audio/mp4; extra_audio_param');
+      expect(mockMediaSource.addSourceBuffer).toHaveBeenCalledWith(
+          'video/mp4; extra_video_param');
+      expect(shaka.text.TextEngine).not.toHaveBeenCalled();
+    });
+
     it('creates TextEngines for text types', async () => {
       const initObject = new Map();
       initObject.set(ContentType.TEXT, fakeTextStream);