add notification sound

Author: arch

docs/app/docs/user-guide/config.md

@@ -25,6 +25,7 @@ Config Files:
 - `max_playback_fps` (int): Limit the max player speed in the tracking preview window (0 = disable limit)
 - `preview_scaling` (float): Set the preview image scaling factor. With a value of `1.0`, the window should fill the height or width of the screen depending on the aspect ratio of the video.
 - `tracker`: (str) Specify the tracker algorithm. Available options are `'MIL'`, `'KCF'`, `'CSRT'`.
+- `notification_sound` (str) Specify the wav file to play when tracking finished (write 'off' to disable the sound notification).
 
 #### `hyperparameter.yaml`
 

environment_appimage.yaml

@@ -160,6 +160,7 @@ dependencies:
     - matplotlib==3.4.2
     - mergedeep==1.3.4
     - mkdocs==1.2.1
+    - playsound==1.3.0
     - pyinstaller==4.3
     - pyinstaller-hooks-contrib==2021.2
     - pynput==1.7.3

environment_ubuntu.yaml

@@ -160,6 +160,7 @@ dependencies:
     - matplotlib==3.4.2
     - mergedeep==1.3.4
     - mkdocs==1.2.1
+    - playsound==1.3.0
     - pyinstaller==4.3
     - pyinstaller-hooks-contrib==2021.2
     - pynput==1.7.3

environment_windows.yaml

@@ -62,6 +62,7 @@ dependencies:
     - opencv-contrib-python==4.5.2.54
     - packaging==21.0
     - pefile==2021.5.24
+    - playsound==1.3.0
     - pyinstaller==4.3
     - pyinstaller-hooks-contrib==2021.2
     - pynput==1.7.3

funscript_editor/algorithms/funscriptgenerator.py

@@ -1,12 +1,15 @@
 """ Top level process to generate the funscript actions by tracking selected features in the video """
 
 import cv2
+import os
 import copy
 import time
 import math
 import json
 import logging
+import threading
 
+from playsound import playsound
 from screeninfo import get_monitors
 from queue import Queue
 from pynput.keyboard import Key, Listener
@@ -20,7 +23,7 @@
 from funscript_editor.algorithms.videotracker import StaticVideoTracker
 from funscript_editor.data.ffmpegstream import FFmpegStream
 from funscript_editor.data.funscript import Funscript
-from funscript_editor.utils.config import HYPERPARAMETER, SETTINGS, PROJECTION
+from funscript_editor.utils.config import HYPERPARAMETER, SETTINGS, PROJECTION, NOTIFICATION_SOUND_FILE
 from funscript_editor.utils.logging import get_logfiles_paths
 from funscript_editor.definitions import SETTINGS_CONFIG_FILE, HYPERPARAMETER_CONFIG_FILE
 
@@ -278,6 +281,8 @@ def min_max_selector(self,
         cv2.putText(image, "Use 'space' to quit and set the trackbar values",
             (self.x_text_start, 100), cv2.FONT_HERSHEY_SIMPLEX, self.font_size, (255,0,0), 2)
 
+        beep_thread = threading.Thread(target=self.beep)
+        beep_thread.start()
         self.clear_keypress_queue()
         trackbarValueMin = lower_limit
         trackbarValueMax = upper_limit
@@ -298,6 +303,15 @@ def min_max_selector(self,
         return (trackbarValueMin, trackbarValueMax) if trackbarValueMin < trackbarValueMax else (trackbarValueMax, trackbarValueMin)
 
 
+    def beep(self) -> None:
+        """ Play an sound to signal an event """
+        if NOTIFICATION_SOUND_FILE is not None:
+            if os.path.exists(NOTIFICATION_SOUND_FILE):
+                playsound(NOTIFICATION_SOUND_FILE)
+            else:
+                self.logger.warning("Notification sound file not found (%s)", NOTIFICATION_SOUND_FILE)
+
+
     def calculate_score(self) -> None:
         """ Calculate the score for the predicted tracking boxes
 

funscript_editor/config/settings.yaml

@@ -19,3 +19,6 @@ preview_scaling: 0.6
 
 # Specify the tracker algorithm. Available options are 'MIL', 'KCF', 'CSRT'.
 tracker: 'CSRT'
+
+# Specify the wav file to play when tracking finished (write 'off' to disable the sound notification)
+notification_sound: 'sound_notification.wav'

funscript_editor/config/sound_notification.wav

@@ -302,6 +302,7 @@ def run(self) -> None:
         pipe = sp.Popen(
                 command,
                 stdout = sp.PIPE,
+                stderr = sp.PIPE,
                 bufsize= 3 * self.config['parameter']['height'] * self.config['parameter']['width']
             )
 
@@ -327,3 +328,6 @@ def run(self) -> None:
         pipe.terminate()
         try: pipe.stdout.close()
         except: pass
+        try: pipe.stderr.close()
+        except: pass
+

funscript_editor/data/ffmpegstream.py

@@ -3,7 +3,7 @@
 import os
 import yaml
 
-from funscript_editor.definitions import ROOT_DIR, UI_CONFIG_FILE, \
+from funscript_editor.definitions import ROOT_DIR, CONFIG_DIR, UI_CONFIG_FILE, \
         HYPERPARAMETER_CONFIG_FILE, SETTINGS_CONFIG_FILE, PROJECTION_CONFIG_FILE
 
 def read_yaml_config(config_file: str) -> dict:
@@ -45,3 +45,6 @@ def read_version() -> str:
 
 #: projection parameter
 PROJECTION = read_yaml_config(PROJECTION_CONFIG_FILE)
+
+#: notification sound file
+NOTIFICATION_SOUND_FILE = os.path.join(CONFIG_DIR, SETTINGS['notification_sound']) if SETTINGS['notification_sound'] != 'off' else None