1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
|
# -*- coding: utf-8 -*-
# Copyright 2018-2025 Mike Fährmann
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.
"""Downloader module for URLs requiring youtube-dl support"""
from .common import DownloaderBase
from .. import ytdl, text
from xml.etree import ElementTree
import os
class YoutubeDLDownloader(DownloaderBase):
scheme = "ytdl"
def __init__(self, job):
DownloaderBase.__init__(self, job)
extractor = job.extractor
retries = self.config("retries", extractor._retries)
self.ytdl_opts = {
"retries": retries+1 if retries >= 0 else float("inf"),
"socket_timeout": self.config("timeout", extractor._timeout),
"nocheckcertificate": not self.config("verify", extractor._verify),
"proxy": self.proxies.get("http") if self.proxies else None,
"ignoreerrors": True,
}
self.ytdl_instance = None
self.rate_dyn = None
self.forward_cookies = self.config("forward-cookies", True)
self.progress = self.config("progress", 3.0)
self.outtmpl = self.config("outtmpl")
def download(self, url, pathfmt):
kwdict = pathfmt.kwdict
ytdl_instance = kwdict.pop("_ytdl_instance", None)
if not ytdl_instance:
ytdl_instance = self.ytdl_instance
if not ytdl_instance:
try:
module = ytdl.import_module(self.config("module"))
except (ImportError, SyntaxError) as exc:
self.log.error("Cannot import module '%s'",
getattr(exc, "name", ""))
self.log.debug("", exc_info=exc)
self.download = lambda u, p: False
return False
try:
ytdl_version = module.version.__version__
except Exception:
ytdl_version = ""
self.log.debug("Using %s version %s", module, ytdl_version)
self.ytdl_instance = ytdl_instance = ytdl.construct_YoutubeDL(
module, self, self.ytdl_opts)
if self.outtmpl == "default":
self.outtmpl = module.DEFAULT_OUTTMPL
if self.forward_cookies:
self.log.debug("Forwarding cookies to %s",
ytdl_instance.__module__)
set_cookie = ytdl_instance.cookiejar.set_cookie
for cookie in self.session.cookies:
set_cookie(cookie)
if "__gdl_initialize" in ytdl_instance.params:
del ytdl_instance.params["__gdl_initialize"]
if self.progress is not None:
ytdl_instance.add_progress_hook(self._progress_hook)
if rlf := ytdl_instance.params.pop("__gdl_ratelimit_func", False):
self.rate_dyn = rlf
info_dict = kwdict.pop("_ytdl_info_dict", None)
if not info_dict:
url = url[5:]
try:
if manifest := kwdict.pop("_ytdl_manifest", None):
info_dict = self._extract_manifest(
ytdl_instance, url, manifest,
kwdict.pop("_ytdl_manifest_data", None),
kwdict.pop("_ytdl_manifest_headers", None))
else:
info_dict = self._extract_info(ytdl_instance, url)
except Exception as exc:
self.log.debug("", exc_info=exc)
self.log.warning("%s: %s", exc.__class__.__name__, exc)
if not info_dict:
return False
if "entries" in info_dict:
index = kwdict.get("_ytdl_index")
if index is None:
return self._download_playlist(
ytdl_instance, pathfmt, info_dict)
else:
info_dict = info_dict["entries"][index]
if extra := kwdict.get("_ytdl_extra"):
info_dict.update(extra)
return self._download_video(ytdl_instance, pathfmt, info_dict)
def _download_video(self, ytdl_instance, pathfmt, info_dict):
if "url" in info_dict:
if "filename" in pathfmt.kwdict:
pathfmt.kwdict["extension"] = \
text.ext_from_url(info_dict["url"])
else:
text.nameext_from_url(info_dict["url"], pathfmt.kwdict)
formats = info_dict.get("requested_formats")
if formats and not compatible_formats(formats):
info_dict["ext"] = "mkv"
elif "ext" not in info_dict:
try:
info_dict["ext"] = info_dict["formats"][0]["ext"]
except LookupError:
info_dict["ext"] = "mp4"
if self.outtmpl:
self._set_outtmpl(ytdl_instance, self.outtmpl)
pathfmt.filename = filename = \
ytdl_instance.prepare_filename(info_dict)
pathfmt.extension = info_dict["ext"]
pathfmt.path = pathfmt.directory + filename
pathfmt.realpath = pathfmt.temppath = (
pathfmt.realdirectory + filename)
else:
pathfmt.set_extension(info_dict["ext"])
pathfmt.build_path()
if pathfmt.exists():
pathfmt.temppath = ""
return True
if self.rate_dyn is not None:
# static ratelimits are set in ytdl.construct_YoutubeDL
ytdl_instance.params["ratelimit"] = self.rate_dyn()
self.out.start(pathfmt.path)
if self.part:
pathfmt.kwdict["extension"] = pathfmt.prefix
filename = pathfmt.build_filename(pathfmt.kwdict)
pathfmt.kwdict["extension"] = info_dict["ext"]
if self.partdir:
path = os.path.join(self.partdir, filename)
else:
path = pathfmt.realdirectory + filename
path = path.replace("%", "%%") + "%(ext)s"
else:
path = pathfmt.realpath.replace("%", "%%")
self._set_outtmpl(ytdl_instance, path)
try:
ytdl_instance.process_info(info_dict)
except Exception as exc:
self.log.debug("", exc_info=exc)
return False
pathfmt.temppath = info_dict.get("filepath") or info_dict["_filename"]
return True
def _download_playlist(self, ytdl_instance, pathfmt, info_dict):
pathfmt.kwdict["extension"] = pathfmt.prefix
filename = pathfmt.build_filename(pathfmt.kwdict)
pathfmt.kwdict["extension"] = pathfmt.extension
path = pathfmt.realdirectory + filename
path = path.replace("%", "%%") + "%(playlist_index)s.%(ext)s"
self._set_outtmpl(ytdl_instance, path)
status = False
for entry in info_dict["entries"]:
if not entry:
continue
if self.rate_dyn is not None:
ytdl_instance.params["ratelimit"] = self.rate_dyn()
try:
ytdl_instance.process_info(entry)
status = True
except Exception as exc:
self.log.debug("", exc_info=exc)
self.log.error("%s: %s", exc.__class__.__name__, exc)
return status
def _extract_info(self, ytdl, url):
return ytdl.extract_info(url, download=False)
def _extract_manifest(self, ytdl, url, manifest_type, manifest_data=None,
headers=None):
extr = ytdl.get_info_extractor("Generic")
video_id = extr._generic_id(url)
if manifest_type == "hls":
if manifest_data is None:
try:
fmts, subs = extr._extract_m3u8_formats_and_subtitles(
url, video_id, "mp4", headers=headers)
except AttributeError:
fmts = extr._extract_m3u8_formats(
url, video_id, "mp4", headers=headers)
subs = None
else:
try:
fmts, subs = extr._parse_m3u8_formats_and_subtitles(
url, video_id, "mp4")
except AttributeError:
fmts = extr._parse_m3u8_formats(url, video_id, "mp4")
subs = None
elif manifest_type == "dash":
if manifest_data is None:
try:
fmts, subs = extr._extract_mpd_formats_and_subtitles(
url, video_id, headers=headers)
except AttributeError:
fmts = extr._extract_mpd_formats(
url, video_id, headers=headers)
subs = None
else:
if isinstance(manifest_data, str):
manifest_data = ElementTree.fromstring(manifest_data)
try:
fmts, subs = extr._parse_mpd_formats_and_subtitles(
manifest_data, mpd_id="dash")
except AttributeError:
fmts = extr._parse_mpd_formats(
manifest_data, mpd_id="dash")
subs = None
else:
self.log.error("Unsupported manifest type '%s'", manifest_type)
return None
info_dict = {
"extractor": "",
"id" : video_id,
"title" : video_id,
"formats" : fmts,
"subtitles": subs,
}
return ytdl.process_ie_result(info_dict, download=False)
def _progress_hook(self, info):
if info["status"] == "downloading" and \
info["elapsed"] >= self.progress:
total = info.get("total_bytes") or info.get("total_bytes_estimate")
speed = info.get("speed")
self.out.progress(
None if total is None else int(total),
info["downloaded_bytes"],
int(speed) if speed else 0,
)
def _set_outtmpl(self, ytdl_instance, outtmpl):
try:
ytdl_instance._parse_outtmpl
except AttributeError:
try:
ytdl_instance.outtmpl_dict["default"] = outtmpl
except AttributeError:
ytdl_instance.params["outtmpl"] = outtmpl
else:
ytdl_instance.params["outtmpl"] = {"default": outtmpl}
def compatible_formats(formats):
"""Returns True if 'formats' are compatible for merge"""
video_ext = formats[0].get("ext")
audio_ext = formats[1].get("ext")
if video_ext == "webm" and audio_ext == "webm":
return True
exts = ("mp3", "mp4", "m4a", "m4p", "m4b", "m4r", "m4v", "ismv", "isma")
return video_ext in exts and audio_ext in exts
__downloader__ = YoutubeDLDownloader
|
