@remotion/player 4.1.0-alpha11 → 4.1.0-alpha12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/MediaVolumeSlider.d.ts +5 -0
  2. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/MediaVolumeSlider.js +115 -0
  3. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlaybackrateControl.d.ts +8 -0
  4. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlaybackrateControl.js +155 -0
  5. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Player.d.ts +52 -0
  6. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Player.js +151 -0
  7. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerControls.d.ts +42 -0
  8. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerControls.js +159 -0
  9. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerSeekBar.d.ts +8 -0
  10. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerSeekBar.js +142 -0
  11. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerUI.d.ts +40 -0
  12. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/PlayerUI.js +299 -0
  13. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/SharedPlayerContext.d.ts +16 -0
  14. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/SharedPlayerContext.js +72 -0
  15. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Thumbnail.d.ts +24 -0
  16. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/Thumbnail.js +41 -0
  17. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/ThumbnailUI.d.ts +11 -0
  18. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/ThumbnailUI.js +82 -0
  19. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-next-frame.d.ts +14 -0
  20. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-next-frame.js +24 -0
  21. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-scale.d.ts +39 -0
  22. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/calculate-scale.js +77 -0
  23. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/emitter-context.d.ts +4 -0
  24. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/emitter-context.js +3 -0
  25. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/error-boundary.d.ts +19 -0
  26. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/error-boundary.js +32 -0
  27. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/event-emitter.d.ts +81 -0
  28. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/event-emitter.js +98 -0
  29. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/format-time.d.ts +1 -0
  30. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/format-time.js +5 -0
  31. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/icons.d.ts +10 -0
  32. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/icons.js +39 -0
  33. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/index.d.ts +61 -0
  34. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/index.js +20 -0
  35. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/is-backgrounded.d.ts +2 -0
  36. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/is-backgrounded.js +20 -0
  37. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-css-classname.d.ts +1 -0
  38. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-css-classname.js +1 -0
  39. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-methods.d.ts +24 -0
  40. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/player-methods.js +1 -0
  41. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/index.test.d.ts +1 -0
  42. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/index.test.js +7 -0
  43. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/test-utils.d.ts +6 -0
  44. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/test-utils.js +14 -0
  45. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-in-out-frames.test.d.ts +1 -0
  46. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-in-out-frames.test.js +54 -0
  47. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-prop.test.d.ts +1 -0
  48. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/test/validate-prop.test.js +129 -0
  49. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-hover-state.d.ts +1 -0
  50. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-hover-state.js +23 -0
  51. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-playback.d.ts +7 -0
  52. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-playback.js +125 -0
  53. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-player.d.ts +19 -0
  54. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-player.js +147 -0
  55. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-thumbnail.d.ts +6 -0
  56. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-thumbnail.js +14 -0
  57. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-video-controls-resize.d.ts +11 -0
  58. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/use-video-controls-resize.js +35 -0
  59. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/calculate-player-size.d.ts +9 -0
  60. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/calculate-player-size.js +24 -0
  61. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/cancellable-promise.d.ts +5 -0
  62. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/cancellable-promise.js +22 -0
  63. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/delay.d.ts +1 -0
  64. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/delay.js +2 -0
  65. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/is-node.d.ts +1 -0
  66. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/is-node.js +1 -0
  67. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/preview-size.d.ts +8 -0
  68. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/preview-size.js +1 -0
  69. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/props-if-has-props.d.ts +10 -0
  70. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/props-if-has-props.js +1 -0
  71. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-cancellable-promises.d.ts +7 -0
  72. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-cancellable-promises.js +18 -0
  73. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-click-prevention-on-double-click.d.ts +3 -0
  74. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-click-prevention-on-double-click.js +42 -0
  75. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-component-visible.d.ts +6 -0
  76. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-component-visible.js +18 -0
  77. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-element-size.d.ts +16 -0
  78. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/use-element-size.js +127 -0
  79. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-in-out-frame.d.ts +6 -0
  80. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-in-out-frame.js +49 -0
  81. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-initial-frame.d.ts +4 -0
  82. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-initial-frame.js +23 -0
  83. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-playbackrate.d.ts +1 -0
  84. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/utils/validate-playbackrate.js +14 -0
  85. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/volume-persistance.d.ts +2 -0
  86. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/esm/volume-persistance.js +14 -0
  87. package/.rollup.cache/Users/jonathanburger/remotion/packages/player/dist/tsconfig-esm.tsbuildinfo +1 -0
  88. package/dist/cjs/Player.d.ts +1 -1
  89. package/dist/cjs/Player.js +1 -1
  90. package/dist/cjs/PlayerControls.d.ts +1 -1
  91. package/dist/cjs/PlayerControls.js +3 -1
  92. package/dist/cjs/PlayerUI.js +1 -3
  93. package/dist/cjs/SharedPlayerContext.js +1 -1
  94. package/dist/cjs/utils/use-element-size.js +21 -4
  95. package/dist/esm/Player.d.ts +1 -1
  96. package/dist/esm/PlayerControls.d.ts +1 -1
  97. package/dist/esm/error-boundary.d.ts +1 -1
  98. package/dist/esm/index.mjs +26 -9
  99. package/package.json +2 -6
  100. package/dist/tsconfig-esm.tsbuildinfo +0 -1
  101. package/dist/tsconfig.tsbuildinfo +0 -1
@@ -0,0 +1,159 @@
1
+ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { useEffect, useMemo, useRef, useState } from 'react';
3
+ import { Internals } from 'remotion';
4
+ import { formatTime } from './format-time.js';
5
+ import { FullscreenIcon, PauseIcon, PlayIcon } from './icons.js';
6
+ import { MediaVolumeSlider } from './MediaVolumeSlider.js';
7
+ import { PlaybackrateControl, playerButtonStyle } from './PlaybackrateControl.js';
8
+ import { PlayerSeekBar } from './PlayerSeekBar.js';
9
+ import { useHoverState } from './use-hover-state.js';
10
+ import { useVideoControlsResize, X_PADDING, } from './use-video-controls-resize.js';
11
+ const gradientSteps = [
12
+ 0, 0.013, 0.049, 0.104, 0.175, 0.259, 0.352, 0.45, 0.55, 0.648, 0.741, 0.825,
13
+ 0.896, 0.951, 0.987,
14
+ ];
15
+ const gradientOpacities = [
16
+ 0, 8.1, 15.5, 22.5, 29, 35.3, 41.2, 47.1, 52.9, 58.8, 64.7, 71, 77.5, 84.5,
17
+ 91.9,
18
+ ];
19
+ const globalGradientOpacity = 1 / 0.7;
20
+ const containerStyle = {
21
+ boxSizing: 'border-box',
22
+ position: 'absolute',
23
+ bottom: 0,
24
+ width: '100%',
25
+ paddingTop: 40,
26
+ paddingBottom: 10,
27
+ backgroundImage: `linear-gradient(to bottom,${gradientSteps
28
+ .map((g, i) => {
29
+ return `hsla(0, 0%, 0%, ${g}) ${gradientOpacities[i] * globalGradientOpacity}%`;
30
+ })
31
+ .join(', ')}, hsl(0, 0%, 0%) 100%)`,
32
+ backgroundSize: 'auto 145px',
33
+ display: 'flex',
34
+ paddingRight: X_PADDING,
35
+ paddingLeft: X_PADDING,
36
+ flexDirection: 'column',
37
+ transition: 'opacity 0.3s',
38
+ };
39
+ const controlsRow = {
40
+ display: 'flex',
41
+ flexDirection: 'row',
42
+ width: '100%',
43
+ alignItems: 'center',
44
+ justifyContent: 'center',
45
+ userSelect: 'none',
46
+ };
47
+ const leftPartStyle = {
48
+ display: 'flex',
49
+ flexDirection: 'row',
50
+ userSelect: 'none',
51
+ alignItems: 'center',
52
+ };
53
+ const xSpacer = {
54
+ width: 12,
55
+ };
56
+ const ySpacer = {
57
+ height: 8,
58
+ };
59
+ const flex1 = {
60
+ flex: 1,
61
+ };
62
+ const fullscreen = {};
63
+ const PlayPauseButton = ({ playing }) => playing ? _jsx(PauseIcon, {}) : _jsx(PlayIcon, {});
64
+ export const Controls = ({ durationInFrames, isFullscreen, fps, player, showVolumeControls, onFullscreenButtonClick, allowFullscreen, onExitFullscreenButtonClick, spaceKeyToPlayOrPause, onSeekEnd, onSeekStart, inFrame, outFrame, initiallyShowControls, canvasSize, renderPlayPauseButton, renderFullscreenButton, alwaysShowControls, showPlaybackRateControl, containerRef, }) => {
65
+ var _a;
66
+ const playButtonRef = useRef(null);
67
+ const frame = Internals.Timeline.useTimelinePosition();
68
+ const [supportsFullscreen, setSupportsFullscreen] = useState(false);
69
+ const hovered = useHoverState(containerRef);
70
+ const { maxTimeLabelWidth, displayVerticalVolumeSlider } = useVideoControlsResize({
71
+ allowFullscreen,
72
+ playerWidth: (_a = canvasSize === null || canvasSize === void 0 ? void 0 : canvasSize.width) !== null && _a !== void 0 ? _a : 0,
73
+ });
74
+ const [shouldShowInitially, setInitiallyShowControls] = useState(() => {
75
+ if (typeof initiallyShowControls === 'boolean') {
76
+ return initiallyShowControls;
77
+ }
78
+ if (typeof initiallyShowControls === 'number') {
79
+ if (initiallyShowControls % 1 !== 0) {
80
+ throw new Error('initiallyShowControls must be an integer or a boolean');
81
+ }
82
+ if (Number.isNaN(initiallyShowControls)) {
83
+ throw new Error('initiallyShowControls must not be NaN');
84
+ }
85
+ if (!Number.isFinite(initiallyShowControls)) {
86
+ throw new Error('initiallyShowControls must be finite');
87
+ }
88
+ if (initiallyShowControls <= 0) {
89
+ throw new Error('initiallyShowControls must be a positive integer');
90
+ }
91
+ return initiallyShowControls;
92
+ }
93
+ throw new TypeError('initiallyShowControls must be a number or a boolean');
94
+ });
95
+ const containerCss = useMemo(() => {
96
+ // Hide if playing and mouse outside
97
+ const shouldShow = hovered || !player.playing || shouldShowInitially || alwaysShowControls;
98
+ return {
99
+ ...containerStyle,
100
+ opacity: Number(shouldShow),
101
+ };
102
+ }, [hovered, shouldShowInitially, player.playing, alwaysShowControls]);
103
+ useEffect(() => {
104
+ if (playButtonRef.current && spaceKeyToPlayOrPause) {
105
+ // This switches focus to play button when player.playing flag changes
106
+ playButtonRef.current.focus({
107
+ preventScroll: true,
108
+ });
109
+ }
110
+ }, [player.playing, spaceKeyToPlayOrPause]);
111
+ useEffect(() => {
112
+ var _a;
113
+ // Must be handled client-side to avoid SSR hydration mismatch
114
+ setSupportsFullscreen((_a = (typeof document !== 'undefined' &&
115
+ (document.fullscreenEnabled || document.webkitFullscreenEnabled))) !== null && _a !== void 0 ? _a : false);
116
+ }, []);
117
+ useEffect(() => {
118
+ if (shouldShowInitially === false) {
119
+ return;
120
+ }
121
+ const time = shouldShowInitially === true ? 2000 : shouldShowInitially;
122
+ const timeout = setTimeout(() => {
123
+ setInitiallyShowControls(false);
124
+ }, time);
125
+ return () => {
126
+ clearInterval(timeout);
127
+ };
128
+ }, [shouldShowInitially]);
129
+ const timeLabel = useMemo(() => {
130
+ return {
131
+ color: 'white',
132
+ fontFamily: 'sans-serif',
133
+ fontSize: 14,
134
+ maxWidth: maxTimeLabelWidth === null ? undefined : maxTimeLabelWidth,
135
+ overflow: 'hidden',
136
+ textOverflow: 'ellipsis',
137
+ };
138
+ }, [maxTimeLabelWidth]);
139
+ const playbackRates = useMemo(() => {
140
+ if (showPlaybackRateControl === true) {
141
+ return [0.5, 0.8, 1, 1.2, 1.5, 1.8, 2, 2.5, 3];
142
+ }
143
+ if (Array.isArray(showPlaybackRateControl)) {
144
+ for (const rate of showPlaybackRateControl) {
145
+ if (typeof rate !== 'number') {
146
+ throw new Error('Every item in showPlaybackRateControl must be a number');
147
+ }
148
+ if (rate <= 0) {
149
+ throw new Error('Every item in showPlaybackRateControl must be positive');
150
+ }
151
+ }
152
+ return showPlaybackRateControl;
153
+ }
154
+ return null;
155
+ }, [showPlaybackRateControl]);
156
+ return (_jsxs("div", { style: containerCss, children: [_jsxs("div", { style: controlsRow, children: [_jsxs("div", { style: leftPartStyle, children: [_jsx("button", { ref: playButtonRef, type: "button", style: playerButtonStyle, onClick: player.playing ? player.pause : player.play, "aria-label": player.playing ? 'Pause video' : 'Play video', title: player.playing ? 'Pause video' : 'Play video', children: renderPlayPauseButton === null ? (_jsx(PlayPauseButton, { playing: player.playing })) : (renderPlayPauseButton({ playing: player.playing })) }), showVolumeControls ? (_jsxs(_Fragment, { children: [_jsx("div", { style: xSpacer }), _jsx(MediaVolumeSlider, { displayVerticalVolumeSlider: displayVerticalVolumeSlider })] })) : null, _jsx("div", { style: xSpacer }), _jsxs("div", { style: timeLabel, children: [formatTime(frame / fps), " / ", formatTime(durationInFrames / fps)] }), _jsx("div", { style: xSpacer })] }), _jsx("div", { style: flex1 }), playbackRates && canvasSize && (_jsx(PlaybackrateControl, { canvasSize: canvasSize, playbackRates: playbackRates })), playbackRates && supportsFullscreen && allowFullscreen ? (_jsx("div", { style: xSpacer })) : null, _jsx("div", { style: fullscreen, children: supportsFullscreen && allowFullscreen ? (_jsx("button", { type: "button", "aria-label": isFullscreen ? 'Exit fullscreen' : 'Enter Fullscreen', title: isFullscreen ? 'Exit fullscreen' : 'Enter Fullscreen', style: playerButtonStyle, onClick: isFullscreen
157
+ ? onExitFullscreenButtonClick
158
+ : onFullscreenButtonClick, children: renderFullscreenButton === null ? (_jsx(FullscreenIcon, { isFullscreen: isFullscreen })) : (renderFullscreenButton({ isFullscreen })) })) : null })] }), _jsx("div", { style: ySpacer }), _jsx(PlayerSeekBar, { onSeekEnd: onSeekEnd, onSeekStart: onSeekStart, durationInFrames: durationInFrames, inFrame: inFrame, outFrame: outFrame })] }));
159
+ };
@@ -0,0 +1,8 @@
1
+ /// <reference types="react" />
2
+ export declare const PlayerSeekBar: React.FC<{
3
+ durationInFrames: number;
4
+ onSeekStart: () => void;
5
+ onSeekEnd: () => void;
6
+ inFrame: number | null;
7
+ outFrame: number | null;
8
+ }>;
@@ -0,0 +1,142 @@
1
+ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
3
+ import { Internals, interpolate } from 'remotion';
4
+ import { useHoverState } from './use-hover-state.js';
5
+ import { usePlayer } from './use-player.js';
6
+ import { useElementSize } from './utils/use-element-size.js';
7
+ const getFrameFromX = (clientX, durationInFrames, width) => {
8
+ var _a;
9
+ const pos = clientX;
10
+ const frame = Math.round(interpolate(pos, [0, width], [0, (_a = durationInFrames - 1) !== null && _a !== void 0 ? _a : 0], {
11
+ extrapolateLeft: 'clamp',
12
+ extrapolateRight: 'clamp',
13
+ }));
14
+ return frame;
15
+ };
16
+ const BAR_HEIGHT = 5;
17
+ const KNOB_SIZE = 12;
18
+ const VERTICAL_PADDING = 4;
19
+ const containerStyle = {
20
+ userSelect: 'none',
21
+ paddingTop: VERTICAL_PADDING,
22
+ paddingBottom: VERTICAL_PADDING,
23
+ boxSizing: 'border-box',
24
+ cursor: 'pointer',
25
+ position: 'relative',
26
+ touchAction: 'none',
27
+ };
28
+ const barBackground = {
29
+ height: BAR_HEIGHT,
30
+ backgroundColor: 'rgba(255, 255, 255, 0.25)',
31
+ width: '100%',
32
+ borderRadius: BAR_HEIGHT / 2,
33
+ };
34
+ const findBodyInWhichDivIsLocated = (div) => {
35
+ let current = div;
36
+ while (current.parentElement) {
37
+ current = current.parentElement;
38
+ }
39
+ return current;
40
+ };
41
+ export const PlayerSeekBar = ({ durationInFrames, onSeekEnd, onSeekStart, inFrame, outFrame }) => {
42
+ const containerRef = useRef(null);
43
+ const barHovered = useHoverState(containerRef);
44
+ const size = useElementSize(containerRef, {
45
+ triggerOnWindowResize: true,
46
+ shouldApplyCssTransforms: true,
47
+ });
48
+ const { seek, play, pause, playing } = usePlayer();
49
+ const frame = Internals.Timeline.useTimelinePosition();
50
+ const [dragging, setDragging] = useState({
51
+ dragging: false,
52
+ });
53
+ const onPointerDown = useCallback((e) => {
54
+ if (!size) {
55
+ throw new Error('Player has no size');
56
+ }
57
+ const _frame = getFrameFromX(e.clientX - size.left, durationInFrames, size.width);
58
+ pause();
59
+ seek(_frame);
60
+ setDragging({
61
+ dragging: true,
62
+ wasPlaying: playing,
63
+ });
64
+ onSeekStart();
65
+ }, [size, durationInFrames, pause, seek, playing, onSeekStart]);
66
+ const onPointerMove = useCallback((e) => {
67
+ var _a;
68
+ if (!size) {
69
+ throw new Error('Player has no size');
70
+ }
71
+ if (!dragging.dragging) {
72
+ return;
73
+ }
74
+ const _frame = getFrameFromX(e.clientX - ((_a = size === null || size === void 0 ? void 0 : size.left) !== null && _a !== void 0 ? _a : 0), durationInFrames, size.width);
75
+ seek(_frame);
76
+ }, [dragging.dragging, durationInFrames, seek, size]);
77
+ const onPointerUp = useCallback(() => {
78
+ setDragging({
79
+ dragging: false,
80
+ });
81
+ if (!dragging.dragging) {
82
+ return;
83
+ }
84
+ if (dragging.wasPlaying) {
85
+ play();
86
+ }
87
+ else {
88
+ pause();
89
+ }
90
+ onSeekEnd();
91
+ }, [dragging, onSeekEnd, pause, play]);
92
+ useEffect(() => {
93
+ if (!dragging.dragging) {
94
+ return;
95
+ }
96
+ const body = findBodyInWhichDivIsLocated(containerRef.current);
97
+ body.addEventListener('pointermove', onPointerMove);
98
+ body.addEventListener('pointerup', onPointerUp);
99
+ return () => {
100
+ body.removeEventListener('pointermove', onPointerMove);
101
+ body.removeEventListener('pointerup', onPointerUp);
102
+ };
103
+ }, [dragging.dragging, onPointerMove, onPointerUp]);
104
+ const knobStyle = useMemo(() => {
105
+ var _a;
106
+ return {
107
+ height: KNOB_SIZE,
108
+ width: KNOB_SIZE,
109
+ borderRadius: KNOB_SIZE / 2,
110
+ position: 'absolute',
111
+ top: VERTICAL_PADDING - KNOB_SIZE / 2 + 5 / 2,
112
+ backgroundColor: 'white',
113
+ left: Math.max(0, (frame / Math.max(1, durationInFrames - 1)) * ((_a = size === null || size === void 0 ? void 0 : size.width) !== null && _a !== void 0 ? _a : 0) -
114
+ KNOB_SIZE / 2),
115
+ boxShadow: '0 0 2px black',
116
+ opacity: Number(barHovered),
117
+ };
118
+ }, [barHovered, durationInFrames, frame, size]);
119
+ const fillStyle = useMemo(() => {
120
+ return {
121
+ height: BAR_HEIGHT,
122
+ backgroundColor: 'rgba(255, 255, 255, 1)',
123
+ width: ((frame - (inFrame !== null && inFrame !== void 0 ? inFrame : 0)) / (durationInFrames - 1)) * 100 + '%',
124
+ marginLeft: ((inFrame !== null && inFrame !== void 0 ? inFrame : 0) / (durationInFrames - 1)) * 100 + '%',
125
+ borderRadius: BAR_HEIGHT / 2,
126
+ };
127
+ }, [durationInFrames, frame, inFrame]);
128
+ const active = useMemo(() => {
129
+ return {
130
+ height: BAR_HEIGHT,
131
+ backgroundColor: 'rgba(255, 255, 255, 0.25)',
132
+ width: (((outFrame !== null && outFrame !== void 0 ? outFrame : durationInFrames - 1) - (inFrame !== null && inFrame !== void 0 ? inFrame : 0)) /
133
+ (durationInFrames - 1)) *
134
+ 100 +
135
+ '%',
136
+ marginLeft: ((inFrame !== null && inFrame !== void 0 ? inFrame : 0) / (durationInFrames - 1)) * 100 + '%',
137
+ borderRadius: BAR_HEIGHT / 2,
138
+ position: 'absolute',
139
+ };
140
+ }, [durationInFrames, inFrame, outFrame]);
141
+ return (_jsxs("div", { ref: containerRef, onPointerDown: onPointerDown, style: containerStyle, children: [_jsxs("div", { style: barBackground, children: [_jsx("div", { style: active }), _jsx("div", { style: fillStyle })] }), _jsx("div", { style: knobStyle })] }));
142
+ };
@@ -0,0 +1,40 @@
1
+ import React from 'react';
2
+ import type { PlayerRef } from './player-methods.js';
3
+ import type { RenderFullscreenButton, RenderPlayPauseButton } from './PlayerControls.js';
4
+ export type ErrorFallback = (info: {
5
+ error: Error;
6
+ }) => React.ReactNode;
7
+ export type RenderLoading = (canvas: {
8
+ height: number;
9
+ width: number;
10
+ }) => React.ReactNode;
11
+ export type RenderPoster = RenderLoading;
12
+ declare const _default: React.ForwardRefExoticComponent<{
13
+ controls: boolean;
14
+ loop: boolean;
15
+ autoPlay: boolean;
16
+ allowFullscreen: boolean;
17
+ inputProps: Record<string, unknown>;
18
+ showVolumeControls: boolean;
19
+ style?: React.CSSProperties | undefined;
20
+ clickToPlay: boolean;
21
+ doubleClickToFullscreen: boolean;
22
+ spaceKeyToPlayOrPause: boolean;
23
+ errorFallback: ErrorFallback;
24
+ playbackRate: number;
25
+ renderLoading: RenderLoading | undefined;
26
+ renderPoster: RenderLoading | undefined;
27
+ className: string | undefined;
28
+ moveToBeginningWhenEnded: boolean;
29
+ showPosterWhenPaused: boolean;
30
+ showPosterWhenEnded: boolean;
31
+ showPosterWhenUnplayed: boolean;
32
+ inFrame: number | null;
33
+ outFrame: number | null;
34
+ initiallyShowControls: number | boolean;
35
+ renderPlayPauseButton: RenderPlayPauseButton | null;
36
+ renderFullscreen: RenderFullscreenButton | null;
37
+ alwaysShowControls: boolean;
38
+ showPlaybackRateControl: boolean | number[];
39
+ } & React.RefAttributes<PlayerRef>>;
40
+ export default _default;
@@ -0,0 +1,299 @@
1
+ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
2
+ import React, { forwardRef, Suspense, useCallback, useContext, useEffect, useImperativeHandle, useMemo, useRef, useState, } from 'react';
3
+ import { Internals } from 'remotion';
4
+ import { calculateCanvasTransformation, calculateContainerStyle, calculateOuter, calculateOuterStyle, } from './calculate-scale.js';
5
+ import { ErrorBoundary } from './error-boundary.js';
6
+ import { PLAYER_CSS_CLASSNAME } from './player-css-classname.js';
7
+ import { Controls } from './PlayerControls.js';
8
+ import { usePlayback } from './use-playback.js';
9
+ import { usePlayer } from './use-player.js';
10
+ import { IS_NODE } from './utils/is-node.js';
11
+ import { useClickPreventionOnDoubleClick } from './utils/use-click-prevention-on-double-click.js';
12
+ import { useElementSize } from './utils/use-element-size.js';
13
+ const reactVersion = React.version.split('.')[0];
14
+ if (reactVersion === '0') {
15
+ throw new Error(`Version ${reactVersion} of "react" is not supported by Remotion`);
16
+ }
17
+ const doesReactVersionSupportSuspense = parseInt(reactVersion, 10) >= 18;
18
+ const PlayerUI = ({ controls, style, loop, autoPlay, allowFullscreen, inputProps, clickToPlay, showVolumeControls, doubleClickToFullscreen, spaceKeyToPlayOrPause, errorFallback, playbackRate, renderLoading, renderPoster, className, moveToBeginningWhenEnded, showPosterWhenUnplayed, showPosterWhenEnded, showPosterWhenPaused, inFrame, outFrame, initiallyShowControls, renderFullscreen: renderFullscreenButton, renderPlayPauseButton, alwaysShowControls, showPlaybackRateControl, }, ref) => {
19
+ var _a, _b, _c;
20
+ const config = Internals.useUnsafeVideoConfig();
21
+ const video = Internals.useVideo();
22
+ const container = useRef(null);
23
+ const canvasSize = useElementSize(container, {
24
+ triggerOnWindowResize: false,
25
+ shouldApplyCssTransforms: false,
26
+ });
27
+ const [hasPausedToResume, setHasPausedToResume] = useState(false);
28
+ const [shouldAutoplay, setShouldAutoPlay] = useState(autoPlay);
29
+ const [isFullscreen, setIsFullscreen] = useState(() => false);
30
+ const [seeking, setSeeking] = useState(false);
31
+ usePlayback({
32
+ loop,
33
+ playbackRate,
34
+ moveToBeginningWhenEnded,
35
+ inFrame,
36
+ outFrame,
37
+ });
38
+ const player = usePlayer();
39
+ useEffect(() => {
40
+ if (hasPausedToResume && !player.playing) {
41
+ setHasPausedToResume(false);
42
+ player.play();
43
+ }
44
+ }, [hasPausedToResume, player]);
45
+ useEffect(() => {
46
+ const { current } = container;
47
+ if (!current) {
48
+ return;
49
+ }
50
+ const onFullscreenChange = () => {
51
+ setIsFullscreen(document.fullscreenElement === current ||
52
+ document.webkitFullscreenElement === current);
53
+ };
54
+ document.addEventListener('fullscreenchange', onFullscreenChange);
55
+ document.addEventListener('webkitfullscreenchange', onFullscreenChange);
56
+ return () => {
57
+ document.removeEventListener('fullscreenchange', onFullscreenChange);
58
+ document.removeEventListener('webkitfullscreenchange', onFullscreenChange);
59
+ };
60
+ }, []);
61
+ const toggle = useCallback((e) => {
62
+ if (player.isPlaying()) {
63
+ player.pause();
64
+ }
65
+ else {
66
+ player.play(e);
67
+ }
68
+ }, [player]);
69
+ const requestFullscreen = useCallback(() => {
70
+ if (!allowFullscreen) {
71
+ throw new Error('allowFullscreen is false');
72
+ }
73
+ const supportsFullScreen = document.fullscreenEnabled || document.webkitFullscreenEnabled;
74
+ if (!supportsFullScreen) {
75
+ throw new Error('Browser doesnt support fullscreen');
76
+ }
77
+ if (!container.current) {
78
+ throw new Error('No player ref found');
79
+ }
80
+ if (container.current.webkitRequestFullScreen) {
81
+ container.current.webkitRequestFullScreen();
82
+ }
83
+ else {
84
+ container.current.requestFullscreen();
85
+ }
86
+ }, [allowFullscreen]);
87
+ const exitFullscreen = useCallback(() => {
88
+ if (document.webkitExitFullscreen) {
89
+ document.webkitExitFullscreen();
90
+ }
91
+ else {
92
+ document.exitFullscreen();
93
+ }
94
+ }, []);
95
+ useEffect(() => {
96
+ const { current } = container;
97
+ if (!current) {
98
+ return;
99
+ }
100
+ const fullscreenChange = () => {
101
+ var _a;
102
+ const element = (_a = document.webkitFullscreenElement) !== null && _a !== void 0 ? _a : document.fullscreenElement;
103
+ if (element && element === container.current) {
104
+ player.emitter.dispatchFullscreenChange({
105
+ isFullscreen: true,
106
+ });
107
+ }
108
+ else {
109
+ player.emitter.dispatchFullscreenChange({
110
+ isFullscreen: false,
111
+ });
112
+ }
113
+ };
114
+ current.addEventListener('webkitfullscreenchange', fullscreenChange);
115
+ current.addEventListener('fullscreenchange', fullscreenChange);
116
+ return () => {
117
+ current.removeEventListener('webkitfullscreenchange', fullscreenChange);
118
+ current.removeEventListener('fullscreenchange', fullscreenChange);
119
+ };
120
+ }, [player.emitter]);
121
+ const durationInFrames = (_a = config === null || config === void 0 ? void 0 : config.durationInFrames) !== null && _a !== void 0 ? _a : 1;
122
+ const layout = useMemo(() => {
123
+ if (!config || !canvasSize) {
124
+ return null;
125
+ }
126
+ return calculateCanvasTransformation({
127
+ canvasSize,
128
+ compositionHeight: config.height,
129
+ compositionWidth: config.width,
130
+ previewSize: 'auto',
131
+ });
132
+ }, [canvasSize, config]);
133
+ const scale = (_b = layout === null || layout === void 0 ? void 0 : layout.scale) !== null && _b !== void 0 ? _b : 1;
134
+ const initialScaleIgnored = useRef(false);
135
+ useEffect(() => {
136
+ if (!initialScaleIgnored.current) {
137
+ initialScaleIgnored.current = true;
138
+ return;
139
+ }
140
+ player.emitter.dispatchScaleChange(scale);
141
+ }, [player.emitter, scale]);
142
+ const { setMediaVolume, setMediaMuted } = useContext(Internals.SetMediaVolumeContext);
143
+ const { mediaMuted, mediaVolume } = useContext(Internals.MediaVolumeContext);
144
+ useEffect(() => {
145
+ player.emitter.dispatchVolumeChange(mediaVolume);
146
+ }, [player.emitter, mediaVolume]);
147
+ const isMuted = mediaMuted || mediaVolume === 0;
148
+ useEffect(() => {
149
+ player.emitter.dispatchMuteChange({
150
+ isMuted,
151
+ });
152
+ }, [player.emitter, isMuted]);
153
+ useImperativeHandle(ref, () => {
154
+ const methods = {
155
+ play: player.play,
156
+ pause: player.pause,
157
+ toggle,
158
+ getContainerNode: () => container.current,
159
+ getCurrentFrame: player.getCurrentFrame,
160
+ isPlaying: () => player.playing,
161
+ seekTo: (f) => {
162
+ const lastFrame = durationInFrames - 1;
163
+ const frameToSeekTo = Math.max(0, Math.min(lastFrame, f));
164
+ if (player.isPlaying()) {
165
+ const pauseToResume = frameToSeekTo !== lastFrame || loop;
166
+ setHasPausedToResume(pauseToResume);
167
+ player.pause();
168
+ }
169
+ if (frameToSeekTo === lastFrame && !loop) {
170
+ player.emitter.dispatchEnded();
171
+ }
172
+ player.seek(frameToSeekTo);
173
+ },
174
+ isFullscreen: () => isFullscreen,
175
+ requestFullscreen,
176
+ exitFullscreen,
177
+ getVolume: () => {
178
+ if (mediaMuted) {
179
+ return 0;
180
+ }
181
+ return mediaVolume;
182
+ },
183
+ setVolume: (vol) => {
184
+ if (typeof vol !== 'number') {
185
+ throw new TypeError(`setVolume() takes a number, got value of type ${typeof vol}`);
186
+ }
187
+ if (isNaN(vol)) {
188
+ throw new TypeError(`setVolume() got a number that is NaN. Volume must be between 0 and 1.`);
189
+ }
190
+ if (vol < 0 || vol > 1) {
191
+ throw new TypeError(`setVolume() got a number that is out of range. Must be between 0 and 1, got ${typeof vol}`);
192
+ }
193
+ setMediaVolume(vol);
194
+ },
195
+ isMuted: () => isMuted,
196
+ mute: () => {
197
+ setMediaMuted(true);
198
+ },
199
+ unmute: () => {
200
+ setMediaMuted(false);
201
+ },
202
+ getScale: () => scale,
203
+ };
204
+ return Object.assign(player.emitter, methods);
205
+ }, [
206
+ durationInFrames,
207
+ exitFullscreen,
208
+ isFullscreen,
209
+ loop,
210
+ mediaMuted,
211
+ isMuted,
212
+ mediaVolume,
213
+ player,
214
+ requestFullscreen,
215
+ setMediaMuted,
216
+ setMediaVolume,
217
+ toggle,
218
+ scale,
219
+ ]);
220
+ const VideoComponent = video ? video.component : null;
221
+ const outerStyle = useMemo(() => {
222
+ return calculateOuterStyle({ canvasSize, config, style });
223
+ }, [canvasSize, config, style]);
224
+ const outer = useMemo(() => {
225
+ return calculateOuter({ config, layout, scale });
226
+ }, [config, layout, scale]);
227
+ const containerStyle = useMemo(() => {
228
+ return calculateContainerStyle({ canvasSize, config, layout, scale });
229
+ }, [canvasSize, config, layout, scale]);
230
+ const onError = useCallback((error) => {
231
+ player.pause();
232
+ // Pay attention to `this context`
233
+ player.emitter.dispatchError(error);
234
+ }, [player]);
235
+ const onFullscreenButtonClick = useCallback((e) => {
236
+ e.stopPropagation();
237
+ requestFullscreen();
238
+ }, [requestFullscreen]);
239
+ const onExitFullscreenButtonClick = useCallback((e) => {
240
+ e.stopPropagation();
241
+ exitFullscreen();
242
+ }, [exitFullscreen]);
243
+ const onSingleClick = useCallback((e) => {
244
+ toggle(e);
245
+ }, [toggle]);
246
+ const onSeekStart = useCallback(() => {
247
+ setSeeking(true);
248
+ }, []);
249
+ const onSeekEnd = useCallback(() => {
250
+ setSeeking(false);
251
+ }, []);
252
+ const onDoubleClick = useCallback(() => {
253
+ if (isFullscreen) {
254
+ exitFullscreen();
255
+ }
256
+ else {
257
+ requestFullscreen();
258
+ }
259
+ }, [exitFullscreen, isFullscreen, requestFullscreen]);
260
+ const [handleClick, handleDoubleClick] = useClickPreventionOnDoubleClick(onSingleClick, onDoubleClick, doubleClickToFullscreen);
261
+ useEffect(() => {
262
+ if (shouldAutoplay) {
263
+ player.play();
264
+ setShouldAutoPlay(false);
265
+ }
266
+ }, [shouldAutoplay, player]);
267
+ const loadingMarkup = useMemo(() => {
268
+ return renderLoading
269
+ ? renderLoading({
270
+ height: outerStyle.height,
271
+ width: outerStyle.width,
272
+ })
273
+ : null;
274
+ }, [outerStyle.height, outerStyle.width, renderLoading]);
275
+ if (!config) {
276
+ return null;
277
+ }
278
+ const poster = renderPoster
279
+ ? renderPoster({
280
+ height: outerStyle.height,
281
+ width: outerStyle.width,
282
+ })
283
+ : null;
284
+ if (poster === undefined) {
285
+ throw new TypeError('renderPoster() must return a React element, but undefined was returned');
286
+ }
287
+ const shouldShowPoster = poster &&
288
+ [
289
+ showPosterWhenPaused && !player.isPlaying() && !seeking,
290
+ showPosterWhenEnded && player.isLastFrame && !player.isPlaying(),
291
+ showPosterWhenUnplayed && !player.hasPlayed && !player.isPlaying(),
292
+ ].some(Boolean);
293
+ const content = (_jsxs(_Fragment, { children: [_jsx("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: _jsx("div", { style: containerStyle, className: PLAYER_CSS_CLASSNAME, children: VideoComponent ? (_jsx(ErrorBoundary, { onError: onError, errorFallback: errorFallback, children: _jsx(Internals.ClipComposition, { children: _jsx(VideoComponent, { ...((_c = video === null || video === void 0 ? void 0 : video.props) !== null && _c !== void 0 ? _c : {}), ...(inputProps !== null && inputProps !== void 0 ? inputProps : {}) }) }) })) : null }) }), shouldShowPoster ? (_jsx("div", { style: outer, onClick: clickToPlay ? handleClick : undefined, onDoubleClick: doubleClickToFullscreen ? handleDoubleClick : undefined, children: poster })) : null, controls ? (_jsx(Controls, { fps: config.fps, durationInFrames: config.durationInFrames, player: player, containerRef: container, onFullscreenButtonClick: onFullscreenButtonClick, isFullscreen: isFullscreen, allowFullscreen: allowFullscreen, showVolumeControls: showVolumeControls, onExitFullscreenButtonClick: onExitFullscreenButtonClick, spaceKeyToPlayOrPause: spaceKeyToPlayOrPause, onSeekEnd: onSeekEnd, onSeekStart: onSeekStart, inFrame: inFrame, outFrame: outFrame, initiallyShowControls: initiallyShowControls, canvasSize: canvasSize, renderFullscreenButton: renderFullscreenButton, renderPlayPauseButton: renderPlayPauseButton, alwaysShowControls: alwaysShowControls, showPlaybackRateControl: showPlaybackRateControl })) : null] }));
294
+ if (IS_NODE && !doesReactVersionSupportSuspense) {
295
+ return (_jsx("div", { ref: container, style: outerStyle, className: className, children: content }));
296
+ }
297
+ return (_jsx("div", { ref: container, style: outerStyle, className: className, children: _jsx(Suspense, { fallback: loadingMarkup, children: content }) }));
298
+ };
299
+ export default forwardRef(PlayerUI);
@@ -0,0 +1,16 @@
1
+ import type { ComponentType, LazyExoticComponent } from 'react';
2
+ import React from 'react';
3
+ import type { TimelineContextValue } from 'remotion';
4
+ export declare const PLAYER_COMP_ID = "player-comp";
5
+ export declare const SharedPlayerContexts: React.FC<{
6
+ children: React.ReactNode;
7
+ timelineContext: TimelineContextValue;
8
+ inputProps?: Record<string, unknown>;
9
+ fps: number;
10
+ compositionWidth: number;
11
+ compositionHeight: number;
12
+ durationInFrames: number;
13
+ component: LazyExoticComponent<ComponentType<unknown>>;
14
+ numberOfSharedAudioTags: number;
15
+ initiallyMuted: boolean;
16
+ }>;