2 # -*- coding: utf-8 -*-
4 from __future__ import absolute_import, unicode_literals
33 compat_get_terminal_size,
38 compat_urllib_request,
57 PerRequestProxyHandler,
67 UnavailableVideoError,
78 from .cache import Cache
79 from .extractor import get_info_extractor, gen_extractors
80 from .downloader import get_suitable_downloader
81 from .downloader.rtmp import rtmpdump_version
82 from .postprocessor import (
84 FFmpegFixupStretchedPP,
89 from .version import __version__
92 class YoutubeDL(object):
95 YoutubeDL objects are the ones responsible of downloading the
96 actual video file and writing it to disk if the user has requested
97 it, among some other tasks. In most cases there should be one per
98 program. As, given a video URL, the downloader doesn't know how to
99 extract all the needed information, task that InfoExtractors do, it
100 has to pass the URL to one of them.
102 For this, YoutubeDL objects have a method that allows
103 InfoExtractors to be registered in a given order. When it is passed
104 a URL, the YoutubeDL object handles it to the first InfoExtractor it
105 finds that reports being able to handle it. The InfoExtractor extracts
106 all the information about the video or videos the URL refers to, and
107 YoutubeDL process the extracted information, possibly using a File
108 Downloader to download the video.
110 YoutubeDL objects accept a lot of parameters. In order not to saturate
111 the object constructor with arguments, it receives a dictionary of
112 options instead. These options are available through the params
113 attribute for the InfoExtractors to use. The YoutubeDL also
114 registers itself as the downloader in charge for the InfoExtractors
115 that are added to it, so this is a "mutual registration".
119 username: Username for authentication purposes.
120 password: Password for authentication purposes.
121 videopassword: Password for acces a video.
122 usenetrc: Use netrc for authentication instead.
123 verbose: Print additional info to stdout.
124 quiet: Do not print messages to stdout.
125 no_warnings: Do not print out anything for warnings.
126 forceurl: Force printing final URL.
127 forcetitle: Force printing title.
128 forceid: Force printing ID.
129 forcethumbnail: Force printing thumbnail URL.
130 forcedescription: Force printing description.
131 forcefilename: Force printing final filename.
132 forceduration: Force printing duration.
133 forcejson: Force printing info_dict as JSON.
134 dump_single_json: Force printing the info_dict of the whole playlist
135 (or video) as a single JSON line.
136 simulate: Do not download the video files.
137 format: Video format code. See options.py for more information.
138 outtmpl: Template for output names.
139 restrictfilenames: Do not allow "&" and spaces in file names
140 ignoreerrors: Do not stop on download errors.
141 nooverwrites: Prevent overwriting files.
142 playliststart: Playlist item to start at.
143 playlistend: Playlist item to end at.
144 playlist_items: Specific indices of playlist to download.
145 playlistreverse: Download playlist items in reverse order.
146 matchtitle: Download only matching titles.
147 rejecttitle: Reject downloads for matching titles.
148 logger: Log messages to a logging.Logger instance.
149 logtostderr: Log messages to stderr instead of stdout.
150 writedescription: Write the video description to a .description file
151 writeinfojson: Write the video description to a .info.json file
152 writeannotations: Write the video annotations to a .annotations.xml file
153 writethumbnail: Write the thumbnail image to a file
154 write_all_thumbnails: Write all thumbnail formats to files
155 writesubtitles: Write the video subtitles to a file
156 writeautomaticsub: Write the automatic subtitles to a file
157 allsubtitles: Downloads all the subtitles of the video
158 (requires writesubtitles or writeautomaticsub)
159 listsubtitles: Lists all available subtitles for the video
160 subtitlesformat: The format code for subtitles
161 subtitleslangs: List of languages of the subtitles to download
162 keepvideo: Keep the video file after post-processing
163 daterange: A DateRange object, download only if the upload_date is in the range.
164 skip_download: Skip the actual download of the video file
165 cachedir: Location of the cache files in the filesystem.
166 False to disable filesystem cache.
167 noplaylist: Download single video instead of a playlist if in doubt.
168 age_limit: An integer representing the user's age in years.
169 Unsuitable videos for the given age are skipped.
170 min_views: An integer representing the minimum view count the video
171 must have in order to not be skipped.
172 Videos without view count information are always
173 downloaded. None for no limit.
174 max_views: An integer representing the maximum view count.
175 Videos that are more popular than that are not
177 Videos without view count information are always
178 downloaded. None for no limit.
179 download_archive: File name of a file where all downloads are recorded.
180 Videos already present in the file are not downloaded
182 cookiefile: File name where cookies should be read from and dumped to.
183 nocheckcertificate:Do not verify SSL certificates
184 prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
185 At the moment, this is only supported by YouTube.
186 proxy: URL of the proxy server to use
187 cn_verification_proxy: URL of the proxy to use for IP address verification
188 on Chinese sites. (Experimental)
189 socket_timeout: Time to wait for unresponsive hosts, in seconds
190 bidi_workaround: Work around buggy terminals without bidirectional text
191 support, using fridibi
192 debug_printtraffic:Print out sent and received HTTP traffic
193 include_ads: Download ads as well
194 default_search: Prepend this string if an input url is not valid.
195 'auto' for elaborate guessing
196 encoding: Use this encoding instead of the system-specified.
197 extract_flat: Do not resolve URLs, return the immediate result.
198 Pass in 'in_playlist' to only show this behavior for
200 postprocessors: A list of dictionaries, each with an entry
201 * key: The name of the postprocessor. See
202 youtube_dl/postprocessor/__init__.py for a list.
203 as well as any further keyword arguments for the
205 progress_hooks: A list of functions that get called on download
206 progress, with a dictionary with the entries
207 * status: One of "downloading", "error", or "finished".
208 Check this first and ignore unknown values.
210 If status is one of "downloading", or "finished", the
211 following properties may also be present:
212 * filename: The final filename (always present)
213 * tmpfilename: The filename we're currently writing to
214 * downloaded_bytes: Bytes on disk
215 * total_bytes: Size of the whole file, None if unknown
216 * total_bytes_estimate: Guess of the eventual file size,
218 * elapsed: The number of seconds since download started.
219 * eta: The estimated time in seconds, None if unknown
220 * speed: The download speed in bytes/second, None if
222 * fragment_index: The counter of the currently
223 downloaded video fragment.
224 * fragment_count: The number of fragments (= individual
225 files that will be merged)
227 Progress hooks are guaranteed to be called at least once
228 (with status "finished") if the download is successful.
229 merge_output_format: Extension to use when merging formats.
230 fixup: Automatically correct known faults of the file.
232 - "never": do nothing
233 - "warn": only emit a warning
234 - "detect_or_warn": check whether we can do anything
235 about it, warn otherwise (default)
236 source_address: (Experimental) Client-side IP address to bind to.
237 call_home: Boolean, true iff we are allowed to contact the
238 youtube-dl servers for debugging.
239 sleep_interval: Number of seconds to sleep before each download.
240 listformats: Print an overview of available video formats and exit.
241 list_thumbnails: Print a table of all thumbnails and exit.
242 match_filter: A function that gets called with the info_dict of
244 If it returns a message, the video is ignored.
245 If it returns None, the video is downloaded.
246 match_filter_func in utils.py is one example for this.
247 no_color: Do not emit color codes in output.
249 The following options determine which downloader is picked:
250 external_downloader: Executable of the external downloader to call.
251 None or unset for standard (built-in) downloader.
252 hls_prefer_native: Use the native HLS downloader instead of ffmpeg/avconv.
254 The following parameters are not used by YoutubeDL itself, they are used by
255 the downloader (see youtube_dl/downloader/common.py):
256 nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
257 noresizebuffer, retries, continuedl, noprogress, consoletitle,
258 xattr_set_filesize, external_downloader_args.
260 The following options are used by the post processors:
261 prefer_ffmpeg: If True, use ffmpeg instead of avconv if both are available,
262 otherwise prefer avconv.
268 _download_retcode = None
269 _num_downloads = None
272 def __init__(self, params=None, auto_init=True):
273 """Create a FileDownloader object with the given options."""
277 self._ies_instances = {}
279 self._progress_hooks = []
280 self._download_retcode = 0
281 self._num_downloads = 0
282 self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
283 self._err_file = sys.stderr
285 self.cache = Cache(self)
287 if params.get('bidi_workaround', False):
290 master, slave = pty.openpty()
291 width = compat_get_terminal_size().columns
295 width_args = ['-w', str(width)]
297 stdin=subprocess.PIPE,
299 stderr=self._err_file)
301 self._output_process = subprocess.Popen(
302 ['bidiv'] + width_args, **sp_kwargs
305 self._output_process = subprocess.Popen(
306 ['fribidi', '-c', 'UTF-8'] + width_args, **sp_kwargs)
307 self._output_channel = os.fdopen(master, 'rb')
308 except OSError as ose:
310 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.')
314 if (sys.version_info >= (3,) and sys.platform != 'win32' and
315 sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968'] and
316 not params.get('restrictfilenames', False)):
317 # On Python 3, the Unicode filesystem API will throw errors (#1474)
319 'Assuming --restrict-filenames since file system encoding '
320 'cannot encode all characters. '
321 'Set the LC_ALL environment variable to fix this.')
322 self.params['restrictfilenames'] = True
324 if isinstance(params.get('outtmpl'), bytes):
326 'Parameter outtmpl is bytes, but should be a unicode string. '
327 'Put from __future__ import unicode_literals at the top of your code file or consider switching to Python 3.x.')
332 self.print_debug_header()
333 self.add_default_info_extractors()
335 for pp_def_raw in self.params.get('postprocessors', []):
336 pp_class = get_postprocessor(pp_def_raw['key'])
337 pp_def = dict(pp_def_raw)
339 pp = pp_class(self, **compat_kwargs(pp_def))
340 self.add_post_processor(pp)
342 for ph in self.params.get('progress_hooks', []):
343 self.add_progress_hook(ph)
345 def warn_if_short_id(self, argv):
346 # short YouTube ID starting with dash?
348 i for i, a in enumerate(argv)
349 if re.match(r'^-[0-9A-Za-z_-]{10}$', a)]
353 [a for i, a in enumerate(argv) if i not in idxs] +
354 ['--'] + [argv[i] for i in idxs]
357 'Long argument string detected. '
358 'Use -- to separate parameters and URLs, like this:\n%s\n' %
359 args_to_str(correct_argv))
361 def add_info_extractor(self, ie):
362 """Add an InfoExtractor object to the end of the list."""
364 self._ies_instances[ie.ie_key()] = ie
365 ie.set_downloader(self)
367 def get_info_extractor(self, ie_key):
369 Get an instance of an IE with name ie_key, it will try to get one from
370 the _ies list, if there's no instance it will create a new one and add
371 it to the extractor list.
373 ie = self._ies_instances.get(ie_key)
375 ie = get_info_extractor(ie_key)()
376 self.add_info_extractor(ie)
379 def add_default_info_extractors(self):
381 Add the InfoExtractors returned by gen_extractors to the end of the list
383 for ie in gen_extractors():
384 self.add_info_extractor(ie)
386 def add_post_processor(self, pp):
387 """Add a PostProcessor object to the end of the chain."""
389 pp.set_downloader(self)
391 def add_progress_hook(self, ph):
392 """Add the progress hook (currently only for the file downloader)"""
393 self._progress_hooks.append(ph)
395 def _bidi_workaround(self, message):
396 if not hasattr(self, '_output_channel'):
399 assert hasattr(self, '_output_process')
400 assert isinstance(message, compat_str)
401 line_count = message.count('\n') + 1
402 self._output_process.stdin.write((message + '\n').encode('utf-8'))
403 self._output_process.stdin.flush()
404 res = ''.join(self._output_channel.readline().decode('utf-8')
405 for _ in range(line_count))
406 return res[:-len('\n')]
408 def to_screen(self, message, skip_eol=False):
409 """Print message to stdout if not in quiet mode."""
410 return self.to_stdout(message, skip_eol, check_quiet=True)
412 def _write_string(self, s, out=None):
413 write_string(s, out=out, encoding=self.params.get('encoding'))
415 def to_stdout(self, message, skip_eol=False, check_quiet=False):
416 """Print message to stdout if not in quiet mode."""
417 if self.params.get('logger'):
418 self.params['logger'].debug(message)
419 elif not check_quiet or not self.params.get('quiet', False):
420 message = self._bidi_workaround(message)
421 terminator = ['\n', ''][skip_eol]
422 output = message + terminator
424 self._write_string(output, self._screen_file)
426 def to_stderr(self, message):
427 """Print message to stderr."""
428 assert isinstance(message, compat_str)
429 if self.params.get('logger'):
430 self.params['logger'].error(message)
432 message = self._bidi_workaround(message)
433 output = message + '\n'
434 self._write_string(output, self._err_file)
436 def to_console_title(self, message):
437 if not self.params.get('consoletitle', False):
439 if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
440 # c_wchar_p() might not be necessary if `message` is
441 # already of type unicode()
442 ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
443 elif 'TERM' in os.environ:
444 self._write_string('\033]0;%s\007' % message, self._screen_file)
446 def save_console_title(self):
447 if not self.params.get('consoletitle', False):
449 if 'TERM' in os.environ:
450 # Save the title on stack
451 self._write_string('\033[22;0t', self._screen_file)
453 def restore_console_title(self):
454 if not self.params.get('consoletitle', False):
456 if 'TERM' in os.environ:
457 # Restore the title from stack
458 self._write_string('\033[23;0t', self._screen_file)
461 self.save_console_title()
464 def __exit__(self, *args):
465 self.restore_console_title()
467 if self.params.get('cookiefile') is not None:
468 self.cookiejar.save()
470 def trouble(self, message=None, tb=None):
471 """Determine action to take when a download problem appears.
473 Depending on if the downloader has been configured to ignore
474 download errors or not, this method may throw an exception or
475 not when errors are found, after printing the message.
477 tb, if given, is additional traceback information.
479 if message is not None:
480 self.to_stderr(message)
481 if self.params.get('verbose'):
483 if sys.exc_info()[0]: # if .trouble has been called from an except block
485 if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
486 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
487 tb += compat_str(traceback.format_exc())
489 tb_data = traceback.format_list(traceback.extract_stack())
490 tb = ''.join(tb_data)
492 if not self.params.get('ignoreerrors', False):
493 if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
494 exc_info = sys.exc_info()[1].exc_info
496 exc_info = sys.exc_info()
497 raise DownloadError(message, exc_info)
498 self._download_retcode = 1
500 def report_warning(self, message):
502 Print the message to stderr, it will be prefixed with 'WARNING:'
503 If stderr is a tty file the 'WARNING:' will be colored
505 if self.params.get('logger') is not None:
506 self.params['logger'].warning(message)
508 if self.params.get('no_warnings'):
510 if not self.params.get('no_color') and self._err_file.isatty() and os.name != 'nt':
511 _msg_header = '\033[0;33mWARNING:\033[0m'
513 _msg_header = 'WARNING:'
514 warning_message = '%s %s' % (_msg_header, message)
515 self.to_stderr(warning_message)
517 def report_error(self, message, tb=None):
519 Do the same as trouble, but prefixes the message with 'ERROR:', colored
520 in red if stderr is a tty file.
522 if not self.params.get('no_color') and self._err_file.isatty() and os.name != 'nt':
523 _msg_header = '\033[0;31mERROR:\033[0m'
525 _msg_header = 'ERROR:'
526 error_message = '%s %s' % (_msg_header, message)
527 self.trouble(error_message, tb)
529 def report_file_already_downloaded(self, file_name):
530 """Report file has already been fully downloaded."""
532 self.to_screen('[download] %s has already been downloaded' % file_name)
533 except UnicodeEncodeError:
534 self.to_screen('[download] The file has already been downloaded')
536 def prepare_filename(self, info_dict):
537 """Generate the output filename."""
539 template_dict = dict(info_dict)
541 template_dict['epoch'] = int(time.time())
542 autonumber_size = self.params.get('autonumber_size')
543 if autonumber_size is None:
545 autonumber_templ = '%0' + str(autonumber_size) + 'd'
546 template_dict['autonumber'] = autonumber_templ % self._num_downloads
547 if template_dict.get('playlist_index') is not None:
548 template_dict['playlist_index'] = '%0*d' % (len(str(template_dict['n_entries'])), template_dict['playlist_index'])
549 if template_dict.get('resolution') is None:
550 if template_dict.get('width') and template_dict.get('height'):
551 template_dict['resolution'] = '%dx%d' % (template_dict['width'], template_dict['height'])
552 elif template_dict.get('height'):
553 template_dict['resolution'] = '%sp' % template_dict['height']
554 elif template_dict.get('width'):
555 template_dict['resolution'] = '?x%d' % template_dict['width']
557 sanitize = lambda k, v: sanitize_filename(
559 restricted=self.params.get('restrictfilenames'),
561 template_dict = dict((k, sanitize(k, v))
562 for k, v in template_dict.items()
564 template_dict = collections.defaultdict(lambda: 'NA', template_dict)
566 outtmpl = sanitize_path(self.params.get('outtmpl', DEFAULT_OUTTMPL))
567 tmpl = compat_expanduser(outtmpl)
568 filename = tmpl % template_dict
569 # Temporary fix for #4787
570 # 'Treat' all problem characters by passing filename through preferredencoding
571 # to workaround encoding issues with subprocess on python2 @ Windows
572 if sys.version_info < (3, 0) and sys.platform == 'win32':
573 filename = encodeFilename(filename, True).decode(preferredencoding())
575 except ValueError as err:
576 self.report_error('Error in output template: ' + str(err) + ' (encoding: ' + repr(preferredencoding()) + ')')
579 def _match_entry(self, info_dict, incomplete):
580 """ Returns None iff the file should be downloaded """
582 video_title = info_dict.get('title', info_dict.get('id', 'video'))
583 if 'title' in info_dict:
584 # This can happen when we're just evaluating the playlist
585 title = info_dict['title']
586 matchtitle = self.params.get('matchtitle', False)
588 if not re.search(matchtitle, title, re.IGNORECASE):
589 return '"' + title + '" title did not match pattern "' + matchtitle + '"'
590 rejecttitle = self.params.get('rejecttitle', False)
592 if re.search(rejecttitle, title, re.IGNORECASE):
593 return '"' + title + '" title matched reject pattern "' + rejecttitle + '"'
594 date = info_dict.get('upload_date', None)
596 dateRange = self.params.get('daterange', DateRange())
597 if date not in dateRange:
598 return '%s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
599 view_count = info_dict.get('view_count', None)
600 if view_count is not None:
601 min_views = self.params.get('min_views')
602 if min_views is not None and view_count < min_views:
603 return 'Skipping %s, because it has not reached minimum view count (%d/%d)' % (video_title, view_count, min_views)
604 max_views = self.params.get('max_views')
605 if max_views is not None and view_count > max_views:
606 return 'Skipping %s, because it has exceeded the maximum view count (%d/%d)' % (video_title, view_count, max_views)
607 if age_restricted(info_dict.get('age_limit'), self.params.get('age_limit')):
608 return 'Skipping "%s" because it is age restricted' % video_title
609 if self.in_download_archive(info_dict):
610 return '%s has already been recorded in archive' % video_title
613 match_filter = self.params.get('match_filter')
614 if match_filter is not None:
615 ret = match_filter(info_dict)
622 def add_extra_info(info_dict, extra_info):
623 '''Set the keys from extra_info in info dict if they are missing'''
624 for key, value in extra_info.items():
625 info_dict.setdefault(key, value)
627 def extract_info(self, url, download=True, ie_key=None, extra_info={},
630 Returns a list with a dictionary for each video we find.
631 If 'download', also downloads the videos.
632 extra_info is a dict containing the extra values to add to each result
636 ies = [self.get_info_extractor(ie_key)]
641 if not ie.suitable(url):
645 self.report_warning('The program functionality for this site has been marked as broken, '
646 'and will probably not work.')
649 ie_result = ie.extract(url)
650 if ie_result is None: # Finished already (backwards compatibility; listformats and friends should be moved here)
652 if isinstance(ie_result, list):
653 # Backwards compatibility: old IE result format
655 '_type': 'compat_list',
656 'entries': ie_result,
658 self.add_default_extra_info(ie_result, ie, url)
660 return self.process_ie_result(ie_result, download, extra_info)
663 except ExtractorError as de: # An error we somewhat expected
664 self.report_error(compat_str(de), de.format_traceback())
666 except MaxDownloadsReached:
668 except Exception as e:
669 if self.params.get('ignoreerrors', False):
670 self.report_error(compat_str(e), tb=compat_str(traceback.format_exc()))
675 self.report_error('no suitable InfoExtractor for URL %s' % url)
677 def add_default_extra_info(self, ie_result, ie, url):
678 self.add_extra_info(ie_result, {
679 'extractor': ie.IE_NAME,
681 'webpage_url_basename': url_basename(url),
682 'extractor_key': ie.ie_key(),
685 def process_ie_result(self, ie_result, download=True, extra_info={}):
687 Take the result of the ie(may be modified) and resolve all unresolved
688 references (URLs, playlist items).
690 It will also download the videos if 'download'.
691 Returns the resolved ie_result.
694 result_type = ie_result.get('_type', 'video')
696 if result_type in ('url', 'url_transparent'):
697 extract_flat = self.params.get('extract_flat', False)
698 if ((extract_flat == 'in_playlist' and 'playlist' in extra_info) or
699 extract_flat is True):
700 if self.params.get('forcejson', False):
701 self.to_stdout(json.dumps(ie_result))
704 if result_type == 'video':
705 self.add_extra_info(ie_result, extra_info)
706 return self.process_video_result(ie_result, download=download)
707 elif result_type == 'url':
708 # We have to add extra_info to the results because it may be
709 # contained in a playlist
710 return self.extract_info(ie_result['url'],
712 ie_key=ie_result.get('ie_key'),
713 extra_info=extra_info)
714 elif result_type == 'url_transparent':
715 # Use the information from the embedding page
716 info = self.extract_info(
717 ie_result['url'], ie_key=ie_result.get('ie_key'),
718 extra_info=extra_info, download=False, process=False)
720 force_properties = dict(
721 (k, v) for k, v in ie_result.items() if v is not None)
722 for f in ('_type', 'url'):
723 if f in force_properties:
724 del force_properties[f]
725 new_result = info.copy()
726 new_result.update(force_properties)
728 assert new_result.get('_type') != 'url_transparent'
730 return self.process_ie_result(
731 new_result, download=download, extra_info=extra_info)
732 elif result_type == 'playlist' or result_type == 'multi_video':
733 # We process each entry in the playlist
734 playlist = ie_result.get('title', None) or ie_result.get('id', None)
735 self.to_screen('[download] Downloading playlist: %s' % playlist)
737 playlist_results = []
739 playliststart = self.params.get('playliststart', 1) - 1
740 playlistend = self.params.get('playlistend', None)
741 # For backwards compatibility, interpret -1 as whole list
742 if playlistend == -1:
745 playlistitems_str = self.params.get('playlist_items', None)
747 if playlistitems_str is not None:
748 def iter_playlistitems(format):
749 for string_segment in format.split(','):
750 if '-' in string_segment:
751 start, end = string_segment.split('-')
752 for item in range(int(start), int(end) + 1):
755 yield int(string_segment)
756 playlistitems = iter_playlistitems(playlistitems_str)
758 ie_entries = ie_result['entries']
759 if isinstance(ie_entries, list):
760 n_all_entries = len(ie_entries)
763 ie_entries[i - 1] for i in playlistitems
764 if -n_all_entries <= i - 1 < n_all_entries]
766 entries = ie_entries[playliststart:playlistend]
767 n_entries = len(entries)
769 "[%s] playlist %s: Collected %d video ids (downloading %d of them)" %
770 (ie_result['extractor'], playlist, n_all_entries, n_entries))
771 elif isinstance(ie_entries, PagedList):
774 for item in playlistitems:
775 entries.extend(ie_entries.getslice(
779 entries = ie_entries.getslice(
780 playliststart, playlistend)
781 n_entries = len(entries)
783 "[%s] playlist %s: Downloading %d videos" %
784 (ie_result['extractor'], playlist, n_entries))
787 entry_list = list(ie_entries)
788 entries = [entry_list[i - 1] for i in playlistitems]
790 entries = list(itertools.islice(
791 ie_entries, playliststart, playlistend))
792 n_entries = len(entries)
794 "[%s] playlist %s: Downloading %d videos" %
795 (ie_result['extractor'], playlist, n_entries))
797 if self.params.get('playlistreverse', False):
798 entries = entries[::-1]
800 for i, entry in enumerate(entries, 1):
801 self.to_screen('[download] Downloading video %s of %s' % (i, n_entries))
803 'n_entries': n_entries,
804 'playlist': playlist,
805 'playlist_id': ie_result.get('id'),
806 'playlist_title': ie_result.get('title'),
807 'playlist_index': i + playliststart,
808 'extractor': ie_result['extractor'],
809 'webpage_url': ie_result['webpage_url'],
810 'webpage_url_basename': url_basename(ie_result['webpage_url']),
811 'extractor_key': ie_result['extractor_key'],
814 reason = self._match_entry(entry, incomplete=True)
815 if reason is not None:
816 self.to_screen('[download] ' + reason)
819 entry_result = self.process_ie_result(entry,
822 playlist_results.append(entry_result)
823 ie_result['entries'] = playlist_results
825 elif result_type == 'compat_list':
827 'Extractor %s returned a compat_list result. '
828 'It needs to be updated.' % ie_result.get('extractor'))
834 'extractor': ie_result['extractor'],
835 'webpage_url': ie_result['webpage_url'],
836 'webpage_url_basename': url_basename(ie_result['webpage_url']),
837 'extractor_key': ie_result['extractor_key'],
841 ie_result['entries'] = [
842 self.process_ie_result(_fixup(r), download, extra_info)
843 for r in ie_result['entries']
847 raise Exception('Invalid result type: %s' % result_type)
849 def _apply_format_filter(self, format_spec, available_formats):
850 " Returns a tuple of the remaining format_spec and filtered formats "
860 operator_rex = re.compile(r'''(?x)\s*\[
861 (?P<key>width|height|tbr|abr|vbr|asr|filesize|fps)
862 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
863 (?P<value>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)
865 ''' % '|'.join(map(re.escape, OPERATORS.keys())))
866 m = operator_rex.search(format_spec)
869 comparison_value = int(m.group('value'))
871 comparison_value = parse_filesize(m.group('value'))
872 if comparison_value is None:
873 comparison_value = parse_filesize(m.group('value') + 'B')
874 if comparison_value is None:
876 'Invalid value %r in format specification %r' % (
877 m.group('value'), format_spec))
878 op = OPERATORS[m.group('op')]
885 str_operator_rex = re.compile(r'''(?x)\s*\[
886 \s*(?P<key>ext|acodec|vcodec|container|protocol)
887 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?
888 \s*(?P<value>[a-zA-Z0-9_-]+)
890 ''' % '|'.join(map(re.escape, STR_OPERATORS.keys())))
891 m = str_operator_rex.search(format_spec)
893 comparison_value = m.group('value')
894 op = STR_OPERATORS[m.group('op')]
897 raise ValueError('Invalid format specification %r' % format_spec)
900 actual_value = f.get(m.group('key'))
901 if actual_value is None:
902 return m.group('none_inclusive')
903 return op(actual_value, comparison_value)
904 new_formats = [f for f in available_formats if _filter(f)]
906 new_format_spec = format_spec[:-len(m.group(0))]
907 if not new_format_spec:
908 new_format_spec = 'best'
910 return (new_format_spec, new_formats)
912 def select_format(self, format_spec, available_formats):
913 while format_spec.endswith(']'):
914 format_spec, available_formats = self._apply_format_filter(
915 format_spec, available_formats)
916 if not available_formats:
919 if format_spec in ['best', 'worst', None]:
920 format_idx = 0 if format_spec == 'worst' else -1
921 audiovideo_formats = [
922 f for f in available_formats
923 if f.get('vcodec') != 'none' and f.get('acodec') != 'none']
924 if audiovideo_formats:
925 return audiovideo_formats[format_idx]
926 # for audio only urls, select the best/worst audio format
927 elif all(f.get('acodec') != 'none' for f in available_formats):
928 return available_formats[format_idx]
929 elif format_spec == 'bestaudio':
931 f for f in available_formats
932 if f.get('vcodec') == 'none']
934 return audio_formats[-1]
935 elif format_spec == 'worstaudio':
937 f for f in available_formats
938 if f.get('vcodec') == 'none']
940 return audio_formats[0]
941 elif format_spec == 'bestvideo':
943 f for f in available_formats
944 if f.get('acodec') == 'none']
946 return video_formats[-1]
947 elif format_spec == 'worstvideo':
949 f for f in available_formats
950 if f.get('acodec') == 'none']
952 return video_formats[0]
954 extensions = ['mp4', 'flv', 'webm', '3gp', 'm4a', 'mp3', 'ogg', 'aac', 'wav']
955 if format_spec in extensions:
956 filter_f = lambda f: f['ext'] == format_spec
958 filter_f = lambda f: f['format_id'] == format_spec
959 matches = list(filter(filter_f, available_formats))
964 def _calc_headers(self, info_dict):
965 res = std_headers.copy()
967 add_headers = info_dict.get('http_headers')
969 res.update(add_headers)
971 cookies = self._calc_cookies(info_dict)
973 res['Cookie'] = cookies
977 def _calc_cookies(self, info_dict):
978 pr = compat_urllib_request.Request(info_dict['url'])
979 self.cookiejar.add_cookie_header(pr)
980 return pr.get_header('Cookie')
982 def process_video_result(self, info_dict, download=True):
983 assert info_dict.get('_type', 'video') == 'video'
985 if 'id' not in info_dict:
986 raise ExtractorError('Missing "id" field in extractor result')
987 if 'title' not in info_dict:
988 raise ExtractorError('Missing "title" field in extractor result')
990 if 'playlist' not in info_dict:
991 # It isn't part of a playlist
992 info_dict['playlist'] = None
993 info_dict['playlist_index'] = None
995 thumbnails = info_dict.get('thumbnails')
996 if thumbnails is None:
997 thumbnail = info_dict.get('thumbnail')
999 info_dict['thumbnails'] = thumbnails = [{'url': thumbnail}]
1001 thumbnails.sort(key=lambda t: (
1002 t.get('preference'), t.get('width'), t.get('height'),
1003 t.get('id'), t.get('url')))
1004 for i, t in enumerate(thumbnails):
1005 if 'width' in t and 'height' in t:
1006 t['resolution'] = '%dx%d' % (t['width'], t['height'])
1007 if t.get('id') is None:
1010 if thumbnails and 'thumbnail' not in info_dict:
1011 info_dict['thumbnail'] = thumbnails[-1]['url']
1013 if 'display_id' not in info_dict and 'id' in info_dict:
1014 info_dict['display_id'] = info_dict['id']
1016 if info_dict.get('upload_date') is None and info_dict.get('timestamp') is not None:
1017 # Working around negative timestamps in Windows
1018 # (see http://bugs.python.org/issue1646728)
1019 if info_dict['timestamp'] < 0 and os.name == 'nt':
1020 info_dict['timestamp'] = 0
1021 upload_date = datetime.datetime.utcfromtimestamp(
1022 info_dict['timestamp'])
1023 info_dict['upload_date'] = upload_date.strftime('%Y%m%d')
1025 if self.params.get('listsubtitles', False):
1026 if 'automatic_captions' in info_dict:
1027 self.list_subtitles(info_dict['id'], info_dict.get('automatic_captions'), 'automatic captions')
1028 self.list_subtitles(info_dict['id'], info_dict.get('subtitles'), 'subtitles')
1030 info_dict['requested_subtitles'] = self.process_subtitles(
1031 info_dict['id'], info_dict.get('subtitles'),
1032 info_dict.get('automatic_captions'))
1034 # This extractors handle format selection themselves
1035 if info_dict['extractor'] in ['Youku']:
1037 self.process_info(info_dict)
1040 # We now pick which formats have to be downloaded
1041 if info_dict.get('formats') is None:
1042 # There's only one format available
1043 formats = [info_dict]
1045 formats = info_dict['formats']
1048 raise ExtractorError('No video formats found!')
1050 # We check that all the formats have the format and format_id fields
1051 for i, format in enumerate(formats):
1052 if 'url' not in format:
1053 raise ExtractorError('Missing "url" key in result (index %d)' % i)
1055 if format.get('format_id') is None:
1056 format['format_id'] = compat_str(i)
1057 if format.get('format') is None:
1058 format['format'] = '{id} - {res}{note}'.format(
1059 id=format['format_id'],
1060 res=self.format_resolution(format),
1061 note=' ({0})'.format(format['format_note']) if format.get('format_note') is not None else '',
1063 # Automatically determine file extension if missing
1064 if 'ext' not in format:
1065 format['ext'] = determine_ext(format['url']).lower()
1066 # Add HTTP headers, so that external programs can use them from the
1068 full_format_info = info_dict.copy()
1069 full_format_info.update(format)
1070 format['http_headers'] = self._calc_headers(full_format_info)
1072 # TODO Central sorting goes here
1074 if formats[0] is not info_dict:
1075 # only set the 'formats' fields if the original info_dict list them
1076 # otherwise we end up with a circular reference, the first (and unique)
1077 # element in the 'formats' field in info_dict is info_dict itself,
1078 # wich can't be exported to json
1079 info_dict['formats'] = formats
1080 if self.params.get('listformats'):
1081 self.list_formats(info_dict)
1083 if self.params.get('list_thumbnails'):
1084 self.list_thumbnails(info_dict)
1087 req_format = self.params.get('format')
1088 if req_format is None:
1089 req_format_list = []
1090 if (self.params.get('outtmpl', DEFAULT_OUTTMPL) != '-' and
1091 info_dict['extractor'] in ['youtube', 'ted']):
1092 merger = FFmpegMergerPP(self)
1093 if merger.available and merger.can_merge():
1094 req_format_list.append('bestvideo+bestaudio')
1095 req_format_list.append('best')
1096 req_format = '/'.join(req_format_list)
1097 formats_to_download = []
1098 if req_format == 'all':
1099 formats_to_download = formats
1101 for rfstr in req_format.split(','):
1102 # We can accept formats requested in the format: 34/5/best, we pick
1103 # the first that is available, starting from left
1104 req_formats = rfstr.split('/')
1105 for rf in req_formats:
1106 if re.match(r'.+?\+.+?', rf) is not None:
1107 # Two formats have been requested like '137+139'
1108 format_1, format_2 = rf.split('+')
1109 formats_info = (self.select_format(format_1, formats),
1110 self.select_format(format_2, formats))
1111 if all(formats_info):
1112 # The first format must contain the video and the
1114 if formats_info[0].get('vcodec') == 'none':
1115 self.report_error('The first format must '
1116 'contain the video, try using '
1117 '"-f %s+%s"' % (format_2, format_1))
1120 formats_info[0]['ext']
1121 if self.params.get('merge_output_format') is None
1122 else self.params['merge_output_format'])
1124 'requested_formats': formats_info,
1125 'format': '%s+%s' % (formats_info[0].get('format'),
1126 formats_info[1].get('format')),
1127 'format_id': '%s+%s' % (formats_info[0].get('format_id'),
1128 formats_info[1].get('format_id')),
1129 'width': formats_info[0].get('width'),
1130 'height': formats_info[0].get('height'),
1131 'resolution': formats_info[0].get('resolution'),
1132 'fps': formats_info[0].get('fps'),
1133 'vcodec': formats_info[0].get('vcodec'),
1134 'vbr': formats_info[0].get('vbr'),
1135 'stretched_ratio': formats_info[0].get('stretched_ratio'),
1136 'acodec': formats_info[1].get('acodec'),
1137 'abr': formats_info[1].get('abr'),
1141 selected_format = None
1143 selected_format = self.select_format(rf, formats)
1144 if selected_format is not None:
1145 formats_to_download.append(selected_format)
1147 if not formats_to_download:
1148 raise ExtractorError('requested format not available',
1152 if len(formats_to_download) > 1:
1153 self.to_screen('[info] %s: downloading video in %s formats' % (info_dict['id'], len(formats_to_download)))
1154 for format in formats_to_download:
1155 new_info = dict(info_dict)
1156 new_info.update(format)
1157 self.process_info(new_info)
1158 # We update the info dict with the best quality format (backwards compatibility)
1159 info_dict.update(formats_to_download[-1])
1162 def process_subtitles(self, video_id, normal_subtitles, automatic_captions):
1163 """Select the requested subtitles and their format"""
1165 if normal_subtitles and self.params.get('writesubtitles'):
1166 available_subs.update(normal_subtitles)
1167 if automatic_captions and self.params.get('writeautomaticsub'):
1168 for lang, cap_info in automatic_captions.items():
1169 if lang not in available_subs:
1170 available_subs[lang] = cap_info
1172 if (not self.params.get('writesubtitles') and not
1173 self.params.get('writeautomaticsub') or not
1177 if self.params.get('allsubtitles', False):
1178 requested_langs = available_subs.keys()
1180 if self.params.get('subtitleslangs', False):
1181 requested_langs = self.params.get('subtitleslangs')
1182 elif 'en' in available_subs:
1183 requested_langs = ['en']
1185 requested_langs = [list(available_subs.keys())[0]]
1187 formats_query = self.params.get('subtitlesformat', 'best')
1188 formats_preference = formats_query.split('/') if formats_query else []
1190 for lang in requested_langs:
1191 formats = available_subs.get(lang)
1193 self.report_warning('%s subtitles not available for %s' % (lang, video_id))
1195 for ext in formats_preference:
1199 matches = list(filter(lambda f: f['ext'] == ext, formats))
1205 self.report_warning(
1206 'No subtitle format found matching "%s" for language %s, '
1207 'using %s' % (formats_query, lang, f['ext']))
1211 def process_info(self, info_dict):
1212 """Process a single resolved IE result."""
1214 assert info_dict.get('_type', 'video') == 'video'
1216 max_downloads = self.params.get('max_downloads')
1217 if max_downloads is not None:
1218 if self._num_downloads >= int(max_downloads):
1219 raise MaxDownloadsReached()
1221 info_dict['fulltitle'] = info_dict['title']
1222 if len(info_dict['title']) > 200:
1223 info_dict['title'] = info_dict['title'][:197] + '...'
1225 if 'format' not in info_dict:
1226 info_dict['format'] = info_dict['ext']
1228 reason = self._match_entry(info_dict, incomplete=False)
1229 if reason is not None:
1230 self.to_screen('[download] ' + reason)
1233 self._num_downloads += 1
1235 info_dict['_filename'] = filename = self.prepare_filename(info_dict)
1238 if self.params.get('forcetitle', False):
1239 self.to_stdout(info_dict['fulltitle'])
1240 if self.params.get('forceid', False):
1241 self.to_stdout(info_dict['id'])
1242 if self.params.get('forceurl', False):
1243 if info_dict.get('requested_formats') is not None:
1244 for f in info_dict['requested_formats']:
1245 self.to_stdout(f['url'] + f.get('play_path', ''))
1247 # For RTMP URLs, also include the playpath
1248 self.to_stdout(info_dict['url'] + info_dict.get('play_path', ''))
1249 if self.params.get('forcethumbnail', False) and info_dict.get('thumbnail') is not None:
1250 self.to_stdout(info_dict['thumbnail'])
1251 if self.params.get('forcedescription', False) and info_dict.get('description') is not None:
1252 self.to_stdout(info_dict['description'])
1253 if self.params.get('forcefilename', False) and filename is not None:
1254 self.to_stdout(filename)
1255 if self.params.get('forceduration', False) and info_dict.get('duration') is not None:
1256 self.to_stdout(formatSeconds(info_dict['duration']))
1257 if self.params.get('forceformat', False):
1258 self.to_stdout(info_dict['format'])
1259 if self.params.get('forcejson', False):
1260 self.to_stdout(json.dumps(info_dict))
1262 # Do nothing else if in simulate mode
1263 if self.params.get('simulate', False):
1266 if filename is None:
1270 dn = os.path.dirname(sanitize_path(encodeFilename(filename)))
1271 if dn and not os.path.exists(dn):
1273 except (OSError, IOError) as err:
1274 self.report_error('unable to create directory ' + compat_str(err))
1277 if self.params.get('writedescription', False):
1278 descfn = replace_extension(filename, 'description', info_dict.get('ext'))
1279 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(descfn)):
1280 self.to_screen('[info] Video description is already present')
1281 elif info_dict.get('description') is None:
1282 self.report_warning('There\'s no description to write.')
1285 self.to_screen('[info] Writing video description to: ' + descfn)
1286 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
1287 descfile.write(info_dict['description'])
1288 except (OSError, IOError):
1289 self.report_error('Cannot write description file ' + descfn)
1292 if self.params.get('writeannotations', False):
1293 annofn = replace_extension(filename, 'annotations.xml', info_dict.get('ext'))
1294 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(annofn)):
1295 self.to_screen('[info] Video annotations are already present')
1298 self.to_screen('[info] Writing video annotations to: ' + annofn)
1299 with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
1300 annofile.write(info_dict['annotations'])
1301 except (KeyError, TypeError):
1302 self.report_warning('There are no annotations to write.')
1303 except (OSError, IOError):
1304 self.report_error('Cannot write annotations file: ' + annofn)
1307 subtitles_are_requested = any([self.params.get('writesubtitles', False),
1308 self.params.get('writeautomaticsub')])
1310 if subtitles_are_requested and info_dict.get('requested_subtitles'):
1311 # subtitles download errors are already managed as troubles in relevant IE
1312 # that way it will silently go on when used with unsupporting IE
1313 subtitles = info_dict['requested_subtitles']
1314 ie = self.get_info_extractor(info_dict['extractor_key'])
1315 for sub_lang, sub_info in subtitles.items():
1316 sub_format = sub_info['ext']
1317 if sub_info.get('data') is not None:
1318 sub_data = sub_info['data']
1321 sub_data = ie._download_webpage(
1322 sub_info['url'], info_dict['id'], note=False)
1323 except ExtractorError as err:
1324 self.report_warning('Unable to download subtitle for "%s": %s' %
1325 (sub_lang, compat_str(err.cause)))
1328 sub_filename = subtitles_filename(filename, sub_lang, sub_format)
1329 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(sub_filename)):
1330 self.to_screen('[info] Video subtitle %s.%s is already_present' % (sub_lang, sub_format))
1332 self.to_screen('[info] Writing video subtitles to: ' + sub_filename)
1333 with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
1334 subfile.write(sub_data)
1335 except (OSError, IOError):
1336 self.report_error('Cannot write subtitles file ' + sub_filename)
1339 if self.params.get('writeinfojson', False):
1340 infofn = replace_extension(filename, 'info.json', info_dict.get('ext'))
1341 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(infofn)):
1342 self.to_screen('[info] Video description metadata is already present')
1344 self.to_screen('[info] Writing video description metadata as JSON to: ' + infofn)
1346 write_json_file(self.filter_requested_info(info_dict), infofn)
1347 except (OSError, IOError):
1348 self.report_error('Cannot write metadata to JSON file ' + infofn)
1351 self._write_thumbnails(info_dict, filename)
1353 if not self.params.get('skip_download', False):
1356 fd = get_suitable_downloader(info, self.params)(self, self.params)
1357 for ph in self._progress_hooks:
1358 fd.add_progress_hook(ph)
1359 if self.params.get('verbose'):
1360 self.to_stdout('[debug] Invoking downloader on %r' % info.get('url'))
1361 return fd.download(name, info)
1363 if info_dict.get('requested_formats') is not None:
1366 merger = FFmpegMergerPP(self)
1367 if not merger.available:
1369 self.report_warning('You have requested multiple '
1370 'formats but ffmpeg or avconv are not installed.'
1371 ' The formats won\'t be merged.')
1373 postprocessors = [merger]
1375 def compatible_formats(formats):
1376 video, audio = formats
1378 video_ext, audio_ext = audio.get('ext'), video.get('ext')
1379 if video_ext and audio_ext:
1381 ('mp3', 'mp4', 'm4a', 'm4p', 'm4b', 'm4r', 'm4v'),
1384 for exts in COMPATIBLE_EXTS:
1385 if video_ext in exts and audio_ext in exts:
1387 # TODO: Check acodec/vcodec
1390 filename_real_ext = os.path.splitext(filename)[1][1:]
1392 os.path.splitext(filename)[0]
1393 if filename_real_ext == info_dict['ext']
1395 requested_formats = info_dict['requested_formats']
1396 if self.params.get('merge_output_format') is None and not compatible_formats(requested_formats):
1397 info_dict['ext'] = 'mkv'
1398 self.report_warning(
1399 'Requested formats are incompatible for merge and will be merged into mkv.')
1400 # Ensure filename always has a correct extension for successful merge
1401 filename = '%s.%s' % (filename_wo_ext, info_dict['ext'])
1402 if os.path.exists(encodeFilename(filename)):
1404 '[download] %s has already been downloaded and '
1405 'merged' % filename)
1407 for f in requested_formats:
1408 new_info = dict(info_dict)
1410 fname = self.prepare_filename(new_info)
1411 fname = prepend_extension(fname, 'f%s' % f['format_id'], new_info['ext'])
1412 downloaded.append(fname)
1413 partial_success = dl(fname, new_info)
1414 success = success and partial_success
1415 info_dict['__postprocessors'] = postprocessors
1416 info_dict['__files_to_merge'] = downloaded
1418 # Just a single file
1419 success = dl(filename, info_dict)
1420 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1421 self.report_error('unable to download video data: %s' % str(err))
1423 except (OSError, IOError) as err:
1424 raise UnavailableVideoError(err)
1425 except (ContentTooShortError, ) as err:
1426 self.report_error('content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
1431 fixup_policy = self.params.get('fixup')
1432 if fixup_policy is None:
1433 fixup_policy = 'detect_or_warn'
1435 stretched_ratio = info_dict.get('stretched_ratio')
1436 if stretched_ratio is not None and stretched_ratio != 1:
1437 if fixup_policy == 'warn':
1438 self.report_warning('%s: Non-uniform pixel ratio (%s)' % (
1439 info_dict['id'], stretched_ratio))
1440 elif fixup_policy == 'detect_or_warn':
1441 stretched_pp = FFmpegFixupStretchedPP(self)
1442 if stretched_pp.available:
1443 info_dict.setdefault('__postprocessors', [])
1444 info_dict['__postprocessors'].append(stretched_pp)
1446 self.report_warning(
1447 '%s: Non-uniform pixel ratio (%s). Install ffmpeg or avconv to fix this automatically.' % (
1448 info_dict['id'], stretched_ratio))
1450 assert fixup_policy in ('ignore', 'never')
1452 if info_dict.get('requested_formats') is None and info_dict.get('container') == 'm4a_dash':
1453 if fixup_policy == 'warn':
1454 self.report_warning('%s: writing DASH m4a. Only some players support this container.' % (
1456 elif fixup_policy == 'detect_or_warn':
1457 fixup_pp = FFmpegFixupM4aPP(self)
1458 if fixup_pp.available:
1459 info_dict.setdefault('__postprocessors', [])
1460 info_dict['__postprocessors'].append(fixup_pp)
1462 self.report_warning(
1463 '%s: writing DASH m4a. Only some players support this container. Install ffmpeg or avconv to fix this automatically.' % (
1466 assert fixup_policy in ('ignore', 'never')
1469 self.post_process(filename, info_dict)
1470 except (PostProcessingError) as err:
1471 self.report_error('postprocessing: %s' % str(err))
1473 self.record_download_archive(info_dict)
1475 def download(self, url_list):
1476 """Download a given list of URLs."""
1477 outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
1478 if (len(url_list) > 1 and
1479 '%' not in outtmpl and
1480 self.params.get('max_downloads') != 1):
1481 raise SameFileError(outtmpl)
1483 for url in url_list:
1485 # It also downloads the videos
1486 res = self.extract_info(url)
1487 except UnavailableVideoError:
1488 self.report_error('unable to download video')
1489 except MaxDownloadsReached:
1490 self.to_screen('[info] Maximum number of downloaded files reached.')
1493 if self.params.get('dump_single_json', False):
1494 self.to_stdout(json.dumps(res))
1496 return self._download_retcode
1498 def download_with_info_file(self, info_filename):
1499 with contextlib.closing(fileinput.FileInput(
1500 [info_filename], mode='r',
1501 openhook=fileinput.hook_encoded('utf-8'))) as f:
1502 # FileInput doesn't have a read method, we can't call json.load
1503 info = self.filter_requested_info(json.loads('\n'.join(f)))
1505 self.process_ie_result(info, download=True)
1506 except DownloadError:
1507 webpage_url = info.get('webpage_url')
1508 if webpage_url is not None:
1509 self.report_warning('The info failed to download, trying with "%s"' % webpage_url)
1510 return self.download([webpage_url])
1513 return self._download_retcode
1516 def filter_requested_info(info_dict):
1518 (k, v) for k, v in info_dict.items()
1519 if k not in ['requested_formats', 'requested_subtitles'])
1521 def post_process(self, filename, ie_info):
1522 """Run all the postprocessors on the given file."""
1523 info = dict(ie_info)
1524 info['filepath'] = filename
1526 if ie_info.get('__postprocessors') is not None:
1527 pps_chain.extend(ie_info['__postprocessors'])
1528 pps_chain.extend(self._pps)
1529 for pp in pps_chain:
1531 files_to_delete, info = pp.run(info)
1532 except PostProcessingError as e:
1533 self.report_error(e.msg)
1534 if files_to_delete and not self.params.get('keepvideo', False):
1535 for old_filename in files_to_delete:
1536 self.to_screen('Deleting original file %s (pass -k to keep)' % old_filename)
1538 os.remove(encodeFilename(old_filename))
1539 except (IOError, OSError):
1540 self.report_warning('Unable to remove downloaded original file')
1542 def _make_archive_id(self, info_dict):
1543 # Future-proof against any change in case
1544 # and backwards compatibility with prior versions
1545 extractor = info_dict.get('extractor_key')
1546 if extractor is None:
1547 if 'id' in info_dict:
1548 extractor = info_dict.get('ie_key') # key in a playlist
1549 if extractor is None:
1550 return None # Incomplete video information
1551 return extractor.lower() + ' ' + info_dict['id']
1553 def in_download_archive(self, info_dict):
1554 fn = self.params.get('download_archive')
1558 vid_id = self._make_archive_id(info_dict)
1560 return False # Incomplete video information
1563 with locked_file(fn, 'r', encoding='utf-8') as archive_file:
1564 for line in archive_file:
1565 if line.strip() == vid_id:
1567 except IOError as ioe:
1568 if ioe.errno != errno.ENOENT:
1572 def record_download_archive(self, info_dict):
1573 fn = self.params.get('download_archive')
1576 vid_id = self._make_archive_id(info_dict)
1578 with locked_file(fn, 'a', encoding='utf-8') as archive_file:
1579 archive_file.write(vid_id + '\n')
1582 def format_resolution(format, default='unknown'):
1583 if format.get('vcodec') == 'none':
1585 if format.get('resolution') is not None:
1586 return format['resolution']
1587 if format.get('height') is not None:
1588 if format.get('width') is not None:
1589 res = '%sx%s' % (format['width'], format['height'])
1591 res = '%sp' % format['height']
1592 elif format.get('width') is not None:
1593 res = '?x%d' % format['width']
1598 def _format_note(self, fdict):
1600 if fdict.get('ext') in ['f4f', 'f4m']:
1601 res += '(unsupported) '
1602 if fdict.get('format_note') is not None:
1603 res += fdict['format_note'] + ' '
1604 if fdict.get('tbr') is not None:
1605 res += '%4dk ' % fdict['tbr']
1606 if fdict.get('container') is not None:
1609 res += '%s container' % fdict['container']
1610 if (fdict.get('vcodec') is not None and
1611 fdict.get('vcodec') != 'none'):
1614 res += fdict['vcodec']
1615 if fdict.get('vbr') is not None:
1617 elif fdict.get('vbr') is not None and fdict.get('abr') is not None:
1619 if fdict.get('vbr') is not None:
1620 res += '%4dk' % fdict['vbr']
1621 if fdict.get('fps') is not None:
1622 res += ', %sfps' % fdict['fps']
1623 if fdict.get('acodec') is not None:
1626 if fdict['acodec'] == 'none':
1629 res += '%-5s' % fdict['acodec']
1630 elif fdict.get('abr') is not None:
1634 if fdict.get('abr') is not None:
1635 res += '@%3dk' % fdict['abr']
1636 if fdict.get('asr') is not None:
1637 res += ' (%5dHz)' % fdict['asr']
1638 if fdict.get('filesize') is not None:
1641 res += format_bytes(fdict['filesize'])
1642 elif fdict.get('filesize_approx') is not None:
1645 res += '~' + format_bytes(fdict['filesize_approx'])
1648 def list_formats(self, info_dict):
1649 formats = info_dict.get('formats', [info_dict])
1651 [f['format_id'], f['ext'], self.format_resolution(f), self._format_note(f)]
1653 if f.get('preference') is None or f['preference'] >= -1000]
1654 if len(formats) > 1:
1655 table[-1][-1] += (' ' if table[-1][-1] else '') + '(best)'
1657 header_line = ['format code', 'extension', 'resolution', 'note']
1659 '[info] Available formats for %s:\n%s' %
1660 (info_dict['id'], render_table(header_line, table)))
1662 def list_thumbnails(self, info_dict):
1663 thumbnails = info_dict.get('thumbnails')
1665 tn_url = info_dict.get('thumbnail')
1667 thumbnails = [{'id': '0', 'url': tn_url}]
1670 '[info] No thumbnails present for %s' % info_dict['id'])
1674 '[info] Thumbnails for %s:' % info_dict['id'])
1675 self.to_screen(render_table(
1676 ['ID', 'width', 'height', 'URL'],
1677 [[t['id'], t.get('width', 'unknown'), t.get('height', 'unknown'), t['url']] for t in thumbnails]))
1679 def list_subtitles(self, video_id, subtitles, name='subtitles'):
1681 self.to_screen('%s has no %s' % (video_id, name))
1684 'Available %s for %s:' % (name, video_id))
1685 self.to_screen(render_table(
1686 ['Language', 'formats'],
1687 [[lang, ', '.join(f['ext'] for f in reversed(formats))]
1688 for lang, formats in subtitles.items()]))
1690 def urlopen(self, req):
1691 """ Start an HTTP download """
1693 # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not
1694 # always respected by websites, some tend to give out URLs with non percent-encoded
1695 # non-ASCII characters (see telemb.py, ard.py [#3412])
1696 # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991)
1697 # To work around aforementioned issue we will replace request's original URL with
1698 # percent-encoded one
1699 req_is_string = isinstance(req, compat_basestring)
1700 url = req if req_is_string else req.get_full_url()
1701 url_escaped = escape_url(url)
1703 # Substitute URL if any change after escaping
1704 if url != url_escaped:
1708 req = compat_urllib_request.Request(
1709 url_escaped, data=req.data, headers=req.headers,
1710 origin_req_host=req.origin_req_host, unverifiable=req.unverifiable)
1712 return self._opener.open(req, timeout=self._socket_timeout)
1714 def print_debug_header(self):
1715 if not self.params.get('verbose'):
1718 if type('') is not compat_str:
1719 # Python 2.6 on SLES11 SP1 (https://github.com/rg3/youtube-dl/issues/3326)
1720 self.report_warning(
1721 'Your Python is broken! Update to a newer and supported version')
1723 stdout_encoding = getattr(
1724 sys.stdout, 'encoding', 'missing (%s)' % type(sys.stdout).__name__)
1726 '[debug] Encodings: locale %s, fs %s, out %s, pref %s\n' % (
1727 locale.getpreferredencoding(),
1728 sys.getfilesystemencoding(),
1730 self.get_encoding()))
1731 write_string(encoding_str, encoding=None)
1733 self._write_string('[debug] youtube-dl version ' + __version__ + '\n')
1735 sp = subprocess.Popen(
1736 ['git', 'rev-parse', '--short', 'HEAD'],
1737 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
1738 cwd=os.path.dirname(os.path.abspath(__file__)))
1739 out, err = sp.communicate()
1740 out = out.decode().strip()
1741 if re.match('[0-9a-f]+', out):
1742 self._write_string('[debug] Git HEAD: ' + out + '\n')
1748 self._write_string('[debug] Python version %s - %s\n' % (
1749 platform.python_version(), platform_name()))
1751 exe_versions = FFmpegPostProcessor.get_versions(self)
1752 exe_versions['rtmpdump'] = rtmpdump_version()
1753 exe_str = ', '.join(
1755 for exe, v in sorted(exe_versions.items())
1760 self._write_string('[debug] exe versions: %s\n' % exe_str)
1763 for handler in self._opener.handlers:
1764 if hasattr(handler, 'proxies'):
1765 proxy_map.update(handler.proxies)
1766 self._write_string('[debug] Proxy map: ' + compat_str(proxy_map) + '\n')
1768 if self.params.get('call_home', False):
1769 ipaddr = self.urlopen('https://yt-dl.org/ip').read().decode('utf-8')
1770 self._write_string('[debug] Public IP address: %s\n' % ipaddr)
1771 latest_version = self.urlopen(
1772 'https://yt-dl.org/latest/version').read().decode('utf-8')
1773 if version_tuple(latest_version) > version_tuple(__version__):
1774 self.report_warning(
1775 'You are using an outdated version (newest version: %s)! '
1776 'See https://yt-dl.org/update if you need help updating.' %
1779 def _setup_opener(self):
1780 timeout_val = self.params.get('socket_timeout')
1781 self._socket_timeout = 600 if timeout_val is None else float(timeout_val)
1783 opts_cookiefile = self.params.get('cookiefile')
1784 opts_proxy = self.params.get('proxy')
1786 if opts_cookiefile is None:
1787 self.cookiejar = compat_cookiejar.CookieJar()
1789 self.cookiejar = compat_cookiejar.MozillaCookieJar(
1791 if os.access(opts_cookiefile, os.R_OK):
1792 self.cookiejar.load()
1794 cookie_processor = compat_urllib_request.HTTPCookieProcessor(
1796 if opts_proxy is not None:
1797 if opts_proxy == '':
1800 proxies = {'http': opts_proxy, 'https': opts_proxy}
1802 proxies = compat_urllib_request.getproxies()
1803 # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
1804 if 'http' in proxies and 'https' not in proxies:
1805 proxies['https'] = proxies['http']
1806 proxy_handler = PerRequestProxyHandler(proxies)
1808 debuglevel = 1 if self.params.get('debug_printtraffic') else 0
1809 https_handler = make_HTTPS_handler(self.params, debuglevel=debuglevel)
1810 ydlh = YoutubeDLHandler(self.params, debuglevel=debuglevel)
1811 opener = compat_urllib_request.build_opener(
1812 proxy_handler, https_handler, cookie_processor, ydlh)
1814 # Delete the default user-agent header, which would otherwise apply in
1815 # cases where our custom HTTP handler doesn't come into play
1816 # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
1817 opener.addheaders = []
1818 self._opener = opener
1820 def encode(self, s):
1821 if isinstance(s, bytes):
1822 return s # Already encoded
1825 return s.encode(self.get_encoding())
1826 except UnicodeEncodeError as err:
1827 err.reason = err.reason + '. Check your system encoding configuration or use the --encoding option.'
1830 def get_encoding(self):
1831 encoding = self.params.get('encoding')
1832 if encoding is None:
1833 encoding = preferredencoding()
1836 def _write_thumbnails(self, info_dict, filename):
1837 if self.params.get('writethumbnail', False):
1838 thumbnails = info_dict.get('thumbnails')
1840 thumbnails = [thumbnails[-1]]
1841 elif self.params.get('write_all_thumbnails', False):
1842 thumbnails = info_dict.get('thumbnails')
1847 # No thumbnails present, so return immediately
1850 for t in thumbnails:
1851 thumb_ext = determine_ext(t['url'], 'jpg')
1852 suffix = '_%s' % t['id'] if len(thumbnails) > 1 else ''
1853 thumb_display_id = '%s ' % t['id'] if len(thumbnails) > 1 else ''
1854 t['filename'] = thumb_filename = os.path.splitext(filename)[0] + suffix + '.' + thumb_ext
1856 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(thumb_filename)):
1857 self.to_screen('[%s] %s: Thumbnail %sis already present' %
1858 (info_dict['extractor'], info_dict['id'], thumb_display_id))
1860 self.to_screen('[%s] %s: Downloading thumbnail %s...' %
1861 (info_dict['extractor'], info_dict['id'], thumb_display_id))
1863 uf = self.urlopen(t['url'])
1864 with open(thumb_filename, 'wb') as thumbf:
1865 shutil.copyfileobj(uf, thumbf)
1866 self.to_screen('[%s] %s: Writing thumbnail %sto: %s' %
1867 (info_dict['extractor'], info_dict['id'], thumb_display_id, thumb_filename))
1868 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1869 self.report_warning('Unable to download thumbnail "%s": %s' %
1870 (t['url'], compat_str(err)))