Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

feat(export): offer voice-over in the export panel

davbio4b517d91049e
diff --git a/src/ui/fullview/ExportPreviewModal.tsx b/src/ui/fullview/ExportPreviewModal.tsx
index 6cdab87..86b99f8 100644
--- a/src/ui/fullview/ExportPreviewModal.tsx
+++ b/src/ui/fullview/ExportPreviewModal.tsx
@@ -16,15 +16,24 @@ import {
import { exportGuideAsPDF } from '@/core/export/pdf-export';
import { paginatePreview, withPreviewStyles } from '@/core/export/preview';
import type { VideoChapter } from '@/core/export/video-export';
-import { canExportVideo, STEP_SECONDS } from '@/core/export/video-support';
+import { COVER_SECONDS, canExportVideo, STEP_SECONDS, videoSeconds } from '@/core/export/video-support';
+import { hasVoiceoverKey, VOICEOVER_SETTINGS } from '@/core/export/voiceover/config';
+import { voiceoverScript } from '@/core/export/voiceover/script';
+import { isBlock } from '@/core/guides/blocks';
import type { Guide, Screenshot, Step } from '@/core/guides/types';
import { BUNDLE_EXTENSION } from '@/core/transfer/schema';
+import { localStorage } from '@/lib/browser-api';
import { Button } from '@/ui/components/ui/button';
import { Dialog, DialogContent, DialogHeader, DialogTitle } from '@/ui/components/ui/dialog';
const VideoStepPlayer = lazy(() => import('@/ui/fullview/VideoStepPlayer'));
const VIDEO_AUTOPLAY_STEP_LIMIT = 25;
+
+function clock(seconds: number): string {
+ const whole = Math.round(seconds);
+ return `${Math.floor(whole / 60)}:${String(whole % 60).padStart(2, '0')}`;
+}
const IMAGE_SCALES: ImageScale[] = ['small', 'medium', 'large'];
interface ExportPreviewModalProps {
@@ -52,11 +61,26 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
const [videoError, setVideoError] = useState<string | null>(null);
const [videoProgress, setVideoProgress] = useState(0);
const [videoRequested, setVideoRequested] = useState(false);
+ const [voiceoverReady, setVoiceoverReady] = useState(false);
+ const [voiceProgress, setVoiceProgress] = useState<{ done: number; total: number } | null>(null);
+ const [narratedSeconds, setNarratedSeconds] = useState<number | null>(null);
+ const [voiceoverError, setVoiceoverError] = useState<string | null>(null);
useEffect(() => {
if (open) loadExportOptions().then(setOptions);
}, [open]);
+ useEffect(() => {
+ if (!open) return;
+ let active = true;
+ localStorage.get([...VOICEOVER_SETTINGS]).then((stored) => {
+ if (active) setVoiceoverReady(hasVoiceoverKey(stored));
+ });
+ return () => {
+ active = false;
+ };
+ }, [open]);
+
useEffect(() => {
let active = true;
canExportVideo().then((supported) => {
@@ -70,6 +94,11 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
const videoPending = steps.length > VIDEO_AUTOPLAY_STEP_LIMIT && !videoRequested;
const typedStepCount = steps.filter((step) => step.inputValue && screenshots.has(step.id)).length;
const { cover, stepDescriptions, resolution, screenshots: withScreenshots, stepUrls, imageScale } = options;
+ const voiceover = options.voiceover && voiceoverReady;
+ const frames = steps.filter((step) => isBlock(step) || screenshots.has(step.id));
+ const baseSeconds = videoSeconds(frames.length, cover);
+ const narration = voiceoverScript(guide, frames, cover);
+ const narratedChars = narration.reduce((total, segment) => total + segment.text.length, 0);
const previewOptions = useMemo<ExportOptions>(
() => ({ ...DEFAULT_EXPORT_OPTIONS, cover, screenshots: withScreenshots, stepUrls, imageScale, stepDescriptions }),
@@ -102,24 +131,40 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
let url: string | null = null;
setVideoError(null);
setVideoProgress(0);
+ setVoiceProgress(null);
+ setNarratedSeconds(null);
+ setVoiceoverError(null);
const timer = setTimeout(async () => {
try {
const { exportGuideAsVideo } = await import('@/core/export/video-export');
- const { blob, chapters } = await exportGuideAsVideo(
+ const {
+ blob,
+ chapters,
+ voiceoverError: failed,
+ } = await exportGuideAsVideo(
guide,
steps,
screenshots,
- { cover, stepDescriptions, resolution },
+ { cover, stepDescriptions, resolution, voiceover },
{
signal: controller.signal,
onProgress: (encoded, frames) => {
if (!controller.signal.aborted) setVideoProgress(frames > 0 ? encoded / frames : 0);
},
+ onVoiceProgress: (done, total) => {
+ if (!controller.signal.aborted) setVoiceProgress(done < total ? { done, total } : null);
+ },
},
);
if (controller.signal.aborted) return;
url = URL.createObjectURL(blob);
setVideoChapters(chapters);
+ setVoiceoverError(failed ?? null);
+ setNarratedSeconds(
+ voiceover && !failed && chapters.length > 0
+ ? chapters[chapters.length - 1].end + (cover ? COVER_SECONDS : 0)
+ : null,
+ );
setVideoUrl(url);
} catch (error) {
if (controller.signal.aborted || (error instanceof DOMException && error.name === 'AbortError')) return;
@@ -132,7 +177,7 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
if (url) URL.revokeObjectURL(url);
setVideoUrl(null);
};
- }, [open, mode, guide, steps, screenshots, cover, stepDescriptions, resolution, videoPending]);
+ }, [open, mode, guide, steps, screenshots, cover, stepDescriptions, resolution, voiceover, videoPending]);
const update = (patch: Partial<ExportOptions>) => {
const next = { ...options, ...patch };
@@ -166,10 +211,17 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
downloadAbort.current = controller;
setDownloadProgress(0);
const { exportGuideAsVideo } = await import('@/core/export/video-export');
- const { blob, extension } = await exportGuideAsVideo(guide, steps, screenshots, options, {
- signal: controller.signal,
- onProgress: (encoded, frames) => setDownloadProgress(frames > 0 ? encoded / frames : 0),
- });
+ const { blob, extension } = await exportGuideAsVideo(
+ guide,
+ steps,
+ screenshots,
+ { ...options, voiceover },
+ {
+ signal: controller.signal,
+ onProgress: (encoded, frames) => setDownloadProgress(frames > 0 ? encoded / frames : 0),
+ onVoiceProgress: (done, total) => setVoiceProgress(done < total ? { done, total } : null),
+ },
+ );
downloadBlob(blob, safeFilename(guide.title, extension));
} else if (format === 'bundle') {
const { exportGuideAsBundle } = await import('@/core/transfer/bundle');
@@ -187,6 +239,7 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
if (!(error instanceof DOMException && error.name === 'AbortError')) throw error;
} finally {
downloadAbort.current = null;
+ setVoiceProgress(null);
setExporting(null);
}
}
@@ -297,6 +350,56 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
</div>
)}
+ {videoSupported && (
+ <div className="pt-3 border-t border-border">
+ <div className="flex items-start justify-between gap-3">
+ <div>
+ <div className="text-[12px] font-semibold text-foreground">{i18n.t('exportPreview.voiceover')}</div>
+ <div className="text-[10px] text-muted-foreground leading-snug">
+ {voiceoverReady ? i18n.t('exportPreview.voiceoverHint') : i18n.t('exportPreview.voiceoverNoKey')}
+ </div>
+ </div>
+ <button
+ type="button"
+ aria-label={i18n.t('exportPreview.voiceover')}
+ aria-pressed={voiceover}
+ disabled={!voiceoverReady}
+ onClick={() => update({ voiceover: !options.voiceover })}
+ className={`w-9 h-5 rounded-full transition-colors relative shrink-0 mt-0.5 disabled:opacity-45 disabled:cursor-not-allowed ${
+ voiceover ? 'bg-accent' : 'bg-border'
+ }`}
+ >
+ <span
+ className={`absolute top-0.5 left-0.5 w-4 h-4 rounded-full bg-white shadow-sm transition-transform ${
+ voiceover ? 'translate-x-4' : 'translate-x-0'
+ }`}
+ />
+ </button>
+ </div>
+
+ {voiceover && (
+ <div className="mt-2.5 space-y-1.5">
+ <div className="rounded-lg bg-secondary px-2.5 py-2 text-[11px] text-foreground" role="status">
+ {narratedSeconds === null
+ ? i18n.t('exportPreview.videoLength', [clock(baseSeconds)])
+ : i18n.t('exportPreview.videoLengthVoice', [clock(baseSeconds), clock(narratedSeconds)])}
+ </div>
+ <div className="px-0.5 text-[10px] text-muted-foreground leading-snug">
+ {i18n.t('exportPreview.voiceoverCost', [String(narration.length), String(narratedChars)])}
+ </div>
+ {voiceoverError && (
+ <div
+ className="rounded-lg px-2.5 py-2 text-[10px] leading-snug text-destructive bg-destructive/10"
+ role="alert"
+ >
+ {i18n.t('exportPreview.voiceoverFailed')}
+ </div>
+ )}
+ </div>
+ )}
+ </div>
+ )}
+
<div className="pt-3 border-t border-border">
<div className="text-[12px] font-semibold text-foreground mb-2">{i18n.t('exportPreview.gifQuality')}</div>
<div className="flex gap-1.5">
@@ -477,11 +580,23 @@ export default function ExportPreviewModal({ open, onOpenChange, guide, steps, s
</div>
) : videoUrl ? (
<Suspense fallback={null}>
- <VideoStepPlayer key={videoUrl} src={videoUrl} chapters={videoChapters} />
+ <VideoStepPlayer
+ key={videoUrl}
+ src={videoUrl}
+ chapters={videoChapters}
+ narrated={voiceover && !voiceoverError}
+ />
</Suspense>
) : (
<div className="flex flex-col items-center gap-2 bg-card border border-border rounded-xl px-4 py-3">
- <div className="text-[11px] text-muted-foreground">{i18n.t('exportPreview.encodingVideo')}</div>
+ <div className="text-[11px] text-muted-foreground">
+ {voiceProgress
+ ? i18n.t('exportPreview.narrating', [
+ String(voiceProgress.done + 1),
+ String(voiceProgress.total),
+ ])
+ : i18n.t('exportPreview.encodingVideo')}
+ </div>
<div className="h-1.5 w-40 overflow-hidden rounded-full bg-border">
<div
className="h-full rounded-full bg-accent transition-[width] duration-150"
diff --git a/src/ui/fullview/__tests__/ExportPreviewModal.test.tsx b/src/ui/fullview/__tests__/ExportPreviewModal.test.tsx
index 81073f3..ef65d8a 100644
--- a/src/ui/fullview/__tests__/ExportPreviewModal.test.tsx
+++ b/src/ui/fullview/__tests__/ExportPreviewModal.test.tsx
@@ -7,6 +7,11 @@ import type { Guide, Screenshot, Step } from '@/core/guides/types';
const exportGuideAsVideo = vi.hoisted(() => vi.fn());
const exportGuideAsHTML = vi.hoisted(() => vi.fn());
const canExportVideo = vi.hoisted(() => vi.fn());
+const stored = vi.hoisted(() => ({ value: {} as Record<string, unknown> }));
+
+vi.mock('@/lib/browser-api', () => ({
+ localStorage: { get: async () => stored.value, set: async () => {} },
+}));
vi.mock('@/core/export/video-export', () => ({ exportGuideAsVideo }));
vi.mock('@/ui/fullview/VideoStepPlayer', () => ({ default: () => <div data-testid="video-player" /> }));
@@ -126,3 +131,60 @@ describe('ExportPreviewModal document preview', () => {
expect(passed.map((s) => s.id)).toEqual(steps.map((s) => s.id));
});
});
+
+describe('ExportPreviewModal voice-over controls', () => {
+ const voiceoverToggle = () => screen.queryByRole('button', { name: 'exportPreview.voiceover' });
+ const lengthNote = () => screen.queryByText(/exportPreview\.videoLength/);
+
+ beforeEach(() => {
+ vi.clearAllMocks();
+ stored.value = { voiceoverProvider: 'openai', voiceoverApiKeys: { openai: 'sk-test' } };
+ canExportVideo.mockResolvedValue(true);
+ exportGuideAsHTML.mockResolvedValue('<html lang="en"><head></head><body></body></html>');
+ exportGuideAsVideo.mockResolvedValue({ blob: new Blob(['video']), extension: 'mp4', chapters: [] });
+ URL.createObjectURL = vi.fn(() => 'blob:video');
+ URL.revokeObjectURL = vi.fn();
+ });
+
+ it('is offered on the document tab too, since video can be exported from there', async () => {
+ renderModal(3);
+
+ await waitFor(() => expect(exportGuideAsHTML).toHaveBeenCalled());
+ expect(voiceoverToggle()).not.toBeNull();
+ });
+
+ it('is offered on the video tab', async () => {
+ renderModal(3);
+
+ fireEvent.click(await screen.findByRole('button', { name: 'exportPreview.modeVideo' }));
+
+ await waitFor(() => expect(voiceoverToggle()).not.toBeNull());
+ });
+
+ it('is absent entirely when this browser cannot encode video', async () => {
+ canExportVideo.mockResolvedValue(false);
+ renderModal(3);
+
+ await waitFor(() => expect(exportGuideAsHTML).toHaveBeenCalled());
+ expect(voiceoverToggle()).toBeNull();
+ });
+
+ it('holds the length estimate back until voice-over is switched on', async () => {
+ renderModal(3);
+
+ await waitFor(() => expect(voiceoverToggle()).not.toBeNull());
+ expect(lengthNote()).toBeNull();
+
+ fireEvent.click(voiceoverToggle() as HTMLElement);
+ await waitFor(() => expect(lengthNote()).not.toBeNull());
+ });
+
+ it('cannot be switched on without a key', async () => {
+ stored.value = {};
+ renderModal(3);
+
+ await waitFor(() => expect(voiceoverToggle()).not.toBeNull());
+ expect((voiceoverToggle() as HTMLButtonElement).disabled).toBe(true);
+ expect(lengthNote()).toBeNull();
+ });
+});
diff --git a/src/ui/sidepanel/ExportMenu.tsx b/src/ui/sidepanel/ExportMenu.tsx
index abf4b3c..70b1313 100644
--- a/src/ui/sidepanel/ExportMenu.tsx
+++ b/src/ui/sidepanel/ExportMenu.tsx
@@ -4,6 +4,7 @@ import { i18n } from '#imports';
import { downloadBlob, downloadText, safeFilename } from '@/core/export/download';
import { exportGuideAsHTML } from '@/core/export/html-export';
import { exportGuideAsMarkdown } from '@/core/export/markdown-export';
+import { loadExportOptions } from '@/core/export/options';
import { exportGuideAsPDF } from '@/core/export/pdf-export';
import { canExportVideo } from '@/core/export/video-support';
import { getGuide } from '@/core/guides/service';
@@ -83,10 +84,17 @@ export default function ExportMenu({
abortRef.current = controller;
setProgress(0);
const { exportGuideAsVideo } = await import('@/core/export/video-export');
- const { blob, extension } = await exportGuideAsVideo(guide, steps, screenshots, undefined, {
- signal: controller.signal,
- onProgress: (encoded, frames) => setProgress(frames > 0 ? encoded / frames : 0),
- });
+ const saved = await loadExportOptions();
+ const { blob, extension } = await exportGuideAsVideo(
+ guide,
+ steps,
+ screenshots,
+ { ...saved, voiceover: false },
+ {
+ signal: controller.signal,
+ onProgress: (encoded, frames) => setProgress(frames > 0 ? encoded / frames : 0),
+ },
+ );
downloadBlob(blob, safeFilename(guide.title, extension));
} else {
downloadBlob(await exportGuideAsPDF(guide, steps, screenshots), safeFilename(guide.title, 'pdf'));