[`media`] Made the `youtube-dl` executable configurable.

`youtube-dl` is mostly dead and there are several forks available, thus
we need to give the user the ability to pick which `youtube-dl`
executable fork they want to use.

Among these, `yt-dlp` is probably the most maintained today and it's
also included in many default repos, so it's been added as an extra
requirement for all the media plugins.

Closes: #268

platypush/plugins/media/__init__.py

@@ -14,6 +14,7 @@ import requests
 from platypush.config import Config
 from platypush.context import get_plugin, get_backend
 from platypush.plugins import Plugin, action
+from platypush.utils import get_default_downloads_dir
 
 
 class PlayerState(enum.Enum):
@@ -147,7 +148,9 @@ class MediaPlugin(Plugin, ABC):
         env: Optional[Dict[str, str]] = None,
         volume: Optional[Union[float, int]] = None,
         torrent_plugin: str = 'torrent',
-        youtube_format: str = 'best',
+        # youtube_format: Optional[str] = 'bv*[height<=?1080][ext=mp4]+bestaudio/best',
+        youtube_format: Optional[str] = 'best[height<=?1080][ext=mp4]',
+        youtube_dl: str = 'yt-dlp',
         **kwargs,
     ):
         """
@@ -169,10 +172,17 @@ class MediaPlugin(Plugin, ABC):
             - ``webtorrent`` - torrent support over webtorrent (unstable)
 
         :param youtube_format: Select the preferred video/audio format for
-            YouTube videos (default: ``best``). See the `youtube-dl
+            YouTube videos. See the `youtube-dl documentation
-            documentation
             <https://github.com/ytdl-org/youtube-dl#format-selection>`_ for more
-            info on supported formats.
+            info on supported formats. Default:
+            ``bv*[height<=?1080][ext=mp4]+bestaudio/best`` - select the best
+            mp4 video with a resolution <= 1080p, and the best audio format.
+
+        :param youtube_dl: Path to the ``youtube-dl`` executable, used to
+            extract information from YouTube videos and other media platforms.
+            Default: ``yt-dlp``. The default has changed from ``youtube-dl`` to
+            the ``yt-dlp`` fork because the former is badly maintained and its
+            latest release was pushed in 2021.
         """
 
         super().__init__(**kwargs)
@@ -216,16 +226,12 @@ class MediaPlugin(Plugin, ABC):
             os.path.expanduser(
                 download_dir
                 or player_config.get('download_dir')
-                or os.path.join(
+                or get_default_downloads_dir()
-                    (os.path.expanduser('~') or self._env.get('HOME') or '/'),
-                    'Downloads',
-                )
             )
         )
 
-        if not os.path.isdir(self.download_dir):
+        os.makedirs(self.download_dir, exist_ok=True)
-            os.makedirs(self.download_dir, exist_ok=True)
+        self._ytdl = youtube_dl
-
         self.media_dirs.add(self.download_dir)
         self.volume = volume
         self._videos_queue = []
@@ -468,7 +474,7 @@ class MediaPlugin(Plugin, ABC):
                 self.logger.exception(e)
 
         results = [
-            {'type': media_type, **result}
+            {**result, 'type': media_type}
             for media_type in self._supported_media_types
             for result in results.get(media_type, [])
             if media_type in results
@@ -580,17 +586,20 @@ class MediaPlugin(Plugin, ABC):
 
     def get_youtube_video_url(self, url, youtube_format: Optional[str] = None):
         ytdl_cmd = [
-            'youtube-dl',
+            self._ytdl,
-            '-f',
+            *(
-            youtube_format or self.youtube_format,
+                ['-f', youtube_format or self.youtube_format]
+                if youtube_format or self.youtube_format
+                else []
+            ),
             '-g',
             url,
         ]
 
         self.logger.info('Executing command %s', ' '.join(ytdl_cmd))
-        with subprocess.Popen(ytdl_cmd, stdout=subprocess.PIPE) as youtube_dl:
+        with subprocess.Popen(ytdl_cmd, stdout=subprocess.PIPE) as ytdl:
-            url = youtube_dl.communicate()[0].decode().strip()
+            url = ytdl.communicate()[0].decode().strip()
-            youtube_dl.wait()
+            ytdl.wait()
 
         return url
 
@@ -628,9 +637,7 @@ class MediaPlugin(Plugin, ABC):
         if m:
             url = f'https://www.youtube.com/watch?v={m.group(1)}'
 
-        with subprocess.Popen(
+        with subprocess.Popen([self._ytdl, '-j', url], stdout=subprocess.PIPE) as proc:
-            ['youtube-dl', '-j', url], stdout=subprocess.PIPE
-        ) as proc:
             if proc.stdout is None:
                 return None
 

platypush/plugins/media/mplayer/manifest.yaml

@@ -3,11 +3,15 @@ manifest:
   install:
     apk:
       - mplayer
+      - yt-dlp
     apt:
       - mplayer
+      - yt-dlp
     dnf:
       - mplayer
+      - yt-dlp
     pacman:
       - mplayer
+      - yt-dlp
   package: platypush.plugins.media.mplayer
   type: plugin

platypush/plugins/media/mpv/manifest.yaml

@@ -4,15 +4,20 @@ manifest:
     apk:
       - mpv
       - py3-mpv
+      - yt-dlp
     apt:
       - mpv
       - python3-mpv
+      - yt-dlp
     dnf:
       - mpv
+      - yt-dlp
     pacman:
       - mpv
       - python-mpv
+      - yt-dlp
     pip:
       - python-mpv
+      - yt-dlp
   package: platypush.plugins.media.mpv
   type: plugin

platypush/plugins/media/omxplayer/manifest.yaml

@@ -3,7 +3,9 @@ manifest:
   install:
     pip:
       - omxplayer-wrapper
+      - yt-dlp
     apt:
       - omxplayer
+      - yt-dlp
   package: platypush.plugins.media.omxplayer
   type: plugin

platypush/plugins/media/vlc/manifest.yaml

@@ -4,15 +4,20 @@ manifest:
     apk:
       - vlc
       - py3-vlc
+      - yt-dlp
     apt:
       - vlc
       - python3-vlc
+      - yt-dlp
     dnf:
       - vlc
       - python3-vlc
+      - yt-dlp
     pacman:
       - vlc
+      - yt-dlp
     pip:
       - python-vlc
+      - yt-dlp
   package: platypush.plugins.media.vlc
   type: plugin

platypush/plugins/youtube/manifest.yaml

@@ -2,28 +2,14 @@ manifest:
   events: {}
   install:
     apk:
-      - py3-google-api-python-client
+      - yt-dlp
-      - py3-google-auth
-      - py3-oauth2client
-      - py3-httplib2
     apt:
-      - python3-google-auth
+      - yt-dlp
-      - python3-oauth2client
-      - python3-httplib2
     dnf:
-      - python-google-api-client
+      - yt-dlp
-      - python-google-auth
-      - python-oauth2client
-      - python-httplib2
     pacman:
-      - python-google-api-python-client
+      - yt-dlp
-      - python-google-auth
-      - python-oauth2client
-      - python-httplib2
     pip:
-      - google-api-python-client
+      - yt-dlp
-      - google-auth
-      - oauth2client
-      - httplib2
   package: platypush.plugins.youtube
   type: plugin

setup.py

@@ -118,7 +118,7 @@ setup(
         # Support for OMXPlayer plugin
         'omxplayer': ['omxplayer-wrapper'],
         # Support for YouTube
-        'youtube': ['youtube-dl'],
+        'youtube': ['yt-dlp'],
         # Support for torrents download
         'torrent': ['python-libtorrent'],
         # Generic support for cameras