frontengine 1.0.46__tar.gz → 1.0.47__tar.gz

{frontengine-1.0.46 → frontengine-1.0.47}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frontengine
-Version: 1.0.46
+Version: 1.0.47
 Summary: FrontEngine is use-define frontview or only use like screen saver
 Author-email: JE-Chen <jechenmailman@gmail.com>
 Project-URL: Homepage, https://github.com/Intergration-Automation-Testing/FrontEngine
@@ -143,6 +143,14 @@ Measuring and capture tools on the **Tools** tab:
   `hsl(...)` or a CSS custom property.
 - **Region capture** — drag out an area; it lands on the clipboard and can be
   saved to a file.
+- **Virtual camera** — drag out an area and send it, overlays and all, as a
+  webcam that Zoom, Teams or Discord can pick as their video source. Needs the
+  optional `pyvirtualcam` package and a virtual camera driver on the system
+  (OBS installs one); without either, the button says so rather than failing
+  quietly.
+- **Camera** — any video input works, including capture cards, and the device
+  list can be refreshed without restarting since cards are usually plugged in
+  while the app is already running.
 - **Read text** — drag out an area to copy the text in it, translate it, or ask
   a question about it.
   > This is the **only** feature here that sends screen content off the
@@ -196,6 +204,27 @@ Four things on the **Stream** tab, for playing and for going live:
 
 ---
 
+## Remote control
+
+From **Settings → Remote control**:
+
+- **Your phone** — turn it on and FrontEngine serves a small page on your local
+  network; open the link on a phone and the buttons drive the same actions the
+  global hotkeys do.
+  > This opens a port on your machine, so it is **off by default**. The link
+  > carries a token that is regenerated every time the server starts, so an old
+  > link stops working, and the page can only ask for the fixed action list —
+  > nothing else is reachable. It is plain HTTP: someone else on the same
+  > network could read the token and press the same buttons, which is a
+  > nuisance rather than a breach given what the buttons do, but leave it off
+  > on networks you do not trust.
+- **A MIDI controller** — press *Learn*, move a knob or pad, and bind it to an
+  action. It uses Windows' built-in winmm, so no extra package is needed. A
+  knob fires once it reaches the top rather than repeatedly on the way, and
+  releasing a pad does not count as a second press.
+
+---
+
 ## Screen-sharing privacy
 
 Your overlays are for you, not for the people you are sharing with. From

{frontengine-1.0.46 → frontengine-1.0.47}/README.md

@@ -119,6 +119,14 @@ Measuring and capture tools on the **Tools** tab:
   `hsl(...)` or a CSS custom property.
 - **Region capture** — drag out an area; it lands on the clipboard and can be
   saved to a file.
+- **Virtual camera** — drag out an area and send it, overlays and all, as a
+  webcam that Zoom, Teams or Discord can pick as their video source. Needs the
+  optional `pyvirtualcam` package and a virtual camera driver on the system
+  (OBS installs one); without either, the button says so rather than failing
+  quietly.
+- **Camera** — any video input works, including capture cards, and the device
+  list can be refreshed without restarting since cards are usually plugged in
+  while the app is already running.
 - **Read text** — drag out an area to copy the text in it, translate it, or ask
   a question about it.
   > This is the **only** feature here that sends screen content off the
@@ -172,6 +180,27 @@ Four things on the **Stream** tab, for playing and for going live:
 
 ---
 
+## Remote control
+
+From **Settings → Remote control**:
+
+- **Your phone** — turn it on and FrontEngine serves a small page on your local
+  network; open the link on a phone and the buttons drive the same actions the
+  global hotkeys do.
+  > This opens a port on your machine, so it is **off by default**. The link
+  > carries a token that is regenerated every time the server starts, so an old
+  > link stops working, and the page can only ask for the fixed action list —
+  > nothing else is reachable. It is plain HTTP: someone else on the same
+  > network could read the token and press the same buttons, which is a
+  > nuisance rather than a breach given what the buttons do, but leave it off
+  > on networks you do not trust.
+- **A MIDI controller** — press *Learn*, move a knob or pad, and bind it to an
+  action. It uses Windows' built-in winmm, so no extra package is needed. A
+  knob fires once it reaches the top rather than repeatedly on the way, and
+  releasing a pad does not count as a second press.
+
+---
+
 ## Screen-sharing privacy
 
 Your overlays are for you, not for the people you are sharing with. From

frontengine-1.0.47/frontengine/ui/dialog/remote_control_dialog.py

@@ -0,0 +1,207 @@
+"""
+遙控設定：手機網頁遙控與 MIDI 控制器。
+
+手機遙控會在這台機器上開一個網路埠，所以預設關閉、每次啟動換新權杖、
+只接受固定的動作清單——這些在畫面上都寫清楚，不藏在文件裡。
+
+Remote control settings: the phone web remote and a MIDI controller.
+
+The phone remote opens a network port on this machine, so it is off by default,
+mints a fresh token at every start and only accepts a fixed list of actions -
+all of which the dialog says out loud rather than hiding in the docs.
+"""
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+from PySide6.QtGui import QGuiApplication
+from PySide6.QtWidgets import (
+    QAbstractItemView, QCheckBox, QComboBox, QDialog, QDialogButtonBox, QGridLayout, QLabel,
+    QPushButton, QTableWidget, QTableWidgetItem, QWidget,
+)
+
+from frontengine.user_setting.user_setting_file import user_setting_dict, write_user_setting
+from frontengine.utils.logging.loggin_instance import front_engine_logger
+from frontengine.utils.midi.midi_input import available as midi_available, list_devices
+from frontengine.utils.multi_language.language_wrapper import language_wrapper
+from frontengine.utils.remote.remote_server import ALLOWED_ACTIONS
+
+MIDI_KEY = "midi_bindings"
+REMOTE_KEY = "phone_remote"
+
+
+def _t(key: str, fallback: str) -> str:
+    return language_wrapper.language_word_dict.get(key, fallback)
+
+
+def current_bindings() -> Dict[str, str]:
+    """設定裡的 {MIDI 鍵: 動作}，只留允許清單裡的動作。"""
+    stored = user_setting_dict.get(MIDI_KEY)
+    if not isinstance(stored, dict):
+        return {}
+    return {str(key): str(value) for key, value in stored.items()
+            if str(value) in ALLOWED_ACTIONS}
+
+
+def remote_enabled() -> bool:
+    settings = user_setting_dict.get(REMOTE_KEY)
+    return bool(settings.get("enabled")) if isinstance(settings, dict) else False
+
+
+class RemoteControlDialog(QDialog):
+    """設定手機遙控與 MIDI 綁定。"""
+
+    def __init__(self, parent: Optional[QWidget] = None, remote=None, midi=None) -> None:
+        front_engine_logger.info("[RemoteControlDialog] Init")
+        super().__init__(parent)
+        self.setWindowTitle(_t("remote_title", "Remote control"))
+        self._remote = remote
+        self._midi = midi
+        self._learning = False
+
+        self.remote_checkbox = QCheckBox(_t("remote_enable", "Let my phone control FrontEngine"))
+        self.remote_checkbox.setChecked(remote_enabled())
+        self.remote_checkbox.toggled.connect(self._toggle_remote)
+        self.remote_url_label = QLabel(self.remote_status())
+        self.remote_url_label.setWordWrap(True)
+        self.remote_url_label.setTextInteractionFlags(
+            self.remote_url_label.textInteractionFlags().TextSelectableByMouse)
+        self.remote_copy_button = QPushButton(_t("remote_copy", "Copy link"))
+        self.remote_copy_button.clicked.connect(self.copy_link)
+        self.remote_hint = QLabel(
+            _t("remote_hint",
+               "This opens a port on this machine for your local network. The link carries a "
+               "one-time token that changes every time it starts, and only the buttons on the "
+               "page can be triggered - nothing else. It is plain HTTP, so treat it like any "
+               "other device on your network: someone else on the same network could read the "
+               "token and press the same buttons. Leave it off on networks you do not trust."))
+        self.remote_hint.setWordWrap(True)
+
+        self.midi_label = QLabel(_t("remote_midi_label", "MIDI controller"))
+        self.midi_combobox = QComboBox()
+        for index, name in list_devices():
+            self.midi_combobox.addItem(name, index)
+        if self.midi_combobox.count() == 0:
+            self.midi_combobox.addItem(_t("remote_midi_none", "No MIDI device found"), -1)
+        self.learn_button = QPushButton(_t("remote_midi_learn", "Learn"))
+        self.learn_button.clicked.connect(self.start_learning)
+        self.learn_button.setEnabled(midi_available())
+        self.remove_button = QPushButton(_t("remote_midi_remove", "Remove"))
+        self.remove_button.clicked.connect(self.remove_selected)
+
+        self.table = QTableWidget(0, 2)
+        self.table.setHorizontalHeaderLabels([
+            _t("remote_midi_control_column", "Control"),
+            _t("remote_midi_action_column", "Action"),
+        ])
+        self.table.setSelectionBehavior(QAbstractItemView.SelectionBehavior.SelectRows)
+        self.table.horizontalHeader().setStretchLastSection(True)
+
+        self.button_box = QDialogButtonBox(
+            QDialogButtonBox.StandardButton.Ok | QDialogButtonBox.StandardButton.Cancel)
+        self.button_box.accepted.connect(self.accept)
+        self.button_box.rejected.connect(self.reject)
+
+        layout = QGridLayout(self)
+        layout.addWidget(self.remote_checkbox, 0, 0, 1, 3)
+        layout.addWidget(self.remote_url_label, 1, 0, 1, 2)
+        layout.addWidget(self.remote_copy_button, 1, 2)
+        layout.addWidget(self.remote_hint, 2, 0, 1, 3)
+        layout.addWidget(self.midi_label, 3, 0)
+        layout.addWidget(self.midi_combobox, 3, 1, 1, 2)
+        layout.addWidget(self.table, 4, 0, 1, 3)
+        layout.addWidget(self.learn_button, 5, 0)
+        layout.addWidget(self.remove_button, 5, 1)
+        layout.addWidget(self.button_box, 6, 0, 1, 3)
+
+        for control, action in current_bindings().items():
+            self.add_row(control, action)
+
+    # --- phone remote ----------------------------------------------------
+    def remote_status(self) -> str:
+        """目前該在手機上開什麼；沒開啟就說明它是關著的。"""
+        if self._remote is None or not getattr(self._remote, "running", False):
+            return _t("remote_off", "Off - nothing is listening.")
+        return self._remote.url()
+
+    def copy_link(self) -> bool:
+        """把連結複製起來，方便貼到手機上。"""
+        if self._remote is None or not getattr(self._remote, "running", False):
+            return False
+        clipboard = QGuiApplication.clipboard()
+        if clipboard is None:  # pragma: no cover - no clipboard at all
+            return False
+        clipboard.setText(self._remote.url())
+        return True
+
+    def _toggle_remote(self, enabled: bool) -> None:
+        user_setting_dict[REMOTE_KEY] = {"enabled": bool(enabled)}
+        write_user_setting()
+        if self._remote is None:
+            return
+        if enabled:
+            self._remote.start()
+        else:
+            self._remote.stop()
+        self.remote_url_label.setText(self.remote_status())
+
+    # --- MIDI bindings ---------------------------------------------------
+    def add_row(self, control: str = "", action: str = "") -> None:
+        """加一列綁定。"""
+        row = self.table.rowCount()
+        self.table.insertRow(row)
+        self.table.setItem(row, 0, QTableWidgetItem(str(control)))
+        combobox = QComboBox()
+        combobox.addItems(list(ALLOWED_ACTIONS))
+        if action in ALLOWED_ACTIONS:
+            combobox.setCurrentText(action)
+        self.table.setCellWidget(row, 1, combobox)
+
+    def start_learning(self) -> None:
+        """按下之後，下一個收到的 MIDI 訊息就會變成新的一列。"""
+        self._learning = True
+        self.learn_button.setText(_t("remote_midi_listening", "Press a control..."))
+
+    @property
+    def learning(self) -> bool:
+        return self._learning
+
+    def learn(self, control: str) -> bool:
+        """收到 MIDI 訊息時由主視窗呼叫；沒在學習狀態就忽略。"""
+        if not self._learning:
+            return False
+        self._learning = False
+        self.learn_button.setText(_t("remote_midi_learn", "Learn"))
+        self.add_row(control, ALLOWED_ACTIONS[0])
+        return True
+
+    def remove_selected(self) -> bool:
+        row = self.table.currentRow()
+        if row < 0:
+            return False
+        self.table.removeRow(row)
+        return True
+
+    def bindings(self) -> Dict[str, str]:
+        """目前表格上的綁定。"""
+        bindings: Dict[str, str] = {}
+        for row in range(self.table.rowCount()):
+            item = self.table.item(row, 0)
+            combobox = self.table.cellWidget(row, 1)
+            control = item.text().strip() if item else ""
+            action = combobox.currentText() if combobox else ""
+            if control and action in ALLOWED_ACTIONS:
+                bindings[control] = action
+        return bindings
+
+    def midi_device(self) -> Any:
+        """選到的 MIDI 裝置索引。"""
+        return self.midi_combobox.currentData()
+
+    def accept(self) -> None:
+        bindings = self.bindings()
+        user_setting_dict[MIDI_KEY] = bindings
+        user_setting_dict["midi_device"] = self.midi_device()
+        write_user_setting()
+        front_engine_logger.info(f"[RemoteControlDialog] saved | {len(bindings)} binding(s)")
+        super().accept()

{frontengine-1.0.46 → frontengine-1.0.47}/frontengine/ui/main_ui.py

@@ -49,7 +49,12 @@ from frontengine.utils.logging.loggin_instance import front_engine_logger
 from frontengine.utils.multi_language.language_wrapper import language_wrapper
 from frontengine.utils.plugins.plugin_loader import load_plugins
 from frontengine.utils.preset_schedule.preset_schedule_service import PresetScheduleService
+from frontengine.ui.dialog.remote_control_dialog import (
+    MIDI_KEY, current_bindings, remote_enabled,
+)
 from frontengine.ui.dialog.screen_privacy_dialog import current_settings as current_privacy_settings
+from frontengine.utils.midi.midi_input import MidiInput, binding_key
+from frontengine.utils.remote.remote_server import RemoteServer
 from frontengine.ui.dialog.smart_pause_dialog import current_rules
 from frontengine.utils.screen_privacy.share_watch import ShareWatchService
 from frontengine.utils.app_profile.app_profile_service import AppProfileService
@@ -211,6 +216,25 @@ class FrontEngineMainUI(QMainWindow):
         )
         self.app_profile_service.start()
 
+        # 手機遙控與 MIDI：兩者都只呼叫既有的快速鍵動作，做不到別的事
+        # The phone remote and MIDI both call the existing hotkey actions and
+        # can do nothing beyond them.
+        # 兩者的訊息都來自別的執行緒（HTTP 伺服器、winmm），所以明確用
+        # QueuedConnection 接回 UI 執行緒——和全域快速鍵同樣的理由。
+        # Both deliver from another thread (the HTTP server, winmm), so an
+        # explicit QueuedConnection brings them back to the UI thread - the same
+        # reason the global hotkeys use one.
+        self.remote_server = RemoteServer()
+        self.remote_server.action_requested.connect(
+            self._handle_hotkey, Qt.ConnectionType.QueuedConnection)
+        if remote_enabled():
+            self.remote_server.start()
+        self.midi_input = MidiInput()
+        self.midi_input.message_received.connect(
+            self._on_midi_message, Qt.ConnectionType.QueuedConnection)
+        if user_setting_dict.get(MIDI_KEY):
+            self.midi_input.start(user_setting_dict.get("midi_device") or 0)
+
         # 分享畫面時把覆蓋層藏出擷取結果（自己仍看得到）
         # Hide the overlays from the capture while sharing; they stay on screen here.
         self.share_watch_service = ShareWatchService(config_provider=current_privacy_settings)
@@ -468,6 +492,22 @@ class FrontEngineMainUI(QMainWindow):
             self.control_center_ui.show_all()
             self._smart_pause_hid = False
 
+    def _on_midi_message(self, message: dict) -> None:
+        """
+        處理一則 MIDI 訊息（已經由 QueuedConnection 帶回 UI 執行緒）。
+        旋鈕轉到底才算一次按下，避免轉動途中連續觸發。
+        Handle one MIDI message, already brought back to the UI thread by the
+        queued connection. A knob only counts once it reaches the top, so
+        turning it does not fire repeatedly on the way.
+        """
+        if message.get("kind") == "note" and not message.get("pressed"):
+            return
+        if message.get("kind") == "control" and int(message.get("value", 0)) < 127:
+            return
+        action = current_bindings().get(binding_key(message))
+        if action:
+            self._handle_hotkey(action)
+
     def _on_sharing_changed(self, sharing: bool, match: str) -> None:
         """
         偵測到會議程式開著／關掉時，自動把覆蓋層藏出擷取結果或放回去。
@@ -529,51 +569,69 @@ class FrontEngineMainUI(QMainWindow):
         if getattr(self, "reminder_service", None) is not None:
             self.reminder_service.tracker.reset()
 
+    # 關閉時要停掉的背景服務，依相依性由外而內排列
+    # The background services to stop on close, outermost first.
+    _CLOSING_SERVICES = (
+        "preset_schedule_service", "theme_schedule_service", "usage_service",
+        "remote_server", "midi_input", "share_watch_service", "reminder_service",
+        "app_profile_service", "smart_pause_service", "hotkey_service",
+    )
+    # 關閉時要清空的覆蓋層清單
+    # The overlay lists to empty on close.
+    _CLOSING_WIDGET_LISTS = (
+        ("video_setting_ui", "video_widget_list"),
+        ("image_setting_ui", "image_widget_list"),
+        ("web_setting_ui", "web_widget_list"),
+        ("gif_setting_ui", "gif_widget_list"),
+        ("sound_player_setting_ui", "sound_widget_list"),
+        ("text_setting_ui", "text_widget_list"),
+        ("particle_setting_ui", "particle_list"),
+        ("pet_setting_ui", "pet_list"),
+    )
+
     def close(self) -> None:
         """關閉程式並清理資源 / Close application and clear resources"""
         if user_setting_dict.get("restore_last_session"):
             save_last_session(self)
-        if getattr(self, "preset_schedule_service", None) is not None:
-            self.preset_schedule_service.stop()
-        if getattr(self, "theme_schedule_service", None) is not None:
-            self.theme_schedule_service.stop()
-        if getattr(self, "usage_service", None) is not None:
-            self.usage_service.stop()
+        self._stop_services()
+        self._save_page_state()
+        self._save_window_geometry()
+        write_user_setting()
+        self._clear_overlays()
+        self.scene_setting_ui.close_scene()
+        super().close()
+        if self.main_app:
+            self.main_app.exit(0)
+
+    def _stop_services(self) -> None:
+        """停掉所有背景服務（沒建立起來的就跳過）。"""
+        for name in self._CLOSING_SERVICES:
+            service = getattr(self, name, None)
+            if service is not None:
+                service.stop()
         if getattr(self, "clipboard_watcher", None) is not None:
             self.clipboard_watcher.stop()
             self._persist_clipboard()
+
+    def _save_page_state(self) -> None:
+        """讓幾個分頁在關閉前把自己的東西收好。"""
         if getattr(self, "widgets_setting_ui", None) is not None:
             self.widgets_setting_ui.save_notes()
             self.widgets_setting_ui.stop_spectrum()
         if getattr(self, "tools_setting_ui", None) is not None:
             self.tools_setting_ui.release_pinned_windows()
             self.tools_setting_ui.stop_camera()
+            self.tools_setting_ui.stop_virtual_camera()
         if getattr(self, "stream_setting_ui", None) is not None:
             self.stream_setting_ui.soundboard.stop_all()
-        if getattr(self, "share_watch_service", None) is not None:
-            self.share_watch_service.stop()
-        if getattr(self, "reminder_service", None) is not None:
-            self.reminder_service.stop()
-        if getattr(self, "app_profile_service", None) is not None:
-            self.app_profile_service.stop()
-        if getattr(self, "smart_pause_service", None) is not None:
-            self.smart_pause_service.stop()
-        if getattr(self, "hotkey_service", None) is not None:
-            self.hotkey_service.stop()
-        self._save_window_geometry()
-        write_user_setting()
-        self.video_setting_ui.video_widget_list.clear()
-        self.image_setting_ui.image_widget_list.clear()
-        self.web_setting_ui.web_widget_list.clear()
-        self.gif_setting_ui.gif_widget_list.clear()
-        self.sound_player_setting_ui.sound_widget_list.clear()
-        self.text_setting_ui.text_widget_list.clear()
-        self.particle_setting_ui.particle_list.clear()
-        self.pet_setting_ui.pet_list.clear()
-        self.scene_setting_ui.close_scene()
-        super().close()
-        if self.main_app:
-            self.main_app.exit(0)
+
+    def _clear_overlays(self) -> None:
+        """清空各分頁記著的覆蓋層清單。"""
+        for page_name, attribute in self._CLOSING_WIDGET_LISTS:
+            page = getattr(self, page_name, None)
+            widget_list = getattr(page, attribute, None) if page is not None else None
+            if widget_list is not None:
+                widget_list.clear()
 
     @classmethod
     def debug_close(cls) -> None:

{frontengine-1.0.46 → frontengine-1.0.47}/frontengine/ui/menu/settings_menu.py

@@ -10,6 +10,7 @@ from frontengine.ui.dialog.app_profile_dialog import AppProfileDialog
 from frontengine.ui.dialog.clipboard_dialog import ClipboardDialog
 from frontengine.ui.dialog.hotkey_settings_dialog import HotkeySettingsDialog
 from frontengine.ui.dialog.reminder_dialog import ReminderDialog
+from frontengine.ui.dialog.remote_control_dialog import RemoteControlDialog
 from frontengine.ui.dialog.screen_privacy_dialog import ScreenPrivacyDialog
 from frontengine.ui.dialog.smart_pause_dialog import SmartPauseDialog
 from frontengine.ui.dialog.usage_report_dialog import UsageReportDialog
@@ -88,6 +89,11 @@ def build_settings_menu(ui: "FrontEngineMainUI") -> None:
     menu.addAction(reminder_action)
     ui.reminder_action = reminder_action
 
+    remote_action = QAction(_t("settings_menu_remote", "Remote control..."), menu)
+    remote_action.triggered.connect(lambda: _open_remote_dialog(ui))
+    menu.addAction(remote_action)
+    ui.remote_action = remote_action
+
     privacy_action = QAction(
         _t("settings_menu_screen_privacy", "Screen-sharing privacy..."), menu)
     privacy_action.triggered.connect(lambda: _open_dialog(ui, ScreenPrivacyDialog))
@@ -121,6 +127,16 @@ def build_settings_menu(ui: "FrontEngineMainUI") -> None:
     menu.addAction(import_action)
 
 
+def _open_remote_dialog(ui: "FrontEngineMainUI") -> None:
+    """開遙控設定，並把它接上 MIDI 的「學習」流程。"""
+    front_engine_logger.info("[SettingsMenu] open RemoteControlDialog")
+    dialog = RemoteControlDialog(ui, remote=getattr(ui, "remote_server", None),
+                                 midi=getattr(ui, "midi_input", None))
+    ui.remote_dialog = dialog
+    dialog.exec()
+    ui.remote_dialog = None
+
+
 def _open_usage_dialog(ui: "FrontEngineMainUI") -> None:
     """開使用時間報告；開關與清除都由對話框直接作用在主視窗的服務上。"""
     front_engine_logger.info("[SettingsMenu] open UsageReportDialog")