Skip to content

🎥 Make videos programmatically with React

4.3 KB
Raw Blame
import type {RenderJob} from '@remotion/studio-shared';
import React, {useCallback, useContext} from 'react';
import {RENDER_STATUS_BACKGROUND} from '../../helpers/colors';
import {
	makeClientRetryPayload,
	makeRetryPayload,
} from '../../helpers/retry-payload';
import {SetSelectedModalContext} from '../../state/modals';
import {Button} from '../Button';
import {Flex, SPACING_UNIT} from '../layout';
import {HORIZONTAL_SCROLLBAR_CLASSNAME} from '../Menu/is-menu-item';
import {ModalContainer} from '../ModalContainer';
import {ModalHeader} from '../ModalHeader';
import {showNotification} from '../Notifications/NotificationCenter';
import {cancelRenderJob, removeRenderJob} from '../RenderQueue/actions';
import type {
	ClientStillRenderJob,
	ClientVideoRenderJob,
} from '../RenderQueue/client-side-render-types';
import {isRestoredClientJob} from '../RenderQueue/client-side-render-types';
import {isClientRenderJob, RenderQueueContext} from '../RenderQueue/context';
import {ClientRenderProgress} from './ClientRenderProgress';
import {GuiRenderStatus} from './GuiRenderStatus';

const container: React.CSSProperties = {
	padding: 20,
	maxWidth: 900,
	paddingTop: 0,
};

const codeBlock: React.CSSProperties = {
	backgroundColor: RENDER_STATUS_BACKGROUND,
	whiteSpace: 'pre',
	padding: 12,
	borderRadius: 4,
	fontFamily: 'monospace',
	overflow: 'auto',
	maxHeight: 300,
};

const spacer: React.CSSProperties = {
	height: SPACING_UNIT,
	width: SPACING_UNIT,
};

const buttonRow: React.CSSProperties = {
	display: 'flex',
	flexDirection: 'row',
	justifyContent: 'flex-end',
};

export const RenderStatusModal: React.FC<{readonly jobId: string}> = ({
	jobId,
}) => {
	const {setSelectedModal} = useContext(SetSelectedModalContext);
	const {jobs, removeClientJob, cancelClientJob} =
		useContext(RenderQueueContext);

	const job = jobs.find((j) => j.id === jobId);
	if (!job) {
		throw new Error('job not found');
	}

	const isClientJob = isClientRenderJob(job);

	const onQuit = useCallback(() => {
		setSelectedModal(null);
	}, [setSelectedModal]);

	const onRetry = useCallback(() => {
		if (isClientJob) {
			if (isRestoredClientJob(job)) {
				return;
			}

			const retryPayload = makeClientRetryPayload(
				job as ClientStillRenderJob | ClientVideoRenderJob,
			);
			setSelectedModal(retryPayload);
		} else {
			const retryPayload = makeRetryPayload(job);
			setSelectedModal(retryPayload);
		}
	}, [job, isClientJob, setSelectedModal]);

	const onClickOnRemove = useCallback(() => {
		setSelectedModal(null);
		if (isClientJob) {
			removeClientJob(job.id);
		} else {
			removeRenderJob(job).catch((err) => {
				showNotification(`Could not remove job: ${err.message}`, 2000);
			});
		}
	}, [job, isClientJob, removeClientJob, setSelectedModal]);

	const onClickOnCancel = useCallback(() => {
		if (isClientJob) {
			cancelClientJob(job.id);
		} else {
			cancelRenderJob(job).catch((err) => {
				showNotification(`Could not cancel job: ${err.message}`, 2000);
			});
		}
	}, [job, isClientJob, cancelClientJob]);

	if (job.status === 'idle') {
		throw new Error('should not have rendered this modal');
	}

	const errorDetails =
		job.status === 'failed'
			? job.error.stack?.split('\n')[0].includes(job.error.message)
				? job.error.stack
				: [job.error.message, job.error.stack].filter(Boolean).join('\n')
			: null;

	return (
		<ModalContainer onOutsideClick={onQuit} onEscape={onQuit}>
			<ModalHeader title={`Render ${job.compositionId}`} />
			<div style={container}>
				{job.status === 'failed' ? (
					<>
						<p>The render failed because of the following error:</p>
						<div className={HORIZONTAL_SCROLLBAR_CLASSNAME} style={codeBlock}>
							{errorDetails}
						</div>
					</>
				) : null}
				{(job.status === 'done' || job.status === 'running') &&
					(isClientJob ? (
						<ClientRenderProgress job={job} />
					) : (
						<GuiRenderStatus job={job as RenderJob} />
					))}
				<div style={spacer} />
				<div style={buttonRow}>
					{job.status === 'running' ? (
						<Button onClick={onClickOnCancel}>Cancel render</Button>
					) : (
						<Button onClick={onClickOnRemove}>Remove render</Button>
					)}
					<Flex />
					{job.status === 'failed' ? (
						<Button onClick={onRetry}>Retry</Button>
					) : null}
					<div style={spacer} />
					<Button onClick={onQuit}>Close</Button>
				</div>
			</div>
		</ModalContainer>
	);
};