fix: Transposing hangs when ffmpeg does not have librubberband (#435)

Fix for #427
vicwomg · Dec 24, 2024 · 8939e60 · 8939e60
1 parent 3ea46de
commit 8939e60
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 3 deletions.
diff --git a/pikaraoke/app.py b/pikaraoke/app.py
@@ -111,6 +111,7 @@ def home():
         title="Home",
         transpose_value=k.now_playing_transpose,
         admin=is_admin(),
+        is_transpose_enabled=k.is_transpose_enabled,
     )
 
 
@@ -164,6 +165,7 @@ def nowplaying():
             "is_paused": k.is_paused,
             "transpose_value": k.now_playing_transpose,
             "volume": k.volume,
+            # "is_transpose_enabled": k.is_transpose_enabled,
         }
         rc["hash"] = hash_dict(rc)  # used to detect changes in the now playing data
         return json.dumps(rc)
@@ -582,6 +584,7 @@ def info():
         cpu=cpu,
         disk=disk,
         ffmpeg_version=k.ffmpeg_version,
+        is_transpose_enabled=k.is_transpose_enabled,
         youtubedl_version=youtubedl_version,
         platform=k.platform,
         os_version=k.os_version,

diff --git a/pikaraoke/karaoke.py b/pikaraoke/karaoke.py
@@ -22,6 +22,7 @@
     get_os_version,
     get_platform,
     is_raspberry_pi,
+    is_transpose_enabled,
     supports_hardware_h264_encoding,
 )
 
@@ -66,6 +67,7 @@ class Karaoke:
     ffmpeg_process = None
     ffmpeg_log = None
     ffmpeg_version = get_ffmpeg_version()
+    is_transpose_enabled = is_transpose_enabled()
     supports_hardware_h264_encoding = supports_hardware_h264_encoding()
     normalize_audio = False
 
@@ -144,6 +146,7 @@ def __init__(
     platform: {self.platform}
     os version: {self.os_version}
     ffmpeg version: {self.ffmpeg_version}
+    ffmpeg transpose support: {self.is_transpose_enabled}
     hardware h264 encoding: {self.supports_hardware_h264_encoding}
     youtubedl-version: {self.get_youtubedl_version()}
 """

diff --git a/pikaraoke/lib/get_platform.py b/pikaraoke/lib/get_platform.py
@@ -21,6 +21,18 @@ def get_ffmpeg_version():
         return "Unable to parse FFmpeg version"
 
 
+def is_transpose_enabled():
+    try:
+        filters = subprocess.run(["ffmpeg", "-filters"], capture_output=True)
+    except FileNotFoundError:
+        # FFmpeg is not installed
+        return False
+    except IndexError:
+        # Unable to parse FFmpeg filters
+        return False
+    return "rubberband" in filters.stdout.decode()
+
+
 def is_raspberry_pi():
     try:
         return (

diff --git a/pikaraoke/templates/home.html b/pikaraoke/templates/home.html
@@ -82,8 +82,10 @@
     $(".control-box").hide();
 
     var slider = document.getElementById("transpose");
+    console.log("slider returned: ", slider)
     var output = document.getElementById("semitones-label");
-    if (slider) {
+    console.log("output returned: ", output)
+    if (slider && output) {
       output.innerHTML = getSemitonesLabel(slider.value);
       // Update the current slider value (each time you drag the slider handle)
       slider.oninput = function () {
@@ -230,6 +232,8 @@ <h4>{% trans %}Player Control{% endtrans %}</h4>
     </div>
   </div>
   <hr />
+
+  {% if is_transpose_enabled %}
   <div class="is-flex" style="justify-content: space-between">
     <div>
       {# MSG: Title of a control to change the key/pitch of the playing song. #}
@@ -242,7 +246,6 @@ <h4 id="semitones-label"></h4>
       ></a>
     </div>
   </div>
-
   <div style="width: 100%">
     <div class="is-flex">
       <input
@@ -265,6 +268,7 @@ <h4 id="semitones-label"></h4>
       </button>
     </div>
   </div>
+  {% endif %}
 </div>
 {% endif %}
 

diff --git a/pikaraoke/templates/info.html b/pikaraoke/templates/info.html
@@ -84,7 +84,7 @@ <h1>{% trans %}System Info{% endtrans %}</h1>
   {# MSG: The version of the program "Youtube-dl". #}
   <li><u>{% trans %}Youtube-dl (yt-dlp) version:{% endtrans %}</u> {{ youtubedl_version }}</li>
   {# MSG: The version of the program "ffmpeg". #}
-  <li><u>{% trans %}FFmpeg version:{% endtrans %}</u> {{ ffmpeg_version }}</li>
+  <li><u>{% trans %}FFmpeg version:{% endtrans %}</u> {{ ffmpeg_version }} {% if not is_transpose_enabled %} (missing lib-rubberband, pitch shift is not supported) {% endif %}</li>
   {# MSG: The version of Pikaraoke running right now. #}
   <li><u>{% trans %}Pikaraoke version:{% endtrans %}</u> {{ pikaraoke_version }}</li>
 </ul>