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