13 compat_urllib_request
,
22 class FileDownloader(object):
23 """File Downloader class.
25 File downloader objects are the ones responsible of downloading the
26 actual video file and writing it to disk.
28 File downloaders accept a lot of parameters. In order not to saturate
29 the object constructor with arguments, it receives a dictionary of
34 verbose: Print additional info to stdout.
35 quiet: Do not print messages to stdout.
36 ratelimit: Download speed limit, in bytes/sec.
37 retries: Number of times to retry for HTTP error 5xx
38 buffersize: Size of download buffer in bytes.
39 noresizebuffer: Do not automatically resize the download buffer.
40 continuedl: Try to continue downloads if possible.
41 noprogress: Do not print the progress bar.
42 logtostderr: Log messages to stderr instead of stdout.
43 consoletitle: Display progress in console window's titlebar.
44 nopart: Do not use temporary .part files.
45 updatetime: Use the Last-modified header to set output file timestamps.
46 test: Download only first bytes to test the downloader.
47 min_filesize: Skip files smaller than this size
48 max_filesize: Skip files larger than this size
53 def __init__(self
, ydl
, params
):
54 """Create a FileDownloader object with the given options."""
56 self
._progress
_hooks
= []
60 def format_bytes(bytes):
63 if type(bytes) is str:
68 exponent
= int(math
.log(bytes, 1024.0))
69 suffix
= ['B','KiB','MiB','GiB','TiB','PiB','EiB','ZiB','YiB'][exponent
]
70 converted
= float(bytes) / float(1024 ** exponent
)
71 return '%.2f%s' % (converted
, suffix
)
74 def format_seconds(seconds
):
75 (mins
, secs
) = divmod(seconds
, 60)
76 (hours
, mins
) = divmod(mins
, 60)
80 return '%02d:%02d' % (mins
, secs
)
82 return '%02d:%02d:%02d' % (hours
, mins
, secs
)
85 def calc_percent(byte_counter
, data_len
):
88 return float(byte_counter
) / float(data_len
) * 100.0
91 def format_percent(percent
):
94 return '%6s' % ('%3.1f%%' % percent
)
97 def calc_eta(start
, now
, total
, current
):
101 if current
== 0 or dif
< 0.001: # One millisecond
103 rate
= float(current
) / dif
104 return int((float(total
) - float(current
)) / rate
)
110 return FileDownloader
.format_seconds(eta
)
113 def calc_speed(start
, now
, bytes):
115 if bytes == 0 or dif
< 0.001: # One millisecond
117 return float(bytes) / dif
120 def format_speed(speed
):
122 return '%10s' % '---b/s'
123 return '%10s' % ('%s/s' % FileDownloader
.format_bytes(speed
))
126 def best_block_size(elapsed_time
, bytes):
127 new_min
= max(bytes / 2.0, 1.0)
128 new_max
= min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
129 if elapsed_time
< 0.001:
131 rate
= bytes / elapsed_time
139 def parse_bytes(bytestr
):
140 """Parse a string indicating a byte quantity into an integer."""
141 matchobj
= re
.match(r
'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr
)
144 number
= float(matchobj
.group(1))
145 multiplier
= 1024.0 ** 'bkmgtpezy'.index(matchobj
.group(2).lower())
146 return int(round(number
* multiplier
))
148 def to_screen(self
, *args
, **kargs
):
149 self
.ydl
.to_screen(*args
, **kargs
)
151 def to_stderr(self
, message
):
152 self
.ydl
.to_screen(message
)
154 def to_cons_title(self
, message
):
155 """Set console/terminal window title to message."""
156 if not self
.params
.get('consoletitle', False):
158 if os
.name
== 'nt' and ctypes
.windll
.kernel32
.GetConsoleWindow():
159 # c_wchar_p() might not be necessary if `message` is
160 # already of type unicode()
161 ctypes
.windll
.kernel32
.SetConsoleTitleW(ctypes
.c_wchar_p(message
))
162 elif 'TERM' in os
.environ
:
163 self
.to_screen('\033]0;%s\007' % message
, skip_eol
=True)
165 def trouble(self
, *args
, **kargs
):
166 self
.ydl
.trouble(*args
, **kargs
)
168 def report_warning(self
, *args
, **kargs
):
169 self
.ydl
.report_warning(*args
, **kargs
)
171 def report_error(self
, *args
, **kargs
):
172 self
.ydl
.report_error(*args
, **kargs
)
174 def slow_down(self
, start_time
, byte_counter
):
175 """Sleep if the download speed is over the rate limit."""
176 rate_limit
= self
.params
.get('ratelimit', None)
177 if rate_limit
is None or byte_counter
== 0:
180 elapsed
= now
- start_time
183 speed
= float(byte_counter
) / elapsed
184 if speed
> rate_limit
:
185 time
.sleep((byte_counter
- rate_limit
* (now
- start_time
)) / rate_limit
)
187 def temp_name(self
, filename
):
188 """Returns a temporary filename for the given filename."""
189 if self
.params
.get('nopart', False) or filename
== u
'-' or \
190 (os
.path
.exists(encodeFilename(filename
)) and not os
.path
.isfile(encodeFilename(filename
))):
192 return filename
+ u
'.part'
194 def undo_temp_name(self
, filename
):
195 if filename
.endswith(u
'.part'):
196 return filename
[:-len(u
'.part')]
199 def try_rename(self
, old_filename
, new_filename
):
201 if old_filename
== new_filename
:
203 os
.rename(encodeFilename(old_filename
), encodeFilename(new_filename
))
204 except (IOError, OSError):
205 self
.report_error(u
'unable to rename file')
207 def try_utime(self
, filename
, last_modified_hdr
):
208 """Try to set the last-modified time of the given file."""
209 if last_modified_hdr
is None:
211 if not os
.path
.isfile(encodeFilename(filename
)):
213 timestr
= last_modified_hdr
216 filetime
= timeconvert(timestr
)
219 # Ignore obviously invalid dates
223 os
.utime(filename
, (time
.time(), filetime
))
228 def report_destination(self
, filename
):
229 """Report destination filename."""
230 self
.to_screen(u
'[download] Destination: ' + filename
)
232 def report_progress(self
, percent
, data_len_str
, speed
, eta
):
233 """Report download progress."""
234 if self
.params
.get('noprogress', False):
236 clear_line
= (u
'\x1b[K' if sys
.stderr
.isatty() and os
.name
!= 'nt' else u
'')
238 eta_str
= self
.format_eta(eta
)
240 eta_str
= 'Unknown ETA'
241 if percent
is not None:
242 percent_str
= self
.format_percent(percent
)
244 percent_str
= 'Unknown %'
245 speed_str
= self
.format_speed(speed
)
246 if self
.params
.get('progress_with_newline', False):
247 self
.to_screen(u
'[download] %s of %s at %s ETA %s' %
248 (percent_str
, data_len_str
, speed_str
, eta_str
))
250 self
.to_screen(u
'\r%s[download] %s of %s at %s ETA %s' %
251 (clear_line
, percent_str
, data_len_str
, speed_str
, eta_str
), skip_eol
=True)
252 self
.to_cons_title(u
'youtube-dl - %s of %s at %s ETA %s' %
253 (percent_str
.strip(), data_len_str
.strip(), speed_str
.strip(), eta_str
.strip()))
255 def report_resuming_byte(self
, resume_len
):
256 """Report attempt to resume at given byte."""
257 self
.to_screen(u
'[download] Resuming download at byte %s' % resume_len
)
259 def report_retry(self
, count
, retries
):
260 """Report retry in case of HTTP error 5xx"""
261 self
.to_screen(u
'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count
, retries
))
263 def report_file_already_downloaded(self
, file_name
):
264 """Report file has already been fully downloaded."""
266 self
.to_screen(u
'[download] %s has already been downloaded' % file_name
)
267 except UnicodeEncodeError:
268 self
.to_screen(u
'[download] The file has already been downloaded')
270 def report_unable_to_resume(self
):
271 """Report it was impossible to resume download."""
272 self
.to_screen(u
'[download] Unable to resume')
274 def report_finish(self
, data_len_str
, tot_time
):
275 """Report download finished."""
276 if self
.params
.get('noprogress', False):
277 self
.to_screen(u
'[download] Download completed')
279 clear_line
= (u
'\x1b[K' if sys
.stderr
.isatty() and os
.name
!= 'nt' else u
'')
280 self
.to_screen(u
'\r%s[download] 100%% of %s in %s' %
281 (clear_line
, data_len_str
, self
.format_seconds(tot_time
)))
283 def _download_with_rtmpdump(self
, filename
, url
, player_url
, page_url
, play_path
, tc_url
, live
):
284 self
.report_destination(filename
)
285 tmpfilename
= self
.temp_name(filename
)
286 test
= self
.params
.get('test', False)
288 # Check for rtmpdump first
290 subprocess
.call(['rtmpdump', '-h'], stdout
=(open(os
.path
.devnull
, 'w')), stderr
=subprocess
.STDOUT
)
291 except (OSError, IOError):
292 self
.report_error(u
'RTMP download detected but "rtmpdump" could not be run')
294 verbosity_option
= '--verbose' if self
.params
.get('verbose', False) else '--quiet'
296 # Download using rtmpdump. rtmpdump returns exit code 2 when
297 # the connection was interrumpted and resuming appears to be
298 # possible. This is part of rtmpdump's normal usage, AFAIK.
299 basic_args
= ['rtmpdump', verbosity_option
, '-r', url
, '-o', tmpfilename
]
300 if player_url
is not None:
301 basic_args
+= ['--swfVfy', player_url
]
302 if page_url
is not None:
303 basic_args
+= ['--pageUrl', page_url
]
304 if play_path
is not None:
305 basic_args
+= ['--playpath', play_path
]
306 if tc_url
is not None:
307 basic_args
+= ['--tcUrl', url
]
309 basic_args
+= ['--stop', '1']
311 basic_args
+= ['--live']
312 args
= basic_args
+ [[], ['--resume', '--skip', '1']][self
.params
.get('continuedl', False)]
313 if self
.params
.get('verbose', False):
316 shell_quote
= lambda args
: ' '.join(map(pipes
.quote
, args
))
319 self
.to_screen(u
'[debug] rtmpdump command line: ' + shell_quote(args
))
320 retval
= subprocess
.call(args
)
321 while (retval
== 2 or retval
== 1) and not test
:
322 prevsize
= os
.path
.getsize(encodeFilename(tmpfilename
))
323 self
.to_screen(u
'\r[rtmpdump] %s bytes' % prevsize
, skip_eol
=True)
324 time
.sleep(5.0) # This seems to be needed
325 retval
= subprocess
.call(basic_args
+ ['-e'] + [[], ['-k', '1']][retval
== 1])
326 cursize
= os
.path
.getsize(encodeFilename(tmpfilename
))
327 if prevsize
== cursize
and retval
== 1:
329 # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
330 if prevsize
== cursize
and retval
== 2 and cursize
> 1024:
331 self
.to_screen(u
'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
334 if retval
== 0 or (test
and retval
== 2):
335 fsize
= os
.path
.getsize(encodeFilename(tmpfilename
))
336 self
.to_screen(u
'\r[rtmpdump] %s bytes' % fsize
)
337 self
.try_rename(tmpfilename
, filename
)
338 self
._hook
_progress
({
339 'downloaded_bytes': fsize
,
340 'total_bytes': fsize
,
341 'filename': filename
,
342 'status': 'finished',
346 self
.to_stderr(u
"\n")
347 self
.report_error(u
'rtmpdump exited with code %d' % retval
)
350 def _download_with_mplayer(self
, filename
, url
):
351 self
.report_destination(filename
)
352 tmpfilename
= self
.temp_name(filename
)
354 args
= ['mplayer', '-really-quiet', '-vo', 'null', '-vc', 'dummy', '-dumpstream', '-dumpfile', tmpfilename
, url
]
355 # Check for mplayer first
357 subprocess
.call(['mplayer', '-h'], stdout
=(open(os
.path
.devnull
, 'w')), stderr
=subprocess
.STDOUT
)
358 except (OSError, IOError):
359 self
.report_error(u
'MMS or RTSP download detected but "%s" could not be run' % args
[0] )
362 # Download using mplayer.
363 retval
= subprocess
.call(args
)
365 fsize
= os
.path
.getsize(encodeFilename(tmpfilename
))
366 self
.to_screen(u
'\r[%s] %s bytes' % (args
[0], fsize
))
367 self
.try_rename(tmpfilename
, filename
)
368 self
._hook
_progress
({
369 'downloaded_bytes': fsize
,
370 'total_bytes': fsize
,
371 'filename': filename
,
372 'status': 'finished',
376 self
.to_stderr(u
"\n")
377 self
.report_error(u
'mplayer exited with code %d' % retval
)
380 def _download_m3u8_with_ffmpeg(self
, filename
, url
):
381 self
.report_destination(filename
)
382 tmpfilename
= self
.temp_name(filename
)
384 args
= ['ffmpeg', '-y', '-i', url
, '-f', 'mp4', '-c', 'copy',
385 '-absf', 'aac_adtstoasc', tmpfilename
]
386 # Check for ffmpeg first
388 subprocess
.call(['ffmpeg', '-h'], stdout
=(open(os
.path
.devnull
, 'w')), stderr
=subprocess
.STDOUT
)
389 except (OSError, IOError):
390 self
.report_error(u
'm3u8 download detected but "%s" could not be run' % args
[0] )
393 retval
= subprocess
.call(args
)
395 fsize
= os
.path
.getsize(encodeFilename(tmpfilename
))
396 self
.to_screen(u
'\r[%s] %s bytes' % (args
[0], fsize
))
397 self
.try_rename(tmpfilename
, filename
)
398 self
._hook
_progress
({
399 'downloaded_bytes': fsize
,
400 'total_bytes': fsize
,
401 'filename': filename
,
402 'status': 'finished',
406 self
.to_stderr(u
"\n")
407 self
.report_error(u
'ffmpeg exited with code %d' % retval
)
411 def _do_download(self
, filename
, info_dict
):
412 url
= info_dict
['url']
414 # Check file already present
415 if self
.params
.get('continuedl', False) and os
.path
.isfile(encodeFilename(filename
)) and not self
.params
.get('nopart', False):
416 self
.report_file_already_downloaded(filename
)
417 self
._hook
_progress
({
418 'filename': filename
,
419 'status': 'finished',
420 'total_bytes': os
.path
.getsize(encodeFilename(filename
)),
424 # Attempt to download using rtmpdump
425 if url
.startswith('rtmp'):
426 return self
._download
_with
_rtmpdump
(filename
, url
,
427 info_dict
.get('player_url', None),
428 info_dict
.get('page_url', None),
429 info_dict
.get('play_path', None),
430 info_dict
.get('tc_url', None),
431 info_dict
.get('live', False))
433 # Attempt to download using mplayer
434 if url
.startswith('mms') or url
.startswith('rtsp'):
435 return self
._download
_with
_mplayer
(filename
, url
)
437 # m3u8 manifest are downloaded with ffmpeg
438 if determine_ext(url
) == u
'm3u8':
439 return self
._download
_m
3u8_with
_ffmpeg
(filename
, url
)
441 tmpfilename
= self
.temp_name(filename
)
444 # Do not include the Accept-Encoding header
445 headers
= {'Youtubedl-no-compression': 'True'}
446 if 'user_agent' in info_dict
:
447 headers
['Youtubedl-user-agent'] = info_dict
['user_agent']
448 basic_request
= compat_urllib_request
.Request(url
, None, headers
)
449 request
= compat_urllib_request
.Request(url
, None, headers
)
451 if self
.params
.get('test', False):
452 request
.add_header('Range','bytes=0-10240')
454 # Establish possible resume length
455 if os
.path
.isfile(encodeFilename(tmpfilename
)):
456 resume_len
= os
.path
.getsize(encodeFilename(tmpfilename
))
462 if self
.params
.get('continuedl', False):
463 self
.report_resuming_byte(resume_len
)
464 request
.add_header('Range','bytes=%d-' % resume_len
)
470 retries
= self
.params
.get('retries', 0)
471 while count
<= retries
:
472 # Establish connection
474 if count
== 0 and 'urlhandle' in info_dict
:
475 data
= info_dict
['urlhandle']
476 data
= compat_urllib_request
.urlopen(request
)
478 except (compat_urllib_error
.HTTPError
, ) as err
:
479 if (err
.code
< 500 or err
.code
>= 600) and err
.code
!= 416:
480 # Unexpected HTTP error
482 elif err
.code
== 416:
483 # Unable to resume (requested range not satisfiable)
485 # Open the connection again without the range header
486 data
= compat_urllib_request
.urlopen(basic_request
)
487 content_length
= data
.info()['Content-Length']
488 except (compat_urllib_error
.HTTPError
, ) as err
:
489 if err
.code
< 500 or err
.code
>= 600:
492 # Examine the reported length
493 if (content_length
is not None and
494 (resume_len
- 100 < int(content_length
) < resume_len
+ 100)):
495 # The file had already been fully downloaded.
496 # Explanation to the above condition: in issue #175 it was revealed that
497 # YouTube sometimes adds or removes a few bytes from the end of the file,
498 # changing the file size slightly and causing problems for some users. So
499 # I decided to implement a suggested change and consider the file
500 # completely downloaded if the file size differs less than 100 bytes from
501 # the one in the hard drive.
502 self
.report_file_already_downloaded(filename
)
503 self
.try_rename(tmpfilename
, filename
)
504 self
._hook
_progress
({
505 'filename': filename
,
506 'status': 'finished',
510 # The length does not match, we start the download over
511 self
.report_unable_to_resume()
517 self
.report_retry(count
, retries
)
520 self
.report_error(u
'giving up after %s retries' % retries
)
523 data_len
= data
.info().get('Content-length', None)
524 if data_len
is not None:
525 data_len
= int(data_len
) + resume_len
526 min_data_len
= self
.params
.get("min_filesize", None)
527 max_data_len
= self
.params
.get("max_filesize", None)
528 if min_data_len
is not None and data_len
< min_data_len
:
529 self
.to_screen(u
'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len
, min_data_len
))
531 if max_data_len
is not None and data_len
> max_data_len
:
532 self
.to_screen(u
'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len
, max_data_len
))
535 data_len_str
= self
.format_bytes(data_len
)
536 byte_counter
= 0 + resume_len
537 block_size
= self
.params
.get('buffersize', 1024)
542 data_block
= data
.read(block_size
)
544 if len(data_block
) == 0:
546 byte_counter
+= len(data_block
)
548 # Open file just in time
551 (stream
, tmpfilename
) = sanitize_open(tmpfilename
, open_mode
)
552 assert stream
is not None
553 filename
= self
.undo_temp_name(tmpfilename
)
554 self
.report_destination(filename
)
555 except (OSError, IOError) as err
:
556 self
.report_error(u
'unable to open for writing: %s' % str(err
))
559 stream
.write(data_block
)
560 except (IOError, OSError) as err
:
561 self
.to_stderr(u
"\n")
562 self
.report_error(u
'unable to write data: %s' % str(err
))
564 if not self
.params
.get('noresizebuffer', False):
565 block_size
= self
.best_block_size(after
- before
, len(data_block
))
568 speed
= self
.calc_speed(start
, time
.time(), byte_counter
- resume_len
)
572 percent
= self
.calc_percent(byte_counter
, data_len
)
573 eta
= self
.calc_eta(start
, time
.time(), data_len
- resume_len
, byte_counter
- resume_len
)
574 self
.report_progress(percent
, data_len_str
, speed
, eta
)
576 self
._hook
_progress
({
577 'downloaded_bytes': byte_counter
,
578 'total_bytes': data_len
,
579 'tmpfilename': tmpfilename
,
580 'filename': filename
,
581 'status': 'downloading',
587 self
.slow_down(start
, byte_counter
- resume_len
)
590 self
.to_stderr(u
"\n")
591 self
.report_error(u
'Did not get any data blocks')
594 self
.report_finish(data_len_str
, (time
.time() - start
))
595 if data_len
is not None and byte_counter
!= data_len
:
596 raise ContentTooShortError(byte_counter
, int(data_len
))
597 self
.try_rename(tmpfilename
, filename
)
599 # Update file modification time
600 if self
.params
.get('updatetime', True):
601 info_dict
['filetime'] = self
.try_utime(filename
, data
.info().get('last-modified', None))
603 self
._hook
_progress
({
604 'downloaded_bytes': byte_counter
,
605 'total_bytes': byte_counter
,
606 'filename': filename
,
607 'status': 'finished',
612 def _hook_progress(self
, status
):
613 for ph
in self
._progress
_hooks
:
616 def add_progress_hook(self
, ph
):
617 """ ph gets called on download progress, with a dictionary with the entries
618 * filename: The final filename
619 * status: One of "downloading" and "finished"
621 It can also have some of the following entries:
623 * downloaded_bytes: Bytes on disks
624 * total_bytes: Total bytes, None if unknown
625 * tmpfilename: The filename we're currently writing to
626 * eta: The estimated time in seconds, None if unknown
627 * speed: The download speed in bytes/second, None if unknown
629 Hooks are guaranteed to be called at least once (with status "finished")
630 if the download is successful.
632 self
._progress
_hooks
.append(ph
)