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.    */
  33.   constructor(player, videoContainer, video) {
  34.     /** @private {shaka.Player} */
  35.     this.player_ = player;
  37.     /** @private {!shaka.extern.UIConfiguration} */
  38.     this.config_ = this.defaultConfig_();
  40.     // Make sure this container is discoverable and that the UI can be reached
  41.     // through it.
  42.     videoContainer['dataset']['shakaPlayerContainer'] = '';
  43.     videoContainer['ui'] = this;
  45.     // Tag the container for mobile platforms, to allow different styles.
  46.     if (this.isMobile()) {
  47.       videoContainer.classList.add('shaka-mobile');
  48.     }
  50.     /** @private {shaka.ui.Controls} */
  51.     this.controls_ = new shaka.ui.Controls(
  52.         player, videoContainer, video, this.config_);
  54.     // Run the initial setup so that no configure() call is required for default
  55.     // settings.
  56.     this.configure({});
  58.     // If the browser's native controls are disabled, use UI TextDisplayer.
  59.     if (!video.controls) {
  60.       player.setVideoContainer(videoContainer);
  61.     }
  63.     videoContainer['ui'] = this;
  64.     video['ui'] = this;
  65.   }
  68.   /**
  69.    * @override
  70.    * @export
  71.    */
  72.   async destroy() {
  73.     if (this.controls_) {
  74.       await this.controls_.destroy();
  75.     }
  76.     this.controls_ = null;
  78.     if (this.player_) {
  79.       await this.player_.destroy();
  80.     }
  81.     this.player_ = null;
  82.   }
  85.   /**
  86.    * Detects if this is a mobile platform, in case you want to choose a
  87.    * different UI configuration on mobile devices.
  88.    *
  89.    * @return {boolean}
  90.    * @export
  91.    */
  92.   isMobile() {
  93.     return shaka.util.Platform.isMobile();
  94.   }
  97.   /**
  98.    * @return {!shaka.extern.UIConfiguration}
  99.    * @export
  100.    */
  101.   getConfiguration() {
  102.     const ret = this.defaultConfig_();
  103.     shaka.util.ConfigUtils.mergeConfigObjects(
  104.         ret, this.config_, this.defaultConfig_(),
  105.         /* overrides= */ {}, /* path= */ '');
  106.     return ret;
  107.   }
  110.   /**
  111.    * @param {string|!Object} config This should either be a field name or an
  112.    *   object following the form of {@link shaka.extern.UIConfiguration}, where
  113.    *   you may omit any field you do not wish to change.
  114.    * @param {*=} value This should be provided if the previous parameter
  115.    *   was a string field name.
  116.    * @export
  117.    */
  118.   configure(config, value) {
  119.     goog.asserts.assert(typeof(config) == 'object' || arguments.length == 2,
  120.         'String configs should have values!');
  122.     // ('fieldName', value) format
  123.     if (arguments.length == 2 && typeof(config) == 'string') {
  124.       config = shaka.util.ConfigUtils.convertToConfigObject(config, value);
  125.     }
  127.     goog.asserts.assert(typeof(config) == 'object', 'Should be an object!');
  129.     shaka.util.ConfigUtils.mergeConfigObjects(
  130.         this.config_, config, this.defaultConfig_(),
  131.         /* overrides= */ {}, /* path= */ '');
  133.     // If a cast receiver app id has been given, add a cast button to the UI
  134.     if (this.config_.castReceiverAppId &&
  135.         !this.config_.overflowMenuButtons.includes('cast')) {
  136.       this.config_.overflowMenuButtons.push('cast');
  137.     }
  139.     goog.asserts.assert(this.player_ != null, 'Should have a player!');
  141.     this.controls_.configure(this.config_);
  143.     this.controls_.dispatchEvent(new shaka.util.FakeEvent('uiupdated'));
  144.   }
  147.   /**
  148.    * @return {shaka.ui.Controls}
  149.    * @export
  150.    */
  151.   getControls() {
  152.     return this.controls_;
  153.   }
  156.   /**
  157.    * Enable or disable the custom controls.
  158.    *
  159.    * @param {boolean} enabled
  160.    * @export
  161.    */
  162.   setEnabled(enabled) {
  163.     this.controls_.setEnabledShakaControls(enabled);
  164.   }
  167.   /**
  168.    * @return {!shaka.extern.UIConfiguration}
  169.    * @private
  170.    */
  171.   defaultConfig_() {
  172.     const config = {
  173.       controlPanelElements: [
  174.         'play_pause',
  175.         'time_and_duration',
  176.         'spacer',
  177.         'mute',
  178.         'volume',
  179.         'fullscreen',
  180.         'overflow_menu',
  181.       ],
  182.       overflowMenuButtons: [
  183.         'captions',
  184.         'quality',
  185.         'language',
  186.         'picture_in_picture',
  187.         'cast',
  188.         'playback_rate',
  189.       ],
  190.       statisticsList: [
  191.         'width',
  192.         'height',
  193.         'corruptedFrames',
  194.         'decodedFrames',
  195.         'droppedFrames',
  196.         'drmTimeSeconds',
  197.         'licenseTime',
  198.         'liveLatency',
  199.         'loadLatency',
  200.         'bufferingTime',
  201.         'manifestTimeSeconds',
  202.         'estimatedBandwidth',
  203.         'streamBandwidth',
  204.         'maxSegmentDuration',
  205.         'pauseTime',
  206.         'playTime',
  207.         'completionPercent',
  208.       ],
  209.       contextMenuElements: [
  210.         'loop',
  211.         'picture_in_picture',
  212.         'statistics',
  213.       ],
  214.       playbackRates: [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2],
  215.       fastForwardRates: [2, 4, 8, 1],
  216.       rewindRates: [-1, -2, -4, -8],
  217.       addSeekBar: true,
  218.       addBigPlayButton: false,
  219.       customContextMenu: false,
  220.       castReceiverAppId: '',
  221.       castAndroidReceiverCompatible: false,
  222.       clearBufferOnQualityChange: true,
  223.       showUnbufferedStart: false,
  224.       seekBarColors: {
  225.         base: 'rgba(255, 255, 255, 0.3)',
  226.         buffered: 'rgba(255, 255, 255, 0.54)',
  227.         played: 'rgb(255, 255, 255)',
  228.         adBreaks: 'rgb(255, 204, 0)',
  229.       },
  230.       volumeBarColors: {
  231.         base: 'rgba(255, 255, 255, 0.54)',
  232.         level: 'rgb(255, 255, 255)',
  233.       },
  234.       trackLabelFormat: shaka.ui.Overlay.TrackLabelFormat.LANGUAGE,
  235.       fadeDelay: 0,
  236.       doubleClickForFullscreen: true,
  237.       singleClickForPlayAndPause: true,
  238.       enableKeyboardPlaybackControls: true,
  239.       enableFullscreenOnRotation: true,
  240.       forceLandscapeOnFullscreen: true,
  241.       enableTooltips: false,
  242.       keyboardSeekDistance: 5,
  243.     };
  245.     // Check AirPlay support
  246.     if (window.WebKitPlaybackTargetAvailabilityEvent) {
  247.       config.overflowMenuButtons.push('airplay');
  248.     }
  250.     // On mobile, by default, hide the volume slide and the small play/pause
  251.     // button and show the big play/pause button in the center.
  252.     // This is in line with default styles in Chrome.
  253.     if (this.isMobile()) {
  254.       config.addBigPlayButton = true;
  255.       config.controlPanelElements = config.controlPanelElements.filter(
  256.           (name) => name != 'play_pause' && name != 'volume');
  257.     }
  259.     return config;
  260.   }
  262.   /**
  263.    * @private
  264.    */
  265.   static async scanPageForShakaElements_() {
  266.     // Install built-in polyfills to patch browser incompatibilities.
  267.     shaka.polyfill.installAll();
  268.     // Check to see if the browser supports the basic APIs Shaka needs.
  269.     if (!shaka.Player.isBrowserSupported()) {
  270.       shaka.log.error('Shaka Player does not support this browser. ' +
  271.           'Please see https://tinyurl.com/y7s4j9tr for the list of ' +
  272.           'supported browsers.');
  274.       // After scanning the page for elements, fire a special "loaded" event for
  275.       // when the load fails. This will allow the page to react to the failure.
  276.       shaka.ui.Overlay.dispatchLoadedEvent_('shaka-ui-load-failed',
  277.           shaka.ui.Overlay.FailReasonCode.NO_BROWSER_SUPPORT);
  278.       return;
  279.     }
  281.     // Look for elements marked 'data-shaka-player-container'
  282.     // on the page. These will be used to create our default
  283.     // UI.
  284.     const containers = document.querySelectorAll(
  285.         '[data-shaka-player-container]');
  287.     // Look for elements marked 'data-shaka-player'. They will
  288.     // either be used in our default UI or with native browser
  289.     // controls.
  290.     const videos = document.querySelectorAll(
  291.         '[data-shaka-player]');
  293.     // Look for elements marked 'data-shaka-player-canvas'
  294.     // on the page. These will be used to create our default
  295.     // UI.
  296.     const canvases = document.querySelectorAll(
  297.         '[data-shaka-player-canvas]');
  299.     if (!videos.length && !containers.length) {
  300.       // No elements have been tagged with shaka attributes.
  301.     } else if (videos.length && !containers.length) {
  302.       // Just the video elements were provided.
  303.       for (const video of videos) {
  304.         // If the app has already manually created a UI for this element,
  305.         // don't create another one.
  306.         if (video['ui']) {
  307.           continue;
  308.         }
  309.         goog.asserts.assert(video.tagName.toLowerCase() == 'video',
  310.             'Should be a video element!');
  312.         const container = document.createElement('div');
  313.         const videoParent = video.parentElement;
  314.         videoParent.replaceChild(container, video);
  315.         container.appendChild(video);
  316.         let currentCanvas = null;
  317.         for (const canvas of canvases) {
  318.           goog.asserts.assert(canvas.tagName.toLowerCase() == 'canvas',
  319.               'Should be a canvas element!');
  320.           if (canvas.parentElement == container) {
  321.             currentCanvas = canvas;
  322.             break;
  323.           }
  324.         }
  325.         if (!currentCanvas) {
  326.           currentCanvas = document.createElement('canvas');
  327.           currentCanvas.classList.add('shaka-canvas-container');
  328.           container.appendChild(currentCanvas);
  329.         }
  330.         shaka.ui.Overlay.setupUIandAutoLoad_(container, video, currentCanvas);
  331.       }
  332.     } else {
  333.       for (const container of containers) {
  334.         // If the app has already manually created a UI for this element,
  335.         // don't create another one.
  336.         if (container['ui']) {
  337.           continue;
  338.         }
  339.         goog.asserts.assert(container.tagName.toLowerCase() == 'div',
  340.             'Container should be a div!');
  342.         let currentVideo = null;
  343.         for (const video of videos) {
  344.           goog.asserts.assert(video.tagName.toLowerCase() == 'video',
  345.               'Should be a video element!');
  346.           if (video.parentElement == container) {
  347.             currentVideo = video;
  348.             break;
  349.           }
  350.         }
  352.         if (!currentVideo) {
  353.           currentVideo = document.createElement('video');
  354.           currentVideo.setAttribute('playsinline', '');
  355.           container.appendChild(currentVideo);
  356.         }
  358.         let currentCanvas = null;
  359.         for (const canvas of canvases) {
  360.           goog.asserts.assert(canvas.tagName.toLowerCase() == 'canvas',
  361.               'Should be a canvas element!');
  362.           if (canvas.parentElement == container) {
  363.             currentCanvas = canvas;
  364.             break;
  365.           }
  366.         }
  367.         if (!currentCanvas) {
  368.           currentCanvas = document.createElement('canvas');
  369.           currentCanvas.classList.add('shaka-canvas-container');
  370.           container.appendChild(currentCanvas);
  371.         }
  373.         try {
  374.           // eslint-disable-next-line no-await-in-loop
  375.           await shaka.ui.Overlay.setupUIandAutoLoad_(
  376.               container, currentVideo, currentCanvas);
  377.         } catch (e) {
  378.           // This can fail if, for example, not every player file has loaded.
  379.           // Ad-block is a likely cause for this sort of failure.
  380.           shaka.log.error('Error setting up Shaka Player', e);
  381.           shaka.ui.Overlay.dispatchLoadedEvent_('shaka-ui-load-failed',
  382.               shaka.ui.Overlay.FailReasonCode.PLAYER_FAILED_TO_LOAD);
  383.           return;
  384.         }
  385.       }
  386.     }
  388.     // After scanning the page for elements, fire the "loaded" event.  This will
  389.     // let apps know they can use the UI library programmatically now, even if
  390.     // they didn't have any Shaka-related elements declared in their HTML.
  391.     shaka.ui.Overlay.dispatchLoadedEvent_('shaka-ui-loaded');
  392.   }
  395.   /**
  396.    * @param {string} eventName
  397.    * @param {shaka.ui.Overlay.FailReasonCode=} reasonCode
  398.    * @private
  399.    */
  400.   static dispatchLoadedEvent_(eventName, reasonCode) {
  401.     let detail = null;
  402.     if (reasonCode != undefined) {
  403.       detail = {
  404.         'reasonCode': reasonCode,
  405.       };
  406.     }
  407.     const uiLoadedEvent = new CustomEvent(eventName, {detail});
  408.     document.dispatchEvent(uiLoadedEvent);
  409.   }
  412.   /**
  413.    * @param {!Element} container
  414.    * @param {!Element} video
  415.    * @param {!Element} canvas
  416.    * @private
  417.    */
  418.   static async setupUIandAutoLoad_(container, video, canvas) {
  419.     // Create the UI
  420.     const player = new shaka.Player(
  421.         shaka.util.Dom.asHTMLMediaElement(video));
  422.     const ui = new shaka.ui.Overlay(player,
  423.         shaka.util.Dom.asHTMLElement(container),
  424.         shaka.util.Dom.asHTMLMediaElement(video));
  426.     // Attach Canvas used for LCEVC Decoding
  427.     player.attachCanvas(/** @type {HTMLCanvasElement} */(canvas));
  429.     // Get and configure cast app id.
  430.     let castAppId = '';
  432.     // Get and configure cast Android Receiver Compatibility
  433.     let castAndroidReceiverCompatible = false;
  435.     // Cast receiver id can be specified on either container or video.
  436.     // It should not be provided on both. If it was, we will use the last
  437.     // one we saw.
  438.     if (container['dataset'] &&
  439.         container['dataset']['shakaPlayerCastReceiverId']) {
  440.       castAppId = container['dataset']['shakaPlayerCastReceiverId'];
  441.       castAndroidReceiverCompatible =
  442.           container['dataset']['shakaPlayerCastAndroidReceiverCompatible'] ===
  443.           'true';
  444.     } else if (video['dataset'] &&
  445.                video['dataset']['shakaPlayerCastReceiverId']) {
  446.       castAppId = video['dataset']['shakaPlayerCastReceiverId'];
  447.       castAndroidReceiverCompatible =
  448.         video['dataset']['shakaPlayerCastAndroidReceiverCompatible'] === 'true';
  449.     }
  451.     if (castAppId.length) {
  452.       ui.configure({castReceiverAppId: castAppId,
  453.         castAndroidReceiverCompatible: castAndroidReceiverCompatible});
  454.     }
  456.     if (shaka.util.Dom.asHTMLMediaElement(video).controls) {
  457.       ui.getControls().setEnabledNativeControls(true);
  458.     }
  460.     // Get the source and load it
  461.     // Source can be specified either on the video element:
  462.     //  <video src='foo.m2u8'></video>
  463.     // or as a separate element inside the video element:
  464.     //  <video>
  465.     //    <source src='foo.m2u8'/>
  466.     //  </video>
  467.     // It should not be specified on both.
  468.     const src = video.getAttribute('src');
  469.     if (src) {
  470.       const sourceElem = document.createElement('source');
  471.       sourceElem.setAttribute('src', src);
  472.       video.appendChild(sourceElem);
  473.       video.removeAttribute('src');
  474.     }
  476.     for (const elem of video.querySelectorAll('source')) {
  477.       try { // eslint-disable-next-line no-await-in-loop
  478.         await ui.getControls().getPlayer().load(elem.getAttribute('src'));
  479.         break;
  480.       } catch (e) {
  481.         shaka.log.error('Error auto-loading asset', e);
  482.       }
  483.     }
  484.   }
  485. };
  487. /**
  488.  * Describes what information should show up in labels for selecting audio
  489.  * variants and text tracks.
  490.  *
  491.  * @enum {number}
  492.  * @export
  493.  */
  494. shaka.ui.Overlay.TrackLabelFormat = {
  495.   'LANGUAGE': 0,
  496.   'ROLE': 1,
  497.   'LANGUAGE_ROLE': 2,
  498.   'LABEL': 3,
  499. };
  501. /**
  502.  * Describes the possible reasons that the UI might fail to load.
  503.  *
  504.  * @enum {number}
  505.  * @export
  506.  */
  507. shaka.ui.Overlay.FailReasonCode = {
  508.   'NO_BROWSER_SUPPORT': 0,
  509.   'PLAYER_FAILED_TO_LOAD': 1,
  510. };
  513. if (document.readyState == 'complete') {
  514.   // Don't fire this event synchronously.  In a compiled bundle, the "shaka"
  515.   // namespace might not be exported to the window until after this point.
  516.   (async () => {
  517.     await Promise.resolve();
  518.     shaka.ui.Overlay.scanPageForShakaElements_();
  519.   })();
  520. } else {
  521.   window.addEventListener('load', shaka.ui.Overlay.scanPageForShakaElements_);
  522. }