From 3aa621ffc162ba0691de2bdf4e2331eeb029b8da Mon Sep 17 00:00:00 2001 From: loucass003 Date: Tue, 4 Aug 2026 19:27:05 +0200 Subject: [PATCH] Cleanned up VMC / VRCOSC code + Status for VMC --- gui/app/public/i18n/en/translation.ftl | 23 ++ .../src/components/commons/StatusBadge.tsx | 55 +++ .../settings/pages/BoneRoutingSettings.tsx | 61 ++-- .../components/settings/pages/VMCSettings.tsx | 224 ++++++++++++ .../settings/pages/VRCOSCSettings.tsx | 343 ++++++++---------- gui/app/src/hooks/relative-time.ts | 32 ++ .../dev/slimevr/android/ForegroundService.kt | 1 - .../main/java/dev/slimevr/osc/transport.kt | 23 +- .../src/main/java/dev/slimevr/osc/types.kt | 9 + .../main/java/dev/slimevr/solarxr/module.kt | 2 +- .../src/main/java/dev/slimevr/solarxr/vmc.kt | 39 ++ .../main/java/dev/slimevr/solarxr/vrcosc.kt | 9 +- .../java/dev/slimevr/util/error-reporting.kt | 6 + .../main/java/dev/slimevr/vmc/behaviours.kt | 205 ----------- .../src/main/java/dev/slimevr/vmc/input.kt | 115 ++++++ .../src/main/java/dev/slimevr/vmc/module.kt | 51 ++- .../java/dev/slimevr/vmc/output-encoder.kt | 84 +++++ .../src/main/java/dev/slimevr/vmc/output.kt | 249 +++++++++++++ .../src/main/java/dev/slimevr/vrcosc/input.kt | 37 +- .../main/java/dev/slimevr/vrcosc/module.kt | 18 +- .../main/java/dev/slimevr/vrcosc/oscquery.kt | 7 +- .../main/java/dev/slimevr/vrcosc/output.kt | 96 ++--- .../src/main/java/dev/slimevr/vrcosc/utils.kt | 9 - .../dev/slimevr/routing/ManualRoutesTest.kt | 6 - .../java/dev/slimevr/vmc/OutputEncoderTest.kt | 144 ++++++++ .../src/main/java/dev/slimevr/desktop/Main.kt | 1 - solarxr-protocol | 2 +- 27 files changed, 1292 insertions(+), 559 deletions(-) create mode 100644 gui/app/src/components/commons/StatusBadge.tsx create mode 100644 gui/app/src/hooks/relative-time.ts delete mode 100644 server/core/src/main/java/dev/slimevr/vmc/behaviours.kt create mode 100644 server/core/src/main/java/dev/slimevr/vmc/input.kt create mode 100644 server/core/src/main/java/dev/slimevr/vmc/output-encoder.kt create mode 100644 server/core/src/main/java/dev/slimevr/vmc/output.kt create mode 100644 server/core/src/test/java/dev/slimevr/vmc/OutputEncoderTest.kt diff --git a/gui/app/public/i18n/en/translation.ftl b/gui/app/public/i18n/en/translation.ftl index 231b6259b..835c36ef9 100644 --- a/gui/app/public/i18n/en/translation.ftl +++ b/gui/app/public/i18n/en/translation.ftl @@ -856,6 +856,7 @@ settings-osc-vrchat-status-input-listening = Listening on port {$port} settings-osc-vrchat-status-input-last-data = Last data from VRChat: {$elapsed} settings-osc-vrchat-status-input-no-data = No data received from VRChat yet settings-osc-vrchat-status-output-idle = No target +settings-osc-vrchat-status-output-waiting = Target {$address}:{$port} ({$source}), no frame sent yet settings-osc-vrchat-status-output-sending = Sending to {$address}:{$port} ({$source}) settings-osc-vrchat-status-output-target = Target {$address}:{$port} ({$source}) settings-osc-vrchat-status-output-last-frame = Last frame sent: {$elapsed} @@ -871,6 +872,7 @@ settings-osc-vrchat-status-network-mode = Network mode settings-osc-vrchat-status-network-mode-description = Automatic mode discovers VRChat through OSCQuery. Manual mode uses the configured address and ports. settings-osc-vrchat-status-network-mode-toggle = Manual network settings settings-osc-vrchat-status-network-manual-description = Configure the local input port and the VRChat OSC target manually. + settings-osc-vrchat-status-badge-idle = Idle settings-osc-vrchat-status-badge-listening = Listening settings-osc-vrchat-status-badge-ready = Ready @@ -909,6 +911,27 @@ settings-osc-vmc-anchor_hip-label = Anchor at hips settings-osc-vmc-mirror_tracking = Mirror tracking settings-osc-vmc-mirror_tracking-description = Mirror the tracking horizontally. settings-osc-vmc-mirror_tracking-label = Mirror tracking +settings-osc-vmc-status-title = Status +settings-osc-vmc-status-input = Input +settings-osc-vmc-status-output = Output +settings-osc-vmc-status-vrm = VRM model +settings-osc-vmc-status-input-idle = Not listening +settings-osc-vmc-status-input-listening = Listening on port {$port} +settings-osc-vmc-status-input-last-data = Last data received: {$elapsed} +settings-osc-vmc-status-input-no-data = No data received yet +settings-osc-vmc-status-output-idle = No target +settings-osc-vmc-status-output-waiting = Target {$address}:{$port}, no frame sent yet +settings-osc-vmc-status-output-sending = Sending to {$address}:{$port} +settings-osc-vmc-status-output-target = Target {$address}:{$port} +settings-osc-vmc-status-output-last-frame = Last frame sent: {$elapsed} +settings-osc-vmc-status-output-no-frame = No frame sent yet +settings-osc-vmc-status-vrm-none = No model loaded, using estimated bone offsets +settings-osc-vmc-status-vrm-loaded = Model loaded, using its bone offsets +settings-osc-vmc-status-badge-idle = Idle +settings-osc-vmc-status-badge-listening = Listening +settings-osc-vmc-status-badge-ready = Ready +settings-osc-vmc-status-badge-disabled = Disabled +settings-osc-vmc-status-badge-error = Error ## Common OSC settings settings-osc-common-network-ports_match_error-v2 = The in and out ports can't be the same! diff --git a/gui/app/src/components/commons/StatusBadge.tsx b/gui/app/src/components/commons/StatusBadge.tsx new file mode 100644 index 000000000..751606e36 --- /dev/null +++ b/gui/app/src/components/commons/StatusBadge.tsx @@ -0,0 +1,55 @@ +import classNames from 'classnames'; +import { ReactNode } from 'react'; +import { Typography } from './Typography'; + +export type StatusVariant = + | 'neutral' + | 'success' + | 'special' + | 'warning' + | 'critical'; + +const VARIANT_CLASSES: Record = { + neutral: 'bg-background-50', + success: 'bg-status-success', + special: 'bg-status-special', + warning: 'bg-status-warning', + critical: 'bg-status-critical', +}; + +export function StatusBadge({ + variant, + id, +}: { + variant: StatusVariant; + id: string; +}) { + return ( + +
+ + + ); +} + +export function StatusRow({ + label, + badge, + children, +}: { + label: ReactNode; + badge: ReactNode; + children?: ReactNode; +}) { + return ( +
+
+
{label}
+ {badge} +
+ {children} +
+ ); +} diff --git a/gui/app/src/components/settings/pages/BoneRoutingSettings.tsx b/gui/app/src/components/settings/pages/BoneRoutingSettings.tsx index 0104b651e..0f86544ba 100644 --- a/gui/app/src/components/settings/pages/BoneRoutingSettings.tsx +++ b/gui/app/src/components/settings/pages/BoneRoutingSettings.tsx @@ -18,6 +18,11 @@ import { CHECKBOX_CLASSES, CheckboxInternal, } from '@/components/commons/Checkbox'; +import { + StatusBadge, + StatusRow, + type StatusVariant, +} from '@/components/commons/StatusBadge'; import { Typography } from '@/components/commons/Typography'; import { SettingsPageLayout, @@ -176,30 +181,15 @@ type OutputSummary = | 'off' | 'unavailable'; -const BADGE_CLASSES: Record = { - sending: 'bg-status-success', - idle: 'bg-status-special', - empty: 'bg-status-warning', - stopped: 'bg-background-50', - off: 'bg-background-50', - unavailable: 'bg-background-50', +const BADGE_VARIANTS: Record = { + sending: 'success', + idle: 'special', + empty: 'warning', + stopped: 'neutral', + off: 'neutral', + unavailable: 'neutral', }; -function StatusBadge({ summary }: { summary: OutputSummary }) { - return ( - -
- - - ); -} - function OutputStatusRow({ status, routed, @@ -224,17 +214,20 @@ function OutputStatusRow({ }, [status, routed]); return ( -
-
-
- -
- -
- + + } + badge={ + + } + >
)}
-
+ ); } diff --git a/gui/app/src/components/settings/pages/VMCSettings.tsx b/gui/app/src/components/settings/pages/VMCSettings.tsx index 00e43b763..11d015be9 100644 --- a/gui/app/src/components/settings/pages/VMCSettings.tsx +++ b/gui/app/src/components/settings/pages/VMCSettings.tsx @@ -5,16 +5,27 @@ import { ChangeVMCOSCSettingsRequestT, ChangeVRMSettingsRequestT, RpcMessage, + VMCOSCInputState, + VMCOSCOutputState, VMCOSCSettingsRequestT, VMCOSCSettingsResponseT, + VMCOSCStatusChangeResponseT, + VMCOSCStatusRequestT, + VMCOSCVrmState, VRMSettingsRequestT, VRMSettingsResponseT, } from 'solarxr-protocol'; import { useWebsocketAPI } from '@/hooks/websocket-api'; +import { useRelativeTime } from '@/hooks/relative-time'; import { CheckBox } from '@/components/commons/Checkbox'; import { FileInput } from '@/components/commons/FileInput'; import { VMCIcon } from '@/components/commons/icon/VMCIcon'; import { Input } from '@/components/commons/Input'; +import { + StatusBadge, + StatusRow, + type StatusVariant, +} from '@/components/commons/StatusBadge'; import { Typography } from '@/components/commons/Typography'; import { magic } from '@/utils/formatting'; import { @@ -131,10 +142,199 @@ export function VRMFileUpload() { ); } +type Badge = 'listening' | 'ready' | 'idle' | 'disabled' | 'error'; + +const BADGE_VARIANTS: Record = { + listening: 'success', + ready: 'success', + idle: 'neutral', + disabled: 'neutral', + error: 'critical', +}; + +function VmcBadge({ badge }: { badge: Badge }) { + return ( + + ); +} + +const INPUT_BADGES: Record = { + [VMCOSCInputState.IDLE]: 'idle', + [VMCOSCInputState.LISTENING]: 'ready', + [VMCOSCInputState.ERROR]: 'error', +}; + +const OUTPUT_BADGES: Record = { + [VMCOSCOutputState.IDLE]: 'idle', + [VMCOSCOutputState.READY]: 'ready', + [VMCOSCOutputState.ERROR]: 'error', +}; + +const VRM_BADGES: Record = { + [VMCOSCVrmState.NONE]: 'disabled', + [VMCOSCVrmState.LOADED]: 'ready', + [VMCOSCVrmState.ERROR]: 'error', +}; + +function inputBadge(state: VMCOSCInputState, received: boolean): Badge { + if (state === VMCOSCInputState.LISTENING && received) return 'listening'; + return INPUT_BADGES[state]; +} + +function StatusCard({ status }: { status: VMCOSCStatusChangeResponseT }) { + const relativeTime = useRelativeTime(); + + const inputState = status.inputState ?? VMCOSCInputState.IDLE; + const outputState = status.outputState ?? VMCOSCOutputState.IDLE; + const vrmState = status.vrmState ?? VMCOSCVrmState.NONE; + + const lastInputElapsed = relativeTime(status.lastReceivedInputMillis); + const lastFrameElapsed = relativeTime(status.lastFrameSentMillis); + + return ( +
+ + } + badge={ + + } + > + {inputState === VMCOSCInputState.IDLE ? ( + + ) : ( + <> + + {inputState === VMCOSCInputState.ERROR && status.inputError ? ( + + {status.inputError?.toString() ?? ''} + + ) : lastInputElapsed ? ( + + ) : ( + + )} + + )} + + + + } + badge={} + > + {outputState === VMCOSCOutputState.IDLE ? ( + status.targetAddress ? ( + + ) : ( + + ) + ) : ( + <> + + {outputState === VMCOSCOutputState.ERROR && status.outputError ? ( + + {status.outputError?.toString() ?? ''} + + ) : lastFrameElapsed ? ( + + ) : ( + + )} + + )} + + + + } + badge={} + > + {vrmState === VMCOSCVrmState.ERROR && status.vrmError ? ( + + {status.vrmError?.toString() ?? ''} + + ) : ( + + )} + +
+ ); +} + export function VMCSettings() { const { l10n } = useLocalization(); const { sendRPCPacket, useRPCPacket } = useWebsocketAPI(); const { oscValidator } = useOscPortsAddressValidator(); + const [status, setStatus] = useState( + null + ); const { reset, control, watch, handleSubmit } = useForm({ defaultValues: defaultVMCSettings, @@ -163,6 +363,8 @@ export function VMCSettings() { sendRPCPacket(RpcMessage.ChangeVMCOSCSettingsRequest, req); }; + const enabled = watch('enabled'); + useEffect(() => { const subscription = watch((_value, { type }) => { if (type === 'change') { @@ -172,6 +374,17 @@ export function VMCSettings() { return () => subscription.unsubscribe(); }, []); + useEffect(() => { + sendRPCPacket(RpcMessage.VMCOSCStatusRequest, new VMCOSCStatusRequestT()); + }, []); + + useRPCPacket( + RpcMessage.VMCOSCStatusChangeResponse, + (response: VMCOSCStatusChangeResponseT) => { + setStatus(response); + } + ); + useRPCPacket( RpcMessage.VMCOSCSettingsResponse, (settings: VMCOSCSettingsResponseT) => { @@ -228,6 +441,17 @@ export function VMCSettings() { label={l10n.getString('settings-osc-vmc-enable-label')} />
+ + {enabled && status && ( + <> + + + + )} + {l10n.getString('settings-osc-vmc-network')} diff --git a/gui/app/src/components/settings/pages/VRCOSCSettings.tsx b/gui/app/src/components/settings/pages/VRCOSCSettings.tsx index 5131757d3..4671330b8 100644 --- a/gui/app/src/components/settings/pages/VRCOSCSettings.tsx +++ b/gui/app/src/components/settings/pages/VRCOSCSettings.tsx @@ -1,7 +1,6 @@ import { Localized, useLocalization } from '@fluent/react'; import { yupResolver } from '@hookform/resolvers/yup'; -import classNames from 'classnames'; -import { ReactNode, useEffect, useState } from 'react'; +import { useEffect, useState } from 'react'; import { useForm } from 'react-hook-form'; import { boolean, object } from 'yup'; import { @@ -21,12 +20,18 @@ import { Button } from '@/components/commons/Button'; import { CheckBox } from '@/components/commons/Checkbox'; import { Input } from '@/components/commons/Input'; import { Typography } from '@/components/commons/Typography'; +import { + StatusBadge, + StatusRow, + type StatusVariant, +} from '@/components/commons/StatusBadge'; import { VRCIcon } from '@/components/commons/icon/VRCIcon'; import { SettingsPageLayout, SettingsPagePaneLayout, } from '@/components/settings/SettingsPageLayout'; import { useWebsocketAPI } from '@/hooks/websocket-api'; +import { useRelativeTime } from '@/hooks/relative-time'; import { OSCPortsAddress, useOscPortsAddressValidator, @@ -48,139 +53,67 @@ const defaultVRCOSCSettings: VRCOSCSettingsForm = { }, }; -function asString(value: string | Uint8Array | null | undefined): string { - return typeof value === 'string' ? value : ''; -} - -function formatElapsedTime(timestamp: bigint | null | undefined, now: number) { - if (!timestamp) return null; - - const elapsedSeconds = Math.max( - 0, - Math.floor((now - Number(timestamp)) / 1000) - ); - if (elapsedSeconds < 5) return 'just now'; - if (elapsedSeconds < 60) return `${elapsedSeconds}s ago`; - - const elapsedMinutes = Math.floor(elapsedSeconds / 60); - if (elapsedMinutes < 60) return `${elapsedMinutes}m ago`; - - const elapsedHours = Math.floor(elapsedMinutes / 60); - return `${elapsedHours}h ago`; -} - -type BadgeKind = - | 'idle' +type Badge = | 'listening' | 'ready' | 'found' | 'searching' + | 'idle' | 'disabled' | 'error'; -const BADGE_LABEL_KEY: Record = { - idle: 'settings-osc-vrchat-status-badge-idle', - listening: 'settings-osc-vrchat-status-badge-listening', - ready: 'settings-osc-vrchat-status-badge-ready', - found: 'settings-osc-vrchat-status-badge-found', - searching: 'settings-osc-vrchat-status-badge-searching', - disabled: 'settings-osc-vrchat-status-badge-disabled', - error: 'settings-osc-vrchat-status-badge-error', +const BADGE_VARIANTS: Record = { + listening: 'success', + ready: 'success', + found: 'success', + searching: 'special', + idle: 'neutral', + disabled: 'neutral', + error: 'critical', }; -const BADGE_CLASSES: Record = { - idle: 'bg-background-50', - listening: 'bg-status-success', - ready: 'bg-status-success', - found: 'bg-status-success', - searching: 'bg-status-special', - disabled: 'bg-background-50', - error: 'bg-status-critical', -}; - -function StatusBadge({ kind }: { kind: BadgeKind }) { +function VrcBadge({ badge }: { badge: Badge }) { return ( - -
- - + ); } -function StatusRow({ - label, - badge, - children, -}: { - label: string; - badge: BadgeKind; - children?: ReactNode; -}) { - return ( -
-
- {label} - -
- {children} -
- ); -} +const INPUT_BADGES: Record = { + [VRCOSCInputState.IDLE]: 'idle', + [VRCOSCInputState.LISTENING]: 'ready', + [VRCOSCInputState.ERROR]: 'error', +}; -function inputBadge( - state: VRCOSCInputState, - lastReceivedMillis: bigint | null | undefined -): BadgeKind { - switch (state) { - case VRCOSCInputState.LISTENING: - return lastReceivedMillis ? 'listening' : 'ready'; - case VRCOSCInputState.ERROR: - return 'error'; - default: - return 'idle'; - } -} +const OUTPUT_BADGES: Record = { + [VRCOSCOutputState.IDLE]: 'idle', + [VRCOSCOutputState.READY]: 'ready', + [VRCOSCOutputState.ERROR]: 'error', +}; -function outputBadge(state: VRCOSCOutputState): BadgeKind { - switch (state) { - case VRCOSCOutputState.READY: - return 'ready'; - case VRCOSCOutputState.ERROR: - return 'error'; - default: - return 'idle'; - } -} +const OSCQUERY_BADGES: Record = { + [VRCOSCOscQueryState.DISABLED]: 'disabled', + [VRCOSCOscQueryState.SEARCHING]: 'searching', + [VRCOSCOscQueryState.FOUND]: 'found', + [VRCOSCOscQueryState.ERROR]: 'error', +}; -function oscQueryBadge(state: VRCOSCOscQueryState): BadgeKind { - switch (state) { - case VRCOSCOscQueryState.FOUND: - return 'found'; - case VRCOSCOscQueryState.SEARCHING: - return 'searching'; - case VRCOSCOscQueryState.ERROR: - return 'error'; - default: - return 'disabled'; - } +function inputBadge(state: VRCOSCInputState, received: boolean): Badge { + if (state === VRCOSCInputState.LISTENING && received) return 'listening'; + return INPUT_BADGES[state]; } function StatusCard({ status, - now, onSwitchToTarget, }: { status: VRCOSCStatusChangeResponseT; - now: number; onSwitchToTarget: (target: VRCOSCDiscoveredTargetT) => void; }) { const { l10n } = useLocalization(); + const relativeTime = useRelativeTime(); const inputState = status.inputState ?? VRCOSCInputState.IDLE; const outputState = status.outputState ?? VRCOSCOutputState.IDLE; @@ -194,118 +127,146 @@ function StatusCard({ ? l10n.getString('settings-osc-vrchat-status-source-auto') : ''; - const lastInputElapsed = formatElapsedTime( - status.lastReceivedInputMillis, - now - ); - const lastFrameElapsed = formatElapsedTime(status.lastFrameSentMillis, now); + const lastInputElapsed = relativeTime(status.lastReceivedInputMillis); + const lastFrameElapsed = relativeTime(status.lastFrameSentMillis); return (
+ } + badge={ + + } > {inputState === VRCOSCInputState.IDLE ? ( - - {l10n.getString('settings-osc-vrchat-status-input-idle')} - + ) : ( <> - - {l10n.getString('settings-osc-vrchat-status-input-listening', { - port: `${status.inputPort ?? 0}`, - })} - + {inputState === VRCOSCInputState.ERROR && status.inputError ? ( - {asString(status.inputError)} + {status.inputError?.toString() ?? ''} ) : lastInputElapsed ? ( - - {l10n.getString('settings-osc-vrchat-status-input-last-data', { - elapsed: lastInputElapsed, - })} - + ) : ( - - {l10n.getString('settings-osc-vrchat-status-input-no-data')} - + )} )} + } + badge={} > {outputState === VRCOSCOutputState.IDLE ? ( - - {l10n.getString('settings-osc-vrchat-status-output-idle')} - + ) : ( <> - - {l10n.getString( + + : 'settings-osc-vrchat-status-output-target' + } + vars={{ + address: status.targetAddress?.toString() ?? '', + port: status.targetPort ?? 0, + source: sourceLabel, + }} + /> {outputState === VRCOSCOutputState.ERROR && status.outputError ? ( - {asString(status.outputError)} + {status.outputError?.toString() ?? ''} ) : lastFrameElapsed ? ( - - {l10n.getString( - 'settings-osc-vrchat-status-output-last-frame', - { elapsed: lastFrameElapsed } - )} - + ) : ( - - {l10n.getString('settings-osc-vrchat-status-output-no-frame')} - + )} )} + } + badge={} > {oscQueryState === VRCOSCOscQueryState.DISABLED ? ( - - {l10n.getString('settings-osc-vrchat-status-oscquery-disabled')} - + ) : oscQueryState === VRCOSCOscQueryState.ERROR ? ( - {asString(status.oscqueryError)} + {status.oscqueryError?.toString() ?? ''} ) : ( <> - - {l10n.getString( - 'settings-osc-vrchat-status-oscquery-advertising', - { port: `${status.oscqueryAdvertisedPort ?? 0}` } - )} - + {oscQueryState === VRCOSCOscQueryState.FOUND && status.discoveredTargets.length > 0 ? ( <> - - {l10n.getString( - 'settings-osc-vrchat-status-oscquery-discovered-title' - )} - +
    {status.discoveredTargets.map((target, index) => (
  • - {asString(target.name)} ({asString(target.address)}: - {target.portOut}) + {target.name?.toString() ?? ''} ( + {target.address?.toString() ?? ''}:{target.portOut}) {status.discoveredTargets.length > 1 && (