Free Motion Capture for Everyone πβ¨
TypeScript
User Settable Freemocap_data Path (#562)
philipqueenff7c0134aba0
diff --git a/.gitignore b/.gitignoreindex cfe4f27b..e0d25e3e 100644--- a/.gitignore+++ b/.gitignore@@ -154,3 +154,4 @@ data/desktop.ininode_modules/+freemocap/system/gui_state.jsondiff --git a/freemocap/gui/qt/actions_and_menus/actions.py b/freemocap/gui/qt/actions_and_menus/actions.pyindex 0dac83f0..968fec87 100644--- a/freemocap/gui/qt/actions_and_menus/actions.py+++ b/freemocap/gui/qt/actions_and_menus/actions.py@@ -12,6 +12,7 @@ LOAD_RECORDING_ACTION_NAME = "Load Recording"IMPORT_VIDEOS_ACTION_NAME = "Import Videos"DOWNLOAD_SAMPLE_DATA_ACTION_NAME = "Download Sample Data (3 cameras, ~1000 frames)"DOWNLOAD_TEST_DATA_ACTION_NAME = "Download Test Data (3 cameras, ~200 frames)"+SET_DATA_FOLDER_ACTION_NAME = "Set Freemocap Data Folder Location"RESET_TO_DEFAULTS_ACTION_NAME = "Reset to Default GUI Settings"KILL_THREADS_AND_PROCESSES_ACTION_NAME = "Kill Threads and Processes"REBOOT_GUI_ACTION_NAME = "Reboot GUI"@@ -56,6 +57,10 @@ class Actions:lambda: freemocap_main_window.download_data(download_url=FIGSHARE_TEST_ZIP_FILE_URL))+ self.set_data_folder_action = QAction(SET_DATA_FOLDER_ACTION_NAME, parent=freemocap_main_window)+ self.set_data_folder_action.setShortcut("Ctrl+S")+ self.set_data_folder_action.triggered.connect(freemocap_main_window.open_settings_dialog)+self.reset_to_defaults_action = QAction(RESET_TO_DEFAULTS_ACTION_NAME, parent=freemocap_main_window)self.reset_to_defaults_action.triggered.connect(freemocap_main_window.reset_to_default_gui_settings)diff --git a/freemocap/gui/qt/actions_and_menus/menu_bar.py b/freemocap/gui/qt/actions_and_menus/menu_bar.pyindex 00c51c72..dd84fd59 100644--- a/freemocap/gui/qt/actions_and_menus/menu_bar.py+++ b/freemocap/gui/qt/actions_and_menus/menu_bar.py@@ -21,6 +21,7 @@ class MenuBar(QMenuBar):file_menu.addAction(actions.load_most_recent_recording_action)file_menu.addAction(actions.load_existing_recording_action)file_menu.addAction(actions.import_videos_action)+ file_menu.addAction(actions.set_data_folder_action)file_menu.addAction(actions.reset_to_defaults_action)file_menu.addAction(actions.exit_action)diff --git a/freemocap/gui/qt/main_window/freemocap_main_window.py b/freemocap/gui/qt/main_window/freemocap_main_window.pyindex f403b948..3a3d10d6 100644--- a/freemocap/gui/qt/main_window/freemocap_main_window.py+++ b/freemocap/gui/qt/main_window/freemocap_main_window.py@@ -21,9 +21,7 @@ from skellycam import ()from tqdm import tqdm-from freemocap.core_processes.export_data.blender_stuff.get_best_guess_of_blender_path import (- get_best_guess_of_blender_path,-)+from freemocap.data_layer.generate_jupyter_notebook.generate_jupyter_notebook import (generate_jupyter_notebook,)@@ -43,6 +41,7 @@ from freemocap.gui.qt.utilities.get_qt_app import get_qt_appfrom freemocap.gui.qt.utilities.save_and_load_gui_state import (GuiState,load_gui_state,+ save_gui_state,)from freemocap.gui.qt.utilities.update_most_recent_recording_toml import (update_most_recent_recording_toml,@@ -64,6 +63,7 @@ from freemocap.gui.qt.widgets.home_widget import (from freemocap.gui.qt.widgets.import_videos_wizard import ImportVideosWizardfrom freemocap.gui.qt.widgets.log_view_widget import LogViewWidgetfrom freemocap.gui.qt.widgets.opencv_conflict_dialog import OpencvConflictDialog+from freemocap.gui.qt.widgets.set_data_folder_dialog import SetDataFolderDialogfrom freemocap.gui.qt.widgets.welcome_screen_dialog import WelcomeScreenDialogfrom freemocap.gui.qt.workers.download_sample_data_thread_worker import DownloadDataThreadWorkerfrom freemocap.gui.qt.workers.export_to_blender_thread_worker import ExportToBlenderThreadWorker@@ -257,7 +257,7 @@ class MainWindow(QMainWindow):def _create_directory_view_widget(self):return DirectoryViewWidget(- top_level_folder_path=self._freemocap_data_folder_path,+ gui_state=self._gui_state,get_active_recording_info_callable=self._active_recording_info_widget.get_active_recording_info,)@@ -275,9 +275,7 @@ class MainWindow(QMainWindow):self._handle_processing_finished_signal)- self._visualization_control_panel = VisualizationControlPanel(- parent=self, blender_executable_path=get_best_guess_of_blender_path()- )+ self._visualization_control_panel = VisualizationControlPanel(parent=self, gui_state=self._gui_state)self._visualization_control_panel.export_to_blender_button.clicked.connect(self._export_active_recording_to_blender)@@ -433,6 +431,12 @@ class MainWindow(QMainWindow):self._process_motion_capture_data_panel._calibration_control_panel._charuco_square_size_line_edit.setText(str(self._gui_state.charuco_square_size))+ self._visualization_control_panel._blender_executable_label.setText(str(self._gui_state.blender_path))+ self._visualization_control_panel._blender_executable_path = str(self._gui_state.blender_path)++ save_gui_state(self._gui_state, get_gui_state_json_path())++ self._active_recording_info_widget.set_active_recording(recording_folder_path=get_most_recent_recording_path())def open_import_videos_dialog(self):# from this tutorial - https://www.youtube.com/watch?v=gg5TepTc2Jg&t=649s@@ -472,6 +476,16 @@ class MainWindow(QMainWindow):self._opencv_conflict_dialog.exec()+ def open_settings_dialog(self):+ self._settings_dialog = SetDataFolderDialog(+ gui_state=self._gui_state, kill_thread_event=self._kill_thread_event, parent=self+ )++ self._settings_dialog.exec()++ if self._settings_dialog.result():+ self.reboot_gui()+def download_data(self, download_url: str):logger.info("Downloading sample data")self.download_data_thread_worker = DownloadDataThreadWorker(dowload_url=download_url)diff --git a/freemocap/gui/qt/utilities/save_and_load_gui_state.py b/freemocap/gui/qt/utilities/save_and_load_gui_state.pyindex 13a05a34..a47d62c3 100644--- a/freemocap/gui/qt/utilities/save_and_load_gui_state.py+++ b/freemocap/gui/qt/utilities/save_and_load_gui_state.py@@ -1,7 +1,12 @@import json-+from pathlib import Pathfrom pydantic import BaseModel+from freemocap.core_processes.export_data.blender_stuff.get_best_guess_of_blender_path import (+ get_best_guess_of_blender_path,+)+from freemocap.system.paths_and_filenames.file_and_folder_names import BASE_FREEMOCAP_DATA_FOLDER_NAME+class GuiState(BaseModel):send_user_pings: bool = True@@ -11,14 +16,16 @@ class GuiState(BaseModel):auto_open_in_blender: bool = Truecharuco_square_size: float = 39annotate_charuco_images: bool = False+ freemocap_data_folder_path: str = str(Path(Path.home(), BASE_FREEMOCAP_DATA_FOLDER_NAME))+ blender_path: str = str(get_best_guess_of_blender_path())-def save_gui_state(gui_state: GuiState, file_pathstring: str = None):+def save_gui_state(gui_state: GuiState, file_pathstring: str) -> None:with open(file_pathstring, "w") as file:json.dump(gui_state.dict(), file, indent=4)-def load_gui_state(file_pathstring: str = None) -> GuiState:+def load_gui_state(file_pathstring: str) -> GuiState:with open(file_pathstring, "r") as file:gui_state = GuiState(**json.load(file))return gui_statediff --git a/freemocap/gui/qt/widgets/active_recording_widget.py b/freemocap/gui/qt/widgets/active_recording_widget.pyindex d6c18aa5..605bc9fc 100644--- a/freemocap/gui/qt/widgets/active_recording_widget.py+++ b/freemocap/gui/qt/widgets/active_recording_widget.py@@ -1,6 +1,6 @@import loggingfrom pathlib import Path-from typing import Union+from typing import Optional, Unionfrom PySide6.QtCore import Signal, QFileSystemWatcherfrom PySide6.QtWidgets import QApplication, QVBoxLayout, QWidget@@ -19,7 +19,7 @@ class ActiveRecordingInfoWidget(QWidget):def __init__(self,- parent: QWidget = None,+ parent: Optional[QWidget] = None,):super().__init__(parent=parent)self._layout = QVBoxLayout()@@ -40,7 +40,7 @@ class ActiveRecordingInfoWidget(QWidget):def active_recording_view_widget(self):return self._active_recording_view_widget- def get_active_recording_info(self, return_path: bool = False) -> Union[RecordingInfoModel, Path]:+ def get_active_recording_info(self, return_path: bool = False) -> Union[RecordingInfoModel, Path, None]:# this is redundant to the `active_recording_info` property,# but it will be more intuitive to send this down as a callable# rather than relying on 'pass-by-reference' magic lol@@ -57,8 +57,13 @@ class ActiveRecordingInfoWidget(QWidget):def set_active_recording(self,- recording_folder_path: Union[str, Path],+ recording_folder_path: Union[str, Path, None],):+ if recording_folder_path is None or recording_folder_path == "None":+ logger.info("No recording folder path provided - clearing active recording")+ self._active_recording_info = None+ return+logger.debug(f"Setting active recording to {recording_folder_path}")self._active_recording_info = RecordingInfoModel(recording_folder_path=str(recording_folder_path))diff --git a/freemocap/gui/qt/widgets/control_panel/export_data_control_panel.py b/freemocap/gui/qt/widgets/control_panel/export_data_control_panel.pyindex 2180ff0f..384f5736 100644--- a/freemocap/gui/qt/widgets/control_panel/export_data_control_panel.py+++ b/freemocap/gui/qt/widgets/control_panel/export_data_control_panel.py@@ -1,6 +1,5 @@import loggingfrom pathlib import Path-from typing import Unionfrom PySide6.QtWidgets import (QVBoxLayout,@@ -9,18 +8,21 @@ from PySide6.QtWidgets import (QCheckBox,QLabel,QFileDialog,- QLineEdit,)+from freemocap.gui.qt.utilities.save_and_load_gui_state import GuiState, save_gui_state+from freemocap.system.paths_and_filenames.path_getters import get_gui_state_json_path+logger = logging.getLogger(__name__)BLENDER_EXECUTABLE_PATH_MISSING_STRING = "BLENDER EXECUTABLE NOT FOUND"class VisualizationControlPanel(QWidget):- def __init__(self, blender_executable_path: Union[str, Path] = BLENDER_EXECUTABLE_PATH_MISSING_STRING, parent=None):+ def __init__(self, gui_state: GuiState, parent=None):super().__init__(parent=parent)- self._blender_executable_path = str(blender_executable_path)+ self._gui_state = gui_state+ self._blender_executable_path = str(self._gui_state.blender_path)self._layout = QVBoxLayout()self.setLayout(self._layout)@@ -36,7 +38,7 @@ class VisualizationControlPanel(QWidget):self._layout.addWidget(QLabel("Blender Executable Path:"))- self._blender_executable_label = QLineEdit(self._blender_executable_path)+ self._blender_executable_label = QLabel(self._blender_executable_path)self._layout.addWidget(self._blender_executable_label)self._set_blender_executable_path_button = QPushButton("Choose your Blender Executable")@@ -84,3 +86,9 @@ class VisualizationControlPanel(QWidget):logger.info(f"User selected Blender Executable path:{self._blender_executable_path}")self._blender_executable_label.setText(self._blender_executable_path)++ if (+ self._blender_executable_path != BLENDER_EXECUTABLE_PATH_MISSING_STRING+ ): # don't persist missing paths across sessions+ self._gui_state.blender_path = self._blender_executable_path+ save_gui_state(gui_state=self._gui_state, file_pathstring=get_gui_state_json_path())diff --git a/freemocap/gui/qt/widgets/directory_view_widget.py b/freemocap/gui/qt/widgets/directory_view_widget.pyindex 95e0b685..55cfc72f 100644--- a/freemocap/gui/qt/widgets/directory_view_widget.py+++ b/freemocap/gui/qt/widgets/directory_view_widget.py@@ -7,6 +7,7 @@ from PySide6.QtCore import Signal, Qtfrom PySide6.QtWidgets import QLabel, QMenu, QTreeView, QVBoxLayout, QWidget, QPushButton, QFileSystemModelfrom qtpy import QtGui+from freemocap.gui.qt.utilities.save_and_load_gui_state import GuiStatefrom freemocap.system.open_file import open_filefrom freemocap.system.paths_and_filenames.path_getters import get_recording_session_folder_path@@ -16,14 +17,14 @@ logger = logging.getLogger(__name__)class DirectoryViewWidget(QWidget):new_active_recording_selected_signal = Signal(str)- def __init__(self, top_level_folder_path: Union[str, Path], get_active_recording_info_callable: Callable):+ def __init__(self, gui_state: GuiState, get_active_recording_info_callable: Callable):self._root_folder = Nonelogger.debug("Creating QtDirectoryViewWidget")super().__init__()self._minimum_width = 300self.setMinimumWidth(self._minimum_width)- self._top_level_folder_path = top_level_folder_path+ self._gui_state = gui_stateself._get_active_recording_info_callable = get_active_recording_info_callableself._layout = QVBoxLayout()@@ -45,17 +46,17 @@ class DirectoryViewWidget(QWidget):self._tree_view_widget.setAlternatingRowColors(True)self._tree_view_widget.setColumnWidth(0, 250)- if self._top_level_folder_path is not None:- self.set_folder_as_root(self._top_level_folder_path)+ self._path_label = QLabel(str(self._gui_state.freemocap_data_folder_path))++ if self._gui_state.freemocap_data_folder_path is not None:+ self.set_folder_as_root(self._gui_state.freemocap_data_folder_path)self._show_freemocap_data_folder_button = QPushButton("Show FreeMoCap Data Folder")self._show_freemocap_data_folder_button.clicked.connect(- lambda: self.set_folder_as_root(self._top_level_folder_path)+ lambda: self.set_folder_as_root(self._gui_state.freemocap_data_folder_path))self._layout.addWidget(self._show_freemocap_data_folder_button)-- self._path_label = QLabel(str(self._top_level_folder_path))self._layout.addWidget(self._path_label)def expand_directory_to_path(self, path: Union[str, Path], collapse_other_directories: bool = True):@@ -83,6 +84,8 @@ class DirectoryViewWidget(QWidget):self._tree_view_widget.setRootIndex(self._file_system_model.index(str(folder_path)))self._tree_view_widget.setColumnWidth(0, int(self._minimum_width * 0.9))+ self._path_label.setText(str(folder_path))+def _context_menu(self):menu = QMenu()open = menu.addAction("Open file")@@ -143,7 +146,8 @@ if __name__ == "__main__":from PySide6.QtWidgets import QApplicationapp = QApplication(sys.argv)- directory_view_widget = DirectoryViewWidget(top_level_folder_path=Path.home())+ gui_state = GuiState()+ directory_view_widget = DirectoryViewWidget(gui_state=gui_state)directory_view_widget.show()diff --git a/freemocap/gui/qt/widgets/set_data_folder_dialog.py b/freemocap/gui/qt/widgets/set_data_folder_dialog.pynew file mode 100644index 00000000..a69e623b--- /dev/null+++ b/freemocap/gui/qt/widgets/set_data_folder_dialog.py@@ -0,0 +1,69 @@+from pathlib import Path+import threading++from PySide6.QtWidgets import QVBoxLayout, QDialog, QPushButton, QLabel, QHBoxLayout, QFileDialog++from freemocap.gui.qt.utilities.save_and_load_gui_state import GuiState, save_gui_state+from freemocap.system.paths_and_filenames.path_getters import get_gui_state_json_path+++class SetDataFolderDialog(QDialog):+ def __init__(self, gui_state: GuiState, kill_thread_event: threading.Event, parent=None) -> None:+ super().__init__(parent=parent)+ self.gui_state = gui_state+ self.kill_thread_event = kill_thread_event++ self._initUI()++ def _initUI(self) -> None:+ self.setMinimumSize(500, 200)++ self.setWindowTitle("Set Freemocap Data Folder")++ self._layout = QVBoxLayout()+ self.setLayout(self._layout)++ self._title_message_label = QLabel(f"Freemocap Data Folder: {self.gui_state.freemocap_data_folder_path}")+ self._title_message_label.setWordWrap(True)+ self._layout.addWidget(self._title_message_label)++ self._change_data_folder_button = QPushButton("Change Folder Location")+ self._change_data_folder_button.clicked.connect(self._change_data_folder)+ self._layout.addWidget(self._change_data_folder_button)++ self._reboot_warning_label = QLabel("Changing the freemocap data folder will reboot the GUI.")+ self._layout.addWidget(self._reboot_warning_label)++ button_box = QHBoxLayout()++ _cancel_button = QPushButton("Cancel")+ _cancel_button.clicked.connect(self.reject)+ button_box.addWidget(_cancel_button)++ self._done_button = QPushButton("Save and Reboot")+ self._done_button.clicked.connect(self._save_and_accept)+ button_box.addWidget(self._done_button)++ self._layout.addLayout(button_box)++ def _change_data_folder(self) -> None:+ self.new_folder_path = QFileDialog.getExistingDirectory(+ self,+ "Select New Data Folder",+ str(self.gui_state.freemocap_data_folder_path),+ QFileDialog.ShowDirsOnly,+ )+ self._title_message_label.setText(f"Freemocap Data Folder: {self.new_folder_path}")++ if self.new_folder_path == "":+ self._done_button.setEnabled(False)+ else:+ self._done_button.setEnabled(True)++ def _save_and_accept(self) -> None:+ if self.new_folder_path is not None:+ freemocap_data_folder_path = Path(self.new_folder_path)+ self.gui_state.freemocap_data_folder_path = str(freemocap_data_folder_path)+ save_gui_state(gui_state=self.gui_state, file_pathstring=get_gui_state_json_path())++ self.accept()diff --git a/freemocap/system/paths_and_filenames/path_getters.py b/freemocap/system/paths_and_filenames/path_getters.pyindex 637058d5..be3b589f 100644--- a/freemocap/system/paths_and_filenames/path_getters.py+++ b/freemocap/system/paths_and_filenames/path_getters.py@@ -1,10 +1,11 @@import timefrom datetime import datetimefrom pathlib import Path-from typing import Union+from typing import Optional, Unionimport toml+from freemocap.gui.qt.utilities.save_and_load_gui_state import load_gui_statefrom freemocap.system.paths_and_filenames.file_and_folder_names import (LOGS_INFO_AND_SETTINGS_FOLDER_NAME,LOG_FILE_FOLDER_NAME,@@ -50,14 +51,27 @@ def create_camera_calibration_file_name(recording_name: str):freemocap_data_folder_path = None-def get_freemocap_data_folder_path(create_folder: bool = True):+def get_freemocap_data_folder_path(create_folder: bool = True) -> str:global freemocap_data_folder_path- if freemocap_data_folder_path is None:- freemocap_data_folder_path = Path(os_independent_home_dir(), BASE_FREEMOCAP_DATA_FOLDER_NAME)+ try:+ if freemocap_data_folder_path is None:+ freemocap_data_folder_path = Path(os_independent_home_dir(), BASE_FREEMOCAP_DATA_FOLDER_NAME)+ if Path(get_gui_state_json_path()).exists():+ gui_state = load_gui_state(get_gui_state_json_path())+ else: # if GUI state isn't in new location, look in old location+ gui_state = load_gui_state(+ str(Path(freemocap_data_folder_path) / LOGS_INFO_AND_SETTINGS_FOLDER_NAME / GUI_STATE_JSON_FILENAME)+ )+ freemocap_data_folder_path = Path(gui_state.freemocap_data_folder_path)+ except Exception as e:+ print(e) # Cannot log this due to circular import from logging config+ finally:+ if freemocap_data_folder_path is None:+ freemocap_data_folder_path = Path(os_independent_home_dir(), BASE_FREEMOCAP_DATA_FOLDER_NAME)- if create_folder:- freemocap_data_folder_path.mkdir(exist_ok=create_folder, parents=True)+ if create_folder:+ freemocap_data_folder_path.mkdir(exist_ok=create_folder, parents=True)return str(freemocap_data_folder_path)@@ -116,13 +130,15 @@ def default_session_name(string_tag: str = None):return session_name-session_folder_path = None+session_folder_path: Optional[Path] = Nonedef create_new_session_folder():global session_folder_pathif session_folder_path is None:session_folder_path = Path(get_recording_session_folder_path()) / default_session_name()+ elif not session_folder_path.is_relative_to(get_freemocap_data_folder_path()):+ session_folder_path = Path(get_recording_session_folder_path()) / default_session_name()return str(session_folder_path)@@ -160,10 +176,10 @@ def get_most_recent_recording_toml_path():def get_gui_state_json_path():- return str(Path(get_logs_info_and_settings_folder_path()) / GUI_STATE_JSON_FILENAME)+ return str(Path(__file__).parent.parent / GUI_STATE_JSON_FILENAME)-def get_most_recent_recording_path(subfolder_str: str = None):+def get_most_recent_recording_path(subfolder_str: Optional[str] = None) -> Optional[str]:if not Path(get_most_recent_recording_toml_path()).exists():logger.error(f"{MOST_RECENT_RECORDING_TOML_FILENAME} not found at {get_most_recent_recording_toml_path()}!!")return None@@ -171,7 +187,7 @@ def get_most_recent_recording_path(subfolder_str: str = None):try:most_recent_recording_dict = toml.load(str(get_most_recent_recording_toml_path()))most_recent_recording_path = most_recent_recording_dict["most_recent_recording_path"]- except (ValueError, toml.TomlDecodeError, KeyError) as e:+ except (ValueError, toml.TomlDecodeError, KeyError, FileNotFoundError) as e:logger.exception(e)return None