]> jfr.im git - yt-dlp.git/blame - youtube_dl/__init__.py
[ninegag] Modernize and remove unused import
[yt-dlp.git] / youtube_dl / __init__.py
CommitLineData
235b3ba4
PH
1#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3
3906e6ce 4__authors__ = (
59ae15a5
PH
5 'Ricardo Garcia Gonzalez',
6 'Danny Colligan',
7 'Benjamin Johnson',
8 'Vasyl\' Vavrychuk',
9 'Witold Baryluk',
10 'Paweł Paprota',
11 'Gergely Imreh',
12 'Rogério Brito',
13 'Philipp Hagemeister',
14 'Sören Schulze',
15 'Kevin Ngo',
16 'Ori Avtalion',
17 'shizeeg',
18 'Filippo Valsorda',
19 'Christian Albrecht',
88f6c78b 20 'Dave Vasilevsky',
2069acc6 21 'Jaime Marquínez Ferrándiz',
fffec3b9 22 'Jeff Crouse',
6aabe820 23 'Osama Khalid',
e8600d69 24 'Michael Walter',
95464f14 25 'M. Yasoob Ullah Khalid',
0ae456f0 26 'Julien Fraichard',
be74864a 27 'Johny Mo Swag',
df725153 28 'Axel Noack',
ba7a1de0 29 'Albert Kim',
4a55479f 30 'Pierre Rudloff',
085bea45 31 'Huarong Huo',
ac4f319b 32 'Ismael Mejía',
2dad310e 33 'Steffan \'Ruirize\' James',
a623df4c 34 'Andras Elso',
b5bdc269 35 'Jelle van der Waa',
d3793638 36 'Marcin Cieślak',
0a120f74 37 'Anton Larionov',
38b2db6a 38 'Takuya Tsuchida',
87968574 39 'Sergey M.',
b83be81d 40 'Michael Orlitzky',
e63fc1be 41 'Chris Gahan',
a7732b67 42 'Saimadhav Heblikar',
2a893862 43 'Mike Col',
6d784e87 44 'Oleg Prutz',
0cea52cc 45 'pulpe',
845d14d3 46 'Andreas Schmitz',
cbffec0c 47 'Michael Kaiser',
96d16370 48 'Niklas Laxström',
f38da667 49 'David Triendl',
a339d7ba 50 'Anthony Weems',
dc3727b6 51 'David Wagner',
2fcec131 52 'Juan C. Olivares',
855e2750 53 'Mattias Harrysson',
ba7a1de0 54)
235b3ba4
PH
55
56__license__ = 'Public Domain'
235b3ba4 57
0d94f247 58import codecs
8f563f32 59import io
fd46a318 60import locale
c9ed14e6 61import optparse
235b3ba4 62import os
0f818663 63import random
235b3ba4 64import re
c9ed14e6 65import shlex
235b3ba4 66import sys
235b3ba4 67
c496ca96 68
a4fd0415 69from .utils import (
e68301af 70 compat_getpass,
a4fd0415 71 compat_print,
a4fd0415
PH
72 DateRange,
73 decodeOption,
1c088fa8 74 get_term_width,
a4fd0415
PH
75 DownloadError,
76 get_cachedir,
a4fd0415 77 MaxDownloadsReached,
a4fd0415 78 preferredencoding,
62e609ab 79 read_batch_urls,
a4fd0415 80 SameFileError,
e3946f98 81 setproctitle,
a4fd0415
PH
82 std_headers,
83 write_string,
a4fd0415 84)
d5ed35b6 85from .update import update_self
a4fd0415
PH
86from .FileDownloader import (
87 FileDownloader,
88)
0824c28c 89from .extractor import gen_extractors
dca08720 90from .version import __version__
8222d8de 91from .YoutubeDL import YoutubeDL
56327689 92from .postprocessor import (
a4fd0415
PH
93 FFmpegMetadataPP,
94 FFmpegVideoConvertor,
95 FFmpegExtractAudioPP,
96 FFmpegEmbedSubtitlePP,
e63fc1be 97 XAttrMetadataPP,
a4fd0415
PH
98)
99
235b3ba4 100
75b5c590 101def parseOpts(overrideArguments=None):
fb27c229 102 def _readOptions(filename_bytes, default=[]):
59ae15a5
PH
103 try:
104 optionf = open(filename_bytes)
105 except IOError:
fb27c229 106 return default # silently skip if file is not present
59ae15a5 107 try:
a0eaa341
PH
108 res = []
109 for l in optionf:
110 res += shlex.split(l, comments=True)
59ae15a5
PH
111 finally:
112 optionf.close()
113 return res
114
588128d0
PH
115 def _readUserConf():
116 xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
117 if xdg_config_home:
118 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
119 if not os.path.isfile(userConfFile):
120 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
121 else:
122 userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl', 'config')
123 if not os.path.isfile(userConfFile):
124 userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
125 userConf = _readOptions(userConfFile, None)
126
127 if userConf is None:
128 appdata_dir = os.environ.get('appdata')
129 if appdata_dir:
130 userConf = _readOptions(
131 os.path.join(appdata_dir, 'youtube-dl', 'config'),
132 default=None)
133 if userConf is None:
134 userConf = _readOptions(
135 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
136 default=None)
137
138 if userConf is None:
139 userConf = _readOptions(
140 os.path.join(os.path.expanduser('~'), 'youtube-dl.conf'),
141 default=None)
142 if userConf is None:
143 userConf = _readOptions(
144 os.path.join(os.path.expanduser('~'), 'youtube-dl.conf.txt'),
145 default=None)
146
147 if userConf is None:
148 userConf = []
149
150 return userConf
151
59ae15a5
PH
152 def _format_option_string(option):
153 ''' ('-o', '--option') -> -o, --format METAVAR'''
154
155 opts = []
156
157 if option._short_opts:
158 opts.append(option._short_opts[0])
159 if option._long_opts:
160 opts.append(option._long_opts[0])
161 if len(opts) > 1:
162 opts.insert(1, ', ')
163
164 if option.takes_value(): opts.append(' %s' % option.metavar)
165
166 return "".join(opts)
167
d6e203b3
IM
168 def _comma_separated_values_options_callback(option, opt_str, value, parser):
169 setattr(parser.values, option.dest, value.split(','))
170
920ef077
JMF
171 def _hide_login_info(opts):
172 opts = list(opts)
3126050c 173 for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
920ef077
JMF
174 try:
175 i = opts.index(private_opt)
176 opts[i+1] = '<PRIVATE>'
177 except ValueError:
178 pass
179 return opts
180
59ae15a5
PH
181 max_width = 80
182 max_help_position = 80
183
184 # No need to wrap help messages if we're on a wide console
1c088fa8 185 columns = get_term_width()
59ae15a5
PH
186 if columns: max_width = columns
187
188 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
189 fmt.format_option_strings = _format_option_string
190
191 kw = {
192 'version' : __version__,
193 'formatter' : fmt,
194 'usage' : '%prog [options] url [url...]',
195 'conflict_handler' : 'resolve',
196 }
197
198 parser = optparse.OptionParser(**kw)
199
200 # option groups
201 general = optparse.OptionGroup(parser, 'General Options')
202 selection = optparse.OptionGroup(parser, 'Video Selection')
203 authentication = optparse.OptionGroup(parser, 'Authentication Options')
204 video_format = optparse.OptionGroup(parser, 'Video Format Options')
505c28aa 205 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
0beb3add 206 downloader = optparse.OptionGroup(parser, 'Download Options')
59ae15a5
PH
207 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
208 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
209 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
210
211 general.add_option('-h', '--help',
212 action='help', help='print this help text and exit')
213 general.add_option('-v', '--version',
214 action='version', help='print program version and exit')
215 general.add_option('-U', '--update',
f631c331 216 action='store_true', dest='update_self', help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
59ae15a5 217 general.add_option('-i', '--ignore-errors',
98c4b8fa 218 action='store_true', dest='ignoreerrors', help='continue on download errors, for example to skip unavailable videos in a playlist', default=False)
41fd7c7e
PH
219 general.add_option('--abort-on-error',
220 action='store_false', dest='ignoreerrors',
221 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
59ae15a5
PH
222 general.add_option('--dump-user-agent',
223 action='store_true', dest='dump_user_agent',
224 help='display the current browser identification', default=False)
225 general.add_option('--user-agent',
226 dest='user_agent', help='specify a custom user agent', metavar='UA')
28535652 227 general.add_option('--referer',
3820df01
JMF
228 dest='referer', help='specify a custom referer, use if the video access is restricted to one domain',
229 metavar='REF', default=None)
59ae15a5
PH
230 general.add_option('--list-extractors',
231 action='store_true', dest='list_extractors',
232 help='List all supported extractors and the URLs they would handle', default=False)
62067cb9 233 general.add_option('--extractor-descriptions',
0f818663
PH
234 action='store_true', dest='list_extractor_descriptions',
235 help='Output descriptions of all supported extractors', default=False)
cf6758d2
PH
236 general.add_option(
237 '--proxy', dest='proxy', default=None, metavar='URL',
238 help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
ea6d901e 239 general.add_option('--no-check-certificate', action='store_true', dest='no_check_certificate', default=False, help='Suppress HTTPS certificate validation.')
7f747732 240 general.add_option(
cce722b7 241 '--cache-dir', dest='cachedir', default=get_cachedir(), metavar='DIR',
7c094bfe 242 help='Location in the filesystem where youtube-dl can store some downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl . At the moment, only YouTube player files (for videos with obfuscated signatures) are cached, but that may change.')
7f747732
PH
243 general.add_option(
244 '--no-cache-dir', action='store_const', const=None, dest='cachedir',
245 help='Disable filesystem caching')
6ad14cab
PH
246 general.add_option(
247 '--socket-timeout', dest='socket_timeout',
9656ee5d 248 type=float, default=None, help=u'Time to wait before giving up, in seconds')
0783b09b
PH
249 general.add_option(
250 '--bidi-workaround', dest='bidi_workaround', action='store_true',
5d681e96 251 help=u'Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
04b4d394
PH
252 general.add_option('--default-search',
253 dest='default_search', metavar='PREFIX',
254 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". By default (with value "auto") youtube-dl guesses.')
588128d0
PH
255 general.add_option(
256 '--ignore-config',
257 action='store_true',
258 help='Do not read configuration files. When given in the global configuration file /etc/youtube-dl.conf: do not read the user configuration in ~/.config/youtube-dl.conf (%APPDATA%/youtube-dl/config.txt on Windows)')
259
59ae15a5 260
a19fd00c
PH
261 selection.add_option(
262 '--playlist-start',
263 dest='playliststart', metavar='NUMBER', default=1, type=int,
264 help='playlist video to start at (default is %default)')
265 selection.add_option(
266 '--playlist-end',
267 dest='playlistend', metavar='NUMBER', default=None, type=int,
268 help='playlist video to end at (default is last)')
59ae15a5
PH
269 selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
270 selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
0c75c3fa
PH
271 selection.add_option('--max-downloads', metavar='NUMBER',
272 dest='max_downloads', type=int, default=None,
273 help='Abort after downloading NUMBER files')
dbf2ba3d
PH
274 selection.add_option('--min-filesize', metavar='SIZE', dest='min_filesize', help="Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)", default=None)
275 selection.add_option('--max-filesize', metavar='SIZE', dest='max_filesize', help="Do not download any videos larger than SIZE (e.g. 50k or 44.6m)", default=None)
bd558525 276 selection.add_option('--date', metavar='DATE', dest='date', help='download only videos uploaded in this date', default=None)
bac268e2
PH
277 selection.add_option(
278 '--datebefore', metavar='DATE', dest='datebefore', default=None,
279 help='download only videos uploaded on or before this date (i.e. inclusive)')
280 selection.add_option(
281 '--dateafter', metavar='DATE', dest='dateafter', default=None,
282 help='download only videos uploaded on or after this date (i.e. inclusive)')
5fe18bdb
PH
283 selection.add_option(
284 '--min-views', metavar='COUNT', dest='min_views',
285 default=None, type=int,
286 help="Do not download any videos with less than COUNT views",)
287 selection.add_option(
288 '--max-views', metavar='COUNT', dest='max_views',
289 default=None, type=int,
290 help="Do not download any videos with more than COUNT views",)
47192f92 291 selection.add_option('--no-playlist', action='store_true', dest='noplaylist', help='download only the currently playing video', default=False)
8dbe9899
PH
292 selection.add_option('--age-limit', metavar='YEARS', dest='age_limit',
293 help='download only videos suitable for the given age',
294 default=None, type=int)
c1c9a79c
PH
295 selection.add_option('--download-archive', metavar='FILE',
296 dest='download_archive',
36a826a5 297 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
7b0817e8
PH
298 selection.add_option(
299 '--include-ads', dest='include_ads',
300 action='store_true',
301 help='Download advertisements as well (experimental)')
8b1be5cd 302 selection.add_option(
4919603f
PH
303 '--youtube-include-dash-manifest', action='store_true',
304 dest='youtube_include_dash_manifest', default=False,
305 help='Try to download the DASH manifest on YouTube videos (experimental)')
9e982f9e 306
59ae15a5
PH
307 authentication.add_option('-u', '--username',
308 dest='username', metavar='USERNAME', help='account username')
309 authentication.add_option('-p', '--password',
310 dest='password', metavar='PASSWORD', help='account password')
311 authentication.add_option('-n', '--netrc',
312 action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False)
c6c19746 313 authentication.add_option('--video-password',
67d28bff 314 dest='videopassword', metavar='PASSWORD', help='video password (vimeo, smotri)')
59ae15a5
PH
315
316
317 video_format.add_option('-f', '--format',
de3ef3ed 318 action='store', dest='format', metavar='FORMAT', default=None,
bc6d5978 319 help='video format code, specify the order of preference using slashes: "-f 22/17/18". "-f mp4" and "-f flv" are also supported. You can also use the special names "best", "bestvideo", "bestaudio", "worst", "worstvideo" and "worstaudio". By default, youtube-dl will pick the best quality.')
59ae15a5
PH
320 video_format.add_option('--all-formats',
321 action='store_const', dest='format', help='download all available video formats', const='all')
322 video_format.add_option('--prefer-free-formats',
323 action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested')
324 video_format.add_option('--max-quality',
325 action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
326 video_format.add_option('-F', '--list-formats',
4950f308 327 action='store_true', dest='listformats', help='list all available formats')
505c28aa
IM
328
329 subtitles.add_option('--write-sub', '--write-srt',
59ae15a5 330 action='store_true', dest='writesubtitles',
953e32b2 331 help='write subtitle file', default=False)
505c28aa 332 subtitles.add_option('--write-auto-sub', '--write-automatic-sub',
b004821f 333 action='store_true', dest='writeautomaticsub',
953e32b2 334 help='write automatic subtitle file (youtube only)', default=False)
505c28aa 335 subtitles.add_option('--all-subs',
ae608b80 336 action='store_true', dest='allsubtitles',
953e32b2 337 help='downloads all the available subtitles of the video', default=False)
505c28aa 338 subtitles.add_option('--list-subs',
2a4093ea 339 action='store_true', dest='listsubtitles',
953e32b2 340 help='lists all available subtitles for the video', default=False)
505c28aa 341 subtitles.add_option('--sub-format',
c3ab8f86 342 action='store', dest='subtitlesformat', metavar='FORMAT',
953e32b2 343 help='subtitle format (default=srt) ([sbv/vtt] youtube only)', default='srt')
d6e203b3
IM
344 subtitles.add_option('--sub-lang', '--sub-langs', '--srt-lang',
345 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
346 default=[], callback=_comma_separated_values_options_callback,
347 help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
59ae15a5 348
0beb3add 349 downloader.add_option('-r', '--rate-limit',
cd054fc4 350 dest='ratelimit', metavar='LIMIT', help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
0beb3add
PH
351 downloader.add_option('-R', '--retries',
352 dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
353 downloader.add_option('--buffer-size',
cd054fc4 354 dest='buffersize', metavar='SIZE', help='size of download buffer (e.g. 1024 or 16K) (default is %default)', default="1024")
0beb3add
PH
355 downloader.add_option('--no-resize-buffer',
356 action='store_true', dest='noresizebuffer',
357 help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.', default=False)
358 downloader.add_option('--test', action='store_true', dest='test', default=False, help=optparse.SUPPRESS_HELP)
359
59ae15a5
PH
360 verbosity.add_option('-q', '--quiet',
361 action='store_true', dest='quiet', help='activates quiet mode', default=False)
362 verbosity.add_option('-s', '--simulate',
363 action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False)
364 verbosity.add_option('--skip-download',
365 action='store_true', dest='skip_download', help='do not download the video', default=False)
366 verbosity.add_option('-g', '--get-url',
367 action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False)
368 verbosity.add_option('-e', '--get-title',
369 action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False)
1a2adf3f 370 verbosity.add_option('--get-id',
371 action='store_true', dest='getid', help='simulate, quiet but print id', default=False)
59ae15a5
PH
372 verbosity.add_option('--get-thumbnail',
373 action='store_true', dest='getthumbnail',
374 help='simulate, quiet but print thumbnail URL', default=False)
375 verbosity.add_option('--get-description',
376 action='store_true', dest='getdescription',
377 help='simulate, quiet but print video description', default=False)
525ef922
PH
378 verbosity.add_option('--get-duration',
379 action='store_true', dest='getduration',
380 help='simulate, quiet but print video length', default=False)
59ae15a5
PH
381 verbosity.add_option('--get-filename',
382 action='store_true', dest='getfilename',
383 help='simulate, quiet but print output filename', default=False)
384 verbosity.add_option('--get-format',
385 action='store_true', dest='getformat',
386 help='simulate, quiet but print output format', default=False)
9d153818
MF
387 verbosity.add_option('-j', '--dump-json',
388 action='store_true', dest='dumpjson',
8694c600 389 help='simulate, quiet but print JSON information', default=False)
7311fef8 390 verbosity.add_option('--newline',
5717d91a 391 action='store_true', dest='progress_with_newline', help='output progress bar as new lines', default=False)
59ae15a5
PH
392 verbosity.add_option('--no-progress',
393 action='store_true', dest='noprogress', help='do not print progress bar', default=False)
394 verbosity.add_option('--console-title',
395 action='store_true', dest='consoletitle',
396 help='display progress in console titlebar', default=False)
397 verbosity.add_option('-v', '--verbose',
398 action='store_true', dest='verbose', help='print various debugging information', default=False)
855703e5
PH
399 verbosity.add_option('--dump-intermediate-pages',
400 action='store_true', dest='dump_intermediate_pages', default=False,
67d28bff 401 help='print downloaded pages to debug problems (very verbose)')
d41e6efc
PH
402 verbosity.add_option('--write-pages',
403 action='store_true', dest='write_pages', default=False,
06dcbb71 404 help='Write downloaded intermediary pages to files in the current directory to debug problems')
edf3e38e
PH
405 verbosity.add_option('--youtube-print-sig-code',
406 action='store_true', dest='youtube_print_sig_code', default=False,
407 help=optparse.SUPPRESS_HELP)
a0ddb8a2
PH
408 verbosity.add_option('--print-traffic',
409 dest='debug_printtraffic', action='store_true', default=False,
4919603f
PH
410 help='Display sent and read HTTP traffic')
411
59ae15a5 412
59ae15a5 413 filesystem.add_option('-t', '--title',
08b2ac74 414 action='store_true', dest='usetitle', help='use title in file name (default)', default=False)
59ae15a5 415 filesystem.add_option('--id',
08b2ac74 416 action='store_true', dest='useid', help='use only video ID in file name', default=False)
59ae15a5
PH
417 filesystem.add_option('-l', '--literal',
418 action='store_true', dest='usetitle', help='[deprecated] alias of --title', default=False)
419 filesystem.add_option('-A', '--auto-number',
420 action='store_true', dest='autonumber',
421 help='number downloaded files starting from 00000', default=False)
422 filesystem.add_option('-o', '--output',
74e3452b
JMF
423 dest='outtmpl', metavar='TEMPLATE',
424 help=('output filename template. Use %(title)s to get the title, '
425 '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
426 '%(autonumber)s to get an automatically incremented number, '
fdefe96b 427 '%(ext)s for the filename extension, '
67d28bff 428 '%(format)s for the format description (like "22 - 1280x720" or "HD"), '
429 '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"), '
fdefe96b 430 '%(upload_date)s for the upload date (YYYYMMDD), '
74e3452b 431 '%(extractor)s for the provider (youtube, metacafe, etc), '
67d28bff 432 '%(id)s for the video id, %(playlist)s for the playlist the video is in, '
74e3452b 433 '%(playlist_index)s for the position in the playlist and %% for a literal percent. '
17b75c0d
PH
434 '%(height)s and %(width)s for the width and height of the video format. '
435 '%(resolution)s for a textual description of the resolution of the video format. '
74e3452b
JMF
436 'Use - to output to stdout. Can also be used to download to a different directory, '
437 'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
213c31ae
SK
438 filesystem.add_option('--autonumber-size',
439 dest='autonumber_size', metavar='NUMBER',
2a9e9b21 440 help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
59ae15a5
PH
441 filesystem.add_option('--restrict-filenames',
442 action='store_true', dest='restrictfilenames',
443 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames', default=False)
444 filesystem.add_option('-a', '--batch-file',
445 dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)')
1dcc4c0c
JMF
446 filesystem.add_option('--load-info',
447 dest='load_info_filename', metavar='FILE',
67d28bff 448 help='json file containing the video information (created with the "--write-json" option)')
59ae15a5
PH
449 filesystem.add_option('-w', '--no-overwrites',
450 action='store_true', dest='nooverwrites', help='do not overwrite files', default=False)
451 filesystem.add_option('-c', '--continue',
d4b7da84 452 action='store_true', dest='continue_dl', help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.', default=True)
59ae15a5
PH
453 filesystem.add_option('--no-continue',
454 action='store_false', dest='continue_dl',
455 help='do not resume partially downloaded files (restart from beginning)')
456 filesystem.add_option('--cookies',
457 dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in')
458 filesystem.add_option('--no-part',
459 action='store_true', dest='nopart', help='do not use .part files', default=False)
460 filesystem.add_option('--no-mtime',
461 action='store_false', dest='updatetime',
462 help='do not use the Last-modified header to set the file modification time', default=True)
463 filesystem.add_option('--write-description',
464 action='store_true', dest='writedescription',
465 help='write video description to a .description file', default=False)
466 filesystem.add_option('--write-info-json',
467 action='store_true', dest='writeinfojson',
468 help='write video metadata to a .info.json file', default=False)
1fb07d10
JG
469 filesystem.add_option('--write-annotations',
470 action='store_true', dest='writeannotations',
471 help='write video annotations to a .annotation file', default=False)
11d9224e
PH
472 filesystem.add_option('--write-thumbnail',
473 action='store_true', dest='writethumbnail',
474 help='write thumbnail image to disk', default=False)
59ae15a5
PH
475
476
477 postproc.add_option('-x', '--extract-audio', action='store_true', dest='extractaudio', default=False,
478 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
479 postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best',
510e6f6d 480 help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; best by default')
59ae15a5
PH
481 postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5',
482 help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)')
7851b379
PH
483 postproc.add_option('--recode-video', metavar='FORMAT', dest='recodevideo', default=None,
484 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm)')
59ae15a5
PH
485 postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False,
486 help='keeps the video file on disk after the post-processing; the video is erased by default')
f0648fc1
BPG
487 postproc.add_option('--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False,
488 help='do not overwrite post-processed files; the post-processed files are overwritten by default')
d4051a8e
JMF
489 postproc.add_option('--embed-subs', action='store_true', dest='embedsubtitles', default=False,
490 help='embed subtitles in the video (only for mp4 videos)')
bc4f2917 491 postproc.add_option('--add-metadata', action='store_true', dest='addmetadata', default=False,
e63fc1be 492 help='write metadata to the video file')
493 postproc.add_option('--xattrs', action='store_true', dest='xattrs', default=False,
494 help='write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
76b1bd67
JMF
495 postproc.add_option('--prefer-avconv', action='store_false', dest='prefer_ffmpeg',
496 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
497 postproc.add_option('--prefer-ffmpeg', action='store_true', dest='prefer_ffmpeg',
498 help='Prefer ffmpeg over avconv for running the postprocessors')
59ae15a5
PH
499
500
501 parser.add_option_group(general)
502 parser.add_option_group(selection)
0beb3add 503 parser.add_option_group(downloader)
59ae15a5
PH
504 parser.add_option_group(filesystem)
505 parser.add_option_group(verbosity)
506 parser.add_option_group(video_format)
505c28aa 507 parser.add_option_group(subtitles)
59ae15a5
PH
508 parser.add_option_group(authentication)
509 parser.add_option_group(postproc)
510
75b5c590
PH
511 if overrideArguments is not None:
512 opts, args = parser.parse_args(overrideArguments)
513 if opts.verbose:
7459e3a2 514 write_string(u'[debug] Override config: ' + repr(overrideArguments) + '\n')
59ae15a5 515 else:
1865ed31 516 commandLineConf = sys.argv[1:]
588128d0
PH
517 if '--ignore-config' in commandLineConf:
518 systemConf = []
519 userConf = []
520 else:
521 systemConf = _readOptions('/etc/youtube-dl.conf')
522 if '--ignore-config' in systemConf:
523 userConf = []
524 else:
525 userConf = _readUserConf()
75b5c590 526 argv = systemConf + userConf + commandLineConf
588128d0 527
75b5c590 528 opts, args = parser.parse_args(argv)
c76cb6d5 529 if opts.verbose:
7459e3a2
PH
530 write_string(u'[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
531 write_string(u'[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
532 write_string(u'[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
fd46a318
PH
533 write_string(u'[debug] Encodings: locale %r, fs %r, out %r, pref: %r\n' %
534 (locale.getpreferredencoding(), sys.getfilesystemencoding(), sys.stdout.encoding, preferredencoding()))
8c42c506 535
59ae15a5 536 return parser, opts, args
235b3ba4 537
e3946f98 538
b8ad4f02 539def _real_main(argv=None):
0d94f247
PH
540 # Compatibility fixes for Windows
541 if sys.platform == 'win32':
542 # https://github.com/rg3/youtube-dl/issues/820
543 codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
544
e3946f98
PH
545 setproctitle(u'youtube-dl')
546
b8ad4f02 547 parser, opts, args = parseOpts(argv)
59ae15a5 548
59ae15a5
PH
549 # Set user agent
550 if opts.user_agent is not None:
551 std_headers['User-Agent'] = opts.user_agent
1865ed31 552
28535652
BH
553 # Set referer
554 if opts.referer is not None:
555 std_headers['Referer'] = opts.referer
59ae15a5
PH
556
557 # Dump user agent
558 if opts.dump_user_agent:
93eb15c5 559 compat_print(std_headers['User-Agent'])
59ae15a5
PH
560 sys.exit(0)
561
562 # Batch file verification
62e609ab 563 batch_urls = []
59ae15a5
PH
564 if opts.batchfile is not None:
565 try:
566 if opts.batchfile == '-':
567 batchfd = sys.stdin
568 else:
62e609ab
PH
569 batchfd = io.open(opts.batchfile, 'r', encoding='utf-8', errors='ignore')
570 batch_urls = read_batch_urls(batchfd)
05afc96b 571 if opts.verbose:
62e609ab 572 write_string(u'[debug] Batch file urls: ' + repr(batch_urls) + u'\n')
59ae15a5
PH
573 except IOError:
574 sys.exit(u'ERROR: batch file could not be read')
62e609ab 575 all_urls = batch_urls + args
59ae15a5 576 all_urls = [url.strip() for url in all_urls]
c774b3c6 577 _enc = preferredencoding()
41292a38 578 all_urls = [url.decode(_enc, 'ignore') if isinstance(url, bytes) else url for url in all_urls]
59ae15a5 579
59ae15a5
PH
580 extractors = gen_extractors()
581
582 if opts.list_extractors:
7dba9cd0 583 for ie in sorted(extractors, key=lambda ie: ie.IE_NAME.lower()):
93eb15c5 584 compat_print(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else ''))
1a2c3c0f 585 matchedUrls = [url for url in all_urls if ie.suitable(url)]
59ae15a5 586 for mu in matchedUrls:
93eb15c5 587 compat_print(u' ' + mu)
59ae15a5 588 sys.exit(0)
0f818663
PH
589 if opts.list_extractor_descriptions:
590 for ie in sorted(extractors, key=lambda ie: ie.IE_NAME.lower()):
591 if not ie._WORKING:
592 continue
593 desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
15870e90
PH
594 if desc is False:
595 continue
0f818663
PH
596 if hasattr(ie, 'SEARCH_KEY'):
597 _SEARCHES = (u'cute kittens', u'slithering pythons', u'falling cat', u'angry poodle', u'purple fish', u'running tortoise')
598 _COUNTS = (u'', u'5', u'10', u'all')
599 desc += u' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES))
600 compat_print(desc)
601 sys.exit(0)
602
59ae15a5
PH
603
604 # Conflicting, missing and erroneous options
605 if opts.usenetrc and (opts.username is not None or opts.password is not None):
606 parser.error(u'using .netrc conflicts with giving username/password')
607 if opts.password is not None and opts.username is None:
67d28bff 608 parser.error(u'account username missing\n')
59ae15a5
PH
609 if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
610 parser.error(u'using output template conflicts with using title, video ID or auto number')
611 if opts.usetitle and opts.useid:
612 parser.error(u'using title conflicts with using video ID')
613 if opts.username is not None and opts.password is None:
e68301af 614 opts.password = compat_getpass(u'Type account password and press [Return]: ')
59ae15a5
PH
615 if opts.ratelimit is not None:
616 numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
617 if numeric_limit is None:
618 parser.error(u'invalid rate limit specified')
619 opts.ratelimit = numeric_limit
9e982f9e
JC
620 if opts.min_filesize is not None:
621 numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
622 if numeric_limit is None:
623 parser.error(u'invalid min_filesize specified')
624 opts.min_filesize = numeric_limit
625 if opts.max_filesize is not None:
626 numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
627 if numeric_limit is None:
628 parser.error(u'invalid max_filesize specified')
629 opts.max_filesize = numeric_limit
59ae15a5
PH
630 if opts.retries is not None:
631 try:
632 opts.retries = int(opts.retries)
dca08720 633 except (TypeError, ValueError):
59ae15a5
PH
634 parser.error(u'invalid retry count specified')
635 if opts.buffersize is not None:
636 numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
637 if numeric_buffersize is None:
638 parser.error(u'invalid buffer size specified')
639 opts.buffersize = numeric_buffersize
a19fd00c
PH
640 if opts.playliststart <= 0:
641 raise ValueError(u'Playlist start must be positive')
642 if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart:
643 raise ValueError(u'Playlist end must be greater than playlist start')
59ae15a5 644 if opts.extractaudio:
510e6f6d 645 if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']:
59ae15a5
PH
646 parser.error(u'invalid audio format specified')
647 if opts.audioquality:
648 opts.audioquality = opts.audioquality.strip('k').strip('K')
649 if not opts.audioquality.isdigit():
650 parser.error(u'invalid audio quality specified')
7851b379
PH
651 if opts.recodevideo is not None:
652 if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg']:
653 parser.error(u'invalid video recode format specified')
bd558525
JMF
654 if opts.date is not None:
655 date = DateRange.day(opts.date)
656 else:
657 date = DateRange(opts.dateafter, opts.datebefore)
04b4d394
PH
658 if opts.default_search not in ('auto', None) and ':' not in opts.default_search:
659 parser.error(u'--default-search invalid; did you forget a colon (:) at the end?')
59ae15a5 660
de3ef3ed
PH
661 # Do not download videos when there are audio-only formats
662 if opts.extractaudio and not opts.keepvideo and opts.format is None:
663 opts.format = 'bestaudio/best'
664
0b7f3118
JMF
665 # --all-sub automatically sets --write-sub if --write-auto-sub is not given
666 # this was the old behaviour if only --all-sub was given.
667 if opts.allsubtitles and (opts.writeautomaticsub == False):
668 opts.writesubtitles = True
669
5cb9c312
PH
670 if sys.version_info < (3,):
671 # In Python 2, sys.argv is a bytestring (also note http://bugs.python.org/issue2128 for Windows systems)
0be41ec2
PH
672 if opts.outtmpl is not None:
673 opts.outtmpl = opts.outtmpl.decode(preferredencoding())
5cb9c312
PH
674 outtmpl =((opts.outtmpl is not None and opts.outtmpl)
675 or (opts.format == '-1' and opts.usetitle and u'%(title)s-%(id)s-%(format)s.%(ext)s')
676 or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s')
677 or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(title)s-%(id)s.%(ext)s')
678 or (opts.usetitle and u'%(title)s-%(id)s.%(ext)s')
679 or (opts.useid and u'%(id)s.%(ext)s')
680 or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
08b2ac74 681 or u'%(title)s-%(id)s.%(ext)s')
dca02c80 682 if not os.path.splitext(outtmpl)[1] and opts.extractaudio:
b61067fa 683 parser.error(u'Cannot download a video and extract audio into the same'
dca02c80
JMF
684 u' file! Use "{0}.%(ext)s" instead of "{0}" as the output'
685 u' template'.format(outtmpl))
29c7a63d 686
525ef922 687 any_printing = opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.getduration or opts.dumpjson
17093b83 688 download_archive_fn = os.path.expanduser(opts.download_archive) if opts.download_archive is not None else opts.download_archive
525ef922 689
bdde425c 690 ydl_opts = {
59ae15a5
PH
691 'usenetrc': opts.usenetrc,
692 'username': opts.username,
693 'password': opts.password,
c6c19746 694 'videopassword': opts.videopassword,
525ef922 695 'quiet': (opts.quiet or any_printing),
59ae15a5
PH
696 'forceurl': opts.geturl,
697 'forcetitle': opts.gettitle,
1a2adf3f 698 'forceid': opts.getid,
59ae15a5
PH
699 'forcethumbnail': opts.getthumbnail,
700 'forcedescription': opts.getdescription,
525ef922 701 'forceduration': opts.getduration,
59ae15a5
PH
702 'forcefilename': opts.getfilename,
703 'forceformat': opts.getformat,
9d153818 704 'forcejson': opts.dumpjson,
59ae15a5 705 'simulate': opts.simulate,
525ef922 706 'skip_download': (opts.skip_download or opts.simulate or any_printing),
59ae15a5
PH
707 'format': opts.format,
708 'format_limit': opts.format_limit,
709 'listformats': opts.listformats,
5cb9c312 710 'outtmpl': outtmpl,
213c31ae 711 'autonumber_size': opts.autonumber_size,
59ae15a5
PH
712 'restrictfilenames': opts.restrictfilenames,
713 'ignoreerrors': opts.ignoreerrors,
714 'ratelimit': opts.ratelimit,
715 'nooverwrites': opts.nooverwrites,
716 'retries': opts.retries,
717 'buffersize': opts.buffersize,
718 'noresizebuffer': opts.noresizebuffer,
719 'continuedl': opts.continue_dl,
720 'noprogress': opts.noprogress,
5717d91a 721 'progress_with_newline': opts.progress_with_newline,
59ae15a5
PH
722 'playliststart': opts.playliststart,
723 'playlistend': opts.playlistend,
47192f92 724 'noplaylist': opts.noplaylist,
59ae15a5
PH
725 'logtostderr': opts.outtmpl == '-',
726 'consoletitle': opts.consoletitle,
727 'nopart': opts.nopart,
728 'updatetime': opts.updatetime,
729 'writedescription': opts.writedescription,
1fb07d10 730 'writeannotations': opts.writeannotations,
59ae15a5 731 'writeinfojson': opts.writeinfojson,
11d9224e 732 'writethumbnail': opts.writethumbnail,
59ae15a5 733 'writesubtitles': opts.writesubtitles,
b004821f 734 'writeautomaticsub': opts.writeautomaticsub,
ae608b80 735 'allsubtitles': opts.allsubtitles,
2a4093ea 736 'listsubtitles': opts.listsubtitles,
9e62bc44 737 'subtitlesformat': opts.subtitlesformat,
d6e203b3 738 'subtitleslangs': opts.subtitleslangs,
8271226a
PH
739 'matchtitle': decodeOption(opts.matchtitle),
740 'rejecttitle': decodeOption(opts.rejecttitle),
59ae15a5
PH
741 'max_downloads': opts.max_downloads,
742 'prefer_free_formats': opts.prefer_free_formats,
743 'verbose': opts.verbose,
855703e5 744 'dump_intermediate_pages': opts.dump_intermediate_pages,
d41e6efc 745 'write_pages': opts.write_pages,
8d5d3a5d 746 'test': opts.test,
7851b379 747 'keepvideo': opts.keepvideo,
9e982f9e 748 'min_filesize': opts.min_filesize,
bd558525 749 'max_filesize': opts.max_filesize,
5fe18bdb
PH
750 'min_views': opts.min_views,
751 'max_views': opts.max_views,
11d9224e 752 'daterange': date,
7f747732 753 'cachedir': opts.cachedir,
f8061589 754 'youtube_print_sig_code': opts.youtube_print_sig_code,
8dbe9899 755 'age_limit': opts.age_limit,
17093b83 756 'download_archive': download_archive_fn,
dca08720
PH
757 'cookiefile': opts.cookiefile,
758 'nocheckcertificate': opts.no_check_certificate,
c2e52508 759 'proxy': opts.proxy,
6ad14cab 760 'socket_timeout': opts.socket_timeout,
0783b09b 761 'bidi_workaround': opts.bidi_workaround,
a0ddb8a2 762 'debug_printtraffic': opts.debug_printtraffic,
76b1bd67 763 'prefer_ffmpeg': opts.prefer_ffmpeg,
7b0817e8 764 'include_ads': opts.include_ads,
04b4d394 765 'default_search': opts.default_search,
4919603f 766 'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
bdde425c 767 }
59ae15a5 768
bdde425c 769 with YoutubeDL(ydl_opts) as ydl:
dca08720 770 ydl.print_debug_header()
bdde425c
PH
771 ydl.add_default_info_extractors()
772
773 # PostProcessors
774 # Add the metadata pp first, the other pps will copy it
775 if opts.addmetadata:
776 ydl.add_post_processor(FFmpegMetadataPP())
777 if opts.extractaudio:
778 ydl.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, nopostoverwrites=opts.nopostoverwrites))
779 if opts.recodevideo:
780 ydl.add_post_processor(FFmpegVideoConvertor(preferedformat=opts.recodevideo))
781 if opts.embedsubtitles:
782 ydl.add_post_processor(FFmpegEmbedSubtitlePP(subtitlesformat=opts.subtitlesformat))
e63fc1be 783 if opts.xattrs:
784 ydl.add_post_processor(XAttrMetadataPP())
bdde425c
PH
785
786 # Update version
787 if opts.update_self:
788 update_self(ydl.to_screen, opts.verbose)
789
790 # Maybe do nothing
1dcc4c0c 791 if (len(all_urls) < 1) and (opts.load_info_filename is None):
bdde425c
PH
792 if not opts.update_self:
793 parser.error(u'you must provide at least one URL')
794 else:
795 sys.exit()
59ae15a5 796
bdde425c 797 try:
1dcc4c0c
JMF
798 if opts.load_info_filename is not None:
799 retcode = ydl.download_with_info_file(opts.load_info_filename)
800 else:
801 retcode = ydl.download(all_urls)
bdde425c
PH
802 except MaxDownloadsReached:
803 ydl.to_screen(u'--max-download limit reached, aborting.')
804 retcode = 101
59ae15a5 805
59ae15a5 806 sys.exit(retcode)
235b3ba4 807
a27b9e8b 808
b8ad4f02 809def main(argv=None):
59ae15a5 810 try:
b8ad4f02 811 _real_main(argv)
59ae15a5
PH
812 except DownloadError:
813 sys.exit(1)
814 except SameFileError:
815 sys.exit(u'ERROR: fixed output name but more than one file to download')
816 except KeyboardInterrupt:
817 sys.exit(u'\nERROR: Interrupted by user')