Skip to content

A self-hosted media server and file management system

fix: transcript's use of teleport blocks switching between overlay and sidebar

aminnausine6c33511d1e2
diff --git a/resources/js/components/panels/TranscriptSidebar.vue b/resources/js/components/panels/TranscriptSidebar.vue
index f5ada92c..166135e5 100644
--- a/resources/js/components/panels/TranscriptSidebar.vue
+++ b/resources/js/components/panels/TranscriptSidebar.vue
@@ -1,22 +1,31 @@
<script setup lang="ts">
-import { onMounted, onUnmounted } from 'vue';
+import { ButtonCorner } from '@/components/cedar-ui/button';
import { useAppStore } from '@/stores/AppStore';
import { storeToRefs } from 'pinia';
+import PlayerTranscript from '@/components/video/transcript/PlayerTranscript.vue';
import SidebarHeader from '@/components/headers/SidebarHeader.vue';
-const { loadedSideBar } = storeToRefs(useAppStore());
+import ProiconsPanelRight from '~icons/proicons/panel-right';
-onMounted(() => {
- loadedSideBar.value = 'transcript';
-});
-onUnmounted(() => {
- loadedSideBar.value = '';
-});
+const { selectedSideBar } = storeToRefs(useAppStore());
+const { cycleSideBar } = useAppStore();
</script>
<template>
- <SidebarHeader :text="'Transcript'" />
+ <SidebarHeader :text="'Transcript'">
+ <ButtonCorner
+ @click="cycleSideBar('transcript', 'list-card')"
+ title="Move to Player"
+ colour-classes="hover:bg-transparent"
+ text-classes="text-white/70 hover:text-white"
+ position-classes="size-5"
+ >
+ <template #icon><ProiconsPanelRight class="scale-x-[-1]" /></template>
+ </ButtonCorner>
+ </SidebarHeader>
- <section id="list-content-transcript" class="full-height-sidebar flex flex-col flex-wrap gap-2"></section>
+ <section id="list-content-transcript" class="full-height-sidebar flex flex-col flex-wrap gap-2">
+ <PlayerTranscript :is-visible="selectedSideBar === 'transcript'"> </PlayerTranscript>
+ </section>
</template>
diff --git a/resources/js/components/video/VideoPlayer.vue b/resources/js/components/video/VideoPlayer.vue
index 46b0999e..c220c310 100755
--- a/resources/js/components/video/VideoPlayer.vue
+++ b/resources/js/components/video/VideoPlayer.vue
@@ -1,10 +1,10 @@
<script setup lang="ts">
import type { ContextMenuItem, PopoverItem } from '@/types/types';
-import type { SubtitleResource } from '@/contracts/media';
import { controlsHideTime, playbackDataBuffer, playerHealthBuffer, volumeDelta, playbackDelta, playbackMin, playbackMax } from '@/service/player/playerConstants';
import { getScreenSize, handleStorageURL, isInputLikeElement, isMobileDevice, toFormattedDate, toFormattedDuration } from '@/service/util';
import { computed, nextTick, onBeforeUnmount, onMounted, provide, ref, useTemplateRef, watch } from 'vue';
+import { breakpointsTailwind, useBreakpoints } from '@vueuse/core';
import { copyVideoFrame, saveVideoFrame } from '@/service/player/frameService';
import { usePlaybackProgress } from '@/composables/player/usePlaybackProgress';
import { useRoute, useRouter } from 'vue-router';
@@ -13,6 +13,7 @@ import { useVideoPlayback } from '@/service/queries';
import { ToastController } from '@/components/cedar-ui/toast';
import { useContentStore } from '@/stores/ContentStore';
import { debounce, round } from 'lodash-es';
+import { useTranscript } from './transcript/useTranscript';
import { useAuthStore } from '@/stores/AuthStore';
import { ContextMenu } from '@/components/cedar-ui/context-menu';
import { GlobalModal } from '@/components/cedar-ui/modal';
@@ -225,6 +226,9 @@ const bufferHealth = computed(() => {
//#endregion
+const breakpoints = useBreakpoints(breakpointsTailwind);
+const isDesktop = breakpoints.greaterOrEqual('lg');
+
const videoButtonOffset = computed(() => {
return 8 + (isNormalView.value ? 0 : 8);
});
@@ -334,7 +338,7 @@ const playerContextMenuItems = computed<ContextMenuItem[]>(() =>
hidden: isAudio.value,
action: () => {
isShowingTranscript.value = !isShowingTranscript.value;
- if (isNormalView.value) {
+ if (isNormalView.value && isDesktop.value) {
selectedSideBar.value = isShowingTranscript.value ? 'transcript' : selectedSideBar.value === 'transcript' ? '' : selectedSideBar.value;
}
},
@@ -1326,6 +1330,33 @@ const addJsonLd = () => {
//#endregion
+//#region Transcript
+
+const {
+ player: transcriptPlayer,
+ playerViewMode: transcriptViewMode,
+ subtitleTrack: transcriptSubtitleTrack,
+ registerTranscriptContext,
+ unregisterTranscriptContext,
+} = useTranscript();
+
+watch(
+ player,
+ (el) => {
+ transcriptPlayer.value = el;
+ },
+ { immediate: true },
+);
+watch(
+ () => playerSubtitles.value?.currentSubtitleTrack ?? playerSubtitles.value?.defaultSubtitleTrack,
+ (track) => {
+ transcriptSubtitleTrack.value = track;
+ },
+ { immediate: true },
+);
+
+//#endregion
+
//#region Hooks
provide('player', player);
@@ -1335,6 +1366,13 @@ watch(stateVideo, (_, old) => {
initVideoPlayer(old.id);
});
+watch(
+ () => viewMode.value,
+ async () => {
+ transcriptViewMode.value = viewMode.value;
+ },
+);
+
watch(isShowingControls, async (visible) => {
if (!visible || !shouldUpdateUI.value || !player.value) return;
handlePlayerTimeUpdate({ target: player.value });
@@ -1370,6 +1408,16 @@ onMounted(() => {
globalThis.addEventListener('pointerup', stopScrub);
globalThis.addEventListener('contextmenu', stopScrub);
unSub = onSeek(handleManualSeek);
+
+ registerTranscriptContext({
+ seek: handleManualSeek,
+ close: () => {
+ isShowingTranscript.value = false;
+ },
+ generated: (track) => {
+ stateVideo.value.subtitles.push(track);
+ },
+ });
});
onBeforeUnmount(() => {
@@ -1379,6 +1427,8 @@ onBeforeUnmount(() => {
document.removeEventListener('fullscreenchange', handleFullScreenChange);
document.removeEventListener('visibilitychange', handleVisibilityChange);
+ unregisterTranscriptContext();
+
if (unSub) unSub();
debouncedCacheVolume.cancel();
@@ -1607,18 +1657,7 @@ defineExpose({
>
<!-- Watch Party (Z-7) -->
<VideoPartyPanel :is-showing-party="isShowingParty" />
- <PlayerTranscript
- :is-visible="isShowingTranscript"
- :player="player"
- :subtitle-track="playerSubtitles?.currentSubtitleTrack ?? playerSubtitles?.defaultSubtitleTrack"
- @seek="handleManualSeek"
- @close="isShowingTranscript = false"
- @generated="
- (track: SubtitleResource) => {
- stateVideo.subtitles.push(track);
- }
- "
- />
+ <PlayerTranscript :is-visible="isShowingTranscript && selectedSideBar !== 'transcript'" />
</div>
</div>
diff --git a/resources/js/components/video/transcript/PlayerTranscript.vue b/resources/js/components/video/transcript/PlayerTranscript.vue
index c8722554..84856f82 100644
--- a/resources/js/components/video/transcript/PlayerTranscript.vue
+++ b/resources/js/components/video/transcript/PlayerTranscript.vue
@@ -2,128 +2,40 @@
import type { ComponentPublicInstance } from 'vue';
import type { SubtitleResource } from '@/contracts/media';
-import { computed, nextTick, onBeforeUnmount, onUnmounted, ref, useTemplateRef, watch } from 'vue';
+import { computed, nextTick, onBeforeUnmount, ref, useTemplateRef, watch } from 'vue';
+import { breakpointsTailwind, useBreakpoints } from '@vueuse/core';
import { ButtonBase, ButtonCorner } from '@/components/cedar-ui/button';
+import { useTranscript } from '@/components/video/transcript/useTranscript';
import { useAppStore } from '@/stores/AppStore';
import { storeToRefs } from 'pinia';
-import { cn, toast } from '@aminnausin/cedar-ui';
+import { cn } from '@aminnausin/cedar-ui';
import GenerateTranscript from '@/components/video/transcript/GenerateTranscript.vue';
+import ProiconsPanelRight from '~icons/proicons/panel-right';
import ProiconsCancel from '~icons/proicons/cancel';
-interface TranscriptLine {
- index: number;
- text: string;
- start: number;
- end: number;
-}
+const props = defineProps<{ isVisible?: boolean }>();
+const emit = defineEmits<{ seek: [value: number]; close: []; generated: [track: SubtitleResource] }>();
-const ALLOWED_TAG_PATTERN = /<(?!\/?(?:i|u|br)\b)[^>]*>/gi;
+const breakpoints = useBreakpoints(breakpointsTailwind);
+const isDesktop = breakpoints.greaterOrEqual('lg');
-const props = defineProps<{ isVisible: boolean; player: HTMLVideoElement | null; subtitleTrack?: SubtitleResource }>();
-const emit = defineEmits<{ seek: [value: number]; close: []; generated: [track: SubtitleResource] }>();
+const { selectedSideBar } = storeToRefs(useAppStore());
+const { cycleSideBar } = useAppStore();
-const { loadedSideBar } = storeToRefs(useAppStore());
+const { player, isNormalView, rawTranscript, parsedTranscript, subtitleTrack, activeIndex, currentTime, loadedTranscriptUrl, loadTranscript, isLoading, generated, seek, close } =
+ useTranscript();
const transcriptContainer = useTemplateRef('transcript-container');
const transcriptLineRefs = ref<(HTMLElement | null)[]>([]);
-const rawTranscript = ref('');
-const currentTime = ref(0);
const isFollowing = ref(true);
-const isLoading = ref(false);
-const loadedTranscriptUrl = ref<string>();
-
-const isTeleported = computed(() => props.isVisible && loadedSideBar.value === 'transcript');
-
-const parsedTranscript = computed<TranscriptLine[]>(() => {
- const lines: TranscriptLine[] = [];
-
- const vtt = rawTranscript.value.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
- const cueLines = vtt.split('\n');
-
- for (let i = 0; i < cueLines.length; i++) {
- const line = cueLines[i].trim();
-
- if (!line.includes(' --> ')) continue;
-
- const [start, end] = line.split(' --> ');
- const textLines: string[] = [];
-
- i++;
-
- while (i < cueLines.length && cueLines[i].trim() !== '') {
- textLines.push(cueLines[i]);
- i++;
- }
-
- const startTime = timestampToSeconds(start);
- const endTime = timestampToSeconds(end);
- const text = textLines.join('\n').trim().replace(ALLOWED_TAG_PATTERN, '');
-
- if (!text) continue;
-
- const previous = lines[lines.length - 1];
-
- if (previous && previous.text === text && startTime <= previous.end) {
- previous.end = Math.max(previous.end, endTime);
- continue;
- }
-
- lines.push({
- start: startTime,
- end: endTime,
- text,
- index: lines.length,
- });
- }
- return lines;
-});
-
-const activeIndex = computed(() => {
- const lines = parsedTranscript.value;
- const time = currentTime.value;
-
- let low = 0;
- let high = lines.length - 1;
-
- while (low <= high) {
- const mid = (low + high) >> 1;
- const line = lines[mid];
- const next = lines[mid + 1];
-
- if (time < line.start) {
- high = mid - 1;
- } else if (!next || time < next.start) {
- return mid;
- } else {
- low = mid + 1;
- }
- }
-
- return -1;
-});
-
-function timestampToSeconds(timestamp: string): number {
- const parts = timestamp.trim().split(':').map(Number);
-
- if (parts.length === 2) {
- const [minutes, seconds] = parts;
- return minutes * 60 + seconds;
- }
-
- if (parts.length === 3) {
- const [hours, minutes, seconds] = parts;
- return hours * 3600 + minutes * 60 + seconds;
- }
-
- return 0;
-}
+const isTeleported = computed(() => props.isVisible && selectedSideBar.value === 'transcript');
function formatTimestamp(totalSeconds: number): string {
- const duration = props.player?.duration ?? 0;
+ const duration = player.value?.duration ?? 0;
const h = Math.floor(totalSeconds / 3600);
const m = Math.floor((totalSeconds % 3600) / 60);
@@ -136,47 +48,10 @@ function formatTimestamp(totalSeconds: number): string {
return `${m}:${formattedSeconds}`;
}
-function buildTranscriptUrl(subtitle?: SubtitleResource): string | undefined {
- if (!subtitle) return undefined;
-
- const { metadata_uuid, track_id, language } = subtitle;
- const languageSlug = track_id === 0 ? `.${language}` : '';
-
- return `/data/subtitles/${metadata_uuid}/${track_id}${languageSlug}.vtt`;
-}
-
-async function loadTranscript() {
- const url = buildTranscriptUrl(props.subtitleTrack);
-
- if (!url || loadedTranscriptUrl.value === url) return;
-
- try {
- isLoading.value = true;
-
- const response = await fetch(url);
-
- if (!response.ok) {
- throw new Error(`Failed to fetch transcript: ${response.status}`);
- }
-
- rawTranscript.value = await response.text();
- loadedTranscriptUrl.value = url;
- } catch (error) {
- toast.error('Failed to load transcript');
- console.error('Failed to load transcript:', error);
- } finally {
- isLoading.value = false;
- }
-}
-
function setTranscriptLineRef(index: number, el: Element | ComponentPublicInstance | null) {
transcriptLineRefs.value[index] = el as HTMLElement | null;
}
-function handleUpdateEvent() {
- currentTime.value = props.player?.currentTime ?? 0;
-}
-
function scrollToLine(index: number, behavior: ScrollBehavior = 'smooth') {
const line = transcriptLineRefs.value[index];
const container = transcriptContainer.value;
@@ -222,16 +97,7 @@ watch(
);
watch(
- () => props.player,
- (newPlayer, oldPlayer) => {
- oldPlayer?.removeEventListener('timeupdate', handleUpdateEvent);
- newPlayer?.addEventListener('timeupdate', handleUpdateEvent);
- },
- { immediate: true },
-);
-
-watch(
- () => props.subtitleTrack,
+ () => subtitleTrack.value,
() => {
rawTranscript.value = '';
transcriptLineRefs.value = [];
@@ -265,10 +131,6 @@ onBeforeUnmount(() => {
transcriptContainer.value?.removeEventListener('wheel', handleUserScroll);
transcriptContainer.value?.removeEventListener('touchmove', handleUserScroll);
});
-
-onUnmounted(() => {
- props.player?.removeEventListener('timeupdate', handleUpdateEvent);
-});
</script>
<template>
@@ -277,7 +139,7 @@ onUnmounted(() => {
v-show="isVisible"
:class="[
'pointer-events-auto w-full max-w-120 flex-1 overflow-y-auto',
- { 'rounded-xl border border-neutral-700/10 bg-neutral-800/90 p-1.5 backdrop-blur-md': !isTeleported },
+ { 'rounded-xl border border-neutral-700/10 bg-neutral-800/90 p-1.5 text-[10px] backdrop-blur-md sm:text-xs': !isTeleported },
{ 'relative text-xs': isTeleported },
]"
>
@@ -286,16 +148,32 @@ onUnmounted(() => {
:class="['scrollbar-minimal scrollbar-dark relative flex h-full flex-col gap-1 overflow-y-auto pe-1', { 'max-h-(--min-page-height-derived)': isTeleported }]"
>
<div :class="cn('sticky top-0 z-10 flex items-center justify-between gap-2 rounded-lg bg-neutral-800 px-2 py-1.5 backdrop-blur-xs', { hidden: isTeleported })">
- <p class="text-sm font-medium text-white/90">Transcript</p>
- <ButtonCorner
- title="Close Transcript"
- @click="emit('close')"
- colour-classes="hover:bg-transparent"
- text-classes=" hover:text-danger-2"
- position-classes="size-5"
- >
- <template #icon> <ProiconsCancel /> </template>
- </ButtonCorner>
+ <p class="text-xs font-medium text-white/90 sm:text-sm">Transcript</p>
+ <div class="flex items-center gap-2">
+ <ButtonCorner
+ v-if="isDesktop && isNormalView"
+ @click="
+ () => {
+ cycleSideBar('transcript', 'list-card');
+ }
+ "
+ title="Move to Sidebar"
+ colour-classes="hover:bg-transparent"
+ text-classes="text-white/70 hover:text-white"
+ position-classes="size-5"
+ >
+ <template #icon> <ProiconsPanelRight class="size-4" /> </template>
+ </ButtonCorner>
+ <ButtonCorner
+ title="Close Transcript"
+ @click="close()"
+ colour-classes="hover:bg-transparent"
+ text-classes="text-white/70 hover:text-danger-2"
+ position-classes="size-5"
+ >
+ <template #icon> <ProiconsCancel class="size-4" /> </template>
+ </ButtonCorner>
+ </div>
</div>
<div class="w-full space-y-1" v-if="isVisible && subtitleTrack">
<div v-if="isLoading">
@@ -318,7 +196,7 @@ onUnmounted(() => {
@click="
() => {
isFollowing = true;
- emit('seek', line.start);
+ seek(line.start);
}
"
>
@@ -340,9 +218,10 @@ onUnmounted(() => {
</div>
<GenerateTranscript
v-else-if="!subtitleTrack"
+ :class="{ 'py-20': !isTeleported }"
@generated="
(data) => {
- emit('generated', data.track);
+ generated(data.track);
}
"
/>
diff --git a/resources/js/components/video/transcript/useTranscript.ts b/resources/js/components/video/transcript/useTranscript.ts
new file mode 100644
index 00000000..0b6906f9
--- /dev/null
+++ b/resources/js/components/video/transcript/useTranscript.ts
@@ -0,0 +1,181 @@
+import type { SubtitleResource } from '@/contracts/media';
+import type { PlayerViewMode } from '@/components/video/VideoPlayer.vue';
+
+import { computed, ref, shallowRef, watch } from 'vue';
+import { toast } from '@aminnausin/cedar-ui';
+
+export interface TranscriptLine {
+ index: number;
+ text: string;
+ start: number;
+ end: number;
+}
+
+const ALLOWED_TAG_PATTERN = /<(?!\/?(?:i|u|br)\b)[^>]*>/gi;
+
+const player = shallowRef<HTMLVideoElement | null>(null);
+const playerViewMode = ref<PlayerViewMode>('normal');
+const isNormalView = computed(() => playerViewMode.value === 'normal');
+const subtitleTrack = ref<SubtitleResource>();
+
+const rawTranscript = ref('');
+const currentTime = ref(0);
+const isLoading = ref(false);
+const loadedTranscriptUrl = ref<string>();
+
+const parsedTranscript = computed<TranscriptLine[]>(() => {
+ const lines: TranscriptLine[] = [];
+
+ const vtt = rawTranscript.value.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
+ const cueLines = vtt.split('\n');
+
+ for (let i = 0; i < cueLines.length; i++) {
+ const line = cueLines[i].trim();
+ if (!line.includes(' --> ')) continue;
+
+ const [start, end] = line.split(' --> ');
+ const textLines: string[] = [];
+ i++;
+
+ while (i < cueLines.length && cueLines[i].trim() !== '') {
+ textLines.push(cueLines[i]);
+ i++;
+ }
+
+ const startTime = timestampToSeconds(start);
+ const endTime = timestampToSeconds(end);
+ const text = textLines.join('\n').trim().replace(ALLOWED_TAG_PATTERN, '');
+
+ if (!text) continue;
+
+ const previous = lines[lines.length - 1];
+ if (previous && previous.text === text && startTime <= previous.end) {
+ previous.end = Math.max(previous.end, endTime);
+ continue;
+ }
+
+ lines.push({ start: startTime, end: endTime, text, index: lines.length });
+ }
+ return lines;
+});
+
+const activeIndex = computed(() => {
+ const lines = parsedTranscript.value;
+ const time = currentTime.value;
+
+ let low = 0;
+ let high = lines.length - 1;
+
+ while (low <= high) {
+ const mid = (low + high) >> 1;
+ const line = lines[mid];
+ const next = lines[mid + 1];
+
+ if (time < line.start) high = mid - 1;
+ else if (!next || time < next.start) return mid;
+ else low = mid + 1;
+ }
+
+ return -1;
+});
+
+function timestampToSeconds(timestamp: string): number {
+ const parts = timestamp.trim().split(':').map(Number);
+ if (parts.length === 2) return parts[0] * 60 + parts[1];
+ if (parts.length === 3) return parts[0] * 3600 + parts[1] * 60 + parts[2];
+ return 0;
+}
+
+function buildTranscriptUrl(subtitle?: SubtitleResource): string | undefined {
+ if (!subtitle) return undefined;
+
+ const { metadata_uuid, track_id, language } = subtitle;
+ const languageSlug = track_id === 0 ? `.${language}` : '';
+
+ return `/data/subtitles/${metadata_uuid}/${track_id}${languageSlug}.vtt`;
+}
+
+async function loadTranscript() {
+ const url = buildTranscriptUrl(subtitleTrack.value);
+
+ if (!url || loadedTranscriptUrl.value === url) return;
+
+ try {
+ isLoading.value = true;
+
+ const response = await fetch(url);
+
+ if (!response.ok) throw new Error(`Failed to fetch transcript: ${response.status}`);
+
+ rawTranscript.value = await response.text();
+ loadedTranscriptUrl.value = url;
+ } catch (error) {
+ toast.error('Failed to load transcript');
+ console.error('Failed to load transcript:', error);
+ } finally {
+ isLoading.value = false;
+ }
+}
+
+type TranscriptHandlers = {
+ seek: (seconds: number) => void;
+ close: () => void;
+ generated: (track: SubtitleResource) => void;
+};
+
+let handlers: TranscriptHandlers | null = null;
+
+function registerTranscriptContext(h: TranscriptHandlers) {
+ handlers = h;
+}
+
+function unregisterTranscriptContext() {
+ handlers = null;
+ player.value = null;
+}
+
+function seek(seconds: number) {
+ handlers?.seek(seconds);
+}
+
+function close() {
+ handlers?.close();
+}
+
+function generated(track: SubtitleResource) {
+ handlers?.generated(track);
+}
+
+function handleTimeUpdate(this: HTMLVideoElement) {
+ currentTime.value = this.currentTime;
+}
+
+watch(player, (newPlayer, oldPlayer) => {
+ oldPlayer?.removeEventListener('timeupdate', handleTimeUpdate);
+ newPlayer?.addEventListener('timeupdate', handleTimeUpdate);
+});
+
+export function useTranscript() {
+ return {
+ // transcript
+ rawTranscript,
+ currentTime,
+ isLoading,
+ loadedTranscriptUrl,
+ parsedTranscript,
+ activeIndex,
+ loadTranscript,
+ // player-owned state
+ player,
+ playerViewMode,
+ isNormalView,
+ subtitleTrack,
+ // owner registration (VideoPlayer.vue calls these)
+ registerTranscriptContext,
+ unregisterTranscriptContext,
+ // consumer actions (PlayerTranscript.vue / TranscriptSidebar.vue call these)
+ seek,
+ close,
+ generated,
+ };
+}
diff --git a/resources/js/stores/AppStore.ts b/resources/js/stores/AppStore.ts
index e0e8df1f..04d63e9d 100644
--- a/resources/js/stores/AppStore.ts
+++ b/resources/js/stores/AppStore.ts
@@ -52,7 +52,6 @@ export const useAppStore = defineStore('App', () => {
const ws = ref<Echo<keyof Broadcaster> | null>(null);
const selectedSideBar = ref('');
- const loadedSideBar = ref('');
const sideBarTarget = ref('');
const pageTitle = ref('');
const scrollLock = ref(false);
@@ -117,7 +116,6 @@ export const useAppStore = defineStore('App', () => {
async function cycleSideBar(target = '', scrollTarget: '' | 'left-card' | 'list-card' | 'root' = '', scrollToTarget = true) {
sideBarTarget.value = scrollTarget;
- loadedSideBar.value = '';
if (selectedSideBar.value === target) {
selectedSideBar.value = '';
@@ -241,7 +239,6 @@ export const useAppStore = defineStore('App', () => {
// Nav State
cycleSideBar,
selectedSideBar,
- loadedSideBar,
sideBarTarget,
pageTitle,