@micromag/element-video 0.3.580 → 0.3.583

package/es/index.js

@@ -45,9 +45,11 @@ var propTypes = {
   onSuspend: PropTypes$1.func,
   onSuspended: PropTypes$1.func,
   onPlayError: PropTypes$1.func,
+  onQualityLevelChange: PropTypes$1.func,
   focusable: PropTypes$1.bool,
   withPoster: PropTypes$1.bool,
-  withLoading: PropTypes$1.bool
+  withLoading: PropTypes$1.bool,
+  qualityStartLevel: PropTypes$1.number
 };
 var defaultProps = {
   media: null,
@@ -79,9 +81,11 @@ var defaultProps = {
   onSuspend: null,
   onSuspended: null,
   onPlayError: null,
+  onQualityLevelChange: null,
   focusable: true,
   withPoster: false,
-  withLoading: false
+  withLoading: false,
+  qualityStartLevel: -1
 };
 var Video = function Video(_ref) {
   var media = _ref.media,
@@ -111,11 +115,13 @@ var Video = function Video(_ref) {
     customOnSuspend = _ref.onSuspend,
     onSuspended = _ref.onSuspended,
     onPlayError = _ref.onPlayError,
+    onQualityLevelChange = _ref.onQualityLevelChange,
     focusable = _ref.focusable,
     withPoster = _ref.withPoster,
     withLoading = _ref.withLoading,
     disablePictureInPicture = _ref.disablePictureInPicture,
-    disableHls = _ref.disableHls;
+    disableHls = _ref.disableHls,
+    qualityStartLevel = _ref.qualityStartLevel;
   var _ref2 = media || {},
     _ref2$url = _ref2.url,
     mediaUrl = _ref2$url === void 0 ? null : _ref2$url,
@@ -134,19 +140,19 @@ var Video = function Video(_ref) {
     return getMediaFilesAsArray(files);
   }, [files]);
   var finalThumbnail = useMediaThumbnail(media, thumbnail);
-  var _ref14 = useRef(null);
-  var currentTime = useMediaCurrentTime(_ref14.current, {
+  var _ref16 = useRef(null);
+  var currentTime = useMediaCurrentTime(_ref16.current, {
     id: mediaUrl,
     disabled: paused || onProgressStep === null
   });
-  var duration = useMediaDuration(_ref14.current, {
+  var duration = useMediaDuration(_ref16.current, {
     id: mediaUrl
   });
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
     showLoading = _useState2[0],
     setShowLoading = _useState2[1];
-  var ready = useMediaReady(_ref14.current, {
+  var ready = useMediaReady(_ref16.current, {
     id: mediaUrl
   });
   useEffect(function () {
@@ -161,11 +167,12 @@ var Video = function Video(_ref) {
       clearTimeout(id);
     };
   }, [mediaUrl, withLoading]);
-  var hlsIsSupported = useMemo(function () {
-    return Hls.isSupported();
-  }, [Hls]);
+  var _useState3 = useState(false),
+    _useState4 = _slicedToArray(_useState3, 2),
+    hlsFailed = _useState4[0],
+    setHlsFailed = _useState4[1];
   var hlsSources = useMemo(function () {
-    if (filesArray.length === 0 || disableHls) {
+    if (filesArray.length === 0 || disableHls || !Hls.isSupported() || hlsFailed) {
       return null;
     }
     return filesArray.filter(function (_ref4) {
@@ -175,44 +182,62 @@ var Video = function Video(_ref) {
         name = _ref4$name === void 0 ? null : _ref4$name;
       return mime === 'application/vnd.apple.mpegurl' || (name || '').endsWith('.m3u8');
     });
-  }, [filesArray, hlsIsSupported, disableHls]);
-  var _useState3 = useState(null),
-    _useState4 = _slicedToArray(_useState3, 2),
-    hlsJs = _useState4[0],
-    setHlsJs = _useState4[1];
-  useEffect(function () {
-    if (hlsJs !== null && _ref14.current !== null) {
-      hlsJs.attachMedia(_ref14.current);
-    }
-    return function () {
-      if (hlsJs !== null) {
-        hlsJs.detachMedia();
-        hlsJs.destroy();
-      }
-    };
-  }, [hlsJs, _ref14.current]);
-  var _useState5 = useState(0),
-    _useState6 = _slicedToArray(_useState5, 2);
-    _useState6[0];
-    var setHlsTsOffset = _useState6[1];
+  }, [filesArray, disableHls, hlsFailed]);
+  var _useState5 = useState(null),
+    _useState6 = _slicedToArray(_useState5, 2),
+    hlsJs = _useState6[0],
+    setHlsJs = _useState6[1];
+  var _useState7 = useState(0),
+    _useState8 = _slicedToArray(_useState7, 2),
+    hlsTsOffset = _useState8[0],
+    setHlsTsOffset = _useState8[1];
+
+  // initialize hls instance if an hls source is provided
   useEffect(function () {
-    if (_ref14.current === null || !hlsIsSupported) {
-      return;
-    }
-    if (hlsSources !== null && hlsSources.length > 0) {
-      setHlsTsOffset(0);
-      var hls = new Hls();
-      var _onHlsBufferAppended = function onHlsBufferAppended(eventName, _ref5) {
-        var frag = _ref5.frag;
+    setHlsTsOffset(0);
+    setHlsFailed(false);
+    if (shouldLoad && _ref16.current !== null && hlsSources !== null && hlsSources.length > 0) {
+      var hls = new Hls({
+        maxBufferLength: 15,
+        // seconds. prevents loading too much per screen.
+        startLevel: qualityStartLevel
+      });
+      hls.on(Hls.Events.LEVEL_SWITCHED, function (_, _ref5) {
+        var level = _ref5.level;
+        if (onQualityLevelChange !== null) {
+          onQualityLevelChange(level);
+        }
+      });
+      hls.on(Hls.Events.ERROR, function (_, _ref6) {
+        var isFatal = _ref6.fatal,
+          errorType = _ref6.type;
+        if (isFatal) {
+          switch (errorType) {
+            case Hls.ErrorTypes.MEDIA_ERROR:
+              // automatically try to recover from media errors
+              hls.recoverMediaError();
+              break;
+            case Hls.ErrorTypes.NETWORK_ERROR:
+              // happens when all retries and media options have been exhausted. in that case, fallback to mp4/webm playback
+              setHlsJs(null);
+              setHlsFailed(true);
+              break;
+          }
+        }
+      });
+
+      // compute hls timestamp offset when we get the first video fragment
+      var _onHlsBufferAppended = function onHlsBufferAppended(_, _ref7) {
+        var frag = _ref7.frag;
         var fragStart = frag.start,
           fragType = frag.type,
           _frag$sn = frag.sn,
           fragSn = _frag$sn === void 0 ? null : _frag$sn,
           _frag$elementaryStrea = frag.elementaryStreams.video,
           videoStream = _frag$elementaryStrea === void 0 ? null : _frag$elementaryStrea;
-        var _ref6 = videoStream || {},
-          _ref6$startPTS = _ref6.startPTS,
-          videoStartPTS = _ref6$startPTS === void 0 ? null : _ref6$startPTS;
+        var _ref8 = videoStream || {},
+          _ref8$startPTS = _ref8.startPTS,
+          videoStartPTS = _ref8$startPTS === void 0 ? null : _ref8$startPTS;
         if (fragType === 'main' && fragSn !== 'initSegment' && videoStartPTS !== null) {
           var tOffset = videoStartPTS - fragStart;
           hls.off(Hls.Events.BUFFER_APPENDED, _onHlsBufferAppended);
@@ -222,8 +247,30 @@ var Video = function Video(_ref) {
       hls.on(Hls.Events.BUFFER_APPENDED, _onHlsBufferAppended);
       hls.loadSource(hlsSources[0].url);
       setHlsJs(hls);
+    } else {
+      setHlsJs(null);
+    }
+  }, [shouldLoad, hlsSources, _ref16]);
+
+  // attach hls.js when the <video> ref is ready
+  useEffect(function () {
+    if (hlsJs !== null && _ref16.current !== null) {
+      hlsJs.attachMedia(_ref16.current);
+    }
+    return function () {
+      if (hlsJs !== null) {
+        hlsJs.detachMedia();
+        hlsJs.destroy();
+      }
+    };
+  }, [hlsJs, _ref16.current]);
+
+  // handle changes of qualityStartLevel when an hls.js instance exists
+  useEffect(function () {
+    if (hlsJs !== null) {
+      hlsJs.startLevel = qualityStartLevel;
     }
-  }, [hlsIsSupported, hlsSources, _ref14]);
+  }, [qualityStartLevel]);
   var sourceFiles = useMemo(function () {
     if (filesArray.length === 0 || hlsSources !== null && hlsSources.length > 0) {
       return null;
@@ -242,11 +289,11 @@ var Video = function Video(_ref) {
       var _file$mime2 = file.mime,
         mime = _file$mime2 === void 0 ? "video/".concat(fileHandle === 'h264' ? 'mp4' : fileHandle) : _file$mime2;
       var currentMimeFile = filesMap[mime] || null;
-      var _ref7 = currentMimeFile || {},
-        _ref7$id = _ref7.id,
-        currentId = _ref7$id === void 0 ? null : _ref7$id,
-        _ref7$handle = _ref7.handle,
-        currentHandle = _ref7$handle === void 0 ? null : _ref7$handle;
+      var _ref9 = currentMimeFile || {},
+        _ref9$id = _ref9.id,
+        currentId = _ref9$id === void 0 ? null : _ref9$id,
+        _ref9$handle = _ref9.handle,
+        currentHandle = _ref9$handle === void 0 ? null : _ref9$handle;
       var currentMimeHandle = currentHandle || currentId;
       return currentMimeFile === null || currentMimeHandle === 'original' ? _objectSpread(_objectSpread({}, filesMap), {}, _defineProperty({}, mime, file)) : filesMap;
     }, {});
@@ -256,14 +303,14 @@ var Video = function Video(_ref) {
   }, [filesArray, hlsSources]);
 
   // @NOTE: Media is an animated image and doesn't have source files in video formats
-  var _ref8 = filesArray.find(function (_ref9) {
-      var handle = _ref9.handle;
+  var _ref10 = filesArray.find(function (_ref11) {
+      var handle = _ref11.handle;
       return handle === 'original';
     }) || {},
-    _ref8$type = _ref8.type,
-    originalType = _ref8$type === void 0 ? null : _ref8$type,
-    _ref8$mime = _ref8.mime,
-    originalMime = _ref8$mime === void 0 ? mediaMime : _ref8$mime;
+    _ref10$type = _ref10.type,
+    originalType = _ref10$type === void 0 ? null : _ref10$type,
+    _ref10$mime = _ref10.mime,
+    originalMime = _ref10$mime === void 0 ? mediaMime : _ref10$mime;
   var originalFileIsImage = originalType === 'image' || originalMime !== null && originalMime.indexOf('image/') === 0;
   var isImageWithoutSourceFile = originalFileIsImage && (sourceFiles === null || sourceFiles.length === 0);
   var withSize = width !== null && height !== null;
@@ -273,7 +320,7 @@ var Video = function Video(_ref) {
     }
   }, [duration, customOnDurationChange]);
   var onVolumeChange = useCallback(function () {
-    var _ref$current = _ref14.current,
+    var _ref$current = _ref16.current,
       element = _ref$current === void 0 ? null : _ref$current;
     if (element === null) {
       return;
@@ -284,10 +331,10 @@ var Video = function Video(_ref) {
   }, [customOnVolumeChange]);
 
   // Manage suspend
-  var _useState7 = useState(false),
-    _useState8 = _slicedToArray(_useState7, 2),
-    isSuspended = _useState8[0],
-    setIsSuspended = _useState8[1];
+  var _useState9 = useState(false),
+    _useState10 = _slicedToArray(_useState9, 2),
+    isSuspended = _useState10[0],
+    setIsSuspended = _useState10[1];
   var onPlay = useCallback(function (e) {
     if (isSuspended) {
       setIsSuspended(false);
@@ -318,7 +365,7 @@ var Video = function Video(_ref) {
     }
   }, [ready, onReady]);
   useEffect(function () {
-    var _ref$current2 = _ref14.current,
+    var _ref$current2 = _ref16.current,
       element = _ref$current2 === void 0 ? null : _ref$current2;
     if (element === null) {
       return;
@@ -355,7 +402,7 @@ var Video = function Video(_ref) {
   }) : null, !isImageWithoutSourceFile ? /*#__PURE__*/React.createElement("video", {
     key: mediaUrl,
     ref: function ref(newRef) {
-      _ref14.current = newRef;
+      _ref16.current = newRef;
       if (mediaRef !== null && isFunction(mediaRef)) {
         mediaRef(newRef);
       } else if (mediaRef !== null) {
@@ -383,10 +430,12 @@ var Video = function Video(_ref) {
     onSuspend: onSuspend,
     "data-has-audio": hasAudio,
     "data-is-suspended": isSuspended,
+    "data-hls": hlsJs !== null,
+    "data-ts-offset": hlsTsOffset,
     "aria-hidden": true
-  }, (sourceFiles || []).map(function (_ref13) {
-    var sourceUrl = _ref13.url,
-      sourceMime = _ref13.mime;
+  }, (sourceFiles || []).map(function (_ref15) {
+    var sourceUrl = _ref15.url,
+      sourceMime = _ref15.mime;
     return /*#__PURE__*/React.createElement("source", {
       key: "".concat(sourceUrl, "-").concat(sourceMime),
       src: sourceUrl !== null ? "".concat(sourceUrl, "#t=0.001") : null,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@micromag/element-video",
-    "version": "0.3.580",
+    "version": "0.3.583",
     "private": false,
     "description": "",
     "keywords": [
@@ -59,8 +59,8 @@
     },
     "dependencies": {
         "@babel/runtime": "^7.13.10",
-        "@micromag/core": "^0.3.578",
-        "@micromag/element-closed-captions": "^0.3.578",
+        "@micromag/core": "^0.3.583",
+        "@micromag/element-closed-captions": "^0.3.583",
         "classnames": "^2.2.6",
         "hls.js": "^1.5.15",
         "lodash": "^4.17.21",
@@ -72,5 +72,5 @@
         "access": "public",
         "registry": "https://registry.npmjs.org/"
     },
-    "gitHead": "8534b331c1ddf17be6cb2bb33dc32f6ed31cf391"
+    "gitHead": "d899cc28ac1f5b552114d8bfcd668a9bb8ab651c"
 }