19 class FileDownloader(object):
20 """File Downloader class.
22 File downloader objects are the ones responsible of downloading the
23 actual video file and writing it to disk.
25 File downloaders accept a lot of parameters. In order not to saturate
26 the object constructor with arguments, it receives a dictionary of
31 verbose: Print additional info to stdout.
32 quiet: Do not print messages to stdout.
33 ratelimit: Download speed limit, in bytes/sec.
34 retries: Number of times to retry for HTTP error 5xx
35 buffersize: Size of download buffer in bytes.
36 noresizebuffer: Do not automatically resize the download buffer.
37 continuedl: Try to continue downloads if possible.
38 noprogress: Do not print the progress bar.
39 logtostderr: Log messages to stderr instead of stdout.
40 consoletitle: Display progress in console window's titlebar.
41 nopart: Do not use temporary .part files.
42 updatetime: Use the Last-modified header to set output file timestamps.
43 test: Download only first bytes to test the downloader.
44 min_filesize: Skip files smaller than this size
45 max_filesize: Skip files larger than this size
50 def __init__(self, ydl, params):
51 """Create a FileDownloader object with the given options."""
53 self._progress_hooks = []
57 def format_seconds(seconds):
58 (mins, secs) = divmod(seconds, 60)
59 (hours, mins) = divmod(mins, 60)
63 return '%02d:%02d' % (mins, secs)
65 return '%02d:%02d:%02d' % (hours, mins, secs)
68 def calc_percent(byte_counter, data_len):
71 return float(byte_counter) / float(data_len) * 100.0
74 def format_percent(percent):
77 return '%6s' % ('%3.1f%%' % percent)
80 def calc_eta(start, now, total, current):
84 if current == 0 or dif < 0.001: # One millisecond
86 rate = float(current) / dif
87 return int((float(total) - float(current)) / rate)
93 return FileDownloader.format_seconds(eta)
96 def calc_speed(start, now, bytes):
98 if bytes == 0 or dif < 0.001: # One millisecond
100 return float(bytes) / dif
103 def format_speed(speed):
105 return '%10s' % '---b/s'
106 return '%10s' % ('%s/s' % format_bytes(speed))
109 def best_block_size(elapsed_time, bytes):
110 new_min = max(bytes / 2.0, 1.0)
111 new_max = min(max(bytes * 2.0, 1.0), 4194304) # Do not surpass 4 MB
112 if elapsed_time < 0.001:
114 rate = bytes / elapsed_time
122 def parse_bytes(bytestr):
123 """Parse a string indicating a byte quantity into an integer."""
124 matchobj = re.match(r'(?i)^(\d+(?:\.\d+)?)([kMGTPEZY]?)$', bytestr)
127 number = float(matchobj.group(1))
128 multiplier = 1024.0 ** 'bkmgtpezy'.index(matchobj.group(2).lower())
129 return int(round(number * multiplier))
131 def to_screen(self, *args, **kargs):
132 self.ydl.to_screen(*args, **kargs)
134 def to_stderr(self, message):
135 self.ydl.to_screen(message)
137 def to_console_title(self, message):
138 self.ydl.to_console_title(message)
140 def trouble(self, *args, **kargs):
141 self.ydl.trouble(*args, **kargs)
143 def report_warning(self, *args, **kargs):
144 self.ydl.report_warning(*args, **kargs)
146 def report_error(self, *args, **kargs):
147 self.ydl.report_error(*args, **kargs)
149 def slow_down(self, start_time, byte_counter):
150 """Sleep if the download speed is over the rate limit."""
151 rate_limit = self.params.get('ratelimit', None)
152 if rate_limit is None or byte_counter == 0:
155 elapsed = now - start_time
158 speed = float(byte_counter) / elapsed
159 if speed > rate_limit:
160 time.sleep((byte_counter - rate_limit * (now - start_time)) / rate_limit)
162 def temp_name(self, filename):
163 """Returns a temporary filename for the given filename."""
164 if self.params.get('nopart', False) or filename == u'-' or \
165 (os.path.exists(encodeFilename(filename)) and not os.path.isfile(encodeFilename(filename))):
167 return filename + u'.part'
169 def undo_temp_name(self, filename):
170 if filename.endswith(u'.part'):
171 return filename[:-len(u'.part')]
174 def try_rename(self, old_filename, new_filename):
176 if old_filename == new_filename:
178 os.rename(encodeFilename(old_filename), encodeFilename(new_filename))
179 except (IOError, OSError):
180 self.report_error(u'unable to rename file')
182 def try_utime(self, filename, last_modified_hdr):
183 """Try to set the last-modified time of the given file."""
184 if last_modified_hdr is None:
186 if not os.path.isfile(encodeFilename(filename)):
188 timestr = last_modified_hdr
191 filetime = timeconvert(timestr)
194 # Ignore obviously invalid dates
198 os.utime(filename, (time.time(), filetime))
203 def report_destination(self, filename):
204 """Report destination filename."""
205 self.to_screen(u'[download] Destination: ' + filename)
207 def report_progress(self, percent, data_len_str, speed, eta):
208 """Report download progress."""
209 if self.params.get('noprogress', False):
211 clear_line = (u'\x1b[K' if sys.stderr.isatty() and os.name != 'nt' else u'')
213 eta_str = self.format_eta(eta)
215 eta_str = 'Unknown ETA'
216 if percent is not None:
217 percent_str = self.format_percent(percent)
219 percent_str = 'Unknown %'
220 speed_str = self.format_speed(speed)
221 if self.params.get('progress_with_newline', False):
222 self.to_screen(u'[download] %s of %s at %s ETA %s' %
223 (percent_str, data_len_str, speed_str, eta_str))
225 self.to_screen(u'\r%s[download] %s of %s at %s ETA %s' %
226 (clear_line, percent_str, data_len_str, speed_str, eta_str), skip_eol=True)
227 self.to_console_title(u'youtube-dl - %s of %s at %s ETA %s' %
228 (percent_str.strip(), data_len_str.strip(), speed_str.strip(), eta_str.strip()))
230 def report_resuming_byte(self, resume_len):
231 """Report attempt to resume at given byte."""
232 self.to_screen(u'[download] Resuming download at byte %s' % resume_len)
234 def report_retry(self, count, retries):
235 """Report retry in case of HTTP error 5xx"""
236 self.to_screen(u'[download] Got server HTTP error. Retrying (attempt %d of %d)...' % (count, retries))
238 def report_file_already_downloaded(self, file_name):
239 """Report file has already been fully downloaded."""
241 self.to_screen(u'[download] %s has already been downloaded' % file_name)
242 except UnicodeEncodeError:
243 self.to_screen(u'[download] The file has already been downloaded')
245 def report_unable_to_resume(self):
246 """Report it was impossible to resume download."""
247 self.to_screen(u'[download] Unable to resume')
249 def report_finish(self, data_len_str, tot_time):
250 """Report download finished."""
251 if self.params.get('noprogress', False):
252 self.to_screen(u'[download] Download completed')
254 clear_line = (u'\x1b[K' if sys.stderr.isatty() and os.name != 'nt' else u'')
255 self.to_screen(u'\r%s[download] 100%% of %s in %s' %
256 (clear_line, data_len_str, self.format_seconds(tot_time)))
258 def _download_with_rtmpdump(self, filename, url, player_url, page_url, play_path, tc_url, live):
259 self.report_destination(filename)
260 tmpfilename = self.temp_name(filename)
261 test = self.params.get('test', False)
263 # Check for rtmpdump first
265 subprocess.call(['rtmpdump', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
266 except (OSError, IOError):
267 self.report_error(u'RTMP download detected but "rtmpdump" could not be run')
269 verbosity_option = '--verbose' if self.params.get('verbose', False) else '--quiet'
271 # Download using rtmpdump. rtmpdump returns exit code 2 when
272 # the connection was interrumpted and resuming appears to be
273 # possible. This is part of rtmpdump's normal usage, AFAIK.
274 basic_args = ['rtmpdump', verbosity_option, '-r', url, '-o', tmpfilename]
275 if player_url is not None:
276 basic_args += ['--swfVfy', player_url]
277 if page_url is not None:
278 basic_args += ['--pageUrl', page_url]
279 if play_path is not None:
280 basic_args += ['--playpath', play_path]
281 if tc_url is not None:
282 basic_args += ['--tcUrl', url]
284 basic_args += ['--stop', '1']
286 basic_args += ['--live']
287 args = basic_args + [[], ['--resume', '--skip', '1']][self.params.get('continuedl', False)]
288 if self.params.get('verbose', False):
291 shell_quote = lambda args: ' '.join(map(pipes.quote, args))
294 self.to_screen(u'[debug] rtmpdump command line: ' + shell_quote(args))
295 retval = subprocess.call(args)
296 while (retval == 2 or retval == 1) and not test:
297 prevsize = os.path.getsize(encodeFilename(tmpfilename))
298 self.to_screen(u'\r[rtmpdump] %s bytes' % prevsize, skip_eol=True)
299 time.sleep(5.0) # This seems to be needed
300 retval = subprocess.call(basic_args + ['-e'] + [[], ['-k', '1']][retval == 1])
301 cursize = os.path.getsize(encodeFilename(tmpfilename))
302 if prevsize == cursize and retval == 1:
304 # Some rtmp streams seem abort after ~ 99.8%. Don't complain for those
305 if prevsize == cursize and retval == 2 and cursize > 1024:
306 self.to_screen(u'\r[rtmpdump] Could not download the whole video. This can happen for some advertisements.')
309 if retval == 0 or (test and retval == 2):
310 fsize = os.path.getsize(encodeFilename(tmpfilename))
311 self.to_screen(u'\r[rtmpdump] %s bytes' % fsize)
312 self.try_rename(tmpfilename, filename)
313 self._hook_progress({
314 'downloaded_bytes': fsize,
315 'total_bytes': fsize,
316 'filename': filename,
317 'status': 'finished',
321 self.to_stderr(u"\n")
322 self.report_error(u'rtmpdump exited with code %d' % retval)
325 def _download_with_mplayer(self, filename, url):
326 self.report_destination(filename)
327 tmpfilename = self.temp_name(filename)
329 args = ['mplayer', '-really-quiet', '-vo', 'null', '-vc', 'dummy', '-dumpstream', '-dumpfile', tmpfilename, url]
330 # Check for mplayer first
332 subprocess.call(['mplayer', '-h'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
333 except (OSError, IOError):
334 self.report_error(u'MMS or RTSP download detected but "%s" could not be run' % args[0] )
337 # Download using mplayer.
338 retval = subprocess.call(args)
340 fsize = os.path.getsize(encodeFilename(tmpfilename))
341 self.to_screen(u'\r[%s] %s bytes' % (args[0], fsize))
342 self.try_rename(tmpfilename, filename)
343 self._hook_progress({
344 'downloaded_bytes': fsize,
345 'total_bytes': fsize,
346 'filename': filename,
347 'status': 'finished',
351 self.to_stderr(u"\n")
352 self.report_error(u'mplayer exited with code %d' % retval)
355 def _download_m3u8_with_ffmpeg(self, filename, url):
356 self.report_destination(filename)
357 tmpfilename = self.temp_name(filename)
359 args = ['-y', '-i', url, '-f', 'mp4', '-c', 'copy',
360 '-bsf:a', 'aac_adtstoasc', tmpfilename]
362 for program in ['avconv', 'ffmpeg']:
364 subprocess.call([program, '-version'], stdout=(open(os.path.devnull, 'w')), stderr=subprocess.STDOUT)
366 except (OSError, IOError):
369 self.report_error(u'm3u8 download detected but ffmpeg or avconv could not be found')
370 cmd = [program] + args
372 retval = subprocess.call(cmd)
374 fsize = os.path.getsize(encodeFilename(tmpfilename))
375 self.to_screen(u'\r[%s] %s bytes' % (args[0], fsize))
376 self.try_rename(tmpfilename, filename)
377 self._hook_progress({
378 'downloaded_bytes': fsize,
379 'total_bytes': fsize,
380 'filename': filename,
381 'status': 'finished',
385 self.to_stderr(u"\n")
386 self.report_error(u'ffmpeg exited with code %d' % retval)
390 def _do_download(self, filename, info_dict):
391 url = info_dict['url']
393 # Check file already present
394 if self.params.get('continuedl', False) and os.path.isfile(encodeFilename(filename)) and not self.params.get('nopart', False):
395 self.report_file_already_downloaded(filename)
396 self._hook_progress({
397 'filename': filename,
398 'status': 'finished',
399 'total_bytes': os.path.getsize(encodeFilename(filename)),
403 # Attempt to download using rtmpdump
404 if url.startswith('rtmp'):
405 return self._download_with_rtmpdump(filename, url,
406 info_dict.get('player_url', None),
407 info_dict.get('page_url', None),
408 info_dict.get('play_path', None),
409 info_dict.get('tc_url', None),
410 info_dict.get('rtmp_live', False))
412 # Attempt to download using mplayer
413 if url.startswith('mms') or url.startswith('rtsp'):
414 return self._download_with_mplayer(filename, url)
416 # m3u8 manifest are downloaded with ffmpeg
417 if determine_ext(url) == u'm3u8':
418 return self._download_m3u8_with_ffmpeg(filename, url)
420 tmpfilename = self.temp_name(filename)
423 # Do not include the Accept-Encoding header
424 headers = {'Youtubedl-no-compression': 'True'}
425 if 'user_agent' in info_dict:
426 headers['Youtubedl-user-agent'] = info_dict['user_agent']
427 basic_request = compat_urllib_request.Request(url, None, headers)
428 request = compat_urllib_request.Request(url, None, headers)
430 if self.params.get('test', False):
431 request.add_header('Range','bytes=0-10240')
433 # Establish possible resume length
434 if os.path.isfile(encodeFilename(tmpfilename)):
435 resume_len = os.path.getsize(encodeFilename(tmpfilename))
441 if self.params.get('continuedl', False):
442 self.report_resuming_byte(resume_len)
443 request.add_header('Range','bytes=%d-' % resume_len)
449 retries = self.params.get('retries', 0)
450 while count <= retries:
451 # Establish connection
453 if count == 0 and 'urlhandle' in info_dict:
454 data = info_dict['urlhandle']
455 data = compat_urllib_request.urlopen(request)
457 except (compat_urllib_error.HTTPError, ) as err:
458 if (err.code < 500 or err.code >= 600) and err.code != 416:
459 # Unexpected HTTP error
461 elif err.code == 416:
462 # Unable to resume (requested range not satisfiable)
464 # Open the connection again without the range header
465 data = compat_urllib_request.urlopen(basic_request)
466 content_length = data.info()['Content-Length']
467 except (compat_urllib_error.HTTPError, ) as err:
468 if err.code < 500 or err.code >= 600:
471 # Examine the reported length
472 if (content_length is not None and
473 (resume_len - 100 < int(content_length) < resume_len + 100)):
474 # The file had already been fully downloaded.
475 # Explanation to the above condition: in issue #175 it was revealed that
476 # YouTube sometimes adds or removes a few bytes from the end of the file,
477 # changing the file size slightly and causing problems for some users. So
478 # I decided to implement a suggested change and consider the file
479 # completely downloaded if the file size differs less than 100 bytes from
480 # the one in the hard drive.
481 self.report_file_already_downloaded(filename)
482 self.try_rename(tmpfilename, filename)
483 self._hook_progress({
484 'filename': filename,
485 'status': 'finished',
489 # The length does not match, we start the download over
490 self.report_unable_to_resume()
496 self.report_retry(count, retries)
499 self.report_error(u'giving up after %s retries' % retries)
502 data_len = data.info().get('Content-length', None)
503 if data_len is not None:
504 data_len = int(data_len) + resume_len
505 min_data_len = self.params.get("min_filesize", None)
506 max_data_len = self.params.get("max_filesize", None)
507 if min_data_len is not None and data_len < min_data_len:
508 self.to_screen(u'\r[download] File is smaller than min-filesize (%s bytes < %s bytes). Aborting.' % (data_len, min_data_len))
510 if max_data_len is not None and data_len > max_data_len:
511 self.to_screen(u'\r[download] File is larger than max-filesize (%s bytes > %s bytes). Aborting.' % (data_len, max_data_len))
514 data_len_str = format_bytes(data_len)
515 byte_counter = 0 + resume_len
516 block_size = self.params.get('buffersize', 1024)
521 data_block = data.read(block_size)
523 if len(data_block) == 0:
525 byte_counter += len(data_block)
527 # Open file just in time
530 (stream, tmpfilename) = sanitize_open(tmpfilename, open_mode)
531 assert stream is not None
532 filename = self.undo_temp_name(tmpfilename)
533 self.report_destination(filename)
534 except (OSError, IOError) as err:
535 self.report_error(u'unable to open for writing: %s' % str(err))
538 stream.write(data_block)
539 except (IOError, OSError) as err:
540 self.to_stderr(u"\n")
541 self.report_error(u'unable to write data: %s' % str(err))
543 if not self.params.get('noresizebuffer', False):
544 block_size = self.best_block_size(after - before, len(data_block))
547 speed = self.calc_speed(start, time.time(), byte_counter - resume_len)
551 percent = self.calc_percent(byte_counter, data_len)
552 eta = self.calc_eta(start, time.time(), data_len - resume_len, byte_counter - resume_len)
553 self.report_progress(percent, data_len_str, speed, eta)
555 self._hook_progress({
556 'downloaded_bytes': byte_counter,
557 'total_bytes': data_len,
558 'tmpfilename': tmpfilename,
559 'filename': filename,
560 'status': 'downloading',
566 self.slow_down(start, byte_counter - resume_len)
569 self.to_stderr(u"\n")
570 self.report_error(u'Did not get any data blocks')
573 self.report_finish(data_len_str, (time.time() - start))
574 if data_len is not None and byte_counter != data_len:
575 raise ContentTooShortError(byte_counter, int(data_len))
576 self.try_rename(tmpfilename, filename)
578 # Update file modification time
579 if self.params.get('updatetime', True):
580 info_dict['filetime'] = self.try_utime(filename, data.info().get('last-modified', None))
582 self._hook_progress({
583 'downloaded_bytes': byte_counter,
584 'total_bytes': byte_counter,
585 'filename': filename,
586 'status': 'finished',
591 def _hook_progress(self, status):
592 for ph in self._progress_hooks:
595 def add_progress_hook(self, ph):
596 """ ph gets called on download progress, with a dictionary with the entries
597 * filename: The final filename
598 * status: One of "downloading" and "finished"
600 It can also have some of the following entries:
602 * downloaded_bytes: Bytes on disks
603 * total_bytes: Total bytes, None if unknown
604 * tmpfilename: The filename we're currently writing to
605 * eta: The estimated time in seconds, None if unknown
606 * speed: The download speed in bytes/second, None if unknown
608 Hooks are guaranteed to be called at least once (with status "finished")
609 if the download is successful.
611 self._progress_hooks.append(ph)