User hooks for hls parser #1998

anuragkalia · 2019-06-14T14:29:41Z

This is regarding the issue #1983.

I have added an extra function onSegmentParsed on the playerInterface passed to each manifest parser. If the manifest parser wants, it can call the function with mime type, stream id, and data (whose format may differ according to the manifest parser) whenever it encounters a new fragment in its stream.

This function right now simply emits an event 'segmentparsed' from the player when this function is called.

Also find the unit tests to go along with it. And let me know if there is any improvement to be made. :)

Add `onSegmentParsed` to playerInterface for manifest parsers. This callback will be triggered to communicate custom metadata of the segment when it is being parsed in the manifest, and can be read on using the event 'segmentparsed'. Right now, only HLS is using this to communicate tags associated with each segment.

googlebot · 2019-06-14T14:29:49Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here (e.g. I signed it!) and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

lib/hls/hls_parser.js

lib/player.js

1. Refactor code+comments to make changes clearer 2. Document SegmentParsedEvent 3. Modify the format of SegmentParsedEvent

theodab

Thanks for the documentation! It's a real improvement.
I just have a few more requests.

lib/player.js

lib/hls/hls_parser.js

Removed the nested 'detail' property to match other events.

anuragkalia · 2019-06-15T04:42:42Z

I really appreciate the quick feedback. Have added jsdoc. Let me know if there is anything else that needs to be done.

In particular, should I add a test case for checking for the case when 'segmentparsed' is fired?

Aside: About the pull request process, I add a comment for each change you request and click 'Resolve'. Is that the correct process? How do you get notified on your end when I push a commit?

anuragkalia · 2019-06-15T08:02:23Z

I signed it!

anuragkalia · 2019-06-18T06:35:09Z

Hi, is there any update on this? I am also confused why googlebot is failing the CLA check.

anuragkalia · 2019-06-18T13:59:01Z

I signed it!

TheModMaker · 2019-06-18T15:11:13Z

Hi, is there any update on this? I am also confused why googlebot is failing the CLA check.

You need to sign the CLA with the email you use to login to GitHub. It appears the email you used in the commits has signed the CLA, but the login email for GitHub doesn't. I think you can also add the email you signed with to your GitHub account as an alternative email and that should work too.

anuragkalia · 2019-06-18T17:13:07Z

I have added the email Anurag.kalia@hotstar.com to github quite already. How much time does it take for Google it to check it again? Also, thanks a lot for taking your time out for this troubleshooting which has no relation to shaka-player. :)

anuragkalia · 2019-06-20T13:32:52Z

I signed it!

joeyparrish · 2019-06-20T21:40:43Z

lib/player.js

+ * @property {number} streamId
+ *   Id of the stream that segment belonged to.
+ * @property {*} segmentData
+ *   Its format depends on the manifest parser.


This seems particularly problematic to me. For one, it's not obvious what the DASH equivalent is to the HLS type you're sending through here. For another, the HLS type you're sending through here is an internal object, the format of which we should be free to change and the compiler should be free to rename. So I wouldn't want to send that outside the Player to the app.

I am still in the beginning of how DASH spec but, from my limited understanding, emsg is the equivalent in DASH. (I saw that emsg is handled separately in code right now). I would like to be corrected on this one. Moreover, given shaka does not intend to be restricted to HLS and DASH but intends to support any manifest, is it not good to provide a general purpose function for extracting custom data from the manifest?

I completely agree with the fact that right now we are sending an internal object directly. I did not account for the fact that users of the method could possibly mutate the object.

Thank you for your time and looking forward to your thoughts.

After thinking a little more about it, I realized that a user can always write their own parser if they have to read the custom data from the manifest. That exactly is something I wanted to avoid and thus came up with this PR.

Also, though emsg indicates segment specific details, it seems to be a feature of mp4 rather than DASH. Am I correct here?

The 'emsg' box is an MP4 box, but it came out of the DASH spec if I remember correctly. There is a schema specified in DASH that means "reload the manifest when you see this". Shaka Player handles that directly, and passes any other schema up to the application.

joeyparrish · 2019-06-20T21:41:18Z

lib/player.js

@@ -4249,6 +4269,26 @@ shaka.Player = class extends shaka.util.FakeEventTarget {
    }
  }

+  /**
+   * Callback from player


This is a method on Player, so this comment can't be right.

joeyparrish · 2019-06-20T21:41:59Z

test/hls/hls_live_unit.js

@@ -555,6 +565,67 @@ describe('HlsParser live', () => {
            master, media, [ref1], mediaWithAdditionalSegment, [ref1, ref2]);
      });

+      it('triggers segment parsed callbacks as segments appear', () => {


Thank you for adding tests!

vlee-harmonicinc · 2020-11-19T07:49:15Z

emsg came out of the DASH Spec, but its concept could be applied to HLS.
HLS support emsg box in MP4 now. It is added to metadata textTrack as cue, just like how HLS process id3 in ts. Below code could extract emsg message, tested in Safari 13 and 14 with browser native player.

        // player = HTMLMediaElement with src= CMAF HLS with emsg
	player.textTracks.addEventListener('addtrack', (event) => {
		if (event.track.kind === 'metadata') {
			event.track.mode = 'hidden';
			event.track.addEventListener('cuechange', (event) => {
				for (let cue of event.target.activeCues){
					console.log(cue.value.key, cue.value.data);
				}
			});
		}
	});

It would be nice if Shaka player support emsg of HLS.

joeyparrish · 2020-11-23T19:42:58Z

emsg came out of the DASH Spec, but its concept could be applied to HLS.
HLS support emsg box in MP4 now. It is added to metadata textTrack as cue, just like how HLS process id3 in ts. Below code could extract emsg message, tested in Safari 13 and 14 with browser native player.

...

It would be nice if Shaka player support emsg of HLS.

That sounds reasonable. Would you be willing to put together a PR to dispatch the appropriate Player events for that in src= mode? Thanks!

vlee-harmonicinc · 2020-12-10T02:46:57Z

Metadata event of src= mode has been already dispatched 6 months ago.
#2476

It seems that metadata in emsg (CMAF) + HLS + MSE mode has not been supported yet. streaming_engine ignores emsg if emsgSchemeIdUris does not exists.

avelad · 2022-06-03T10:27:51Z

@anuragkalia I see that there are conflicts to be able to merge, can you rebase?

avelad · 2022-06-13T06:12:46Z

Closing due to inactivity.

NoChance777 · 2022-06-13T11:06:07Z

Hello guys, I've been tracking this ticket for a while already. We need this feature for being able to extract scte35 events from a HLS stream.

avelad · 2022-06-13T11:11:29Z

This is an abandoned PR, right now we are not working on this functionality, if you are interested you can open a PR and we will review it as soon as possible. Thanks!

Anurag Kalia added 2 commits June 12, 2019 17:55

Add unit tests for onSegmentParsed

d794b4a

theodab requested changes Jun 14, 2019

View reviewed changes

lib/hls/hls_parser.js Outdated Show resolved Hide resolved

lib/hls/hls_parser.js Outdated Show resolved Hide resolved

lib/player.js Show resolved Hide resolved

Refactoring and documentation

df301ce

1. Refactor code+comments to make changes clearer 2. Document SegmentParsedEvent 3. Modify the format of SegmentParsedEvent

theodab requested changes Jun 14, 2019

View reviewed changes

lib/player.js Show resolved Hide resolved

lib/hls/hls_parser.js Outdated Show resolved Hide resolved

lib/hls/hls_parser.js Outdated Show resolved Hide resolved

Added type jsdoc + Changed SegmentParsedEvent

1540464

Removed the nested 'detail' property to match other events.

Fix: Build errors because of jsdoc

b83c2db

joeyparrish requested changes Jun 20, 2019

View reviewed changes

joeyparrish added the type: enhancement New feature or request label Sep 30, 2019

avelad added the status: waiting on response Waiting on a response from the reporter(s) of the issue label Jun 3, 2022

avelad closed this Jun 13, 2022

github-actions bot added the status: archived Archived and locked; will not be updated label Jul 25, 2023

github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2023

github-actions bot removed the status: waiting on response Waiting on a response from the reporter(s) of the issue label Jul 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

User hooks for hls parser #1998

User hooks for hls parser #1998

anuragkalia commented Jun 14, 2019

googlebot commented Jun 14, 2019

theodab left a comment

anuragkalia commented Jun 15, 2019

anuragkalia commented Jun 15, 2019

anuragkalia commented Jun 18, 2019

anuragkalia commented Jun 18, 2019

TheModMaker commented Jun 18, 2019

anuragkalia commented Jun 18, 2019

anuragkalia commented Jun 20, 2019

joeyparrish Jun 20, 2019

anuragkalia Jun 21, 2019 •

edited

Loading

anuragkalia Jun 21, 2019

joeyparrish Jul 2, 2019

joeyparrish Jun 20, 2019

joeyparrish Jun 20, 2019

vlee-harmonicinc commented Nov 19, 2020 •

edited

Loading

joeyparrish commented Nov 23, 2020

vlee-harmonicinc commented Dec 10, 2020 •

edited

Loading

avelad commented Jun 3, 2022

avelad commented Jun 13, 2022

NoChance777 commented Jun 13, 2022 •

edited

Loading

avelad commented Jun 13, 2022

User hooks for hls parser #1998

User hooks for hls parser #1998

Conversation

anuragkalia commented Jun 14, 2019

googlebot commented Jun 14, 2019

What to do if you already signed the CLA

Individual signers

Corporate signers

theodab left a comment

Choose a reason for hiding this comment

anuragkalia commented Jun 15, 2019

anuragkalia commented Jun 15, 2019

anuragkalia commented Jun 18, 2019

anuragkalia commented Jun 18, 2019

TheModMaker commented Jun 18, 2019

anuragkalia commented Jun 18, 2019

anuragkalia commented Jun 20, 2019

joeyparrish Jun 20, 2019

Choose a reason for hiding this comment

anuragkalia Jun 21, 2019 • edited Loading

Choose a reason for hiding this comment

anuragkalia Jun 21, 2019

Choose a reason for hiding this comment

joeyparrish Jul 2, 2019

Choose a reason for hiding this comment

joeyparrish Jun 20, 2019

Choose a reason for hiding this comment

joeyparrish Jun 20, 2019

Choose a reason for hiding this comment

vlee-harmonicinc commented Nov 19, 2020 • edited Loading

joeyparrish commented Nov 23, 2020

vlee-harmonicinc commented Dec 10, 2020 • edited Loading

avelad commented Jun 3, 2022

avelad commented Jun 13, 2022

NoChance777 commented Jun 13, 2022 • edited Loading

avelad commented Jun 13, 2022

anuragkalia Jun 21, 2019 •

edited

Loading

vlee-harmonicinc commented Nov 19, 2020 •

edited

Loading

vlee-harmonicinc commented Dec 10, 2020 •

edited

Loading

NoChance777 commented Jun 13, 2022 •

edited

Loading