Merge branch 'bugfix_osc_query' into develop

locales/en.yml

@@ -24,6 +24,9 @@ common_error:
     invalid_value_speaker_phrase_timeout: "It cannot be set lower than '{{speaker_record_timeout_label}}' with a value of 0 or more."
     invalid_value_speaker_max_phrase: "You can set a number equal to or greater than 0."
 
+common_warning:
+    unable_to_use_osc_query: "The functions below have been automatically disabled because receiving OSC data is not possible due to OSC IP Address settings."
+
 main_page:
     translation: "Translation"
     transcription_send: "Voice2Chatbox"

locales/ja.yml

@@ -24,6 +24,9 @@ common_error:
     invalid_value_speaker_phrase_timeout: "0 以上で 「{{speaker_record_timeout_label}}」 より小さくすることはできません。"
     invalid_value_speaker_max_phrase: "0 以上の数値を設定できます。"
 
+common_warning:
+    unable_to_use_osc_query: "OSC IP Address の設定によりOSCデータの受信ができないため、以下の機能が自動的に無効になっています。"
+
 main_page:
     translation: "翻訳"
     transcription_send: "音声認識 マイク"

src-python/controller.py

@@ -1137,8 +1137,7 @@ class Controller:
     def getOscIpAddress(*args, **kwargs) -> dict:
         return {"status":200, "result":config.OSC_IP_ADDRESS}
 
-    @staticmethod
+    def setOscIpAddress(self, data, *args, **kwargs) -> dict:
-    def setOscIpAddress(data, *args, **kwargs) -> dict:
         if isValidIpAddress(data) is False:
             response = {
                 "status":400,
@@ -1151,6 +1150,11 @@ class Controller:
             try:
                 model.setOscIpAddress(data)
                 config.OSC_IP_ADDRESS = data
+                if model.getIsOscQueryEnabled() is True:
+                    self.enableOscQuery()
+                else:
+                    self.setDisableVrcMicMuteSync()
+                    self.disableOscQuery()
                 response = {"status":200, "result":config.OSC_IP_ADDRESS}
             except Exception:
                 model.setOscIpAddress(config.OSC_IP_ADDRESS)
@@ -1426,13 +1430,20 @@ class Controller:
 
     @staticmethod
     def setEnableVrcMicMuteSync(*args, **kwargs) -> dict:
-        if model.getIsOscQueryEnabled() is False:
+        if model.getIsOscQueryEnabled() is True:
             config.VRC_MIC_MUTE_SYNC = True
             model.setMuteSelfStatus()
             model.changeMicTranscriptStatus()
+            response = {"status":200, "result":config.VRC_MIC_MUTE_SYNC}
         else:
-            config.VRC_MIC_MUTE_SYNC = False
+            response = {
-        return {"status":200, "result":config.VRC_MIC_MUTE_SYNC}
+                    "status":400,
+                    "result":{
+                        "message":"Cannot enable VRC mic mute sync while OSC query is disabled",
+                        "data": config.VRC_MIC_MUTE_SYNC
+                    }
+            }
+        return response
 
     @staticmethod
     def setDisableVrcMicMuteSync(*args, **kwargs) -> dict:
@@ -1913,10 +1924,22 @@ class Controller:
         self.run(200, self.run_mapping["initialization_progress"], progress)
 
     def enableOscQuery(self):
-        self.run(200, self.run_mapping["enable_osc_query"], True)
+        self.run(
+            200,
+            self.run_mapping["enable_osc_query"],
+            {
+                "data": True,
+                "disabled_functions": []
+            }
+        )
 
     def disableOscQuery(self):
-        self.run(200, self.run_mapping["enable_osc_query"], False)
+        self.run(200, self.run_mapping["enable_osc_query"], {
+            "data": False,
+            "disabled_functions": [
+                "vrc_mic_mute_sync",
+            ]
+        })
 
     def init(self, *args, **kwargs) -> None:
         removeLog()
@@ -1999,6 +2022,8 @@ class Controller:
         if osc_query_enabled is True:
             self.enableOscQuery()
         else:
+            # OSC Query is disabled, so disable VRC some features
+            config.VRC_MIC_MUTE_SYNC = False
             self.disableOscQuery()
 
         if config.VRC_MIC_MUTE_SYNC is True:

src-ui/app/_index_css/variables.css

@@ -25,6 +25,7 @@
     --error_bc_active_color: #9c3938;
     --success_bc_color: #368777;
     --waring_color: #cb944f;
+    --waring_bc_color: #cf7b1b;
 
     --dark_basic_text_color: #f2f2f2;
     --dark_100_color: #f5f7fb;

src-ui/app/config_page/setting_section/setting_box/others/Others.jsx

@@ -101,11 +101,17 @@ export const VrcMicMuteSyncContainer = () => {
     const { t } = useTranslation();
     const { currentEnableVrcMicMuteSync, toggleEnableVrcMicMuteSync } = useEnableVrcMicMuteSync();
 
+    const variable = {
+        state: currentEnableVrcMicMuteSync.state,
+        data: currentEnableVrcMicMuteSync.data.is_enabled,
+    };
+
     return (
         <CheckboxContainer
             label={t("config_page.others.vrc_mic_mute_sync.label")}
             desc={t("config_page.others.vrc_mic_mute_sync.desc")}
-            variable={currentEnableVrcMicMuteSync}
+            variable={variable}
+            is_available={currentEnableVrcMicMuteSync.data.is_available}
             toggleFunction={toggleEnableVrcMicMuteSync}
         />
     );

src-ui/app/main_page/main_section/top_bar/right_side_components/RightSideComponents.jsx

@@ -77,7 +77,7 @@ const OpenVrcMicMuteSyncQuickSetting = () => {
     return (
         <OpenQuickSettingButton
             label={t("config_page.others.vrc_mic_mute_sync.label")}
-            variable={currentEnableVrcMicMuteSync.data}
+            variable={currentEnableVrcMicMuteSync.data.is_enabled}
             onClickFunction={onClickFunction}
         />
     );

src-ui/app/snackbar_controller/SnackbarController.jsx

@@ -14,6 +14,7 @@ export const SnackbarController = () => {
 
     const snackbar_classname = clsx(styles.snackbar_content, {
         [styles.is_success]: currentNotificationStatus.data.status === "success",
+        [styles.is_warning]: currentNotificationStatus.data.status === "warning",
         [styles.is_error]: currentNotificationStatus.data.status === "error",
     });
 

src-ui/app/snackbar_controller/SnackbarController.module.scss

@@ -6,6 +6,9 @@
     &.is_success {
         background-color: var(--success_bc_color);
     }
+    &.is_warning {
+        background-color: var(--waring_bc_color);
+    }
     &.is_error {
         background-color: var(--error_bc_color);
     }

src-ui/common_components/checkbox/Checkbox.jsx

@@ -3,15 +3,16 @@ import styles from "./Checkbox.module.scss";
 export const Checkbox = ({
     checkboxId,
     variable,
+    is_available = true,
     toggleFunction,
     size = "2.8rem",
-    color = "var(--primary_600_color)",
     borderWidth = "0.2rem",
     padding = "2rem",
 }) => {
 
     const wrapper_class_names = clsx(styles.checkbox_wrapper, {
-        [styles.is_disabled]: variable.state === "pending",
+        [styles.is_disabled]: !is_available,
+        [styles.is_pending]: variable.state === "pending",
     });
 
     return (
@@ -21,7 +22,6 @@ export const Checkbox = ({
                 htmlFor={checkboxId}
                 style={{
                     "--checkbox-size": size,
-                    "--checkbox-color": color,
                     "--checkbox-border-width": borderWidth,
                     "--checkbox-padding": padding,
                 }}

src-ui/common_components/checkbox/Checkbox.module.scss

@@ -18,12 +18,19 @@
             border: var(--checkbox-color, var(--primary_600_color)) solid var(--checkbox-border-width, 0.2rem);
         }
     }
-    &.is_disabled {
+    &.is_pending {
         pointer-events: none;
         & .cbx {
             border-color: var(--primary_800_color);
         }
     }
+    &.is_disabled {
+        pointer-events: none;
+        & .cbx {
+            filter: grayscale(100%);
+            border-color: var(--dark_800_color);
+        }
+    }
 }
 
 .checkbox_wrapper .cbx {

src-ui/logics/common/index.js

@@ -11,5 +11,6 @@ export { useMessage } from "./useMessage";
 export { useUpdateSoftware } from "./useUpdateSoftware";
 export { useVolume } from "./useVolume";
 export { useHandleNetworkConnection } from "./useHandleNetworkConnection";
+export { useHandleOscQuery } from "./useHandleOscQuery";
 export { useIsVrctAvailable } from "./useIsVrctAvailable";
 export { useFetch } from "./useFetch";

src-ui/logics/common/useHandleOscQuery.js

@@ -0,0 +1,44 @@
+import { useTranslation } from "react-i18next";
+import { useNotificationStatus } from "@logics_common";
+import {
+    useEnableVrcMicMuteSync,
+} from "@logics_configs";
+
+export const useHandleOscQuery = () => {
+    const { t } = useTranslation();
+
+    const { showNotification_Warning } = useNotificationStatus();
+    const { updateEnableVrcMicMuteSync } = useEnableVrcMicMuteSync();
+
+    const handleOscQuery = ({is_osc_query_enabled, disabled_functions}) => {
+        if (!is_osc_query_enabled && disabled_functions.length > 0) {
+            const BASE_LABEL = t("common_warning.unable_to_use_osc_query");
+            let items_label = "";
+
+            for (const disabled_function of disabled_functions) {
+                if (disabled_function === "vrc_mic_mute_sync") {
+                    updateEnableVrcMicMuteSync({
+                        is_enabled: false,
+                        is_available: false,
+                    });
+                    const item = `- ${t("config_page.others.vrc_mic_mute_sync.label")}`;
+                    items_label = `${items_label}\n${item}`;
+                }
+            }
+            const label = `${BASE_LABEL}${items_label}`;
+            showNotification_Warning(
+                label,
+                { hide_duration: 10000, }
+            );
+        } else if (is_osc_query_enabled) {
+            updateEnableVrcMicMuteSync((old_value) => ({
+                ...old_value.data,
+                is_available: true,
+            }));
+        }
+    };
+
+    return {
+        handleOscQuery,
+    };
+};

src-ui/logics/common/useNotificationStatus.js

@@ -5,6 +5,16 @@ export const useNotificationStatus = () => {
 
     const generateRandomKey = () => Math.random();
 
+    const showNotification_Warning = (message, options = {}) => {
+        updateNotificationStatus({
+            status: "warning",
+            is_open: true,
+            key: generateRandomKey(),
+            message: message,
+            options: options,
+        });
+    };
+
     const showNotification_Error = (message, options = {}) => {
         updateNotificationStatus({
             status: "error",
@@ -37,6 +47,7 @@ export const useNotificationStatus = () => {
         currentNotificationStatus,
         updateNotificationStatus,
 
+        showNotification_Warning,
         showNotification_Error,
         showNotification_Success,
         closeNotification,

src-ui/logics/configs/others/useEnableVrcMicMuteSync.js

@@ -12,7 +12,7 @@ export const useEnableVrcMicMuteSync = () => {
 
     const toggleEnableVrcMicMuteSync = () => {
         pendingEnableVrcMicMuteSync();
-        if (currentEnableVrcMicMuteSync.data) {
+        if (currentEnableVrcMicMuteSync.data.is_enabled) {
             asyncStdoutToPython("/set/disable/vrc_mic_mute_sync");
         } else {
             asyncStdoutToPython("/set/enable/vrc_mic_mute_sync");

src-ui/logics/useReceiveRoutes.js

@@ -7,6 +7,7 @@ import {
     useIsVrctAvailable,
     useNotificationStatus,
     useHandleNetworkConnection,
+    useHandleOscQuery,
 
     useSoftwareVersion,
     useComputeMode,
@@ -83,6 +84,7 @@ export const useReceiveRoutes = () => {
     const { updateComputeMode } = useComputeMode();
     const { updateInitProgress } = useInitProgress();
     const { updateIsBackendReady } = useIsBackendReady();
+    const { handleOscQuery } = useHandleOscQuery();
     const { restoreWindowGeometry } = useWindow();
     const { updateIsMainPageCompactMode } = useIsMainPageCompactMode();
     const {
@@ -219,6 +221,12 @@ export const useReceiveRoutes = () => {
             }));
         },
         "/run/connected_network": handleNetworkConnection,
+        "/run/enable_osc_query": ({data, disabled_functions}) => {
+            handleOscQuery({
+                is_osc_query_enabled: data,
+                disabled_functions: disabled_functions,
+            });
+        },
 
         // Main Page
         // Page Controls
@@ -480,9 +488,15 @@ export const useReceiveRoutes = () => {
         "/set/enable/logger_feature": updateEnableAutoExportMessageLogs,
         "/set/disable/logger_feature": updateEnableAutoExportMessageLogs,
 
-        "/get/data/vrc_mic_mute_sync": updateEnableVrcMicMuteSync,
+        "/get/data/vrc_mic_mute_sync": (payload) => updateEnableVrcMicMuteSync((old_value) => {
-        "/set/enable/vrc_mic_mute_sync": updateEnableVrcMicMuteSync,
+            return {...old_value.data, is_enabled: payload};
-        "/set/disable/vrc_mic_mute_sync": updateEnableVrcMicMuteSync,
+        }),
+        "/set/enable/vrc_mic_mute_sync": (payload) => updateEnableVrcMicMuteSync((old_value) => {
+            return {...old_value.data, is_enabled: payload};
+        }),
+        "/set/disable/vrc_mic_mute_sync": (payload) => updateEnableVrcMicMuteSync((old_value) => {
+            return {...old_value.data, is_enabled: payload};
+        }),
 
         "/get/data/send_message_to_vrc": updateEnableSendMessageToVrc,
         "/set/enable/send_message_to_vrc": updateEnableSendMessageToVrc,

src-ui/store.js

@@ -60,10 +60,19 @@ export const createAtomWithHook = (initialValue, base_name, options) => {
         };
 
         const updateAtom = (payload, options = {}) => {
-            const { remain_state = false, set_state } = options;
+            const { remain_state = false, set_state, lock_state } = options;
 
             setAtom((currentValue) => {
-                const new_state = set_state ?? (remain_state ? currentValue.state : "ok");
+                let new_state;
+                if (lock_state) {
+                    new_state = set_state;
+                } else {
+                    if (currentValue.lock_state) {
+                        new_state = currentValue.state;
+                    } else {
+                        new_state = set_state ?? (remain_state ? currentValue.state : "ok");
+                    }
+                }
 
                 const updated_data = typeof payload === "function"
                     ? payload(currentValue)