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