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