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