Source: ui/ui.js

  1. /*! @license
  2.  * Shaka Player
  3.  * Copyright 2016 Google LLC
  4.  * SPDX-License-Identifier: Apache-2.0
  5.  */
  8. goog.provide('shaka.ui.Overlay');
  9. goog.provide('shaka.ui.Overlay.FailReasonCode');
  10. goog.provide('shaka.ui.Overlay.TrackLabelFormat');
  12. goog.require('goog.asserts');
  13. goog.require('shaka.Player');
  14. goog.require('shaka.log');
  15. goog.require('shaka.polyfill');
  16. goog.require('shaka.ui.Controls');
  17. goog.require('shaka.util.ConfigUtils');
  18. goog.require('shaka.util.Dom');
  19. goog.require('shaka.util.FakeEvent');
  20. goog.require('shaka.util.IDestroyable');
  21. goog.require('shaka.util.Platform');
  23. /**
  24.  * @implements {shaka.util.IDestroyable}
  25.  * @export
  26.  */
  27. shaka.ui.Overlay = class {
  28.   /**
  29.    * @param {!shaka.Player} player
  30.    * @param {!HTMLElement} videoContainer
  31.    * @param {!HTMLMediaElement} video
  32.    * @param {?HTMLCanvasElement=} vrCanvas
  33.    */
  34.   constructor(player, videoContainer, video, vrCanvas = null) {
  35.     /** @private {shaka.Player} */
  36.     this.player_ = player;
  38.     /** @private {HTMLElement} */
  39.     this.videoContainer_ = videoContainer;
  41.     /** @private {!shaka.extern.UIConfiguration} */
  42.     this.config_ = this.defaultConfig_();
  44.     // Make sure this container is discoverable and that the UI can be reached
  45.     // through it.
  46.     videoContainer['dataset']['shakaPlayerContainer'] = '';
  47.     videoContainer['ui'] = this;
  49.     // Tag the container for mobile platforms, to allow different styles.
  50.     if (this.isMobile()) {
  51.       videoContainer.classList.add('shaka-mobile');
  52.     }
  54.     /** @private {shaka.ui.Controls} */
  55.     this.controls_ = new shaka.ui.Controls(
  56.         player, videoContainer, video, vrCanvas, this.config_);
  58.     // Run the initial setup so that no configure() call is required for default
  59.     // settings.
  60.     this.configure({});
  62.     // If the browser's native controls are disabled, use UI TextDisplayer.
  63.     if (!video.controls) {
  64.       player.setVideoContainer(videoContainer);
  65.     }
  67.     videoContainer['ui'] = this;
  68.     video['ui'] = this;
  69.   }
  72.   /**
  73.    * @override
  74.    * @export
  75.    */
  76.   async destroy() {
  77.     if (this.controls_) {
  78.       await this.controls_.destroy();
  79.     }
  80.     this.controls_ = null;
  82.     if (this.player_) {
  83.       await this.player_.destroy();
  84.     }
  85.     this.player_ = null;
  86.   }
  89.   /**
  90.    * Detects if this is a mobile platform, in case you want to choose a
  91.    * different UI configuration on mobile devices.
  92.    *
  93.    * @return {boolean}
  94.    * @export
  95.    */
  96.   isMobile() {
  97.     return shaka.util.Platform.isMobile();
  98.   }
  101.   /**
  102.    * @return {!shaka.extern.UIConfiguration}
  103.    * @export
  104.    */
  105.   getConfiguration() {
  106.     const ret = this.defaultConfig_();
  107.     shaka.util.ConfigUtils.mergeConfigObjects(
  108.         ret, this.config_, this.defaultConfig_(),
  109.         /* overrides= */ {}, /* path= */ '');
  110.     return ret;
  111.   }
  114.   /**
  115.    * @param {string|!Object} config This should either be a field name or an
  116.    *   object following the form of {@link shaka.extern.UIConfiguration}, where
  117.    *   you may omit any field you do not wish to change.
  118.    * @param {*=} value This should be provided if the previous parameter
  119.    *   was a string field name.
  120.    * @export
  121.    */
  122.   configure(config, value) {
  123.     goog.asserts.assert(typeof(config) == 'object' || arguments.length == 2,
  124.         'String configs should have values!');
  126.     // ('fieldName', value) format
  127.     if (arguments.length == 2 && typeof(config) == 'string') {
  128.       config = shaka.util.ConfigUtils.convertToConfigObject(config, value);
  129.     }
  131.     goog.asserts.assert(typeof(config) == 'object', 'Should be an object!');
  133.     shaka.util.ConfigUtils.mergeConfigObjects(
  134.         this.config_, config, this.defaultConfig_(),
  135.         /* overrides= */ {}, /* path= */ '');
  137.     // If a cast receiver app id has been given, add a cast button to the UI
  138.     if (this.config_.castReceiverAppId &&
  139.         !this.config_.overflowMenuButtons.includes('cast')) {
  140.       this.config_.overflowMenuButtons.push('cast');
  141.     }
  143.     goog.asserts.assert(this.player_ != null, 'Should have a player!');
  145.     this.controls_.configure(this.config_);
  147.     this.controls_.dispatchEvent(new shaka.util.FakeEvent('uiupdated'));
  148.   }
  151.   /**
  152.    * @return {shaka.ui.Controls}
  153.    * @export
  154.    */
  155.   getControls() {
  156.     return this.controls_;
  157.   }
  160.   /**
  161.    * Enable or disable the custom controls.
  162.    *
  163.    * @param {boolean} enabled
  164.    * @export
  165.    */
  166.   setEnabled(enabled) {
  167.     this.controls_.setEnabledShakaControls(enabled);
  168.   }
  171.   /**
  172.    * @return {!shaka.extern.UIConfiguration}
  173.    * @private
  174.    */
  175.   defaultConfig_() {
  176.     const config = {
  177.       controlPanelElements: [
  178.         'play_pause',
  179.         'time_and_duration',
  180.         'spacer',
  181.         'mute',
  182.         'volume',
  183.         'fullscreen',
  184.         'overflow_menu',
  185.       ],
  186.       overflowMenuButtons: [
  187.         'captions',
  188.         'quality',
  189.         'language',
  190.         'picture_in_picture',
  191.         'cast',
  192.         'playback_rate',
  193.         'recenter_vr',
  194.         'toggle_stereoscopic',
  195.       ],
  196.       statisticsList: [
  197.         'width',
  198.         'height',
  199.         'corruptedFrames',
  200.         'decodedFrames',
  201.         'droppedFrames',
  202.         'drmTimeSeconds',
  203.         'licenseTime',
  204.         'liveLatency',
  205.         'loadLatency',
  206.         'bufferingTime',
  207.         'manifestTimeSeconds',
  208.         'estimatedBandwidth',
  209.         'streamBandwidth',
  210.         'maxSegmentDuration',
  211.         'pauseTime',
  212.         'playTime',
  213.         'completionPercent',
  214.         'manifestSizeBytes',
  215.         'bytesDownloaded',
  216.         'nonFatalErrorCount',
  217.         'manifestPeriodCount',
  218.         'manifestGapCount',
  219.       ],
  220.       adStatisticsList: [
  221.         'loadTimes',
  222.         'averageLoadTime',
  223.         'started',
  224.         'playedCompletely',
  225.         'skipped',
  226.         'errors',
  227.       ],
  228.       contextMenuElements: [
  229.         'loop',
  230.         'picture_in_picture',
  231.         'save_video_frame',
  232.         'statistics',
  233.         'ad_statistics',
  234.       ],
  235.       playbackRates: [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2],
  236.       fastForwardRates: [2, 4, 8, 1],
  237.       rewindRates: [-1, -2, -4, -8],
  238.       addSeekBar: true,
  239.       addBigPlayButton: false,
  240.       customContextMenu: false,
  241.       castReceiverAppId: '',
  242.       castAndroidReceiverCompatible: false,
  243.       clearBufferOnQualityChange: true,
  244.       showUnbufferedStart: false,
  245.       seekBarColors: {
  246.         base: 'rgba(255, 255, 255, 0.3)',
  247.         buffered: 'rgba(255, 255, 255, 0.54)',
  248.         played: 'rgb(255, 255, 255)',
  249.         adBreaks: 'rgb(255, 204, 0)',
  250.       },
  251.       volumeBarColors: {
  252.         base: 'rgba(255, 255, 255, 0.54)',
  253.         level: 'rgb(255, 255, 255)',
  254.       },
  255.       trackLabelFormat: shaka.ui.Overlay.TrackLabelFormat.LANGUAGE,
  256.       textTrackLabelFormat: shaka.ui.Overlay.TrackLabelFormat.LANGUAGE,
  257.       fadeDelay: 0,
  258.       doubleClickForFullscreen: true,
  259.       singleClickForPlayAndPause: true,
  260.       enableKeyboardPlaybackControls: true,
  261.       enableFullscreenOnRotation: true,
  262.       forceLandscapeOnFullscreen: true,
  263.       enableTooltips: false,
  264.       keyboardSeekDistance: 5,
  265.       keyboardLargeSeekDistance: 60,
  266.       fullScreenElement: this.videoContainer_,
  267.       preferDocumentPictureInPicture: true,
  268.       showAudioChannelCountVariants: true,
  269.       seekOnTaps: navigator.maxTouchPoints > 0,
  270.       tapSeekDistance: 10,
  271.       refreshTickInSeconds: 0.125,
  272.       displayInVrMode: false,
  273.       defaultVrProjectionMode: 'equirectangular',
  274.     };
  276.     // eslint-disable-next-line no-restricted-syntax
  277.     if ('remote' in HTMLMediaElement.prototype) {
  278.       config.overflowMenuButtons.push('remote');
  279.     } else if (window.WebKitPlaybackTargetAvailabilityEvent) {
  280.       config.overflowMenuButtons.push('airplay');
  281.     }
  283.     // On mobile, by default, hide the volume slide and the small play/pause
  284.     // button and show the big play/pause button in the center.
  285.     // This is in line with default styles in Chrome.
  286.     if (this.isMobile()) {
  287.       config.addBigPlayButton = true;
  288.       config.controlPanelElements = config.controlPanelElements.filter(
  289.           (name) => name != 'play_pause' && name != 'volume');
  290.     }
  292.     // Set this button here to push it at the end.
  293.     config.overflowMenuButtons.push('save_video_frame');
  295.     return config;
  296.   }
  298.   /**
  299.    * @private
  300.    */
  301.   static async scanPageForShakaElements_() {
  302.     // Install built-in polyfills to patch browser incompatibilities.
  303.     shaka.polyfill.installAll();
  304.     // Check to see if the browser supports the basic APIs Shaka needs.
  305.     if (!shaka.Player.isBrowserSupported()) {
  306.       shaka.log.error('Shaka Player does not support this browser. ' +
  307.           'Please see https://tinyurl.com/y7s4j9tr for the list of ' +
  308.           'supported browsers.');
  310.       // After scanning the page for elements, fire a special "loaded" event for
  311.       // when the load fails. This will allow the page to react to the failure.
  312.       shaka.ui.Overlay.dispatchLoadedEvent_('shaka-ui-load-failed',
  313.           shaka.ui.Overlay.FailReasonCode.NO_BROWSER_SUPPORT);
  314.       return;
  315.     }
  317.     // Look for elements marked 'data-shaka-player-container'
  318.     // on the page. These will be used to create our default
  319.     // UI.
  320.     const containers = document.querySelectorAll(
  321.         '[data-shaka-player-container]');
  323.     // Look for elements marked 'data-shaka-player'. They will
  324.     // either be used in our default UI or with native browser
  325.     // controls.
  326.     const videos = document.querySelectorAll(
  327.         '[data-shaka-player]');
  329.     // Look for elements marked 'data-shaka-player-canvas'
  330.     // on the page. These will be used to create our default
  331.     // UI.
  332.     const canvases = document.querySelectorAll(
  333.         '[data-shaka-player-canvas]');
  335.     // Look for elements marked 'data-shaka-player-vr-canvas'
  336.     // on the page. These will be used to create our default
  337.     // UI.
  338.     const vrCanvases = document.querySelectorAll(
  339.         '[data-shaka-player-vr-canvas]');
  341.     if (!videos.length && !containers.length) {
  342.       // No elements have been tagged with shaka attributes.
  343.     } else if (videos.length && !containers.length) {
  344.       // Just the video elements were provided.
  345.       for (const video of videos) {
  346.         // If the app has already manually created a UI for this element,
  347.         // don't create another one.
  348.         if (video['ui']) {
  349.           continue;
  350.         }
  351.         goog.asserts.assert(video.tagName.toLowerCase() == 'video',
  352.             'Should be a video element!');
  354.         const container = document.createElement('div');
  355.         const videoParent = video.parentElement;
  356.         videoParent.replaceChild(container, video);
  357.         container.appendChild(video);
  358.         const {lcevcCanvas, vrCanvas} =
  359.             shaka.ui.Overlay.findOrMakeSpecialCanvases_(
  360.                 container, canvases, vrCanvases);
  361.         shaka.ui.Overlay.setupUIandAutoLoad_(
  362.             container, video, lcevcCanvas, vrCanvas);
  363.       }
  364.     } else {
  365.       for (const container of containers) {
  366.         // If the app has already manually created a UI for this element,
  367.         // don't create another one.
  368.         if (container['ui']) {
  369.           continue;
  370.         }
  371.         goog.asserts.assert(container.tagName.toLowerCase() == 'div',
  372.             'Container should be a div!');
  374.         let currentVideo = null;
  375.         for (const video of videos) {
  376.           goog.asserts.assert(video.tagName.toLowerCase() == 'video',
  377.               'Should be a video element!');
  378.           if (video.parentElement == container) {
  379.             currentVideo = video;
  380.             break;
  381.           }
  382.         }
  384.         if (!currentVideo) {
  385.           currentVideo = document.createElement('video');
  386.           currentVideo.setAttribute('playsinline', '');
  387.           container.appendChild(currentVideo);
  388.         }
  389.         const {lcevcCanvas, vrCanvas} =
  390.             shaka.ui.Overlay.findOrMakeSpecialCanvases_(
  391.                 container, canvases, vrCanvases);
  392.         try {
  393.           // eslint-disable-next-line no-await-in-loop
  394.           await shaka.ui.Overlay.setupUIandAutoLoad_(
  395.               container, currentVideo, lcevcCanvas, vrCanvas);
  396.         } catch (e) {
  397.           // This can fail if, for example, not every player file has loaded.
  398.           // Ad-block is a likely cause for this sort of failure.
  399.           shaka.log.error('Error setting up Shaka Player', e);
  400.           shaka.ui.Overlay.dispatchLoadedEvent_('shaka-ui-load-failed',
  401.               shaka.ui.Overlay.FailReasonCode.PLAYER_FAILED_TO_LOAD);
  402.           return;
  403.         }
  404.       }
  405.     }
  407.     // After scanning the page for elements, fire the "loaded" event.  This will
  408.     // let apps know they can use the UI library programmatically now, even if
  409.     // they didn't have any Shaka-related elements declared in their HTML.
  410.     shaka.ui.Overlay.dispatchLoadedEvent_('shaka-ui-loaded');
  411.   }
  414.   /**
  415.    * @param {string} eventName
  416.    * @param {shaka.ui.Overlay.FailReasonCode=} reasonCode
  417.    * @private
  418.    */
  419.   static dispatchLoadedEvent_(eventName, reasonCode) {
  420.     let detail = null;
  421.     if (reasonCode != undefined) {
  422.       detail = {
  423.         'reasonCode': reasonCode,
  424.       };
  425.     }
  426.     const uiLoadedEvent = new CustomEvent(eventName, {detail});
  427.     document.dispatchEvent(uiLoadedEvent);
  428.   }
  431.   /**
  432.    * @param {!Element} container
  433.    * @param {!Element} video
  434.    * @param {!Element} lcevcCanvas
  435.    * @param {!Element} vrCanvas
  436.    * @private
  437.    */
  438.   static async setupUIandAutoLoad_(container, video, lcevcCanvas, vrCanvas) {
  439.     // Create the UI
  440.     const player = new shaka.Player();
  441.     const ui = new shaka.ui.Overlay(player,
  442.         shaka.util.Dom.asHTMLElement(container),
  443.         shaka.util.Dom.asHTMLMediaElement(video),
  444.         shaka.util.Dom.asHTMLCanvasElement(vrCanvas));
  446.     // Attach Canvas used for LCEVC Decoding
  447.     player.attachCanvas(/** @type {HTMLCanvasElement} */(lcevcCanvas));
  449.     // Get and configure cast app id.
  450.     let castAppId = '';
  452.     // Get and configure cast Android Receiver Compatibility
  453.     let castAndroidReceiverCompatible = false;
  455.     // Cast receiver id can be specified on either container or video.
  456.     // It should not be provided on both. If it was, we will use the last
  457.     // one we saw.
  458.     if (container['dataset'] &&
  459.         container['dataset']['shakaPlayerCastReceiverId']) {
  460.       castAppId = container['dataset']['shakaPlayerCastReceiverId'];
  461.       castAndroidReceiverCompatible =
  462.           container['dataset']['shakaPlayerCastAndroidReceiverCompatible'] ===
  463.           'true';
  464.     } else if (video['dataset'] &&
  465.                video['dataset']['shakaPlayerCastReceiverId']) {
  466.       castAppId = video['dataset']['shakaPlayerCastReceiverId'];
  467.       castAndroidReceiverCompatible =
  468.         video['dataset']['shakaPlayerCastAndroidReceiverCompatible'] === 'true';
  469.     }
  471.     if (castAppId.length) {
  472.       ui.configure({castReceiverAppId: castAppId,
  473.         castAndroidReceiverCompatible: castAndroidReceiverCompatible});
  474.     }
  476.     if (shaka.util.Dom.asHTMLMediaElement(video).controls) {
  477.       ui.getControls().setEnabledNativeControls(true);
  478.     }
  480.     // Get the source and load it
  481.     // Source can be specified either on the video element:
  482.     //  <video src='foo.m2u8'></video>
  483.     // or as a separate element inside the video element:
  484.     //  <video>
  485.     //    <source src='foo.m2u8'/>
  486.     //  </video>
  487.     // It should not be specified on both.
  488.     const src = video.getAttribute('src');
  489.     if (src) {
  490.       const sourceElem = document.createElement('source');
  491.       sourceElem.setAttribute('src', src);
  492.       video.appendChild(sourceElem);
  493.       video.removeAttribute('src');
  494.     }
  496.     await player.attach(shaka.util.Dom.asHTMLMediaElement(video));
  498.     for (const elem of video.querySelectorAll('source')) {
  499.       try { // eslint-disable-next-line no-await-in-loop
  500.         await ui.getControls().getPlayer().load(elem.getAttribute('src'));
  501.         break;
  502.       } catch (e) {
  503.         shaka.log.error('Error auto-loading asset', e);
  504.       }
  505.     }
  506.   }
  509.   /**
  510.    * @param {!Element} container
  511.    * @param {!NodeList.<!Element>} canvases
  512.    * @param {!NodeList.<!Element>} vrCanvases
  513.    * @return {{lcevcCanvas: !Element, vrCanvas: !Element}}
  514.    * @private
  515.    */
  516.   static findOrMakeSpecialCanvases_(container, canvases, vrCanvases) {
  517.     let lcevcCanvas = null;
  518.     for (const canvas of canvases) {
  519.       goog.asserts.assert(canvas.tagName.toLowerCase() == 'canvas',
  520.           'Should be a canvas element!');
  521.       if (canvas.parentElement == container) {
  522.         lcevcCanvas = canvas;
  523.         break;
  524.       }
  525.     }
  526.     if (!lcevcCanvas) {
  527.       lcevcCanvas = document.createElement('canvas');
  528.       lcevcCanvas.classList.add('shaka-canvas-container');
  529.       container.appendChild(lcevcCanvas);
  530.     }
  531.     let vrCanvas = null;
  532.     for (const canvas of vrCanvases) {
  533.       goog.asserts.assert(canvas.tagName.toLowerCase() == 'canvas',
  534.           'Should be a canvas element!');
  535.       if (canvas.parentElement == container) {
  536.         vrCanvas = canvas;
  537.         break;
  538.       }
  539.     }
  540.     if (!vrCanvas) {
  541.       vrCanvas = document.createElement('canvas');
  542.       vrCanvas.classList.add('shaka-vr-canvas-container');
  543.       container.appendChild(vrCanvas);
  544.     }
  545.     return {
  546.       lcevcCanvas,
  547.       vrCanvas,
  548.     };
  549.   }
  550. };
  552. /**
  553.  * Describes what information should show up in labels for selecting audio
  554.  * variants and text tracks.
  555.  *
  556.  * @enum {number}
  557.  * @export
  558.  */
  559. shaka.ui.Overlay.TrackLabelFormat = {
  560.   'LANGUAGE': 0,
  561.   'ROLE': 1,
  562.   'LANGUAGE_ROLE': 2,
  563.   'LABEL': 3,
  564. };
  566. /**
  567.  * Describes the possible reasons that the UI might fail to load.
  568.  *
  569.  * @enum {number}
  570.  * @export
  571.  */
  572. shaka.ui.Overlay.FailReasonCode = {
  573.   'NO_BROWSER_SUPPORT': 0,
  574.   'PLAYER_FAILED_TO_LOAD': 1,
  575. };
  578. if (document.readyState == 'complete') {
  579.   // Don't fire this event synchronously.  In a compiled bundle, the "shaka"
  580.   // namespace might not be exported to the window until after this point.
  581.   (async () => {
  582.     await Promise.resolve();
  583.     shaka.ui.Overlay.scanPageForShakaElements_();
  584.   })();
  585. } else {
  586.   window.addEventListener('load', shaka.ui.Overlay.scanPageForShakaElements_);
  587. }