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