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