Skip to content

A self-hosted media server and file management system

feat: add custom font options to UI

aminnausin594ff1a762a6
diff --git a/resources/js/components/icons/ProIconsTextHighlightColorOff.vue b/resources/js/components/icons/ProIconsTextHighlightColorOff.vue
new file mode 100644
index 00000000..bfb3cb21
--- /dev/null
+++ b/resources/js/components/icons/ProIconsTextHighlightColorOff.vue
@@ -0,0 +1,15 @@
+<template>
+ <svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" viewBox="0 0 24 24">
+ <defs>
+ <mask id="off-mask">
+ <rect width="24" height="24" fill="white" />
+ <path d="M3 3L21 21" stroke="black" stroke-width="4" stroke-linecap="round" stroke-linejoin="round" />
+ </mask>
+ </defs>
+ <g fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" stroke-width="1.5">
+ <rect width="16.5" height="16.5" x="3.75" y="3.75" rx="4" mask="url(#off-mask)" />
+ <path d="m8.25 16l1.34-3.063m0 0h4.82m-4.82 0l2.051-4.694a.386.386 0 0 1 .718 0l2.052 4.694m0 0L15.75 16" mask="url(#off-mask)" />
+ <path d="M3 3L21 21" stroke-linecap="round" stroke-linejoin="round" />
+ </g>
+ </svg>
+</template>
diff --git a/resources/js/components/video/VideoInfoPanel.vue b/resources/js/components/video/VideoInfoPanel.vue
index 9f77ff19..ec18d9f4 100755
--- a/resources/js/components/video/VideoInfoPanel.vue
+++ b/resources/js/components/video/VideoInfoPanel.vue
@@ -3,6 +3,7 @@ import type { AxiosError } from 'axios';
import { computed, onMounted, ref, useTemplateRef, watch, nextTick } from 'vue';
import { handleStorageURL, toTimeSpan, formatFileSize, toPlural } from '@/service/util';
+import { resetFonts, resetSubtitles } from '@/service/media/attachments';
import { getMediaDateDescription } from '@/service/media/mediaFormatter';
import { runRegenerateStoryboard } from '@/service/media/storyboard';
import { handleEditFolderImages } from '@/service/folder/folderActions';
@@ -11,7 +12,6 @@ import { handleEditMediaImages } from '@/service/media/mediaActions';
import { getUserViewCount } from '@/service/mediaAPI';
import { ContextMenuItem } from '@/components/cedar-ui/context-menu';
import { useContentStore } from '@/stores/ContentStore';
-import { resetSubtitles } from '@/service/media/subtitles';
import { useModalStore } from '@/stores/ModalStore';
import { BasePopover } from '@/components/cedar-ui/popover';
import { storeToRefs } from 'pinia';
@@ -29,6 +29,7 @@ import useMetaData from '@/composables/useMetaData';
import ShareModal from '@/components/modals/ShareModal.vue';
import LazyImage from '@/components/lazy/LazyImage.vue';
+import ProiconsTextFontSize from '~icons/proicons/text-font-size';
import ProiconsMoreVertical from '~icons/proicons/more-vertical';
import ProiconsInfoSquare from '~icons/proicons/info-square';
import TablerDownload from '@/components/icons/TablerDownload.vue';
@@ -90,6 +91,12 @@ const popoverItems = computed(() => {
action: () => handleEditMediaImages(stateVideo.value, stateDirectory.value.id),
hidden: !isAuthenticated.value,
},
+ {
+ icon: ProiconsPhoto,
+ text: (stateVideo.value.storyboard ? 'Reset' : 'Build') + ' Storyboard',
+ hidden: !isAuthenticated.value || stateVideo.value.metadata?.media_type === 1,
+ action: handleResetStoryboard,
+ },
{
icon: IconCaptions,
text: 'Reset Subtitles',
@@ -97,10 +104,10 @@ const popoverItems = computed(() => {
action: handleResetSubtitles,
},
{
- icon: ProiconsPhoto,
- text: (stateVideo.value.storyboard ? 'Reset' : 'Build') + ' Storyboard',
- hidden: !isAuthenticated.value || stateVideo.value.metadata?.media_type === 1,
- action: handleResetStoryboard,
+ icon: ProiconsTextFontSize,
+ text: 'Reset Fonts',
+ hidden: stateVideo.value.metadata?.media_type === 1 || !isAuthenticated.value,
+ action: handleResetFonts,
},
];
});
@@ -155,6 +162,23 @@ const handleResetSubtitles = () => {
});
};
+const handleResetFonts = () => {
+ if (!stateVideo.value.metadata?.id) {
+ toast.error('ID Missing');
+ return;
+ }
+ toast.promise(resetFonts(stateVideo.value.metadata.id), {
+ loading: 'Resetting Fonts',
+ loadingDescription: `Clearing custom font cache`,
+ success: 'Fonts Reset!',
+ error: 'Failed to reset fonts',
+ errorDescription: (err) => {
+ const axiosErr = err as AxiosError<{ message?: string }>;
+ return axiosErr.response?.data?.message ?? axiosErr.message;
+ },
+ });
+};
+
const handleResetStoryboard = () => {
if (!stateVideo.value.metadata?.id) {
toast.error('ID Missing');
diff --git a/resources/js/components/video/subtitles/OctopusRenderer.ts b/resources/js/components/video/subtitles/OctopusRenderer.ts
index 25d7459a..6a63345b 100644
--- a/resources/js/components/video/subtitles/OctopusRenderer.ts
+++ b/resources/js/components/video/subtitles/OctopusRenderer.ts
@@ -10,7 +10,7 @@ export default function useOctopusRenderer() {
const assInstance = ref<SubtitlesOctopus | null>(null);
const abortController = ref<AbortController | null>(null);
- const instantiateOctopus = async (nextTrack: SubtitleResource, getCurrentTime: () => number, frameRate?: number) => {
+ const instantiateOctopus = async (nextTrack: SubtitleResource, getCurrentTime: () => number, frameRate?: number, fonts: string[] = []) => {
const video = document.getElementById('video-source') as HTMLVideoElement;
if (!video) return;
if (assInstance.value) clearOctopus();
@@ -47,7 +47,7 @@ export default function useOctopusRenderer() {
const options: SubtitlesOctopusOptions = {
video,
subUrl,
- fonts: [...baseFonts, ...supplementalFonts],
+ fonts: [...baseFonts, ...supplementalFonts, ...fonts],
workerUrl: '/build/lib/subtitles-octopus/subtitles-octopus-worker.js',
fallbackFont: '/fonts/noto-sans/NotoSans-V42-Regular.woff2',
onError(e?: any) {
diff --git a/resources/js/components/video/subtitles/PlayerSubtitles.vue b/resources/js/components/video/subtitles/PlayerSubtitles.vue
index afaebf1d..8962cfad 100644
--- a/resources/js/components/video/subtitles/PlayerSubtitles.vue
+++ b/resources/js/components/video/subtitles/PlayerSubtitles.vue
@@ -3,8 +3,9 @@ import type { SubtitleResource } from '@/types/resources';
import type { PopoverItem } from '@aminnausin/cedar-ui';
import type { Ref } from 'vue';
-import { computed, inject, nextTick, onMounted, onUnmounted, ref, useTemplateRef } from 'vue';
+import { computed, inject, nextTick, onMounted, onUnmounted, ref, useTemplateRef, watch } from 'vue';
import { useContentStore } from '@/stores/ContentStore';
+import { useAppStore } from '@/stores/AppStore';
import { storeToRefs } from 'pinia';
import { cn, toast } from '@aminnausin/cedar-ui';
import { round } from 'lodash-es';
@@ -14,6 +15,8 @@ import VideoPopoverSlider from '@/components/video/popover/VideoPopoverSlider.vu
import VideoPopoverItem from '@/components/video/popover/VideoPopoverItem.vue';
import VideoPopover from '@/components/video/popover/VideoPopover.vue';
+import ProIconsTextHighlightColorOff from '@/components/icons/ProIconsTextHighlightColorOff.vue';
+import ProIconsTextHighlightColor from '~icons/proicons/text-highlight-color';
import ProiconsTextFontSize from '~icons/proicons/text-font-size';
import ProiconsCheckmark from '~icons/proicons/checkmark';
import IconCaptionsOff from '@/components/icons/IconCaptionsOff.vue';
@@ -28,6 +31,7 @@ interface PlayerSubtitlesProps {
const { instantiateOctopus, clearOctopus, debouncedResetOctopusCache, resizeOctopus } = useOctopusRenderer();
//#region Shared State
+const { useEmbeddedFonts: useFonts } = storeToRefs(useAppStore());
const { stateVideo } = storeToRefs(useContentStore());
const player = inject<Ref<HTMLVideoElement>>('player');
const props = defineProps<PlayerSubtitlesProps>();
@@ -71,6 +75,17 @@ const playerSubtitleItems = computed(() => {
};
});
+ const toggleFonts: PopoverItem | undefined = stateVideo.value.fonts?.length
+ ? {
+ icon: useFonts.value ? ProIconsTextHighlightColor : ProIconsTextHighlightColorOff,
+ text: 'Custom Fonts',
+ selected: useFonts.value,
+ selectedIcon: ProiconsCheckmark,
+ selectedIconStyle: 'text-primary',
+ action: () => (useFonts.value = !useFonts.value),
+ }
+ : undefined;
+
const subtitlesOff: PopoverItem = {
icon: IconCaptionsOff,
text: 'Off',
@@ -80,7 +95,7 @@ const playerSubtitleItems = computed(() => {
action: clearSubtitles,
};
- return [subtitlesOff, ...items];
+ return [toggleFonts, subtitlesOff, ...items].filter(Boolean);
});
const defaultSubtitleTrack = computed<SubtitleResource | undefined>(() => {
@@ -110,14 +125,14 @@ const handleSizeWheel = (event: WheelEvent) => {
* Handle Subtitles Toggle
* @param track -> Defaults to first available subtitle only if not currently showing anything
*/
-const handleSubtitles = (track?: SubtitleResource) => {
+const handleSubtitles = (track?: SubtitleResource, reloadCurrentTrack = false) => {
const nextTrack = track ?? (isShowingSubtitles.value ? undefined : defaultSubtitleTrack.value);
isShowingSubtitles.value = !!nextTrack;
- subtitlesPopover.value?.handleClose();
+ if (!reloadCurrentTrack) subtitlesPopover.value?.handleClose();
// If no change, don't bother calculating anything
- if (currentSubtitleTrack.value?.id === nextTrack?.id && currentSubtitleTrack.value?.metadata_uuid === nextTrack?.metadata_uuid) return;
+ if (currentSubtitleTrack.value?.id === nextTrack?.id && currentSubtitleTrack.value?.metadata_uuid === nextTrack?.metadata_uuid && !reloadCurrentTrack) return;
currentSubtitleTrack.value = nextTrack;
@@ -127,7 +142,7 @@ const handleSubtitles = (track?: SubtitleResource) => {
}
if (nextTrack.codec === 'ass') {
- instantiateOctopus(nextTrack, props.getCurrentTime, stateVideo.value.metadata?.frame_rate);
+ instantiateOctopus(nextTrack, props.getCurrentTime, stateVideo.value.metadata?.frame_rate, useFonts.value ? stateVideo.value.fonts : []);
hideNativeTracks();
return;
}
@@ -203,6 +218,11 @@ const buildSubtitleUrl = (subtitle?: SubtitleResource): string => {
return `/data/subtitles/${metadata_uuid}/${track_id}${languageSlug}${extension}`;
};
+watch(
+ () => useFonts.value,
+ () => handleSubtitles(currentSubtitleTrack.value, true),
+);
+
onMounted(() => {
window.addEventListener('resize', debouncedResetOctopusCache);
});
diff --git a/resources/js/contracts/media.ts b/resources/js/contracts/media.ts
index d250d57a..c19aa3d9 100644
--- a/resources/js/contracts/media.ts
+++ b/resources/js/contracts/media.ts
@@ -161,6 +161,8 @@ export interface VideoResource {
folder_name?: string;
library_name?: string;
+
+ fonts?: string[];
}
export interface SubtitleResource {
diff --git a/resources/js/service/media/attachments.ts b/resources/js/service/media/attachments.ts
new file mode 100644
index 00000000..bed9d0c8
--- /dev/null
+++ b/resources/js/service/media/attachments.ts
@@ -0,0 +1,9 @@
+import { API } from '@/service/api';
+
+export const resetSubtitles = (metadataId: number) => {
+ return API.delete(`/metadata/${metadataId}/subtitles`, { headers: { 'X-Skip-Toast': 'true' } });
+};
+
+export const resetFonts = (metadataId: number) => {
+ return API.delete(`/metadata/${metadataId}/fonts`, { headers: { 'X-Skip-Toast': 'true' } });
+};
diff --git a/resources/js/service/media/subtitles.ts b/resources/js/service/media/subtitles.ts
deleted file mode 100644
index fd2ccb60..00000000
--- a/resources/js/service/media/subtitles.ts
+++ /dev/null
@@ -1,5 +0,0 @@
-import { API } from '../api';
-
-export const resetSubtitles = (metadataId: number) => {
- return API.delete(`/metadata/${metadataId}/subtitles`, { headers: { 'X-Skip-Toast': 'true' } });
-};
diff --git a/resources/js/stores/AppStore.ts b/resources/js/stores/AppStore.ts
index 31bff881..04d63e9d 100644
--- a/resources/js/stores/AppStore.ts
+++ b/resources/js/stores/AppStore.ts
@@ -86,6 +86,8 @@ export const useAppStore = defineStore('App', () => {
const preferredAudioLanguage = usePersistedString('preferredAudioLanguage', '');
+ const useEmbeddedFonts = usePersisted('useEmbeddedFonts', false);
+
//#endregion
function toggleDarkMode() {
@@ -189,6 +191,8 @@ export const useAppStore = defineStore('App', () => {
useAmLyrics.init();
preferredAudioLanguage.init();
+
+ useEmbeddedFonts.init();
};
watch(lightMode, toggleDarkMode, { immediate: false });
@@ -209,6 +213,8 @@ export const useAppStore = defineStore('App', () => {
watch(preferredAudioLanguage.state, preferredAudioLanguage.persist);
+ watch(useEmbeddedFonts.state, useEmbeddedFonts.persist);
+
//#endregion
return {
@@ -224,6 +230,7 @@ export const useAppStore = defineStore('App', () => {
preferredAudioLanguage: preferredAudioLanguage.state,
showLyricsMetadata: showLyricsMetadata.state,
useAmLyrics: useAmLyrics.state,
+ useEmbeddedFonts: useEmbeddedFonts.state,
initBrowserState,
// Local State