boris-behav-obs 9.7__tar.gz → 9.7.2__tar.gz

{boris_behav_obs-9.7 → boris_behav_obs-9.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boris-behav-obs
-Version: 9.7
+Version: 9.7.2
 Summary: BORIS - Behavioral Observation Research Interactive Software
 Author-email: Olivier Friard <olivier.friard@unito.it>
 License-Expression: GPL-3.0-only
@@ -52,7 +52,7 @@ It provides also some analysis tools like time budget and some plotting function
 <!-- The BO-RIS paper has more than [![BORIS citations counter](https://penelope.unito.it/friard/boris_scopus_citations.png) citations](https://www.boris.unito.it/citations) in peer-reviewed scientific publications. -->
 
 
-The BORIS paper has more than 2337 citations in peer-reviewed scientific publications.
+The BORIS paper has more than 2407 citations in peer-reviewed scientific publications.
 
 
 

{boris_behav_obs-9.7 → boris_behav_obs-9.7.2}/README.md

@@ -14,7 +14,7 @@ It provides also some analysis tools like time budget and some plotting function
 <!-- The BO-RIS paper has more than [![BORIS citations counter](https://penelope.unito.it/friard/boris_scopus_citations.png) citations](https://www.boris.unito.it/citations) in peer-reviewed scientific publications. -->
 
 
-The BORIS paper has more than 2337 citations in peer-reviewed scientific publications.
+The BORIS paper has more than 2407 citations in peer-reviewed scientific publications.
 
 
 

{boris_behav_obs-9.7 → boris_behav_obs-9.7.2}/boris/cmd_arguments.py

@@ -35,6 +35,8 @@ def parse_arguments():
     parser.add_option("-n", "--nosplashscreen", action="store_true", default=False, help="No splash screen")
     parser.add_option("-p", "--project", action="store", default="", dest="project", help="Project file")
     parser.add_option("-o", "--observation", action="store", default="", dest="observation", help="Observation id")
+    parser.add_option("-i", "--ipc", action="store_true", default="", dest="ipc", help="MPV IPC mode")
+
     parser.add_option(
         "-f",
         "--no-first-launch-dialog",

{boris_behav_obs-9.7 → boris_behav_obs-9.7.2}/boris/config.py

@@ -22,8 +22,7 @@ This file is part of BORIS.
 
 programName: str = "BORIS"
 
-
-MACOS_CODE = "darwin"
+# socket for MPV IPC mode
 MPV_SOCKET = "/tmp/mpvsocket"
 
 
@@ -133,6 +132,8 @@ POINT_EVENT_PLOT_COLOR = "black"
 
 CHAR_FORBIDDEN_IN_MODIFIERS = "(|),`~"
 
+FAST_FORWARD_DEFAULT_VALUE:float = 10.0
+
 ADAPT_FAST_JUMP = "adapt_fast_jump"
 ADAPT_FAST_JUMP_DEFAULT = False
 
@@ -420,6 +421,10 @@ MPV_HWDEC_AUTOSAFE = "auto-safe"
 MPV_HWDEC_OPTIONS = (MPV_HWDEC_AUTO, MPV_HWDEC_AUTOSAFE, MPV_HWDEC_NO)
 MPV_HWDEC_DEFAULT_VALUE = MPV_HWDEC_AUTO
 
+# frame step size (disabled)
+# FRAME_STEP_SIZE: str = "frame_step_size"
+# FRAME_STEP_SIZE_DEFAULT_VALUE: int = 1
+
 ANALYSIS_PLUGINS = "analysis_plugins"
 EXCLUDED_PLUGINS = "excluded_plugins"
 PERSONAL_PLUGINS_DIR = "personal_plugins_dir"
@@ -731,6 +736,7 @@ INIT_PARAM = {
     MPV_HWDEC: MPV_HWDEC_DEFAULT_VALUE,
     PROJECT_FILE_INDENTATION: PROJECT_FILE_INDENTATION_DEFAULT_VALUE,
     f"{MEDIA} tw fields": MEDIA_TW_EVENTS_FIELDS_DEFAULT,
+    # FRAME_STEP_SIZE: FRAME_STEP_SIZE_DEFAULT_VALUE,
 }
 
 SDIS_EXT = "sds"

{boris_behav_obs-9.7 → boris_behav_obs-9.7.2}/boris/config_file.py

@@ -82,11 +82,11 @@ def read(self):
 
         logging.debug(f"time format: {self.timeFormat}")
 
-        self.fast = 10
+        self.fast = cfg.FAST_FORWARD_DEFAULT_VALUE
         try:
-            self.fast = int(settings.value("Time/fast_forward_speed"))
+            self.fast = float(settings.value("Time/fast_forward_speed"))
         except Exception:
-            self.fast = 10
+            self.fast = cfg.FAST_FORWARD_DEFAULT_VALUE
 
         logging.debug(f"Time/fast_forward_speed: {self.fast}")
 

{boris_behav_obs-9.7 → boris_behav_obs-9.7.2}/boris/core.py

@@ -43,7 +43,6 @@ import locale
 import tempfile
 import time
 import urllib.request
-from typing import Union, Tuple
 from decimal import Decimal as dec
 from decimal import ROUND_DOWN
 import gzip
@@ -150,7 +149,7 @@ if util.versiontuple(platform.python_version()) < util.versiontuple(MIN_PYTHON_V
     logging.critical(msg)
     sys.exit()
 
-if sys.platform == "darwin":  # for MacOS
+if sys.platform.startswith("darwin"):  # for MacOS
     os.environ["LC_ALL"] = "en_US.UTF-8"
 
 
@@ -242,7 +241,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
     current_player: int = 0  # id of the selected (left click) video player
 
     mem_media_name: str = ""  # record current media name. Use to check if media changed
-    mem_playlist_index: Union[int, None] = None
+    mem_playlist_index: int | None = None
     saved_state = None
     user_move_slider: bool = False
     observationId: str = ""  # current observation id
@@ -400,7 +399,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
         # if BORIS is running on Mac lock all dockwidget features
         # because Qdockwidgets may have a strange behavior
-        if sys.platform == "darwin":
+        if sys.platform.startswith("darwin"):
             self.action_block_dockwidgets.setChecked(True)
             self.block_dockwidgets()
 
@@ -739,7 +738,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         text: str = "Behaviors to show in ethogram list",
         table: str = cfg.ETHOGRAM,
         behavior_type: list = cfg.STATE_EVENT_TYPES,
-    ) -> Tuple[bool, list]:
+    ) -> tuple[bool, list]:
         """
         allow user to:
             filter behaviors in ethogram widget
@@ -1428,55 +1427,60 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         if not self.dw_player[player].player.playlist_count:
             return
 
-        # one media
-        if self.dw_player[player].player.playlist_count == 1:
-            if new_time < self.dw_player[player].player.duration:
-                new_time_float = round(float(new_time), 3)
-
-                self.dw_player[player].player.seek(new_time_float, "absolute+exact")
+        try:
+            # one media
+            if self.dw_player[player].player.playlist_count == 1:
+                if new_time < self.dw_player[player].player.duration:
+                    new_time_float = round(float(new_time), 3)
 
-                if player == 0 and not self.user_move_slider:
-                    self.video_slider.setValue(
-                        round(self.dw_player[0].player.time_pos / self.dw_player[0].player.duration * (cfg.SLIDER_MAXIMUM - 1))
-                    )
-                return 0
-            else:
-                return 1
+                    self.dw_player[player].player.seek(new_time_float, "absolute+exact")
+                    self.mpv_timer_out()
 
-        # many media
-        else:
-            if new_time < self.dw_player[player].cumul_media_durations_sec[-1]:
-                for idx, d in enumerate(self.dw_player[player].cumul_media_durations_sec[:-1]):
-                    if d <= new_time < self.dw_player[player].cumul_media_durations_sec[idx + 1]:
-                        self.dw_player[player].player.playlist_pos = idx
-                        time.sleep(0.5)
-
-                        self.dw_player[player].player.seek(
-                            round(
-                                float(new_time)
-                                - sum(self.dw_player[player].media_durations[0 : self.dw_player[player].player.playlist_pos]) / 1000,
-                                3,
-                            ),
-                            "absolute+exact",
+                    if player == 0 and not self.user_move_slider:
+                        self.video_slider.setValue(
+                            round(self.dw_player[0].player.time_pos / self.dw_player[0].player.duration * (cfg.SLIDER_MAXIMUM - 1))
                         )
+                    return 0
+                else:
+                    return 1
 
-                        break
+            # many media
+            else:
+                if new_time < self.dw_player[player].cumul_media_durations_sec[-1]:
+                    for idx, d in enumerate(self.dw_player[player].cumul_media_durations_sec[:-1]):
+                        if d <= new_time < self.dw_player[player].cumul_media_durations_sec[idx + 1]:
+                            self.dw_player[player].player.playlist_pos = idx
+                            time.sleep(0.5)
+
+                            self.dw_player[player].player.seek(
+                                round(
+                                    float(new_time)
+                                    - sum(self.dw_player[player].media_durations[0 : self.dw_player[player].player.playlist_pos]) / 1000,
+                                    3,
+                                ),
+                                "absolute+exact",
+                            )
 
-                if player == 0 and not self.user_move_slider:
-                    self.video_slider.setValue(
-                        round(self.dw_player[0].player.time_pos / self.dw_player[0].player.duration * (cfg.SLIDER_MAXIMUM - 1))
+                            break
+
+                    if player == 0 and not self.user_move_slider:
+                        self.video_slider.setValue(
+                            round(self.dw_player[0].player.time_pos / self.dw_player[0].player.duration * (cfg.SLIDER_MAXIMUM - 1))
+                        )
+                    return 0
+                else:
+                    QMessageBox.warning(
+                        self,
+                        cfg.programName,
+                        (
+                            "The indicated position is greater than the total media duration "
+                            f"({util.seconds2time(self.dw_player[player].cumul_media_durations_sec[-1])})"
+                        ),
                     )
-                return 0
-            else:
-                QMessageBox.warning(
-                    self,
-                    cfg.programName,
-                    (
-                        "The indicated position is greater than the total media duration "
-                        f"({util.seconds2time(self.dw_player[player].cumul_media_durations_sec[-1])})"
-                    ),
-                )
-                return 1
+                    return 1
+        except Exception as e:
+            print(f"error in seek mediaplayer function: {e}")
+            return 0
 
     def jump_to(self) -> None:
         """
@@ -3677,14 +3681,19 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         """
         show next frame
         """
+        # frame_step_size = self.config_param.get(cfg.FRAME_STEP_SIZE, cfg.FRAME_STEP_SIZE_DEFAULT_VALUE)
+
         if self.playerType == cfg.IMAGES:
             if self.image_idx < len(self.images_list) - 1:
-                self.image_idx += 1
+                self.image_idx += 1  # frame_step_size
                 self.extract_frame(self.dw_player[0])
 
         if self.playerType == cfg.MEDIA:
             for dw in self.dw_player:
+                # for _ in range(frame_step_size):
                 dw.player.frame_step()
+                # time.sleep(0.5)
+
                 if self.geometric_measurements_mode:
                     self.extract_frame(dw)
 
@@ -3692,6 +3701,8 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 for idx in self.plot_data:
                     self.timer_plot_data_out(self.plot_data[idx])
 
+            self.mpv_timer_out()
+
         if self.geometric_measurements_mode:
             geometric_measurement.redraw_measurements(self)
 
@@ -3709,6 +3720,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         if self.playerType == cfg.MEDIA:
             for dw in self.dw_player:
                 dw.player.frame_back_step()
+
                 if self.geometric_measurements_mode:
                     self.extract_frame(dw)
 
@@ -3716,6 +3728,8 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 for idx in self.plot_data:
                     self.timer_plot_data_out(self.plot_data[idx])
 
+            self.mpv_timer_out()
+
         if self.geometric_measurements_mode:
             geometric_measurement.redraw_measurements(self)
 
@@ -3855,15 +3869,13 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 write_event.write_event(self, event, cumulative_time)
             # write_event.write_event(self, event, self.getLaps())
 
-    def get_frame_index(self, player_idx: int = 0) -> Union[int, str]:
+    def get_frame_index(self, player_idx: int = 0) -> int | str:
         """
         returns frame index for player player_idx
         """
 
-        if not sys.platform.startswith(cfg.MACOS_CODE):
-            estimated_frame_number = self.dw_player[player_idx].player.estimated_frame_number
-        else:
-            estimated_frame_number = observation_operations.send_command({"command": ["get_property", "estimated_frame_number"]})
+        estimated_frame_number = self.dw_player[player_idx].player.estimated_frame_number
+
         if estimated_frame_number is not None:
             return estimated_frame_number
         else:
@@ -3939,7 +3951,8 @@ class MainWindow(QMainWindow, Ui_MainWindow):
             if self.dw_player[0].player.duration is None:
                 return
             video_position = slider_position * self.dw_player[0].player.duration
-            self.dw_player[0].player.command("seek", str(video_position), "absolute")
+            # self.dw_player[0].player.command("seek", str(video_position), "absolute")
+            self.dw_player[0].player.seek(video_position, "absolute")
 
             self.plot_timer_out()
 
@@ -4132,7 +4145,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 self.dw_player[n_player].player.playlist_pos = self.dw_player[n_player].player.playlist_count - 1
                 self.seek_mediaplayer(self.dw_player[n_player].media_durations[-1], player=n_player)
 
-    def mpv_timer_out(self, value: Union[float, None], scroll_slider=True):
+    def mpv_timer_out(self, value: float | None = None, scroll_slider=True):
         """
         print the media current position and total length for MPV player
         scroll video slider to video position
@@ -4147,8 +4160,8 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         frame_idx = self.get_frame_index()
         # frame_idx = 0
 
-        if value is None:
-            current_media_time_pos = 0
+        if value is None:  # ipc mpv
+            current_media_time_pos = self.dw_player[0].player.time_pos
         else:
             current_media_time_pos = value
 
@@ -4186,22 +4199,19 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
         ct0 = cumulative_time_pos
 
-        if not sys.platform.startswith(cfg.MACOS_CODE):
-            if self.dw_player[0].player.time_pos is not None:
-                for n_player in range(1, len(self.dw_player)):
-                    ct = self.getLaps(n_player=n_player)
+        if self.dw_player[0].player.time_pos is not None:
+            for n_player in range(1, len(self.dw_player)):
+                ct = self.getLaps(n_player=n_player)
 
-                    # sync players 2..8 if time diff >= 1 s
-                    if (
-                        abs(ct0 - (ct + dec(self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.OFFSET][str(n_player + 1)])))
-                        >= 1
-                    ):
-                        self.sync_time(n_player, ct0)  # self.seek_mediaplayer(ct0, n_player)
+                # sync players 2..8 if time diff >= 1 s
+                if abs(ct0 - (ct + dec(self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.OFFSET][str(n_player + 1)]))) >= 1:
+                    self.sync_time(n_player, ct0)  # self.seek_mediaplayer(ct0, n_player)
 
         currentTimeOffset = dec(cumulative_time_pos + self.pj[cfg.OBSERVATIONS][self.observationId][cfg.TIME_OFFSET])
 
         all_media_duration = sum(self.dw_player[0].media_durations) / 1000
         current_media_duration = self.dw_player[0].player.duration  # mediaplayer_length
+
         self.mediaTotalLength = current_media_duration
 
         # current state(s)
@@ -4301,6 +4311,8 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
             self.actionPlay.setIcon(QIcon(f":/play_{gui_utilities.theme_mode()}"))
 
+        print(f"{msg=}")
+
         if msg:
             self.lb_current_media_time.setText(msg)
 
@@ -4317,14 +4329,6 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
         logging.info("Media end reached")
 
-        """
-        print(f"{self.dw_player[0].player.time_pos=}")
-        print(f"{self.dw_player[0].player.pause=}")
-        print(f"{self.dw_player[0].player.core_idle=}")
-        print(f"{self.dw_player[0].player.eof_reached=}")
-        print(f"{self.dw_player[0].player.playlist_pos=}")
-        """
-
         if self.pj[cfg.OBSERVATIONS][self.observationId][cfg.CLOSE_BEHAVIORS_BETWEEN_VIDEOS]:
             if self.dw_player[0].player.eof_reached and self.dw_player[0].player.core_idle:
                 if self.dw_player[0].player.playlist_pos == len(self.dw_player[0].player.playlist) - 1:
@@ -4480,7 +4484,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                 for x in self.pj[cfg.OBSERVATIONS][obs_id][cfg.EVENTS]
             )
 
-    def choose_behavior(self, obs_key) -> Union[None, str]:
+    def choose_behavior(self, obs_key) -> None | str:
         """
         fill listwidget with all behaviors coded by key
 
@@ -4512,7 +4516,7 @@ class MainWindow(QMainWindow, Ui_MainWindow):
             else:
                 return None
 
-    def choose_subject(self, subject_key) -> Union[None, str]:
+    def choose_subject(self, subject_key) -> None | str:
         """
         fill listwidget with all subjects coded by key
 
@@ -4594,18 +4598,13 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
             if self.playerType == cfg.MEDIA:
                 # cumulative time
-                if not sys.platform.startswith(cfg.MACOS_CODE):
-                    mem_laps = sum(self.dw_player[n_player].media_durations[0 : self.dw_player[n_player].player.playlist_pos]) + (
-                        0 if self.dw_player[n_player].player.time_pos is None else self.dw_player[n_player].player.time_pos * 1000
-                    )
-                else:
-                    time_pos = observation_operations.send_command({"command": ["get_property", "time-pos"]})
-                    # TODO: fix!
-                    return dec(time_pos)
+                mem_laps = sum(self.dw_player[n_player].media_durations[0 : self.dw_player[n_player].player.playlist_pos]) + (
+                    0 if self.dw_player[n_player].player.time_pos is None else self.dw_player[n_player].player.time_pos * 1000
+                )
 
                 return dec(str(round(mem_laps / 1000, 3)))
 
-    def get_obs_time(self, n_player: int = 0) -> Tuple[dec, dec | None]:
+    def get_obs_time(self, n_player: int = 0) -> tuple[dec, dec | None]:
         """
         returns time in current media and cumulative time from begining of observation
         do not add time offset
@@ -5389,6 +5388,18 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         """
         logging.debug("function: closeEvent")
 
+        # close MPV in IPC mode
+        if self.MPV_IPC_MODE:
+            try:
+                for idx, p in enumerate(self.dw_player):
+                    p.player.process.terminate()
+                    try:
+                        p.player.process.wait(timeout=3)  # wait up to 3s
+                    except subprocess.TimeoutExpired:
+                        p.player.process.kill()  # force if still alive
+            except Exception as e:
+                logging.warning(f"Error stopping MPV process #{idx}: {e}")
+
         # check if re-encoding
         if self.processes:
             if (
@@ -5442,6 +5453,8 @@ class MainWindow(QMainWindow, Ui_MainWindow):
         check if first player ended
         """
 
+        print("play_video")
+
         if self.geometric_measurements_mode:
             return
 
@@ -5463,6 +5476,9 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
         self.statusbar.showMessage("", 0)
 
+        if self.ipc_mpv_timer is not None:
+            self.ipc_mpv_timer.start()
+
         self.plot_timer.start()
 
         # start all timer for plotting data
@@ -5494,6 +5510,10 @@ class MainWindow(QMainWindow, Ui_MainWindow):
                     for data_timer in self.ext_data_timer_list:
                         data_timer.stop()
 
+                    if self.ipc_mpv_timer is not None:
+                        self.ipc_mpv_timer.stop()
+                        self.mpv_timer_out()
+
                     player.player.pause = True
 
         self.lb_player_status.setText(msg)
@@ -5543,13 +5563,6 @@ class MainWindow(QMainWindow, Ui_MainWindow):
 
             self.update_visualizations()
 
-            # subtitles
-            """
-            st_track_number = 0 if self.config_param[DISPLAY_SUBTITLES] else -1
-            for player in self.dw_player:
-                player.mediaplayer.video_set_spu(st_track_number)
-            """
-
     def jumpForward_activated(self):
         """
         forward from current position
@@ -5806,6 +5819,22 @@ def main():
                 results.ptText.appendHtml(f"Some issues were found in the project<br><br>{msg}")
                 results.show()
 
+    # check mpv IPC mode
+    window.MPV_IPC_MODE = False
+    if options.ipc or sys.platform.startswith("darwin"):
+        window.MPV_IPC_MODE = True
+        # check if mpv is available
+        if not shutil.which("mpv"):
+            logging.critical("The mpv command is not available on the path")
+            QMessageBox.critical(
+                None,
+                cfg.programName,
+                ("The mpv command is not available on the path"),
+                QMessageBox.Ok | QMessageBox.Default,
+                QMessageBox.NoButton,
+            )
+            sys.exit()
+
     window.show()
     window.raise_()  # for overlapping widget (?)