@gradio/core 0.17.0 → 0.18.1

package/src/api_docs/Settings.svelte

@@ -6,10 +6,14 @@
 	export let space_id: string | null;
 	export let pwa_enabled: boolean | undefined;
 	import { BaseDropdown as Dropdown } from "@gradio/dropdown";
+	import { BaseCheckbox as Checkbox } from "@gradio/checkbox";
 	import { language_choices, changeLocale } from "../i18n";
 	import { locale, _ } from "svelte-i18n";
 	import { setupi18n } from "../i18n";
+	import record from "./img/record.svg";
+	import { createEventDispatcher } from "svelte";
 
+	const dispatch = createEventDispatcher();
 	if (root === "") {
 		root = location.protocol + "//" + location.host + location.pathname;
 	}
@@ -44,6 +48,8 @@
 
 	let current_locale: string;
 	let current_theme: "light" | "dark" | "system" = "system";
+	export let allow_zoom = true;
+	export let allow_video_trim = true;
 
 	locale.subscribe((value) => {
 		if (value) {
@@ -55,6 +61,15 @@
 		const new_locale = e.detail;
 		changeLocale(new_locale);
 	}
+
+	function handleZoomChange(e: CustomEvent): void {
+		allow_zoom = e.detail;
+	}
+
+	function handleVideoTrimChange(e: CustomEvent): void {
+		allow_video_trim = e.detail;
+	}
+
 	setupi18n();
 </script>
 
@@ -120,6 +135,44 @@
 		{/if}
 	</p>
 </div>
+<div class="banner-wrap">
+	<h2>{$_("common.screen_studio")} <span class="beta-tag">beta</span></h2>
+	<p class="padded">
+		Screen Studio allows you to record your screen and generates a video of your
+		app with automatically adding zoom in and zoom out effects as well as
+		trimming the video to remove the prediction time.
+		<br /><br />
+		Start recording by clicking the <i>Start Recording</i> button below and then
+		sharing the current browser tab of your Gradio demo. Use your app as you
+		would normally to generate a prediction.
+		<br />
+		Stop recording by clicking the <i>Stop Recording</i> button in the footer of
+		the demo.
+		<br /><br />
+		<Checkbox
+			label="Include automatic zoom in/out"
+			interactive={true}
+			value={allow_zoom}
+			on:change={handleZoomChange}
+		/>
+		<Checkbox
+			label="Include automatic video trimming"
+			interactive={true}
+			value={allow_video_trim}
+			on:change={handleVideoTrimChange}
+		/>
+	</p>
+	<button
+		class="record-button"
+		on:click={() => {
+			dispatch("close");
+			dispatch("start_recording");
+		}}
+	>
+		<img src={record} alt="Start Recording" />
+		Start Recording
+	</button>
+</div>
 
 <style>
 	.banner-wrap {
@@ -150,7 +203,8 @@
 		margin-left: var(--size-2);
 	}
 
-	.theme-button {
+	.theme-button,
+	.record-button {
 		display: flex;
 		align-items: center;
 		border: 1px solid var(--border-color-primary);
@@ -162,6 +216,15 @@
 		cursor: pointer;
 	}
 
+	.record-button img {
+		margin-right: var(--size-1);
+		margin-left: var(--size-1);
+		width: var(--size-3);
+	}
+	.record-button:hover {
+		border-color: red;
+	}
+
 	.current-theme {
 		border: 1px solid var(--body-text-color-subdued);
 		color: var(--body-text-color);
@@ -181,4 +244,17 @@
 		all: unset;
 		cursor: pointer;
 	}
+
+	.beta-tag {
+		position: relative;
+		top: -5px;
+		font-size: var(--text-xs);
+		background-color: var(--color-accent);
+		color: white;
+		padding: 2px 6px;
+		border-radius: 10px;
+		margin-left: 5px;
+		font-weight: normal;
+		text-transform: uppercase;
+	}
 </style>

package/src/api_docs/img/record-stop.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 20 20" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="#000000"><g id="SVGRepo_bgCarrier" stroke-width="0"></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <title>record [#982]</title> <desc>Created with Sketch.</desc> <defs> </defs> <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"> <g id="Dribbble-Light-Preview" transform="translate(-380.000000, -3839.000000)" fill="#FF0000"> <g id="icons" transform="translate(56.000000, 160.000000)"> <path d="M338,3689 C338,3691.209 336.209,3693 334,3693 C331.791,3693 330,3691.209 330,3689 C330,3686.791 331.791,3685 334,3685 C336.209,3685 338,3686.791 338,3689 M334,3697 C329.589,3697 326,3693.411 326,3689 C326,3684.589 329.589,3681 334,3681 C338.411,3681 342,3684.589 342,3689 C342,3693.411 338.411,3697 334,3697 M334,3679 C328.477,3679 324,3683.477 324,3689 C324,3694.523 328.477,3699 334,3699 C339.523,3699 344,3694.523 344,3689 C344,3683.477 339.523,3679 334,3679" id="record-[#982]"> </path> </g> </g> </g> </g></svg>

package/src/api_docs/img/record.svg

@@ -0,0 +1 @@
+<svg viewBox="0 0 20 20" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" fill="#000000"><g id="SVGRepo_bgCarrier" stroke-width="0"></g><g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round"></g><g id="SVGRepo_iconCarrier"> <title>record [#982]</title> <desc>Created with Sketch.</desc> <defs> </defs> <g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"> <g id="Dribbble-Light-Preview" transform="translate(-380.000000, -3839.000000)" fill="#808080"> <g id="icons" transform="translate(56.000000, 160.000000)"> <path d="M338,3689 C338,3691.209 336.209,3693 334,3693 C331.791,3693 330,3691.209 330,3689 C330,3686.791 331.791,3685 334,3685 C336.209,3685 338,3686.791 338,3689 M334,3697 C329.589,3697 326,3693.411 326,3689 C326,3684.589 329.589,3681 334,3681 C338.411,3681 342,3684.589 342,3689 C342,3693.411 338.411,3697 334,3697 M334,3679 C328.477,3679 324,3683.477 324,3689 C324,3694.523 328.477,3699 334,3699 C339.523,3699 344,3694.523 344,3689 C344,3683.477 339.523,3679 334,3679" id="record-[#982]"> </path> </g> </g> </g> </g></svg>

package/src/init.ts

@@ -179,13 +179,15 @@ export function create_components(initial_layout: ComponentMeta | undefined): {
 		root: string;
 		dependencies: Dependency[];
 	}): void {
+		components.forEach((c) => {
+			for (const prop in c.props) {
+				if (c.props[prop] === null) {
+					c.props[prop] = undefined;
+				}
+			}
+		});
 		let replacement_components: ComponentMeta[] = [];
 		let new_components: ComponentMeta[] = [];
-		console.log("old_keys", keys_per_render_id[render_id]);
-		console.log(
-			"new_keys",
-			components.map((c) => c.key)
-		);
 		components.forEach((c) => {
 			if (c.key == null || !keys_per_render_id[render_id]?.includes(c.key)) {
 				new_components.push(c);
@@ -193,7 +195,6 @@ export function create_components(initial_layout: ComponentMeta | undefined): {
 				replacement_components.push(c);
 			}
 		});
-		console.log(new_components.length, replacement_components.length);
 		let _constructor_map = preload_all_components(new_components, root);
 		_constructor_map.forEach((v, k) => {
 			constructor_map.set(k, v);

package/src/lang/en.json

@@ -69,6 +69,10 @@
 		"language": "Language",
 		"display_theme": "Display Theme",
 		"pwa": "Progressive Web App",
+		"record": "Record",
+		"stop_recording": "Stop Recording",
+		"screen_studio": "Screen Studio",
+		"share_gradio_tab": "[Sharing] Gradio Tab",
 		"run": "Run"
 	},
 	"dataframe": {

package/src/screen_recorder.ts

@@ -0,0 +1,361 @@
+import type { ToastMessage } from "@gradio/statustracker";
+
+let isRecording = false;
+let mediaRecorder: MediaRecorder | null = null;
+let recordedChunks: Blob[] = [];
+let recordingStartTime = 0;
+let animationFrameId: number | null = null;
+let removeSegment: { start?: number; end?: number } = {};
+let root: string;
+
+let add_message_callback: (
+	title: string,
+	message: string,
+	type: ToastMessage["type"]
+) => void;
+let onRecordingStateChange: ((isRecording: boolean) => void) | null = null;
+let zoomEffects: {
+	boundingBox: { topLeft: [number, number]; bottomRight: [number, number] };
+	start_frame: number;
+	duration?: number;
+}[] = [];
+
+export function initialize(
+	rootPath: string,
+	add_new_message: (
+		title: string,
+		message: string,
+		type: ToastMessage["type"]
+	) => void,
+	recordingStateCallback?: (isRecording: boolean) => void
+): void {
+	root = rootPath;
+	add_message_callback = add_new_message;
+	if (recordingStateCallback) {
+		onRecordingStateChange = recordingStateCallback;
+	}
+}
+
+export async function startRecording(): Promise<void> {
+	if (isRecording) {
+		return;
+	}
+
+	try {
+		const originalTitle = document.title;
+		document.title = "[Sharing] Gradio Tab";
+		const stream = await navigator.mediaDevices.getDisplayMedia({
+			video: {
+				width: { ideal: 1920 },
+				height: { ideal: 1080 },
+				frameRate: { ideal: 30 }
+			},
+			audio: true,
+			selfBrowserSurface: "include"
+		} as MediaStreamConstraints);
+		document.title = originalTitle;
+
+		const options = {
+			videoBitsPerSecond: 5000000
+		};
+
+		mediaRecorder = new MediaRecorder(stream, options);
+
+		recordedChunks = [];
+		removeSegment = {};
+
+		mediaRecorder.ondataavailable = handleDataAvailable;
+		mediaRecorder.onstop = handleStop;
+
+		mediaRecorder.start(1000);
+		isRecording = true;
+		if (onRecordingStateChange) {
+			onRecordingStateChange(true);
+		}
+		recordingStartTime = Date.now();
+	} catch (error: any) {
+		add_message_callback(
+			"Recording Error",
+			"Failed to start recording: " + error.message,
+			"error"
+		);
+	}
+}
+
+export function stopRecording(): void {
+	if (!isRecording || !mediaRecorder) {
+		return;
+	}
+
+	mediaRecorder.stop();
+	isRecording = false;
+	if (onRecordingStateChange) {
+		onRecordingStateChange(false);
+	}
+}
+
+export function isCurrentlyRecording(): boolean {
+	return isRecording;
+}
+
+export function markRemoveSegmentStart(): void {
+	if (!isRecording) {
+		return;
+	}
+
+	const currentTime = (Date.now() - recordingStartTime) / 1000;
+	removeSegment.start = currentTime;
+}
+
+export function markRemoveSegmentEnd(): void {
+	if (!isRecording || removeSegment.start === undefined) {
+		return;
+	}
+
+	const currentTime = (Date.now() - recordingStartTime) / 1000;
+	removeSegment.end = currentTime;
+}
+
+export function clearRemoveSegment(): void {
+	removeSegment = {};
+}
+
+export function addZoomEffect(
+	is_input: boolean,
+	params: {
+		boundingBox: {
+			topLeft: [number, number];
+			bottomRight: [number, number];
+		};
+		duration?: number;
+	}
+): void {
+	if (!isRecording) {
+		return;
+	}
+
+	const FPS = 30;
+	const currentTime = (Date.now() - recordingStartTime) / 1000;
+	const currentFrame = is_input
+		? Math.floor((currentTime - 2) * FPS)
+		: Math.floor(currentTime * FPS);
+
+	if (
+		params.boundingBox &&
+		params.boundingBox.topLeft &&
+		params.boundingBox.bottomRight &&
+		params.boundingBox.topLeft.length === 2 &&
+		params.boundingBox.bottomRight.length === 2
+	) {
+		const newEffectDuration = params.duration || 2.0;
+		const newEffectEndFrame =
+			currentFrame + Math.floor(newEffectDuration * FPS);
+
+		const hasOverlap = zoomEffects.some((existingEffect) => {
+			const existingEffectEndFrame =
+				existingEffect.start_frame +
+				Math.floor((existingEffect.duration || 2.0) * FPS);
+			return (
+				(currentFrame >= existingEffect.start_frame &&
+					currentFrame <= existingEffectEndFrame) ||
+				(newEffectEndFrame >= existingEffect.start_frame &&
+					newEffectEndFrame <= existingEffectEndFrame) ||
+				(currentFrame <= existingEffect.start_frame &&
+					newEffectEndFrame >= existingEffectEndFrame)
+			);
+		});
+
+		if (!hasOverlap) {
+			zoomEffects.push({
+				boundingBox: params.boundingBox,
+				start_frame: currentFrame,
+				duration: newEffectDuration
+			});
+		}
+	}
+}
+
+export function zoom(
+	is_input: boolean,
+	elements: number[],
+	duration = 2.0
+): void {
+	if (!isRecording) {
+		return;
+	}
+
+	try {
+		setTimeout(() => {
+			if (!elements || elements.length === 0) {
+				return;
+			}
+
+			let minLeft = Infinity;
+			let minTop = Infinity;
+			let maxRight = 0;
+			let maxBottom = 0;
+			let foundElements = false;
+
+			for (const elementId of elements) {
+				const selector = `#component-${elementId}`;
+				const element = document.querySelector(selector);
+
+				if (element) {
+					foundElements = true;
+					const rect = element.getBoundingClientRect();
+
+					minLeft = Math.min(minLeft, rect.left);
+					minTop = Math.min(minTop, rect.top);
+					maxRight = Math.max(maxRight, rect.right);
+					maxBottom = Math.max(maxBottom, rect.bottom);
+				}
+			}
+
+			if (!foundElements) {
+				return;
+			}
+
+			const viewportWidth = window.innerWidth;
+			const viewportHeight = window.innerHeight;
+
+			const boxWidth = Math.min(maxRight, viewportWidth) - Math.max(0, minLeft);
+			const boxHeight =
+				Math.min(maxBottom, viewportHeight) - Math.max(0, minTop);
+
+			const widthPercentage = boxWidth / viewportWidth;
+			const heightPercentage = boxHeight / viewportHeight;
+
+			if (widthPercentage >= 0.8 || heightPercentage >= 0.8) {
+				return;
+			}
+
+			const isSafari = /^((?!chrome|android).)*safari/i.test(
+				navigator.userAgent
+			);
+
+			let topLeft: [number, number] = [
+				Math.max(0, minLeft) / viewportWidth,
+				Math.max(0, minTop) / viewportHeight
+			];
+
+			let bottomRight: [number, number] = [
+				Math.min(maxRight, viewportWidth) / viewportWidth,
+				Math.min(maxBottom, viewportHeight) / viewportHeight
+			];
+
+			if (isSafari) {
+				topLeft[0] = Math.max(0, topLeft[0] * 0.9);
+				bottomRight[0] = Math.min(1, bottomRight[0] * 0.9);
+				const width = bottomRight[0] - topLeft[0];
+				const center = (topLeft[0] + bottomRight[0]) / 2;
+				const newCenter = center * 0.9;
+				topLeft[0] = Math.max(0, newCenter - width / 2);
+				bottomRight[0] = Math.min(1, newCenter + width / 2);
+			}
+
+			topLeft[0] = Math.max(0, topLeft[0]);
+			topLeft[1] = Math.max(0, topLeft[1]);
+			bottomRight[0] = Math.min(1, bottomRight[0]);
+			bottomRight[1] = Math.min(1, bottomRight[1]);
+
+			addZoomEffect(is_input, {
+				boundingBox: {
+					topLeft,
+					bottomRight
+				},
+				duration: duration
+			});
+		}, 300);
+	} catch (error) {
+		// pass
+	}
+}
+
+function handleDataAvailable(event: BlobEvent): void {
+	if (event.data.size > 0) {
+		recordedChunks.push(event.data);
+	}
+}
+
+function handleStop(): void {
+	isRecording = false;
+	if (onRecordingStateChange) {
+		onRecordingStateChange(false);
+	}
+
+	const blob = new Blob(recordedChunks, {
+		type: "video/mp4"
+	});
+
+	handleRecordingComplete(blob);
+
+	const screenStream = mediaRecorder?.stream?.getTracks() || [];
+	screenStream.forEach((track) => track.stop());
+
+	if (animationFrameId !== null) {
+		cancelAnimationFrame(animationFrameId);
+		animationFrameId = null;
+	}
+}
+
+async function handleRecordingComplete(recordedBlob: Blob): Promise<void> {
+	try {
+		add_message_callback(
+			"Processing video",
+			"This may take a few seconds...",
+			"info"
+		);
+
+		const formData = new FormData();
+		formData.append("video", recordedBlob, "recording.mp4");
+
+		if (removeSegment.start !== undefined && removeSegment.end !== undefined) {
+			formData.append("remove_segment_start", removeSegment.start.toString());
+			formData.append("remove_segment_end", removeSegment.end.toString());
+		}
+
+		if (zoomEffects.length > 0) {
+			formData.append("zoom_effects", JSON.stringify(zoomEffects));
+		}
+
+		const response = await fetch(root + "/gradio_api/process_recording", {
+			method: "POST",
+			body: formData
+		});
+
+		if (!response.ok) {
+			throw new Error(
+				`Server returned ${response.status}: ${response.statusText}`
+			);
+		}
+
+		const processedBlob = await response.blob();
+		const defaultFilename = `gradio-screen-recording-${new Date().toISOString().replace(/:/g, "-").replace(/\..+/, "")}.mp4`;
+		saveWithDownloadAttribute(processedBlob, defaultFilename);
+		zoomEffects = [];
+	} catch (error) {
+		add_message_callback(
+			"Processing Error",
+			"Failed to process recording. Saving original version.",
+			"warning"
+		);
+
+		const defaultFilename = `gradio-screen-recording-${new Date().toISOString().replace(/:/g, "-").replace(/\..+/, "")}.mp4`;
+		saveWithDownloadAttribute(recordedBlob, defaultFilename);
+	}
+}
+
+function saveWithDownloadAttribute(blob: Blob, suggestedName: string): void {
+	const url = URL.createObjectURL(blob);
+	const a = document.createElement("a");
+	a.style.display = "none";
+	a.href = url;
+	a.download = suggestedName;
+
+	document.body.appendChild(a);
+	a.click();
+	setTimeout(() => {
+		document.body.removeChild(a);
+		URL.revokeObjectURL(url);
+	}, 100);
+}