1 from __future__
import unicode_literals
9 from .common
import FileDownloader
10 from ..aes
import aes_cbc_decrypt_bytes
11 from ..compat
import (
16 from ..postprocessor
.ffmpeg
import FFmpegPostProcessor
, EXT_TO_OUT_FORMATS
24 handle_youtubedl_headers
,
27 process_communicate_or_kill
,
33 class ExternalFD(FileDownloader
):
34 SUPPORTED_PROTOCOLS
= ('http', 'https', 'ftp', 'ftps')
35 can_download_to_stdout
= False
37 def real_download(self
, filename
, info_dict
):
38 self
.report_destination(filename
)
39 tmpfilename
= self
.temp_name(filename
)
43 retval
= self
._call
_downloader
(tmpfilename
, info_dict
)
44 except KeyboardInterrupt:
45 if not info_dict
.get('is_live'):
47 # Live stream downloading cancellation should be considered as
48 # correct and expected termination thus all postprocessing
51 self
.to_screen('[%s] Interrupted by user' % self
.get_basename())
57 'elapsed': time
.time() - started
,
60 fsize
= os
.path
.getsize(encodeFilename(tmpfilename
))
61 self
.to_screen('\r[%s] Downloaded %s bytes' % (self
.get_basename(), fsize
))
62 self
.try_rename(tmpfilename
, filename
)
64 'downloaded_bytes': fsize
,
67 self
._hook
_progress
(status
, info_dict
)
71 self
.report_error('%s exited with code %d' % (
72 self
.get_basename(), retval
))
76 def get_basename(cls
):
77 return cls
.__name
__[:-2].lower()
81 return self
.get_basename()
84 def available(cls
, path
=None):
85 path
= check_executable(path
or cls
.get_basename(), [cls
.AVAILABLE_OPT
])
92 def supports(cls
, info_dict
):
94 (cls
.can_download_to_stdout
or not info_dict
.get('to_stdout'))
95 and info_dict
['protocol'] in cls
.SUPPORTED_PROTOCOLS
)
98 def can_download(cls
, info_dict
, path
=None):
99 return cls
.available(path
) and cls
.supports(info_dict
)
101 def _option(self
, command_option
, param
):
102 return cli_option(self
.params
, command_option
, param
)
104 def _bool_option(self
, command_option
, param
, true_value
='true', false_value
='false', separator
=None):
105 return cli_bool_option(self
.params
, command_option
, param
, true_value
, false_value
, separator
)
107 def _valueless_option(self
, command_option
, param
, expected_value
=True):
108 return cli_valueless_option(self
.params
, command_option
, param
, expected_value
)
110 def _configuration_args(self
, keys
=None, *args
, **kwargs
):
111 return _configuration_args(
112 self
.get_basename(), self
.params
.get('external_downloader_args'), self
.get_basename(),
113 keys
, *args
, **kwargs
)
115 def _call_downloader(self
, tmpfilename
, info_dict
):
116 """ Either overwrite this or implement _make_cmd """
117 cmd
= [encodeArgument(a
) for a
in self
._make
_cmd
(tmpfilename
, info_dict
)]
121 if 'fragments' in info_dict
:
122 fragment_retries
= self
.params
.get('fragment_retries', 0)
123 skip_unavailable_fragments
= self
.params
.get('skip_unavailable_fragments', True)
126 while count
<= fragment_retries
:
127 p
= subprocess
.Popen(
128 cmd
, stderr
=subprocess
.PIPE
)
129 _
, stderr
= process_communicate_or_kill(p
)
130 if p
.returncode
== 0:
132 # TODO: Decide whether to retry based on error code
133 # https://aria2.github.io/manual/en/html/aria2c.html#exit-status
134 self
.to_stderr(stderr
.decode('utf-8', 'replace'))
136 if count
<= fragment_retries
:
138 '[%s] Got error. Retrying fragments (attempt %d of %s)...'
139 % (self
.get_basename(), count
, self
.format_retries(fragment_retries
)))
140 if count
> fragment_retries
:
141 if not skip_unavailable_fragments
:
142 self
.report_error('Giving up after %s fragment retries' % fragment_retries
)
145 dest
, _
= sanitize_open(tmpfilename
, 'wb')
146 for frag_index
, fragment
in enumerate(info_dict
['fragments']):
147 fragment_filename
= '%s-Frag%d' % (tmpfilename
, frag_index
)
149 src
, _
= sanitize_open(fragment_filename
, 'rb')
151 if skip_unavailable_fragments
and frag_index
> 1:
152 self
.to_screen('[%s] Skipping fragment %d ...' % (self
.get_basename(), frag_index
))
154 self
.report_error('Unable to open fragment %d' % frag_index
)
156 decrypt_info
= fragment
.get('decrypt_info')
158 if decrypt_info
['METHOD'] == 'AES-128':
159 iv
= decrypt_info
.get('IV') or compat_struct_pack('>8xq', fragment
['media_sequence'])
160 decrypt_info
['KEY'] = decrypt_info
.get('KEY') or self
.ydl
.urlopen(
161 self
._prepare
_url
(info_dict
, info_dict
.get('_decryption_key_url') or decrypt_info
['URI'])).read()
162 encrypted_data
= src
.read()
163 decrypted_data
= aes_cbc_decrypt_bytes(encrypted_data
, decrypt_info
['KEY'], iv
)
164 dest
.write(decrypted_data
)
166 fragment_data
= src
.read()
167 dest
.write(fragment_data
)
169 fragment_data
= src
.read()
170 dest
.write(fragment_data
)
172 if not self
.params
.get('keep_fragments', False):
173 os
.remove(encodeFilename(fragment_filename
))
175 os
.remove(encodeFilename('%s.frag.urls' % tmpfilename
))
177 p
= subprocess
.Popen(
178 cmd
, stderr
=subprocess
.PIPE
)
179 _
, stderr
= process_communicate_or_kill(p
)
180 if p
.returncode
!= 0:
181 self
.to_stderr(stderr
.decode('utf-8', 'replace'))
184 def _prepare_url(self
, info_dict
, url
):
185 headers
= info_dict
.get('http_headers')
186 return sanitized_Request(url
, None, headers
) if headers
else url
189 class CurlFD(ExternalFD
):
192 def _make_cmd(self
, tmpfilename
, info_dict
):
193 cmd
= [self
.exe
, '--location', '-o', tmpfilename
]
194 if info_dict
.get('http_headers') is not None:
195 for key
, val
in info_dict
['http_headers'].items():
196 cmd
+= ['--header', '%s: %s' % (key
, val
)]
198 cmd
+= self
._bool
_option
('--continue-at', 'continuedl', '-', '0')
199 cmd
+= self
._valueless
_option
('--silent', 'noprogress')
200 cmd
+= self
._valueless
_option
('--verbose', 'verbose')
201 cmd
+= self
._option
('--limit-rate', 'ratelimit')
202 retry
= self
._option
('--retry', 'retries')
204 if retry
[1] in ('inf', 'infinite'):
205 retry
[1] = '2147483647'
207 cmd
+= self
._option
('--max-filesize', 'max_filesize')
208 cmd
+= self
._option
('--interface', 'source_address')
209 cmd
+= self
._option
('--proxy', 'proxy')
210 cmd
+= self
._valueless
_option
('--insecure', 'nocheckcertificate')
211 cmd
+= self
._configuration
_args
()
212 cmd
+= ['--', info_dict
['url']]
215 def _call_downloader(self
, tmpfilename
, info_dict
):
216 cmd
= [encodeArgument(a
) for a
in self
._make
_cmd
(tmpfilename
, info_dict
)]
220 # curl writes the progress to stderr so don't capture it.
221 p
= subprocess
.Popen(cmd
)
222 process_communicate_or_kill(p
)
226 class AxelFD(ExternalFD
):
229 def _make_cmd(self
, tmpfilename
, info_dict
):
230 cmd
= [self
.exe
, '-o', tmpfilename
]
231 if info_dict
.get('http_headers') is not None:
232 for key
, val
in info_dict
['http_headers'].items():
233 cmd
+= ['-H', '%s: %s' % (key
, val
)]
234 cmd
+= self
._configuration
_args
()
235 cmd
+= ['--', info_dict
['url']]
239 class WgetFD(ExternalFD
):
240 AVAILABLE_OPT
= '--version'
242 def _make_cmd(self
, tmpfilename
, info_dict
):
243 cmd
= [self
.exe
, '-O', tmpfilename
, '-nv', '--no-cookies']
244 if info_dict
.get('http_headers') is not None:
245 for key
, val
in info_dict
['http_headers'].items():
246 cmd
+= ['--header', '%s: %s' % (key
, val
)]
247 cmd
+= self
._option
('--limit-rate', 'ratelimit')
248 retry
= self
._option
('--tries', 'retries')
250 if retry
[1] in ('inf', 'infinite'):
253 cmd
+= self
._option
('--bind-address', 'source_address')
254 cmd
+= self
._option
('--proxy', 'proxy')
255 cmd
+= self
._valueless
_option
('--no-check-certificate', 'nocheckcertificate')
256 cmd
+= self
._configuration
_args
()
257 cmd
+= ['--', info_dict
['url']]
261 class Aria2cFD(ExternalFD
):
263 SUPPORTED_PROTOCOLS
= ('http', 'https', 'ftp', 'ftps', 'dash_frag_urls', 'm3u8_frag_urls')
266 def supports_manifest(manifest
):
267 UNSUPPORTED_FEATURES
= [
268 r
'#EXT-X-BYTERANGE', # playlists composed of byte ranges of media files [1]
269 # 1. https://tools.ietf.org/html/draft-pantos-http-live-streaming-17#section-4.3.2.2
271 check_results
= (not re
.search(feature
, manifest
) for feature
in UNSUPPORTED_FEATURES
)
272 return all(check_results
)
274 def _make_cmd(self
, tmpfilename
, info_dict
):
275 cmd
= [self
.exe
, '-c',
276 '--console-log-level=warn', '--summary-interval=0', '--download-result=hide',
277 '--file-allocation=none', '-x16', '-j16', '-s16']
278 if 'fragments' in info_dict
:
279 cmd
+= ['--allow-overwrite=true', '--allow-piece-length-change=true']
281 cmd
+= ['--min-split-size', '1M']
283 if info_dict
.get('http_headers') is not None:
284 for key
, val
in info_dict
['http_headers'].items():
285 cmd
+= ['--header', '%s: %s' % (key
, val
)]
286 cmd
+= self
._option
('--max-overall-download-limit', 'ratelimit')
287 cmd
+= self
._option
('--interface', 'source_address')
288 cmd
+= self
._option
('--all-proxy', 'proxy')
289 cmd
+= self
._bool
_option
('--check-certificate', 'nocheckcertificate', 'false', 'true', '=')
290 cmd
+= self
._bool
_option
('--remote-time', 'updatetime', 'true', 'false', '=')
291 cmd
+= self
._configuration
_args
()
293 # aria2c strips out spaces from the beginning/end of filenames and paths.
294 # We work around this issue by adding a "./" to the beginning of the
295 # filename and relative path, and adding a "/" at the end of the path.
296 # See: https://github.com/yt-dlp/yt-dlp/issues/276
297 # https://github.com/ytdl-org/youtube-dl/issues/20312
298 # https://github.com/aria2/aria2/issues/1373
299 dn
= os
.path
.dirname(tmpfilename
)
301 if not os
.path
.isabs(dn
):
302 dn
= '.%s%s' % (os
.path
.sep
, dn
)
303 cmd
+= ['--dir', dn
+ os
.path
.sep
]
304 if 'fragments' not in info_dict
:
305 cmd
+= ['--out', '.%s%s' % (os
.path
.sep
, os
.path
.basename(tmpfilename
))]
306 cmd
+= ['--auto-file-renaming=false']
308 if 'fragments' in info_dict
:
309 cmd
+= ['--file-allocation=none', '--uri-selector=inorder']
310 url_list_file
= '%s.frag.urls' % tmpfilename
312 for frag_index
, fragment
in enumerate(info_dict
['fragments']):
313 fragment_filename
= '%s-Frag%d' % (os
.path
.basename(tmpfilename
), frag_index
)
314 url_list
.append('%s\n\tout=%s' % (fragment
['url'], fragment_filename
))
315 stream
, _
= sanitize_open(url_list_file
, 'wb')
316 stream
.write('\n'.join(url_list
).encode('utf-8'))
318 cmd
+= ['-i', url_list_file
]
320 cmd
+= ['--', info_dict
['url']]
324 class HttpieFD(ExternalFD
):
325 AVAILABLE_OPT
= '--version'
328 def available(cls
, path
=None):
329 return ExternalFD
.available(cls
, path
or 'http')
331 def _make_cmd(self
, tmpfilename
, info_dict
):
332 cmd
= ['http', '--download', '--output', tmpfilename
, info_dict
['url']]
334 if info_dict
.get('http_headers') is not None:
335 for key
, val
in info_dict
['http_headers'].items():
336 cmd
+= ['%s:%s' % (key
, val
)]
340 class FFmpegFD(ExternalFD
):
341 SUPPORTED_PROTOCOLS
= ('http', 'https', 'ftp', 'ftps', 'm3u8', 'm3u8_native', 'rtsp', 'rtmp', 'rtmp_ffmpeg', 'mms', 'http_dash_segments')
342 can_download_to_stdout
= True
345 def available(cls
, path
=None):
346 # TODO: Fix path for ffmpeg
347 # Fixme: This may be wrong when --ffmpeg-location is used
348 return FFmpegPostProcessor().available
350 def on_process_started(self
, proc
, stdin
):
351 """ Override this in subclasses """
355 def can_merge_formats(cls
, info_dict
, params
):
357 info_dict
.get('requested_formats')
358 and info_dict
.get('protocol')
359 and not params
.get('allow_unplayable_formats')
360 and 'no-direct-merge' not in params
.get('compat_opts', [])
361 and cls
.can_download(info_dict
))
363 def _call_downloader(self
, tmpfilename
, info_dict
):
364 urls
= [f
['url'] for f
in info_dict
.get('requested_formats', [])] or [info_dict
['url']]
365 ffpp
= FFmpegPostProcessor(downloader
=self
)
366 if not ffpp
.available
:
367 self
.report_error('m3u8 download detected but ffmpeg could not be found. Please install')
371 args
= [ffpp
.executable
, '-y']
373 for log_level
in ('quiet', 'verbose'):
374 if self
.params
.get(log_level
, False):
375 args
+= ['-loglevel', log_level
]
377 if not self
.params
.get('verbose'):
378 args
+= ['-hide_banner']
380 args
+= info_dict
.get('_ffmpeg_args', [])
382 # This option exists only for compatibility. Extractors should use `_ffmpeg_args` instead
383 seekable
= info_dict
.get('_seekable')
384 if seekable
is not None:
385 # setting -seekable prevents ffmpeg from guessing if the server
386 # supports seeking(by adding the header `Range: bytes=0-`), which
387 # can cause problems in some cases
388 # https://github.com/ytdl-org/youtube-dl/issues/11800#issuecomment-275037127
389 # http://trac.ffmpeg.org/ticket/6125#comment:10
390 args
+= ['-seekable', '1' if seekable
else '0']
392 # start_time = info_dict.get('start_time') or 0
394 # args += ['-ss', compat_str(start_time)]
395 # end_time = info_dict.get('end_time')
397 # args += ['-t', compat_str(end_time - start_time)]
399 if info_dict
.get('http_headers') is not None and re
.match(r
'^https?://', urls
[0]):
400 # Trailing \r\n after each HTTP header is important to prevent warning from ffmpeg/avconv:
401 # [http @ 00000000003d2fa0] No trailing CRLF found in HTTP header.
402 headers
= handle_youtubedl_headers(info_dict
['http_headers'])
405 ''.join('%s: %s\r\n' % (key
, val
) for key
, val
in headers
.items())]
408 proxy
= self
.params
.get('proxy')
410 if not re
.match(r
'^[\da-zA-Z]+://', proxy
):
411 proxy
= 'http://%s' % proxy
413 if proxy
.startswith('socks'):
415 '%s does not support SOCKS proxies. Downloading is likely to fail. '
416 'Consider adding --hls-prefer-native to your command.' % self
.get_basename())
418 # Since December 2015 ffmpeg supports -http_proxy option (see
419 # http://git.videolan.org/?p=ffmpeg.git;a=commit;h=b4eb1f29ebddd60c41a2eb39f5af701e38e0d3fd)
420 # We could switch to the following code if we are able to detect version properly
421 # args += ['-http_proxy', proxy]
422 env
= os
.environ
.copy()
423 compat_setenv('HTTP_PROXY', proxy
, env
=env
)
424 compat_setenv('http_proxy', proxy
, env
=env
)
426 protocol
= info_dict
.get('protocol')
428 if protocol
== 'rtmp':
429 player_url
= info_dict
.get('player_url')
430 page_url
= info_dict
.get('page_url')
431 app
= info_dict
.get('app')
432 play_path
= info_dict
.get('play_path')
433 tc_url
= info_dict
.get('tc_url')
434 flash_version
= info_dict
.get('flash_version')
435 live
= info_dict
.get('rtmp_live', False)
436 conn
= info_dict
.get('rtmp_conn')
437 if player_url
is not None:
438 args
+= ['-rtmp_swfverify', player_url
]
439 if page_url
is not None:
440 args
+= ['-rtmp_pageurl', page_url
]
442 args
+= ['-rtmp_app', app
]
443 if play_path
is not None:
444 args
+= ['-rtmp_playpath', play_path
]
445 if tc_url
is not None:
446 args
+= ['-rtmp_tcurl', tc_url
]
447 if flash_version
is not None:
448 args
+= ['-rtmp_flashver', flash_version
]
450 args
+= ['-rtmp_live', 'live']
451 if isinstance(conn
, list):
453 args
+= ['-rtmp_conn', entry
]
454 elif isinstance(conn
, compat_str
):
455 args
+= ['-rtmp_conn', conn
]
457 for i
, url
in enumerate(urls
):
458 args
+= self
._configuration
_args
((f
'_i{i + 1}', '_i')) + ['-i', url
]
460 args
+= ['-c', 'copy']
461 if info_dict
.get('requested_formats') or protocol
== 'http_dash_segments':
462 for (i
, fmt
) in enumerate(info_dict
.get('requested_formats') or [info_dict
]):
463 stream_number
= fmt
.get('manifest_stream_number', 0)
464 a_or_v
= 'a' if fmt
.get('acodec') != 'none' else 'v'
465 args
.extend(['-map', f
'{i}:{a_or_v}:{stream_number}'])
467 if self
.params
.get('test', False):
468 args
+= ['-fs', compat_str(self
._TEST
_FILE
_SIZE
)]
470 ext
= info_dict
['ext']
471 if protocol
in ('m3u8', 'm3u8_native'):
472 use_mpegts
= (tmpfilename
== '-') or self
.params
.get('hls_use_mpegts')
473 if use_mpegts
is None:
474 use_mpegts
= info_dict
.get('is_live')
476 args
+= ['-f', 'mpegts']
478 args
+= ['-f', 'mp4']
479 if (ffpp
.basename
== 'ffmpeg' and is_outdated_version(ffpp
._versions
['ffmpeg'], '3.2', False)) and (not info_dict
.get('acodec') or info_dict
['acodec'].split('.')[0] in ('aac', 'mp4a')):
480 args
+= ['-bsf:a', 'aac_adtstoasc']
481 elif protocol
== 'rtmp':
482 args
+= ['-f', 'flv']
483 elif ext
== 'mp4' and tmpfilename
== '-':
484 args
+= ['-f', 'mpegts']
486 args
+= ['-f', EXT_TO_OUT_FORMATS
.get(ext
, ext
)]
488 args
+= self
._configuration
_args
(('_o1', '_o', ''))
490 args
= [encodeArgument(opt
) for opt
in args
]
491 args
.append(encodeFilename(ffpp
._ffmpeg
_filename
_argument
(tmpfilename
), True))
492 self
._debug
_cmd
(args
)
494 proc
= subprocess
.Popen(args
, stdin
=subprocess
.PIPE
, env
=env
)
495 if url
in ('-', 'pipe:'):
496 self
.on_process_started(proc
, proc
.stdin
)
499 except BaseException
as e
:
500 # subprocces.run would send the SIGKILL signal to ffmpeg and the
501 # mp4 file couldn't be played, but if we ask ffmpeg to quit it
502 # produces a file that is playable (this is mostly useful for live
503 # streams). Note that Windows is not affected and produces playable
504 # files (see https://github.com/ytdl-org/youtube-dl/issues/8300).
505 if isinstance(e
, KeyboardInterrupt) and sys
.platform
!= 'win32' and url
not in ('-', 'pipe:'):
506 process_communicate_or_kill(proc
, b
'q')
514 class AVconvFD(FFmpegFD
):
519 (klass
.get_basename(), klass
)
520 for name
, klass
in globals().items()
521 if name
.endswith('FD') and name
!= 'ExternalFD'
525 def list_external_downloaders():
526 return sorted(_BY_NAME
.keys())
529 def get_external_downloader(external_downloader
):
530 """ Given the name of the executable, see whether we support the given
532 # Drop .exe extension on Windows
533 bn
= os
.path
.splitext(os
.path
.basename(external_downloader
))[0]
534 return _BY_NAME
.get(bn
)