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