fix: output-restricted event handling for unplayable streams #1305

alex-barstow · 2022-08-09T17:07:44Z

Description

This change will improve handling of EME 'keystatuschange' events of the type 'output-restricted', which occurs when the client does not meet HDCP compliance. The existing implementation uses blacklistCurrentPlaylist() to exclude a single playlist from ABR selection when such an event is encountered, but does not handle cases where there are multiple unplayable HD streams.

Specific Changes proposed

I am proposing we do the following:

When encountering an 'output-restricted', we should assume that this is due to HDCP non-compliance and that all HD playlists will be unplayable.
Therefore, exclude all HD playlists from ABR selection.
Unplayable segments may have already been buffered, so after excluding the HD playlists, perform a fastQualityChange_() which will clear the buffer and switch to a playable SD stream.

…form fastQualityChange_, update test

codecov · 2022-08-09T17:09:18Z

Codecov Report

Merging #1305 (4f0153d) into main (97e02fb) will increase coverage by 0.00%.
The diff coverage is 93.33%.

@@           Coverage Diff           @@
##             main    #1305   +/-   ##
=======================================
  Coverage   86.30%   86.31%           
=======================================
  Files          39       39           
  Lines        9842     9855   +13     
  Branches     2293     2298    +5     
=======================================
+ Hits         8494     8506   +12     
- Misses       1348     1349    +1

Impacted Files	Coverage Δ
src/videojs-http-streaming.js	`91.08% <93.33%> (+0.03%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

gesinger · 2022-08-10T11:12:47Z

src/videojs-http-streaming.js

@@ -1062,11 +1062,34 @@ class VhsHandler extends Component {

    this.player_.tech_.on('keystatuschange', (e) => {
      if (e.status === 'output-restricted') {


If we change this to:

if (e.status !== 'output-restricted') { return; }

we can remove a level of indentation.

Yup, should have done that.

gesinger · 2022-08-10T11:14:42Z

src/videojs-http-streaming.js

+        const masterPlaylist = this.masterPlaylistController_.media();
+        const excludedHDPlaylists = [];
+
+        if (masterPlaylist && masterPlaylist.playlists) {


Same for this line too, we can return early if these aren't available.

gesinger · 2022-08-10T11:17:27Z

src/videojs-http-streaming.js

-          message: `DRM keystatus changed to ${e.status}. Playlist will fail to play. Check for HDCP content.`,
-          blacklistDuration: Infinity
-        });
+        const masterPlaylist = this.masterPlaylistController_.media();


this.masterPlaylistController_.media() actually returns the currently active media playlist. You want

http-streaming/src/master-playlist-controller.js

Line 1665 in 97e02fb

master() {

Suggested change

const masterPlaylist = this.masterPlaylistController_.media();

const masterPlaylist = this.masterPlaylistController_.master();

gesinger · 2022-08-10T11:18:41Z

src/videojs-http-streaming.js

+          // Assume all HD streams are unplayable and exclude them from ABR selection, then perform
+          // a fastQualityChange to clear the buffer since it may already contain unplayable segments


Might be better to move the second part of the comment ("...clear the buffer since it may already contain unplayable segments") above the call to fastQualityChange_

gesinger · 2022-08-10T11:20:31Z

src/videojs-http-streaming.js

+              if (!playlist.excludeUntil || playlist.excludeUntil < Infinity) {
+
+                playlist.excludeUntil = Infinity;


I'm not sure if we need to check the current excludeUntil and can instead probably just set playlist.excludeUntil = Infinity;.

I added this to make sure we only exclude/clear buffer/switch playlists once in the event we get multiple output-restricted events, which I have encountered in testing.

gesinger · 2022-08-10T11:21:29Z

src/videojs-http-streaming.js

+          if (excludedHDPlaylists.length) {
+            videojs.log.warn(
+              'DRM keystatus changed to "output-restricted." Removing the following HD playlists ' +
+              'that will most likely fail to play and clearing already buffered HD segments. ' +


Technically, we're clearing a buffer which may contain more than just HD segments.

Suggested change

'that will most likely fail to play and clearing already buffered HD segments. ' +

'that will most likely fail to play and clearing the buffer. ' +

gesinger · 2022-08-10T11:22:46Z

src/videojs-http-streaming.js

+            videojs.log.warn(
+              'DRM keystatus changed to "output-restricted." Removing the following HD playlists ' +
+              'that will most likely fail to play and clearing already buffered HD segments. ' +
+              'Check for HDCP content.',


This may not always be an issue for the stream provider, but can instead involve, for instance, the client not having the right hardware to play back HDCP content. We can add something like:

`This may be due to HDCP restrictions on the stream and the capabilities of the current device."

gesinger · 2022-08-10T11:23:44Z

test/videojs-http-streaming.test.js

  };

-  const excludes = [];
+  this.player.tech_.vhs.masterPlaylistController_.media = () => {


Suggested change

this.player.tech_.vhs.masterPlaylistController_.media = () => {

this.player.tech_.vhs.masterPlaylistController_.master = () => {

…ideojs/http-streaming into fix-output-restricted-handling

alex-barstow added 2 commits August 5, 2022 13:04

modify output-restricted handling to exclude all HD playlists and per…

8dc7557

…form fastQualityChange_, update test

remove .only

97a650f

Merge branch 'main' into fix-output-restricted-handling

91e1238

alex-barstow requested a review from gesinger August 9, 2022 17:10

gesinger reviewed Aug 10, 2022

View reviewed changes

alex-barstow added 3 commits August 15, 2022 15:10

code review changes

999726c

Merge branch 'fix-output-restricted-handling' of https://github.com/v…

7174b72

…ideojs/http-streaming into fix-output-restricted-handling

fix conditional and test

4f0153d

alex-barstow requested a review from gesinger August 15, 2022 20:14

gesinger approved these changes Aug 16, 2022

View reviewed changes

misteroneill approved these changes Aug 17, 2022

View reviewed changes

misteroneill merged commit 23bbf84 into main Aug 17, 2022

misteroneill deleted the fix-output-restricted-handling branch August 17, 2022 17:22

misteroneill pushed a commit that referenced this pull request Aug 19, 2022

fix: output-restricted event handling for unplayable streams (#1305)

1c62a98

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: output-restricted event handling for unplayable streams #1305

fix: output-restricted event handling for unplayable streams #1305

alex-barstow commented Aug 9, 2022 •

edited

Loading

codecov bot commented Aug 9, 2022 •

edited

Loading

gesinger Aug 10, 2022

alex-barstow Aug 11, 2022

gesinger Aug 10, 2022

gesinger Aug 10, 2022

gesinger Aug 10, 2022

gesinger Aug 10, 2022

alex-barstow Aug 15, 2022

gesinger Aug 10, 2022

gesinger Aug 10, 2022

gesinger Aug 10, 2022

		@@ -1062,11 +1062,34 @@ class VhsHandler extends Component {

		this.player_.tech_.on('keystatuschange', (e) => {
		if (e.status === 'output-restricted') {

	const masterPlaylist = this.masterPlaylistController_.media();
	const masterPlaylist = this.masterPlaylistController_.master();

		// Assume all HD streams are unplayable and exclude them from ABR selection, then perform
		// a fastQualityChange to clear the buffer since it may already contain unplayable segments

		if (!playlist.excludeUntil \|\| playlist.excludeUntil < Infinity) {

		playlist.excludeUntil = Infinity;

	'that will most likely fail to play and clearing already buffered HD segments. ' +
	'that will most likely fail to play and clearing the buffer. ' +

	this.player.tech_.vhs.masterPlaylistController_.media = () => {
	this.player.tech_.vhs.masterPlaylistController_.master = () => {

fix: output-restricted event handling for unplayable streams #1305

fix: output-restricted event handling for unplayable streams #1305

Conversation

alex-barstow commented Aug 9, 2022 • edited Loading

Description

Specific Changes proposed

codecov bot commented Aug 9, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alex-barstow commented Aug 9, 2022 •

edited

Loading

codecov bot commented Aug 9, 2022 •

edited

Loading