player: support media decryption keys for mpv (#1050)

Author: BruceZhang1993

feeluown/library/provider_protocol.py

@@ -98,6 +98,7 @@ def song_select_media(
         """Select a media by the quality sorting policy
 
         If the song has some valid medias, this method can always return one of them.
+        Providers may return a Media object with decryption_key for DRM streams.
         """
         raise NotImplementedError
 
@@ -108,6 +109,7 @@ def song_get_media(
         """Get song's media by a specified quality
 
         :return: when quality is invalid, return None
+        Providers may return a Media object with decryption_key for DRM streams.
         """
         raise NotImplementedError
 
@@ -244,10 +246,18 @@ def video_list_quality(self, video: BriefVideoModel) -> List[Quality.Video]:
     def video_select_media(
         self, video: BriefVideoModel, policy=None
     ) -> Tuple[Media, Quality.Video]:
+        """Select a media by quality.
+
+        Providers may return a Media object with decryption_key for DRM streams.
+        """
         raise NotImplementedError
 
     @abstractmethod
     def video_get_media(self, video: BriefVideoModel, quality) -> Optional[Media]:
+        """Get video's media by a specified quality.
+
+        Providers may return a Media object with decryption_key for DRM streams.
+        """
         raise NotImplementedError
 
 

feeluown/media.py

@@ -226,6 +226,7 @@ class Media:
     def __init__(self, obj, type_=MediaType.audio,
                  http_headers=None,
                  http_proxy=None,
+                 decryption_key=None,
                  **kwargs):
         if isinstance(obj, Media):
             self._copy(obj)
@@ -244,10 +245,14 @@ def __init__(self, obj, type_=MediaType.audio,
         self.http_headers = http_headers or {}
         # Example: http://127.0.0.1:7890
         self.http_proxy = http_proxy or ''
+        # Optional DRM decryption key forwarded to mpv as demuxer-lavf-o.
+        self.decryption_key = decryption_key
 
     def _copy(self, media):
         self.url = media.url
         self.http_headers = media.http_headers
+        self.http_proxy = media.http_proxy
+        self.decryption_key = media.decryption_key
         self.type_ = media.type_
         self._props = media._props
         self._manifest = media.manifest

feeluown/player/mpvplayer.py

@@ -129,6 +129,7 @@ def play(self, media, video=True, metadata=None):
                 media = Media(media)
             self._set_http_headers(media.http_headers)
             self._set_http_proxy(media.http_proxy)
+            self._set_decryption_key(media.decryption_key)
             self._stop_mpv()
             if media.manifest is None:
                 url = media.url
@@ -365,6 +366,13 @@ def _set_http_proxy(self, http_proxy):
             self._mpv.handle, b'http-proxy', bytes(http_proxy, 'utf-8')
         )
 
+    def _set_decryption_key(self, decryption_key):
+        if decryption_key is not None:
+            value = bytes(f'decryption_key={decryption_key}', 'utf-8')
+        else:
+            value = b''
+        _mpv_set_option_string(self._mpv.handle, b'demuxer-lavf-o', value)
+
     def __log_handler(self, loglevel, component, message):
         print('[{}] {}: {}'.format(loglevel, component, message))
 

tests/player/test_player.py

@@ -110,6 +110,30 @@ def test_play_media_with_http_headers(self, mock_set_option_string):
         assert mock_set_option_string.called
         self.player.stop()
 
+    @mock.patch('feeluown.player.mpvplayer._mpv_set_option_string')
+    def test_play_media_with_decryption_key(self, mock_set_option_string):
+        media = Media('http://xxx', decryption_key='0123456789abcdef')
+        self.player.play(media)
+
+        mock_set_option_string.assert_any_call(
+            self.player._mpv.handle,
+            b'demuxer-lavf-o',
+            b'decryption_key=0123456789abcdef',
+        )
+        self.player.stop()
+
+    @mock.patch('feeluown.player.mpvplayer._mpv_set_option_string')
+    def test_play_media_without_decryption_key_clears_mpv_option(
+        self, mock_set_option_string
+    ):
+        media = Media('http://xxx')
+        self.player.play(media)
+
+        mock_set_option_string.assert_any_call(
+            self.player._mpv.handle, b'demuxer-lavf-o', b''
+        )
+        self.player.stop()
+
 
 class TestPlaylist(TestCase):
     def setUp(self):

tests/test_media.py

@@ -12,7 +12,22 @@ def media():
 def test_media_copy(media):
     media2 = Media(media)
     assert media2.http_headers == media.http_headers
+    assert media2.http_proxy == media.http_proxy
+    assert media2.decryption_key == media.decryption_key
 
 
 def test_media_http_headers(media):
     assert 'referer' in media.http_headers
+
+
+def test_media_decryption_key_default_is_none():
+    media = Media('zzz://xxx.yyy')
+
+    assert media.decryption_key is None
+
+
+def test_media_decryption_key(media):
+    media.decryption_key = '0123456789abcdef'
+    media2 = Media(media)
+
+    assert media2.decryption_key == '0123456789abcdef'