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