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