feat: mpdstats: adds config option for remaining time threshold to determine if track was played. (#5657)

Add new configuration option for mpdstats plugin,
`played_ratio_threshold`, to allow configuring the percentage the song
must be played for it to be counted as played instead of skipped.

Author: snejus

beetsplug/mpdstats.py

@@ -27,6 +27,7 @@
 # much time should we wait between retries?
 RETRIES = 10
 RETRY_INTERVAL = 5
+DUPLICATE_PLAY_THRESHOLD = 10.0
 
 
 mpd_config = config["mpd"]
@@ -143,7 +144,9 @@ def __init__(self, lib, log):
 
         self.do_rating = mpd_config["rating"].get(bool)
         self.rating_mix = mpd_config["rating_mix"].get(float)
-        self.time_threshold = 10.0  # TODO: maybe add config option?
+        self.played_ratio_threshold = mpd_config["played_ratio_threshold"].get(
+            float
+        )
 
         self.now_playing = None
         self.mpd = MPDClientWrapper(log)
@@ -216,10 +219,8 @@ def handle_song_change(self, song):
 
         Returns whether the change was manual (skipped previous song or not)
         """
-        diff = abs(song["remaining"] - (time.time() - song["started"]))
-
-        skipped = diff >= self.time_threshold
-
+        elapsed = song["elapsed_at_start"] + (time.time() - song["started"])
+        skipped = elapsed / song["duration"] < self.played_ratio_threshold
         if skipped:
             self.handle_skipped(song)
         else:
@@ -256,13 +257,10 @@ def on_pause(self, status):
 
     def on_play(self, status):
         path, songid = self.mpd.currentsong()
-
         if not path:
             return
 
         played, duration = map(int, status["time"].split(":", 1))
-        remaining = duration - played
-
         if self.now_playing:
             if self.now_playing["path"] != path:
                 self.handle_song_change(self.now_playing)
@@ -273,7 +271,7 @@ def on_play(self, status):
                 # after natural song start.
                 diff = abs(time.time() - self.now_playing["started"])
 
-                if diff <= self.time_threshold:
+                if diff <= DUPLICATE_PLAY_THRESHOLD:
                     return
 
                 if self.now_playing["path"] == path and played == 0:
@@ -288,7 +286,8 @@ def on_play(self, status):
 
         self.now_playing = {
             "started": time.time(),
-            "remaining": remaining,
+            "elapsed_at_start": played,
+            "duration": duration,
             "path": path,
             "id": songid,
             "beets_item": self.get_item(path),
@@ -337,6 +336,7 @@ def __init__(self):
                 "host": os.environ.get("MPD_HOST", "localhost"),
                 "port": int(os.environ.get("MPD_PORT", 6600)),
                 "password": "",
+                "played_ratio_threshold": 0.85,
             }
         )
         mpd_config["password"].redact = True

docs/changelog.rst

@@ -30,6 +30,9 @@ New features:
   :bug:`5829`
 * :doc:`plugins/mbcollection`: When getting the user collections, only consider
   collections of releases, and ignore collections of other entity types.
+* :doc:`plugins/mpdstats`: Add new configuration option,
+  ``played_ratio_threshold``, to allow configuring the percentage the song must
+  be played for it to be counted as played instead of skipped.
 
 Bug fixes:
 

docs/plugins/mpdstats.rst

@@ -58,6 +58,9 @@ configuration file. The available options are:
   Default: ``yes``.
 - **rating_mix**: Tune the way rating is calculated (see below).
   Default: 0.75.
+- **played_ratio_threshold**: If a song was played for less than this percentage
+  of its duration it will be considered a skip.
+  Default: 0.85
 
 A Word on Ratings
 -----------------