2 # -*- coding: utf-8 -*-
4 from __future__ import absolute_import, unicode_literals
32 compat_urllib_request,
58 UnavailableVideoError,
66 from .cache import Cache
67 from .extractor import get_info_extractor, gen_extractors
68 from .downloader import get_suitable_downloader
69 from .downloader.rtmp import rtmpdump_version
70 from .postprocessor import FFmpegMergerPP, FFmpegPostProcessor
71 from .version import __version__
74 class YoutubeDL(object):
77 YoutubeDL objects are the ones responsible of downloading the
78 actual video file and writing it to disk if the user has requested
79 it, among some other tasks. In most cases there should be one per
80 program. As, given a video URL, the downloader doesn't know how to
81 extract all the needed information, task that InfoExtractors do, it
82 has to pass the URL to one of them.
84 For this, YoutubeDL objects have a method that allows
85 InfoExtractors to be registered in a given order. When it is passed
86 a URL, the YoutubeDL object handles it to the first InfoExtractor it
87 finds that reports being able to handle it. The InfoExtractor extracts
88 all the information about the video or videos the URL refers to, and
89 YoutubeDL process the extracted information, possibly using a File
90 Downloader to download the video.
92 YoutubeDL objects accept a lot of parameters. In order not to saturate
93 the object constructor with arguments, it receives a dictionary of
94 options instead. These options are available through the params
95 attribute for the InfoExtractors to use. The YoutubeDL also
96 registers itself as the downloader in charge for the InfoExtractors
97 that are added to it, so this is a "mutual registration".
101 username: Username for authentication purposes.
102 password: Password for authentication purposes.
103 videopassword: Password for acces a video.
104 usenetrc: Use netrc for authentication instead.
105 verbose: Print additional info to stdout.
106 quiet: Do not print messages to stdout.
107 no_warnings: Do not print out anything for warnings.
108 forceurl: Force printing final URL.
109 forcetitle: Force printing title.
110 forceid: Force printing ID.
111 forcethumbnail: Force printing thumbnail URL.
112 forcedescription: Force printing description.
113 forcefilename: Force printing final filename.
114 forceduration: Force printing duration.
115 forcejson: Force printing info_dict as JSON.
116 dump_single_json: Force printing the info_dict of the whole playlist
117 (or video) as a single JSON line.
118 simulate: Do not download the video files.
119 format: Video format code.
120 format_limit: Highest quality format to try.
121 outtmpl: Template for output names.
122 restrictfilenames: Do not allow "&" and spaces in file names
123 ignoreerrors: Do not stop on download errors.
124 nooverwrites: Prevent overwriting files.
125 playliststart: Playlist item to start at.
126 playlistend: Playlist item to end at.
127 matchtitle: Download only matching titles.
128 rejecttitle: Reject downloads for matching titles.
129 logger: Log messages to a logging.Logger instance.
130 logtostderr: Log messages to stderr instead of stdout.
131 writedescription: Write the video description to a .description file
132 writeinfojson: Write the video description to a .info.json file
133 writeannotations: Write the video annotations to a .annotations.xml file
134 writethumbnail: Write the thumbnail image to a file
135 writesubtitles: Write the video subtitles to a file
136 writeautomaticsub: Write the automatic subtitles to a file
137 allsubtitles: Downloads all the subtitles of the video
138 (requires writesubtitles or writeautomaticsub)
139 listsubtitles: Lists all available subtitles for the video
140 subtitlesformat: Subtitle format [srt/sbv/vtt] (default=srt)
141 subtitleslangs: List of languages of the subtitles to download
142 keepvideo: Keep the video file after post-processing
143 daterange: A DateRange object, download only if the upload_date is in the range.
144 skip_download: Skip the actual download of the video file
145 cachedir: Location of the cache files in the filesystem.
146 False to disable filesystem cache.
147 noplaylist: Download single video instead of a playlist if in doubt.
148 age_limit: An integer representing the user's age in years.
149 Unsuitable videos for the given age are skipped.
150 min_views: An integer representing the minimum view count the video
151 must have in order to not be skipped.
152 Videos without view count information are always
153 downloaded. None for no limit.
154 max_views: An integer representing the maximum view count.
155 Videos that are more popular than that are not
157 Videos without view count information are always
158 downloaded. None for no limit.
159 download_archive: File name of a file where all downloads are recorded.
160 Videos already present in the file are not downloaded
162 cookiefile: File name where cookies should be read from and dumped to.
163 nocheckcertificate:Do not verify SSL certificates
164 prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
165 At the moment, this is only supported by YouTube.
166 proxy: URL of the proxy server to use
167 socket_timeout: Time to wait for unresponsive hosts, in seconds
168 bidi_workaround: Work around buggy terminals without bidirectional text
169 support, using fridibi
170 debug_printtraffic:Print out sent and received HTTP traffic
171 include_ads: Download ads as well
172 default_search: Prepend this string if an input url is not valid.
173 'auto' for elaborate guessing
174 encoding: Use this encoding instead of the system-specified.
175 extract_flat: Do not resolve URLs, return the immediate result.
176 Pass in 'in_playlist' to only show this behavior for
179 The following parameters are not used by YoutubeDL itself, they are used by
181 nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
182 noresizebuffer, retries, continuedl, noprogress, consoletitle
184 The following options are used by the post processors:
185 prefer_ffmpeg: If True, use ffmpeg instead of avconv if both are available,
186 otherwise prefer avconv.
187 exec_cmd: Arbitrary command to run after downloading
193 _download_retcode = None
194 _num_downloads = None
197 def __init__(self, params=None, auto_init=True):
198 """Create a FileDownloader object with the given options."""
202 self._ies_instances = {}
204 self._progress_hooks = []
205 self._download_retcode = 0
206 self._num_downloads = 0
207 self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
208 self._err_file = sys.stderr
210 self.cache = Cache(self)
212 if params.get('bidi_workaround', False):
215 master, slave = pty.openpty()
216 width = get_term_width()
220 width_args = ['-w', str(width)]
222 stdin=subprocess.PIPE,
224 stderr=self._err_file)
226 self._output_process = subprocess.Popen(
227 ['bidiv'] + width_args, **sp_kwargs
230 self._output_process = subprocess.Popen(
231 ['fribidi', '-c', 'UTF-8'] + width_args, **sp_kwargs)
232 self._output_channel = os.fdopen(master, 'rb')
233 except OSError as ose:
235 self.report_warning('Could not find fribidi executable, ignoring --bidi-workaround . Make sure that fribidi is an executable file in one of the directories in your $PATH.')
239 if (sys.version_info >= (3,) and sys.platform != 'win32' and
240 sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968']
241 and not params.get('restrictfilenames', False)):
242 # On Python 3, the Unicode filesystem API will throw errors (#1474)
244 'Assuming --restrict-filenames since file system encoding '
245 'cannot encode all characters. '
246 'Set the LC_ALL environment variable to fix this.')
247 self.params['restrictfilenames'] = True
249 if '%(stitle)s' in self.params.get('outtmpl', ''):
250 self.report_warning('%(stitle)s is deprecated. Use the %(title)s and the --restrict-filenames flag(which also secures %(uploader)s et al) instead.')
255 self.print_debug_header()
256 self.add_default_info_extractors()
258 def warn_if_short_id(self, argv):
259 # short YouTube ID starting with dash?
261 i for i, a in enumerate(argv)
262 if re.match(r'^-[0-9A-Za-z_-]{10}$', a)]
266 [a for i, a in enumerate(argv) if i not in idxs] +
267 ['--'] + [argv[i] for i in idxs]
270 'Long argument string detected. '
271 'Use -- to separate parameters and URLs, like this:\n%s\n' %
272 args_to_str(correct_argv))
274 def add_info_extractor(self, ie):
275 """Add an InfoExtractor object to the end of the list."""
277 self._ies_instances[ie.ie_key()] = ie
278 ie.set_downloader(self)
280 def get_info_extractor(self, ie_key):
282 Get an instance of an IE with name ie_key, it will try to get one from
283 the _ies list, if there's no instance it will create a new one and add
284 it to the extractor list.
286 ie = self._ies_instances.get(ie_key)
288 ie = get_info_extractor(ie_key)()
289 self.add_info_extractor(ie)
292 def add_default_info_extractors(self):
294 Add the InfoExtractors returned by gen_extractors to the end of the list
296 for ie in gen_extractors():
297 self.add_info_extractor(ie)
299 def add_post_processor(self, pp):
300 """Add a PostProcessor object to the end of the chain."""
302 pp.set_downloader(self)
304 def add_progress_hook(self, ph):
305 """Add the progress hook (currently only for the file downloader)"""
306 self._progress_hooks.append(ph)
308 def _bidi_workaround(self, message):
309 if not hasattr(self, '_output_channel'):
312 assert hasattr(self, '_output_process')
313 assert isinstance(message, compat_str)
314 line_count = message.count('\n') + 1
315 self._output_process.stdin.write((message + '\n').encode('utf-8'))
316 self._output_process.stdin.flush()
317 res = ''.join(self._output_channel.readline().decode('utf-8')
318 for _ in range(line_count))
319 return res[:-len('\n')]
321 def to_screen(self, message, skip_eol=False):
322 """Print message to stdout if not in quiet mode."""
323 return self.to_stdout(message, skip_eol, check_quiet=True)
325 def _write_string(self, s, out=None):
326 write_string(s, out=out, encoding=self.params.get('encoding'))
328 def to_stdout(self, message, skip_eol=False, check_quiet=False):
329 """Print message to stdout if not in quiet mode."""
330 if self.params.get('logger'):
331 self.params['logger'].debug(message)
332 elif not check_quiet or not self.params.get('quiet', False):
333 message = self._bidi_workaround(message)
334 terminator = ['\n', ''][skip_eol]
335 output = message + terminator
337 self._write_string(output, self._screen_file)
339 def to_stderr(self, message):
340 """Print message to stderr."""
341 assert isinstance(message, compat_str)
342 if self.params.get('logger'):
343 self.params['logger'].error(message)
345 message = self._bidi_workaround(message)
346 output = message + '\n'
347 self._write_string(output, self._err_file)
349 def to_console_title(self, message):
350 if not self.params.get('consoletitle', False):
352 if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
353 # c_wchar_p() might not be necessary if `message` is
354 # already of type unicode()
355 ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
356 elif 'TERM' in os.environ:
357 self._write_string('\033]0;%s\007' % message, self._screen_file)
359 def save_console_title(self):
360 if not self.params.get('consoletitle', False):
362 if 'TERM' in os.environ:
363 # Save the title on stack
364 self._write_string('\033[22;0t', self._screen_file)
366 def restore_console_title(self):
367 if not self.params.get('consoletitle', False):
369 if 'TERM' in os.environ:
370 # Restore the title from stack
371 self._write_string('\033[23;0t', self._screen_file)
374 self.save_console_title()
377 def __exit__(self, *args):
378 self.restore_console_title()
380 if self.params.get('cookiefile') is not None:
381 self.cookiejar.save()
383 def trouble(self, message=None, tb=None):
384 """Determine action to take when a download problem appears.
386 Depending on if the downloader has been configured to ignore
387 download errors or not, this method may throw an exception or
388 not when errors are found, after printing the message.
390 tb, if given, is additional traceback information.
392 if message is not None:
393 self.to_stderr(message)
394 if self.params.get('verbose'):
396 if sys.exc_info()[0]: # if .trouble has been called from an except block
398 if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
399 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
400 tb += compat_str(traceback.format_exc())
402 tb_data = traceback.format_list(traceback.extract_stack())
403 tb = ''.join(tb_data)
405 if not self.params.get('ignoreerrors', False):
406 if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
407 exc_info = sys.exc_info()[1].exc_info
409 exc_info = sys.exc_info()
410 raise DownloadError(message, exc_info)
411 self._download_retcode = 1
413 def report_warning(self, message):
415 Print the message to stderr, it will be prefixed with 'WARNING:'
416 If stderr is a tty file the 'WARNING:' will be colored
418 if self.params.get('logger') is not None:
419 self.params['logger'].warning(message)
421 if self.params.get('no_warnings'):
423 if self._err_file.isatty() and os.name != 'nt':
424 _msg_header = '\033[0;33mWARNING:\033[0m'
426 _msg_header = 'WARNING:'
427 warning_message = '%s %s' % (_msg_header, message)
428 self.to_stderr(warning_message)
430 def report_error(self, message, tb=None):
432 Do the same as trouble, but prefixes the message with 'ERROR:', colored
433 in red if stderr is a tty file.
435 if self._err_file.isatty() and os.name != 'nt':
436 _msg_header = '\033[0;31mERROR:\033[0m'
438 _msg_header = 'ERROR:'
439 error_message = '%s %s' % (_msg_header, message)
440 self.trouble(error_message, tb)
442 def report_file_already_downloaded(self, file_name):
443 """Report file has already been fully downloaded."""
445 self.to_screen('[download] %s has already been downloaded' % file_name)
446 except UnicodeEncodeError:
447 self.to_screen('[download] The file has already been downloaded')
449 def prepare_filename(self, info_dict):
450 """Generate the output filename."""
452 template_dict = dict(info_dict)
454 template_dict['epoch'] = int(time.time())
455 autonumber_size = self.params.get('autonumber_size')
456 if autonumber_size is None:
458 autonumber_templ = '%0' + str(autonumber_size) + 'd'
459 template_dict['autonumber'] = autonumber_templ % self._num_downloads
460 if template_dict.get('playlist_index') is not None:
461 template_dict['playlist_index'] = '%0*d' % (len(str(template_dict['n_entries'])), template_dict['playlist_index'])
462 if template_dict.get('resolution') is None:
463 if template_dict.get('width') and template_dict.get('height'):
464 template_dict['resolution'] = '%dx%d' % (template_dict['width'], template_dict['height'])
465 elif template_dict.get('height'):
466 template_dict['resolution'] = '%sp' % template_dict['height']
467 elif template_dict.get('width'):
468 template_dict['resolution'] = '?x%d' % template_dict['width']
470 sanitize = lambda k, v: sanitize_filename(
472 restricted=self.params.get('restrictfilenames'),
474 template_dict = dict((k, sanitize(k, v))
475 for k, v in template_dict.items()
477 template_dict = collections.defaultdict(lambda: 'NA', template_dict)
479 outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
480 tmpl = compat_expanduser(outtmpl)
481 filename = tmpl % template_dict
483 except ValueError as err:
484 self.report_error('Error in output template: ' + str(err) + ' (encoding: ' + repr(preferredencoding()) + ')')
487 def _match_entry(self, info_dict):
488 """ Returns None iff the file should be downloaded """
490 video_title = info_dict.get('title', info_dict.get('id', 'video'))
491 if 'title' in info_dict:
492 # This can happen when we're just evaluating the playlist
493 title = info_dict['title']
494 matchtitle = self.params.get('matchtitle', False)
496 if not re.search(matchtitle, title, re.IGNORECASE):
497 return '"' + title + '" title did not match pattern "' + matchtitle + '"'
498 rejecttitle = self.params.get('rejecttitle', False)
500 if re.search(rejecttitle, title, re.IGNORECASE):
501 return '"' + title + '" title matched reject pattern "' + rejecttitle + '"'
502 date = info_dict.get('upload_date', None)
504 dateRange = self.params.get('daterange', DateRange())
505 if date not in dateRange:
506 return '%s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
507 view_count = info_dict.get('view_count', None)
508 if view_count is not None:
509 min_views = self.params.get('min_views')
510 if min_views is not None and view_count < min_views:
511 return 'Skipping %s, because it has not reached minimum view count (%d/%d)' % (video_title, view_count, min_views)
512 max_views = self.params.get('max_views')
513 if max_views is not None and view_count > max_views:
514 return 'Skipping %s, because it has exceeded the maximum view count (%d/%d)' % (video_title, view_count, max_views)
515 age_limit = self.params.get('age_limit')
516 if age_limit is not None:
517 actual_age_limit = info_dict.get('age_limit')
518 if actual_age_limit is None:
520 if age_limit < actual_age_limit:
521 return 'Skipping "' + title + '" because it is age restricted'
522 if self.in_download_archive(info_dict):
523 return '%s has already been recorded in archive' % video_title
527 def add_extra_info(info_dict, extra_info):
528 '''Set the keys from extra_info in info dict if they are missing'''
529 for key, value in extra_info.items():
530 info_dict.setdefault(key, value)
532 def extract_info(self, url, download=True, ie_key=None, extra_info={},
535 Returns a list with a dictionary for each video we find.
536 If 'download', also downloads the videos.
537 extra_info is a dict containing the extra values to add to each result
541 ies = [self.get_info_extractor(ie_key)]
546 if not ie.suitable(url):
550 self.report_warning('The program functionality for this site has been marked as broken, '
551 'and will probably not work.')
554 ie_result = ie.extract(url)
555 if ie_result is None: # Finished already (backwards compatibility; listformats and friends should be moved here)
557 if isinstance(ie_result, list):
558 # Backwards compatibility: old IE result format
560 '_type': 'compat_list',
561 'entries': ie_result,
563 self.add_default_extra_info(ie_result, ie, url)
565 return self.process_ie_result(ie_result, download, extra_info)
568 except ExtractorError as de: # An error we somewhat expected
569 self.report_error(compat_str(de), de.format_traceback())
571 except MaxDownloadsReached:
573 except Exception as e:
574 if self.params.get('ignoreerrors', False):
575 self.report_error(compat_str(e), tb=compat_str(traceback.format_exc()))
580 self.report_error('no suitable InfoExtractor for URL %s' % url)
582 def add_default_extra_info(self, ie_result, ie, url):
583 self.add_extra_info(ie_result, {
584 'extractor': ie.IE_NAME,
586 'webpage_url_basename': url_basename(url),
587 'extractor_key': ie.ie_key(),
590 def process_ie_result(self, ie_result, download=True, extra_info={}):
592 Take the result of the ie(may be modified) and resolve all unresolved
593 references (URLs, playlist items).
595 It will also download the videos if 'download'.
596 Returns the resolved ie_result.
599 result_type = ie_result.get('_type', 'video')
601 if result_type in ('url', 'url_transparent'):
602 extract_flat = self.params.get('extract_flat', False)
603 if ((extract_flat == 'in_playlist' and 'playlist' in extra_info) or
604 extract_flat is True):
605 if self.params.get('forcejson', False):
606 self.to_stdout(json.dumps(ie_result))
609 if result_type == 'video':
610 self.add_extra_info(ie_result, extra_info)
611 return self.process_video_result(ie_result, download=download)
612 elif result_type == 'url':
613 # We have to add extra_info to the results because it may be
614 # contained in a playlist
615 return self.extract_info(ie_result['url'],
617 ie_key=ie_result.get('ie_key'),
618 extra_info=extra_info)
619 elif result_type == 'url_transparent':
620 # Use the information from the embedding page
621 info = self.extract_info(
622 ie_result['url'], ie_key=ie_result.get('ie_key'),
623 extra_info=extra_info, download=False, process=False)
625 force_properties = dict(
626 (k, v) for k, v in ie_result.items() if v is not None)
627 for f in ('_type', 'url'):
628 if f in force_properties:
629 del force_properties[f]
630 new_result = info.copy()
631 new_result.update(force_properties)
633 assert new_result.get('_type') != 'url_transparent'
635 return self.process_ie_result(
636 new_result, download=download, extra_info=extra_info)
637 elif result_type == 'playlist' or result_type == 'multi_video':
638 # We process each entry in the playlist
639 playlist = ie_result.get('title', None) or ie_result.get('id', None)
640 self.to_screen('[download] Downloading playlist: %s' % playlist)
642 playlist_results = []
644 playliststart = self.params.get('playliststart', 1) - 1
645 playlistend = self.params.get('playlistend', None)
646 # For backwards compatibility, interpret -1 as whole list
647 if playlistend == -1:
650 ie_entries = ie_result['entries']
651 if isinstance(ie_entries, list):
652 n_all_entries = len(ie_entries)
653 entries = ie_entries[playliststart:playlistend]
654 n_entries = len(entries)
656 "[%s] playlist %s: Collected %d video ids (downloading %d of them)" %
657 (ie_result['extractor'], playlist, n_all_entries, n_entries))
658 elif isinstance(ie_entries, PagedList):
659 entries = ie_entries.getslice(
660 playliststart, playlistend)
661 n_entries = len(entries)
663 "[%s] playlist %s: Downloading %d videos" %
664 (ie_result['extractor'], playlist, n_entries))
666 entries = list(itertools.islice(
667 ie_entries, playliststart, playlistend))
668 n_entries = len(entries)
670 "[%s] playlist %s: Downloading %d videos" %
671 (ie_result['extractor'], playlist, n_entries))
673 for i, entry in enumerate(entries, 1):
674 self.to_screen('[download] Downloading video #%s of %s' % (i, n_entries))
676 'n_entries': n_entries,
677 'playlist': playlist,
678 'playlist_id': ie_result.get('id'),
679 'playlist_title': ie_result.get('title'),
680 'playlist_index': i + playliststart,
681 'extractor': ie_result['extractor'],
682 'webpage_url': ie_result['webpage_url'],
683 'webpage_url_basename': url_basename(ie_result['webpage_url']),
684 'extractor_key': ie_result['extractor_key'],
687 reason = self._match_entry(entry)
688 if reason is not None:
689 self.to_screen('[download] ' + reason)
692 entry_result = self.process_ie_result(entry,
695 playlist_results.append(entry_result)
696 ie_result['entries'] = playlist_results
698 elif result_type == 'compat_list':
700 'Extractor %s returned a compat_list result. '
701 'It needs to be updated.' % ie_result.get('extractor'))
707 'extractor': ie_result['extractor'],
708 'webpage_url': ie_result['webpage_url'],
709 'webpage_url_basename': url_basename(ie_result['webpage_url']),
710 'extractor_key': ie_result['extractor_key'],
714 ie_result['entries'] = [
715 self.process_ie_result(_fixup(r), download, extra_info)
716 for r in ie_result['entries']
720 raise Exception('Invalid result type: %s' % result_type)
722 def select_format(self, format_spec, available_formats):
723 if format_spec == 'best' or format_spec is None:
724 return available_formats[-1]
725 elif format_spec == 'worst':
726 return available_formats[0]
727 elif format_spec == 'bestaudio':
729 f for f in available_formats
730 if f.get('vcodec') == 'none']
732 return audio_formats[-1]
733 elif format_spec == 'worstaudio':
735 f for f in available_formats
736 if f.get('vcodec') == 'none']
738 return audio_formats[0]
739 elif format_spec == 'bestvideo':
741 f for f in available_formats
742 if f.get('acodec') == 'none']
744 return video_formats[-1]
745 elif format_spec == 'worstvideo':
747 f for f in available_formats
748 if f.get('acodec') == 'none']
750 return video_formats[0]
752 extensions = ['mp4', 'flv', 'webm', '3gp', 'm4a']
753 if format_spec in extensions:
754 filter_f = lambda f: f['ext'] == format_spec
756 filter_f = lambda f: f['format_id'] == format_spec
757 matches = list(filter(filter_f, available_formats))
762 def process_video_result(self, info_dict, download=True):
763 assert info_dict.get('_type', 'video') == 'video'
765 if 'id' not in info_dict:
766 raise ExtractorError('Missing "id" field in extractor result')
767 if 'title' not in info_dict:
768 raise ExtractorError('Missing "title" field in extractor result')
770 if 'playlist' not in info_dict:
771 # It isn't part of a playlist
772 info_dict['playlist'] = None
773 info_dict['playlist_index'] = None
775 thumbnails = info_dict.get('thumbnails')
777 thumbnails.sort(key=lambda t: (
778 t.get('width'), t.get('height'), t.get('url')))
780 if 'width' in t and 'height' in t:
781 t['resolution'] = '%dx%d' % (t['width'], t['height'])
783 if thumbnails and 'thumbnail' not in info_dict:
784 info_dict['thumbnail'] = thumbnails[-1]['url']
786 if 'display_id' not in info_dict and 'id' in info_dict:
787 info_dict['display_id'] = info_dict['id']
789 if info_dict.get('upload_date') is None and info_dict.get('timestamp') is not None:
790 # Working around negative timestamps in Windows
791 # (see http://bugs.python.org/issue1646728)
792 if info_dict['timestamp'] < 0 and os.name == 'nt':
793 info_dict['timestamp'] = 0
794 upload_date = datetime.datetime.utcfromtimestamp(
795 info_dict['timestamp'])
796 info_dict['upload_date'] = upload_date.strftime('%Y%m%d')
798 # This extractors handle format selection themselves
799 if info_dict['extractor'] in ['Youku']:
801 self.process_info(info_dict)
804 # We now pick which formats have to be downloaded
805 if info_dict.get('formats') is None:
806 # There's only one format available
807 formats = [info_dict]
809 formats = info_dict['formats']
812 raise ExtractorError('No video formats found!')
814 # We check that all the formats have the format and format_id fields
815 for i, format in enumerate(formats):
816 if 'url' not in format:
817 raise ExtractorError('Missing "url" key in result (index %d)' % i)
819 if format.get('format_id') is None:
820 format['format_id'] = compat_str(i)
821 if format.get('format') is None:
822 format['format'] = '{id} - {res}{note}'.format(
823 id=format['format_id'],
824 res=self.format_resolution(format),
825 note=' ({0})'.format(format['format_note']) if format.get('format_note') is not None else '',
827 # Automatically determine file extension if missing
828 if 'ext' not in format:
829 format['ext'] = determine_ext(format['url']).lower()
831 format_limit = self.params.get('format_limit', None)
833 formats = list(takewhile_inclusive(
834 lambda f: f['format_id'] != format_limit, formats
837 # TODO Central sorting goes here
839 if formats[0] is not info_dict:
840 # only set the 'formats' fields if the original info_dict list them
841 # otherwise we end up with a circular reference, the first (and unique)
842 # element in the 'formats' field in info_dict is info_dict itself,
843 # wich can't be exported to json
844 info_dict['formats'] = formats
845 if self.params.get('listformats', None):
846 self.list_formats(info_dict)
849 req_format = self.params.get('format')
850 if req_format is None:
852 formats_to_download = []
853 # The -1 is for supporting YoutubeIE
854 if req_format in ('-1', 'all'):
855 formats_to_download = formats
857 for rfstr in req_format.split(','):
858 # We can accept formats requested in the format: 34/5/best, we pick
859 # the first that is available, starting from left
860 req_formats = rfstr.split('/')
861 for rf in req_formats:
862 if re.match(r'.+?\+.+?', rf) is not None:
863 # Two formats have been requested like '137+139'
864 format_1, format_2 = rf.split('+')
865 formats_info = (self.select_format(format_1, formats),
866 self.select_format(format_2, formats))
867 if all(formats_info):
868 # The first format must contain the video and the
870 if formats_info[0].get('vcodec') == 'none':
871 self.report_error('The first format must '
872 'contain the video, try using '
873 '"-f %s+%s"' % (format_2, format_1))
876 'requested_formats': formats_info,
878 'ext': formats_info[0]['ext'],
881 selected_format = None
883 selected_format = self.select_format(rf, formats)
884 if selected_format is not None:
885 formats_to_download.append(selected_format)
887 if not formats_to_download:
888 raise ExtractorError('requested format not available',
892 if len(formats_to_download) > 1:
893 self.to_screen('[info] %s: downloading video in %s formats' % (info_dict['id'], len(formats_to_download)))
894 for format in formats_to_download:
895 new_info = dict(info_dict)
896 new_info.update(format)
897 self.process_info(new_info)
898 # We update the info dict with the best quality format (backwards compatibility)
899 info_dict.update(formats_to_download[-1])
902 def process_info(self, info_dict):
903 """Process a single resolved IE result."""
905 assert info_dict.get('_type', 'video') == 'video'
907 max_downloads = self.params.get('max_downloads')
908 if max_downloads is not None:
909 if self._num_downloads >= int(max_downloads):
910 raise MaxDownloadsReached()
912 info_dict['fulltitle'] = info_dict['title']
913 if len(info_dict['title']) > 200:
914 info_dict['title'] = info_dict['title'][:197] + '...'
916 # Keep for backwards compatibility
917 info_dict['stitle'] = info_dict['title']
919 if 'format' not in info_dict:
920 info_dict['format'] = info_dict['ext']
922 reason = self._match_entry(info_dict)
923 if reason is not None:
924 self.to_screen('[download] ' + reason)
927 self._num_downloads += 1
929 filename = self.prepare_filename(info_dict)
932 if self.params.get('forcetitle', False):
933 self.to_stdout(info_dict['fulltitle'])
934 if self.params.get('forceid', False):
935 self.to_stdout(info_dict['id'])
936 if self.params.get('forceurl', False):
937 if info_dict.get('requested_formats') is not None:
938 for f in info_dict['requested_formats']:
939 self.to_stdout(f['url'] + f.get('play_path', ''))
941 # For RTMP URLs, also include the playpath
942 self.to_stdout(info_dict['url'] + info_dict.get('play_path', ''))
943 if self.params.get('forcethumbnail', False) and info_dict.get('thumbnail') is not None:
944 self.to_stdout(info_dict['thumbnail'])
945 if self.params.get('forcedescription', False) and info_dict.get('description') is not None:
946 self.to_stdout(info_dict['description'])
947 if self.params.get('forcefilename', False) and filename is not None:
948 self.to_stdout(filename)
949 if self.params.get('forceduration', False) and info_dict.get('duration') is not None:
950 self.to_stdout(formatSeconds(info_dict['duration']))
951 if self.params.get('forceformat', False):
952 self.to_stdout(info_dict['format'])
953 if self.params.get('forcejson', False):
954 info_dict['_filename'] = filename
955 self.to_stdout(json.dumps(info_dict))
956 if self.params.get('dump_single_json', False):
957 info_dict['_filename'] = filename
959 # Do nothing else if in simulate mode
960 if self.params.get('simulate', False):
967 dn = os.path.dirname(encodeFilename(filename))
968 if dn and not os.path.exists(dn):
970 except (OSError, IOError) as err:
971 self.report_error('unable to create directory ' + compat_str(err))
974 if self.params.get('writedescription', False):
975 descfn = filename + '.description'
976 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(descfn)):
977 self.to_screen('[info] Video description is already present')
980 self.to_screen('[info] Writing video description to: ' + descfn)
981 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
982 descfile.write(info_dict['description'])
983 except (KeyError, TypeError):
984 self.report_warning('There\'s no description to write.')
985 except (OSError, IOError):
986 self.report_error('Cannot write description file ' + descfn)
989 if self.params.get('writeannotations', False):
990 annofn = filename + '.annotations.xml'
991 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(annofn)):
992 self.to_screen('[info] Video annotations are already present')
995 self.to_screen('[info] Writing video annotations to: ' + annofn)
996 with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
997 annofile.write(info_dict['annotations'])
998 except (KeyError, TypeError):
999 self.report_warning('There are no annotations to write.')
1000 except (OSError, IOError):
1001 self.report_error('Cannot write annotations file: ' + annofn)
1004 subtitles_are_requested = any([self.params.get('writesubtitles', False),
1005 self.params.get('writeautomaticsub')])
1007 if subtitles_are_requested and 'subtitles' in info_dict and info_dict['subtitles']:
1008 # subtitles download errors are already managed as troubles in relevant IE
1009 # that way it will silently go on when used with unsupporting IE
1010 subtitles = info_dict['subtitles']
1011 sub_format = self.params.get('subtitlesformat', 'srt')
1012 for sub_lang in subtitles.keys():
1013 sub = subtitles[sub_lang]
1017 sub_filename = subtitles_filename(filename, sub_lang, sub_format)
1018 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(sub_filename)):
1019 self.to_screen('[info] Video subtitle %s.%s is already_present' % (sub_lang, sub_format))
1021 self.to_screen('[info] Writing video subtitles to: ' + sub_filename)
1022 with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
1024 except (OSError, IOError):
1025 self.report_error('Cannot write subtitles file ' + sub_filename)
1028 if self.params.get('writeinfojson', False):
1029 infofn = os.path.splitext(filename)[0] + '.info.json'
1030 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(infofn)):
1031 self.to_screen('[info] Video description metadata is already present')
1033 self.to_screen('[info] Writing video description metadata as JSON to: ' + infofn)
1035 write_json_file(info_dict, infofn)
1036 except (OSError, IOError):
1037 self.report_error('Cannot write metadata to JSON file ' + infofn)
1040 if self.params.get('writethumbnail', False):
1041 if info_dict.get('thumbnail') is not None:
1042 thumb_format = determine_ext(info_dict['thumbnail'], 'jpg')
1043 thumb_filename = os.path.splitext(filename)[0] + '.' + thumb_format
1044 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(thumb_filename)):
1045 self.to_screen('[%s] %s: Thumbnail is already present' %
1046 (info_dict['extractor'], info_dict['id']))
1048 self.to_screen('[%s] %s: Downloading thumbnail ...' %
1049 (info_dict['extractor'], info_dict['id']))
1051 uf = self.urlopen(info_dict['thumbnail'])
1052 with open(thumb_filename, 'wb') as thumbf:
1053 shutil.copyfileobj(uf, thumbf)
1054 self.to_screen('[%s] %s: Writing thumbnail to: %s' %
1055 (info_dict['extractor'], info_dict['id'], thumb_filename))
1056 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1057 self.report_warning('Unable to download thumbnail "%s": %s' %
1058 (info_dict['thumbnail'], compat_str(err)))
1060 if not self.params.get('skip_download', False):
1061 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(filename)):
1066 fd = get_suitable_downloader(info)(self, self.params)
1067 for ph in self._progress_hooks:
1068 fd.add_progress_hook(ph)
1069 if self.params.get('verbose'):
1070 self.to_stdout('[debug] Invoking downloader on %r' % info.get('url'))
1071 return fd.download(name, info)
1072 if info_dict.get('requested_formats') is not None:
1075 merger = FFmpegMergerPP(self, not self.params.get('keepvideo'))
1076 if not merger._executable:
1078 self.report_warning('You have requested multiple '
1079 'formats but ffmpeg or avconv are not installed.'
1080 ' The formats won\'t be merged')
1082 postprocessors = [merger]
1083 for f in info_dict['requested_formats']:
1084 new_info = dict(info_dict)
1086 fname = self.prepare_filename(new_info)
1087 fname = prepend_extension(fname, 'f%s' % f['format_id'])
1088 downloaded.append(fname)
1089 partial_success = dl(fname, new_info)
1090 success = success and partial_success
1091 info_dict['__postprocessors'] = postprocessors
1092 info_dict['__files_to_merge'] = downloaded
1094 # Just a single file
1095 success = dl(filename, info_dict)
1096 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1097 self.report_error('unable to download video data: %s' % str(err))
1099 except (OSError, IOError) as err:
1100 raise UnavailableVideoError(err)
1101 except (ContentTooShortError, ) as err:
1102 self.report_error('content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
1107 self.post_process(filename, info_dict)
1108 except (PostProcessingError) as err:
1109 self.report_error('postprocessing: %s' % str(err))
1112 self.record_download_archive(info_dict)
1114 def download(self, url_list):
1115 """Download a given list of URLs."""
1116 outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
1117 if (len(url_list) > 1 and
1119 and self.params.get('max_downloads') != 1):
1120 raise SameFileError(outtmpl)
1122 for url in url_list:
1124 # It also downloads the videos
1125 res = self.extract_info(url)
1126 except UnavailableVideoError:
1127 self.report_error('unable to download video')
1128 except MaxDownloadsReached:
1129 self.to_screen('[info] Maximum number of downloaded files reached.')
1132 if self.params.get('dump_single_json', False):
1133 self.to_stdout(json.dumps(res))
1135 return self._download_retcode
1137 def download_with_info_file(self, info_filename):
1138 with io.open(info_filename, 'r', encoding='utf-8') as f:
1141 self.process_ie_result(info, download=True)
1142 except DownloadError:
1143 webpage_url = info.get('webpage_url')
1144 if webpage_url is not None:
1145 self.report_warning('The info failed to download, trying with "%s"' % webpage_url)
1146 return self.download([webpage_url])
1149 return self._download_retcode
1151 def post_process(self, filename, ie_info):
1152 """Run all the postprocessors on the given file."""
1153 info = dict(ie_info)
1154 info['filepath'] = filename
1157 if ie_info.get('__postprocessors') is not None:
1158 pps_chain.extend(ie_info['__postprocessors'])
1159 pps_chain.extend(self._pps)
1160 for pp in pps_chain:
1162 keep_video_wish, new_info = pp.run(info)
1163 if keep_video_wish is not None:
1165 keep_video = keep_video_wish
1166 elif keep_video is None:
1167 # No clear decision yet, let IE decide
1168 keep_video = keep_video_wish
1169 except PostProcessingError as e:
1170 self.report_error(e.msg)
1171 if keep_video is False and not self.params.get('keepvideo', False):
1173 self.to_screen('Deleting original file %s (pass -k to keep)' % filename)
1174 os.remove(encodeFilename(filename))
1175 except (IOError, OSError):
1176 self.report_warning('Unable to remove downloaded video file')
1178 def _make_archive_id(self, info_dict):
1179 # Future-proof against any change in case
1180 # and backwards compatibility with prior versions
1181 extractor = info_dict.get('extractor_key')
1182 if extractor is None:
1183 if 'id' in info_dict:
1184 extractor = info_dict.get('ie_key') # key in a playlist
1185 if extractor is None:
1186 return None # Incomplete video information
1187 return extractor.lower() + ' ' + info_dict['id']
1189 def in_download_archive(self, info_dict):
1190 fn = self.params.get('download_archive')
1194 vid_id = self._make_archive_id(info_dict)
1196 return False # Incomplete video information
1199 with locked_file(fn, 'r', encoding='utf-8') as archive_file:
1200 for line in archive_file:
1201 if line.strip() == vid_id:
1203 except IOError as ioe:
1204 if ioe.errno != errno.ENOENT:
1208 def record_download_archive(self, info_dict):
1209 fn = self.params.get('download_archive')
1212 vid_id = self._make_archive_id(info_dict)
1214 with locked_file(fn, 'a', encoding='utf-8') as archive_file:
1215 archive_file.write(vid_id + '\n')
1218 def format_resolution(format, default='unknown'):
1219 if format.get('vcodec') == 'none':
1221 if format.get('resolution') is not None:
1222 return format['resolution']
1223 if format.get('height') is not None:
1224 if format.get('width') is not None:
1225 res = '%sx%s' % (format['width'], format['height'])
1227 res = '%sp' % format['height']
1228 elif format.get('width') is not None:
1229 res = '?x%d' % format['width']
1234 def _format_note(self, fdict):
1236 if fdict.get('ext') in ['f4f', 'f4m']:
1237 res += '(unsupported) '
1238 if fdict.get('format_note') is not None:
1239 res += fdict['format_note'] + ' '
1240 if fdict.get('tbr') is not None:
1241 res += '%4dk ' % fdict['tbr']
1242 if fdict.get('container') is not None:
1245 res += '%s container' % fdict['container']
1246 if (fdict.get('vcodec') is not None and
1247 fdict.get('vcodec') != 'none'):
1250 res += fdict['vcodec']
1251 if fdict.get('vbr') is not None:
1253 elif fdict.get('vbr') is not None and fdict.get('abr') is not None:
1255 if fdict.get('vbr') is not None:
1256 res += '%4dk' % fdict['vbr']
1257 if fdict.get('fps') is not None:
1258 res += ', %sfps' % fdict['fps']
1259 if fdict.get('acodec') is not None:
1262 if fdict['acodec'] == 'none':
1265 res += '%-5s' % fdict['acodec']
1266 elif fdict.get('abr') is not None:
1270 if fdict.get('abr') is not None:
1271 res += '@%3dk' % fdict['abr']
1272 if fdict.get('asr') is not None:
1273 res += ' (%5dHz)' % fdict['asr']
1274 if fdict.get('filesize') is not None:
1277 res += format_bytes(fdict['filesize'])
1278 elif fdict.get('filesize_approx') is not None:
1281 res += '~' + format_bytes(fdict['filesize_approx'])
1284 def list_formats(self, info_dict):
1285 def line(format, idlen=20):
1286 return (('%-' + compat_str(idlen + 1) + 's%-10s%-12s%s') % (
1287 format['format_id'],
1289 self.format_resolution(format),
1290 self._format_note(format),
1293 formats = info_dict.get('formats', [info_dict])
1294 idlen = max(len('format code'),
1295 max(len(f['format_id']) for f in formats))
1296 formats_s = [line(f, idlen) for f in formats]
1297 if len(formats) > 1:
1298 formats_s[0] += (' ' if self._format_note(formats[0]) else '') + '(worst)'
1299 formats_s[-1] += (' ' if self._format_note(formats[-1]) else '') + '(best)'
1301 header_line = line({
1302 'format_id': 'format code', 'ext': 'extension',
1303 'resolution': 'resolution', 'format_note': 'note'}, idlen=idlen)
1304 self.to_screen('[info] Available formats for %s:\n%s\n%s' %
1305 (info_dict['id'], header_line, '\n'.join(formats_s)))
1307 def urlopen(self, req):
1308 """ Start an HTTP download """
1310 # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not
1311 # always respected by websites, some tend to give out URLs with non percent-encoded
1312 # non-ASCII characters (see telemb.py, ard.py [#3412])
1313 # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991)
1314 # To work around aforementioned issue we will replace request's original URL with
1315 # percent-encoded one
1316 req_is_string = isinstance(req, basestring if sys.version_info < (3, 0) else compat_str)
1317 url = req if req_is_string else req.get_full_url()
1318 url_escaped = escape_url(url)
1320 # Substitute URL if any change after escaping
1321 if url != url_escaped:
1325 req = compat_urllib_request.Request(
1326 url_escaped, data=req.data, headers=req.headers,
1327 origin_req_host=req.origin_req_host, unverifiable=req.unverifiable)
1329 return self._opener.open(req, timeout=self._socket_timeout)
1331 def print_debug_header(self):
1332 if not self.params.get('verbose'):
1335 if type('') is not compat_str:
1336 # Python 2.6 on SLES11 SP1 (https://github.com/rg3/youtube-dl/issues/3326)
1337 self.report_warning(
1338 'Your Python is broken! Update to a newer and supported version')
1340 stdout_encoding = getattr(
1341 sys.stdout, 'encoding', 'missing (%s)' % type(sys.stdout).__name__)
1343 '[debug] Encodings: locale %s, fs %s, out %s, pref %s\n' % (
1344 locale.getpreferredencoding(),
1345 sys.getfilesystemencoding(),
1347 self.get_encoding()))
1348 write_string(encoding_str, encoding=None)
1350 self._write_string('[debug] youtube-dl version ' + __version__ + '\n')
1352 sp = subprocess.Popen(
1353 ['git', 'rev-parse', '--short', 'HEAD'],
1354 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
1355 cwd=os.path.dirname(os.path.abspath(__file__)))
1356 out, err = sp.communicate()
1357 out = out.decode().strip()
1358 if re.match('[0-9a-f]+', out):
1359 self._write_string('[debug] Git HEAD: ' + out + '\n')
1365 self._write_string('[debug] Python version %s - %s\n' % (
1366 platform.python_version(), platform_name()))
1368 exe_versions = FFmpegPostProcessor.get_versions()
1369 exe_versions['rtmpdump'] = rtmpdump_version()
1370 exe_str = ', '.join(
1372 for exe, v in sorted(exe_versions.items())
1377 self._write_string('[debug] exe versions: %s\n' % exe_str)
1380 for handler in self._opener.handlers:
1381 if hasattr(handler, 'proxies'):
1382 proxy_map.update(handler.proxies)
1383 self._write_string('[debug] Proxy map: ' + compat_str(proxy_map) + '\n')
1385 def _setup_opener(self):
1386 timeout_val = self.params.get('socket_timeout')
1387 self._socket_timeout = 600 if timeout_val is None else float(timeout_val)
1389 opts_cookiefile = self.params.get('cookiefile')
1390 opts_proxy = self.params.get('proxy')
1392 if opts_cookiefile is None:
1393 self.cookiejar = compat_cookiejar.CookieJar()
1395 self.cookiejar = compat_cookiejar.MozillaCookieJar(
1397 if os.access(opts_cookiefile, os.R_OK):
1398 self.cookiejar.load()
1400 cookie_processor = compat_urllib_request.HTTPCookieProcessor(
1402 if opts_proxy is not None:
1403 if opts_proxy == '':
1406 proxies = {'http': opts_proxy, 'https': opts_proxy}
1408 proxies = compat_urllib_request.getproxies()
1409 # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
1410 if 'http' in proxies and 'https' not in proxies:
1411 proxies['https'] = proxies['http']
1412 proxy_handler = compat_urllib_request.ProxyHandler(proxies)
1414 debuglevel = 1 if self.params.get('debug_printtraffic') else 0
1415 https_handler = make_HTTPS_handler(
1416 self.params.get('nocheckcertificate', False), debuglevel=debuglevel)
1417 ydlh = YoutubeDLHandler(debuglevel=debuglevel)
1418 opener = compat_urllib_request.build_opener(
1419 https_handler, proxy_handler, cookie_processor, ydlh)
1420 # Delete the default user-agent header, which would otherwise apply in
1421 # cases where our custom HTTP handler doesn't come into play
1422 # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
1423 opener.addheaders = []
1424 self._opener = opener
1426 def encode(self, s):
1427 if isinstance(s, bytes):
1428 return s # Already encoded
1431 return s.encode(self.get_encoding())
1432 except UnicodeEncodeError as err:
1433 err.reason = err.reason + '. Check your system encoding configuration or use the --encoding option.'
1436 def get_encoding(self):
1437 encoding = self.params.get('encoding')
1438 if encoding is None:
1439 encoding = preferredencoding()