boris-behav-obs 9.7.7__py3-none-any.whl

boris/video_operations.py

@@ -0,0 +1,310 @@
+"""
+BORIS
+Behavioral Observation Research Interactive Software
+Copyright 2012-2025 Olivier Friard
+
+
+  This program is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+  MA 02110-1301, USA.
+
+"""
+
+import logging
+import pathlib as pl
+import shutil
+from math import log2
+
+from PySide6.QtWidgets import QFileDialog
+
+from . import config as cfg
+from . import dialog
+
+
+def deinterlace(self):
+    """
+    change the deinterlace status of player
+    """
+
+    logging.info("change deinterlace status of player")
+
+    for dw in self.dw_player:
+        dw.player.deinterlace = self.action_deinterlace.isChecked()
+
+
+def snapshot(self):
+    """
+    MEDIA obs: take snapshot of current video at current position
+    IMAGES obs: save a copy of the current image
+
+    snapshot is saved on media path following the template: MEDIA-FILE-NAME_TIME-POSITION.png
+    """
+
+    if self.playerType == cfg.MEDIA:
+        for i, player in enumerate(self.dw_player):
+            if (
+                str(i + 1) in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.FILE]
+                and self.pj[cfg.OBSERVATIONS][self.observationId][cfg.FILE][str(i + 1)]
+            ):
+                p = pl.Path(self.dw_player[0].player.playlist[self.dw_player[0].player.playlist_pos]["filename"])
+
+                snapshot_file_path = str(p.parent / f"{p.stem}_{player.player.time_pos:0.3f}.png")
+
+                player.player.screenshot_to_file(snapshot_file_path)
+                self.statusbar.showMessage(f"Video snapshot saved in {snapshot_file_path}", 0)
+
+                logging.debug(f"video snapshot saved in {snapshot_file_path}")
+
+    if self.playerType == cfg.IMAGES:
+        output_file_name, _ = QFileDialog().getSaveFileName(
+            self, "Save copy of the current image", pl.Path(self.images_list[self.image_idx]).name
+        )
+        if output_file_name:
+            shutil.copyfile(self.images_list[self.image_idx], output_file_name)
+            self.statusbar.showMessage(f"Image saved in {output_file_name}", 0)
+
+            logging.debug(f"video snapshot saved in {output_file_name}")
+
+
+def zoom_level(self):
+    """
+    display dialog box for setting the zoom level
+    """
+    logging.info("change zoom level of player")
+
+    players_list: list = []
+    for idx, dw in enumerate(self.dw_player):
+        players_list.append(("dsb", f"Player #{idx + 1}", 0.1, 12, 0.1, 2**dw.player.video_zoom, 1))
+
+    zl = dialog.Input_dialog(label_caption="Select the zoom level", elements_list=players_list, title="Video zoom level")
+    if not zl.exec_():
+        return
+
+    if cfg.ZOOM_LEVEL not in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO]:
+        self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.ZOOM_LEVEL] = {}
+
+    for idx, dw in enumerate(self.dw_player):
+        if (
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.ZOOM_LEVEL].get(str(idx + 1), dw.player.video_zoom)
+            != zl.elements[f"Player #{idx + 1}"].value()
+        ):
+            dw.player.video_zoom = log2(float(zl.elements[f"Player #{idx + 1}"].value()))
+
+            logging.debug(f"video zoom changed in {dw.player.video_zoom} for player {idx + 1}")
+
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.ZOOM_LEVEL][str(idx + 1)] = float(
+                zl.elements[f"Player #{idx + 1}"].value()
+            )
+            display_zoom_level(self)
+            self.project_changed()
+
+
+def change_player_offset(self):
+    """
+    display dialog box for setting the player time offset
+    """
+    logging.info("change the player time offset")
+
+    if cfg.OFFSET not in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO]:
+        self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.OFFSET] = {}
+
+    players_list: list = []
+
+    for idx, dw in enumerate(self.dw_player):
+        players_list.append(
+            (
+                "dsb",
+                f"Player #{idx + 1}",
+                -100000,
+                100000,
+                0.001,
+                self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.OFFSET][str(idx + 1)],
+                3,
+            )
+        )
+
+    zl = dialog.Input_dialog(label_caption="Select the time offset", elements_list=players_list, title="Time offset")
+    if not zl.exec_():
+        return
+
+    for idx, dw in enumerate(self.dw_player):
+        if (
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.OFFSET].get(str(idx + 1), 0)
+            != zl.elements[f"Player #{idx + 1}"].value()
+        ):
+            logging.debug(f"time offset of player changed in {zl.elements[f'Player #{idx + 1}'].value()} for player {idx + 1}")
+
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.OFFSET][str(idx + 1)] = float(
+                zl.elements[f"Player #{idx + 1}"].value()
+            )
+
+            if self.dw_player[0].player.time_pos is not None:
+                cumulative_time_pos = self.getLaps()  # for player 1
+                self.sync_time(idx, cumulative_time_pos)
+
+            self.project_changed()
+
+
+def rotate_displayed_video(self):
+    """
+    rotate the displayed video
+    """
+    players_list: list = []
+    for idx, dw in enumerate(self.dw_player):
+        rotation_angles: list = []
+        for choice in (0, 90, 180, 270):
+            rotation_angles.append((str(choice), "selected" if choice == dw.player.video_rotate else ""))
+        players_list.append(("il", f"Player #{idx + 1}", rotation_angles))
+
+    w = dialog.Input_dialog(label_caption="Select the rotation angle", elements_list=players_list, title="Video rotation angle")
+    if not w.exec_():
+        return
+    if cfg.ROTATION_ANGLE not in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO]:
+        self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.ROTATION_ANGLE] = {}
+
+    for idx, dw in enumerate(self.dw_player):
+        if self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.ROTATION_ANGLE].get(
+            str(idx + 1), dw.player.video_rotate
+        ) != float(w.elements[f"Player #{idx + 1}"].currentText()):
+            dw.player.video_rotate = int(w.elements[f"Player #{idx + 1}"].currentText())
+
+            logging.debug(f"video rotation changed to {dw.player.video_rotate} for player {idx + 1}")
+
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.ROTATION_ANGLE][str(idx + 1)] = int(
+                w.elements[f"Player #{idx + 1}"].currentText()
+            )
+            self.project_changed()
+
+
+def display_subtitles(self):
+    """
+    display dialog for subtitles display
+    """
+    players_list = []
+    for idx, dw in enumerate(self.dw_player):
+        if cfg.DISPLAY_MEDIA_SUBTITLES in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO]:
+            default = self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.DISPLAY_MEDIA_SUBTITLES].get(
+                str(idx + 1), dw.player.sub_visibility
+            )
+        else:
+            default = dw.player.sub_visibility
+        players_list.append(("cb", f"Player #{idx + 1}", default))
+
+    st = dialog.Input_dialog("Display subtitles", players_list)
+    if not st.exec_():
+        return
+
+    if cfg.DISPLAY_MEDIA_SUBTITLES not in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO]:
+        self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.DISPLAY_MEDIA_SUBTITLES] = {}
+
+    for idx, dw in enumerate(self.dw_player):
+        if (
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.DISPLAY_MEDIA_SUBTITLES].get(
+                str(idx + 1), dw.player.sub_visibility
+            )
+            != st.elements[f"Player #{idx + 1}"].isChecked()
+        ):
+            dw.player.sub_visibility = st.elements[f"Player #{idx + 1}"].isChecked()
+
+            logging.debug(f"subtitle visibility for player {idx + 1}: {dw.player.sub_visibility}")
+
+            self.pj[cfg.OBSERVATIONS][self.observationId][cfg.MEDIA_INFO][cfg.DISPLAY_MEDIA_SUBTITLES][str(idx + 1)] = st.elements[
+                f"Player #{idx + 1}"
+            ].isChecked()
+            self.project_changed()
+
+
+def display_zoom_level(self) -> None:
+    """
+    display the zoom level
+    """
+    msg: str = "Zoom level: <b>"
+    for player in self.dw_player:
+        vz = player.player.video_zoom
+        if vz is None:
+            self.lb_zoom_level.setText("-")
+            return
+        if player.player.video_zoom is not None:
+            msg += f"{2**player.player.video_zoom:.1f} "
+        else:
+            msg += "NA "
+    msg += "</b>"
+    self.lb_zoom_level.setText(msg)
+
+
+def display_play_rate(self) -> None:
+    """
+    display current play rate in status bar widget
+    """
+
+    self.lb_video_info.setText(f"Play rate: <b>x{self.play_rate:.3f}</b>")
+
+    logging.debug(f"play rate: {self.play_rate:.3f}")
+
+
+def video_normalspeed_activated(self):
+    """
+    set playing speed at normal speed (1x)
+    """
+
+    if self.playerType != cfg.MEDIA:
+        return
+
+    self.play_rate = 1
+    for i, player in enumerate(self.dw_player):
+        if (
+            str(i + 1) in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.FILE]
+            and self.pj[cfg.OBSERVATIONS][self.observationId][cfg.FILE][str(i + 1)]
+        ):
+            player.player.speed = self.play_rate
+
+    display_play_rate(self)
+
+
+def video_faster_activated(self):
+    """
+    increase playing speed by play_rate_step value
+    """
+
+    if self.playerType != cfg.MEDIA:
+        return
+
+    if self.play_rate + self.play_rate_step <= 60:
+        self.play_rate += self.play_rate_step
+        for i, player in enumerate(self.dw_player):
+            if (
+                str(i + 1) in self.pj[cfg.OBSERVATIONS][self.observationId][cfg.FILE]
+                and self.pj[cfg.OBSERVATIONS][self.observationId][cfg.FILE][str(i + 1)]
+            ):
+                player.player.speed = self.play_rate
+                print("speed")
+
+        display_play_rate(self)
+
+
+def video_slower_activated(self):
+    """
+    decrease playing speed by play_rate_step value
+    """
+
+    if self.playerType != cfg.MEDIA:
+        return
+
+    if self.play_rate - self.play_rate_step >= 0.1:
+        self.play_rate -= self.play_rate_step
+
+        for i, player in enumerate(self.dw_player):
+            player.player.speed = round(self.play_rate, 3)
+
+        display_play_rate(self)

boris/view_df.py

@@ -0,0 +1,104 @@
+from .view_df_ui import Ui_Form
+from PySide6.QtWidgets import QWidget, QFileDialog
+from PySide6.QtCore import Qt, QAbstractTableModel
+
+from . import config as cfg
+from pathlib import Path
+from . import dialog
+
+try:
+    import pyreadr
+
+    flag_pyreadr_loaded = True
+except ModuleNotFoundError:
+    flag_pyreadr_loaded = False
+
+
+class DataFrameModel(QAbstractTableModel):
+    def __init__(self, dataframe):
+        super().__init__()
+        self._dataframe = dataframe
+
+    def rowCount(self, parent=None):
+        return self._dataframe.shape[0]
+
+    def columnCount(self, parent=None):
+        return self._dataframe.shape[1]
+
+    def data(self, index, role=Qt.DisplayRole):
+        if role == Qt.DisplayRole:
+            return str(self._dataframe.iat[index.row(), index.column()])
+        return None
+
+    def headerData(self, section, orientation, role=Qt.DisplayRole):
+        if role == Qt.DisplayRole:
+            if orientation == Qt.Horizontal:
+                return self._dataframe.columns[section]
+            elif orientation == Qt.Vertical:
+                return self._dataframe.index[section]
+        return None
+
+
+class View_df(QWidget, Ui_Form):
+    def __init__(self, plugin_name: str, plugin_version: str, df, parent=None):
+        super().__init__()
+        self.plugin_name = plugin_name
+        self.df = df
+
+        self.setupUi(self)
+        self.lb_plugin_info.setText(f"{plugin_name} v. {plugin_version}")
+        self.setWindowTitle(f"{plugin_name} v. {plugin_version}")
+
+        self.pb_close.clicked.connect(self.close)
+        self.pb_save.clicked.connect(self.save)
+
+        model = DataFrameModel(self.df)
+        self.tv_df.setModel(model)
+
+    def save(self):
+        file_formats = (
+            cfg.TSV,
+            cfg.CSV,
+            cfg.ODS,
+            cfg.XLSX,
+            # cfg.XLS,
+            cfg.HTML,
+            # cfg.TBS,
+            cfg.PANDAS_DF,
+            cfg.RDS,
+        )
+
+        file_dialog_options = QFileDialog.Options()
+        file_dialog_options |= QFileDialog.DontConfirmOverwrite
+
+        file_name, filter_ = QFileDialog().getSaveFileName(
+            None, f"Save {self.plugin_name}", "", ";;".join(file_formats), options=file_dialog_options
+        )
+        if not file_name:
+            return
+
+        outputFormat = cfg.FILE_NAME_SUFFIX[filter_]
+        if Path(file_name).suffix != "." + outputFormat:
+            file_name = f"{file_name}.{outputFormat}"
+            if Path(file_name).exists():
+                if (
+                    dialog.MessageDialog(cfg.programName, f"The file {file_name} already exists.", [cfg.CANCEL, cfg.OVERWRITE])
+                    == cfg.CANCEL
+                ):
+                    return
+
+        if filter_ == cfg.TSV:
+            self.df.to_csv(file_name, sep="\t", index=False)
+        if filter_ == cfg.CSV:
+            self.df.to_csv(file_name, sep=";", index=False)
+        if filter_ == cfg.XLSX:
+            self.df.to_excel(file_name, index=False)
+        if filter_ == cfg.ODS:
+            self.df.to_excel(file_name, index=False, engine="odf")
+        if filter_ == cfg.HTML:
+            self.df.to_html(file_name, index=False)
+        if filter_ == cfg.PANDAS_DF:
+            self.df.to_pickle(file_name)
+
+        if filter_ == cfg.RDS and flag_pyreadr_loaded:
+            pyreadr.write_rds(file_name, self.df)

boris/view_df_ui.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+
+################################################################################
+## Form generated from reading UI file 'view_df.ui'
+##
+## Created by: Qt User Interface Compiler version 6.8.0
+##
+## WARNING! All changes made in this file will be lost when recompiling UI file!
+################################################################################
+
+from PySide6.QtCore import (QCoreApplication, QDate, QDateTime, QLocale,
+    QMetaObject, QObject, QPoint, QRect,
+    QSize, QTime, QUrl, Qt)
+from PySide6.QtGui import (QBrush, QColor, QConicalGradient, QCursor,
+    QFont, QFontDatabase, QGradient, QIcon,
+    QImage, QKeySequence, QLinearGradient, QPainter,
+    QPalette, QPixmap, QRadialGradient, QTransform)
+from PySide6.QtWidgets import (QApplication, QHBoxLayout, QHeaderView, QLabel,
+    QPushButton, QSizePolicy, QSpacerItem, QTableView,
+    QVBoxLayout, QWidget)
+
+class Ui_Form(object):
+    def setupUi(self, Form):
+        if not Form.objectName():
+            Form.setObjectName(u"Form")
+        Form.resize(400, 300)
+        self.verticalLayout_2 = QVBoxLayout(Form)
+        self.verticalLayout_2.setObjectName(u"verticalLayout_2")
+        self.lb_plugin_info = QLabel(Form)
+        self.lb_plugin_info.setObjectName(u"lb_plugin_info")
+
+        self.verticalLayout_2.addWidget(self.lb_plugin_info)
+
+        self.verticalLayout = QVBoxLayout()
+        self.verticalLayout.setObjectName(u"verticalLayout")
+        self.tv_df = QTableView(Form)
+        self.tv_df.setObjectName(u"tv_df")
+
+        self.verticalLayout.addWidget(self.tv_df)
+
+        self.horizontalLayout = QHBoxLayout()
+        self.horizontalLayout.setObjectName(u"horizontalLayout")
+        self.horizontalSpacer = QSpacerItem(40, 20, QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Minimum)
+
+        self.horizontalLayout.addItem(self.horizontalSpacer)
+
+        self.pb_save = QPushButton(Form)
+        self.pb_save.setObjectName(u"pb_save")
+
+        self.horizontalLayout.addWidget(self.pb_save)
+
+        self.pb_close = QPushButton(Form)
+        self.pb_close.setObjectName(u"pb_close")
+
+        self.horizontalLayout.addWidget(self.pb_close)
+
+
+        self.verticalLayout.addLayout(self.horizontalLayout)
+
+
+        self.verticalLayout_2.addLayout(self.verticalLayout)
+
+
+        self.retranslateUi(Form)
+
+        QMetaObject.connectSlotsByName(Form)
+    # setupUi
+
+    def retranslateUi(self, Form):
+        Form.setWindowTitle(QCoreApplication.translate("Form", u"Form", None))
+        self.lb_plugin_info.setText(QCoreApplication.translate("Form", u"TextLabel", None))
+        self.pb_save.setText(QCoreApplication.translate("Form", u"Save results", None))
+        self.pb_close.setText(QCoreApplication.translate("Form", u"Close", None))
+    # retranslateUi
+