]> Raphaƫl G. Git Repositories - youtubedl/blob - youtube_dl/options.py
6b811535f474dd6f5a1d6724c04730f69b7a16cc
[youtubedl] / youtube_dl / options.py
1 from __future__ import unicode_literals
2
3 import os.path
4 import optparse
5 import re
6 import sys
7
8 from .downloader.external import list_external_downloaders
9 from .compat import (
10 compat_expanduser,
11 compat_get_terminal_size,
12 compat_getenv,
13 compat_kwargs,
14 compat_shlex_split,
15 )
16 from .utils import (
17 preferredencoding,
18 write_string,
19 )
20 from .version import __version__
21
22
23 def parseOpts(overrideArguments=None):
24 def _readOptions(filename_bytes, default=[]):
25 try:
26 optionf = open(filename_bytes)
27 except IOError:
28 return default # silently skip if file is not present
29 try:
30 # FIXME: https://github.com/rg3/youtube-dl/commit/dfe5fa49aed02cf36ba9f743b11b0903554b5e56
31 contents = optionf.read()
32 if sys.version_info < (3,):
33 contents = contents.decode(preferredencoding())
34 res = compat_shlex_split(contents, comments=True)
35 finally:
36 optionf.close()
37 return res
38
39 def _readUserConf():
40 xdg_config_home = compat_getenv('XDG_CONFIG_HOME')
41 if xdg_config_home:
42 userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
43 if not os.path.isfile(userConfFile):
44 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
45 else:
46 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl', 'config')
47 if not os.path.isfile(userConfFile):
48 userConfFile = os.path.join(compat_expanduser('~'), '.config', 'youtube-dl.conf')
49 userConf = _readOptions(userConfFile, None)
50
51 if userConf is None:
52 appdata_dir = compat_getenv('appdata')
53 if appdata_dir:
54 userConf = _readOptions(
55 os.path.join(appdata_dir, 'youtube-dl', 'config'),
56 default=None)
57 if userConf is None:
58 userConf = _readOptions(
59 os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
60 default=None)
61
62 if userConf is None:
63 userConf = _readOptions(
64 os.path.join(compat_expanduser('~'), 'youtube-dl.conf'),
65 default=None)
66 if userConf is None:
67 userConf = _readOptions(
68 os.path.join(compat_expanduser('~'), 'youtube-dl.conf.txt'),
69 default=None)
70
71 if userConf is None:
72 userConf = []
73
74 return userConf
75
76 def _format_option_string(option):
77 ''' ('-o', '--option') -> -o, --format METAVAR'''
78
79 opts = []
80
81 if option._short_opts:
82 opts.append(option._short_opts[0])
83 if option._long_opts:
84 opts.append(option._long_opts[0])
85 if len(opts) > 1:
86 opts.insert(1, ', ')
87
88 if option.takes_value():
89 opts.append(' %s' % option.metavar)
90
91 return ''.join(opts)
92
93 def _comma_separated_values_options_callback(option, opt_str, value, parser):
94 setattr(parser.values, option.dest, value.split(','))
95
96 def _hide_login_info(opts):
97 PRIVATE_OPTS = ['-p', '--password', '-u', '--username', '--video-password', '--ap-password', '--ap-username']
98 eqre = re.compile('^(?P<key>' + ('|'.join(re.escape(po) for po in PRIVATE_OPTS)) + ')=.+$')
99
100 def _scrub_eq(o):
101 m = eqre.match(o)
102 if m:
103 return m.group('key') + '=PRIVATE'
104 else:
105 return o
106
107 opts = list(map(_scrub_eq, opts))
108 for private_opt in PRIVATE_OPTS:
109 try:
110 i = opts.index(private_opt)
111 opts[i + 1] = 'PRIVATE'
112 except ValueError:
113 pass
114 return opts
115
116 # No need to wrap help messages if we're on a wide console
117 columns = compat_get_terminal_size().columns
118 max_width = columns if columns else 80
119 max_help_position = 80
120
121 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
122 fmt.format_option_strings = _format_option_string
123
124 kw = {
125 'version': __version__,
126 'formatter': fmt,
127 'usage': '%prog [OPTIONS] URL [URL...]',
128 'conflict_handler': 'resolve',
129 }
130
131 parser = optparse.OptionParser(**compat_kwargs(kw))
132
133 general = optparse.OptionGroup(parser, 'General Options')
134 general.add_option(
135 '-h', '--help',
136 action='help',
137 help='Print this help text and exit')
138 general.add_option(
139 '-v', '--version',
140 action='version',
141 help='Print program version and exit')
142 general.add_option(
143 '-U', '--update',
144 action='store_true', dest='update_self',
145 help='Update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
146 general.add_option(
147 '-i', '--ignore-errors',
148 action='store_true', dest='ignoreerrors', default=False,
149 help='Continue on download errors, for example to skip unavailable videos in a playlist')
150 general.add_option(
151 '--abort-on-error',
152 action='store_false', dest='ignoreerrors',
153 help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
154 general.add_option(
155 '--dump-user-agent',
156 action='store_true', dest='dump_user_agent', default=False,
157 help='Display the current browser identification')
158 general.add_option(
159 '--list-extractors',
160 action='store_true', dest='list_extractors', default=False,
161 help='List all supported extractors')
162 general.add_option(
163 '--extractor-descriptions',
164 action='store_true', dest='list_extractor_descriptions', default=False,
165 help='Output descriptions of all supported extractors')
166 general.add_option(
167 '--force-generic-extractor',
168 action='store_true', dest='force_generic_extractor', default=False,
169 help='Force extraction to use the generic extractor')
170 general.add_option(
171 '--default-search',
172 dest='default_search', metavar='PREFIX',
173 help='Use this prefix for unqualified URLs. For example "gvsearch2:" downloads two videos from google videos for youtube-dl "large apple". Use the value "auto" to let youtube-dl guess ("auto_warning" to emit a warning when guessing). "error" just throws an error. The default value "fixup_error" repairs broken URLs, but emits an error if this is not possible instead of searching.')
174 general.add_option(
175 '--ignore-config',
176 action='store_true',
177 help='Do not read configuration files. '
178 'When given in the global configuration file /etc/youtube-dl.conf: '
179 'Do not read the user configuration in ~/.config/youtube-dl/config '
180 '(%APPDATA%/youtube-dl/config.txt on Windows)')
181 general.add_option(
182 '--config-location',
183 dest='config_location', metavar='PATH',
184 help='Location of the configuration file; either the path to the config or its containing directory.')
185 general.add_option(
186 '--flat-playlist',
187 action='store_const', dest='extract_flat', const='in_playlist',
188 default=False,
189 help='Do not extract the videos of a playlist, only list them.')
190 general.add_option(
191 '--mark-watched',
192 action='store_true', dest='mark_watched', default=False,
193 help='Mark videos watched (YouTube only)')
194 general.add_option(
195 '--no-mark-watched',
196 action='store_false', dest='mark_watched', default=False,
197 help='Do not mark videos watched (YouTube only)')
198 general.add_option(
199 '--no-color', '--no-colors',
200 action='store_true', dest='no_color',
201 default=False,
202 help='Do not emit color codes in output')
203
204 network = optparse.OptionGroup(parser, 'Network Options')
205 network.add_option(
206 '--proxy', dest='proxy',
207 default=None, metavar='URL',
208 help='Use the specified HTTP/HTTPS/SOCKS proxy. To enable experimental '
209 'SOCKS proxy, specify a proper scheme. For example '
210 'socks5://127.0.0.1:1080/. Pass in an empty string (--proxy "") '
211 'for direct connection')
212 network.add_option(
213 '--socket-timeout',
214 dest='socket_timeout', type=float, default=None, metavar='SECONDS',
215 help='Time to wait before giving up, in seconds')
216 network.add_option(
217 '--source-address',
218 metavar='IP', dest='source_address', default=None,
219 help='Client-side IP address to bind to',
220 )
221 network.add_option(
222 '-4', '--force-ipv4',
223 action='store_const', const='0.0.0.0', dest='source_address',
224 help='Make all connections via IPv4',
225 )
226 network.add_option(
227 '-6', '--force-ipv6',
228 action='store_const', const='::', dest='source_address',
229 help='Make all connections via IPv6',
230 )
231
232 geo = optparse.OptionGroup(parser, 'Geo Restriction')
233 geo.add_option(
234 '--geo-verification-proxy',
235 dest='geo_verification_proxy', default=None, metavar='URL',
236 help='Use this proxy to verify the IP address for some geo-restricted sites. '
237 'The default proxy specified by --proxy (or none, if the options is not present) is used for the actual downloading.')
238 geo.add_option(
239 '--cn-verification-proxy',
240 dest='cn_verification_proxy', default=None, metavar='URL',
241 help=optparse.SUPPRESS_HELP)
242 geo.add_option(
243 '--geo-bypass',
244 action='store_true', dest='geo_bypass', default=True,
245 help='Bypass geographic restriction via faking X-Forwarded-For HTTP header (experimental)')
246 geo.add_option(
247 '--no-geo-bypass',
248 action='store_false', dest='geo_bypass', default=True,
249 help='Do not bypass geographic restriction via faking X-Forwarded-For HTTP header (experimental)')
250 geo.add_option(
251 '--geo-bypass-country', metavar='CODE',
252 dest='geo_bypass_country', default=None,
253 help='Force bypass geographic restriction with explicitly provided two-letter ISO 3166-2 country code (experimental)')
254
255 selection = optparse.OptionGroup(parser, 'Video Selection')
256 selection.add_option(
257 '--playlist-start',
258 dest='playliststart', metavar='NUMBER', default=1, type=int,
259 help='Playlist video to start at (default is %default)')
260 selection.add_option(
261 '--playlist-end',
262 dest='playlistend', metavar='NUMBER', default=None, type=int,
263 help='Playlist video to end at (default is last)')
264 selection.add_option(
265 '--playlist-items',
266 dest='playlist_items', metavar='ITEM_SPEC', default=None,
267 help='Playlist video items to download. Specify indices of the videos in the playlist separated by commas like: "--playlist-items 1,2,5,8" if you want to download videos indexed 1, 2, 5, 8 in the playlist. You can specify range: "--playlist-items 1-3,7,10-13", it will download the videos at index 1, 2, 3, 7, 10, 11, 12 and 13.')
268 selection.add_option(
269 '--match-title',
270 dest='matchtitle', metavar='REGEX',
271 help='Download only matching titles (regex or caseless sub-string)')
272 selection.add_option(
273 '--reject-title',
274 dest='rejecttitle', metavar='REGEX',
275 help='Skip download for matching titles (regex or caseless sub-string)')
276 selection.add_option(
277 '--max-downloads',
278 dest='max_downloads', metavar='NUMBER', type=int, default=None,
279 help='Abort after downloading NUMBER files')
280 selection.add_option(
281 '--min-filesize',
282 metavar='SIZE', dest='min_filesize', default=None,
283 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
284 selection.add_option(
285 '--max-filesize',
286 metavar='SIZE', dest='max_filesize', default=None,
287 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
288 selection.add_option(
289 '--date',
290 metavar='DATE', dest='date', default=None,
291 help='Download only videos uploaded in this date')
292 selection.add_option(
293 '--datebefore',
294 metavar='DATE', dest='datebefore', default=None,
295 help='Download only videos uploaded on or before this date (i.e. inclusive)')
296 selection.add_option(
297 '--dateafter',
298 metavar='DATE', dest='dateafter', default=None,
299 help='Download only videos uploaded on or after this date (i.e. inclusive)')
300 selection.add_option(
301 '--min-views',
302 metavar='COUNT', dest='min_views', default=None, type=int,
303 help='Do not download any videos with less than COUNT views')
304 selection.add_option(
305 '--max-views',
306 metavar='COUNT', dest='max_views', default=None, type=int,
307 help='Do not download any videos with more than COUNT views')
308 selection.add_option(
309 '--match-filter',
310 metavar='FILTER', dest='match_filter', default=None,
311 help=(
312 'Generic video filter. '
313 'Specify any key (see help for -o for a list of available keys) to '
314 'match if the key is present, '
315 '!key to check if the key is not present, '
316 'key > NUMBER (like "comment_count > 12", also works with '
317 '>=, <, <=, !=, =) to compare against a number, '
318 'key = \'LITERAL\' (like "uploader = \'Mike Smith\'", also works with !=) '
319 'to match against a string literal '
320 'and & to require multiple matches. '
321 'Values which are not known are excluded unless you '
322 'put a question mark (?) after the operator. '
323 'For example, to only match videos that have been liked more than '
324 '100 times and disliked less than 50 times (or the dislike '
325 'functionality is not available at the given service), but who '
326 'also have a description, use --match-filter '
327 '"like_count > 100 & dislike_count <? 50 & description" .'
328 ))
329 selection.add_option(
330 '--no-playlist',
331 action='store_true', dest='noplaylist', default=False,
332 help='Download only the video, if the URL refers to a video and a playlist.')
333 selection.add_option(
334 '--yes-playlist',
335 action='store_false', dest='noplaylist', default=False,
336 help='Download the playlist, if the URL refers to a video and a playlist.')
337 selection.add_option(
338 '--age-limit',
339 metavar='YEARS', dest='age_limit', default=None, type=int,
340 help='Download only videos suitable for the given age')
341 selection.add_option(
342 '--download-archive', metavar='FILE',
343 dest='download_archive',
344 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
345 selection.add_option(
346 '--include-ads',
347 dest='include_ads', action='store_true',
348 help='Download advertisements as well (experimental)')
349
350 authentication = optparse.OptionGroup(parser, 'Authentication Options')
351 authentication.add_option(
352 '-u', '--username',
353 dest='username', metavar='USERNAME',
354 help='Login with this account ID')
355 authentication.add_option(
356 '-p', '--password',
357 dest='password', metavar='PASSWORD',
358 help='Account password. If this option is left out, youtube-dl will ask interactively.')
359 authentication.add_option(
360 '-2', '--twofactor',
361 dest='twofactor', metavar='TWOFACTOR',
362 help='Two-factor authentication code')
363 authentication.add_option(
364 '-n', '--netrc',
365 action='store_true', dest='usenetrc', default=False,
366 help='Use .netrc authentication data')
367 authentication.add_option(
368 '--video-password',
369 dest='videopassword', metavar='PASSWORD',
370 help='Video password (vimeo, smotri, youku)')
371
372 adobe_pass = optparse.OptionGroup(parser, 'Adobe Pass Options')
373 adobe_pass.add_option(
374 '--ap-mso',
375 dest='ap_mso', metavar='MSO',
376 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
377 adobe_pass.add_option(
378 '--ap-username',
379 dest='ap_username', metavar='USERNAME',
380 help='Multiple-system operator account login')
381 adobe_pass.add_option(
382 '--ap-password',
383 dest='ap_password', metavar='PASSWORD',
384 help='Multiple-system operator account password. If this option is left out, youtube-dl will ask interactively.')
385 adobe_pass.add_option(
386 '--ap-list-mso',
387 action='store_true', dest='ap_list_mso', default=False,
388 help='List all supported multiple-system operators')
389
390 video_format = optparse.OptionGroup(parser, 'Video Format Options')
391 video_format.add_option(
392 '-f', '--format',
393 action='store', dest='format', metavar='FORMAT', default=None,
394 help='Video format code, see the "FORMAT SELECTION" for all the info')
395 video_format.add_option(
396 '--all-formats',
397 action='store_const', dest='format', const='all',
398 help='Download all available video formats')
399 video_format.add_option(
400 '--prefer-free-formats',
401 action='store_true', dest='prefer_free_formats', default=False,
402 help='Prefer free video formats unless a specific one is requested')
403 video_format.add_option(
404 '-F', '--list-formats',
405 action='store_true', dest='listformats',
406 help='List all available formats of requested videos')
407 video_format.add_option(
408 '--youtube-include-dash-manifest',
409 action='store_true', dest='youtube_include_dash_manifest', default=True,
410 help=optparse.SUPPRESS_HELP)
411 video_format.add_option(
412 '--youtube-skip-dash-manifest',
413 action='store_false', dest='youtube_include_dash_manifest',
414 help='Do not download the DASH manifests and related data on YouTube videos')
415 video_format.add_option(
416 '--merge-output-format',
417 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
418 help=(
419 'If a merge is required (e.g. bestvideo+bestaudio), '
420 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
421 'Ignored if no merge is required'))
422
423 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
424 subtitles.add_option(
425 '--write-sub', '--write-srt',
426 action='store_true', dest='writesubtitles', default=False,
427 help='Write subtitle file')
428 subtitles.add_option(
429 '--write-auto-sub', '--write-automatic-sub',
430 action='store_true', dest='writeautomaticsub', default=False,
431 help='Write automatically generated subtitle file (YouTube only)')
432 subtitles.add_option(
433 '--all-subs',
434 action='store_true', dest='allsubtitles', default=False,
435 help='Download all the available subtitles of the video')
436 subtitles.add_option(
437 '--list-subs',
438 action='store_true', dest='listsubtitles', default=False,
439 help='List all available subtitles for the video')
440 subtitles.add_option(
441 '--sub-format',
442 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
443 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
444 subtitles.add_option(
445 '--sub-lang', '--sub-langs', '--srt-lang',
446 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
447 default=[], callback=_comma_separated_values_options_callback,
448 help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
449
450 downloader = optparse.OptionGroup(parser, 'Download Options')
451 downloader.add_option(
452 '-r', '--limit-rate', '--rate-limit',
453 dest='ratelimit', metavar='RATE',
454 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
455 downloader.add_option(
456 '-R', '--retries',
457 dest='retries', metavar='RETRIES', default=10,
458 help='Number of retries (default is %default), or "infinite".')
459 downloader.add_option(
460 '--fragment-retries',
461 dest='fragment_retries', metavar='RETRIES', default=10,
462 help='Number of retries for a fragment (default is %default), or "infinite" (DASH and hlsnative only)')
463 downloader.add_option(
464 '--skip-unavailable-fragments',
465 action='store_true', dest='skip_unavailable_fragments', default=True,
466 help='Skip unavailable fragments (DASH and hlsnative only)')
467 downloader.add_option(
468 '--abort-on-unavailable-fragment',
469 action='store_false', dest='skip_unavailable_fragments',
470 help='Abort downloading when some fragment is not available')
471 downloader.add_option(
472 '--buffer-size',
473 dest='buffersize', metavar='SIZE', default='1024',
474 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
475 downloader.add_option(
476 '--no-resize-buffer',
477 action='store_true', dest='noresizebuffer', default=False,
478 help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
479 downloader.add_option(
480 '--test',
481 action='store_true', dest='test', default=False,
482 help=optparse.SUPPRESS_HELP)
483 downloader.add_option(
484 '--playlist-reverse',
485 action='store_true',
486 help='Download playlist videos in reverse order')
487 downloader.add_option(
488 '--playlist-random',
489 action='store_true',
490 help='Download playlist videos in random order')
491 downloader.add_option(
492 '--xattr-set-filesize',
493 dest='xattr_set_filesize', action='store_true',
494 help='Set file xattribute ytdl.filesize with expected file size (experimental)')
495 downloader.add_option(
496 '--hls-prefer-native',
497 dest='hls_prefer_native', action='store_true', default=None,
498 help='Use the native HLS downloader instead of ffmpeg')
499 downloader.add_option(
500 '--hls-prefer-ffmpeg',
501 dest='hls_prefer_native', action='store_false', default=None,
502 help='Use ffmpeg instead of the native HLS downloader')
503 downloader.add_option(
504 '--hls-use-mpegts',
505 dest='hls_use_mpegts', action='store_true',
506 help='Use the mpegts container for HLS videos, allowing to play the '
507 'video while downloading (some players may not be able to play it)')
508 downloader.add_option(
509 '--external-downloader',
510 dest='external_downloader', metavar='COMMAND',
511 help='Use the specified external downloader. '
512 'Currently supports %s' % ','.join(list_external_downloaders()))
513 downloader.add_option(
514 '--external-downloader-args',
515 dest='external_downloader_args', metavar='ARGS',
516 help='Give these arguments to the external downloader')
517
518 workarounds = optparse.OptionGroup(parser, 'Workarounds')
519 workarounds.add_option(
520 '--encoding',
521 dest='encoding', metavar='ENCODING',
522 help='Force the specified encoding (experimental)')
523 workarounds.add_option(
524 '--no-check-certificate',
525 action='store_true', dest='no_check_certificate', default=False,
526 help='Suppress HTTPS certificate validation')
527 workarounds.add_option(
528 '--prefer-insecure',
529 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
530 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
531 workarounds.add_option(
532 '--user-agent',
533 metavar='UA', dest='user_agent',
534 help='Specify a custom user agent')
535 workarounds.add_option(
536 '--referer',
537 metavar='URL', dest='referer', default=None,
538 help='Specify a custom referer, use if the video access is restricted to one domain',
539 )
540 workarounds.add_option(
541 '--add-header',
542 metavar='FIELD:VALUE', dest='headers', action='append',
543 help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
544 )
545 workarounds.add_option(
546 '--bidi-workaround',
547 dest='bidi_workaround', action='store_true',
548 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
549 workarounds.add_option(
550 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
551 dest='sleep_interval', type=float,
552 help=(
553 'Number of seconds to sleep before each download when used alone '
554 'or a lower bound of a range for randomized sleep before each download '
555 '(minimum possible number of seconds to sleep) when used along with '
556 '--max-sleep-interval.'))
557 workarounds.add_option(
558 '--max-sleep-interval', metavar='SECONDS',
559 dest='max_sleep_interval', type=float,
560 help=(
561 'Upper bound of a range for randomized sleep before each download '
562 '(maximum possible number of seconds to sleep). Must only be used '
563 'along with --min-sleep-interval.'))
564
565 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
566 verbosity.add_option(
567 '-q', '--quiet',
568 action='store_true', dest='quiet', default=False,
569 help='Activate quiet mode')
570 verbosity.add_option(
571 '--no-warnings',
572 dest='no_warnings', action='store_true', default=False,
573 help='Ignore warnings')
574 verbosity.add_option(
575 '-s', '--simulate',
576 action='store_true', dest='simulate', default=False,
577 help='Do not download the video and do not write anything to disk')
578 verbosity.add_option(
579 '--skip-download',
580 action='store_true', dest='skip_download', default=False,
581 help='Do not download the video')
582 verbosity.add_option(
583 '-g', '--get-url',
584 action='store_true', dest='geturl', default=False,
585 help='Simulate, quiet but print URL')
586 verbosity.add_option(
587 '-e', '--get-title',
588 action='store_true', dest='gettitle', default=False,
589 help='Simulate, quiet but print title')
590 verbosity.add_option(
591 '--get-id',
592 action='store_true', dest='getid', default=False,
593 help='Simulate, quiet but print id')
594 verbosity.add_option(
595 '--get-thumbnail',
596 action='store_true', dest='getthumbnail', default=False,
597 help='Simulate, quiet but print thumbnail URL')
598 verbosity.add_option(
599 '--get-description',
600 action='store_true', dest='getdescription', default=False,
601 help='Simulate, quiet but print video description')
602 verbosity.add_option(
603 '--get-duration',
604 action='store_true', dest='getduration', default=False,
605 help='Simulate, quiet but print video length')
606 verbosity.add_option(
607 '--get-filename',
608 action='store_true', dest='getfilename', default=False,
609 help='Simulate, quiet but print output filename')
610 verbosity.add_option(
611 '--get-format',
612 action='store_true', dest='getformat', default=False,
613 help='Simulate, quiet but print output format')
614 verbosity.add_option(
615 '-j', '--dump-json',
616 action='store_true', dest='dumpjson', default=False,
617 help='Simulate, quiet but print JSON information. See --output for a description of available keys.')
618 verbosity.add_option(
619 '-J', '--dump-single-json',
620 action='store_true', dest='dump_single_json', default=False,
621 help='Simulate, quiet but print JSON information for each command-line argument. If the URL refers to a playlist, dump the whole playlist information in a single line.')
622 verbosity.add_option(
623 '--print-json',
624 action='store_true', dest='print_json', default=False,
625 help='Be quiet and print the video information as JSON (video is still being downloaded).',
626 )
627 verbosity.add_option(
628 '--newline',
629 action='store_true', dest='progress_with_newline', default=False,
630 help='Output progress bar as new lines')
631 verbosity.add_option(
632 '--no-progress',
633 action='store_true', dest='noprogress', default=False,
634 help='Do not print progress bar')
635 verbosity.add_option(
636 '--console-title',
637 action='store_true', dest='consoletitle', default=False,
638 help='Display progress in console titlebar')
639 verbosity.add_option(
640 '-v', '--verbose',
641 action='store_true', dest='verbose', default=False,
642 help='Print various debugging information')
643 verbosity.add_option(
644 '--dump-pages', '--dump-intermediate-pages',
645 action='store_true', dest='dump_intermediate_pages', default=False,
646 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
647 verbosity.add_option(
648 '--write-pages',
649 action='store_true', dest='write_pages', default=False,
650 help='Write downloaded intermediary pages to files in the current directory to debug problems')
651 verbosity.add_option(
652 '--youtube-print-sig-code',
653 action='store_true', dest='youtube_print_sig_code', default=False,
654 help=optparse.SUPPRESS_HELP)
655 verbosity.add_option(
656 '--print-traffic', '--dump-headers',
657 dest='debug_printtraffic', action='store_true', default=False,
658 help='Display sent and read HTTP traffic')
659 verbosity.add_option(
660 '-C', '--call-home',
661 dest='call_home', action='store_true', default=False,
662 help='Contact the youtube-dl server for debugging')
663 verbosity.add_option(
664 '--no-call-home',
665 dest='call_home', action='store_false', default=False,
666 help='Do NOT contact the youtube-dl server for debugging')
667
668 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
669 filesystem.add_option(
670 '-a', '--batch-file',
671 dest='batchfile', metavar='FILE',
672 help='File containing URLs to download (\'-\' for stdin)')
673 filesystem.add_option(
674 '--id', default=False,
675 action='store_true', dest='useid', help='Use only video ID in file name')
676 filesystem.add_option(
677 '-o', '--output',
678 dest='outtmpl', metavar='TEMPLATE',
679 help=('Output filename template, see the "OUTPUT TEMPLATE" for all the info'))
680 filesystem.add_option(
681 '--autonumber-size',
682 dest='autonumber_size', metavar='NUMBER', type=int,
683 help=optparse.SUPPRESS_HELP)
684 filesystem.add_option(
685 '--autonumber-start',
686 dest='autonumber_start', metavar='NUMBER', default=1, type=int,
687 help='Specify the start value for %(autonumber)s (default is %default)')
688 filesystem.add_option(
689 '--restrict-filenames',
690 action='store_true', dest='restrictfilenames', default=False,
691 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
692 filesystem.add_option(
693 '-A', '--auto-number',
694 action='store_true', dest='autonumber', default=False,
695 help=optparse.SUPPRESS_HELP)
696 filesystem.add_option(
697 '-t', '--title',
698 action='store_true', dest='usetitle', default=False,
699 help=optparse.SUPPRESS_HELP)
700 filesystem.add_option(
701 '-l', '--literal', default=False,
702 action='store_true', dest='usetitle',
703 help=optparse.SUPPRESS_HELP)
704 filesystem.add_option(
705 '-w', '--no-overwrites',
706 action='store_true', dest='nooverwrites', default=False,
707 help='Do not overwrite files')
708 filesystem.add_option(
709 '-c', '--continue',
710 action='store_true', dest='continue_dl', default=True,
711 help='Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
712 filesystem.add_option(
713 '--no-continue',
714 action='store_false', dest='continue_dl',
715 help='Do not resume partially downloaded files (restart from beginning)')
716 filesystem.add_option(
717 '--no-part',
718 action='store_true', dest='nopart', default=False,
719 help='Do not use .part files - write directly into output file')
720 filesystem.add_option(
721 '--no-mtime',
722 action='store_false', dest='updatetime', default=True,
723 help='Do not use the Last-modified header to set the file modification time')
724 filesystem.add_option(
725 '--write-description',
726 action='store_true', dest='writedescription', default=False,
727 help='Write video description to a .description file')
728 filesystem.add_option(
729 '--write-info-json',
730 action='store_true', dest='writeinfojson', default=False,
731 help='Write video metadata to a .info.json file')
732 filesystem.add_option(
733 '--write-annotations',
734 action='store_true', dest='writeannotations', default=False,
735 help='Write video annotations to a .annotations.xml file')
736 filesystem.add_option(
737 '--load-info-json', '--load-info',
738 dest='load_info_filename', metavar='FILE',
739 help='JSON file containing the video information (created with the "--write-info-json" option)')
740 filesystem.add_option(
741 '--cookies',
742 dest='cookiefile', metavar='FILE',
743 help='File to read cookies from and dump cookie jar in')
744 filesystem.add_option(
745 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
746 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.')
747 filesystem.add_option(
748 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
749 help='Disable filesystem caching')
750 filesystem.add_option(
751 '--rm-cache-dir',
752 action='store_true', dest='rm_cachedir',
753 help='Delete all filesystem cache files')
754
755 thumbnail = optparse.OptionGroup(parser, 'Thumbnail images')
756 thumbnail.add_option(
757 '--write-thumbnail',
758 action='store_true', dest='writethumbnail', default=False,
759 help='Write thumbnail image to disk')
760 thumbnail.add_option(
761 '--write-all-thumbnails',
762 action='store_true', dest='write_all_thumbnails', default=False,
763 help='Write all thumbnail image formats to disk')
764 thumbnail.add_option(
765 '--list-thumbnails',
766 action='store_true', dest='list_thumbnails', default=False,
767 help='Simulate and list all available thumbnail formats')
768
769 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
770 postproc.add_option(
771 '-x', '--extract-audio',
772 action='store_true', dest='extractaudio', default=False,
773 help='Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
774 postproc.add_option(
775 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
776 help='Specify audio format: "best", "aac", "flac", "mp3", "m4a", "opus", "vorbis", or "wav"; "%default" by default; No effect without -x')
777 postproc.add_option(
778 '--audio-quality', metavar='QUALITY',
779 dest='audioquality', default='5',
780 help='Specify ffmpeg/avconv audio quality, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default %default)')
781 postproc.add_option(
782 '--recode-video',
783 metavar='FORMAT', dest='recodevideo', default=None,
784 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
785 postproc.add_option(
786 '--postprocessor-args',
787 dest='postprocessor_args', metavar='ARGS',
788 help='Give these arguments to the postprocessor')
789 postproc.add_option(
790 '-k', '--keep-video',
791 action='store_true', dest='keepvideo', default=False,
792 help='Keep the video file on disk after the post-processing; the video is erased by default')
793 postproc.add_option(
794 '--no-post-overwrites',
795 action='store_true', dest='nopostoverwrites', default=False,
796 help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
797 postproc.add_option(
798 '--embed-subs',
799 action='store_true', dest='embedsubtitles', default=False,
800 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
801 postproc.add_option(
802 '--embed-thumbnail',
803 action='store_true', dest='embedthumbnail', default=False,
804 help='Embed thumbnail in the audio as cover art')
805 postproc.add_option(
806 '--add-metadata',
807 action='store_true', dest='addmetadata', default=False,
808 help='Write metadata to the video file')
809 postproc.add_option(
810 '--metadata-from-title',
811 metavar='FORMAT', dest='metafromtitle',
812 help='Parse additional metadata like song title / artist from the video title. '
813 'The format syntax is the same as --output, '
814 'the parsed parameters replace existing values. '
815 'Additional templates: %(album)s, %(artist)s. '
816 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
817 '"Coldplay - Paradise"')
818 postproc.add_option(
819 '--xattrs',
820 action='store_true', dest='xattrs', default=False,
821 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
822 postproc.add_option(
823 '--fixup',
824 metavar='POLICY', dest='fixup', default='detect_or_warn',
825 help='Automatically correct known faults of the file. '
826 'One of never (do nothing), warn (only emit a warning), '
827 'detect_or_warn (the default; fix file if we can, warn otherwise)')
828 postproc.add_option(
829 '--prefer-avconv',
830 action='store_false', dest='prefer_ffmpeg',
831 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
832 postproc.add_option(
833 '--prefer-ffmpeg',
834 action='store_true', dest='prefer_ffmpeg',
835 help='Prefer ffmpeg over avconv for running the postprocessors')
836 postproc.add_option(
837 '--ffmpeg-location', '--avconv-location', metavar='PATH',
838 dest='ffmpeg_location',
839 help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
840 postproc.add_option(
841 '--exec',
842 metavar='CMD', dest='exec_cmd',
843 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
844 postproc.add_option(
845 '--convert-subs', '--convert-subtitles',
846 metavar='FORMAT', dest='convertsubtitles', default=None,
847 help='Convert the subtitles to other format (currently supported: srt|ass|vtt)')
848
849 parser.add_option_group(general)
850 parser.add_option_group(network)
851 parser.add_option_group(geo)
852 parser.add_option_group(selection)
853 parser.add_option_group(downloader)
854 parser.add_option_group(filesystem)
855 parser.add_option_group(thumbnail)
856 parser.add_option_group(verbosity)
857 parser.add_option_group(workarounds)
858 parser.add_option_group(video_format)
859 parser.add_option_group(subtitles)
860 parser.add_option_group(authentication)
861 parser.add_option_group(adobe_pass)
862 parser.add_option_group(postproc)
863
864 if overrideArguments is not None:
865 opts, args = parser.parse_args(overrideArguments)
866 if opts.verbose:
867 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
868 else:
869 def compat_conf(conf):
870 if sys.version_info < (3,):
871 return [a.decode(preferredencoding(), 'replace') for a in conf]
872 return conf
873
874 command_line_conf = compat_conf(sys.argv[1:])
875 opts, args = parser.parse_args(command_line_conf)
876
877 system_conf = user_conf = custom_conf = []
878
879 if '--config-location' in command_line_conf:
880 location = compat_expanduser(opts.config_location)
881 if os.path.isdir(location):
882 location = os.path.join(location, 'youtube-dl.conf')
883 if not os.path.exists(location):
884 parser.error('config-location %s does not exist.' % location)
885 custom_conf = _readOptions(location)
886 elif '--ignore-config' in command_line_conf:
887 pass
888 else:
889 system_conf = _readOptions('/etc/youtube-dl.conf')
890 if '--ignore-config' not in system_conf:
891 user_conf = _readUserConf()
892
893 argv = system_conf + user_conf + custom_conf + command_line_conf
894 opts, args = parser.parse_args(argv)
895 if opts.verbose:
896 for conf_label, conf in (
897 ('System config', system_conf),
898 ('User config', user_conf),
899 ('Custom config', custom_conf),
900 ('Command-line args', command_line_conf)):
901 write_string('[debug] %s: %s\n' % (conf_label, repr(_hide_login_info(conf))))
902
903 return parser, opts, args