]> jfr.im git - yt-dlp.git/blame - youtube_dl/YoutubeDL.py
[Sohu] Fix title extraction
[yt-dlp.git] / youtube_dl / YoutubeDL.py
CommitLineData
8222d8de
JMF
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3
6febd1c1 4from __future__ import absolute_import, unicode_literals
8222d8de 5
26e63931 6import collections
31bd3925 7import contextlib
9d2ecdbc 8import datetime
c1c9a79c 9import errno
31bd3925 10import fileinput
8222d8de 11import io
b82f815f 12import itertools
8694c600 13import json
62fec3b2 14import locale
083c9df9 15import operator
8222d8de 16import os
dca08720 17import platform
8222d8de
JMF
18import re
19import shutil
dca08720 20import subprocess
8222d8de
JMF
21import socket
22import sys
23import time
24import traceback
25
1e5b9a95
PH
26if os.name == 'nt':
27 import ctypes
28
8c25f81b 29from .compat import (
8f9312c3 30 compat_basestring,
dca08720 31 compat_cookiejar,
4644ac55 32 compat_expanduser,
003c69a8 33 compat_get_terminal_size,
ce02ed60 34 compat_http_client,
4f026faf 35 compat_kwargs,
ce02ed60
PH
36 compat_str,
37 compat_urllib_error,
38 compat_urllib_request,
8c25f81b
PH
39)
40from .utils import (
d05cfe06 41 escape_url,
ce02ed60
PH
42 ContentTooShortError,
43 date_from_str,
44 DateRange,
acd69589 45 DEFAULT_OUTTMPL,
ce02ed60
PH
46 determine_ext,
47 DownloadError,
48 encodeFilename,
49 ExtractorError,
02dbf93f 50 format_bytes,
525ef922 51 formatSeconds,
ce02ed60 52 locked_file,
dca08720 53 make_HTTPS_handler,
ce02ed60 54 MaxDownloadsReached,
b7ab0590 55 PagedList,
083c9df9 56 parse_filesize,
91410c9b 57 PerRequestProxyHandler,
ce02ed60 58 PostProcessingError,
dca08720 59 platform_name,
ce02ed60 60 preferredencoding,
cfb56d1a 61 render_table,
ce02ed60
PH
62 SameFileError,
63 sanitize_filename,
1bb5c511 64 sanitize_path,
e5660ee6 65 std_headers,
ce02ed60
PH
66 subtitles_filename,
67 takewhile_inclusive,
68 UnavailableVideoError,
29eb5174 69 url_basename,
58b1f00d 70 version_tuple,
ce02ed60
PH
71 write_json_file,
72 write_string,
dca08720 73 YoutubeDLHandler,
6350728b 74 prepend_extension,
7d4111ed 75 args_to_str,
05900629 76 age_restricted,
ce02ed60 77)
a0e07d31 78from .cache import Cache
023fa8c4 79from .extractor import get_info_extractor, gen_extractors
3bc2ddcc 80from .downloader import get_suitable_downloader
4c83c967 81from .downloader.rtmp import rtmpdump_version
4f026faf 82from .postprocessor import (
62cd676c 83 FFmpegFixupM4aPP,
6271f1ca 84 FFmpegFixupStretchedPP,
4f026faf
PH
85 FFmpegMergerPP,
86 FFmpegPostProcessor,
87 get_postprocessor,
88)
dca08720 89from .version import __version__
8222d8de
JMF
90
91
92class YoutubeDL(object):
93 """YoutubeDL class.
94
95 YoutubeDL objects are the ones responsible of downloading the
96 actual video file and writing it to disk if the user has requested
97 it, among some other tasks. In most cases there should be one per
98 program. As, given a video URL, the downloader doesn't know how to
99 extract all the needed information, task that InfoExtractors do, it
100 has to pass the URL to one of them.
101
102 For this, YoutubeDL objects have a method that allows
103 InfoExtractors to be registered in a given order. When it is passed
104 a URL, the YoutubeDL object handles it to the first InfoExtractor it
105 finds that reports being able to handle it. The InfoExtractor extracts
106 all the information about the video or videos the URL refers to, and
107 YoutubeDL process the extracted information, possibly using a File
108 Downloader to download the video.
109
110 YoutubeDL objects accept a lot of parameters. In order not to saturate
111 the object constructor with arguments, it receives a dictionary of
112 options instead. These options are available through the params
113 attribute for the InfoExtractors to use. The YoutubeDL also
114 registers itself as the downloader in charge for the InfoExtractors
115 that are added to it, so this is a "mutual registration".
116
117 Available options:
118
119 username: Username for authentication purposes.
120 password: Password for authentication purposes.
c6c19746 121 videopassword: Password for acces a video.
8222d8de
JMF
122 usenetrc: Use netrc for authentication instead.
123 verbose: Print additional info to stdout.
124 quiet: Do not print messages to stdout.
ad8915b7 125 no_warnings: Do not print out anything for warnings.
8222d8de
JMF
126 forceurl: Force printing final URL.
127 forcetitle: Force printing title.
128 forceid: Force printing ID.
129 forcethumbnail: Force printing thumbnail URL.
130 forcedescription: Force printing description.
131 forcefilename: Force printing final filename.
525ef922 132 forceduration: Force printing duration.
8694c600 133 forcejson: Force printing info_dict as JSON.
63e0be34
PH
134 dump_single_json: Force printing the info_dict of the whole playlist
135 (or video) as a single JSON line.
8222d8de 136 simulate: Do not download the video files.
d8600787 137 format: Video format code. See options.py for more information.
8222d8de
JMF
138 format_limit: Highest quality format to try.
139 outtmpl: Template for output names.
140 restrictfilenames: Do not allow "&" and spaces in file names
141 ignoreerrors: Do not stop on download errors.
142 nooverwrites: Prevent overwriting files.
143 playliststart: Playlist item to start at.
144 playlistend: Playlist item to end at.
c14e88f0 145 playlist_items: Specific indices of playlist to download.
ff815fe6 146 playlistreverse: Download playlist items in reverse order.
8222d8de
JMF
147 matchtitle: Download only matching titles.
148 rejecttitle: Reject downloads for matching titles.
8bf9319e 149 logger: Log messages to a logging.Logger instance.
8222d8de
JMF
150 logtostderr: Log messages to stderr instead of stdout.
151 writedescription: Write the video description to a .description file
152 writeinfojson: Write the video description to a .info.json file
1fb07d10 153 writeannotations: Write the video annotations to a .annotations.xml file
8222d8de 154 writethumbnail: Write the thumbnail image to a file
ec82d85a 155 write_all_thumbnails: Write all thumbnail formats to files
8222d8de 156 writesubtitles: Write the video subtitles to a file
b004821f 157 writeautomaticsub: Write the automatic subtitles to a file
8222d8de 158 allsubtitles: Downloads all the subtitles of the video
0b7f3118 159 (requires writesubtitles or writeautomaticsub)
8222d8de 160 listsubtitles: Lists all available subtitles for the video
a504ced0 161 subtitlesformat: The format code for subtitles
aa6a10c4 162 subtitleslangs: List of languages of the subtitles to download
8222d8de
JMF
163 keepvideo: Keep the video file after post-processing
164 daterange: A DateRange object, download only if the upload_date is in the range.
165 skip_download: Skip the actual download of the video file
c35f9e72 166 cachedir: Location of the cache files in the filesystem.
a0e07d31 167 False to disable filesystem cache.
47192f92 168 noplaylist: Download single video instead of a playlist if in doubt.
8dbe9899
PH
169 age_limit: An integer representing the user's age in years.
170 Unsuitable videos for the given age are skipped.
5fe18bdb
PH
171 min_views: An integer representing the minimum view count the video
172 must have in order to not be skipped.
173 Videos without view count information are always
174 downloaded. None for no limit.
175 max_views: An integer representing the maximum view count.
176 Videos that are more popular than that are not
177 downloaded.
178 Videos without view count information are always
179 downloaded. None for no limit.
180 download_archive: File name of a file where all downloads are recorded.
c1c9a79c
PH
181 Videos already present in the file are not downloaded
182 again.
dca08720 183 cookiefile: File name where cookies should be read from and dumped to.
a1ee09e8 184 nocheckcertificate:Do not verify SSL certificates
7e8c0af0
PH
185 prefer_insecure: Use HTTP instead of HTTPS to retrieve information.
186 At the moment, this is only supported by YouTube.
a1ee09e8 187 proxy: URL of the proxy server to use
91410c9b
PH
188 cn_verification_proxy: URL of the proxy to use for IP address verification
189 on Chinese sites. (Experimental)
e344693b 190 socket_timeout: Time to wait for unresponsive hosts, in seconds
0783b09b
PH
191 bidi_workaround: Work around buggy terminals without bidirectional text
192 support, using fridibi
a0ddb8a2 193 debug_printtraffic:Print out sent and received HTTP traffic
7b0817e8 194 include_ads: Download ads as well
04b4d394
PH
195 default_search: Prepend this string if an input url is not valid.
196 'auto' for elaborate guessing
62fec3b2 197 encoding: Use this encoding instead of the system-specified.
e8ee972c 198 extract_flat: Do not resolve URLs, return the immediate result.
057a5206
PH
199 Pass in 'in_playlist' to only show this behavior for
200 playlist items.
4f026faf 201 postprocessors: A list of dictionaries, each with an entry
71b640cc
PH
202 * key: The name of the postprocessor. See
203 youtube_dl/postprocessor/__init__.py for a list.
4f026faf
PH
204 as well as any further keyword arguments for the
205 postprocessor.
71b640cc
PH
206 progress_hooks: A list of functions that get called on download
207 progress, with a dictionary with the entries
5cda4eda 208 * status: One of "downloading", "error", or "finished".
ee69b99a 209 Check this first and ignore unknown values.
71b640cc 210
5cda4eda 211 If status is one of "downloading", or "finished", the
ee69b99a
PH
212 following properties may also be present:
213 * filename: The final filename (always present)
5cda4eda 214 * tmpfilename: The filename we're currently writing to
71b640cc
PH
215 * downloaded_bytes: Bytes on disk
216 * total_bytes: Size of the whole file, None if unknown
5cda4eda
PH
217 * total_bytes_estimate: Guess of the eventual file size,
218 None if unavailable.
219 * elapsed: The number of seconds since download started.
71b640cc
PH
220 * eta: The estimated time in seconds, None if unknown
221 * speed: The download speed in bytes/second, None if
222 unknown
5cda4eda
PH
223 * fragment_index: The counter of the currently
224 downloaded video fragment.
225 * fragment_count: The number of fragments (= individual
226 files that will be merged)
71b640cc
PH
227
228 Progress hooks are guaranteed to be called at least once
229 (with status "finished") if the download is successful.
45598f15 230 merge_output_format: Extension to use when merging formats.
6271f1ca
PH
231 fixup: Automatically correct known faults of the file.
232 One of:
233 - "never": do nothing
234 - "warn": only emit a warning
235 - "detect_or_warn": check whether we can do anything
62cd676c 236 about it, warn otherwise (default)
be4a824d 237 source_address: (Experimental) Client-side IP address to bind to.
8bfa7545
PH
238 call_home: Boolean, true iff we are allowed to contact the
239 youtube-dl servers for debugging.
5f0d813d 240 sleep_interval: Number of seconds to sleep before each download.
cfb56d1a
PH
241 listformats: Print an overview of available video formats and exit.
242 list_thumbnails: Print a table of all thumbnails and exit.
347de493
PH
243 match_filter: A function that gets called with the info_dict of
244 every video.
245 If it returns a message, the video is ignored.
246 If it returns None, the video is downloaded.
247 match_filter_func in utils.py is one example for this.
7e5db8c9 248 no_color: Do not emit color codes in output.
71b640cc 249
85729c51
PH
250 The following options determine which downloader is picked:
251 external_downloader: Executable of the external downloader to call.
252 None or unset for standard (built-in) downloader.
253 hls_prefer_native: Use the native HLS downloader instead of ffmpeg/avconv.
fe7e0c98 254
8222d8de 255 The following parameters are not used by YoutubeDL itself, they are used by
c75f0b36 256 the downloader (see youtube_dl/downloader/common.py):
8222d8de 257 nopart, updatetime, buffersize, ratelimit, min_filesize, max_filesize, test,
881e6a1f 258 noresizebuffer, retries, continuedl, noprogress, consoletitle,
c75f0b36 259 xattr_set_filesize, external_downloader_args.
76b1bd67
JMF
260
261 The following options are used by the post processors:
262 prefer_ffmpeg: If True, use ffmpeg instead of avconv if both are available,
263 otherwise prefer avconv.
8d31fa3c 264 exec_cmd: Arbitrary command to run after downloading
8222d8de
JMF
265 """
266
267 params = None
268 _ies = []
269 _pps = []
270 _download_retcode = None
271 _num_downloads = None
272 _screen_file = None
273
3511266b 274 def __init__(self, params=None, auto_init=True):
8222d8de 275 """Create a FileDownloader object with the given options."""
e9f9a10f
JMF
276 if params is None:
277 params = {}
8222d8de 278 self._ies = []
56c73665 279 self._ies_instances = {}
8222d8de 280 self._pps = []
933605d7 281 self._progress_hooks = []
8222d8de
JMF
282 self._download_retcode = 0
283 self._num_downloads = 0
284 self._screen_file = [sys.stdout, sys.stderr][params.get('logtostderr', False)]
0783b09b 285 self._err_file = sys.stderr
e9f9a10f 286 self.params = params
a0e07d31 287 self.cache = Cache(self)
34308b30 288
0783b09b 289 if params.get('bidi_workaround', False):
1c088fa8
PH
290 try:
291 import pty
292 master, slave = pty.openpty()
003c69a8 293 width = compat_get_terminal_size().columns
1c088fa8
PH
294 if width is None:
295 width_args = []
296 else:
297 width_args = ['-w', str(width)]
5d681e96 298 sp_kwargs = dict(
1c088fa8
PH
299 stdin=subprocess.PIPE,
300 stdout=slave,
301 stderr=self._err_file)
5d681e96
PH
302 try:
303 self._output_process = subprocess.Popen(
304 ['bidiv'] + width_args, **sp_kwargs
305 )
306 except OSError:
5d681e96
PH
307 self._output_process = subprocess.Popen(
308 ['fribidi', '-c', 'UTF-8'] + width_args, **sp_kwargs)
309 self._output_channel = os.fdopen(master, 'rb')
1c088fa8
PH
310 except OSError as ose:
311 if ose.errno == 2:
6febd1c1 312 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
313 else:
314 raise
0783b09b 315
34308b30 316 if (sys.version_info >= (3,) and sys.platform != 'win32' and
8fb3ac36
PH
317 sys.getfilesystemencoding() in ['ascii', 'ANSI_X3.4-1968'] and
318 not params.get('restrictfilenames', False)):
34308b30
PH
319 # On Python 3, the Unicode filesystem API will throw errors (#1474)
320 self.report_warning(
6febd1c1 321 'Assuming --restrict-filenames since file system encoding '
1b725173 322 'cannot encode all characters. '
6febd1c1 323 'Set the LC_ALL environment variable to fix this.')
4a98cdbf 324 self.params['restrictfilenames'] = True
34308b30 325
486dd09e
PH
326 if isinstance(params.get('outtmpl'), bytes):
327 self.report_warning(
328 'Parameter outtmpl is bytes, but should be a unicode string. '
329 'Put from __future__ import unicode_literals at the top of your code file or consider switching to Python 3.x.')
330
dca08720
PH
331 self._setup_opener()
332
3511266b
PH
333 if auto_init:
334 self.print_debug_header()
335 self.add_default_info_extractors()
336
4f026faf
PH
337 for pp_def_raw in self.params.get('postprocessors', []):
338 pp_class = get_postprocessor(pp_def_raw['key'])
339 pp_def = dict(pp_def_raw)
340 del pp_def['key']
341 pp = pp_class(self, **compat_kwargs(pp_def))
342 self.add_post_processor(pp)
343
71b640cc
PH
344 for ph in self.params.get('progress_hooks', []):
345 self.add_progress_hook(ph)
346
7d4111ed
PH
347 def warn_if_short_id(self, argv):
348 # short YouTube ID starting with dash?
349 idxs = [
350 i for i, a in enumerate(argv)
351 if re.match(r'^-[0-9A-Za-z_-]{10}$', a)]
352 if idxs:
353 correct_argv = (
354 ['youtube-dl'] +
355 [a for i, a in enumerate(argv) if i not in idxs] +
356 ['--'] + [argv[i] for i in idxs]
357 )
358 self.report_warning(
359 'Long argument string detected. '
360 'Use -- to separate parameters and URLs, like this:\n%s\n' %
361 args_to_str(correct_argv))
362
8222d8de
JMF
363 def add_info_extractor(self, ie):
364 """Add an InfoExtractor object to the end of the list."""
365 self._ies.append(ie)
56c73665 366 self._ies_instances[ie.ie_key()] = ie
8222d8de
JMF
367 ie.set_downloader(self)
368
56c73665
JMF
369 def get_info_extractor(self, ie_key):
370 """
371 Get an instance of an IE with name ie_key, it will try to get one from
372 the _ies list, if there's no instance it will create a new one and add
373 it to the extractor list.
374 """
375 ie = self._ies_instances.get(ie_key)
376 if ie is None:
377 ie = get_info_extractor(ie_key)()
378 self.add_info_extractor(ie)
379 return ie
380
023fa8c4
JMF
381 def add_default_info_extractors(self):
382 """
383 Add the InfoExtractors returned by gen_extractors to the end of the list
384 """
385 for ie in gen_extractors():
386 self.add_info_extractor(ie)
387
8222d8de
JMF
388 def add_post_processor(self, pp):
389 """Add a PostProcessor object to the end of the chain."""
390 self._pps.append(pp)
391 pp.set_downloader(self)
392
933605d7
JMF
393 def add_progress_hook(self, ph):
394 """Add the progress hook (currently only for the file downloader)"""
395 self._progress_hooks.append(ph)
8ab470f1 396
1c088fa8 397 def _bidi_workaround(self, message):
5d681e96 398 if not hasattr(self, '_output_channel'):
1c088fa8
PH
399 return message
400
5d681e96 401 assert hasattr(self, '_output_process')
11b85ce6 402 assert isinstance(message, compat_str)
6febd1c1
PH
403 line_count = message.count('\n') + 1
404 self._output_process.stdin.write((message + '\n').encode('utf-8'))
5d681e96 405 self._output_process.stdin.flush()
6febd1c1 406 res = ''.join(self._output_channel.readline().decode('utf-8')
9e1a5b84 407 for _ in range(line_count))
6febd1c1 408 return res[:-len('\n')]
1c088fa8 409
8222d8de 410 def to_screen(self, message, skip_eol=False):
0783b09b
PH
411 """Print message to stdout if not in quiet mode."""
412 return self.to_stdout(message, skip_eol, check_quiet=True)
413
734f90bb 414 def _write_string(self, s, out=None):
b58ddb32 415 write_string(s, out=out, encoding=self.params.get('encoding'))
734f90bb 416
0783b09b 417 def to_stdout(self, message, skip_eol=False, check_quiet=False):
8222d8de 418 """Print message to stdout if not in quiet mode."""
8bf9319e 419 if self.params.get('logger'):
43afe285 420 self.params['logger'].debug(message)
0783b09b 421 elif not check_quiet or not self.params.get('quiet', False):
1c088fa8 422 message = self._bidi_workaround(message)
6febd1c1 423 terminator = ['\n', ''][skip_eol]
8222d8de 424 output = message + terminator
1c088fa8 425
734f90bb 426 self._write_string(output, self._screen_file)
8222d8de
JMF
427
428 def to_stderr(self, message):
429 """Print message to stderr."""
11b85ce6 430 assert isinstance(message, compat_str)
8bf9319e 431 if self.params.get('logger'):
43afe285
IB
432 self.params['logger'].error(message)
433 else:
1c088fa8 434 message = self._bidi_workaround(message)
6febd1c1 435 output = message + '\n'
734f90bb 436 self._write_string(output, self._err_file)
8222d8de 437
1e5b9a95
PH
438 def to_console_title(self, message):
439 if not self.params.get('consoletitle', False):
440 return
441 if os.name == 'nt' and ctypes.windll.kernel32.GetConsoleWindow():
442 # c_wchar_p() might not be necessary if `message` is
443 # already of type unicode()
444 ctypes.windll.kernel32.SetConsoleTitleW(ctypes.c_wchar_p(message))
445 elif 'TERM' in os.environ:
734f90bb 446 self._write_string('\033]0;%s\007' % message, self._screen_file)
1e5b9a95 447
bdde425c
PH
448 def save_console_title(self):
449 if not self.params.get('consoletitle', False):
450 return
451 if 'TERM' in os.environ:
efd6c574 452 # Save the title on stack
734f90bb 453 self._write_string('\033[22;0t', self._screen_file)
bdde425c
PH
454
455 def restore_console_title(self):
456 if not self.params.get('consoletitle', False):
457 return
458 if 'TERM' in os.environ:
efd6c574 459 # Restore the title from stack
734f90bb 460 self._write_string('\033[23;0t', self._screen_file)
bdde425c
PH
461
462 def __enter__(self):
463 self.save_console_title()
464 return self
465
466 def __exit__(self, *args):
467 self.restore_console_title()
f89197d7 468
dca08720
PH
469 if self.params.get('cookiefile') is not None:
470 self.cookiejar.save()
bdde425c 471
8222d8de
JMF
472 def trouble(self, message=None, tb=None):
473 """Determine action to take when a download problem appears.
474
475 Depending on if the downloader has been configured to ignore
476 download errors or not, this method may throw an exception or
477 not when errors are found, after printing the message.
478
479 tb, if given, is additional traceback information.
480 """
481 if message is not None:
482 self.to_stderr(message)
483 if self.params.get('verbose'):
484 if tb is None:
485 if sys.exc_info()[0]: # if .trouble has been called from an except block
6febd1c1 486 tb = ''
8222d8de 487 if hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
6febd1c1 488 tb += ''.join(traceback.format_exception(*sys.exc_info()[1].exc_info))
8222d8de
JMF
489 tb += compat_str(traceback.format_exc())
490 else:
491 tb_data = traceback.format_list(traceback.extract_stack())
6febd1c1 492 tb = ''.join(tb_data)
8222d8de
JMF
493 self.to_stderr(tb)
494 if not self.params.get('ignoreerrors', False):
495 if sys.exc_info()[0] and hasattr(sys.exc_info()[1], 'exc_info') and sys.exc_info()[1].exc_info[0]:
496 exc_info = sys.exc_info()[1].exc_info
497 else:
498 exc_info = sys.exc_info()
499 raise DownloadError(message, exc_info)
500 self._download_retcode = 1
501
502 def report_warning(self, message):
503 '''
504 Print the message to stderr, it will be prefixed with 'WARNING:'
505 If stderr is a tty file the 'WARNING:' will be colored
506 '''
6d07ce01
JMF
507 if self.params.get('logger') is not None:
508 self.params['logger'].warning(message)
8222d8de 509 else:
ad8915b7
PH
510 if self.params.get('no_warnings'):
511 return
7e5db8c9 512 if not self.params.get('no_color') and self._err_file.isatty() and os.name != 'nt':
6d07ce01
JMF
513 _msg_header = '\033[0;33mWARNING:\033[0m'
514 else:
515 _msg_header = 'WARNING:'
516 warning_message = '%s %s' % (_msg_header, message)
517 self.to_stderr(warning_message)
8222d8de
JMF
518
519 def report_error(self, message, tb=None):
520 '''
521 Do the same as trouble, but prefixes the message with 'ERROR:', colored
522 in red if stderr is a tty file.
523 '''
7e5db8c9 524 if not self.params.get('no_color') and self._err_file.isatty() and os.name != 'nt':
6febd1c1 525 _msg_header = '\033[0;31mERROR:\033[0m'
8222d8de 526 else:
6febd1c1
PH
527 _msg_header = 'ERROR:'
528 error_message = '%s %s' % (_msg_header, message)
8222d8de
JMF
529 self.trouble(error_message, tb)
530
8222d8de
JMF
531 def report_file_already_downloaded(self, file_name):
532 """Report file has already been fully downloaded."""
533 try:
6febd1c1 534 self.to_screen('[download] %s has already been downloaded' % file_name)
ce02ed60 535 except UnicodeEncodeError:
6febd1c1 536 self.to_screen('[download] The file has already been downloaded')
8222d8de 537
8222d8de
JMF
538 def prepare_filename(self, info_dict):
539 """Generate the output filename."""
540 try:
541 template_dict = dict(info_dict)
542
543 template_dict['epoch'] = int(time.time())
544 autonumber_size = self.params.get('autonumber_size')
545 if autonumber_size is None:
546 autonumber_size = 5
6febd1c1 547 autonumber_templ = '%0' + str(autonumber_size) + 'd'
8222d8de 548 template_dict['autonumber'] = autonumber_templ % self._num_downloads
702665c0 549 if template_dict.get('playlist_index') is not None:
c6b4132a 550 template_dict['playlist_index'] = '%0*d' % (len(str(template_dict['n_entries'])), template_dict['playlist_index'])
17b75c0d
PH
551 if template_dict.get('resolution') is None:
552 if template_dict.get('width') and template_dict.get('height'):
553 template_dict['resolution'] = '%dx%d' % (template_dict['width'], template_dict['height'])
554 elif template_dict.get('height'):
805ef3c6 555 template_dict['resolution'] = '%sp' % template_dict['height']
17b75c0d 556 elif template_dict.get('width'):
805ef3c6 557 template_dict['resolution'] = '?x%d' % template_dict['width']
8222d8de 558
586a91b6 559 sanitize = lambda k, v: sanitize_filename(
45598aab 560 compat_str(v),
1bb5c511 561 restricted=self.params.get('restrictfilenames'),
6febd1c1 562 is_id=(k == 'id'))
586a91b6 563 template_dict = dict((k, sanitize(k, v))
45598aab
PH
564 for k, v in template_dict.items()
565 if v is not None)
6febd1c1 566 template_dict = collections.defaultdict(lambda: 'NA', template_dict)
8222d8de 567
1bb5c511 568 outtmpl = sanitize_path(self.params.get('outtmpl', DEFAULT_OUTTMPL))
4644ac55 569 tmpl = compat_expanduser(outtmpl)
586a91b6 570 filename = tmpl % template_dict
3a0d2f52
S
571 # Temporary fix for #4787
572 # 'Treat' all problem characters by passing filename through preferredencoding
573 # to workaround encoding issues with subprocess on python2 @ Windows
574 if sys.version_info < (3, 0) and sys.platform == 'win32':
575 filename = encodeFilename(filename, True).decode(preferredencoding())
8222d8de 576 return filename
8222d8de 577 except ValueError as err:
6febd1c1 578 self.report_error('Error in output template: ' + str(err) + ' (encoding: ' + repr(preferredencoding()) + ')')
8222d8de
JMF
579 return None
580
442c37b7 581 def _match_entry(self, info_dict, incomplete):
8222d8de
JMF
582 """ Returns None iff the file should be downloaded """
583
6febd1c1 584 video_title = info_dict.get('title', info_dict.get('id', 'video'))
7012b23c
PH
585 if 'title' in info_dict:
586 # This can happen when we're just evaluating the playlist
587 title = info_dict['title']
588 matchtitle = self.params.get('matchtitle', False)
589 if matchtitle:
590 if not re.search(matchtitle, title, re.IGNORECASE):
6febd1c1 591 return '"' + title + '" title did not match pattern "' + matchtitle + '"'
7012b23c
PH
592 rejecttitle = self.params.get('rejecttitle', False)
593 if rejecttitle:
594 if re.search(rejecttitle, title, re.IGNORECASE):
6febd1c1 595 return '"' + title + '" title matched reject pattern "' + rejecttitle + '"'
8222d8de
JMF
596 date = info_dict.get('upload_date', None)
597 if date is not None:
598 dateRange = self.params.get('daterange', DateRange())
599 if date not in dateRange:
6febd1c1 600 return '%s upload date is not in range %s' % (date_from_str(date).isoformat(), dateRange)
5fe18bdb
PH
601 view_count = info_dict.get('view_count', None)
602 if view_count is not None:
603 min_views = self.params.get('min_views')
604 if min_views is not None and view_count < min_views:
6febd1c1 605 return 'Skipping %s, because it has not reached minimum view count (%d/%d)' % (video_title, view_count, min_views)
5fe18bdb
PH
606 max_views = self.params.get('max_views')
607 if max_views is not None and view_count > max_views:
6febd1c1 608 return 'Skipping %s, because it has exceeded the maximum view count (%d/%d)' % (video_title, view_count, max_views)
05900629 609 if age_restricted(info_dict.get('age_limit'), self.params.get('age_limit')):
347de493 610 return 'Skipping "%s" because it is age restricted' % video_title
c1c9a79c 611 if self.in_download_archive(info_dict):
6febd1c1 612 return '%s has already been recorded in archive' % video_title
347de493 613
442c37b7
PH
614 if not incomplete:
615 match_filter = self.params.get('match_filter')
616 if match_filter is not None:
617 ret = match_filter(info_dict)
618 if ret is not None:
619 return ret
347de493 620
8222d8de 621 return None
fe7e0c98 622
b6c45014
JMF
623 @staticmethod
624 def add_extra_info(info_dict, extra_info):
625 '''Set the keys from extra_info in info dict if they are missing'''
626 for key, value in extra_info.items():
627 info_dict.setdefault(key, value)
628
7fc3fa05
PH
629 def extract_info(self, url, download=True, ie_key=None, extra_info={},
630 process=True):
8222d8de
JMF
631 '''
632 Returns a list with a dictionary for each video we find.
633 If 'download', also downloads the videos.
634 extra_info is a dict containing the extra values to add to each result
613b2d9d 635 '''
fe7e0c98 636
8222d8de 637 if ie_key:
56c73665 638 ies = [self.get_info_extractor(ie_key)]
8222d8de
JMF
639 else:
640 ies = self._ies
641
642 for ie in ies:
643 if not ie.suitable(url):
644 continue
645
646 if not ie.working():
6febd1c1
PH
647 self.report_warning('The program functionality for this site has been marked as broken, '
648 'and will probably not work.')
8222d8de
JMF
649
650 try:
651 ie_result = ie.extract(url)
5f6a1245 652 if ie_result is None: # Finished already (backwards compatibility; listformats and friends should be moved here)
8222d8de
JMF
653 break
654 if isinstance(ie_result, list):
655 # Backwards compatibility: old IE result format
8222d8de
JMF
656 ie_result = {
657 '_type': 'compat_list',
658 'entries': ie_result,
659 }
ea38e55f 660 self.add_default_extra_info(ie_result, ie, url)
7fc3fa05
PH
661 if process:
662 return self.process_ie_result(ie_result, download, extra_info)
663 else:
664 return ie_result
5f6a1245 665 except ExtractorError as de: # An error we somewhat expected
8222d8de
JMF
666 self.report_error(compat_str(de), de.format_traceback())
667 break
d3e5bbf4
PH
668 except MaxDownloadsReached:
669 raise
8222d8de
JMF
670 except Exception as e:
671 if self.params.get('ignoreerrors', False):
672 self.report_error(compat_str(e), tb=compat_str(traceback.format_exc()))
673 break
674 else:
675 raise
676 else:
1a489545 677 self.report_error('no suitable InfoExtractor for URL %s' % url)
fe7e0c98 678
ea38e55f
PH
679 def add_default_extra_info(self, ie_result, ie, url):
680 self.add_extra_info(ie_result, {
681 'extractor': ie.IE_NAME,
682 'webpage_url': url,
683 'webpage_url_basename': url_basename(url),
684 'extractor_key': ie.ie_key(),
685 })
686
8222d8de
JMF
687 def process_ie_result(self, ie_result, download=True, extra_info={}):
688 """
689 Take the result of the ie(may be modified) and resolve all unresolved
690 references (URLs, playlist items).
691
692 It will also download the videos if 'download'.
693 Returns the resolved ie_result.
694 """
695
e8ee972c
PH
696 result_type = ie_result.get('_type', 'video')
697
057a5206
PH
698 if result_type in ('url', 'url_transparent'):
699 extract_flat = self.params.get('extract_flat', False)
700 if ((extract_flat == 'in_playlist' and 'playlist' in extra_info) or
701 extract_flat is True):
057a5206
PH
702 if self.params.get('forcejson', False):
703 self.to_stdout(json.dumps(ie_result))
e8ee972c
PH
704 return ie_result
705
8222d8de 706 if result_type == 'video':
b6c45014 707 self.add_extra_info(ie_result, extra_info)
feee2ecf 708 return self.process_video_result(ie_result, download=download)
8222d8de
JMF
709 elif result_type == 'url':
710 # We have to add extra_info to the results because it may be
711 # contained in a playlist
712 return self.extract_info(ie_result['url'],
713 download,
714 ie_key=ie_result.get('ie_key'),
715 extra_info=extra_info)
7fc3fa05
PH
716 elif result_type == 'url_transparent':
717 # Use the information from the embedding page
718 info = self.extract_info(
719 ie_result['url'], ie_key=ie_result.get('ie_key'),
720 extra_info=extra_info, download=False, process=False)
721
412c617d
PH
722 force_properties = dict(
723 (k, v) for k, v in ie_result.items() if v is not None)
724 for f in ('_type', 'url'):
725 if f in force_properties:
726 del force_properties[f]
727 new_result = info.copy()
728 new_result.update(force_properties)
7fc3fa05
PH
729
730 assert new_result.get('_type') != 'url_transparent'
7fc3fa05
PH
731
732 return self.process_ie_result(
733 new_result, download=download, extra_info=extra_info)
42e12102 734 elif result_type == 'playlist' or result_type == 'multi_video':
8222d8de
JMF
735 # We process each entry in the playlist
736 playlist = ie_result.get('title', None) or ie_result.get('id', None)
6febd1c1 737 self.to_screen('[download] Downloading playlist: %s' % playlist)
8222d8de
JMF
738
739 playlist_results = []
740
8222d8de 741 playliststart = self.params.get('playliststart', 1) - 1
a19fd00c
PH
742 playlistend = self.params.get('playlistend', None)
743 # For backwards compatibility, interpret -1 as whole list
8222d8de 744 if playlistend == -1:
a19fd00c 745 playlistend = None
8222d8de 746
c14e88f0
PH
747 playlistitems_str = self.params.get('playlist_items', None)
748 playlistitems = None
749 if playlistitems_str is not None:
750 def iter_playlistitems(format):
751 for string_segment in format.split(','):
752 if '-' in string_segment:
753 start, end = string_segment.split('-')
754 for item in range(int(start), int(end) + 1):
755 yield int(item)
756 else:
757 yield int(string_segment)
758 playlistitems = iter_playlistitems(playlistitems_str)
759
b82f815f
PH
760 ie_entries = ie_result['entries']
761 if isinstance(ie_entries, list):
762 n_all_entries = len(ie_entries)
c14e88f0
PH
763 if playlistitems:
764 entries = [ie_entries[i - 1] for i in playlistitems]
765 else:
766 entries = ie_entries[playliststart:playlistend]
b7ab0590
PH
767 n_entries = len(entries)
768 self.to_screen(
769 "[%s] playlist %s: Collected %d video ids (downloading %d of them)" %
770 (ie_result['extractor'], playlist, n_all_entries, n_entries))
b82f815f 771 elif isinstance(ie_entries, PagedList):
c14e88f0
PH
772 if playlistitems:
773 entries = []
774 for item in playlistitems:
775 entries.extend(ie_entries.getslice(
776 item - 1, item
777 ))
778 else:
779 entries = ie_entries.getslice(
780 playliststart, playlistend)
b7ab0590
PH
781 n_entries = len(entries)
782 self.to_screen(
783 "[%s] playlist %s: Downloading %d videos" %
784 (ie_result['extractor'], playlist, n_entries))
b82f815f 785 else: # iterable
c14e88f0
PH
786 if playlistitems:
787 entry_list = list(ie_entries)
788 entries = [entry_list[i - 1] for i in playlistitems]
789 else:
790 entries = list(itertools.islice(
791 ie_entries, playliststart, playlistend))
b82f815f
PH
792 n_entries = len(entries)
793 self.to_screen(
794 "[%s] playlist %s: Downloading %d videos" %
795 (ie_result['extractor'], playlist, n_entries))
8222d8de 796
ff815fe6
MS
797 if self.params.get('playlistreverse', False):
798 entries = entries[::-1]
799
fe7e0c98 800 for i, entry in enumerate(entries, 1):
734ea11e 801 self.to_screen('[download] Downloading video %s of %s' % (i, n_entries))
8222d8de 802 extra = {
c6b4132a 803 'n_entries': n_entries,
fe7e0c98 804 'playlist': playlist,
a1cf99d0
PH
805 'playlist_id': ie_result.get('id'),
806 'playlist_title': ie_result.get('title'),
fe7e0c98 807 'playlist_index': i + playliststart,
b6c45014 808 'extractor': ie_result['extractor'],
9103bbc5 809 'webpage_url': ie_result['webpage_url'],
29eb5174 810 'webpage_url_basename': url_basename(ie_result['webpage_url']),
be97abc2 811 'extractor_key': ie_result['extractor_key'],
fe7e0c98 812 }
7012b23c 813
442c37b7 814 reason = self._match_entry(entry, incomplete=True)
7012b23c 815 if reason is not None:
6febd1c1 816 self.to_screen('[download] ' + reason)
7012b23c
PH
817 continue
818
8222d8de
JMF
819 entry_result = self.process_ie_result(entry,
820 download=download,
821 extra_info=extra)
822 playlist_results.append(entry_result)
823 ie_result['entries'] = playlist_results
824 return ie_result
825 elif result_type == 'compat_list':
c9bf4114
PH
826 self.report_warning(
827 'Extractor %s returned a compat_list result. '
828 'It needs to be updated.' % ie_result.get('extractor'))
5f6a1245 829
8222d8de 830 def _fixup(r):
9e1a5b84
JW
831 self.add_extra_info(
832 r,
9103bbc5
JMF
833 {
834 'extractor': ie_result['extractor'],
835 'webpage_url': ie_result['webpage_url'],
29eb5174 836 'webpage_url_basename': url_basename(ie_result['webpage_url']),
be97abc2 837 'extractor_key': ie_result['extractor_key'],
9e1a5b84
JW
838 }
839 )
8222d8de
JMF
840 return r
841 ie_result['entries'] = [
b6c45014 842 self.process_ie_result(_fixup(r), download, extra_info)
8222d8de
JMF
843 for r in ie_result['entries']
844 ]
845 return ie_result
846 else:
847 raise Exception('Invalid result type: %s' % result_type)
848
083c9df9
PH
849 def _apply_format_filter(self, format_spec, available_formats):
850 " Returns a tuple of the remaining format_spec and filtered formats "
851
852 OPERATORS = {
853 '<': operator.lt,
854 '<=': operator.le,
855 '>': operator.gt,
856 '>=': operator.ge,
857 '=': operator.eq,
858 '!=': operator.ne,
859 }
860 operator_rex = re.compile(r'''(?x)\s*\[
2ec19e95 861 (?P<key>width|height|tbr|abr|vbr|asr|filesize|fps)
083c9df9
PH
862 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?\s*
863 (?P<value>[0-9.]+(?:[kKmMgGtTpPeEzZyY]i?[Bb]?)?)
864 \]$
865 ''' % '|'.join(map(re.escape, OPERATORS.keys())))
866 m = operator_rex.search(format_spec)
9ddb6925
S
867 if m:
868 try:
869 comparison_value = int(m.group('value'))
870 except ValueError:
871 comparison_value = parse_filesize(m.group('value'))
872 if comparison_value is None:
873 comparison_value = parse_filesize(m.group('value') + 'B')
874 if comparison_value is None:
875 raise ValueError(
876 'Invalid value %r in format specification %r' % (
877 m.group('value'), format_spec))
878 op = OPERATORS[m.group('op')]
879
083c9df9 880 if not m:
9ddb6925
S
881 STR_OPERATORS = {
882 '=': operator.eq,
883 '!=': operator.ne,
884 }
885 str_operator_rex = re.compile(r'''(?x)\s*\[
886 \s*(?P<key>ext|acodec|vcodec|container|protocol)
887 \s*(?P<op>%s)(?P<none_inclusive>\s*\?)?
888 \s*(?P<value>[a-zA-Z0-9_-]+)
889 \s*\]$
890 ''' % '|'.join(map(re.escape, STR_OPERATORS.keys())))
891 m = str_operator_rex.search(format_spec)
892 if m:
893 comparison_value = m.group('value')
894 op = STR_OPERATORS[m.group('op')]
083c9df9 895
9ddb6925
S
896 if not m:
897 raise ValueError('Invalid format specification %r' % format_spec)
083c9df9
PH
898
899 def _filter(f):
900 actual_value = f.get(m.group('key'))
901 if actual_value is None:
902 return m.group('none_inclusive')
903 return op(actual_value, comparison_value)
904 new_formats = [f for f in available_formats if _filter(f)]
905
906 new_format_spec = format_spec[:-len(m.group(0))]
907 if not new_format_spec:
908 new_format_spec = 'best'
909
910 return (new_format_spec, new_formats)
911
a9c58ad9 912 def select_format(self, format_spec, available_formats):
083c9df9
PH
913 while format_spec.endswith(']'):
914 format_spec, available_formats = self._apply_format_filter(
915 format_spec, available_formats)
916 if not available_formats:
917 return None
918
a9c58ad9
JMF
919 if format_spec == 'best' or format_spec is None:
920 return available_formats[-1]
921 elif format_spec == 'worst':
c36a9595
S
922 audiovideo_formats = [
923 f for f in available_formats
924 if f.get('vcodec') != 'none' and f.get('acodec') != 'none']
925 if audiovideo_formats:
926 return audiovideo_formats[0]
a9c58ad9 927 return available_formats[0]
ba7678f9
PH
928 elif format_spec == 'bestaudio':
929 audio_formats = [
930 f for f in available_formats
931 if f.get('vcodec') == 'none']
932 if audio_formats:
933 return audio_formats[-1]
934 elif format_spec == 'worstaudio':
935 audio_formats = [
936 f for f in available_formats
937 if f.get('vcodec') == 'none']
938 if audio_formats:
939 return audio_formats[0]
bc6d5978
JMF
940 elif format_spec == 'bestvideo':
941 video_formats = [
942 f for f in available_formats
943 if f.get('acodec') == 'none']
944 if video_formats:
945 return video_formats[-1]
946 elif format_spec == 'worstvideo':
947 video_formats = [
948 f for f in available_formats
949 if f.get('acodec') == 'none']
950 if video_formats:
951 return video_formats[0]
a9c58ad9 952 else:
0217c783 953 extensions = ['mp4', 'flv', 'webm', '3gp', 'm4a', 'mp3', 'ogg', 'aac', 'wav']
49e86983
JMF
954 if format_spec in extensions:
955 filter_f = lambda f: f['ext'] == format_spec
956 else:
957 filter_f = lambda f: f['format_id'] == format_spec
fe7e0c98 958 matches = list(filter(filter_f, available_formats))
a9c58ad9
JMF
959 if matches:
960 return matches[-1]
961 return None
962
e5660ee6
JMF
963 def _calc_headers(self, info_dict):
964 res = std_headers.copy()
965
966 add_headers = info_dict.get('http_headers')
967 if add_headers:
968 res.update(add_headers)
969
970 cookies = self._calc_cookies(info_dict)
971 if cookies:
972 res['Cookie'] = cookies
973
974 return res
975
976 def _calc_cookies(self, info_dict):
662435f7 977 pr = compat_urllib_request.Request(info_dict['url'])
e5660ee6 978 self.cookiejar.add_cookie_header(pr)
662435f7 979 return pr.get_header('Cookie')
e5660ee6 980
dd82ffea
JMF
981 def process_video_result(self, info_dict, download=True):
982 assert info_dict.get('_type', 'video') == 'video'
983
bec1fad2
PH
984 if 'id' not in info_dict:
985 raise ExtractorError('Missing "id" field in extractor result')
986 if 'title' not in info_dict:
987 raise ExtractorError('Missing "title" field in extractor result')
988
dd82ffea
JMF
989 if 'playlist' not in info_dict:
990 # It isn't part of a playlist
991 info_dict['playlist'] = None
992 info_dict['playlist_index'] = None
993
d5519808 994 thumbnails = info_dict.get('thumbnails')
cfb56d1a
PH
995 if thumbnails is None:
996 thumbnail = info_dict.get('thumbnail')
997 if thumbnail:
a7a14d95 998 info_dict['thumbnails'] = thumbnails = [{'url': thumbnail}]
d5519808 999 if thumbnails:
be6d7229 1000 thumbnails.sort(key=lambda t: (
cfb56d1a
PH
1001 t.get('preference'), t.get('width'), t.get('height'),
1002 t.get('id'), t.get('url')))
f6c24009 1003 for i, t in enumerate(thumbnails):
d5519808
PH
1004 if 'width' in t and 'height' in t:
1005 t['resolution'] = '%dx%d' % (t['width'], t['height'])
f6c24009
PH
1006 if t.get('id') is None:
1007 t['id'] = '%d' % i
d5519808
PH
1008
1009 if thumbnails and 'thumbnail' not in info_dict:
1010 info_dict['thumbnail'] = thumbnails[-1]['url']
1011
c9ae7b95 1012 if 'display_id' not in info_dict and 'id' in info_dict:
0afef30b
PH
1013 info_dict['display_id'] = info_dict['id']
1014
955c4514 1015 if info_dict.get('upload_date') is None and info_dict.get('timestamp') is not None:
706d7d4e
S
1016 # Working around negative timestamps in Windows
1017 # (see http://bugs.python.org/issue1646728)
1018 if info_dict['timestamp'] < 0 and os.name == 'nt':
1019 info_dict['timestamp'] = 0
9d2ecdbc 1020 upload_date = datetime.datetime.utcfromtimestamp(
955c4514 1021 info_dict['timestamp'])
9d2ecdbc
PH
1022 info_dict['upload_date'] = upload_date.strftime('%Y%m%d')
1023
a504ced0 1024 if self.params.get('listsubtitles', False):
360e1ca5
JMF
1025 if 'automatic_captions' in info_dict:
1026 self.list_subtitles(info_dict['id'], info_dict.get('automatic_captions'), 'automatic captions')
1027 self.list_subtitles(info_dict['id'], info_dict.get('subtitles'), 'subtitles')
a504ced0 1028 return
360e1ca5
JMF
1029 info_dict['requested_subtitles'] = self.process_subtitles(
1030 info_dict['id'], info_dict.get('subtitles'),
1031 info_dict.get('automatic_captions'))
a504ced0 1032
6ff000b8 1033 # This extractors handle format selection themselves
6febd1c1 1034 if info_dict['extractor'] in ['Youku']:
12893efe
JMF
1035 if download:
1036 self.process_info(info_dict)
6ff000b8
JMF
1037 return info_dict
1038
dd82ffea
JMF
1039 # We now pick which formats have to be downloaded
1040 if info_dict.get('formats') is None:
1041 # There's only one format available
1042 formats = [info_dict]
1043 else:
1044 formats = info_dict['formats']
1045
db95dc13
PH
1046 if not formats:
1047 raise ExtractorError('No video formats found!')
1048
dd82ffea 1049 # We check that all the formats have the format and format_id fields
db95dc13 1050 for i, format in enumerate(formats):
bec1fad2
PH
1051 if 'url' not in format:
1052 raise ExtractorError('Missing "url" key in result (index %d)' % i)
1053
dd82ffea 1054 if format.get('format_id') is None:
8016c922 1055 format['format_id'] = compat_str(i)
8c51aa65 1056 if format.get('format') is None:
6febd1c1 1057 format['format'] = '{id} - {res}{note}'.format(
8c51aa65
JMF
1058 id=format['format_id'],
1059 res=self.format_resolution(format),
6febd1c1 1060 note=' ({0})'.format(format['format_note']) if format.get('format_note') is not None else '',
8c51aa65 1061 )
c1002e96
PH
1062 # Automatically determine file extension if missing
1063 if 'ext' not in format:
cce929ea 1064 format['ext'] = determine_ext(format['url']).lower()
e5660ee6
JMF
1065 # Add HTTP headers, so that external programs can use them from the
1066 # json output
1067 full_format_info = info_dict.copy()
1068 full_format_info.update(format)
1069 format['http_headers'] = self._calc_headers(full_format_info)
dd82ffea 1070
99e206d5
JMF
1071 format_limit = self.params.get('format_limit', None)
1072 if format_limit:
f4d96df0
PH
1073 formats = list(takewhile_inclusive(
1074 lambda f: f['format_id'] != format_limit, formats
1075 ))
4bcc7bd1
PH
1076
1077 # TODO Central sorting goes here
99e206d5 1078
f89197d7 1079 if formats[0] is not info_dict:
b3d9ef88
JMF
1080 # only set the 'formats' fields if the original info_dict list them
1081 # otherwise we end up with a circular reference, the first (and unique)
f89197d7 1082 # element in the 'formats' field in info_dict is info_dict itself,
b3d9ef88
JMF
1083 # wich can't be exported to json
1084 info_dict['formats'] = formats
cfb56d1a 1085 if self.params.get('listformats'):
bfaae0a7 1086 self.list_formats(info_dict)
1087 return
cfb56d1a
PH
1088 if self.params.get('list_thumbnails'):
1089 self.list_thumbnails(info_dict)
1090 return
bfaae0a7 1091
de3ef3ed 1092 req_format = self.params.get('format')
a9c58ad9
JMF
1093 if req_format is None:
1094 req_format = 'best'
dd82ffea 1095 formats_to_download = []
3a77719c 1096 if req_format == 'all':
dd82ffea
JMF
1097 formats_to_download = formats
1098 else:
1de33faf
PH
1099 for rfstr in req_format.split(','):
1100 # We can accept formats requested in the format: 34/5/best, we pick
1101 # the first that is available, starting from left
1102 req_formats = rfstr.split('/')
1103 for rf in req_formats:
1104 if re.match(r'.+?\+.+?', rf) is not None:
1105 # Two formats have been requested like '137+139'
1106 format_1, format_2 = rf.split('+')
1107 formats_info = (self.select_format(format_1, formats),
9e1a5b84 1108 self.select_format(format_2, formats))
1de33faf 1109 if all(formats_info):
c2954908
JMF
1110 # The first format must contain the video and the
1111 # second the audio
1112 if formats_info[0].get('vcodec') == 'none':
1113 self.report_error('The first format must '
9e1a5b84
JW
1114 'contain the video, try using '
1115 '"-f %s+%s"' % (format_2, format_1))
c2954908 1116 return
45598f15
PH
1117 output_ext = (
1118 formats_info[0]['ext']
1119 if self.params.get('merge_output_format') is None
1120 else self.params['merge_output_format'])
1de33faf
PH
1121 selected_format = {
1122 'requested_formats': formats_info,
300753a0
S
1123 'format': '%s+%s' % (formats_info[0].get('format'),
1124 formats_info[1].get('format')),
6d593c32
S
1125 'format_id': '%s+%s' % (formats_info[0].get('format_id'),
1126 formats_info[1].get('format_id')),
f90ad273
PH
1127 'width': formats_info[0].get('width'),
1128 'height': formats_info[0].get('height'),
1129 'resolution': formats_info[0].get('resolution'),
1130 'fps': formats_info[0].get('fps'),
1131 'vcodec': formats_info[0].get('vcodec'),
1132 'vbr': formats_info[0].get('vbr'),
6271f1ca 1133 'stretched_ratio': formats_info[0].get('stretched_ratio'),
f90ad273
PH
1134 'acodec': formats_info[1].get('acodec'),
1135 'abr': formats_info[1].get('abr'),
45598f15 1136 'ext': output_ext,
1de33faf
PH
1137 }
1138 else:
1139 selected_format = None
6350728b 1140 else:
1de33faf
PH
1141 selected_format = self.select_format(rf, formats)
1142 if selected_format is not None:
1143 formats_to_download.append(selected_format)
1144 break
dd82ffea 1145 if not formats_to_download:
6febd1c1 1146 raise ExtractorError('requested format not available',
78a3a9f8 1147 expected=True)
dd82ffea
JMF
1148
1149 if download:
1150 if len(formats_to_download) > 1:
6febd1c1 1151 self.to_screen('[info] %s: downloading video in %s formats' % (info_dict['id'], len(formats_to_download)))
dd82ffea
JMF
1152 for format in formats_to_download:
1153 new_info = dict(info_dict)
1154 new_info.update(format)
1155 self.process_info(new_info)
1156 # We update the info dict with the best quality format (backwards compatibility)
1157 info_dict.update(formats_to_download[-1])
1158 return info_dict
1159
98c70d6f 1160 def process_subtitles(self, video_id, normal_subtitles, automatic_captions):
a504ced0 1161 """Select the requested subtitles and their format"""
98c70d6f
JMF
1162 available_subs = {}
1163 if normal_subtitles and self.params.get('writesubtitles'):
1164 available_subs.update(normal_subtitles)
1165 if automatic_captions and self.params.get('writeautomaticsub'):
1166 for lang, cap_info in automatic_captions.items():
360e1ca5
JMF
1167 if lang not in available_subs:
1168 available_subs[lang] = cap_info
1169
4d171848
JMF
1170 if (not self.params.get('writesubtitles') and not
1171 self.params.get('writeautomaticsub') or not
1172 available_subs):
1173 return None
a504ced0
JMF
1174
1175 if self.params.get('allsubtitles', False):
1176 requested_langs = available_subs.keys()
1177 else:
1178 if self.params.get('subtitleslangs', False):
1179 requested_langs = self.params.get('subtitleslangs')
1180 elif 'en' in available_subs:
1181 requested_langs = ['en']
1182 else:
1183 requested_langs = [list(available_subs.keys())[0]]
1184
1185 formats_query = self.params.get('subtitlesformat', 'best')
1186 formats_preference = formats_query.split('/') if formats_query else []
1187 subs = {}
1188 for lang in requested_langs:
1189 formats = available_subs.get(lang)
1190 if formats is None:
1191 self.report_warning('%s subtitles not available for %s' % (lang, video_id))
1192 continue
a504ced0
JMF
1193 for ext in formats_preference:
1194 if ext == 'best':
1195 f = formats[-1]
1196 break
1197 matches = list(filter(lambda f: f['ext'] == ext, formats))
1198 if matches:
1199 f = matches[-1]
1200 break
1201 else:
1202 f = formats[-1]
1203 self.report_warning(
1204 'No subtitle format found matching "%s" for language %s, '
1205 'using %s' % (formats_query, lang, f['ext']))
1206 subs[lang] = f
1207 return subs
1208
8222d8de
JMF
1209 def process_info(self, info_dict):
1210 """Process a single resolved IE result."""
1211
1212 assert info_dict.get('_type', 'video') == 'video'
fd288278
PH
1213
1214 max_downloads = self.params.get('max_downloads')
1215 if max_downloads is not None:
1216 if self._num_downloads >= int(max_downloads):
1217 raise MaxDownloadsReached()
8222d8de
JMF
1218
1219 info_dict['fulltitle'] = info_dict['title']
1220 if len(info_dict['title']) > 200:
6febd1c1 1221 info_dict['title'] = info_dict['title'][:197] + '...'
8222d8de 1222
11b85ce6 1223 if 'format' not in info_dict:
8222d8de
JMF
1224 info_dict['format'] = info_dict['ext']
1225
442c37b7 1226 reason = self._match_entry(info_dict, incomplete=False)
8222d8de 1227 if reason is not None:
6febd1c1 1228 self.to_screen('[download] ' + reason)
8222d8de
JMF
1229 return
1230
fd288278 1231 self._num_downloads += 1
8222d8de 1232
e72c7e41 1233 info_dict['_filename'] = filename = self.prepare_filename(info_dict)
8222d8de
JMF
1234
1235 # Forced printings
1236 if self.params.get('forcetitle', False):
0783b09b 1237 self.to_stdout(info_dict['fulltitle'])
8222d8de 1238 if self.params.get('forceid', False):
0783b09b 1239 self.to_stdout(info_dict['id'])
8222d8de 1240 if self.params.get('forceurl', False):
16ae61f6 1241 if info_dict.get('requested_formats') is not None:
1242 for f in info_dict['requested_formats']:
1243 self.to_stdout(f['url'] + f.get('play_path', ''))
1244 else:
1245 # For RTMP URLs, also include the playpath
1246 self.to_stdout(info_dict['url'] + info_dict.get('play_path', ''))
216d71d0 1247 if self.params.get('forcethumbnail', False) and info_dict.get('thumbnail') is not None:
0783b09b 1248 self.to_stdout(info_dict['thumbnail'])
216d71d0 1249 if self.params.get('forcedescription', False) and info_dict.get('description') is not None:
0783b09b 1250 self.to_stdout(info_dict['description'])
8222d8de 1251 if self.params.get('forcefilename', False) and filename is not None:
0783b09b 1252 self.to_stdout(filename)
525ef922
PH
1253 if self.params.get('forceduration', False) and info_dict.get('duration') is not None:
1254 self.to_stdout(formatSeconds(info_dict['duration']))
8222d8de 1255 if self.params.get('forceformat', False):
0783b09b 1256 self.to_stdout(info_dict['format'])
9d153818 1257 if self.params.get('forcejson', False):
0783b09b 1258 self.to_stdout(json.dumps(info_dict))
8222d8de
JMF
1259
1260 # Do nothing else if in simulate mode
1261 if self.params.get('simulate', False):
1262 return
1263
1264 if filename is None:
1265 return
1266
1267 try:
e5a11a22 1268 dn = os.path.dirname(sanitize_path(encodeFilename(filename)))
d26e981d 1269 if dn and not os.path.exists(dn):
8222d8de
JMF
1270 os.makedirs(dn)
1271 except (OSError, IOError) as err:
6febd1c1 1272 self.report_error('unable to create directory ' + compat_str(err))
8222d8de
JMF
1273 return
1274
1275 if self.params.get('writedescription', False):
6febd1c1 1276 descfn = filename + '.description'
7b6fefc9 1277 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(descfn)):
6febd1c1 1278 self.to_screen('[info] Video description is already present')
f00fd51d
JMF
1279 elif info_dict.get('description') is None:
1280 self.report_warning('There\'s no description to write.')
7b6fefc9
PH
1281 else:
1282 try:
6febd1c1 1283 self.to_screen('[info] Writing video description to: ' + descfn)
7b6fefc9
PH
1284 with io.open(encodeFilename(descfn), 'w', encoding='utf-8') as descfile:
1285 descfile.write(info_dict['description'])
7b6fefc9 1286 except (OSError, IOError):
6febd1c1 1287 self.report_error('Cannot write description file ' + descfn)
7b6fefc9 1288 return
8222d8de 1289
1fb07d10 1290 if self.params.get('writeannotations', False):
6febd1c1 1291 annofn = filename + '.annotations.xml'
7b6fefc9 1292 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(annofn)):
6febd1c1 1293 self.to_screen('[info] Video annotations are already present')
7b6fefc9
PH
1294 else:
1295 try:
6febd1c1 1296 self.to_screen('[info] Writing video annotations to: ' + annofn)
7b6fefc9
PH
1297 with io.open(encodeFilename(annofn), 'w', encoding='utf-8') as annofile:
1298 annofile.write(info_dict['annotations'])
1299 except (KeyError, TypeError):
6febd1c1 1300 self.report_warning('There are no annotations to write.')
7b6fefc9 1301 except (OSError, IOError):
6febd1c1 1302 self.report_error('Cannot write annotations file: ' + annofn)
7b6fefc9 1303 return
1fb07d10 1304
c4a91be7 1305 subtitles_are_requested = any([self.params.get('writesubtitles', False),
0b7f3118 1306 self.params.get('writeautomaticsub')])
c4a91be7 1307
c84dd8a9 1308 if subtitles_are_requested and info_dict.get('requested_subtitles'):
8222d8de
JMF
1309 # subtitles download errors are already managed as troubles in relevant IE
1310 # that way it will silently go on when used with unsupporting IE
c84dd8a9 1311 subtitles = info_dict['requested_subtitles']
0f2c0d33 1312 ie = self.get_info_extractor(info_dict['extractor_key'])
a504ced0
JMF
1313 for sub_lang, sub_info in subtitles.items():
1314 sub_format = sub_info['ext']
1315 if sub_info.get('data') is not None:
1316 sub_data = sub_info['data']
1317 else:
1318 try:
0f2c0d33
JMF
1319 sub_data = ie._download_webpage(
1320 sub_info['url'], info_dict['id'], note=False)
1321 except ExtractorError as err:
a504ced0 1322 self.report_warning('Unable to download subtitle for "%s": %s' %
0f2c0d33 1323 (sub_lang, compat_str(err.cause)))
a504ced0 1324 continue
8222d8de 1325 try:
d4051a8e 1326 sub_filename = subtitles_filename(filename, sub_lang, sub_format)
7b6fefc9 1327 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(sub_filename)):
6febd1c1 1328 self.to_screen('[info] Video subtitle %s.%s is already_present' % (sub_lang, sub_format))
7b6fefc9 1329 else:
6febd1c1 1330 self.to_screen('[info] Writing video subtitles to: ' + sub_filename)
7b6fefc9 1331 with io.open(encodeFilename(sub_filename), 'w', encoding='utf-8') as subfile:
a504ced0 1332 subfile.write(sub_data)
8222d8de 1333 except (OSError, IOError):
e4db1951 1334 self.report_error('Cannot write subtitles file ' + sub_filename)
8222d8de
JMF
1335 return
1336
8222d8de 1337 if self.params.get('writeinfojson', False):
6febd1c1 1338 infofn = os.path.splitext(filename)[0] + '.info.json'
7b6fefc9 1339 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(infofn)):
6febd1c1 1340 self.to_screen('[info] Video description metadata is already present')
7b6fefc9 1341 else:
6febd1c1 1342 self.to_screen('[info] Writing video description metadata as JSON to: ' + infofn)
7b6fefc9 1343 try:
92120217 1344 write_json_file(info_dict, infofn)
7b6fefc9 1345 except (OSError, IOError):
6febd1c1 1346 self.report_error('Cannot write metadata to JSON file ' + infofn)
7b6fefc9 1347 return
8222d8de 1348
ec82d85a 1349 self._write_thumbnails(info_dict, filename)
8222d8de
JMF
1350
1351 if not self.params.get('skip_download', False):
4340deca
P
1352 try:
1353 def dl(name, info):
a055469f 1354 fd = get_suitable_downloader(info, self.params)(self, self.params)
4340deca
P
1355 for ph in self._progress_hooks:
1356 fd.add_progress_hook(ph)
1357 if self.params.get('verbose'):
1358 self.to_stdout('[debug] Invoking downloader on %r' % info.get('url'))
1359 return fd.download(name, info)
ee69b99a 1360
4340deca
P
1361 if info_dict.get('requested_formats') is not None:
1362 downloaded = []
1363 success = True
d47aeb22 1364 merger = FFmpegMergerPP(self)
f740fae2 1365 if not merger.available:
4340deca
P
1366 postprocessors = []
1367 self.report_warning('You have requested multiple '
1368 'formats but ffmpeg or avconv are not installed.'
1369 ' The formats won\'t be merged')
6350728b 1370 else:
4340deca
P
1371 postprocessors = [merger]
1372 for f in info_dict['requested_formats']:
1373 new_info = dict(info_dict)
1374 new_info.update(f)
1375 fname = self.prepare_filename(new_info)
1376 fname = prepend_extension(fname, 'f%s' % f['format_id'])
1377 downloaded.append(fname)
1378 partial_success = dl(fname, new_info)
1379 success = success and partial_success
1380 info_dict['__postprocessors'] = postprocessors
1381 info_dict['__files_to_merge'] = downloaded
1382 else:
1383 # Just a single file
1384 success = dl(filename, info_dict)
1385 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1386 self.report_error('unable to download video data: %s' % str(err))
1387 return
1388 except (OSError, IOError) as err:
1389 raise UnavailableVideoError(err)
1390 except (ContentTooShortError, ) as err:
1391 self.report_error('content too short (expected %s bytes and served %s)' % (err.expected, err.downloaded))
1392 return
8222d8de
JMF
1393
1394 if success:
6271f1ca 1395 # Fixup content
62cd676c
PH
1396 fixup_policy = self.params.get('fixup')
1397 if fixup_policy is None:
1398 fixup_policy = 'detect_or_warn'
1399
6271f1ca
PH
1400 stretched_ratio = info_dict.get('stretched_ratio')
1401 if stretched_ratio is not None and stretched_ratio != 1:
6271f1ca
PH
1402 if fixup_policy == 'warn':
1403 self.report_warning('%s: Non-uniform pixel ratio (%s)' % (
1404 info_dict['id'], stretched_ratio))
1405 elif fixup_policy == 'detect_or_warn':
1406 stretched_pp = FFmpegFixupStretchedPP(self)
1407 if stretched_pp.available:
1408 info_dict.setdefault('__postprocessors', [])
1409 info_dict['__postprocessors'].append(stretched_pp)
1410 else:
1411 self.report_warning(
1412 '%s: Non-uniform pixel ratio (%s). Install ffmpeg or avconv to fix this automatically.' % (
1413 info_dict['id'], stretched_ratio))
1414 else:
62cd676c
PH
1415 assert fixup_policy in ('ignore', 'never')
1416
1417 if info_dict.get('requested_formats') is None and info_dict.get('container') == 'm4a_dash':
1418 if fixup_policy == 'warn':
1419 self.report_warning('%s: writing DASH m4a. Only some players support this container.' % (
1420 info_dict['id']))
1421 elif fixup_policy == 'detect_or_warn':
1422 fixup_pp = FFmpegFixupM4aPP(self)
1423 if fixup_pp.available:
1424 info_dict.setdefault('__postprocessors', [])
1425 info_dict['__postprocessors'].append(fixup_pp)
1426 else:
1427 self.report_warning(
1428 '%s: writing DASH m4a. Only some players support this container. Install ffmpeg or avconv to fix this automatically.' % (
1429 info_dict['id']))
1430 else:
1431 assert fixup_policy in ('ignore', 'never')
6271f1ca 1432
8222d8de
JMF
1433 try:
1434 self.post_process(filename, info_dict)
1435 except (PostProcessingError) as err:
6febd1c1 1436 self.report_error('postprocessing: %s' % str(err))
8222d8de 1437 return
cd58dc3e 1438 self.record_download_archive(info_dict)
8222d8de
JMF
1439
1440 def download(self, url_list):
1441 """Download a given list of URLs."""
acd69589 1442 outtmpl = self.params.get('outtmpl', DEFAULT_OUTTMPL)
0c75c3fa 1443 if (len(url_list) > 1 and
8fb3ac36
PH
1444 '%' not in outtmpl and
1445 self.params.get('max_downloads') != 1):
acd69589 1446 raise SameFileError(outtmpl)
8222d8de
JMF
1447
1448 for url in url_list:
1449 try:
5f6a1245 1450 # It also downloads the videos
63e0be34 1451 res = self.extract_info(url)
8222d8de 1452 except UnavailableVideoError:
6febd1c1 1453 self.report_error('unable to download video')
8222d8de 1454 except MaxDownloadsReached:
6febd1c1 1455 self.to_screen('[info] Maximum number of downloaded files reached.')
8222d8de 1456 raise
63e0be34
PH
1457 else:
1458 if self.params.get('dump_single_json', False):
1459 self.to_stdout(json.dumps(res))
8222d8de
JMF
1460
1461 return self._download_retcode
1462
1dcc4c0c 1463 def download_with_info_file(self, info_filename):
31bd3925
JMF
1464 with contextlib.closing(fileinput.FileInput(
1465 [info_filename], mode='r',
1466 openhook=fileinput.hook_encoded('utf-8'))) as f:
1467 # FileInput doesn't have a read method, we can't call json.load
1468 info = json.loads('\n'.join(f))
d4943898
JMF
1469 try:
1470 self.process_ie_result(info, download=True)
1471 except DownloadError:
1472 webpage_url = info.get('webpage_url')
1473 if webpage_url is not None:
6febd1c1 1474 self.report_warning('The info failed to download, trying with "%s"' % webpage_url)
d4943898
JMF
1475 return self.download([webpage_url])
1476 else:
1477 raise
1478 return self._download_retcode
1dcc4c0c 1479
8222d8de
JMF
1480 def post_process(self, filename, ie_info):
1481 """Run all the postprocessors on the given file."""
1482 info = dict(ie_info)
1483 info['filepath'] = filename
6350728b
JMF
1484 pps_chain = []
1485 if ie_info.get('__postprocessors') is not None:
1486 pps_chain.extend(ie_info['__postprocessors'])
1487 pps_chain.extend(self._pps)
1488 for pp in pps_chain:
f3ff1a36 1489 old_filename = info['filepath']
8222d8de 1490 try:
592e97e8 1491 files_to_delete, info = pp.run(info)
8222d8de 1492 except PostProcessingError as e:
bbcbf4d4 1493 self.report_error(e.msg)
592e97e8
JMF
1494 if files_to_delete and not self.params.get('keepvideo', False):
1495 for old_filename in files_to_delete:
f3ff1a36 1496 self.to_screen('Deleting original file %s (pass -k to keep)' % old_filename)
592e97e8
JMF
1497 try:
1498 os.remove(encodeFilename(old_filename))
1499 except (IOError, OSError):
1500 self.report_warning('Unable to remove downloaded original file')
c1c9a79c 1501
5db07df6
PH
1502 def _make_archive_id(self, info_dict):
1503 # Future-proof against any change in case
1504 # and backwards compatibility with prior versions
d31209a1 1505 extractor = info_dict.get('extractor_key')
7012b23c
PH
1506 if extractor is None:
1507 if 'id' in info_dict:
1508 extractor = info_dict.get('ie_key') # key in a playlist
1509 if extractor is None:
5db07df6 1510 return None # Incomplete video information
6febd1c1 1511 return extractor.lower() + ' ' + info_dict['id']
5db07df6
PH
1512
1513 def in_download_archive(self, info_dict):
1514 fn = self.params.get('download_archive')
1515 if fn is None:
1516 return False
1517
1518 vid_id = self._make_archive_id(info_dict)
1519 if vid_id is None:
7012b23c 1520 return False # Incomplete video information
5db07df6 1521
c1c9a79c
PH
1522 try:
1523 with locked_file(fn, 'r', encoding='utf-8') as archive_file:
1524 for line in archive_file:
1525 if line.strip() == vid_id:
1526 return True
1527 except IOError as ioe:
1528 if ioe.errno != errno.ENOENT:
1529 raise
1530 return False
1531
1532 def record_download_archive(self, info_dict):
1533 fn = self.params.get('download_archive')
1534 if fn is None:
1535 return
5db07df6
PH
1536 vid_id = self._make_archive_id(info_dict)
1537 assert vid_id
c1c9a79c 1538 with locked_file(fn, 'a', encoding='utf-8') as archive_file:
6febd1c1 1539 archive_file.write(vid_id + '\n')
dd82ffea 1540
8c51aa65 1541 @staticmethod
8abeeb94 1542 def format_resolution(format, default='unknown'):
fb04e403
PH
1543 if format.get('vcodec') == 'none':
1544 return 'audio only'
f49d89ee
PH
1545 if format.get('resolution') is not None:
1546 return format['resolution']
8c51aa65
JMF
1547 if format.get('height') is not None:
1548 if format.get('width') is not None:
6febd1c1 1549 res = '%sx%s' % (format['width'], format['height'])
8c51aa65 1550 else:
6febd1c1 1551 res = '%sp' % format['height']
f49d89ee 1552 elif format.get('width') is not None:
6febd1c1 1553 res = '?x%d' % format['width']
8c51aa65 1554 else:
8abeeb94 1555 res = default
8c51aa65
JMF
1556 return res
1557
c57f7757
PH
1558 def _format_note(self, fdict):
1559 res = ''
1560 if fdict.get('ext') in ['f4f', 'f4m']:
1561 res += '(unsupported) '
1562 if fdict.get('format_note') is not None:
1563 res += fdict['format_note'] + ' '
1564 if fdict.get('tbr') is not None:
1565 res += '%4dk ' % fdict['tbr']
1566 if fdict.get('container') is not None:
1567 if res:
1568 res += ', '
1569 res += '%s container' % fdict['container']
1570 if (fdict.get('vcodec') is not None and
1571 fdict.get('vcodec') != 'none'):
1572 if res:
1573 res += ', '
1574 res += fdict['vcodec']
91c7271a 1575 if fdict.get('vbr') is not None:
c57f7757
PH
1576 res += '@'
1577 elif fdict.get('vbr') is not None and fdict.get('abr') is not None:
1578 res += 'video@'
1579 if fdict.get('vbr') is not None:
1580 res += '%4dk' % fdict['vbr']
fbb21cf5
PH
1581 if fdict.get('fps') is not None:
1582 res += ', %sfps' % fdict['fps']
c57f7757
PH
1583 if fdict.get('acodec') is not None:
1584 if res:
1585 res += ', '
1586 if fdict['acodec'] == 'none':
1587 res += 'video only'
1588 else:
1589 res += '%-5s' % fdict['acodec']
1590 elif fdict.get('abr') is not None:
1591 if res:
1592 res += ', '
1593 res += 'audio'
1594 if fdict.get('abr') is not None:
1595 res += '@%3dk' % fdict['abr']
1596 if fdict.get('asr') is not None:
1597 res += ' (%5dHz)' % fdict['asr']
1598 if fdict.get('filesize') is not None:
1599 if res:
1600 res += ', '
1601 res += format_bytes(fdict['filesize'])
9732d77e
PH
1602 elif fdict.get('filesize_approx') is not None:
1603 if res:
1604 res += ', '
1605 res += '~' + format_bytes(fdict['filesize_approx'])
c57f7757 1606 return res
91c7271a 1607
c57f7757 1608 def list_formats(self, info_dict):
94badb25 1609 formats = info_dict.get('formats', [info_dict])
b81a359e
PH
1610 table = [
1611 [f['format_id'], f['ext'], self.format_resolution(f), self._format_note(f)]
1612 for f in formats
e65566a9 1613 if f.get('preference') is None or f['preference'] >= -1000]
94badb25 1614 if len(formats) > 1:
b81a359e 1615 table[-1][-1] += (' ' if table[-1][-1] else '') + '(best)'
57dd9a8f 1616
b81a359e 1617 header_line = ['format code', 'extension', 'resolution', 'note']
cfb56d1a 1618 self.to_screen(
b81a359e
PH
1619 '[info] Available formats for %s:\n%s' %
1620 (info_dict['id'], render_table(header_line, table)))
cfb56d1a
PH
1621
1622 def list_thumbnails(self, info_dict):
1623 thumbnails = info_dict.get('thumbnails')
1624 if not thumbnails:
1625 tn_url = info_dict.get('thumbnail')
1626 if tn_url:
1627 thumbnails = [{'id': '0', 'url': tn_url}]
1628 else:
1629 self.to_screen(
1630 '[info] No thumbnails present for %s' % info_dict['id'])
1631 return
1632
1633 self.to_screen(
1634 '[info] Thumbnails for %s:' % info_dict['id'])
1635 self.to_screen(render_table(
1636 ['ID', 'width', 'height', 'URL'],
1637 [[t['id'], t.get('width', 'unknown'), t.get('height', 'unknown'), t['url']] for t in thumbnails]))
dca08720 1638
360e1ca5 1639 def list_subtitles(self, video_id, subtitles, name='subtitles'):
a504ced0 1640 if not subtitles:
360e1ca5 1641 self.to_screen('%s has no %s' % (video_id, name))
a504ced0 1642 return
a504ced0 1643 self.to_screen(
edab9dbf
JMF
1644 'Available %s for %s:' % (name, video_id))
1645 self.to_screen(render_table(
1646 ['Language', 'formats'],
1647 [[lang, ', '.join(f['ext'] for f in reversed(formats))]
1648 for lang, formats in subtitles.items()]))
a504ced0 1649
dca08720
PH
1650 def urlopen(self, req):
1651 """ Start an HTTP download """
37419b4f 1652
d05cfe06
S
1653 # According to RFC 3986, URLs can not contain non-ASCII characters, however this is not
1654 # always respected by websites, some tend to give out URLs with non percent-encoded
1655 # non-ASCII characters (see telemb.py, ard.py [#3412])
37419b4f 1656 # urllib chokes on URLs with non-ASCII characters (see http://bugs.python.org/issue3991)
d05cfe06
S
1657 # To work around aforementioned issue we will replace request's original URL with
1658 # percent-encoded one
8f9312c3 1659 req_is_string = isinstance(req, compat_basestring)
68b09730 1660 url = req if req_is_string else req.get_full_url()
d05cfe06 1661 url_escaped = escape_url(url)
37419b4f
S
1662
1663 # Substitute URL if any change after escaping
1664 if url != url_escaped:
68b09730 1665 if req_is_string:
37419b4f
S
1666 req = url_escaped
1667 else:
1668 req = compat_urllib_request.Request(
1669 url_escaped, data=req.data, headers=req.headers,
1670 origin_req_host=req.origin_req_host, unverifiable=req.unverifiable)
1671
19a41fc6 1672 return self._opener.open(req, timeout=self._socket_timeout)
dca08720
PH
1673
1674 def print_debug_header(self):
1675 if not self.params.get('verbose'):
1676 return
62fec3b2 1677
4192b51c
PH
1678 if type('') is not compat_str:
1679 # Python 2.6 on SLES11 SP1 (https://github.com/rg3/youtube-dl/issues/3326)
1680 self.report_warning(
1681 'Your Python is broken! Update to a newer and supported version')
1682
c6afed48
PH
1683 stdout_encoding = getattr(
1684 sys.stdout, 'encoding', 'missing (%s)' % type(sys.stdout).__name__)
b0472057 1685 encoding_str = (
734f90bb
PH
1686 '[debug] Encodings: locale %s, fs %s, out %s, pref %s\n' % (
1687 locale.getpreferredencoding(),
1688 sys.getfilesystemencoding(),
c6afed48 1689 stdout_encoding,
b0472057 1690 self.get_encoding()))
4192b51c 1691 write_string(encoding_str, encoding=None)
734f90bb
PH
1692
1693 self._write_string('[debug] youtube-dl version ' + __version__ + '\n')
dca08720
PH
1694 try:
1695 sp = subprocess.Popen(
1696 ['git', 'rev-parse', '--short', 'HEAD'],
1697 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
1698 cwd=os.path.dirname(os.path.abspath(__file__)))
1699 out, err = sp.communicate()
1700 out = out.decode().strip()
1701 if re.match('[0-9a-f]+', out):
734f90bb 1702 self._write_string('[debug] Git HEAD: ' + out + '\n')
70a1165b 1703 except Exception:
dca08720
PH
1704 try:
1705 sys.exc_clear()
70a1165b 1706 except Exception:
dca08720 1707 pass
d28b5171
PH
1708 self._write_string('[debug] Python version %s - %s\n' % (
1709 platform.python_version(), platform_name()))
1710
73fac4e9 1711 exe_versions = FFmpegPostProcessor.get_versions(self)
4c83c967 1712 exe_versions['rtmpdump'] = rtmpdump_version()
d28b5171
PH
1713 exe_str = ', '.join(
1714 '%s %s' % (exe, v)
1715 for exe, v in sorted(exe_versions.items())
1716 if v
1717 )
1718 if not exe_str:
1719 exe_str = 'none'
1720 self._write_string('[debug] exe versions: %s\n' % exe_str)
dca08720
PH
1721
1722 proxy_map = {}
1723 for handler in self._opener.handlers:
1724 if hasattr(handler, 'proxies'):
1725 proxy_map.update(handler.proxies)
734f90bb 1726 self._write_string('[debug] Proxy map: ' + compat_str(proxy_map) + '\n')
dca08720 1727
58b1f00d
PH
1728 if self.params.get('call_home', False):
1729 ipaddr = self.urlopen('https://yt-dl.org/ip').read().decode('utf-8')
1730 self._write_string('[debug] Public IP address: %s\n' % ipaddr)
1731 latest_version = self.urlopen(
1732 'https://yt-dl.org/latest/version').read().decode('utf-8')
1733 if version_tuple(latest_version) > version_tuple(__version__):
1734 self.report_warning(
1735 'You are using an outdated version (newest version: %s)! '
1736 'See https://yt-dl.org/update if you need help updating.' %
1737 latest_version)
1738
e344693b 1739 def _setup_opener(self):
6ad14cab 1740 timeout_val = self.params.get('socket_timeout')
19a41fc6 1741 self._socket_timeout = 600 if timeout_val is None else float(timeout_val)
6ad14cab 1742
dca08720
PH
1743 opts_cookiefile = self.params.get('cookiefile')
1744 opts_proxy = self.params.get('proxy')
1745
1746 if opts_cookiefile is None:
1747 self.cookiejar = compat_cookiejar.CookieJar()
1748 else:
1749 self.cookiejar = compat_cookiejar.MozillaCookieJar(
1750 opts_cookiefile)
1751 if os.access(opts_cookiefile, os.R_OK):
1752 self.cookiejar.load()
1753
1754 cookie_processor = compat_urllib_request.HTTPCookieProcessor(
1755 self.cookiejar)
1756 if opts_proxy is not None:
1757 if opts_proxy == '':
1758 proxies = {}
1759 else:
1760 proxies = {'http': opts_proxy, 'https': opts_proxy}
1761 else:
1762 proxies = compat_urllib_request.getproxies()
1763 # Set HTTPS proxy to HTTP one if given (https://github.com/rg3/youtube-dl/issues/805)
1764 if 'http' in proxies and 'https' not in proxies:
1765 proxies['https'] = proxies['http']
91410c9b 1766 proxy_handler = PerRequestProxyHandler(proxies)
a0ddb8a2
PH
1767
1768 debuglevel = 1 if self.params.get('debug_printtraffic') else 0
be4a824d
PH
1769 https_handler = make_HTTPS_handler(self.params, debuglevel=debuglevel)
1770 ydlh = YoutubeDLHandler(self.params, debuglevel=debuglevel)
dca08720 1771 opener = compat_urllib_request.build_opener(
2461f79d
PH
1772 proxy_handler, https_handler, cookie_processor, ydlh)
1773
dca08720
PH
1774 # Delete the default user-agent header, which would otherwise apply in
1775 # cases where our custom HTTP handler doesn't come into play
1776 # (See https://github.com/rg3/youtube-dl/issues/1309 for details)
1777 opener.addheaders = []
1778 self._opener = opener
62fec3b2
PH
1779
1780 def encode(self, s):
1781 if isinstance(s, bytes):
1782 return s # Already encoded
1783
1784 try:
1785 return s.encode(self.get_encoding())
1786 except UnicodeEncodeError as err:
1787 err.reason = err.reason + '. Check your system encoding configuration or use the --encoding option.'
1788 raise
1789
1790 def get_encoding(self):
1791 encoding = self.params.get('encoding')
1792 if encoding is None:
1793 encoding = preferredencoding()
1794 return encoding
ec82d85a
PH
1795
1796 def _write_thumbnails(self, info_dict, filename):
1797 if self.params.get('writethumbnail', False):
1798 thumbnails = info_dict.get('thumbnails')
1799 if thumbnails:
1800 thumbnails = [thumbnails[-1]]
1801 elif self.params.get('write_all_thumbnails', False):
1802 thumbnails = info_dict.get('thumbnails')
1803 else:
1804 return
1805
1806 if not thumbnails:
1807 # No thumbnails present, so return immediately
1808 return
1809
1810 for t in thumbnails:
1811 thumb_ext = determine_ext(t['url'], 'jpg')
1812 suffix = '_%s' % t['id'] if len(thumbnails) > 1 else ''
1813 thumb_display_id = '%s ' % t['id'] if len(thumbnails) > 1 else ''
1814 thumb_filename = os.path.splitext(filename)[0] + suffix + '.' + thumb_ext
1815
1816 if self.params.get('nooverwrites', False) and os.path.exists(encodeFilename(thumb_filename)):
1817 self.to_screen('[%s] %s: Thumbnail %sis already present' %
1818 (info_dict['extractor'], info_dict['id'], thumb_display_id))
1819 else:
1820 self.to_screen('[%s] %s: Downloading thumbnail %s...' %
1821 (info_dict['extractor'], info_dict['id'], thumb_display_id))
1822 try:
1823 uf = self.urlopen(t['url'])
1824 with open(thumb_filename, 'wb') as thumbf:
1825 shutil.copyfileobj(uf, thumbf)
1826 self.to_screen('[%s] %s: Writing thumbnail %sto: %s' %
1827 (info_dict['extractor'], info_dict['id'], thumb_display_id, thumb_filename))
1828 except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
1829 self.report_warning('Unable to download thumbnail "%s": %s' %
1830 (t['url'], compat_str(err)))