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