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