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