mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
initial commit
This commit is contained in:
474
src/config/definitions.ts
Normal file
474
src/config/definitions.ts
Normal file
@@ -0,0 +1,474 @@
|
||||
import {
|
||||
AnkiConnectConfig,
|
||||
Config,
|
||||
RawConfig,
|
||||
ResolvedConfig,
|
||||
RuntimeOptionId,
|
||||
RuntimeOptionScope,
|
||||
RuntimeOptionValue,
|
||||
RuntimeOptionValueType,
|
||||
} from "../types";
|
||||
|
||||
export type ConfigValueKind =
|
||||
| "boolean"
|
||||
| "number"
|
||||
| "string"
|
||||
| "enum"
|
||||
| "array"
|
||||
| "object";
|
||||
|
||||
export interface RuntimeOptionRegistryEntry {
|
||||
id: RuntimeOptionId;
|
||||
path: string;
|
||||
label: string;
|
||||
scope: RuntimeOptionScope;
|
||||
valueType: RuntimeOptionValueType;
|
||||
allowedValues: RuntimeOptionValue[];
|
||||
defaultValue: RuntimeOptionValue;
|
||||
requiresRestart: boolean;
|
||||
formatValueForOsd: (value: RuntimeOptionValue) => string;
|
||||
toAnkiPatch: (value: RuntimeOptionValue) => Partial<AnkiConnectConfig>;
|
||||
}
|
||||
|
||||
export interface ConfigOptionRegistryEntry {
|
||||
path: string;
|
||||
kind: ConfigValueKind;
|
||||
defaultValue: unknown;
|
||||
description: string;
|
||||
enumValues?: readonly string[];
|
||||
runtime?: RuntimeOptionRegistryEntry;
|
||||
}
|
||||
|
||||
export interface ConfigTemplateSection {
|
||||
title: string;
|
||||
description: string[];
|
||||
key: keyof ResolvedConfig;
|
||||
notes?: string[];
|
||||
}
|
||||
|
||||
export const SPECIAL_COMMANDS = {
|
||||
SUBSYNC_TRIGGER: "__subsync-trigger",
|
||||
RUNTIME_OPTIONS_OPEN: "__runtime-options-open",
|
||||
RUNTIME_OPTION_CYCLE_PREFIX: "__runtime-option-cycle:",
|
||||
REPLAY_SUBTITLE: "__replay-subtitle",
|
||||
PLAY_NEXT_SUBTITLE: "__play-next-subtitle",
|
||||
} as const;
|
||||
|
||||
export const DEFAULT_KEYBINDINGS: NonNullable<ResolvedConfig["keybindings"]> = [
|
||||
{ key: "Space", command: ["cycle", "pause"] },
|
||||
{ key: "ArrowRight", command: ["seek", 5] },
|
||||
{ key: "ArrowLeft", command: ["seek", -5] },
|
||||
{ key: "ArrowUp", command: ["seek", 60] },
|
||||
{ key: "ArrowDown", command: ["seek", -60] },
|
||||
{ key: "Shift+KeyH", command: ["sub-seek", -1] },
|
||||
{ key: "Shift+KeyL", command: ["sub-seek", 1] },
|
||||
{ key: "Ctrl+Shift+KeyH", command: [SPECIAL_COMMANDS.REPLAY_SUBTITLE] },
|
||||
{ key: "Ctrl+Shift+KeyL", command: [SPECIAL_COMMANDS.PLAY_NEXT_SUBTITLE] },
|
||||
{ key: "KeyQ", command: ["quit"] },
|
||||
{ key: "Ctrl+KeyW", command: ["quit"] },
|
||||
];
|
||||
|
||||
export const DEFAULT_CONFIG: ResolvedConfig = {
|
||||
subtitlePosition: { yPercent: 10 },
|
||||
keybindings: [],
|
||||
websocket: {
|
||||
enabled: "auto",
|
||||
port: 6677,
|
||||
},
|
||||
texthooker: {
|
||||
openBrowser: true,
|
||||
},
|
||||
ankiConnect: {
|
||||
enabled: false,
|
||||
url: "http://127.0.0.1:8765",
|
||||
pollingRate: 3000,
|
||||
fields: {
|
||||
audio: "ExpressionAudio",
|
||||
image: "Picture",
|
||||
sentence: "Sentence",
|
||||
miscInfo: "MiscInfo",
|
||||
translation: "SelectionText",
|
||||
},
|
||||
ai: {
|
||||
enabled: false,
|
||||
alwaysUseAiTranslation: false,
|
||||
apiKey: "",
|
||||
model: "openai/gpt-4o-mini",
|
||||
baseUrl: "https://openrouter.ai/api",
|
||||
targetLanguage: "English",
|
||||
systemPrompt:
|
||||
"You are a translation engine. Return only the translated text with no explanations.",
|
||||
},
|
||||
media: {
|
||||
generateAudio: true,
|
||||
generateImage: true,
|
||||
imageType: "static",
|
||||
imageFormat: "jpg",
|
||||
imageQuality: 92,
|
||||
imageMaxWidth: undefined,
|
||||
imageMaxHeight: undefined,
|
||||
animatedFps: 10,
|
||||
animatedMaxWidth: 640,
|
||||
animatedMaxHeight: undefined,
|
||||
animatedCrf: 35,
|
||||
audioPadding: 0.5,
|
||||
fallbackDuration: 3.0,
|
||||
maxMediaDuration: 30,
|
||||
},
|
||||
behavior: {
|
||||
overwriteAudio: true,
|
||||
overwriteImage: true,
|
||||
mediaInsertMode: "append",
|
||||
highlightWord: true,
|
||||
notificationType: "osd",
|
||||
autoUpdateNewCards: true,
|
||||
},
|
||||
metadata: {
|
||||
pattern: "[SubMiner] %f (%t)",
|
||||
},
|
||||
isLapis: {
|
||||
enabled: false,
|
||||
sentenceCardModel: "Japanese sentences",
|
||||
sentenceCardSentenceField: "Sentence",
|
||||
sentenceCardAudioField: "SentenceAudio",
|
||||
},
|
||||
isKiku: {
|
||||
enabled: false,
|
||||
fieldGrouping: "disabled",
|
||||
deleteDuplicateInAuto: true,
|
||||
},
|
||||
},
|
||||
shortcuts: {
|
||||
toggleVisibleOverlayGlobal: "Alt+Shift+O",
|
||||
toggleInvisibleOverlayGlobal: "Alt+Shift+I",
|
||||
copySubtitle: "CommandOrControl+C",
|
||||
copySubtitleMultiple: "CommandOrControl+Shift+C",
|
||||
updateLastCardFromClipboard: "CommandOrControl+V",
|
||||
triggerFieldGrouping: "CommandOrControl+G",
|
||||
triggerSubsync: "Ctrl+Alt+S",
|
||||
mineSentence: "CommandOrControl+S",
|
||||
mineSentenceMultiple: "CommandOrControl+Shift+S",
|
||||
multiCopyTimeoutMs: 3000,
|
||||
toggleSecondarySub: "CommandOrControl+Shift+V",
|
||||
markAudioCard: "CommandOrControl+Shift+A",
|
||||
openRuntimeOptions: "CommandOrControl+Shift+O",
|
||||
},
|
||||
secondarySub: {
|
||||
secondarySubLanguages: [],
|
||||
autoLoadSecondarySub: false,
|
||||
defaultMode: "hover",
|
||||
},
|
||||
subsync: {
|
||||
defaultMode: "auto",
|
||||
alass_path: "",
|
||||
ffsubsync_path: "",
|
||||
ffmpeg_path: "",
|
||||
},
|
||||
subtitleStyle: {
|
||||
fontFamily:
|
||||
"Noto Sans CJK JP Regular, Noto Sans CJK JP, Arial Unicode MS, Arial, sans-serif",
|
||||
fontSize: 35,
|
||||
fontColor: "#cad3f5",
|
||||
fontWeight: "normal",
|
||||
fontStyle: "normal",
|
||||
backgroundColor: "rgba(54, 58, 79, 0.5)",
|
||||
secondary: {
|
||||
fontSize: 24,
|
||||
fontColor: "#ffffff",
|
||||
backgroundColor: "transparent",
|
||||
fontWeight: "normal",
|
||||
fontStyle: "normal",
|
||||
fontFamily:
|
||||
"Noto Sans CJK JP Regular, Noto Sans CJK JP, Arial Unicode MS, Arial, sans-serif",
|
||||
},
|
||||
},
|
||||
auto_start_overlay: false,
|
||||
bind_visible_overlay_to_mpv_sub_visibility: true,
|
||||
jimaku: {
|
||||
apiBaseUrl: "https://jimaku.cc",
|
||||
languagePreference: "ja",
|
||||
maxEntryResults: 10,
|
||||
},
|
||||
youtubeSubgen: {
|
||||
mode: "automatic",
|
||||
whisperBin: "",
|
||||
whisperModel: "",
|
||||
primarySubLanguages: ["ja", "jpn"],
|
||||
},
|
||||
invisibleOverlay: {
|
||||
startupVisibility: "platform-default",
|
||||
},
|
||||
};
|
||||
|
||||
export const DEFAULT_ANKI_CONNECT_CONFIG = DEFAULT_CONFIG.ankiConnect;
|
||||
|
||||
export const RUNTIME_OPTION_REGISTRY: RuntimeOptionRegistryEntry[] = [
|
||||
{
|
||||
id: "anki.autoUpdateNewCards",
|
||||
path: "ankiConnect.behavior.autoUpdateNewCards",
|
||||
label: "Auto Update New Cards",
|
||||
scope: "ankiConnect",
|
||||
valueType: "boolean",
|
||||
allowedValues: [true, false],
|
||||
defaultValue: DEFAULT_CONFIG.ankiConnect.behavior.autoUpdateNewCards,
|
||||
requiresRestart: false,
|
||||
formatValueForOsd: (value) => (value === true ? "On" : "Off"),
|
||||
toAnkiPatch: (value) => ({
|
||||
behavior: { autoUpdateNewCards: value === true },
|
||||
}),
|
||||
},
|
||||
{
|
||||
id: "anki.kikuFieldGrouping",
|
||||
path: "ankiConnect.isKiku.fieldGrouping",
|
||||
label: "Kiku Field Grouping",
|
||||
scope: "ankiConnect",
|
||||
valueType: "enum",
|
||||
allowedValues: ["auto", "manual", "disabled"],
|
||||
defaultValue: "disabled",
|
||||
requiresRestart: false,
|
||||
formatValueForOsd: (value) => String(value),
|
||||
toAnkiPatch: (value) => ({
|
||||
isKiku: {
|
||||
fieldGrouping:
|
||||
value === "auto" || value === "manual" || value === "disabled"
|
||||
? value
|
||||
: "disabled",
|
||||
},
|
||||
}),
|
||||
},
|
||||
];
|
||||
|
||||
export const CONFIG_OPTION_REGISTRY: ConfigOptionRegistryEntry[] = [
|
||||
{
|
||||
path: "websocket.enabled",
|
||||
kind: "enum",
|
||||
enumValues: ["auto", "true", "false"],
|
||||
defaultValue: DEFAULT_CONFIG.websocket.enabled,
|
||||
description: "Built-in subtitle websocket server mode.",
|
||||
},
|
||||
{
|
||||
path: "websocket.port",
|
||||
kind: "number",
|
||||
defaultValue: DEFAULT_CONFIG.websocket.port,
|
||||
description: "Built-in subtitle websocket server port.",
|
||||
},
|
||||
{
|
||||
path: "ankiConnect.enabled",
|
||||
kind: "boolean",
|
||||
defaultValue: DEFAULT_CONFIG.ankiConnect.enabled,
|
||||
description: "Enable AnkiConnect integration.",
|
||||
},
|
||||
{
|
||||
path: "ankiConnect.pollingRate",
|
||||
kind: "number",
|
||||
defaultValue: DEFAULT_CONFIG.ankiConnect.pollingRate,
|
||||
description: "Polling interval in milliseconds.",
|
||||
},
|
||||
{
|
||||
path: "ankiConnect.behavior.autoUpdateNewCards",
|
||||
kind: "boolean",
|
||||
defaultValue: DEFAULT_CONFIG.ankiConnect.behavior.autoUpdateNewCards,
|
||||
description: "Automatically update newly added cards.",
|
||||
runtime: RUNTIME_OPTION_REGISTRY[0],
|
||||
},
|
||||
{
|
||||
path: "ankiConnect.isKiku.fieldGrouping",
|
||||
kind: "enum",
|
||||
enumValues: ["auto", "manual", "disabled"],
|
||||
defaultValue: DEFAULT_CONFIG.ankiConnect.isKiku.fieldGrouping,
|
||||
description: "Kiku duplicate-card field grouping mode.",
|
||||
runtime: RUNTIME_OPTION_REGISTRY[1],
|
||||
},
|
||||
{
|
||||
path: "subsync.defaultMode",
|
||||
kind: "enum",
|
||||
enumValues: ["auto", "manual"],
|
||||
defaultValue: DEFAULT_CONFIG.subsync.defaultMode,
|
||||
description: "Subsync default mode.",
|
||||
},
|
||||
{
|
||||
path: "shortcuts.multiCopyTimeoutMs",
|
||||
kind: "number",
|
||||
defaultValue: DEFAULT_CONFIG.shortcuts.multiCopyTimeoutMs,
|
||||
description: "Timeout for multi-copy/mine modes.",
|
||||
},
|
||||
{
|
||||
path: "bind_visible_overlay_to_mpv_sub_visibility",
|
||||
kind: "boolean",
|
||||
defaultValue: DEFAULT_CONFIG.bind_visible_overlay_to_mpv_sub_visibility,
|
||||
description:
|
||||
"Link visible overlay toggles to MPV subtitle visibility (primary and secondary).",
|
||||
},
|
||||
{
|
||||
path: "jimaku.languagePreference",
|
||||
kind: "enum",
|
||||
enumValues: ["ja", "en", "none"],
|
||||
defaultValue: DEFAULT_CONFIG.jimaku.languagePreference,
|
||||
description: "Preferred language used in Jimaku search.",
|
||||
},
|
||||
{
|
||||
path: "jimaku.maxEntryResults",
|
||||
kind: "number",
|
||||
defaultValue: DEFAULT_CONFIG.jimaku.maxEntryResults,
|
||||
description: "Maximum Jimaku search results returned.",
|
||||
},
|
||||
{
|
||||
path: "youtubeSubgen.mode",
|
||||
kind: "enum",
|
||||
enumValues: ["automatic", "preprocess", "off"],
|
||||
defaultValue: DEFAULT_CONFIG.youtubeSubgen.mode,
|
||||
description: "YouTube subtitle generation mode for the launcher script.",
|
||||
},
|
||||
{
|
||||
path: "youtubeSubgen.whisperBin",
|
||||
kind: "string",
|
||||
defaultValue: DEFAULT_CONFIG.youtubeSubgen.whisperBin,
|
||||
description: "Path to whisper.cpp CLI used as fallback transcription engine.",
|
||||
},
|
||||
{
|
||||
path: "youtubeSubgen.whisperModel",
|
||||
kind: "string",
|
||||
defaultValue: DEFAULT_CONFIG.youtubeSubgen.whisperModel,
|
||||
description: "Path to whisper model used for fallback transcription.",
|
||||
},
|
||||
{
|
||||
path: "youtubeSubgen.primarySubLanguages",
|
||||
kind: "string",
|
||||
defaultValue: DEFAULT_CONFIG.youtubeSubgen.primarySubLanguages.join(","),
|
||||
description:
|
||||
"Comma-separated primary subtitle language priority used by the launcher.",
|
||||
},
|
||||
];
|
||||
|
||||
export const CONFIG_TEMPLATE_SECTIONS: ConfigTemplateSection[] = [
|
||||
{
|
||||
title: "Overlay Auto-Start",
|
||||
description: [
|
||||
"When overlay connects to mpv, automatically show overlay and hide mpv subtitles.",
|
||||
],
|
||||
key: "auto_start_overlay",
|
||||
},
|
||||
{
|
||||
title: "Visible Overlay Subtitle Binding",
|
||||
description: [
|
||||
"Control whether visible overlay toggles also toggle MPV subtitle visibility.",
|
||||
"When enabled, visible overlay hides MPV subtitles; when disabled, MPV subtitles are left unchanged.",
|
||||
],
|
||||
key: "bind_visible_overlay_to_mpv_sub_visibility",
|
||||
},
|
||||
{
|
||||
title: "Texthooker Server",
|
||||
description: [
|
||||
"Control whether browser opens automatically for texthooker.",
|
||||
],
|
||||
key: "texthooker",
|
||||
},
|
||||
{
|
||||
title: "WebSocket Server",
|
||||
description: [
|
||||
"Built-in WebSocket server broadcasts subtitle text to connected clients.",
|
||||
"Auto mode disables built-in server if mpv_websocket is detected.",
|
||||
],
|
||||
key: "websocket",
|
||||
},
|
||||
{
|
||||
title: "AnkiConnect Integration",
|
||||
description: ["Automatic Anki updates and media generation options."],
|
||||
key: "ankiConnect",
|
||||
},
|
||||
{
|
||||
title: "Keyboard Shortcuts",
|
||||
description: [
|
||||
"Overlay keyboard shortcuts. Set a shortcut to null to disable.",
|
||||
],
|
||||
key: "shortcuts",
|
||||
},
|
||||
{
|
||||
title: "Invisible Overlay",
|
||||
description: [
|
||||
"Startup behavior for the invisible interactive subtitle mining layer.",
|
||||
],
|
||||
key: "invisibleOverlay",
|
||||
},
|
||||
{
|
||||
title: "Keybindings (MPV Commands)",
|
||||
description: [
|
||||
"Extra keybindings that are merged with built-in defaults.",
|
||||
"Set command to null to disable a default keybinding.",
|
||||
],
|
||||
key: "keybindings",
|
||||
},
|
||||
{
|
||||
title: "Subtitle Appearance",
|
||||
description: ["Primary and secondary subtitle styling."],
|
||||
key: "subtitleStyle",
|
||||
},
|
||||
{
|
||||
title: "Secondary Subtitles",
|
||||
description: [
|
||||
"Dual subtitle track options.",
|
||||
"Used by subminer YouTube subtitle generation as secondary language preferences.",
|
||||
],
|
||||
key: "secondarySub",
|
||||
},
|
||||
{
|
||||
title: "Auto Subtitle Sync",
|
||||
description: ["Subsync engine and executable paths."],
|
||||
key: "subsync",
|
||||
},
|
||||
{
|
||||
title: "Subtitle Position",
|
||||
description: ["Initial vertical subtitle position from the bottom."],
|
||||
key: "subtitlePosition",
|
||||
},
|
||||
{
|
||||
title: "Jimaku",
|
||||
description: ["Jimaku API configuration and defaults."],
|
||||
key: "jimaku",
|
||||
},
|
||||
{
|
||||
title: "YouTube Subtitle Generation",
|
||||
description: [
|
||||
"Defaults for subminer YouTube subtitle extraction/transcription mode.",
|
||||
],
|
||||
key: "youtubeSubgen",
|
||||
},
|
||||
];
|
||||
|
||||
export function deepCloneConfig(config: ResolvedConfig): ResolvedConfig {
|
||||
return JSON.parse(JSON.stringify(config)) as ResolvedConfig;
|
||||
}
|
||||
|
||||
export function deepMergeRawConfig(
|
||||
base: RawConfig,
|
||||
patch: RawConfig,
|
||||
): RawConfig {
|
||||
const clone = JSON.parse(JSON.stringify(base)) as Record<string, unknown>;
|
||||
const patchObject = patch as Record<string, unknown>;
|
||||
|
||||
const mergeInto = (
|
||||
target: Record<string, unknown>,
|
||||
source: Record<string, unknown>,
|
||||
): void => {
|
||||
for (const [key, value] of Object.entries(source)) {
|
||||
if (
|
||||
value !== null &&
|
||||
typeof value === "object" &&
|
||||
!Array.isArray(value) &&
|
||||
typeof target[key] === "object" &&
|
||||
target[key] !== null &&
|
||||
!Array.isArray(target[key])
|
||||
) {
|
||||
mergeInto(
|
||||
target[key] as Record<string, unknown>,
|
||||
value as Record<string, unknown>,
|
||||
);
|
||||
} else {
|
||||
target[key] = value;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
mergeInto(clone, patchObject);
|
||||
return clone as RawConfig;
|
||||
}
|
||||
Reference in New Issue
Block a user