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