]> jfr.im git - yt-dlp.git/blob - yt_dlp/YoutubeDL.py
[cleanup] Add keyword automatically to SearchIE descriptions
[yt-dlp.git] / yt_dlp / YoutubeDL.py
1 #!/usr/bin/env python3
2 # coding: utf-8
3
4 from __future__ import absolute_import, unicode_literals
5
6 import collections
7 import contextlib
8 import copy
9 import datetime
10 import errno
11 import fileinput
12 import functools
13 import io
14 import itertools
15 import json
16 import locale
17 import operator
18 import os
19 import platform
20 import re
21 import shutil
22 import subprocess
23 import sys
24 import tempfile
25 import time
26 import tokenize
27 import traceback
28 import random
29 import unicodedata
30
31 from enum import Enum
32 from string import ascii_letters
33
34 from .compat import (
35 compat_basestring,
36 compat_get_terminal_size,
37 compat_kwargs,
38 compat_numeric_types,
39 compat_os_name,
40 compat_pycrypto_AES,
41 compat_shlex_quote,
42 compat_str,
43 compat_tokenize_tokenize,
44 compat_urllib_error,
45 compat_urllib_request,
46 compat_urllib_request_DataHandler,
47 windows_enable_vt_mode,
48 )
49 from .cookies import load_cookies
50 from .utils import (
51 age_restricted,
52 args_to_str,
53 ContentTooShortError,
54 date_from_str,
55 DateRange,
56 DEFAULT_OUTTMPL,
57 determine_ext,
58 determine_protocol,
59 DOT_DESKTOP_LINK_TEMPLATE,
60 DOT_URL_LINK_TEMPLATE,
61 DOT_WEBLOC_LINK_TEMPLATE,
62 DownloadError,
63 encode_compat_str,
64 encodeFilename,
65 EntryNotInPlaylist,
66 error_to_compat_str,
67 ExistingVideoReached,
68 expand_path,
69 ExtractorError,
70 float_or_none,
71 format_bytes,
72 format_field,
73 formatSeconds,
74 GeoRestrictedError,
75 HEADRequest,
76 int_or_none,
77 iri_to_uri,
78 ISO3166Utils,
79 LazyList,
80 locked_file,
81 make_dir,
82 make_HTTPS_handler,
83 MaxDownloadsReached,
84 network_exceptions,
85 number_of_digits,
86 orderedSet,
87 OUTTMPL_TYPES,
88 PagedList,
89 parse_filesize,
90 PerRequestProxyHandler,
91 platform_name,
92 Popen,
93 PostProcessingError,
94 preferredencoding,
95 prepend_extension,
96 register_socks_protocols,
97 RejectedVideoReached,
98 render_table,
99 replace_extension,
100 SameFileError,
101 sanitize_filename,
102 sanitize_path,
103 sanitize_url,
104 sanitized_Request,
105 std_headers,
106 STR_FORMAT_RE_TMPL,
107 STR_FORMAT_TYPES,
108 str_or_none,
109 strftime_or_none,
110 subtitles_filename,
111 supports_terminal_sequences,
112 ThrottledDownload,
113 to_high_limit_path,
114 traverse_obj,
115 try_get,
116 UnavailableVideoError,
117 url_basename,
118 variadic,
119 version_tuple,
120 write_json_file,
121 write_string,
122 YoutubeDLCookieProcessor,
123 YoutubeDLHandler,
124 YoutubeDLRedirectHandler,
125 )
126 from .cache import Cache
127 from .minicurses import format_text
128 from .extractor import (
129 gen_extractor_classes,
130 get_info_extractor,
131 _LAZY_LOADER,
132 _PLUGIN_CLASSES as plugin_extractors
133 )
134 from .extractor.openload import PhantomJSwrapper
135 from .downloader import (
136 FFmpegFD,
137 get_suitable_downloader,
138 shorten_protocol_name
139 )
140 from .downloader.rtmp import rtmpdump_version
141 from .postprocessor import (
142 get_postprocessor,
143 EmbedThumbnailPP,
144 FFmpegFixupDurationPP,
145 FFmpegFixupM3u8PP,
146 FFmpegFixupM4aPP,
147 FFmpegFixupStretchedPP,
148 FFmpegFixupTimestampPP,
149 FFmpegMergerPP,
150 FFmpegPostProcessor,
151 MoveFilesAfterDownloadPP,
152 _PLUGIN_CLASSES as plugin_postprocessors
153 )
154 from .update import detect_variant
155 from .version import __version__
156
157 if compat_os_name == 'nt':
158 import ctypes
159
160
161 class YoutubeDL(object):
162 """YoutubeDL class.
163
164 YoutubeDL objects are the ones responsible of downloading the
165 actual video file and writing it to disk if the user has requested
166 it, among some other tasks. In most cases there should be one per
167 program. As, given a video URL, the downloader doesn't know how to
168 extract all the needed information, task that InfoExtractors do, it
169 has to pass the URL to one of them.
170
171 For this, YoutubeDL objects have a method that allows
172 InfoExtractors to be registered in a given order. When it is passed
173 a URL, the YoutubeDL object handles it to the first InfoExtractor it
174 finds that reports being able to handle it. The InfoExtractor extracts
175 all the information about the video or videos the URL refers to, and
176 YoutubeDL process the extracted information, possibly using a File
177 Downloader to download the video.
178
179 YoutubeDL objects accept a lot of parameters. In order not to saturate
180 the object constructor with arguments, it receives a dictionary of
181 options instead. These options are available through the params
182 attribute for the InfoExtractors to use. The YoutubeDL also
183 registers itself as the downloader in charge for the InfoExtractors
184 that are added to it, so this is a "mutual registration".
185
186 Available options:
187
188 username: Username for authentication purposes.
189 password: Password for authentication purposes.
190 videopassword: Password for accessing a video.
191 ap_mso: Adobe Pass multiple-system operator identifier.
192 ap_username: Multiple-system operator account username.
193 ap_password: Multiple-system operator account password.
194 usenetrc: Use netrc for authentication instead.
195 verbose: Print additional info to stdout.
196 quiet: Do not print messages to stdout.
197 no_warnings: Do not print out anything for warnings.
198 forceprint: A list of templates to force print
199 forceurl: Force printing final URL. (Deprecated)
200 forcetitle: Force printing title. (Deprecated)
201 forceid: Force printing ID. (Deprecated)
202 forcethumbnail: Force printing thumbnail URL. (Deprecated)
203 forcedescription: Force printing description. (Deprecated)
204 forcefilename: Force printing final filename. (Deprecated)
205 forceduration: Force printing duration. (Deprecated)
206 forcejson: Force printing info_dict as JSON.
207 dump_single_json: Force printing the info_dict of the whole playlist
208 (or video) as a single JSON line.
209 force_write_download_archive: Force writing download archive regardless
210 of 'skip_download' or 'simulate'.
211 simulate: Do not download the video files. If unset (or None),
212 simulate only if listsubtitles, listformats or list_thumbnails is used
213 format: Video format code. see "FORMAT SELECTION" for more details.
214 allow_unplayable_formats: Allow unplayable formats to be extracted and downloaded.
215 ignore_no_formats_error: Ignore "No video formats" error. Usefull for
216 extracting metadata even if the video is not actually
217 available for download (experimental)
218 format_sort: How to sort the video formats. see "Sorting Formats"
219 for more details.
220 format_sort_force: Force the given format_sort. see "Sorting Formats"
221 for more details.
222 allow_multiple_video_streams: Allow multiple video streams to be merged
223 into a single file
224 allow_multiple_audio_streams: Allow multiple audio streams to be merged
225 into a single file
226 check_formats Whether to test if the formats are downloadable.
227 Can be True (check all), False (check none)
228 or None (check only if requested by extractor)
229 paths: Dictionary of output paths. The allowed keys are 'home'
230 'temp' and the keys of OUTTMPL_TYPES (in utils.py)
231 outtmpl: Dictionary of templates for output names. Allowed keys
232 are 'default' and the keys of OUTTMPL_TYPES (in utils.py).
233 For compatibility with youtube-dl, a single string can also be used
234 outtmpl_na_placeholder: Placeholder for unavailable meta fields.
235 restrictfilenames: Do not allow "&" and spaces in file names
236 trim_file_name: Limit length of filename (extension excluded)
237 windowsfilenames: Force the filenames to be windows compatible
238 ignoreerrors: Do not stop on download/postprocessing errors.
239 Can be 'only_download' to ignore only download errors.
240 Default is 'only_download' for CLI, but False for API
241 skip_playlist_after_errors: Number of allowed failures until the rest of
242 the playlist is skipped
243 force_generic_extractor: Force downloader to use the generic extractor
244 overwrites: Overwrite all video and metadata files if True,
245 overwrite only non-video files if None
246 and don't overwrite any file if False
247 For compatibility with youtube-dl,
248 "nooverwrites" may also be used instead
249 playliststart: Playlist item to start at.
250 playlistend: Playlist item to end at.
251 playlist_items: Specific indices of playlist to download.
252 playlistreverse: Download playlist items in reverse order.
253 playlistrandom: Download playlist items in random order.
254 matchtitle: Download only matching titles.
255 rejecttitle: Reject downloads for matching titles.
256 logger: Log messages to a logging.Logger instance.
257 logtostderr: Log messages to stderr instead of stdout.
258 consoletitle: Display progress in console window's titlebar.
259 writedescription: Write the video description to a .description file
260 writeinfojson: Write the video description to a .info.json file
261 clean_infojson: Remove private fields from the infojson
262 getcomments: Extract video comments. This will not be written to disk
263 unless writeinfojson is also given
264 writeannotations: Write the video annotations to a .annotations.xml file
265 writethumbnail: Write the thumbnail image to a file
266 allow_playlist_files: Whether to write playlists' description, infojson etc
267 also to disk when using the 'write*' options
268 write_all_thumbnails: Write all thumbnail formats to files
269 writelink: Write an internet shortcut file, depending on the
270 current platform (.url/.webloc/.desktop)
271 writeurllink: Write a Windows internet shortcut file (.url)
272 writewebloclink: Write a macOS internet shortcut file (.webloc)
273 writedesktoplink: Write a Linux internet shortcut file (.desktop)
274 writesubtitles: Write the video subtitles to a file
275 writeautomaticsub: Write the automatically generated subtitles to a file
276 allsubtitles: Deprecated - Use subtitleslangs = ['all']
277 Downloads all the subtitles of the video
278 (requires writesubtitles or writeautomaticsub)
279 listsubtitles: Lists all available subtitles for the video
280 subtitlesformat: The format code for subtitles
281 subtitleslangs: List of languages of the subtitles to download (can be regex).
282 The list may contain "all" to refer to all the available
283 subtitles. The language can be prefixed with a "-" to
284 exclude it from the requested languages. Eg: ['all', '-live_chat']
285 keepvideo: Keep the video file after post-processing
286 daterange: A DateRange object, download only if the upload_date is in the range.
287 skip_download: Skip the actual download of the video file
288 cachedir: Location of the cache files in the filesystem.
289 False to disable filesystem cache.
290 noplaylist: Download single video instead of a playlist if in doubt.
291 age_limit: An integer representing the user's age in years.
292 Unsuitable videos for the given age are skipped.
293 min_views: An integer representing the minimum view count the video
294 must have in order to not be skipped.
295 Videos without view count information are always
296 downloaded. None for no limit.
297 max_views: An integer representing the maximum view count.
298 Videos that are more popular than that are not
299 downloaded.
300 Videos without view count information are always
301 downloaded. None for no limit.
302 download_archive: File name of a file where all downloads are recorded.
303 Videos already present in the file are not downloaded
304 again.
305 break_on_existing: Stop the download process after attempting to download a
306 file that is in the archive.
307 break_on_reject: Stop the download process when encountering a video that
308 has been filtered out.
309 cookiefile: File name where cookies should be read from and dumped to
310 cookiesfrombrowser: A tuple containing the name of the browser and the profile
311 name/path from where cookies are loaded.
312 Eg: ('chrome', ) or ('vivaldi', 'default')
313 nocheckcertificate:Do not verify SSL certificates
314 prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
315 At the moment, this is only supported by YouTube.
316 proxy: URL of the proxy server to use
317 geo_verification_proxy: URL of the proxy to use for IP address verification
318 on geo-restricted sites.
319 socket_timeout: Time to wait for unresponsive hosts, in seconds
320 bidi_workaround: Work around buggy terminals without bidirectional text
321 support, using fridibi
322 debug_printtraffic:Print out sent and received HTTP traffic
323 include_ads: Download ads as well
324 default_search: Prepend this string if an input url is not valid.
325 'auto' for elaborate guessing
326 encoding: Use this encoding instead of the system-specified.
327 extract_flat: Do not resolve URLs, return the immediate result.
328 Pass in 'in_playlist' to only show this behavior for
329 playlist items.
330 postprocessors: A list of dictionaries, each with an entry
331 * key: The name of the postprocessor. See
332 yt_dlp/postprocessor/__init__.py for a list.
333 * when: When to run the postprocessor. Can be one of
334 pre_process|before_dl|post_process|after_move.
335 Assumed to be 'post_process' if not given
336 post_hooks: Deprecated - Register a custom postprocessor instead
337 A list of functions that get called as the final step
338 for each video file, after all postprocessors have been
339 called. The filename will be passed as the only argument.
340 progress_hooks: A list of functions that get called on download
341 progress, with a dictionary with the entries
342 * status: One of "downloading", "error", or "finished".
343 Check this first and ignore unknown values.
344 * info_dict: The extracted info_dict
345
346 If status is one of "downloading", or "finished", the
347 following properties may also be present:
348 * filename: The final filename (always present)
349 * tmpfilename: The filename we're currently writing to
350 * downloaded_bytes: Bytes on disk
351 * total_bytes: Size of the whole file, None if unknown
352 * total_bytes_estimate: Guess of the eventual file size,
353 None if unavailable.
354 * elapsed: The number of seconds since download started.
355 * eta: The estimated time in seconds, None if unknown
356 * speed: The download speed in bytes/second, None if
357 unknown
358 * fragment_index: The counter of the currently
359 downloaded video fragment.
360 * fragment_count: The number of fragments (= individual
361 files that will be merged)
362
363 Progress hooks are guaranteed to be called at least once
364 (with status "finished") if the download is successful.
365 postprocessor_hooks: A list of functions that get called on postprocessing
366 progress, with a dictionary with the entries
367 * status: One of "started", "processing", or "finished".
368 Check this first and ignore unknown values.
369 * postprocessor: Name of the postprocessor
370 * info_dict: The extracted info_dict
371
372 Progress hooks are guaranteed to be called at least twice
373 (with status "started" and "finished") if the processing is successful.
374 merge_output_format: Extension to use when merging formats.
375 final_ext: Expected final extension; used to detect when the file was
376 already downloaded and converted. "merge_output_format" is
377 replaced by this extension when given
378 fixup: Automatically correct known faults of the file.
379 One of:
380 - "never": do nothing
381 - "warn": only emit a warning
382 - "detect_or_warn": check whether we can do anything
383 about it, warn otherwise (default)
384 source_address: Client-side IP address to bind to.
385 call_home: Boolean, true iff we are allowed to contact the
386 yt-dlp servers for debugging. (BROKEN)
387 sleep_interval_requests: Number of seconds to sleep between requests
388 during extraction
389 sleep_interval: Number of seconds to sleep before each download when
390 used alone or a lower bound of a range for randomized
391 sleep before each download (minimum possible number
392 of seconds to sleep) when used along with
393 max_sleep_interval.
394 max_sleep_interval:Upper bound of a range for randomized sleep before each
395 download (maximum possible number of seconds to sleep).
396 Must only be used along with sleep_interval.
397 Actual sleep time will be a random float from range
398 [sleep_interval; max_sleep_interval].
399 sleep_interval_subtitles: Number of seconds to sleep before each subtitle download
400 listformats: Print an overview of available video formats and exit.
401 list_thumbnails: Print a table of all thumbnails and exit.
402 match_filter: A function that gets called with the info_dict of
403 every video.
404 If it returns a message, the video is ignored.
405 If it returns None, the video is downloaded.
406 match_filter_func in utils.py is one example for this.
407 no_color: Do not emit color codes in output.
408 geo_bypass: Bypass geographic restriction via faking X-Forwarded-For
409 HTTP header
410 geo_bypass_country:
411 Two-letter ISO 3166-2 country code that will be used for
412 explicit geographic restriction bypassing via faking
413 X-Forwarded-For HTTP header
414 geo_bypass_ip_block:
415 IP range in CIDR notation that will be used similarly to
416 geo_bypass_country
417
418 The following options determine which downloader is picked:
419 external_downloader: A dictionary of protocol keys and the executable of the
420 external downloader to use for it. The allowed protocols
421 are default|http|ftp|m3u8|dash|rtsp|rtmp|mms.
422 Set the value to 'native' to use the native downloader
423 hls_prefer_native: Deprecated - Use external_downloader = {'m3u8': 'native'}
424 or {'m3u8': 'ffmpeg'} instead.
425 Use the native HLS downloader instead of ffmpeg/avconv
426 if True, otherwise use ffmpeg/avconv if False, otherwise
427 use downloader suggested by extractor if None.
428 compat_opts: Compatibility options. See "Differences in default behavior".
429 The following options do not work when used through the API:
430 filename, abort-on-error, multistreams, no-live-chat, format-sort
431 no-clean-infojson, no-playlist-metafiles, no-keep-subs.
432 Refer __init__.py for their implementation
433 progress_template: Dictionary of templates for progress outputs.
434 Allowed keys are 'download', 'postprocess',
435 'download-title' (console title) and 'postprocess-title'.
436 The template is mapped on a dictionary with keys 'progress' and 'info'
437
438 The following parameters are not used by YoutubeDL itself, they are used by
439 the downloader (see yt_dlp/downloader/common.py):
440 nopart, updatetime, buffersize, ratelimit, throttledratelimit, min_filesize,
441 max_filesize, test, noresizebuffer, retries, fragment_retries, continuedl,
442 noprogress, xattr_set_filesize, hls_use_mpegts, http_chunk_size,
443 external_downloader_args.
444
445 The following options are used by the post processors:
446 prefer_ffmpeg: If False, use avconv instead of ffmpeg if both are available,
447 otherwise prefer ffmpeg. (avconv support is deprecated)
448 ffmpeg_location: Location of the ffmpeg/avconv binary; either the path
449 to the binary or its containing directory.
450 postprocessor_args: A dictionary of postprocessor/executable keys (in lower case)
451 and a list of additional command-line arguments for the
452 postprocessor/executable. The dict can also have "PP+EXE" keys
453 which are used when the given exe is used by the given PP.
454 Use 'default' as the name for arguments to passed to all PP
455 For compatibility with youtube-dl, a single list of args
456 can also be used
457
458 The following options are used by the extractors:
459 extractor_retries: Number of times to retry for known errors
460 dynamic_mpd: Whether to process dynamic DASH manifests (default: True)
461 hls_split_discontinuity: Split HLS playlists to different formats at
462 discontinuities such as ad breaks (default: False)
463 extractor_args: A dictionary of arguments to be passed to the extractors.
464 See "EXTRACTOR ARGUMENTS" for details.
465 Eg: {'youtube': {'skip': ['dash', 'hls']}}
466 youtube_include_dash_manifest: Deprecated - Use extractor_args instead.
467 If True (default), DASH manifests and related
468 data will be downloaded and processed by extractor.
469 You can reduce network I/O by disabling it if you don't
470 care about DASH. (only for youtube)
471 youtube_include_hls_manifest: Deprecated - Use extractor_args instead.
472 If True (default), HLS manifests and related
473 data will be downloaded and processed by extractor.
474 You can reduce network I/O by disabling it if you don't
475 care about HLS. (only for youtube)
476 """
477
478 _NUMERIC_FIELDS = set((
479 'width', 'height', 'tbr', 'abr', 'asr', 'vbr', 'fps', 'filesize', 'filesize_approx',
480 'timestamp', 'release_timestamp',
481 'duration', 'view_count', 'like_count', 'dislike_count', 'repost_count',
482 'average_rating', 'comment_count', 'age_limit',
483 'start_time', 'end_time',
484 'chapter_number', 'season_number', 'episode_number',
485 'track_number', 'disc_number', 'release_year',
486 ))
487
488 _format_selection_exts = {
489 'audio': {'m4a', 'mp3', 'ogg', 'aac'},
490 'video': {'mp4', 'flv', 'webm', '3gp'},
491 'storyboards': {'mhtml'},
492 }
493
494 params = None
495 _ies = {}
496 _pps = {'pre_process': [], 'before_dl': [], 'after_move': [], 'post_process': []}
497 _printed_messages = set()
498 _first_webpage_request = True
499 _download_retcode = None
500 _num_downloads = None
501 _playlist_level = 0
502 _playlist_urls = set()
503 _screen_file = None
504
505 def __init__(self, params=None, auto_init=True):
506 """Create a FileDownloader object with the given options.
507 @param auto_init Whether to load the default extractors and print header (if verbose).
508 Set to 'no_verbose_header' to not print the header
509 """
510 if params is None:
511 params = {}
512 self._ies = {}
513 self._ies_instances = {}
514 self._pps = {'pre_process': [], 'before_dl': [], 'after_move': [], 'post_process': []}
515 self._printed_messages = set()
516 self._first_webpage_request = True
517 self._post_hooks = []
518 self._progress_hooks = []
519 self._postprocessor_hooks = []
520 self._download_retcode = 0
521 self._num_downloads = 0
522 self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
523 self._err_file = sys.stderr
524 self.params = params
525 self.cache = Cache(self)
526
527 windows_enable_vt_mode()
528 # FIXME: This will break if we ever print color to stdout
529 self._allow_colors = {
530 'screen': not self.params.get('no_color') and supports_terminal_sequences(self._screen_file),
531 'err': not self.params.get('no_color') and supports_terminal_sequences(self._err_file),
532 }
533
534 if sys.version_info < (3, 6):
535 self.report_warning(
536 'Python version %d.%d is not supported! Please update to Python 3.6 or above' % sys.version_info[:2])
537
538 if self.params.get('allow_unplayable_formats'):
539 self.report_warning(
540 f'You have asked for {self._format_err("UNPLAYABLE", self.Styles.EMPHASIS)} formats to be listed/downloaded. '
541 'This is a developer option intended for debugging. \n'
542 ' If you experience any issues while using this option, '
543 f'{self._format_err("DO NOT", self.Styles.ERROR)} open a bug report')
544
545 def check_deprecated(param, option, suggestion):
546 if self.params.get(param) is not None:
547 self.report_warning('%s is deprecated. Use %s instead' % (option, suggestion))
548 return True
549 return False
550
551 if check_deprecated('cn_verification_proxy', '--cn-verification-proxy', '--geo-verification-proxy'):
552 if self.params.get('geo_verification_proxy') is None:
553 self.params['geo_verification_proxy'] = self.params['cn_verification_proxy']
554
555 check_deprecated('autonumber', '--auto-number', '-o "%(autonumber)s-%(title)s.%(ext)s"')
556 check_deprecated('usetitle', '--title', '-o "%(title)s-%(id)s.%(ext)s"')
557 check_deprecated('useid', '--id', '-o "%(id)s.%(ext)s"')
558
559 for msg in self.params.get('_warnings', []):
560 self.report_warning(msg)
561
562 if 'list-formats' in self.params.get('compat_opts', []):
563 self.params['listformats_table'] = False
564
565 if 'overwrites' not in self.params and self.params.get('nooverwrites') is not None:
566 # nooverwrites was unnecessarily changed to overwrites
567 # in 0c3d0f51778b153f65c21906031c2e091fcfb641
568 # This ensures compatibility with both keys
569 self.params['overwrites'] = not self.params['nooverwrites']
570 elif self.params.get('overwrites') is None:
571 self.params.pop('overwrites', None)
572 else:
573 self.params['nooverwrites'] = not self.params['overwrites']
574
575 if params.get('bidi_workaround', False):
576 try:
577 import pty
578 master, slave = pty.openpty()
579 width = compat_get_terminal_size().columns
580 if width is None:
581 width_args = []
582 else:
583 width_args = ['-w', str(width)]
584 sp_kwargs = dict(
585 stdin=subprocess.PIPE,
586 stdout=slave,
587 stderr=self._err_file)
588 try:
589 self._output_process = Popen(['bidiv'] + width_args, **sp_kwargs)
590 except OSError:
591 self._output_process = Popen(['fribidi', '-c', 'UTF-8'] + width_args, **sp_kwargs)
592 self._output_channel = os.fdopen(master, 'rb')
593 except OSError as ose:
594 if ose.errno == errno.ENOENT:
595 self.report_warning(
596 'Could not find fribidi executable, ignoring --bidi-workaround. '
597 'Make sure that fribidi is an executable file in one of the directories in your $PATH.')
598 else:
599 raise
600
601 if (sys.platform != 'win32'
602 and sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968']
603 and not params.get('restrictfilenames', False)):
604 # Unicode filesystem API will throw errors (#1474, #13027)
605 self.report_warning(
606 'Assuming --restrict-filenames since file system encoding '
607 'cannot encode all characters. '
608 'Set the LC_ALL environment variable to fix this.')
609 self.params['restrictfilenames'] = True
610
611 self.outtmpl_dict = self.parse_outtmpl()
612
613 # Creating format selector here allows us to catch syntax errors before the extraction
614 self.format_selector = (
615 None if self.params.get('format') is None
616 else self.build_format_selector(self.params['format']))
617
618 self._setup_opener()
619
620 if auto_init:
621 if auto_init != 'no_verbose_header':
622 self.print_debug_header()
623 self.add_default_info_extractors()
624
625 for pp_def_raw in self.params.get('postprocessors', []):
626 pp_def = dict(pp_def_raw)
627 when = pp_def.pop('when', 'post_process')
628 pp_class = get_postprocessor(pp_def.pop('key'))
629 pp = pp_class(self, **compat_kwargs(pp_def))
630 self.add_post_processor(pp, when=when)
631
632 for ph in self.params.get('post_hooks', []):
633 self.add_post_hook(ph)
634
635 for ph in self.params.get('progress_hooks', []):
636 self.add_progress_hook(ph)
637
638 register_socks_protocols()
639
640 def preload_download_archive(fn):
641 """Preload the archive, if any is specified"""
642 if fn is None:
643 return False
644 self.write_debug(f'Loading archive file {fn!r}')
645 try:
646 with locked_file(fn, 'r', encoding='utf-8') as archive_file:
647 for line in archive_file:
648 self.archive.add(line.strip())
649 except IOError as ioe:
650 if ioe.errno != errno.ENOENT:
651 raise
652 return False
653 return True
654
655 self.archive = set()
656 preload_download_archive(self.params.get('download_archive'))
657
658 def warn_if_short_id(self, argv):
659 # short YouTube ID starting with dash?
660 idxs = [
661 i for i, a in enumerate(argv)
662 if re.match(r'^-[0-9A-Za-z_-]{10}$', a)]
663 if idxs:
664 correct_argv = (
665 ['yt-dlp']
666 + [a for i, a in enumerate(argv) if i not in idxs]
667 + ['--'] + [argv[i] for i in idxs]
668 )
669 self.report_warning(
670 'Long argument string detected. '
671 'Use -- to separate parameters and URLs, like this:\n%s' %
672 args_to_str(correct_argv))
673
674 def add_info_extractor(self, ie):
675 """Add an InfoExtractor object to the end of the list."""
676 ie_key = ie.ie_key()
677 self._ies[ie_key] = ie
678 if not isinstance(ie, type):
679 self._ies_instances[ie_key] = ie
680 ie.set_downloader(self)
681
682 def _get_info_extractor_class(self, ie_key):
683 ie = self._ies.get(ie_key)
684 if ie is None:
685 ie = get_info_extractor(ie_key)
686 self.add_info_extractor(ie)
687 return ie
688
689 def get_info_extractor(self, ie_key):
690 """
691 Get an instance of an IE with name ie_key, it will try to get one from
692 the _ies list, if there's no instance it will create a new one and add
693 it to the extractor list.
694 """
695 ie = self._ies_instances.get(ie_key)
696 if ie is None:
697 ie = get_info_extractor(ie_key)()
698 self.add_info_extractor(ie)
699 return ie
700
701 def add_default_info_extractors(self):
702 """
703 Add the InfoExtractors returned by gen_extractors to the end of the list
704 """
705 for ie in gen_extractor_classes():
706 self.add_info_extractor(ie)
707
708 def add_post_processor(self, pp, when='post_process'):
709 """Add a PostProcessor object to the end of the chain."""
710 self._pps[when].append(pp)
711 pp.set_downloader(self)
712
713 def add_post_hook(self, ph):
714 """Add the post hook"""
715 self._post_hooks.append(ph)
716
717 def add_progress_hook(self, ph):
718 """Add the download progress hook"""
719 self._progress_hooks.append(ph)
720
721 def add_postprocessor_hook(self, ph):
722 """Add the postprocessing progress hook"""
723 self._postprocessor_hooks.append(ph)
724
725 def _bidi_workaround(self, message):
726 if not hasattr(self, '_output_channel'):
727 return message
728
729 assert hasattr(self, '_output_process')
730 assert isinstance(message, compat_str)
731 line_count = message.count('\n') + 1
732 self._output_process.stdin.write((message + '\n').encode('utf-8'))
733 self._output_process.stdin.flush()
734 res = ''.join(self._output_channel.readline().decode('utf-8')
735 for _ in range(line_count))
736 return res[:-len('\n')]
737
738 def _write_string(self, message, out=None, only_once=False):
739 if only_once:
740 if message in self._printed_messages:
741 return
742 self._printed_messages.add(message)
743 write_string(message, out=out, encoding=self.params.get('encoding'))
744
745 def to_stdout(self, message, skip_eol=False, quiet=False):
746 """Print message to stdout"""
747 if self.params.get('logger'):
748 self.params['logger'].debug(message)
749 elif not quiet or self.params.get('verbose'):
750 self._write_string(
751 '%s%s' % (self._bidi_workaround(message), ('' if skip_eol else '\n')),
752 self._err_file if quiet else self._screen_file)
753
754 def to_stderr(self, message, only_once=False):
755 """Print message to stderr"""
756 assert isinstance(message, compat_str)
757 if self.params.get('logger'):
758 self.params['logger'].error(message)
759 else:
760 self._write_string('%s\n' % self._bidi_workaround(message), self._err_file, only_once=only_once)
761
762 def to_console_title(self, message):
763 if not self.params.get('consoletitle', False):
764 return
765 if compat_os_name == 'nt':
766 if ctypes.windll.kernel32.GetConsoleWindow():
767 # c_wchar_p() might not be necessary if `message` is
768 # already of type unicode()
769 ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
770 elif 'TERM' in os.environ:
771 self._write_string('\033]0;%s\007' % message, self._screen_file)
772
773 def save_console_title(self):
774 if not self.params.get('consoletitle', False):
775 return
776 if self.params.get('simulate'):
777 return
778 if compat_os_name != 'nt' and 'TERM' in os.environ:
779 # Save the title on stack
780 self._write_string('\033[22;0t', self._screen_file)
781
782 def restore_console_title(self):
783 if not self.params.get('consoletitle', False):
784 return
785 if self.params.get('simulate'):
786 return
787 if compat_os_name != 'nt' and 'TERM' in os.environ:
788 # Restore the title from stack
789 self._write_string('\033[23;0t', self._screen_file)
790
791 def __enter__(self):
792 self.save_console_title()
793 return self
794
795 def __exit__(self, *args):
796 self.restore_console_title()
797
798 if self.params.get('cookiefile') is not None:
799 self.cookiejar.save(ignore_discard=True, ignore_expires=True)
800
801 def trouble(self, message=None, tb=None):
802 """Determine action to take when a download problem appears.
803
804 Depending on if the downloader has been configured to ignore
805 download errors or not, this method may throw an exception or
806 not when errors are found, after printing the message.
807
808 tb, if given, is additional traceback information.
809 """
810 if message is not None:
811 self.to_stderr(message)
812 if self.params.get('verbose'):
813 if tb is None:
814 if sys.exc_info()[0]: # if .trouble has been called from an except block
815 tb = ''
816 if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
817 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
818 tb += encode_compat_str(traceback.format_exc())
819 else:
820 tb_data = traceback.format_list(traceback.extract_stack())
821 tb = ''.join(tb_data)
822 if tb:
823 self.to_stderr(tb)
824 if not self.params.get('ignoreerrors'):
825 if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
826 exc_info = sys.exc_info()[1].exc_info
827 else:
828 exc_info = sys.exc_info()
829 raise DownloadError(message, exc_info)
830 self._download_retcode = 1
831
832 def to_screen(self, message, skip_eol=False):
833 """Print message to stdout if not in quiet mode"""
834 self.to_stdout(
835 message, skip_eol, quiet=self.params.get('quiet', False))
836
837 class Styles(Enum):
838 HEADERS = 'yellow'
839 EMPHASIS = 'blue'
840 ID = 'green'
841 DELIM = 'blue'
842 ERROR = 'red'
843 WARNING = 'yellow'
844
845 def __format_text(self, out, text, f, fallback=None, *, test_encoding=False):
846 assert out in ('screen', 'err')
847 if test_encoding:
848 original_text = text
849 handle = self._screen_file if out == 'screen' else self._err_file
850 encoding = self.params.get('encoding') or getattr(handle, 'encoding', 'ascii')
851 text = text.encode(encoding, 'ignore').decode(encoding)
852 if fallback is not None and text != original_text:
853 text = fallback
854 if isinstance(f, self.Styles):
855 f = f._value_
856 return format_text(text, f) if self._allow_colors[out] else text if fallback is None else fallback
857
858 def _format_screen(self, *args, **kwargs):
859 return self.__format_text('screen', *args, **kwargs)
860
861 def _format_err(self, *args, **kwargs):
862 return self.__format_text('err', *args, **kwargs)
863
864 def report_warning(self, message, only_once=False):
865 '''
866 Print the message to stderr, it will be prefixed with 'WARNING:'
867 If stderr is a tty file the 'WARNING:' will be colored
868 '''
869 if self.params.get('logger') is not None:
870 self.params['logger'].warning(message)
871 else:
872 if self.params.get('no_warnings'):
873 return
874 self.to_stderr(f'{self._format_err("WARNING:", self.Styles.WARNING)} {message}', only_once)
875
876 def report_error(self, message, tb=None):
877 '''
878 Do the same as trouble, but prefixes the message with 'ERROR:', colored
879 in red if stderr is a tty file.
880 '''
881 self.trouble(f'{self._format_err("ERROR:", self.Styles.ERROR)} {message}', tb)
882
883 def write_debug(self, message, only_once=False):
884 '''Log debug message or Print message to stderr'''
885 if not self.params.get('verbose', False):
886 return
887 message = '[debug] %s' % message
888 if self.params.get('logger'):
889 self.params['logger'].debug(message)
890 else:
891 self.to_stderr(message, only_once)
892
893 def report_file_already_downloaded(self, file_name):
894 """Report file has already been fully downloaded."""
895 try:
896 self.to_screen('[download] %s has already been downloaded' % file_name)
897 except UnicodeEncodeError:
898 self.to_screen('[download] The file has already been downloaded')
899
900 def report_file_delete(self, file_name):
901 """Report that existing file will be deleted."""
902 try:
903 self.to_screen('Deleting existing file %s' % file_name)
904 except UnicodeEncodeError:
905 self.to_screen('Deleting existing file')
906
907 def raise_no_formats(self, info, forced=False):
908 has_drm = info.get('__has_drm')
909 msg = 'This video is DRM protected' if has_drm else 'No video formats found!'
910 expected = self.params.get('ignore_no_formats_error')
911 if forced or not expected:
912 raise ExtractorError(msg, video_id=info['id'], ie=info['extractor'],
913 expected=has_drm or expected)
914 else:
915 self.report_warning(msg)
916
917 def parse_outtmpl(self):
918 outtmpl_dict = self.params.get('outtmpl', {})
919 if not isinstance(outtmpl_dict, dict):
920 outtmpl_dict = {'default': outtmpl_dict}
921 # Remove spaces in the default template
922 if self.params.get('restrictfilenames'):
923 sanitize = lambda x: x.replace(' - ', ' ').replace(' ', '-')
924 else:
925 sanitize = lambda x: x
926 outtmpl_dict.update({
927 k: sanitize(v) for k, v in DEFAULT_OUTTMPL.items()
928 if outtmpl_dict.get(k) is None})
929 for key, val in outtmpl_dict.items():
930 if isinstance(val, bytes):
931 self.report_warning(
932 'Parameter outtmpl is bytes, but should be a unicode string. '
933 'Put from __future__ import unicode_literals at the top of your code file or consider switching to Python 3.x.')
934 return outtmpl_dict
935
936 def get_output_path(self, dir_type='', filename=None):
937 paths = self.params.get('paths', {})
938 assert isinstance(paths, dict)
939 path = os.path.join(
940 expand_path(paths.get('home', '').strip()),
941 expand_path(paths.get(dir_type, '').strip()) if dir_type else '',
942 filename or '')
943
944 # Temporary fix for #4787
945 # 'Treat' all problem characters by passing filename through preferredencoding
946 # to workaround encoding issues with subprocess on python2 @ Windows
947 if sys.version_info < (3, 0) and sys.platform == 'win32':
948 path = encodeFilename(path, True).decode(preferredencoding())
949 return sanitize_path(path, force=self.params.get('windowsfilenames'))
950
951 @staticmethod
952 def _outtmpl_expandpath(outtmpl):
953 # expand_path translates '%%' into '%' and '$$' into '$'
954 # correspondingly that is not what we want since we need to keep
955 # '%%' intact for template dict substitution step. Working around
956 # with boundary-alike separator hack.
957 sep = ''.join([random.choice(ascii_letters) for _ in range(32)])
958 outtmpl = outtmpl.replace('%%', '%{0}%'.format(sep)).replace('$$', '${0}$'.format(sep))
959
960 # outtmpl should be expand_path'ed before template dict substitution
961 # because meta fields may contain env variables we don't want to
962 # be expanded. For example, for outtmpl "%(title)s.%(ext)s" and
963 # title "Hello $PATH", we don't want `$PATH` to be expanded.
964 return expand_path(outtmpl).replace(sep, '')
965
966 @staticmethod
967 def escape_outtmpl(outtmpl):
968 ''' Escape any remaining strings like %s, %abc% etc. '''
969 return re.sub(
970 STR_FORMAT_RE_TMPL.format('', '(?![%(\0])'),
971 lambda mobj: ('' if mobj.group('has_key') else '%') + mobj.group(0),
972 outtmpl)
973
974 @classmethod
975 def validate_outtmpl(cls, outtmpl):
976 ''' @return None or Exception object '''
977 outtmpl = re.sub(
978 STR_FORMAT_RE_TMPL.format('[^)]*', '[ljqBU]'),
979 lambda mobj: f'{mobj.group(0)[:-1]}s',
980 cls._outtmpl_expandpath(outtmpl))
981 try:
982 cls.escape_outtmpl(outtmpl) % collections.defaultdict(int)
983 return None
984 except ValueError as err:
985 return err
986
987 @staticmethod
988 def _copy_infodict(info_dict):
989 info_dict = dict(info_dict)
990 for key in ('__original_infodict', '__postprocessors'):
991 info_dict.pop(key, None)
992 return info_dict
993
994 def prepare_outtmpl(self, outtmpl, info_dict, sanitize=None):
995 """ Make the outtmpl and info_dict suitable for substitution: ydl.escape_outtmpl(outtmpl) % info_dict """
996 info_dict.setdefault('epoch', int(time.time())) # keep epoch consistent once set
997
998 info_dict = self._copy_infodict(info_dict)
999 info_dict['duration_string'] = ( # %(duration>%H-%M-%S)s is wrong if duration > 24hrs
1000 formatSeconds(info_dict['duration'], '-' if sanitize else ':')
1001 if info_dict.get('duration', None) is not None
1002 else None)
1003 info_dict['autonumber'] = self.params.get('autonumber_start', 1) - 1 + self._num_downloads
1004 if info_dict.get('resolution') is None:
1005 info_dict['resolution'] = self.format_resolution(info_dict, default=None)
1006
1007 # For fields playlist_index, playlist_autonumber and autonumber convert all occurrences
1008 # of %(field)s to %(field)0Nd for backward compatibility
1009 field_size_compat_map = {
1010 'playlist_index': number_of_digits(info_dict.get('_last_playlist_index') or 0),
1011 'playlist_autonumber': number_of_digits(info_dict.get('n_entries') or 0),
1012 'autonumber': self.params.get('autonumber_size') or 5,
1013 }
1014
1015 TMPL_DICT = {}
1016 EXTERNAL_FORMAT_RE = re.compile(STR_FORMAT_RE_TMPL.format('[^)]*', f'[{STR_FORMAT_TYPES}ljqBU]'))
1017 MATH_FUNCTIONS = {
1018 '+': float.__add__,
1019 '-': float.__sub__,
1020 }
1021 # Field is of the form key1.key2...
1022 # where keys (except first) can be string, int or slice
1023 FIELD_RE = r'\w*(?:\.(?:\w+|{num}|{num}?(?::{num}?){{1,2}}))*'.format(num=r'(?:-?\d+)')
1024 MATH_FIELD_RE = r'''{field}|{num}'''.format(field=FIELD_RE, num=r'-?\d+(?:.\d+)?')
1025 MATH_OPERATORS_RE = r'(?:%s)' % '|'.join(map(re.escape, MATH_FUNCTIONS.keys()))
1026 INTERNAL_FORMAT_RE = re.compile(r'''(?x)
1027 (?P<negate>-)?
1028 (?P<fields>{field})
1029 (?P<maths>(?:{math_op}{math_field})*)
1030 (?:>(?P<strf_format>.+?))?
1031 (?P<alternate>(?<!\\),[^|)]+)?
1032 (?:\|(?P<default>.*?))?
1033 $'''.format(field=FIELD_RE, math_op=MATH_OPERATORS_RE, math_field=MATH_FIELD_RE))
1034
1035 def _traverse_infodict(k):
1036 k = k.split('.')
1037 if k[0] == '':
1038 k.pop(0)
1039 return traverse_obj(info_dict, k, is_user_input=True, traverse_string=True)
1040
1041 def get_value(mdict):
1042 # Object traversal
1043 value = _traverse_infodict(mdict['fields'])
1044 # Negative
1045 if mdict['negate']:
1046 value = float_or_none(value)
1047 if value is not None:
1048 value *= -1
1049 # Do maths
1050 offset_key = mdict['maths']
1051 if offset_key:
1052 value = float_or_none(value)
1053 operator = None
1054 while offset_key:
1055 item = re.match(
1056 MATH_FIELD_RE if operator else MATH_OPERATORS_RE,
1057 offset_key).group(0)
1058 offset_key = offset_key[len(item):]
1059 if operator is None:
1060 operator = MATH_FUNCTIONS[item]
1061 continue
1062 item, multiplier = (item[1:], -1) if item[0] == '-' else (item, 1)
1063 offset = float_or_none(item)
1064 if offset is None:
1065 offset = float_or_none(_traverse_infodict(item))
1066 try:
1067 value = operator(value, multiplier * offset)
1068 except (TypeError, ZeroDivisionError):
1069 return None
1070 operator = None
1071 # Datetime formatting
1072 if mdict['strf_format']:
1073 value = strftime_or_none(value, mdict['strf_format'].replace('\\,', ','))
1074
1075 return value
1076
1077 na = self.params.get('outtmpl_na_placeholder', 'NA')
1078
1079 def _dumpjson_default(obj):
1080 if isinstance(obj, (set, LazyList)):
1081 return list(obj)
1082 raise TypeError(f'Object of type {type(obj).__name__} is not JSON serializable')
1083
1084 def create_key(outer_mobj):
1085 if not outer_mobj.group('has_key'):
1086 return outer_mobj.group(0)
1087 key = outer_mobj.group('key')
1088 mobj = re.match(INTERNAL_FORMAT_RE, key)
1089 initial_field = mobj.group('fields').split('.')[-1] if mobj else ''
1090 value, default = None, na
1091 while mobj:
1092 mobj = mobj.groupdict()
1093 default = mobj['default'] if mobj['default'] is not None else default
1094 value = get_value(mobj)
1095 if value is None and mobj['alternate']:
1096 mobj = re.match(INTERNAL_FORMAT_RE, mobj['alternate'][1:])
1097 else:
1098 break
1099
1100 fmt = outer_mobj.group('format')
1101 if fmt == 's' and value is not None and key in field_size_compat_map.keys():
1102 fmt = '0{:d}d'.format(field_size_compat_map[key])
1103
1104 value = default if value is None else value
1105
1106 str_fmt = f'{fmt[:-1]}s'
1107 if fmt[-1] == 'l': # list
1108 delim = '\n' if '#' in (outer_mobj.group('conversion') or '') else ', '
1109 value, fmt = delim.join(variadic(value)), str_fmt
1110 elif fmt[-1] == 'j': # json
1111 value, fmt = json.dumps(value, default=_dumpjson_default), str_fmt
1112 elif fmt[-1] == 'q': # quoted
1113 value, fmt = compat_shlex_quote(str(value)), str_fmt
1114 elif fmt[-1] == 'B': # bytes
1115 value = f'%{str_fmt}'.encode('utf-8') % str(value).encode('utf-8')
1116 value, fmt = value.decode('utf-8', 'ignore'), 's'
1117 elif fmt[-1] == 'U': # unicode normalized
1118 opts = outer_mobj.group('conversion') or ''
1119 value, fmt = unicodedata.normalize(
1120 # "+" = compatibility equivalence, "#" = NFD
1121 'NF%s%s' % ('K' if '+' in opts else '', 'D' if '#' in opts else 'C'),
1122 value), str_fmt
1123 elif fmt[-1] == 'c':
1124 if value:
1125 value = str(value)[0]
1126 else:
1127 fmt = str_fmt
1128 elif fmt[-1] not in 'rs': # numeric
1129 value = float_or_none(value)
1130 if value is None:
1131 value, fmt = default, 's'
1132
1133 if sanitize:
1134 if fmt[-1] == 'r':
1135 # If value is an object, sanitize might convert it to a string
1136 # So we convert it to repr first
1137 value, fmt = repr(value), str_fmt
1138 if fmt[-1] in 'csr':
1139 value = sanitize(initial_field, value)
1140
1141 key = '%s\0%s' % (key.replace('%', '%\0'), outer_mobj.group('format'))
1142 TMPL_DICT[key] = value
1143 return '{prefix}%({key}){fmt}'.format(key=key, fmt=fmt, prefix=outer_mobj.group('prefix'))
1144
1145 return EXTERNAL_FORMAT_RE.sub(create_key, outtmpl), TMPL_DICT
1146
1147 def evaluate_outtmpl(self, outtmpl, info_dict, *args, **kwargs):
1148 outtmpl, info_dict = self.prepare_outtmpl(outtmpl, info_dict, *args, **kwargs)
1149 return self.escape_outtmpl(outtmpl) % info_dict
1150
1151 def _prepare_filename(self, info_dict, tmpl_type='default'):
1152 try:
1153 sanitize = lambda k, v: sanitize_filename(
1154 compat_str(v),
1155 restricted=self.params.get('restrictfilenames'),
1156 is_id=(k == 'id' or k.endswith('_id')))
1157 outtmpl = self._outtmpl_expandpath(self.outtmpl_dict.get(tmpl_type, self.outtmpl_dict['default']))
1158 filename = self.evaluate_outtmpl(outtmpl, info_dict, sanitize)
1159
1160 force_ext = OUTTMPL_TYPES.get(tmpl_type)
1161 if filename and force_ext is not None:
1162 filename = replace_extension(filename, force_ext, info_dict.get('ext'))
1163
1164 # https://github.com/blackjack4494/youtube-dlc/issues/85
1165 trim_file_name = self.params.get('trim_file_name', False)
1166 if trim_file_name:
1167 fn_groups = filename.rsplit('.')
1168 ext = fn_groups[-1]
1169 sub_ext = ''
1170 if len(fn_groups) > 2:
1171 sub_ext = fn_groups[-2]
1172 filename = '.'.join(filter(None, [fn_groups[0][:trim_file_name], sub_ext, ext]))
1173
1174 return filename
1175 except ValueError as err:
1176 self.report_error('Error in output template: ' + str(err) + ' (encoding: ' + repr(preferredencoding()) + ')')
1177 return None
1178
1179 def prepare_filename(self, info_dict, dir_type='', warn=False):
1180 """Generate the output filename."""
1181
1182 filename = self._prepare_filename(info_dict, dir_type or 'default')
1183 if not filename and dir_type not in ('', 'temp'):
1184 return ''
1185
1186 if warn:
1187 if not self.params.get('paths'):
1188 pass
1189 elif filename == '-':
1190 self.report_warning('--paths is ignored when an outputting to stdout', only_once=True)
1191 elif os.path.isabs(filename):
1192 self.report_warning('--paths is ignored since an absolute path is given in output template', only_once=True)
1193 if filename == '-' or not filename:
1194 return filename
1195
1196 return self.get_output_path(dir_type, filename)
1197
1198 def _match_entry(self, info_dict, incomplete=False, silent=False):
1199 """ Returns None if the file should be downloaded """
1200
1201 video_title = info_dict.get('title', info_dict.get('id', 'video'))
1202
1203 def check_filter():
1204 if 'title' in info_dict:
1205 # This can happen when we're just evaluating the playlist
1206 title = info_dict['title']
1207 matchtitle = self.params.get('matchtitle', False)
1208 if matchtitle:
1209 if not re.search(matchtitle, title, re.IGNORECASE):
1210 return '"' + title + '" title did not match pattern "' + matchtitle + '"'
1211 rejecttitle = self.params.get('rejecttitle', False)
1212 if rejecttitle:
1213 if re.search(rejecttitle, title, re.IGNORECASE):
1214 return '"' + title + '" title matched reject pattern "' + rejecttitle + '"'
1215 date = info_dict.get('upload_date')
1216 if date is not None:
1217 dateRange = self.params.get('daterange', DateRange())
1218 if date not in dateRange:
1219 return '%s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
1220 view_count = info_dict.get('view_count')
1221 if view_count is not None:
1222 min_views = self.params.get('min_views')
1223 if min_views is not None and view_count < min_views:
1224 return 'Skipping %s, because it has not reached minimum view count (%d/%d)' % (video_title, view_count, min_views)
1225 max_views = self.params.get('max_views')
1226 if max_views is not None and view_count > max_views:
1227 return 'Skipping %s, because it has exceeded the maximum view count (%d/%d)' % (video_title, view_count, max_views)
1228 if age_restricted(info_dict.get('age_limit'), self.params.get('age_limit')):
1229 return 'Skipping "%s" because it is age restricted' % video_title
1230
1231 match_filter = self.params.get('match_filter')
1232 if match_filter is not None:
1233 try:
1234 ret = match_filter(info_dict, incomplete=incomplete)
1235 except TypeError:
1236 # For backward compatibility
1237 ret = None if incomplete else match_filter(info_dict)
1238 if ret is not None:
1239 return ret
1240 return None
1241
1242 if self.in_download_archive(info_dict):
1243 reason = '%s has already been recorded in the archive' % video_title
1244 break_opt, break_err = 'break_on_existing', ExistingVideoReached
1245 else:
1246 reason = check_filter()
1247 break_opt, break_err = 'break_on_reject', RejectedVideoReached
1248 if reason is not None:
1249 if not silent:
1250 self.to_screen('[download] ' + reason)
1251 if self.params.get(break_opt, False):
1252 raise break_err()
1253 return reason
1254
1255 @staticmethod
1256 def add_extra_info(info_dict, extra_info):
1257 '''Set the keys from extra_info in info dict if they are missing'''
1258 for key, value in extra_info.items():
1259 info_dict.setdefault(key, value)
1260
1261 def extract_info(self, url, download=True, ie_key=None, extra_info=None,
1262 process=True, force_generic_extractor=False):
1263 """
1264 Return a list with a dictionary for each video extracted.
1265
1266 Arguments:
1267 url -- URL to extract
1268
1269 Keyword arguments:
1270 download -- whether to download videos during extraction
1271 ie_key -- extractor key hint
1272 extra_info -- dictionary containing the extra values to add to each result
1273 process -- whether to resolve all unresolved references (URLs, playlist items),
1274 must be True for download to work.
1275 force_generic_extractor -- force using the generic extractor
1276 """
1277
1278 if extra_info is None:
1279 extra_info = {}
1280
1281 if not ie_key and force_generic_extractor:
1282 ie_key = 'Generic'
1283
1284 if ie_key:
1285 ies = {ie_key: self._get_info_extractor_class(ie_key)}
1286 else:
1287 ies = self._ies
1288
1289 for ie_key, ie in ies.items():
1290 if not ie.suitable(url):
1291 continue
1292
1293 if not ie.working():
1294 self.report_warning('The program functionality for this site has been marked as broken, '
1295 'and will probably not work.')
1296
1297 temp_id = ie.get_temp_id(url)
1298 if temp_id is not None and self.in_download_archive({'id': temp_id, 'ie_key': ie_key}):
1299 self.to_screen("[%s] %s: has already been recorded in archive" % (
1300 ie_key, temp_id))
1301 break
1302 return self.__extract_info(url, self.get_info_extractor(ie_key), download, extra_info, process)
1303 else:
1304 self.report_error('no suitable InfoExtractor for URL %s' % url)
1305
1306 def __handle_extraction_exceptions(func):
1307 @functools.wraps(func)
1308 def wrapper(self, *args, **kwargs):
1309 try:
1310 return func(self, *args, **kwargs)
1311 except GeoRestrictedError as e:
1312 msg = e.msg
1313 if e.countries:
1314 msg += '\nThis video is available in %s.' % ', '.join(
1315 map(ISO3166Utils.short2full, e.countries))
1316 msg += '\nYou might want to use a VPN or a proxy server (with --proxy) to workaround.'
1317 self.report_error(msg)
1318 except ExtractorError as e: # An error we somewhat expected
1319 self.report_error(compat_str(e), e.format_traceback())
1320 except ThrottledDownload:
1321 self.to_stderr('\r')
1322 self.report_warning('The download speed is below throttle limit. Re-extracting data')
1323 return wrapper(self, *args, **kwargs)
1324 except (MaxDownloadsReached, ExistingVideoReached, RejectedVideoReached, LazyList.IndexError):
1325 raise
1326 except Exception as e:
1327 if self.params.get('ignoreerrors'):
1328 self.report_error(error_to_compat_str(e), tb=encode_compat_str(traceback.format_exc()))
1329 else:
1330 raise
1331 return wrapper
1332
1333 @__handle_extraction_exceptions
1334 def __extract_info(self, url, ie, download, extra_info, process):
1335 ie_result = ie.extract(url)
1336 if ie_result is None: # Finished already (backwards compatibility; listformats and friends should be moved here)
1337 return
1338 if isinstance(ie_result, list):
1339 # Backwards compatibility: old IE result format
1340 ie_result = {
1341 '_type': 'compat_list',
1342 'entries': ie_result,
1343 }
1344 if extra_info.get('original_url'):
1345 ie_result.setdefault('original_url', extra_info['original_url'])
1346 self.add_default_extra_info(ie_result, ie, url)
1347 if process:
1348 return self.process_ie_result(ie_result, download, extra_info)
1349 else:
1350 return ie_result
1351
1352 def add_default_extra_info(self, ie_result, ie, url):
1353 if url is not None:
1354 self.add_extra_info(ie_result, {
1355 'webpage_url': url,
1356 'original_url': url,
1357 'webpage_url_basename': url_basename(url),
1358 })
1359 if ie is not None:
1360 self.add_extra_info(ie_result, {
1361 'extractor': ie.IE_NAME,
1362 'extractor_key': ie.ie_key(),
1363 })
1364
1365 def process_ie_result(self, ie_result, download=True, extra_info=None):
1366 """
1367 Take the result of the ie(may be modified) and resolve all unresolved
1368 references (URLs, playlist items).
1369
1370 It will also download the videos if 'download'.
1371 Returns the resolved ie_result.
1372 """
1373 if extra_info is None:
1374 extra_info = {}
1375 result_type = ie_result.get('_type', 'video')
1376
1377 if result_type in ('url', 'url_transparent'):
1378 ie_result['url'] = sanitize_url(ie_result['url'])
1379 if ie_result.get('original_url'):
1380 extra_info.setdefault('original_url', ie_result['original_url'])
1381
1382 extract_flat = self.params.get('extract_flat', False)
1383 if ((extract_flat == 'in_playlist' and 'playlist' in extra_info)
1384 or extract_flat is True):
1385 info_copy = ie_result.copy()
1386 ie = try_get(ie_result.get('ie_key'), self.get_info_extractor)
1387 if ie and not ie_result.get('id'):
1388 info_copy['id'] = ie.get_temp_id(ie_result['url'])
1389 self.add_default_extra_info(info_copy, ie, ie_result['url'])
1390 self.add_extra_info(info_copy, extra_info)
1391 self.__forced_printings(info_copy, self.prepare_filename(info_copy), incomplete=True)
1392 if self.params.get('force_write_download_archive', False):
1393 self.record_download_archive(info_copy)
1394 return ie_result
1395
1396 if result_type == 'video':
1397 self.add_extra_info(ie_result, extra_info)
1398 ie_result = self.process_video_result(ie_result, download=download)
1399 additional_urls = (ie_result or {}).get('additional_urls')
1400 if additional_urls:
1401 # TODO: Improve MetadataParserPP to allow setting a list
1402 if isinstance(additional_urls, compat_str):
1403 additional_urls = [additional_urls]
1404 self.to_screen(
1405 '[info] %s: %d additional URL(s) requested' % (ie_result['id'], len(additional_urls)))
1406 self.write_debug('Additional URLs: "%s"' % '", "'.join(additional_urls))
1407 ie_result['additional_entries'] = [
1408 self.extract_info(
1409 url, download, extra_info,
1410 force_generic_extractor=self.params.get('force_generic_extractor'))
1411 for url in additional_urls
1412 ]
1413 return ie_result
1414 elif result_type == 'url':
1415 # We have to add extra_info to the results because it may be
1416 # contained in a playlist
1417 return self.extract_info(
1418 ie_result['url'], download,
1419 ie_key=ie_result.get('ie_key'),
1420 extra_info=extra_info)
1421 elif result_type == 'url_transparent':
1422 # Use the information from the embedding page
1423 info = self.extract_info(
1424 ie_result['url'], ie_key=ie_result.get('ie_key'),
1425 extra_info=extra_info, download=False, process=False)
1426
1427 # extract_info may return None when ignoreerrors is enabled and
1428 # extraction failed with an error, don't crash and return early
1429 # in this case
1430 if not info:
1431 return info
1432
1433 force_properties = dict(
1434 (k, v) for k, v in ie_result.items() if v is not None)
1435 for f in ('_type', 'url', 'id', 'extractor', 'extractor_key', 'ie_key'):
1436 if f in force_properties:
1437 del force_properties[f]
1438 new_result = info.copy()
1439 new_result.update(force_properties)
1440
1441 # Extracted info may not be a video result (i.e.
1442 # info.get('_type', 'video') != video) but rather an url or
1443 # url_transparent. In such cases outer metadata (from ie_result)
1444 # should be propagated to inner one (info). For this to happen
1445 # _type of info should be overridden with url_transparent. This
1446 # fixes issue from https://github.com/ytdl-org/youtube-dl/pull/11163.
1447 if new_result.get('_type') == 'url':
1448 new_result['_type'] = 'url_transparent'
1449
1450 return self.process_ie_result(
1451 new_result, download=download, extra_info=extra_info)
1452 elif result_type in ('playlist', 'multi_video'):
1453 # Protect from infinite recursion due to recursively nested playlists
1454 # (see https://github.com/ytdl-org/youtube-dl/issues/27833)
1455 webpage_url = ie_result['webpage_url']
1456 if webpage_url in self._playlist_urls:
1457 self.to_screen(
1458 '[download] Skipping already downloaded playlist: %s'
1459 % ie_result.get('title') or ie_result.get('id'))
1460 return
1461
1462 self._playlist_level += 1
1463 self._playlist_urls.add(webpage_url)
1464 self._sanitize_thumbnails(ie_result)
1465 try:
1466 return self.__process_playlist(ie_result, download)
1467 finally:
1468 self._playlist_level -= 1
1469 if not self._playlist_level:
1470 self._playlist_urls.clear()
1471 elif result_type == 'compat_list':
1472 self.report_warning(
1473 'Extractor %s returned a compat_list result. '
1474 'It needs to be updated.' % ie_result.get('extractor'))
1475
1476 def _fixup(r):
1477 self.add_extra_info(r, {
1478 'extractor': ie_result['extractor'],
1479 'webpage_url': ie_result['webpage_url'],
1480 'webpage_url_basename': url_basename(ie_result['webpage_url']),
1481 'extractor_key': ie_result['extractor_key'],
1482 })
1483 return r
1484 ie_result['entries'] = [
1485 self.process_ie_result(_fixup(r), download, extra_info)
1486 for r in ie_result['entries']
1487 ]
1488 return ie_result
1489 else:
1490 raise Exception('Invalid result type: %s' % result_type)
1491
1492 def _ensure_dir_exists(self, path):
1493 return make_dir(path, self.report_error)
1494
1495 def __process_playlist(self, ie_result, download):
1496 # We process each entry in the playlist
1497 playlist = ie_result.get('title') or ie_result.get('id')
1498 self.to_screen('[download] Downloading playlist: %s' % playlist)
1499
1500 if 'entries' not in ie_result:
1501 raise EntryNotInPlaylist()
1502 incomplete_entries = bool(ie_result.get('requested_entries'))
1503 if incomplete_entries:
1504 def fill_missing_entries(entries, indexes):
1505 ret = [None] * max(*indexes)
1506 for i, entry in zip(indexes, entries):
1507 ret[i - 1] = entry
1508 return ret
1509 ie_result['entries'] = fill_missing_entries(ie_result['entries'], ie_result['requested_entries'])
1510
1511 playlist_results = []
1512
1513 playliststart = self.params.get('playliststart', 1)
1514 playlistend = self.params.get('playlistend')
1515 # For backwards compatibility, interpret -1 as whole list
1516 if playlistend == -1:
1517 playlistend = None
1518
1519 playlistitems_str = self.params.get('playlist_items')
1520 playlistitems = None
1521 if playlistitems_str is not None:
1522 def iter_playlistitems(format):
1523 for string_segment in format.split(','):
1524 if '-' in string_segment:
1525 start, end = string_segment.split('-')
1526 for item in range(int(start), int(end) + 1):
1527 yield int(item)
1528 else:
1529 yield int(string_segment)
1530 playlistitems = orderedSet(iter_playlistitems(playlistitems_str))
1531
1532 ie_entries = ie_result['entries']
1533 msg = (
1534 'Downloading %d videos' if not isinstance(ie_entries, list)
1535 else 'Collected %d videos; downloading %%d of them' % len(ie_entries))
1536
1537 if isinstance(ie_entries, list):
1538 def get_entry(i):
1539 return ie_entries[i - 1]
1540 else:
1541 if not isinstance(ie_entries, PagedList):
1542 ie_entries = LazyList(ie_entries)
1543
1544 def get_entry(i):
1545 return YoutubeDL.__handle_extraction_exceptions(
1546 lambda self, i: ie_entries[i - 1]
1547 )(self, i)
1548
1549 entries = []
1550 items = playlistitems if playlistitems is not None else itertools.count(playliststart)
1551 for i in items:
1552 if i == 0:
1553 continue
1554 if playlistitems is None and playlistend is not None and playlistend < i:
1555 break
1556 entry = None
1557 try:
1558 entry = get_entry(i)
1559 if entry is None:
1560 raise EntryNotInPlaylist()
1561 except (IndexError, EntryNotInPlaylist):
1562 if incomplete_entries:
1563 raise EntryNotInPlaylist()
1564 elif not playlistitems:
1565 break
1566 entries.append(entry)
1567 try:
1568 if entry is not None:
1569 self._match_entry(entry, incomplete=True, silent=True)
1570 except (ExistingVideoReached, RejectedVideoReached):
1571 break
1572 ie_result['entries'] = entries
1573
1574 # Save playlist_index before re-ordering
1575 entries = [
1576 ((playlistitems[i - 1] if playlistitems else i + playliststart - 1), entry)
1577 for i, entry in enumerate(entries, 1)
1578 if entry is not None]
1579 n_entries = len(entries)
1580
1581 if not playlistitems and (playliststart or playlistend):
1582 playlistitems = list(range(playliststart, playliststart + n_entries))
1583 ie_result['requested_entries'] = playlistitems
1584
1585 if not self.params.get('simulate') and self.params.get('allow_playlist_files', True):
1586 ie_copy = {
1587 'playlist': playlist,
1588 'playlist_id': ie_result.get('id'),
1589 'playlist_title': ie_result.get('title'),
1590 'playlist_uploader': ie_result.get('uploader'),
1591 'playlist_uploader_id': ie_result.get('uploader_id'),
1592 'playlist_index': 0,
1593 'n_entries': n_entries,
1594 }
1595 ie_copy.update(dict(ie_result))
1596
1597 if self._write_info_json('playlist', ie_result,
1598 self.prepare_filename(ie_copy, 'pl_infojson')) is None:
1599 return
1600 if self._write_description('playlist', ie_result,
1601 self.prepare_filename(ie_copy, 'pl_description')) is None:
1602 return
1603 # TODO: This should be passed to ThumbnailsConvertor if necessary
1604 self._write_thumbnails('playlist', ie_copy, self.prepare_filename(ie_copy, 'pl_thumbnail'))
1605
1606 if self.params.get('playlistreverse', False):
1607 entries = entries[::-1]
1608 if self.params.get('playlistrandom', False):
1609 random.shuffle(entries)
1610
1611 x_forwarded_for = ie_result.get('__x_forwarded_for_ip')
1612
1613 self.to_screen('[%s] playlist %s: %s' % (ie_result['extractor'], playlist, msg % n_entries))
1614 failures = 0
1615 max_failures = self.params.get('skip_playlist_after_errors') or float('inf')
1616 for i, entry_tuple in enumerate(entries, 1):
1617 playlist_index, entry = entry_tuple
1618 if 'playlist-index' in self.params.get('compat_opts', []):
1619 playlist_index = playlistitems[i - 1] if playlistitems else i + playliststart - 1
1620 self.to_screen('[download] Downloading video %s of %s' % (i, n_entries))
1621 # This __x_forwarded_for_ip thing is a bit ugly but requires
1622 # minimal changes
1623 if x_forwarded_for:
1624 entry['__x_forwarded_for_ip'] = x_forwarded_for
1625 extra = {
1626 'n_entries': n_entries,
1627 '_last_playlist_index': max(playlistitems) if playlistitems else (playlistend or n_entries),
1628 'playlist_index': playlist_index,
1629 'playlist_autonumber': i,
1630 'playlist': playlist,
1631 'playlist_id': ie_result.get('id'),
1632 'playlist_title': ie_result.get('title'),
1633 'playlist_uploader': ie_result.get('uploader'),
1634 'playlist_uploader_id': ie_result.get('uploader_id'),
1635 'extractor': ie_result['extractor'],
1636 'webpage_url': ie_result['webpage_url'],
1637 'webpage_url_basename': url_basename(ie_result['webpage_url']),
1638 'extractor_key': ie_result['extractor_key'],
1639 }
1640
1641 if self._match_entry(entry, incomplete=True) is not None:
1642 continue
1643
1644 entry_result = self.__process_iterable_entry(entry, download, extra)
1645 if not entry_result:
1646 failures += 1
1647 if failures >= max_failures:
1648 self.report_error(
1649 'Skipping the remaining entries in playlist "%s" since %d items failed extraction' % (playlist, failures))
1650 break
1651 # TODO: skip failed (empty) entries?
1652 playlist_results.append(entry_result)
1653 ie_result['entries'] = playlist_results
1654 self.to_screen('[download] Finished downloading playlist: %s' % playlist)
1655 return ie_result
1656
1657 @__handle_extraction_exceptions
1658 def __process_iterable_entry(self, entry, download, extra_info):
1659 return self.process_ie_result(
1660 entry, download=download, extra_info=extra_info)
1661
1662 def _build_format_filter(self, filter_spec):
1663 " Returns a function to filter the formats according to the filter_spec "
1664
1665 OPERATORS = {
1666 '<': operator.lt,
1667 '<=': operator.le,
1668 '>': operator.gt,
1669 '>=': operator.ge,
1670 '=': operator.eq,
1671 '!=': operator.ne,
1672 }
1673 operator_rex = re.compile(r'''(?x)\s*
1674 (?P<key>width|height|tbr|abr|vbr|asr|filesize|filesize_approx|fps)\s*
1675 (?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
1676 (?P<value>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)\s*
1677 ''' % '|'.join(map(re.escape, OPERATORS.keys())))
1678 m = operator_rex.fullmatch(filter_spec)
1679 if m:
1680 try:
1681 comparison_value = int(m.group('value'))
1682 except ValueError:
1683 comparison_value = parse_filesize(m.group('value'))
1684 if comparison_value is None:
1685 comparison_value = parse_filesize(m.group('value') + 'B')
1686 if comparison_value is None:
1687 raise ValueError(
1688 'Invalid value %r in format specification %r' % (
1689 m.group('value'), filter_spec))
1690 op = OPERATORS[m.group('op')]
1691
1692 if not m:
1693 STR_OPERATORS = {
1694 '=': operator.eq,
1695 '^=': lambda attr, value: attr.startswith(value),
1696 '$=': lambda attr, value: attr.endswith(value),
1697 '*=': lambda attr, value: value in attr,
1698 }
1699 str_operator_rex = re.compile(r'''(?x)\s*
1700 (?P<key>[a-zA-Z0-9._-]+)\s*
1701 (?P<negation>!\s*)?(?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
1702 (?P<value>[a-zA-Z0-9._-]+)\s*
1703 ''' % '|'.join(map(re.escape, STR_OPERATORS.keys())))
1704 m = str_operator_rex.fullmatch(filter_spec)
1705 if m:
1706 comparison_value = m.group('value')
1707 str_op = STR_OPERATORS[m.group('op')]
1708 if m.group('negation'):
1709 op = lambda attr, value: not str_op(attr, value)
1710 else:
1711 op = str_op
1712
1713 if not m:
1714 raise SyntaxError('Invalid filter specification %r' % filter_spec)
1715
1716 def _filter(f):
1717 actual_value = f.get(m.group('key'))
1718 if actual_value is None:
1719 return m.group('none_inclusive')
1720 return op(actual_value, comparison_value)
1721 return _filter
1722
1723 def _default_format_spec(self, info_dict, download=True):
1724
1725 def can_merge():
1726 merger = FFmpegMergerPP(self)
1727 return merger.available and merger.can_merge()
1728
1729 prefer_best = (
1730 not self.params.get('simulate')
1731 and download
1732 and (
1733 not can_merge()
1734 or info_dict.get('is_live', False)
1735 or self.outtmpl_dict['default'] == '-'))
1736 compat = (
1737 prefer_best
1738 or self.params.get('allow_multiple_audio_streams', False)
1739 or 'format-spec' in self.params.get('compat_opts', []))
1740
1741 return (
1742 'best/bestvideo+bestaudio' if prefer_best
1743 else 'bestvideo*+bestaudio/best' if not compat
1744 else 'bestvideo+bestaudio/best')
1745
1746 def build_format_selector(self, format_spec):
1747 def syntax_error(note, start):
1748 message = (
1749 'Invalid format specification: '
1750 '{0}\n\t{1}\n\t{2}^'.format(note, format_spec, ' ' * start[1]))
1751 return SyntaxError(message)
1752
1753 PICKFIRST = 'PICKFIRST'
1754 MERGE = 'MERGE'
1755 SINGLE = 'SINGLE'
1756 GROUP = 'GROUP'
1757 FormatSelector = collections.namedtuple('FormatSelector', ['type', 'selector', 'filters'])
1758
1759 allow_multiple_streams = {'audio': self.params.get('allow_multiple_audio_streams', False),
1760 'video': self.params.get('allow_multiple_video_streams', False)}
1761
1762 check_formats = self.params.get('check_formats')
1763
1764 def _parse_filter(tokens):
1765 filter_parts = []
1766 for type, string, start, _, _ in tokens:
1767 if type == tokenize.OP and string == ']':
1768 return ''.join(filter_parts)
1769 else:
1770 filter_parts.append(string)
1771
1772 def _remove_unused_ops(tokens):
1773 # Remove operators that we don't use and join them with the surrounding strings
1774 # for example: 'mp4' '-' 'baseline' '-' '16x9' is converted to 'mp4-baseline-16x9'
1775 ALLOWED_OPS = ('/', '+', ',', '(', ')')
1776 last_string, last_start, last_end, last_line = None, None, None, None
1777 for type, string, start, end, line in tokens:
1778 if type == tokenize.OP and string == '[':
1779 if last_string:
1780 yield tokenize.NAME, last_string, last_start, last_end, last_line
1781 last_string = None
1782 yield type, string, start, end, line
1783 # everything inside brackets will be handled by _parse_filter
1784 for type, string, start, end, line in tokens:
1785 yield type, string, start, end, line
1786 if type == tokenize.OP and string == ']':
1787 break
1788 elif type == tokenize.OP and string in ALLOWED_OPS:
1789 if last_string:
1790 yield tokenize.NAME, last_string, last_start, last_end, last_line
1791 last_string = None
1792 yield type, string, start, end, line
1793 elif type in [tokenize.NAME, tokenize.NUMBER, tokenize.OP]:
1794 if not last_string:
1795 last_string = string
1796 last_start = start
1797 last_end = end
1798 else:
1799 last_string += string
1800 if last_string:
1801 yield tokenize.NAME, last_string, last_start, last_end, last_line
1802
1803 def _parse_format_selection(tokens, inside_merge=False, inside_choice=False, inside_group=False):
1804 selectors = []
1805 current_selector = None
1806 for type, string, start, _, _ in tokens:
1807 # ENCODING is only defined in python 3.x
1808 if type == getattr(tokenize, 'ENCODING', None):
1809 continue
1810 elif type in [tokenize.NAME, tokenize.NUMBER]:
1811 current_selector = FormatSelector(SINGLE, string, [])
1812 elif type == tokenize.OP:
1813 if string == ')':
1814 if not inside_group:
1815 # ')' will be handled by the parentheses group
1816 tokens.restore_last_token()
1817 break
1818 elif inside_merge and string in ['/', ',']:
1819 tokens.restore_last_token()
1820 break
1821 elif inside_choice and string == ',':
1822 tokens.restore_last_token()
1823 break
1824 elif string == ',':
1825 if not current_selector:
1826 raise syntax_error('"," must follow a format selector', start)
1827 selectors.append(current_selector)
1828 current_selector = None
1829 elif string == '/':
1830 if not current_selector:
1831 raise syntax_error('"/" must follow a format selector', start)
1832 first_choice = current_selector
1833 second_choice = _parse_format_selection(tokens, inside_choice=True)
1834 current_selector = FormatSelector(PICKFIRST, (first_choice, second_choice), [])
1835 elif string == '[':
1836 if not current_selector:
1837 current_selector = FormatSelector(SINGLE, 'best', [])
1838 format_filter = _parse_filter(tokens)
1839 current_selector.filters.append(format_filter)
1840 elif string == '(':
1841 if current_selector:
1842 raise syntax_error('Unexpected "("', start)
1843 group = _parse_format_selection(tokens, inside_group=True)
1844 current_selector = FormatSelector(GROUP, group, [])
1845 elif string == '+':
1846 if not current_selector:
1847 raise syntax_error('Unexpected "+"', start)
1848 selector_1 = current_selector
1849 selector_2 = _parse_format_selection(tokens, inside_merge=True)
1850 if not selector_2:
1851 raise syntax_error('Expected a selector', start)
1852 current_selector = FormatSelector(MERGE, (selector_1, selector_2), [])
1853 else:
1854 raise syntax_error('Operator not recognized: "{0}"'.format(string), start)
1855 elif type == tokenize.ENDMARKER:
1856 break
1857 if current_selector:
1858 selectors.append(current_selector)
1859 return selectors
1860
1861 def _merge(formats_pair):
1862 format_1, format_2 = formats_pair
1863
1864 formats_info = []
1865 formats_info.extend(format_1.get('requested_formats', (format_1,)))
1866 formats_info.extend(format_2.get('requested_formats', (format_2,)))
1867
1868 if not allow_multiple_streams['video'] or not allow_multiple_streams['audio']:
1869 get_no_more = {'video': False, 'audio': False}
1870 for (i, fmt_info) in enumerate(formats_info):
1871 if fmt_info.get('acodec') == fmt_info.get('vcodec') == 'none':
1872 formats_info.pop(i)
1873 continue
1874 for aud_vid in ['audio', 'video']:
1875 if not allow_multiple_streams[aud_vid] and fmt_info.get(aud_vid[0] + 'codec') != 'none':
1876 if get_no_more[aud_vid]:
1877 formats_info.pop(i)
1878 break
1879 get_no_more[aud_vid] = True
1880
1881 if len(formats_info) == 1:
1882 return formats_info[0]
1883
1884 video_fmts = [fmt_info for fmt_info in formats_info if fmt_info.get('vcodec') != 'none']
1885 audio_fmts = [fmt_info for fmt_info in formats_info if fmt_info.get('acodec') != 'none']
1886
1887 the_only_video = video_fmts[0] if len(video_fmts) == 1 else None
1888 the_only_audio = audio_fmts[0] if len(audio_fmts) == 1 else None
1889
1890 output_ext = self.params.get('merge_output_format')
1891 if not output_ext:
1892 if the_only_video:
1893 output_ext = the_only_video['ext']
1894 elif the_only_audio and not video_fmts:
1895 output_ext = the_only_audio['ext']
1896 else:
1897 output_ext = 'mkv'
1898
1899 filtered = lambda *keys: filter(None, (traverse_obj(fmt, *keys) for fmt in formats_info))
1900
1901 new_dict = {
1902 'requested_formats': formats_info,
1903 'format': '+'.join(filtered('format')),
1904 'format_id': '+'.join(filtered('format_id')),
1905 'ext': output_ext,
1906 'protocol': '+'.join(map(determine_protocol, formats_info)),
1907 'language': '+'.join(orderedSet(filtered('language'))),
1908 'format_note': '+'.join(orderedSet(filtered('format_note'))),
1909 'filesize_approx': sum(filtered('filesize', 'filesize_approx')),
1910 'tbr': sum(filtered('tbr', 'vbr', 'abr')),
1911 }
1912
1913 if the_only_video:
1914 new_dict.update({
1915 'width': the_only_video.get('width'),
1916 'height': the_only_video.get('height'),
1917 'resolution': the_only_video.get('resolution') or self.format_resolution(the_only_video),
1918 'fps': the_only_video.get('fps'),
1919 'dynamic_range': the_only_video.get('dynamic_range'),
1920 'vcodec': the_only_video.get('vcodec'),
1921 'vbr': the_only_video.get('vbr'),
1922 'stretched_ratio': the_only_video.get('stretched_ratio'),
1923 })
1924
1925 if the_only_audio:
1926 new_dict.update({
1927 'acodec': the_only_audio.get('acodec'),
1928 'abr': the_only_audio.get('abr'),
1929 'asr': the_only_audio.get('asr'),
1930 })
1931
1932 return new_dict
1933
1934 def _check_formats(formats):
1935 if not check_formats:
1936 yield from formats
1937 return
1938 for f in formats:
1939 self.to_screen('[info] Testing format %s' % f['format_id'])
1940 temp_file = tempfile.NamedTemporaryFile(
1941 suffix='.tmp', delete=False,
1942 dir=self.get_output_path('temp') or None)
1943 temp_file.close()
1944 try:
1945 success, _ = self.dl(temp_file.name, f, test=True)
1946 except (DownloadError, IOError, OSError, ValueError) + network_exceptions:
1947 success = False
1948 finally:
1949 if os.path.exists(temp_file.name):
1950 try:
1951 os.remove(temp_file.name)
1952 except OSError:
1953 self.report_warning('Unable to delete temporary file "%s"' % temp_file.name)
1954 if success:
1955 yield f
1956 else:
1957 self.to_screen('[info] Unable to download format %s. Skipping...' % f['format_id'])
1958
1959 def _build_selector_function(selector):
1960 if isinstance(selector, list): # ,
1961 fs = [_build_selector_function(s) for s in selector]
1962
1963 def selector_function(ctx):
1964 for f in fs:
1965 yield from f(ctx)
1966 return selector_function
1967
1968 elif selector.type == GROUP: # ()
1969 selector_function = _build_selector_function(selector.selector)
1970
1971 elif selector.type == PICKFIRST: # /
1972 fs = [_build_selector_function(s) for s in selector.selector]
1973
1974 def selector_function(ctx):
1975 for f in fs:
1976 picked_formats = list(f(ctx))
1977 if picked_formats:
1978 return picked_formats
1979 return []
1980
1981 elif selector.type == MERGE: # +
1982 selector_1, selector_2 = map(_build_selector_function, selector.selector)
1983
1984 def selector_function(ctx):
1985 for pair in itertools.product(
1986 selector_1(copy.deepcopy(ctx)), selector_2(copy.deepcopy(ctx))):
1987 yield _merge(pair)
1988
1989 elif selector.type == SINGLE: # atom
1990 format_spec = selector.selector or 'best'
1991
1992 # TODO: Add allvideo, allaudio etc by generalizing the code with best/worst selector
1993 if format_spec == 'all':
1994 def selector_function(ctx):
1995 yield from _check_formats(ctx['formats'])
1996 elif format_spec == 'mergeall':
1997 def selector_function(ctx):
1998 formats = list(_check_formats(ctx['formats']))
1999 if not formats:
2000 return
2001 merged_format = formats[-1]
2002 for f in formats[-2::-1]:
2003 merged_format = _merge((merged_format, f))
2004 yield merged_format
2005
2006 else:
2007 format_fallback, format_reverse, format_idx = False, True, 1
2008 mobj = re.match(
2009 r'(?P<bw>best|worst|b|w)(?P<type>video|audio|v|a)?(?P<mod>\*)?(?:\.(?P<n>[1-9]\d*))?$',
2010 format_spec)
2011 if mobj is not None:
2012 format_idx = int_or_none(mobj.group('n'), default=1)
2013 format_reverse = mobj.group('bw')[0] == 'b'
2014 format_type = (mobj.group('type') or [None])[0]
2015 not_format_type = {'v': 'a', 'a': 'v'}.get(format_type)
2016 format_modified = mobj.group('mod') is not None
2017
2018 format_fallback = not format_type and not format_modified # for b, w
2019 _filter_f = (
2020 (lambda f: f.get('%scodec' % format_type) != 'none')
2021 if format_type and format_modified # bv*, ba*, wv*, wa*
2022 else (lambda f: f.get('%scodec' % not_format_type) == 'none')
2023 if format_type # bv, ba, wv, wa
2024 else (lambda f: f.get('vcodec') != 'none' and f.get('acodec') != 'none')
2025 if not format_modified # b, w
2026 else lambda f: True) # b*, w*
2027 filter_f = lambda f: _filter_f(f) and (
2028 f.get('vcodec') != 'none' or f.get('acodec') != 'none')
2029 else:
2030 if format_spec in self._format_selection_exts['audio']:
2031 filter_f = lambda f: f.get('ext') == format_spec and f.get('acodec') != 'none'
2032 elif format_spec in self._format_selection_exts['video']:
2033 filter_f = lambda f: f.get('ext') == format_spec and f.get('acodec') != 'none' and f.get('vcodec') != 'none'
2034 elif format_spec in self._format_selection_exts['storyboards']:
2035 filter_f = lambda f: f.get('ext') == format_spec and f.get('acodec') == 'none' and f.get('vcodec') == 'none'
2036 else:
2037 filter_f = lambda f: f.get('format_id') == format_spec # id
2038
2039 def selector_function(ctx):
2040 formats = list(ctx['formats'])
2041 matches = list(filter(filter_f, formats)) if filter_f is not None else formats
2042 if format_fallback and ctx['incomplete_formats'] and not matches:
2043 # for extractors with incomplete formats (audio only (soundcloud)
2044 # or video only (imgur)) best/worst will fallback to
2045 # best/worst {video,audio}-only format
2046 matches = formats
2047 matches = LazyList(_check_formats(matches[::-1 if format_reverse else 1]))
2048 try:
2049 yield matches[format_idx - 1]
2050 except IndexError:
2051 return
2052
2053 filters = [self._build_format_filter(f) for f in selector.filters]
2054
2055 def final_selector(ctx):
2056 ctx_copy = copy.deepcopy(ctx)
2057 for _filter in filters:
2058 ctx_copy['formats'] = list(filter(_filter, ctx_copy['formats']))
2059 return selector_function(ctx_copy)
2060 return final_selector
2061
2062 stream = io.BytesIO(format_spec.encode('utf-8'))
2063 try:
2064 tokens = list(_remove_unused_ops(compat_tokenize_tokenize(stream.readline)))
2065 except tokenize.TokenError:
2066 raise syntax_error('Missing closing/opening brackets or parenthesis', (0, len(format_spec)))
2067
2068 class TokenIterator(object):
2069 def __init__(self, tokens):
2070 self.tokens = tokens
2071 self.counter = 0
2072
2073 def __iter__(self):
2074 return self
2075
2076 def __next__(self):
2077 if self.counter >= len(self.tokens):
2078 raise StopIteration()
2079 value = self.tokens[self.counter]
2080 self.counter += 1
2081 return value
2082
2083 next = __next__
2084
2085 def restore_last_token(self):
2086 self.counter -= 1
2087
2088 parsed_selector = _parse_format_selection(iter(TokenIterator(tokens)))
2089 return _build_selector_function(parsed_selector)
2090
2091 def _calc_headers(self, info_dict):
2092 res = std_headers.copy()
2093
2094 add_headers = info_dict.get('http_headers')
2095 if add_headers:
2096 res.update(add_headers)
2097
2098 cookies = self._calc_cookies(info_dict)
2099 if cookies:
2100 res['Cookie'] = cookies
2101
2102 if 'X-Forwarded-For' not in res:
2103 x_forwarded_for_ip = info_dict.get('__x_forwarded_for_ip')
2104 if x_forwarded_for_ip:
2105 res['X-Forwarded-For'] = x_forwarded_for_ip
2106
2107 return res
2108
2109 def _calc_cookies(self, info_dict):
2110 pr = sanitized_Request(info_dict['url'])
2111 self.cookiejar.add_cookie_header(pr)
2112 return pr.get_header('Cookie')
2113
2114 def _sanitize_thumbnails(self, info_dict):
2115 thumbnails = info_dict.get('thumbnails')
2116 if thumbnails is None:
2117 thumbnail = info_dict.get('thumbnail')
2118 if thumbnail:
2119 info_dict['thumbnails'] = thumbnails = [{'url': thumbnail}]
2120 if thumbnails:
2121 thumbnails.sort(key=lambda t: (
2122 t.get('preference') if t.get('preference') is not None else -1,
2123 t.get('width') if t.get('width') is not None else -1,
2124 t.get('height') if t.get('height') is not None else -1,
2125 t.get('id') if t.get('id') is not None else '',
2126 t.get('url')))
2127
2128 def thumbnail_tester():
2129 def test_thumbnail(t):
2130 self.to_screen(f'[info] Testing thumbnail {t["id"]}')
2131 try:
2132 self.urlopen(HEADRequest(t['url']))
2133 except network_exceptions as err:
2134 self.to_screen(f'[info] Unable to connect to thumbnail {t["id"]} URL {t["url"]!r} - {err}. Skipping...')
2135 return False
2136 return True
2137 return test_thumbnail
2138
2139 for i, t in enumerate(thumbnails):
2140 if t.get('id') is None:
2141 t['id'] = '%d' % i
2142 if t.get('width') and t.get('height'):
2143 t['resolution'] = '%dx%d' % (t['width'], t['height'])
2144 t['url'] = sanitize_url(t['url'])
2145
2146 if self.params.get('check_formats'):
2147 info_dict['thumbnails'] = LazyList(filter(thumbnail_tester(), thumbnails[::-1])).reverse()
2148 else:
2149 info_dict['thumbnails'] = thumbnails
2150
2151 def process_video_result(self, info_dict, download=True):
2152 assert info_dict.get('_type', 'video') == 'video'
2153
2154 if 'id' not in info_dict:
2155 raise ExtractorError('Missing "id" field in extractor result')
2156 if 'title' not in info_dict:
2157 raise ExtractorError('Missing "title" field in extractor result',
2158 video_id=info_dict['id'], ie=info_dict['extractor'])
2159
2160 def report_force_conversion(field, field_not, conversion):
2161 self.report_warning(
2162 '"%s" field is not %s - forcing %s conversion, there is an error in extractor'
2163 % (field, field_not, conversion))
2164
2165 def sanitize_string_field(info, string_field):
2166 field = info.get(string_field)
2167 if field is None or isinstance(field, compat_str):
2168 return
2169 report_force_conversion(string_field, 'a string', 'string')
2170 info[string_field] = compat_str(field)
2171
2172 def sanitize_numeric_fields(info):
2173 for numeric_field in self._NUMERIC_FIELDS:
2174 field = info.get(numeric_field)
2175 if field is None or isinstance(field, compat_numeric_types):
2176 continue
2177 report_force_conversion(numeric_field, 'numeric', 'int')
2178 info[numeric_field] = int_or_none(field)
2179
2180 sanitize_string_field(info_dict, 'id')
2181 sanitize_numeric_fields(info_dict)
2182
2183 if 'playlist' not in info_dict:
2184 # It isn't part of a playlist
2185 info_dict['playlist'] = None
2186 info_dict['playlist_index'] = None
2187
2188 self._sanitize_thumbnails(info_dict)
2189
2190 thumbnail = info_dict.get('thumbnail')
2191 thumbnails = info_dict.get('thumbnails')
2192 if thumbnail:
2193 info_dict['thumbnail'] = sanitize_url(thumbnail)
2194 elif thumbnails:
2195 info_dict['thumbnail'] = thumbnails[-1]['url']
2196
2197 if info_dict.get('display_id') is None and 'id' in info_dict:
2198 info_dict['display_id'] = info_dict['id']
2199
2200 if info_dict.get('duration') is not None:
2201 info_dict['duration_string'] = formatSeconds(info_dict['duration'])
2202
2203 for ts_key, date_key in (
2204 ('timestamp', 'upload_date'),
2205 ('release_timestamp', 'release_date'),
2206 ):
2207 if info_dict.get(date_key) is None and info_dict.get(ts_key) is not None:
2208 # Working around out-of-range timestamp values (e.g. negative ones on Windows,
2209 # see http://bugs.python.org/issue1646728)
2210 try:
2211 upload_date = datetime.datetime.utcfromtimestamp(info_dict[ts_key])
2212 info_dict[date_key] = upload_date.strftime('%Y%m%d')
2213 except (ValueError, OverflowError, OSError):
2214 pass
2215
2216 live_keys = ('is_live', 'was_live')
2217 live_status = info_dict.get('live_status')
2218 if live_status is None:
2219 for key in live_keys:
2220 if info_dict.get(key) is False:
2221 continue
2222 if info_dict.get(key):
2223 live_status = key
2224 break
2225 if all(info_dict.get(key) is False for key in live_keys):
2226 live_status = 'not_live'
2227 if live_status:
2228 info_dict['live_status'] = live_status
2229 for key in live_keys:
2230 if info_dict.get(key) is None:
2231 info_dict[key] = (live_status == key)
2232
2233 # Auto generate title fields corresponding to the *_number fields when missing
2234 # in order to always have clean titles. This is very common for TV series.
2235 for field in ('chapter', 'season', 'episode'):
2236 if info_dict.get('%s_number' % field) is not None and not info_dict.get(field):
2237 info_dict[field] = '%s %d' % (field.capitalize(), info_dict['%s_number' % field])
2238
2239 for cc_kind in ('subtitles', 'automatic_captions'):
2240 cc = info_dict.get(cc_kind)
2241 if cc:
2242 for _, subtitle in cc.items():
2243 for subtitle_format in subtitle:
2244 if subtitle_format.get('url'):
2245 subtitle_format['url'] = sanitize_url(subtitle_format['url'])
2246 if subtitle_format.get('ext') is None:
2247 subtitle_format['ext'] = determine_ext(subtitle_format['url']).lower()
2248
2249 automatic_captions = info_dict.get('automatic_captions')
2250 subtitles = info_dict.get('subtitles')
2251
2252 info_dict['requested_subtitles'] = self.process_subtitles(
2253 info_dict['id'], subtitles, automatic_captions)
2254
2255 # We now pick which formats have to be downloaded
2256 if info_dict.get('formats') is None:
2257 # There's only one format available
2258 formats = [info_dict]
2259 else:
2260 formats = info_dict['formats']
2261
2262 info_dict['__has_drm'] = any(f.get('has_drm') for f in formats)
2263 if not self.params.get('allow_unplayable_formats'):
2264 formats = [f for f in formats if not f.get('has_drm')]
2265
2266 if not formats:
2267 self.raise_no_formats(info_dict)
2268
2269 def is_wellformed(f):
2270 url = f.get('url')
2271 if not url:
2272 self.report_warning(
2273 '"url" field is missing or empty - skipping format, '
2274 'there is an error in extractor')
2275 return False
2276 if isinstance(url, bytes):
2277 sanitize_string_field(f, 'url')
2278 return True
2279
2280 # Filter out malformed formats for better extraction robustness
2281 formats = list(filter(is_wellformed, formats))
2282
2283 formats_dict = {}
2284
2285 # We check that all the formats have the format and format_id fields
2286 for i, format in enumerate(formats):
2287 sanitize_string_field(format, 'format_id')
2288 sanitize_numeric_fields(format)
2289 format['url'] = sanitize_url(format['url'])
2290 if not format.get('format_id'):
2291 format['format_id'] = compat_str(i)
2292 else:
2293 # Sanitize format_id from characters used in format selector expression
2294 format['format_id'] = re.sub(r'[\s,/+\[\]()]', '_', format['format_id'])
2295 format_id = format['format_id']
2296 if format_id not in formats_dict:
2297 formats_dict[format_id] = []
2298 formats_dict[format_id].append(format)
2299
2300 # Make sure all formats have unique format_id
2301 common_exts = set(itertools.chain(*self._format_selection_exts.values()))
2302 for format_id, ambiguous_formats in formats_dict.items():
2303 ambigious_id = len(ambiguous_formats) > 1
2304 for i, format in enumerate(ambiguous_formats):
2305 if ambigious_id:
2306 format['format_id'] = '%s-%d' % (format_id, i)
2307 if format.get('ext') is None:
2308 format['ext'] = determine_ext(format['url']).lower()
2309 # Ensure there is no conflict between id and ext in format selection
2310 # See https://github.com/yt-dlp/yt-dlp/issues/1282
2311 if format['format_id'] != format['ext'] and format['format_id'] in common_exts:
2312 format['format_id'] = 'f%s' % format['format_id']
2313
2314 for i, format in enumerate(formats):
2315 if format.get('format') is None:
2316 format['format'] = '{id} - {res}{note}'.format(
2317 id=format['format_id'],
2318 res=self.format_resolution(format),
2319 note=format_field(format, 'format_note', ' (%s)'),
2320 )
2321 if format.get('protocol') is None:
2322 format['protocol'] = determine_protocol(format)
2323 if format.get('resolution') is None:
2324 format['resolution'] = self.format_resolution(format, default=None)
2325 if format.get('dynamic_range') is None and format.get('vcodec') != 'none':
2326 format['dynamic_range'] = 'SDR'
2327 # Add HTTP headers, so that external programs can use them from the
2328 # json output
2329 full_format_info = info_dict.copy()
2330 full_format_info.update(format)
2331 format['http_headers'] = self._calc_headers(full_format_info)
2332 # Remove private housekeeping stuff
2333 if '__x_forwarded_for_ip' in info_dict:
2334 del info_dict['__x_forwarded_for_ip']
2335
2336 # TODO Central sorting goes here
2337
2338 if not formats or formats[0] is not info_dict:
2339 # only set the 'formats' fields if the original info_dict list them
2340 # otherwise we end up with a circular reference, the first (and unique)
2341 # element in the 'formats' field in info_dict is info_dict itself,
2342 # which can't be exported to json
2343 info_dict['formats'] = formats
2344
2345 info_dict, _ = self.pre_process(info_dict)
2346
2347 if self.params.get('list_thumbnails'):
2348 self.list_thumbnails(info_dict)
2349 if self.params.get('listformats'):
2350 if not info_dict.get('formats') and not info_dict.get('url'):
2351 self.to_screen('%s has no formats' % info_dict['id'])
2352 else:
2353 self.list_formats(info_dict)
2354 if self.params.get('listsubtitles'):
2355 if 'automatic_captions' in info_dict:
2356 self.list_subtitles(
2357 info_dict['id'], automatic_captions, 'automatic captions')
2358 self.list_subtitles(info_dict['id'], subtitles, 'subtitles')
2359 list_only = self.params.get('simulate') is None and (
2360 self.params.get('list_thumbnails') or self.params.get('listformats') or self.params.get('listsubtitles'))
2361 if list_only:
2362 # Without this printing, -F --print-json will not work
2363 self.__forced_printings(info_dict, self.prepare_filename(info_dict), incomplete=True)
2364 return
2365
2366 format_selector = self.format_selector
2367 if format_selector is None:
2368 req_format = self._default_format_spec(info_dict, download=download)
2369 self.write_debug('Default format spec: %s' % req_format)
2370 format_selector = self.build_format_selector(req_format)
2371
2372 # While in format selection we may need to have an access to the original
2373 # format set in order to calculate some metrics or do some processing.
2374 # For now we need to be able to guess whether original formats provided
2375 # by extractor are incomplete or not (i.e. whether extractor provides only
2376 # video-only or audio-only formats) for proper formats selection for
2377 # extractors with such incomplete formats (see
2378 # https://github.com/ytdl-org/youtube-dl/pull/5556).
2379 # Since formats may be filtered during format selection and may not match
2380 # the original formats the results may be incorrect. Thus original formats
2381 # or pre-calculated metrics should be passed to format selection routines
2382 # as well.
2383 # We will pass a context object containing all necessary additional data
2384 # instead of just formats.
2385 # This fixes incorrect format selection issue (see
2386 # https://github.com/ytdl-org/youtube-dl/issues/10083).
2387 incomplete_formats = (
2388 # All formats are video-only or
2389 all(f.get('vcodec') != 'none' and f.get('acodec') == 'none' for f in formats)
2390 # all formats are audio-only
2391 or all(f.get('vcodec') == 'none' and f.get('acodec') != 'none' for f in formats))
2392
2393 ctx = {
2394 'formats': formats,
2395 'incomplete_formats': incomplete_formats,
2396 }
2397
2398 formats_to_download = list(format_selector(ctx))
2399 if not formats_to_download:
2400 if not self.params.get('ignore_no_formats_error'):
2401 raise ExtractorError('Requested format is not available', expected=True,
2402 video_id=info_dict['id'], ie=info_dict['extractor'])
2403 else:
2404 self.report_warning('Requested format is not available')
2405 # Process what we can, even without any available formats.
2406 self.process_info(dict(info_dict))
2407 elif download:
2408 self.to_screen(
2409 '[info] %s: Downloading %d format(s): %s' % (
2410 info_dict['id'], len(formats_to_download),
2411 ", ".join([f['format_id'] for f in formats_to_download])))
2412 for fmt in formats_to_download:
2413 new_info = dict(info_dict)
2414 # Save a reference to the original info_dict so that it can be modified in process_info if needed
2415 new_info['__original_infodict'] = info_dict
2416 new_info.update(fmt)
2417 self.process_info(new_info)
2418 # We update the info dict with the selected best quality format (backwards compatibility)
2419 if formats_to_download:
2420 info_dict.update(formats_to_download[-1])
2421 return info_dict
2422
2423 def process_subtitles(self, video_id, normal_subtitles, automatic_captions):
2424 """Select the requested subtitles and their format"""
2425 available_subs = {}
2426 if normal_subtitles and self.params.get('writesubtitles'):
2427 available_subs.update(normal_subtitles)
2428 if automatic_captions and self.params.get('writeautomaticsub'):
2429 for lang, cap_info in automatic_captions.items():
2430 if lang not in available_subs:
2431 available_subs[lang] = cap_info
2432
2433 if (not self.params.get('writesubtitles') and not
2434 self.params.get('writeautomaticsub') or not
2435 available_subs):
2436 return None
2437
2438 all_sub_langs = available_subs.keys()
2439 if self.params.get('allsubtitles', False):
2440 requested_langs = all_sub_langs
2441 elif self.params.get('subtitleslangs', False):
2442 # A list is used so that the order of languages will be the same as
2443 # given in subtitleslangs. See https://github.com/yt-dlp/yt-dlp/issues/1041
2444 requested_langs = []
2445 for lang_re in self.params.get('subtitleslangs'):
2446 if lang_re == 'all':
2447 requested_langs.extend(all_sub_langs)
2448 continue
2449 discard = lang_re[0] == '-'
2450 if discard:
2451 lang_re = lang_re[1:]
2452 current_langs = filter(re.compile(lang_re + '$').match, all_sub_langs)
2453 if discard:
2454 for lang in current_langs:
2455 while lang in requested_langs:
2456 requested_langs.remove(lang)
2457 else:
2458 requested_langs.extend(current_langs)
2459 requested_langs = orderedSet(requested_langs)
2460 elif 'en' in available_subs:
2461 requested_langs = ['en']
2462 else:
2463 requested_langs = [list(all_sub_langs)[0]]
2464 if requested_langs:
2465 self.write_debug('Downloading subtitles: %s' % ', '.join(requested_langs))
2466
2467 formats_query = self.params.get('subtitlesformat', 'best')
2468 formats_preference = formats_query.split('/') if formats_query else []
2469 subs = {}
2470 for lang in requested_langs:
2471 formats = available_subs.get(lang)
2472 if formats is None:
2473 self.report_warning('%s subtitles not available for %s' % (lang, video_id))
2474 continue
2475 for ext in formats_preference:
2476 if ext == 'best':
2477 f = formats[-1]
2478 break
2479 matches = list(filter(lambda f: f['ext'] == ext, formats))
2480 if matches:
2481 f = matches[-1]
2482 break
2483 else:
2484 f = formats[-1]
2485 self.report_warning(
2486 'No subtitle format found matching "%s" for language %s, '
2487 'using %s' % (formats_query, lang, f['ext']))
2488 subs[lang] = f
2489 return subs
2490
2491 def __forced_printings(self, info_dict, filename, incomplete):
2492 def print_mandatory(field, actual_field=None):
2493 if actual_field is None:
2494 actual_field = field
2495 if (self.params.get('force%s' % field, False)
2496 and (not incomplete or info_dict.get(actual_field) is not None)):
2497 self.to_stdout(info_dict[actual_field])
2498
2499 def print_optional(field):
2500 if (self.params.get('force%s' % field, False)
2501 and info_dict.get(field) is not None):
2502 self.to_stdout(info_dict[field])
2503
2504 info_dict = info_dict.copy()
2505 if filename is not None:
2506 info_dict['filename'] = filename
2507 if info_dict.get('requested_formats') is not None:
2508 # For RTMP URLs, also include the playpath
2509 info_dict['urls'] = '\n'.join(f['url'] + f.get('play_path', '') for f in info_dict['requested_formats'])
2510 elif 'url' in info_dict:
2511 info_dict['urls'] = info_dict['url'] + info_dict.get('play_path', '')
2512
2513 if self.params.get('forceprint') or self.params.get('forcejson'):
2514 self.post_extract(info_dict)
2515 for tmpl in self.params.get('forceprint', []):
2516 mobj = re.match(r'\w+(=?)$', tmpl)
2517 if mobj and mobj.group(1):
2518 tmpl = f'{tmpl[:-1]} = %({tmpl[:-1]})s'
2519 elif mobj:
2520 tmpl = '%({})s'.format(tmpl)
2521 self.to_stdout(self.evaluate_outtmpl(tmpl, info_dict))
2522
2523 print_mandatory('title')
2524 print_mandatory('id')
2525 print_mandatory('url', 'urls')
2526 print_optional('thumbnail')
2527 print_optional('description')
2528 print_optional('filename')
2529 if self.params.get('forceduration') and info_dict.get('duration') is not None:
2530 self.to_stdout(formatSeconds(info_dict['duration']))
2531 print_mandatory('format')
2532
2533 if self.params.get('forcejson'):
2534 self.to_stdout(json.dumps(self.sanitize_info(info_dict)))
2535
2536 def dl(self, name, info, subtitle=False, test=False):
2537 if not info.get('url'):
2538 self.raise_no_formats(info, True)
2539
2540 if test:
2541 verbose = self.params.get('verbose')
2542 params = {
2543 'test': True,
2544 'quiet': self.params.get('quiet') or not verbose,
2545 'verbose': verbose,
2546 'noprogress': not verbose,
2547 'nopart': True,
2548 'skip_unavailable_fragments': False,
2549 'keep_fragments': False,
2550 'overwrites': True,
2551 '_no_ytdl_file': True,
2552 }
2553 else:
2554 params = self.params
2555 fd = get_suitable_downloader(info, params, to_stdout=(name == '-'))(self, params)
2556 if not test:
2557 for ph in self._progress_hooks:
2558 fd.add_progress_hook(ph)
2559 urls = '", "'.join([f['url'] for f in info.get('requested_formats', [])] or [info['url']])
2560 self.write_debug('Invoking downloader on "%s"' % urls)
2561
2562 new_info = copy.deepcopy(self._copy_infodict(info))
2563 if new_info.get('http_headers') is None:
2564 new_info['http_headers'] = self._calc_headers(new_info)
2565 return fd.download(name, new_info, subtitle)
2566
2567 def process_info(self, info_dict):
2568 """Process a single resolved IE result."""
2569
2570 assert info_dict.get('_type', 'video') == 'video'
2571
2572 max_downloads = self.params.get('max_downloads')
2573 if max_downloads is not None:
2574 if self._num_downloads >= int(max_downloads):
2575 raise MaxDownloadsReached()
2576
2577 # TODO: backward compatibility, to be removed
2578 info_dict['fulltitle'] = info_dict['title']
2579
2580 if 'format' not in info_dict and 'ext' in info_dict:
2581 info_dict['format'] = info_dict['ext']
2582
2583 if self._match_entry(info_dict) is not None:
2584 return
2585
2586 self.post_extract(info_dict)
2587 self._num_downloads += 1
2588
2589 # info_dict['_filename'] needs to be set for backward compatibility
2590 info_dict['_filename'] = full_filename = self.prepare_filename(info_dict, warn=True)
2591 temp_filename = self.prepare_filename(info_dict, 'temp')
2592 files_to_move = {}
2593
2594 # Forced printings
2595 self.__forced_printings(info_dict, full_filename, incomplete=('format' not in info_dict))
2596
2597 if self.params.get('simulate'):
2598 if self.params.get('force_write_download_archive', False):
2599 self.record_download_archive(info_dict)
2600 # Do nothing else if in simulate mode
2601 return
2602
2603 if full_filename is None:
2604 return
2605 if not self._ensure_dir_exists(encodeFilename(full_filename)):
2606 return
2607 if not self._ensure_dir_exists(encodeFilename(temp_filename)):
2608 return
2609
2610 if self._write_description('video', info_dict,
2611 self.prepare_filename(info_dict, 'description')) is None:
2612 return
2613
2614 sub_files = self._write_subtitles(info_dict, temp_filename)
2615 if sub_files is None:
2616 return
2617 files_to_move.update(dict(sub_files))
2618
2619 thumb_files = self._write_thumbnails(
2620 'video', info_dict, temp_filename, self.prepare_filename(info_dict, 'thumbnail'))
2621 if thumb_files is None:
2622 return
2623 files_to_move.update(dict(thumb_files))
2624
2625 infofn = self.prepare_filename(info_dict, 'infojson')
2626 _infojson_written = self._write_info_json('video', info_dict, infofn)
2627 if _infojson_written:
2628 info_dict['__infojson_filename'] = infofn
2629 elif _infojson_written is None:
2630 return
2631
2632 # Note: Annotations are deprecated
2633 annofn = None
2634 if self.params.get('writeannotations', False):
2635 annofn = self.prepare_filename(info_dict, 'annotation')
2636 if annofn:
2637 if not self._ensure_dir_exists(encodeFilename(annofn)):
2638 return
2639 if not self.params.get('overwrites', True) and os.path.exists(encodeFilename(annofn)):
2640 self.to_screen('[info] Video annotations are already present')
2641 elif not info_dict.get('annotations'):
2642 self.report_warning('There are no annotations to write.')
2643 else:
2644 try:
2645 self.to_screen('[info] Writing video annotations to: ' + annofn)
2646 with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
2647 annofile.write(info_dict['annotations'])
2648 except (KeyError, TypeError):
2649 self.report_warning('There are no annotations to write.')
2650 except (OSError, IOError):
2651 self.report_error('Cannot write annotations file: ' + annofn)
2652 return
2653
2654 # Write internet shortcut files
2655 url_link = webloc_link = desktop_link = False
2656 if self.params.get('writelink', False):
2657 if sys.platform == "darwin": # macOS.
2658 webloc_link = True
2659 elif sys.platform.startswith("linux"):
2660 desktop_link = True
2661 else: # if sys.platform in ['win32', 'cygwin']:
2662 url_link = True
2663 if self.params.get('writeurllink', False):
2664 url_link = True
2665 if self.params.get('writewebloclink', False):
2666 webloc_link = True
2667 if self.params.get('writedesktoplink', False):
2668 desktop_link = True
2669
2670 if url_link or webloc_link or desktop_link:
2671 if 'webpage_url' not in info_dict:
2672 self.report_error('Cannot write internet shortcut file because the "webpage_url" field is missing in the media information')
2673 return
2674 ascii_url = iri_to_uri(info_dict['webpage_url'])
2675
2676 def _write_link_file(extension, template, newline, embed_filename):
2677 linkfn = replace_extension(full_filename, extension, info_dict.get('ext'))
2678 if self.params.get('overwrites', True) and os.path.exists(encodeFilename(linkfn)):
2679 self.to_screen('[info] Internet shortcut is already present')
2680 else:
2681 try:
2682 self.to_screen('[info] Writing internet shortcut to: ' + linkfn)
2683 with io.open(encodeFilename(to_high_limit_path(linkfn)), 'w', encoding='utf-8', newline=newline) as linkfile:
2684 template_vars = {'url': ascii_url}
2685 if embed_filename:
2686 template_vars['filename'] = linkfn[:-(len(extension) + 1)]
2687 linkfile.write(template % template_vars)
2688 except (OSError, IOError):
2689 self.report_error('Cannot write internet shortcut ' + linkfn)
2690 return False
2691 return True
2692
2693 if url_link:
2694 if not _write_link_file('url', DOT_URL_LINK_TEMPLATE, '\r\n', embed_filename=False):
2695 return
2696 if webloc_link:
2697 if not _write_link_file('webloc', DOT_WEBLOC_LINK_TEMPLATE, '\n', embed_filename=False):
2698 return
2699 if desktop_link:
2700 if not _write_link_file('desktop', DOT_DESKTOP_LINK_TEMPLATE, '\n', embed_filename=True):
2701 return
2702
2703 try:
2704 info_dict, files_to_move = self.pre_process(info_dict, 'before_dl', files_to_move)
2705 except PostProcessingError as err:
2706 self.report_error('Preprocessing: %s' % str(err))
2707 return
2708
2709 must_record_download_archive = False
2710 if self.params.get('skip_download', False):
2711 info_dict['filepath'] = temp_filename
2712 info_dict['__finaldir'] = os.path.dirname(os.path.abspath(encodeFilename(full_filename)))
2713 info_dict['__files_to_move'] = files_to_move
2714 info_dict = self.run_pp(MoveFilesAfterDownloadPP(self, False), info_dict)
2715 else:
2716 # Download
2717 info_dict.setdefault('__postprocessors', [])
2718 try:
2719
2720 def existing_file(*filepaths):
2721 ext = info_dict.get('ext')
2722 final_ext = self.params.get('final_ext', ext)
2723 existing_files = []
2724 for file in orderedSet(filepaths):
2725 if final_ext != ext:
2726 converted = replace_extension(file, final_ext, ext)
2727 if os.path.exists(encodeFilename(converted)):
2728 existing_files.append(converted)
2729 if os.path.exists(encodeFilename(file)):
2730 existing_files.append(file)
2731
2732 if not existing_files or self.params.get('overwrites', False):
2733 for file in orderedSet(existing_files):
2734 self.report_file_delete(file)
2735 os.remove(encodeFilename(file))
2736 return None
2737
2738 info_dict['ext'] = os.path.splitext(existing_files[0])[1][1:]
2739 return existing_files[0]
2740
2741 success = True
2742 if info_dict.get('requested_formats') is not None:
2743
2744 def compatible_formats(formats):
2745 # TODO: some formats actually allow this (mkv, webm, ogg, mp4), but not all of them.
2746 video_formats = [format for format in formats if format.get('vcodec') != 'none']
2747 audio_formats = [format for format in formats if format.get('acodec') != 'none']
2748 if len(video_formats) > 2 or len(audio_formats) > 2:
2749 return False
2750
2751 # Check extension
2752 exts = set(format.get('ext') for format in formats)
2753 COMPATIBLE_EXTS = (
2754 set(('mp3', 'mp4', 'm4a', 'm4p', 'm4b', 'm4r', 'm4v', 'ismv', 'isma')),
2755 set(('webm',)),
2756 )
2757 for ext_sets in COMPATIBLE_EXTS:
2758 if ext_sets.issuperset(exts):
2759 return True
2760 # TODO: Check acodec/vcodec
2761 return False
2762
2763 requested_formats = info_dict['requested_formats']
2764 old_ext = info_dict['ext']
2765 if self.params.get('merge_output_format') is None:
2766 if not compatible_formats(requested_formats):
2767 info_dict['ext'] = 'mkv'
2768 self.report_warning(
2769 'Requested formats are incompatible for merge and will be merged into mkv')
2770 if (info_dict['ext'] == 'webm'
2771 and info_dict.get('thumbnails')
2772 # check with type instead of pp_key, __name__, or isinstance
2773 # since we dont want any custom PPs to trigger this
2774 and any(type(pp) == EmbedThumbnailPP for pp in self._pps['post_process'])):
2775 info_dict['ext'] = 'mkv'
2776 self.report_warning(
2777 'webm doesn\'t support embedding a thumbnail, mkv will be used')
2778 new_ext = info_dict['ext']
2779
2780 def correct_ext(filename, ext=new_ext):
2781 if filename == '-':
2782 return filename
2783 filename_real_ext = os.path.splitext(filename)[1][1:]
2784 filename_wo_ext = (
2785 os.path.splitext(filename)[0]
2786 if filename_real_ext in (old_ext, new_ext)
2787 else filename)
2788 return '%s.%s' % (filename_wo_ext, ext)
2789
2790 # Ensure filename always has a correct extension for successful merge
2791 full_filename = correct_ext(full_filename)
2792 temp_filename = correct_ext(temp_filename)
2793 dl_filename = existing_file(full_filename, temp_filename)
2794 info_dict['__real_download'] = False
2795
2796 if dl_filename is not None:
2797 self.report_file_already_downloaded(dl_filename)
2798 elif get_suitable_downloader(info_dict, self.params, to_stdout=temp_filename == '-'):
2799 info_dict['url'] = '\n'.join(f['url'] for f in requested_formats)
2800 success, real_download = self.dl(temp_filename, info_dict)
2801 info_dict['__real_download'] = real_download
2802 else:
2803 downloaded = []
2804 merger = FFmpegMergerPP(self)
2805 if self.params.get('allow_unplayable_formats'):
2806 self.report_warning(
2807 'You have requested merging of multiple formats '
2808 'while also allowing unplayable formats to be downloaded. '
2809 'The formats won\'t be merged to prevent data corruption.')
2810 elif not merger.available:
2811 self.report_warning(
2812 'You have requested merging of multiple formats but ffmpeg is not installed. '
2813 'The formats won\'t be merged.')
2814
2815 if temp_filename == '-':
2816 reason = ('using a downloader other than ffmpeg' if FFmpegFD.can_merge_formats(info_dict)
2817 else 'but the formats are incompatible for simultaneous download' if merger.available
2818 else 'but ffmpeg is not installed')
2819 self.report_warning(
2820 f'You have requested downloading multiple formats to stdout {reason}. '
2821 'The formats will be streamed one after the other')
2822 fname = temp_filename
2823 for f in requested_formats:
2824 new_info = dict(info_dict)
2825 del new_info['requested_formats']
2826 new_info.update(f)
2827 if temp_filename != '-':
2828 fname = prepend_extension(
2829 correct_ext(temp_filename, new_info['ext']),
2830 'f%s' % f['format_id'], new_info['ext'])
2831 if not self._ensure_dir_exists(fname):
2832 return
2833 f['filepath'] = fname
2834 downloaded.append(fname)
2835 partial_success, real_download = self.dl(fname, new_info)
2836 info_dict['__real_download'] = info_dict['__real_download'] or real_download
2837 success = success and partial_success
2838 if merger.available and not self.params.get('allow_unplayable_formats'):
2839 info_dict['__postprocessors'].append(merger)
2840 info_dict['__files_to_merge'] = downloaded
2841 # Even if there were no downloads, it is being merged only now
2842 info_dict['__real_download'] = True
2843 else:
2844 for file in downloaded:
2845 files_to_move[file] = None
2846 else:
2847 # Just a single file
2848 dl_filename = existing_file(full_filename, temp_filename)
2849 if dl_filename is None or dl_filename == temp_filename:
2850 # dl_filename == temp_filename could mean that the file was partially downloaded with --no-part.
2851 # So we should try to resume the download
2852 success, real_download = self.dl(temp_filename, info_dict)
2853 info_dict['__real_download'] = real_download
2854 else:
2855 self.report_file_already_downloaded(dl_filename)
2856
2857 dl_filename = dl_filename or temp_filename
2858 info_dict['__finaldir'] = os.path.dirname(os.path.abspath(encodeFilename(full_filename)))
2859
2860 except network_exceptions as err:
2861 self.report_error('unable to download video data: %s' % error_to_compat_str(err))
2862 return
2863 except (OSError, IOError) as err:
2864 raise UnavailableVideoError(err)
2865 except (ContentTooShortError, ) as err:
2866 self.report_error('content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
2867 return
2868
2869 if success and full_filename != '-':
2870
2871 def fixup():
2872 do_fixup = True
2873 fixup_policy = self.params.get('fixup')
2874 vid = info_dict['id']
2875
2876 if fixup_policy in ('ignore', 'never'):
2877 return
2878 elif fixup_policy == 'warn':
2879 do_fixup = False
2880 elif fixup_policy != 'force':
2881 assert fixup_policy in ('detect_or_warn', None)
2882 if not info_dict.get('__real_download'):
2883 do_fixup = False
2884
2885 def ffmpeg_fixup(cndn, msg, cls):
2886 if not cndn:
2887 return
2888 if not do_fixup:
2889 self.report_warning(f'{vid}: {msg}')
2890 return
2891 pp = cls(self)
2892 if pp.available:
2893 info_dict['__postprocessors'].append(pp)
2894 else:
2895 self.report_warning(f'{vid}: {msg}. Install ffmpeg to fix this automatically')
2896
2897 stretched_ratio = info_dict.get('stretched_ratio')
2898 ffmpeg_fixup(
2899 stretched_ratio not in (1, None),
2900 f'Non-uniform pixel ratio {stretched_ratio}',
2901 FFmpegFixupStretchedPP)
2902
2903 ffmpeg_fixup(
2904 (info_dict.get('requested_formats') is None
2905 and info_dict.get('container') == 'm4a_dash'
2906 and info_dict.get('ext') == 'm4a'),
2907 'writing DASH m4a. Only some players support this container',
2908 FFmpegFixupM4aPP)
2909
2910 downloader = get_suitable_downloader(info_dict, self.params) if 'protocol' in info_dict else None
2911 downloader = downloader.__name__ if downloader else None
2912 ffmpeg_fixup(info_dict.get('requested_formats') is None and downloader == 'HlsFD',
2913 'malformed AAC bitstream detected', FFmpegFixupM3u8PP)
2914 ffmpeg_fixup(downloader == 'WebSocketFragmentFD', 'malformed timestamps detected', FFmpegFixupTimestampPP)
2915 ffmpeg_fixup(downloader == 'WebSocketFragmentFD', 'malformed duration detected', FFmpegFixupDurationPP)
2916
2917 fixup()
2918 try:
2919 info_dict = self.post_process(dl_filename, info_dict, files_to_move)
2920 except PostProcessingError as err:
2921 self.report_error('Postprocessing: %s' % str(err))
2922 return
2923 try:
2924 for ph in self._post_hooks:
2925 ph(info_dict['filepath'])
2926 except Exception as err:
2927 self.report_error('post hooks: %s' % str(err))
2928 return
2929 must_record_download_archive = True
2930
2931 if must_record_download_archive or self.params.get('force_write_download_archive', False):
2932 self.record_download_archive(info_dict)
2933 max_downloads = self.params.get('max_downloads')
2934 if max_downloads is not None and self._num_downloads >= int(max_downloads):
2935 raise MaxDownloadsReached()
2936
2937 def download(self, url_list):
2938 """Download a given list of URLs."""
2939 outtmpl = self.outtmpl_dict['default']
2940 if (len(url_list) > 1
2941 and outtmpl != '-'
2942 and '%' not in outtmpl
2943 and self.params.get('max_downloads') != 1):
2944 raise SameFileError(outtmpl)
2945
2946 for url in url_list:
2947 try:
2948 # It also downloads the videos
2949 res = self.extract_info(
2950 url, force_generic_extractor=self.params.get('force_generic_extractor', False))
2951 except UnavailableVideoError:
2952 self.report_error('unable to download video')
2953 except MaxDownloadsReached:
2954 self.to_screen('[info] Maximum number of downloads reached')
2955 raise
2956 except ExistingVideoReached:
2957 self.to_screen('[info] Encountered a video that is already in the archive, stopping due to --break-on-existing')
2958 raise
2959 except RejectedVideoReached:
2960 self.to_screen('[info] Encountered a video that did not match filter, stopping due to --break-on-reject')
2961 raise
2962 else:
2963 if self.params.get('dump_single_json', False):
2964 self.post_extract(res)
2965 self.to_stdout(json.dumps(self.sanitize_info(res)))
2966
2967 return self._download_retcode
2968
2969 def download_with_info_file(self, info_filename):
2970 with contextlib.closing(fileinput.FileInput(
2971 [info_filename], mode='r',
2972 openhook=fileinput.hook_encoded('utf-8'))) as f:
2973 # FileInput doesn't have a read method, we can't call json.load
2974 info = self.sanitize_info(json.loads('\n'.join(f)), self.params.get('clean_infojson', True))
2975 try:
2976 self.process_ie_result(info, download=True)
2977 except (DownloadError, EntryNotInPlaylist, ThrottledDownload):
2978 webpage_url = info.get('webpage_url')
2979 if webpage_url is not None:
2980 self.report_warning('The info failed to download, trying with "%s"' % webpage_url)
2981 return self.download([webpage_url])
2982 else:
2983 raise
2984 return self._download_retcode
2985
2986 @staticmethod
2987 def sanitize_info(info_dict, remove_private_keys=False):
2988 ''' Sanitize the infodict for converting to json '''
2989 if info_dict is None:
2990 return info_dict
2991 info_dict.setdefault('epoch', int(time.time()))
2992 remove_keys = {'__original_infodict'} # Always remove this since this may contain a copy of the entire dict
2993 keep_keys = ['_type'], # Always keep this to facilitate load-info-json
2994 if remove_private_keys:
2995 remove_keys |= {
2996 'requested_formats', 'requested_subtitles', 'requested_entries',
2997 'filepath', 'entries', 'original_url', 'playlist_autonumber',
2998 }
2999 empty_values = (None, {}, [], set(), tuple())
3000 reject = lambda k, v: k not in keep_keys and (
3001 k.startswith('_') or k in remove_keys or v in empty_values)
3002 else:
3003 reject = lambda k, v: k in remove_keys
3004 filter_fn = lambda obj: (
3005 list(map(filter_fn, obj)) if isinstance(obj, (LazyList, list, tuple, set))
3006 else obj if not isinstance(obj, dict)
3007 else dict((k, filter_fn(v)) for k, v in obj.items() if not reject(k, v)))
3008 return filter_fn(info_dict)
3009
3010 @staticmethod
3011 def filter_requested_info(info_dict, actually_filter=True):
3012 ''' Alias of sanitize_info for backward compatibility '''
3013 return YoutubeDL.sanitize_info(info_dict, actually_filter)
3014
3015 def run_pp(self, pp, infodict):
3016 files_to_delete = []
3017 if '__files_to_move' not in infodict:
3018 infodict['__files_to_move'] = {}
3019 try:
3020 files_to_delete, infodict = pp.run(infodict)
3021 except PostProcessingError as e:
3022 # Must be True and not 'only_download'
3023 if self.params.get('ignoreerrors') is True:
3024 self.report_error(e)
3025 return infodict
3026 raise
3027
3028 if not files_to_delete:
3029 return infodict
3030 if self.params.get('keepvideo', False):
3031 for f in files_to_delete:
3032 infodict['__files_to_move'].setdefault(f, '')
3033 else:
3034 for old_filename in set(files_to_delete):
3035 self.to_screen('Deleting original file %s (pass -k to keep)' % old_filename)
3036 try:
3037 os.remove(encodeFilename(old_filename))
3038 except (IOError, OSError):
3039 self.report_warning('Unable to remove downloaded original file')
3040 if old_filename in infodict['__files_to_move']:
3041 del infodict['__files_to_move'][old_filename]
3042 return infodict
3043
3044 @staticmethod
3045 def post_extract(info_dict):
3046 def actual_post_extract(info_dict):
3047 if info_dict.get('_type') in ('playlist', 'multi_video'):
3048 for video_dict in info_dict.get('entries', {}):
3049 actual_post_extract(video_dict or {})
3050 return
3051
3052 post_extractor = info_dict.get('__post_extractor') or (lambda: {})
3053 extra = post_extractor().items()
3054 info_dict.update(extra)
3055 info_dict.pop('__post_extractor', None)
3056
3057 original_infodict = info_dict.get('__original_infodict') or {}
3058 original_infodict.update(extra)
3059 original_infodict.pop('__post_extractor', None)
3060
3061 actual_post_extract(info_dict or {})
3062
3063 def pre_process(self, ie_info, key='pre_process', files_to_move=None):
3064 info = dict(ie_info)
3065 info['__files_to_move'] = files_to_move or {}
3066 for pp in self._pps[key]:
3067 info = self.run_pp(pp, info)
3068 return info, info.pop('__files_to_move', None)
3069
3070 def post_process(self, filename, ie_info, files_to_move=None):
3071 """Run all the postprocessors on the given file."""
3072 info = dict(ie_info)
3073 info['filepath'] = filename
3074 info['__files_to_move'] = files_to_move or {}
3075
3076 for pp in ie_info.get('__postprocessors', []) + self._pps['post_process']:
3077 info = self.run_pp(pp, info)
3078 info = self.run_pp(MoveFilesAfterDownloadPP(self), info)
3079 del info['__files_to_move']
3080 for pp in self._pps['after_move']:
3081 info = self.run_pp(pp, info)
3082 return info
3083
3084 def _make_archive_id(self, info_dict):
3085 video_id = info_dict.get('id')
3086 if not video_id:
3087 return
3088 # Future-proof against any change in case
3089 # and backwards compatibility with prior versions
3090 extractor = info_dict.get('extractor_key') or info_dict.get('ie_key') # key in a playlist
3091 if extractor is None:
3092 url = str_or_none(info_dict.get('url'))
3093 if not url:
3094 return
3095 # Try to find matching extractor for the URL and take its ie_key
3096 for ie_key, ie in self._ies.items():
3097 if ie.suitable(url):
3098 extractor = ie_key
3099 break
3100 else:
3101 return
3102 return '%s %s' % (extractor.lower(), video_id)
3103
3104 def in_download_archive(self, info_dict):
3105 fn = self.params.get('download_archive')
3106 if fn is None:
3107 return False
3108
3109 vid_id = self._make_archive_id(info_dict)
3110 if not vid_id:
3111 return False # Incomplete video information
3112
3113 return vid_id in self.archive
3114
3115 def record_download_archive(self, info_dict):
3116 fn = self.params.get('download_archive')
3117 if fn is None:
3118 return
3119 vid_id = self._make_archive_id(info_dict)
3120 assert vid_id
3121 with locked_file(fn, 'a', encoding='utf-8') as archive_file:
3122 archive_file.write(vid_id + '\n')
3123 self.archive.add(vid_id)
3124
3125 @staticmethod
3126 def format_resolution(format, default='unknown'):
3127 is_images = format.get('vcodec') == 'none' and format.get('acodec') == 'none'
3128 if format.get('vcodec') == 'none' and format.get('acodec') != 'none':
3129 return 'audio only'
3130 if format.get('resolution') is not None:
3131 return format['resolution']
3132 if format.get('width') and format.get('height'):
3133 res = '%dx%d' % (format['width'], format['height'])
3134 elif format.get('height'):
3135 res = '%sp' % format['height']
3136 elif format.get('width'):
3137 res = '%dx?' % format['width']
3138 elif is_images:
3139 return 'images'
3140 else:
3141 return default
3142 return f'{res} images' if is_images else res
3143
3144 def _format_note(self, fdict):
3145 res = ''
3146 if fdict.get('ext') in ['f4f', 'f4m']:
3147 res += '(unsupported) '
3148 if fdict.get('language'):
3149 if res:
3150 res += ' '
3151 res += '[%s] ' % fdict['language']
3152 if fdict.get('format_note') is not None:
3153 res += fdict['format_note'] + ' '
3154 if fdict.get('tbr') is not None:
3155 res += '%4dk ' % fdict['tbr']
3156 if fdict.get('container') is not None:
3157 if res:
3158 res += ', '
3159 res += '%s container' % fdict['container']
3160 if (fdict.get('vcodec') is not None
3161 and fdict.get('vcodec') != 'none'):
3162 if res:
3163 res += ', '
3164 res += fdict['vcodec']
3165 if fdict.get('vbr') is not None:
3166 res += '@'
3167 elif fdict.get('vbr') is not None and fdict.get('abr') is not None:
3168 res += 'video@'
3169 if fdict.get('vbr') is not None:
3170 res += '%4dk' % fdict['vbr']
3171 if fdict.get('fps') is not None:
3172 if res:
3173 res += ', '
3174 res += '%sfps' % fdict['fps']
3175 if fdict.get('acodec') is not None:
3176 if res:
3177 res += ', '
3178 if fdict['acodec'] == 'none':
3179 res += 'video only'
3180 else:
3181 res += '%-5s' % fdict['acodec']
3182 elif fdict.get('abr') is not None:
3183 if res:
3184 res += ', '
3185 res += 'audio'
3186 if fdict.get('abr') is not None:
3187 res += '@%3dk' % fdict['abr']
3188 if fdict.get('asr') is not None:
3189 res += ' (%5dHz)' % fdict['asr']
3190 if fdict.get('filesize') is not None:
3191 if res:
3192 res += ', '
3193 res += format_bytes(fdict['filesize'])
3194 elif fdict.get('filesize_approx') is not None:
3195 if res:
3196 res += ', '
3197 res += '~' + format_bytes(fdict['filesize_approx'])
3198 return res
3199
3200 def _list_format_headers(self, *headers):
3201 if self.params.get('listformats_table', True) is not False:
3202 return [self._format_screen(header, self.Styles.HEADERS) for header in headers]
3203 return headers
3204
3205 def list_formats(self, info_dict):
3206 formats = info_dict.get('formats', [info_dict])
3207 new_format = self.params.get('listformats_table', True) is not False
3208 if new_format:
3209 tbr_digits = number_of_digits(max(f.get('tbr') or 0 for f in formats))
3210 vbr_digits = number_of_digits(max(f.get('vbr') or 0 for f in formats))
3211 abr_digits = number_of_digits(max(f.get('abr') or 0 for f in formats))
3212 delim = self._format_screen('\u2502', self.Styles.DELIM, '|', test_encoding=True)
3213 table = [
3214 [
3215 self._format_screen(format_field(f, 'format_id'), self.Styles.ID),
3216 format_field(f, 'ext'),
3217 self.format_resolution(f),
3218 format_field(f, 'fps', '%d'),
3219 format_field(f, 'dynamic_range', '%s', ignore=(None, 'SDR')).replace('HDR', ''),
3220 delim,
3221 format_field(f, 'filesize', ' %s', func=format_bytes) + format_field(f, 'filesize_approx', '~%s', func=format_bytes),
3222 format_field(f, 'tbr', f'%{tbr_digits}dk'),
3223 shorten_protocol_name(f.get('protocol', '').replace("native", "n")),
3224 delim,
3225 format_field(f, 'vcodec', default='unknown').replace('none', ''),
3226 format_field(f, 'vbr', f'%{vbr_digits}dk'),
3227 format_field(f, 'acodec', default='unknown').replace('none', ''),
3228 format_field(f, 'abr', f'%{abr_digits}dk'),
3229 format_field(f, 'asr', '%5dHz'),
3230 ', '.join(filter(None, (
3231 self._format_screen('UNSUPPORTED', 'light red') if f.get('ext') in ('f4f', 'f4m') else '',
3232 format_field(f, 'language', '[%s]'),
3233 format_field(f, 'format_note'),
3234 format_field(f, 'container', ignore=(None, f.get('ext'))),
3235 ))),
3236 ] for f in formats if f.get('preference') is None or f['preference'] >= -1000]
3237 header_line = self._list_format_headers(
3238 'ID', 'EXT', 'RESOLUTION', 'FPS', 'HDR', delim, ' FILESIZE', ' TBR', 'PROTO',
3239 delim, 'VCODEC', ' VBR', 'ACODEC', ' ABR', ' ASR', 'MORE INFO')
3240 else:
3241 table = [
3242 [
3243 format_field(f, 'format_id'),
3244 format_field(f, 'ext'),
3245 self.format_resolution(f),
3246 self._format_note(f)]
3247 for f in formats
3248 if f.get('preference') is None or f['preference'] >= -1000]
3249 header_line = ['format code', 'extension', 'resolution', 'note']
3250
3251 self.to_screen(
3252 '[info] Available formats for %s:' % info_dict['id'])
3253 self.to_stdout(render_table(
3254 header_line, table,
3255 extraGap=(0 if new_format else 1),
3256 hideEmpty=new_format,
3257 delim=new_format and self._format_screen('\u2500', self.Styles.DELIM, '-', test_encoding=True)))
3258
3259 def list_thumbnails(self, info_dict):
3260 thumbnails = list(info_dict.get('thumbnails'))
3261 if not thumbnails:
3262 self.to_screen('[info] No thumbnails present for %s' % info_dict['id'])
3263 return
3264
3265 self.to_screen(
3266 '[info] Thumbnails for %s:' % info_dict['id'])
3267 self.to_stdout(render_table(
3268 self._list_format_headers('ID', 'Width', 'Height', 'URL'),
3269 [[t['id'], t.get('width', 'unknown'), t.get('height', 'unknown'), t['url']] for t in thumbnails]))
3270
3271 def list_subtitles(self, video_id, subtitles, name='subtitles'):
3272 if not subtitles:
3273 self.to_screen('%s has no %s' % (video_id, name))
3274 return
3275 self.to_screen(
3276 'Available %s for %s:' % (name, video_id))
3277
3278 def _row(lang, formats):
3279 exts, names = zip(*((f['ext'], f.get('name') or 'unknown') for f in reversed(formats)))
3280 if len(set(names)) == 1:
3281 names = [] if names[0] == 'unknown' else names[:1]
3282 return [lang, ', '.join(names), ', '.join(exts)]
3283
3284 self.to_stdout(render_table(
3285 self._list_format_headers('Language', 'Name', 'Formats'),
3286 [_row(lang, formats) for lang, formats in subtitles.items()],
3287 hideEmpty=True))
3288
3289 def urlopen(self, req):
3290 """ Start an HTTP download """
3291 if isinstance(req, compat_basestring):
3292 req = sanitized_Request(req)
3293 return self._opener.open(req, timeout=self._socket_timeout)
3294
3295 def print_debug_header(self):
3296 if not self.params.get('verbose'):
3297 return
3298
3299 def get_encoding(stream):
3300 ret = getattr(stream, 'encoding', 'missing (%s)' % type(stream).__name__)
3301 if not supports_terminal_sequences(stream):
3302 ret += ' (No ANSI)'
3303 return ret
3304
3305 encoding_str = 'Encodings: locale %s, fs %s, out %s, err %s, pref %s' % (
3306 locale.getpreferredencoding(),
3307 sys.getfilesystemencoding(),
3308 get_encoding(self._screen_file), get_encoding(self._err_file),
3309 self.get_encoding())
3310
3311 logger = self.params.get('logger')
3312 if logger:
3313 write_debug = lambda msg: logger.debug(f'[debug] {msg}')
3314 write_debug(encoding_str)
3315 else:
3316 write_string(f'[debug] {encoding_str}\n', encoding=None)
3317 write_debug = lambda msg: self._write_string(f'[debug] {msg}\n')
3318
3319 source = detect_variant()
3320 write_debug('yt-dlp version %s%s' % (__version__, '' if source == 'unknown' else f' ({source})'))
3321 if not _LAZY_LOADER:
3322 if os.environ.get('YTDLP_NO_LAZY_EXTRACTORS'):
3323 write_debug('Lazy loading extractors is forcibly disabled')
3324 else:
3325 write_debug('Lazy loading extractors is disabled')
3326 if plugin_extractors or plugin_postprocessors:
3327 write_debug('Plugins: %s' % [
3328 '%s%s' % (klass.__name__, '' if klass.__name__ == name else f' as {name}')
3329 for name, klass in itertools.chain(plugin_extractors.items(), plugin_postprocessors.items())])
3330 if self.params.get('compat_opts'):
3331 write_debug('Compatibility options: %s' % ', '.join(self.params.get('compat_opts')))
3332 try:
3333 sp = Popen(
3334 ['git', 'rev-parse', '--short', 'HEAD'],
3335 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
3336 cwd=os.path.dirname(os.path.abspath(__file__)))
3337 out, err = sp.communicate_or_kill()
3338 out = out.decode().strip()
3339 if re.match('[0-9a-f]+', out):
3340 write_debug('Git HEAD: %s' % out)
3341 except Exception:
3342 try:
3343 sys.exc_clear()
3344 except Exception:
3345 pass
3346
3347 def python_implementation():
3348 impl_name = platform.python_implementation()
3349 if impl_name == 'PyPy' and hasattr(sys, 'pypy_version_info'):
3350 return impl_name + ' version %d.%d.%d' % sys.pypy_version_info[:3]
3351 return impl_name
3352
3353 write_debug('Python version %s (%s %s) - %s' % (
3354 platform.python_version(),
3355 python_implementation(),
3356 platform.architecture()[0],
3357 platform_name()))
3358
3359 exe_versions = FFmpegPostProcessor.get_versions(self)
3360 exe_versions['rtmpdump'] = rtmpdump_version()
3361 exe_versions['phantomjs'] = PhantomJSwrapper._version()
3362 exe_str = ', '.join(
3363 f'{exe} {v}' for exe, v in sorted(exe_versions.items()) if v
3364 ) or 'none'
3365 write_debug('exe versions: %s' % exe_str)
3366
3367 from .downloader.websocket import has_websockets
3368 from .postprocessor.embedthumbnail import has_mutagen
3369 from .cookies import SQLITE_AVAILABLE, KEYRING_AVAILABLE
3370
3371 lib_str = ', '.join(sorted(filter(None, (
3372 compat_pycrypto_AES and compat_pycrypto_AES.__name__.split('.')[0],
3373 has_websockets and 'websockets',
3374 has_mutagen and 'mutagen',
3375 SQLITE_AVAILABLE and 'sqlite',
3376 KEYRING_AVAILABLE and 'keyring',
3377 )))) or 'none'
3378 write_debug('Optional libraries: %s' % lib_str)
3379
3380 proxy_map = {}
3381 for handler in self._opener.handlers:
3382 if hasattr(handler, 'proxies'):
3383 proxy_map.update(handler.proxies)
3384 write_debug(f'Proxy map: {proxy_map}')
3385
3386 # Not implemented
3387 if False and self.params.get('call_home'):
3388 ipaddr = self.urlopen('https://yt-dl.org/ip').read().decode('utf-8')
3389 write_debug('Public IP address: %s' % ipaddr)
3390 latest_version = self.urlopen(
3391 'https://yt-dl.org/latest/version').read().decode('utf-8')
3392 if version_tuple(latest_version) > version_tuple(__version__):
3393 self.report_warning(
3394 'You are using an outdated version (newest version: %s)! '
3395 'See https://yt-dl.org/update if you need help updating.' %
3396 latest_version)
3397
3398 def _setup_opener(self):
3399 timeout_val = self.params.get('socket_timeout')
3400 self._socket_timeout = 20 if timeout_val is None else float(timeout_val)
3401
3402 opts_cookiesfrombrowser = self.params.get('cookiesfrombrowser')
3403 opts_cookiefile = self.params.get('cookiefile')
3404 opts_proxy = self.params.get('proxy')
3405
3406 self.cookiejar = load_cookies(opts_cookiefile, opts_cookiesfrombrowser, self)
3407
3408 cookie_processor = YoutubeDLCookieProcessor(self.cookiejar)
3409 if opts_proxy is not None:
3410 if opts_proxy == '':
3411 proxies = {}
3412 else:
3413 proxies = {'http': opts_proxy, 'https': opts_proxy}
3414 else:
3415 proxies = compat_urllib_request.getproxies()
3416 # Set HTTPS proxy to HTTP one if given (https://github.com/ytdl-org/youtube-dl/issues/805)
3417 if 'http' in proxies and 'https' not in proxies:
3418 proxies['https'] = proxies['http']
3419 proxy_handler = PerRequestProxyHandler(proxies)
3420
3421 debuglevel = 1 if self.params.get('debug_printtraffic') else 0
3422 https_handler = make_HTTPS_handler(self.params, debuglevel=debuglevel)
3423 ydlh = YoutubeDLHandler(self.params, debuglevel=debuglevel)
3424 redirect_handler = YoutubeDLRedirectHandler()
3425 data_handler = compat_urllib_request_DataHandler()
3426
3427 # When passing our own FileHandler instance, build_opener won't add the
3428 # default FileHandler and allows us to disable the file protocol, which
3429 # can be used for malicious purposes (see
3430 # https://github.com/ytdl-org/youtube-dl/issues/8227)
3431 file_handler = compat_urllib_request.FileHandler()
3432
3433 def file_open(*args, **kwargs):
3434 raise compat_urllib_error.URLError('file:// scheme is explicitly disabled in yt-dlp for security reasons')
3435 file_handler.file_open = file_open
3436
3437 opener = compat_urllib_request.build_opener(
3438 proxy_handler, https_handler, cookie_processor, ydlh, redirect_handler, data_handler, file_handler)
3439
3440 # Delete the default user-agent header, which would otherwise apply in
3441 # cases where our custom HTTP handler doesn't come into play
3442 # (See https://github.com/ytdl-org/youtube-dl/issues/1309 for details)
3443 opener.addheaders = []
3444 self._opener = opener
3445
3446 def encode(self, s):
3447 if isinstance(s, bytes):
3448 return s # Already encoded
3449
3450 try:
3451 return s.encode(self.get_encoding())
3452 except UnicodeEncodeError as err:
3453 err.reason = err.reason + '. Check your system encoding configuration or use the --encoding option.'
3454 raise
3455
3456 def get_encoding(self):
3457 encoding = self.params.get('encoding')
3458 if encoding is None:
3459 encoding = preferredencoding()
3460 return encoding
3461
3462 def _write_info_json(self, label, ie_result, infofn):
3463 ''' Write infojson and returns True = written, False = skip, None = error '''
3464 if not self.params.get('writeinfojson'):
3465 return False
3466 elif not infofn:
3467 self.write_debug(f'Skipping writing {label} infojson')
3468 return False
3469 elif not self._ensure_dir_exists(infofn):
3470 return None
3471 elif not self.params.get('overwrites', True) and os.path.exists(infofn):
3472 self.to_screen(f'[info] {label.title()} metadata is already present')
3473 else:
3474 self.to_screen(f'[info] Writing {label} metadata as JSON to: {infofn}')
3475 try:
3476 write_json_file(self.sanitize_info(ie_result, self.params.get('clean_infojson', True)), infofn)
3477 except (OSError, IOError):
3478 self.report_error(f'Cannot write {label} metadata to JSON file {infofn}')
3479 return None
3480 return True
3481
3482 def _write_description(self, label, ie_result, descfn):
3483 ''' Write description and returns True = written, False = skip, None = error '''
3484 if not self.params.get('writedescription'):
3485 return False
3486 elif not descfn:
3487 self.write_debug(f'Skipping writing {label} description')
3488 return False
3489 elif not self._ensure_dir_exists(descfn):
3490 return None
3491 elif not self.params.get('overwrites', True) and os.path.exists(descfn):
3492 self.to_screen(f'[info] {label.title()} description is already present')
3493 elif ie_result.get('description') is None:
3494 self.report_warning(f'There\'s no {label} description to write')
3495 return False
3496 else:
3497 try:
3498 self.to_screen(f'[info] Writing {label} description to: {descfn}')
3499 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
3500 descfile.write(ie_result['description'])
3501 except (OSError, IOError):
3502 self.report_error(f'Cannot write {label} description file {descfn}')
3503 return None
3504 return True
3505
3506 def _write_subtitles(self, info_dict, filename):
3507 ''' Write subtitles to file and return list of (sub_filename, final_sub_filename); or None if error'''
3508 ret = []
3509 subtitles = info_dict.get('requested_subtitles')
3510 if not subtitles or not (self.params.get('writesubtitles') or self.params.get('writeautomaticsub')):
3511 # subtitles download errors are already managed as troubles in relevant IE
3512 # that way it will silently go on when used with unsupporting IE
3513 return ret
3514
3515 sub_filename_base = self.prepare_filename(info_dict, 'subtitle')
3516 if not sub_filename_base:
3517 self.to_screen('[info] Skipping writing video subtitles')
3518 return ret
3519 for sub_lang, sub_info in subtitles.items():
3520 sub_format = sub_info['ext']
3521 sub_filename = subtitles_filename(filename, sub_lang, sub_format, info_dict.get('ext'))
3522 sub_filename_final = subtitles_filename(sub_filename_base, sub_lang, sub_format, info_dict.get('ext'))
3523 if not self.params.get('overwrites', True) and os.path.exists(sub_filename):
3524 self.to_screen(f'[info] Video subtitle {sub_lang}.{sub_format} is already present')
3525 sub_info['filepath'] = sub_filename
3526 ret.append((sub_filename, sub_filename_final))
3527 continue
3528
3529 self.to_screen(f'[info] Writing video subtitles to: {sub_filename}')
3530 if sub_info.get('data') is not None:
3531 try:
3532 # Use newline='' to prevent conversion of newline characters
3533 # See https://github.com/ytdl-org/youtube-dl/issues/10268
3534 with io.open(sub_filename, 'w', encoding='utf-8', newline='') as subfile:
3535 subfile.write(sub_info['data'])
3536 sub_info['filepath'] = sub_filename
3537 ret.append((sub_filename, sub_filename_final))
3538 continue
3539 except (OSError, IOError):
3540 self.report_error(f'Cannot write video subtitles file {sub_filename}')
3541 return None
3542
3543 try:
3544 sub_copy = sub_info.copy()
3545 sub_copy.setdefault('http_headers', info_dict.get('http_headers'))
3546 self.dl(sub_filename, sub_copy, subtitle=True)
3547 sub_info['filepath'] = sub_filename
3548 ret.append((sub_filename, sub_filename_final))
3549 except (ExtractorError, IOError, OSError, ValueError) + network_exceptions as err:
3550 self.report_warning(f'Unable to download video subtitles for {sub_lang!r}: {err}')
3551 continue
3552 return ret
3553
3554 def _write_thumbnails(self, label, info_dict, filename, thumb_filename_base=None):
3555 ''' Write thumbnails to file and return list of (thumb_filename, final_thumb_filename) '''
3556 write_all = self.params.get('write_all_thumbnails', False)
3557 thumbnails, ret = [], []
3558 if write_all or self.params.get('writethumbnail', False):
3559 thumbnails = info_dict.get('thumbnails') or []
3560 multiple = write_all and len(thumbnails) > 1
3561
3562 if thumb_filename_base is None:
3563 thumb_filename_base = filename
3564 if thumbnails and not thumb_filename_base:
3565 self.write_debug(f'Skipping writing {label} thumbnail')
3566 return ret
3567
3568 for t in thumbnails[::-1]:
3569 thumb_ext = (f'{t["id"]}.' if multiple else '') + determine_ext(t['url'], 'jpg')
3570 thumb_display_id = f'{label} thumbnail' + (f' {t["id"]}' if multiple else '')
3571 thumb_filename = replace_extension(filename, thumb_ext, info_dict.get('ext'))
3572 thumb_filename_final = replace_extension(thumb_filename_base, thumb_ext, info_dict.get('ext'))
3573
3574 if not self.params.get('overwrites', True) and os.path.exists(thumb_filename):
3575 ret.append((thumb_filename, thumb_filename_final))
3576 t['filepath'] = thumb_filename
3577 self.to_screen(f'[info] {thumb_display_id.title()} is already present')
3578 else:
3579 self.to_screen(f'[info] Downloading {thumb_display_id} ...')
3580 try:
3581 uf = self.urlopen(t['url'])
3582 self.to_screen(f'[info] Writing {thumb_display_id} to: {thumb_filename}')
3583 with open(encodeFilename(thumb_filename), 'wb') as thumbf:
3584 shutil.copyfileobj(uf, thumbf)
3585 ret.append((thumb_filename, thumb_filename_final))
3586 t['filepath'] = thumb_filename
3587 except network_exceptions as err:
3588 self.report_warning(f'Unable to download {thumb_display_id}: {err}')
3589 if ret and not write_all:
3590 break
3591 return ret