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