Videojs

[Natkeeran]

! Important - This is for review and feedback.

JIRA Ticket: (link)

• Use-a-thon: Oral History Transcriptions documentation#1305

• Add Captions, Subtitles, and Interactive Transcripts  documentation#1003

• Drupal core issue about vtt - https://www.drupal.org/project/drupal/issues/3057144

• Drupal videojs module issue about audio support - https://www.drupal.org/project/videojs/issues/2698357

What does this Pull Request do?

This PR enables you to add transcript(s) to video/audio objects when using videojs viewer.

What's new?

• islandora_videojs sub module which is a plugin extending https://www.drupal.org/project/videojs module.

How should this be tested?

• Install videojs module. This branch: https://github.com/Natkeeran/videojs/tree/mimes. This adds the mimetypes info needed to display audio.
• Get this PR for islandora.
• Add transcript vocabulary item: http://localhost:8000/admin/structure/taxonomy/manage/islandora_media_use/overview (note the path)
• (Verify that path is same as here: https://github.com/digitalutsc/islandora/blob/videojs/modules/islandora_videojs/islandora_videojs.module#L90. I am not sure what is the best method to filter for transcript media files. At the least, this will be made into a config.)
• Modify the field.field.media.file.field_media_file.yml config to allow for vtt extensions to be uploaded.
• Note that currently authentication is hard coded: https://github.com/digitalutsc/islandora/blob/videojs/modules/islandora_videojs/islandora_videojs.module#L79
• Go to audio and video Manage display and choose Video.js: http://localhost:8000/admin/structure/media/manage/audio/display and http://localhost:8000/admin/structure/media/manage/video/display
• Create an audio and/or video. Add a media -> file. Select Transcript for Media Use. Save.
• In the viewer, it should display the captions.

Notes and Questions

• Is videojs the player we are looking to support?
• Do we want to create PR for videojs drupal module to add the mimetypes?
• Can we better implement this: https://github.com/digitalutsc/islandora/blob/videojs/modules/islandora_videojs/islandora_videojs.module#L60. i.e jsonapi?. What is the best method to filter for a particular media use other than to use the term path (i.e /taxonomy/term/20)?
• Language can be easily added by adding a language field and passing that to the twig template.

Interested parties

@dannylamb @seth-shaw-unlv @DonRichards

[seth-shaw-unlv]

A few non-code related notes (I'll add code comments separately):

• One step missing from the instructions is to enable the islandora_videojs module (e.g. drush en -y islandora_videojs).
• Even then, you need to view the Media's page to see the captions; the videojs player does not show up on the repository_item page. (I suspect due to how the EVAs work.)
• Also, and I'm not quite sure where the error is, but part way through my test video the videojs player crashed and did so again after refreshing the page. Now, when I went back to screen-shot the error, it played just fine. (I hate intermittent bugs... especially when they aren't logged anywhere.)
• The build failed on coding standards. Please use phpcbf.

[seth-shaw-unlv]

Also need to clean up for coding standards.

[seth-shaw-unlv]

You can avoid the Guzzle work by using IslandoraUtils. After you lookup the Term ID, e.g. $transcript_term = getTermForUri('http://pcdm.org/use#Transcript');, take your $node from the routeMatch and use getMediaWithTerm to find your Transcript Media, e.g. $media = getMediaWithTerm($node, $transcript);.

[dannylamb]

Between IslandoraUtils and the MediaSourceService you can replace huge chunks of this.

[elizoller]

@Natkeeran are you still working on this?

[elizoller]

@Natkeeran I'm keen to see this work make its way into Islandora. Is there anything I can do to help?

[seth-shaw-unlv]

@elizoller, we may need to consider this PR abandoned. I would probably grab my own branch of Islandora, apply this PR's patch file to your branch, and then address the various comments made on this PR to continue cleaning it up before making a new PR.

[elizoller]

ok, thanks for the advice @seth-shaw-unlv

[DonRichards]

Is this still going to be merged?

[elizoller]

i contributed the work that uses HTML5 video and audio players instead of videojs. i vaguely remember there may have been some community concern about including videojs when it can cost money. but thats a vague memory so if others know something different, please chime in.