feat(linux): enable experimental renderer by default

Author: trin94

docs/configuration.md

@@ -21,3 +21,10 @@ mpvQC can be configured using the following environment variables:
   - **Operating System:** All
   - **Description:** Enables mpv player logging
   - **Possible Values:** *not set* or *any value*
+
+- **`MPVQC_LINUX_EXPERIMENTAL_RENDERER`**
+
+  - **Default Value:** true
+  - **Operating System:** Linux
+  - **Description:** Enables rendering in background thread
+  - **Possible Values:** *false* to revert back to stable renderer, unset to enable

mpvqc/services/player.py

@@ -6,12 +6,13 @@
 
 import logging
 import os
+import platform
 from dataclasses import dataclass
 from pathlib import Path
 from typing import TYPE_CHECKING
 
 import inject
-from PySide6.QtCore import QObject, Qt, Signal
+from PySide6.QtCore import QObject, Qt, Signal, Slot
 
 from .application_paths import ApplicationPathsService
 from .host_integration import HostIntegrationService
@@ -106,6 +107,10 @@ def init(self, win_id: int | None = None):
         self._mpv.observe_property("height", self._on_player_height_changed)
         self._mpv.observe_property("width", self._on_player_width_changed)
 
+        if platform.system() == "Linux" and os.getenv("MPVQC_LINUX_EXPERIMENTAL_RENDERER", "").lower() != "false":
+            self._host_integration.refresh_rate_changed.connect(self._on_refresh_rate_changed)
+            self._on_refresh_rate_changed(self._host_integration.refresh_rate)
+
     @property
     def mpv(self) -> MPV | None:
         return self._mpv
@@ -115,6 +120,11 @@ def _get_mpv_attr(self, attr: str) -> Any | None:
             return None
         return getattr(self._mpv, attr, None)
 
+    def _set_mpv_attr(self, attr: str, value: Any) -> None:
+        if self._mpv is None:
+            return
+        setattr(self._mpv, attr, value)
+
     @property
     def mpv_version(self) -> str:
         return self._get_mpv_attr("mpv_version") or ""
@@ -238,6 +248,17 @@ def _on_player_width_changed(self, _, value: int) -> None:
         if value is not None:
             self.width_changed.emit(value)
 
+    @Slot(float)
+    def _on_refresh_rate_changed(self, new_refresh_rate: float) -> None:
+        if new_refresh_rate is None:
+            return
+
+        refresh_rate = round(new_refresh_rate, 4)
+        audio_delay = round(1 / refresh_rate, 4)
+
+        logger.info("Adjusting audio_delay to %s due to updated refresh rate %s", audio_delay, refresh_rate)
+        self._set_mpv_attr("audio_delay", audio_delay)
+
     def move_mouse(self, x: int, y: int) -> None:
         zoom_factor = self._host_integration.display_zoom_factor
         x = int(x * zoom_factor)

mpvqc/views/__init__.py

@@ -3,5 +3,21 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 # ruff: noqa: F401
-from .player_framebuffer_object import MpvqcMpvFrameBufferObjectPyObject
+
+import logging
+import os
+import platform
+
+logger = logging.getLogger(__name__)
+
+if platform.system() == "Linux":
+    if os.getenv("MPVQC_LINUX_EXPERIMENTAL_RENDERER", "").lower() == "false":
+        logger.info("Using default renderer. Unset MPVQC_LINUX_EXPERIMENTAL_RENDERER to enable experimental renderer")
+        from .player_framebuffer_object import MpvqcMpvFrameBufferObjectPyObject
+    else:
+        logger.info("Using experimental renderer. Set MPVQC_LINUX_EXPERIMENTAL_RENDERER=false to disable")
+        from .player_framebuffer_object_offscreen import MpvqcMpvFrameBufferObjectPyObject
+else:
+    from .player_framebuffer_object import MpvqcMpvFrameBufferObjectPyObject
+
 from .player_win_id import MpvWindowPyObject