]> Raphaƫl G. Git Repositories - youtubedl/blob - youtube_dl/options.py
349f44778e799af0c58b249939f14958036080a1
[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 network.add_option(
232 '--geo-verification-proxy',
233 dest='geo_verification_proxy', default=None, metavar='URL',
234 help='Use this proxy to verify the IP address for some geo-restricted sites. '
235 'The default proxy specified by --proxy (or none, if the options is not present) is used for the actual downloading.'
236 )
237 network.add_option(
238 '--cn-verification-proxy',
239 dest='cn_verification_proxy', default=None, metavar='URL',
240 help=optparse.SUPPRESS_HELP,
241 )
242
243 selection = optparse.OptionGroup(parser, 'Video Selection')
244 selection.add_option(
245 '--playlist-start',
246 dest='playliststart', metavar='NUMBER', default=1, type=int,
247 help='Playlist video to start at (default is %default)')
248 selection.add_option(
249 '--playlist-end',
250 dest='playlistend', metavar='NUMBER', default=None, type=int,
251 help='Playlist video to end at (default is last)')
252 selection.add_option(
253 '--playlist-items',
254 dest='playlist_items', metavar='ITEM_SPEC', default=None,
255 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.')
256 selection.add_option(
257 '--match-title',
258 dest='matchtitle', metavar='REGEX',
259 help='Download only matching titles (regex or caseless sub-string)')
260 selection.add_option(
261 '--reject-title',
262 dest='rejecttitle', metavar='REGEX',
263 help='Skip download for matching titles (regex or caseless sub-string)')
264 selection.add_option(
265 '--max-downloads',
266 dest='max_downloads', metavar='NUMBER', type=int, default=None,
267 help='Abort after downloading NUMBER files')
268 selection.add_option(
269 '--min-filesize',
270 metavar='SIZE', dest='min_filesize', default=None,
271 help='Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)')
272 selection.add_option(
273 '--max-filesize',
274 metavar='SIZE', dest='max_filesize', default=None,
275 help='Do not download any videos larger than SIZE (e.g. 50k or 44.6m)')
276 selection.add_option(
277 '--date',
278 metavar='DATE', dest='date', default=None,
279 help='Download only videos uploaded in this date')
280 selection.add_option(
281 '--datebefore',
282 metavar='DATE', dest='datebefore', default=None,
283 help='Download only videos uploaded on or before this date (i.e. inclusive)')
284 selection.add_option(
285 '--dateafter',
286 metavar='DATE', dest='dateafter', default=None,
287 help='Download only videos uploaded on or after this date (i.e. inclusive)')
288 selection.add_option(
289 '--min-views',
290 metavar='COUNT', dest='min_views', default=None, type=int,
291 help='Do not download any videos with less than COUNT views')
292 selection.add_option(
293 '--max-views',
294 metavar='COUNT', dest='max_views', default=None, type=int,
295 help='Do not download any videos with more than COUNT views')
296 selection.add_option(
297 '--match-filter',
298 metavar='FILTER', dest='match_filter', default=None,
299 help=(
300 'Generic video filter. '
301 'Specify any key (see help for -o for a list of available keys) to'
302 ' match if the key is present, '
303 '!key to check if the key is not present,'
304 'key > NUMBER (like "comment_count > 12", also works with '
305 '>=, <, <=, !=, =) to compare against a number, and '
306 '& to require multiple matches. '
307 'Values which are not known are excluded unless you'
308 ' put a question mark (?) after the operator.'
309 'For example, to only match videos that have been liked more than '
310 '100 times and disliked less than 50 times (or the dislike '
311 'functionality is not available at the given service), but who '
312 'also have a description, use --match-filter '
313 '"like_count > 100 & dislike_count <? 50 & description" .'
314 ))
315 selection.add_option(
316 '--no-playlist',
317 action='store_true', dest='noplaylist', default=False,
318 help='Download only the video, if the URL refers to a video and a playlist.')
319 selection.add_option(
320 '--yes-playlist',
321 action='store_false', dest='noplaylist', default=False,
322 help='Download the playlist, if the URL refers to a video and a playlist.')
323 selection.add_option(
324 '--age-limit',
325 metavar='YEARS', dest='age_limit', default=None, type=int,
326 help='Download only videos suitable for the given age')
327 selection.add_option(
328 '--download-archive', metavar='FILE',
329 dest='download_archive',
330 help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
331 selection.add_option(
332 '--include-ads',
333 dest='include_ads', action='store_true',
334 help='Download advertisements as well (experimental)')
335
336 authentication = optparse.OptionGroup(parser, 'Authentication Options')
337 authentication.add_option(
338 '-u', '--username',
339 dest='username', metavar='USERNAME',
340 help='Login with this account ID')
341 authentication.add_option(
342 '-p', '--password',
343 dest='password', metavar='PASSWORD',
344 help='Account password. If this option is left out, youtube-dl will ask interactively.')
345 authentication.add_option(
346 '-2', '--twofactor',
347 dest='twofactor', metavar='TWOFACTOR',
348 help='Two-factor authentication code')
349 authentication.add_option(
350 '-n', '--netrc',
351 action='store_true', dest='usenetrc', default=False,
352 help='Use .netrc authentication data')
353 authentication.add_option(
354 '--video-password',
355 dest='videopassword', metavar='PASSWORD',
356 help='Video password (vimeo, smotri, youku)')
357
358 adobe_pass = optparse.OptionGroup(parser, 'Adobe Pass Options')
359 adobe_pass.add_option(
360 '--ap-mso',
361 dest='ap_mso', metavar='MSO',
362 help='Adobe Pass multiple-system operator (TV provider) identifier, use --ap-list-mso for a list of available MSOs')
363 adobe_pass.add_option(
364 '--ap-username',
365 dest='ap_username', metavar='USERNAME',
366 help='Multiple-system operator account login')
367 adobe_pass.add_option(
368 '--ap-password',
369 dest='ap_password', metavar='PASSWORD',
370 help='Multiple-system operator account password. If this option is left out, youtube-dl will ask interactively.')
371 adobe_pass.add_option(
372 '--ap-list-mso',
373 action='store_true', dest='ap_list_mso', default=False,
374 help='List all supported multiple-system operators')
375
376 video_format = optparse.OptionGroup(parser, 'Video Format Options')
377 video_format.add_option(
378 '-f', '--format',
379 action='store', dest='format', metavar='FORMAT', default=None,
380 help='Video format code, see the "FORMAT SELECTION" for all the info')
381 video_format.add_option(
382 '--all-formats',
383 action='store_const', dest='format', const='all',
384 help='Download all available video formats')
385 video_format.add_option(
386 '--prefer-free-formats',
387 action='store_true', dest='prefer_free_formats', default=False,
388 help='Prefer free video formats unless a specific one is requested')
389 video_format.add_option(
390 '-F', '--list-formats',
391 action='store_true', dest='listformats',
392 help='List all available formats of requested videos')
393 video_format.add_option(
394 '--youtube-include-dash-manifest',
395 action='store_true', dest='youtube_include_dash_manifest', default=True,
396 help=optparse.SUPPRESS_HELP)
397 video_format.add_option(
398 '--youtube-skip-dash-manifest',
399 action='store_false', dest='youtube_include_dash_manifest',
400 help='Do not download the DASH manifests and related data on YouTube videos')
401 video_format.add_option(
402 '--merge-output-format',
403 action='store', dest='merge_output_format', metavar='FORMAT', default=None,
404 help=(
405 'If a merge is required (e.g. bestvideo+bestaudio), '
406 'output to given container format. One of mkv, mp4, ogg, webm, flv. '
407 'Ignored if no merge is required'))
408
409 subtitles = optparse.OptionGroup(parser, 'Subtitle Options')
410 subtitles.add_option(
411 '--write-sub', '--write-srt',
412 action='store_true', dest='writesubtitles', default=False,
413 help='Write subtitle file')
414 subtitles.add_option(
415 '--write-auto-sub', '--write-automatic-sub',
416 action='store_true', dest='writeautomaticsub', default=False,
417 help='Write automatically generated subtitle file (YouTube only)')
418 subtitles.add_option(
419 '--all-subs',
420 action='store_true', dest='allsubtitles', default=False,
421 help='Download all the available subtitles of the video')
422 subtitles.add_option(
423 '--list-subs',
424 action='store_true', dest='listsubtitles', default=False,
425 help='List all available subtitles for the video')
426 subtitles.add_option(
427 '--sub-format',
428 action='store', dest='subtitlesformat', metavar='FORMAT', default='best',
429 help='Subtitle format, accepts formats preference, for example: "srt" or "ass/srt/best"')
430 subtitles.add_option(
431 '--sub-lang', '--sub-langs', '--srt-lang',
432 action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
433 default=[], callback=_comma_separated_values_options_callback,
434 help='Languages of the subtitles to download (optional) separated by commas, use --list-subs for available language tags')
435
436 downloader = optparse.OptionGroup(parser, 'Download Options')
437 downloader.add_option(
438 '-r', '--limit-rate', '--rate-limit',
439 dest='ratelimit', metavar='RATE',
440 help='Maximum download rate in bytes per second (e.g. 50K or 4.2M)')
441 downloader.add_option(
442 '-R', '--retries',
443 dest='retries', metavar='RETRIES', default=10,
444 help='Number of retries (default is %default), or "infinite".')
445 downloader.add_option(
446 '--fragment-retries',
447 dest='fragment_retries', metavar='RETRIES', default=10,
448 help='Number of retries for a fragment (default is %default), or "infinite" (DASH and hlsnative only)')
449 downloader.add_option(
450 '--skip-unavailable-fragments',
451 action='store_true', dest='skip_unavailable_fragments', default=True,
452 help='Skip unavailable fragments (DASH and hlsnative only)')
453 downloader.add_option(
454 '--abort-on-unavailable-fragment',
455 action='store_false', dest='skip_unavailable_fragments',
456 help='Abort downloading when some fragment is not available')
457 downloader.add_option(
458 '--buffer-size',
459 dest='buffersize', metavar='SIZE', default='1024',
460 help='Size of download buffer (e.g. 1024 or 16K) (default is %default)')
461 downloader.add_option(
462 '--no-resize-buffer',
463 action='store_true', dest='noresizebuffer', default=False,
464 help='Do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.')
465 downloader.add_option(
466 '--test',
467 action='store_true', dest='test', default=False,
468 help=optparse.SUPPRESS_HELP)
469 downloader.add_option(
470 '--playlist-reverse',
471 action='store_true',
472 help='Download playlist videos in reverse order')
473 downloader.add_option(
474 '--playlist-random',
475 action='store_true',
476 help='Download playlist videos in random order')
477 downloader.add_option(
478 '--xattr-set-filesize',
479 dest='xattr_set_filesize', action='store_true',
480 help='Set file xattribute ytdl.filesize with expected file size (experimental)')
481 downloader.add_option(
482 '--hls-prefer-native',
483 dest='hls_prefer_native', action='store_true', default=None,
484 help='Use the native HLS downloader instead of ffmpeg')
485 downloader.add_option(
486 '--hls-prefer-ffmpeg',
487 dest='hls_prefer_native', action='store_false', default=None,
488 help='Use ffmpeg instead of the native HLS downloader')
489 downloader.add_option(
490 '--hls-use-mpegts',
491 dest='hls_use_mpegts', action='store_true',
492 help='Use the mpegts container for HLS videos, allowing to play the '
493 'video while downloading (some players may not be able to play it)')
494 downloader.add_option(
495 '--external-downloader',
496 dest='external_downloader', metavar='COMMAND',
497 help='Use the specified external downloader. '
498 'Currently supports %s' % ','.join(list_external_downloaders()))
499 downloader.add_option(
500 '--external-downloader-args',
501 dest='external_downloader_args', metavar='ARGS',
502 help='Give these arguments to the external downloader')
503
504 workarounds = optparse.OptionGroup(parser, 'Workarounds')
505 workarounds.add_option(
506 '--encoding',
507 dest='encoding', metavar='ENCODING',
508 help='Force the specified encoding (experimental)')
509 workarounds.add_option(
510 '--no-check-certificate',
511 action='store_true', dest='no_check_certificate', default=False,
512 help='Suppress HTTPS certificate validation')
513 workarounds.add_option(
514 '--prefer-insecure',
515 '--prefer-unsecure', action='store_true', dest='prefer_insecure',
516 help='Use an unencrypted connection to retrieve information about the video. (Currently supported only for YouTube)')
517 workarounds.add_option(
518 '--user-agent',
519 metavar='UA', dest='user_agent',
520 help='Specify a custom user agent')
521 workarounds.add_option(
522 '--referer',
523 metavar='URL', dest='referer', default=None,
524 help='Specify a custom referer, use if the video access is restricted to one domain',
525 )
526 workarounds.add_option(
527 '--add-header',
528 metavar='FIELD:VALUE', dest='headers', action='append',
529 help='Specify a custom HTTP header and its value, separated by a colon \':\'. You can use this option multiple times',
530 )
531 workarounds.add_option(
532 '--bidi-workaround',
533 dest='bidi_workaround', action='store_true',
534 help='Work around terminals that lack bidirectional text support. Requires bidiv or fribidi executable in PATH')
535 workarounds.add_option(
536 '--sleep-interval', '--min-sleep-interval', metavar='SECONDS',
537 dest='sleep_interval', type=float,
538 help=(
539 'Number of seconds to sleep before each download when used alone '
540 'or a lower bound of a range for randomized sleep before each download '
541 '(minimum possible number of seconds to sleep) when used along with '
542 '--max-sleep-interval.'))
543 workarounds.add_option(
544 '--max-sleep-interval', metavar='SECONDS',
545 dest='max_sleep_interval', type=float,
546 help=(
547 'Upper bound of a range for randomized sleep before each download '
548 '(maximum possible number of seconds to sleep). Must only be used '
549 'along with --min-sleep-interval.'))
550
551 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
552 verbosity.add_option(
553 '-q', '--quiet',
554 action='store_true', dest='quiet', default=False,
555 help='Activate quiet mode')
556 verbosity.add_option(
557 '--no-warnings',
558 dest='no_warnings', action='store_true', default=False,
559 help='Ignore warnings')
560 verbosity.add_option(
561 '-s', '--simulate',
562 action='store_true', dest='simulate', default=False,
563 help='Do not download the video and do not write anything to disk')
564 verbosity.add_option(
565 '--skip-download',
566 action='store_true', dest='skip_download', default=False,
567 help='Do not download the video')
568 verbosity.add_option(
569 '-g', '--get-url',
570 action='store_true', dest='geturl', default=False,
571 help='Simulate, quiet but print URL')
572 verbosity.add_option(
573 '-e', '--get-title',
574 action='store_true', dest='gettitle', default=False,
575 help='Simulate, quiet but print title')
576 verbosity.add_option(
577 '--get-id',
578 action='store_true', dest='getid', default=False,
579 help='Simulate, quiet but print id')
580 verbosity.add_option(
581 '--get-thumbnail',
582 action='store_true', dest='getthumbnail', default=False,
583 help='Simulate, quiet but print thumbnail URL')
584 verbosity.add_option(
585 '--get-description',
586 action='store_true', dest='getdescription', default=False,
587 help='Simulate, quiet but print video description')
588 verbosity.add_option(
589 '--get-duration',
590 action='store_true', dest='getduration', default=False,
591 help='Simulate, quiet but print video length')
592 verbosity.add_option(
593 '--get-filename',
594 action='store_true', dest='getfilename', default=False,
595 help='Simulate, quiet but print output filename')
596 verbosity.add_option(
597 '--get-format',
598 action='store_true', dest='getformat', default=False,
599 help='Simulate, quiet but print output format')
600 verbosity.add_option(
601 '-j', '--dump-json',
602 action='store_true', dest='dumpjson', default=False,
603 help='Simulate, quiet but print JSON information. See --output for a description of available keys.')
604 verbosity.add_option(
605 '-J', '--dump-single-json',
606 action='store_true', dest='dump_single_json', default=False,
607 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.')
608 verbosity.add_option(
609 '--print-json',
610 action='store_true', dest='print_json', default=False,
611 help='Be quiet and print the video information as JSON (video is still being downloaded).',
612 )
613 verbosity.add_option(
614 '--newline',
615 action='store_true', dest='progress_with_newline', default=False,
616 help='Output progress bar as new lines')
617 verbosity.add_option(
618 '--no-progress',
619 action='store_true', dest='noprogress', default=False,
620 help='Do not print progress bar')
621 verbosity.add_option(
622 '--console-title',
623 action='store_true', dest='consoletitle', default=False,
624 help='Display progress in console titlebar')
625 verbosity.add_option(
626 '-v', '--verbose',
627 action='store_true', dest='verbose', default=False,
628 help='Print various debugging information')
629 verbosity.add_option(
630 '--dump-pages', '--dump-intermediate-pages',
631 action='store_true', dest='dump_intermediate_pages', default=False,
632 help='Print downloaded pages encoded using base64 to debug problems (very verbose)')
633 verbosity.add_option(
634 '--write-pages',
635 action='store_true', dest='write_pages', default=False,
636 help='Write downloaded intermediary pages to files in the current directory to debug problems')
637 verbosity.add_option(
638 '--youtube-print-sig-code',
639 action='store_true', dest='youtube_print_sig_code', default=False,
640 help=optparse.SUPPRESS_HELP)
641 verbosity.add_option(
642 '--print-traffic', '--dump-headers',
643 dest='debug_printtraffic', action='store_true', default=False,
644 help='Display sent and read HTTP traffic')
645 verbosity.add_option(
646 '-C', '--call-home',
647 dest='call_home', action='store_true', default=False,
648 help='Contact the youtube-dl server for debugging')
649 verbosity.add_option(
650 '--no-call-home',
651 dest='call_home', action='store_false', default=False,
652 help='Do NOT contact the youtube-dl server for debugging')
653
654 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
655 filesystem.add_option(
656 '-a', '--batch-file',
657 dest='batchfile', metavar='FILE',
658 help='File containing URLs to download (\'-\' for stdin)')
659 filesystem.add_option(
660 '--id', default=False,
661 action='store_true', dest='useid', help='Use only video ID in file name')
662 filesystem.add_option(
663 '-o', '--output',
664 dest='outtmpl', metavar='TEMPLATE',
665 help=('Output filename template, see the "OUTPUT TEMPLATE" for all the info'))
666 filesystem.add_option(
667 '--autonumber-size',
668 dest='autonumber_size', metavar='NUMBER', default=5, type=int,
669 help='Specify the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given (default is %default)')
670 filesystem.add_option(
671 '--autonumber-start',
672 dest='autonumber_start', metavar='NUMBER', default=1, type=int,
673 help='Specify the start value for %(autonumber)s (default is %default)')
674 filesystem.add_option(
675 '--restrict-filenames',
676 action='store_true', dest='restrictfilenames', default=False,
677 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames')
678 filesystem.add_option(
679 '-A', '--auto-number',
680 action='store_true', dest='autonumber', default=False,
681 help='[deprecated; use -o "%(autonumber)s-%(title)s.%(ext)s" ] Number downloaded files starting from 00000')
682 filesystem.add_option(
683 '-t', '--title',
684 action='store_true', dest='usetitle', default=False,
685 help='[deprecated] Use title in file name (default)')
686 filesystem.add_option(
687 '-l', '--literal', default=False,
688 action='store_true', dest='usetitle',
689 help='[deprecated] Alias of --title')
690 filesystem.add_option(
691 '-w', '--no-overwrites',
692 action='store_true', dest='nooverwrites', default=False,
693 help='Do not overwrite files')
694 filesystem.add_option(
695 '-c', '--continue',
696 action='store_true', dest='continue_dl', default=True,
697 help='Force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.')
698 filesystem.add_option(
699 '--no-continue',
700 action='store_false', dest='continue_dl',
701 help='Do not resume partially downloaded files (restart from beginning)')
702 filesystem.add_option(
703 '--no-part',
704 action='store_true', dest='nopart', default=False,
705 help='Do not use .part files - write directly into output file')
706 filesystem.add_option(
707 '--no-mtime',
708 action='store_false', dest='updatetime', default=True,
709 help='Do not use the Last-modified header to set the file modification time')
710 filesystem.add_option(
711 '--write-description',
712 action='store_true', dest='writedescription', default=False,
713 help='Write video description to a .description file')
714 filesystem.add_option(
715 '--write-info-json',
716 action='store_true', dest='writeinfojson', default=False,
717 help='Write video metadata to a .info.json file')
718 filesystem.add_option(
719 '--write-annotations',
720 action='store_true', dest='writeannotations', default=False,
721 help='Write video annotations to a .annotations.xml file')
722 filesystem.add_option(
723 '--load-info-json', '--load-info',
724 dest='load_info_filename', metavar='FILE',
725 help='JSON file containing the video information (created with the "--write-info-json" option)')
726 filesystem.add_option(
727 '--cookies',
728 dest='cookiefile', metavar='FILE',
729 help='File to read cookies from and dump cookie jar in')
730 filesystem.add_option(
731 '--cache-dir', dest='cachedir', default=None, metavar='DIR',
732 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.')
733 filesystem.add_option(
734 '--no-cache-dir', action='store_const', const=False, dest='cachedir',
735 help='Disable filesystem caching')
736 filesystem.add_option(
737 '--rm-cache-dir',
738 action='store_true', dest='rm_cachedir',
739 help='Delete all filesystem cache files')
740
741 thumbnail = optparse.OptionGroup(parser, 'Thumbnail images')
742 thumbnail.add_option(
743 '--write-thumbnail',
744 action='store_true', dest='writethumbnail', default=False,
745 help='Write thumbnail image to disk')
746 thumbnail.add_option(
747 '--write-all-thumbnails',
748 action='store_true', dest='write_all_thumbnails', default=False,
749 help='Write all thumbnail image formats to disk')
750 thumbnail.add_option(
751 '--list-thumbnails',
752 action='store_true', dest='list_thumbnails', default=False,
753 help='Simulate and list all available thumbnail formats')
754
755 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
756 postproc.add_option(
757 '-x', '--extract-audio',
758 action='store_true', dest='extractaudio', default=False,
759 help='Convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
760 postproc.add_option(
761 '--audio-format', metavar='FORMAT', dest='audioformat', default='best',
762 help='Specify audio format: "best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; "%default" by default; No effect without -x')
763 postproc.add_option(
764 '--audio-quality', metavar='QUALITY',
765 dest='audioquality', default='5',
766 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)')
767 postproc.add_option(
768 '--recode-video',
769 metavar='FORMAT', dest='recodevideo', default=None,
770 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm|mkv|avi)')
771 postproc.add_option(
772 '--postprocessor-args',
773 dest='postprocessor_args', metavar='ARGS',
774 help='Give these arguments to the postprocessor')
775 postproc.add_option(
776 '-k', '--keep-video',
777 action='store_true', dest='keepvideo', default=False,
778 help='Keep the video file on disk after the post-processing; the video is erased by default')
779 postproc.add_option(
780 '--no-post-overwrites',
781 action='store_true', dest='nopostoverwrites', default=False,
782 help='Do not overwrite post-processed files; the post-processed files are overwritten by default')
783 postproc.add_option(
784 '--embed-subs',
785 action='store_true', dest='embedsubtitles', default=False,
786 help='Embed subtitles in the video (only for mp4, webm and mkv videos)')
787 postproc.add_option(
788 '--embed-thumbnail',
789 action='store_true', dest='embedthumbnail', default=False,
790 help='Embed thumbnail in the audio as cover art')
791 postproc.add_option(
792 '--add-metadata',
793 action='store_true', dest='addmetadata', default=False,
794 help='Write metadata to the video file')
795 postproc.add_option(
796 '--metadata-from-title',
797 metavar='FORMAT', dest='metafromtitle',
798 help='Parse additional metadata like song title / artist from the video title. '
799 'The format syntax is the same as --output, '
800 'the parsed parameters replace existing values. '
801 'Additional templates: %(album)s, %(artist)s. '
802 'Example: --metadata-from-title "%(artist)s - %(title)s" matches a title like '
803 '"Coldplay - Paradise"')
804 postproc.add_option(
805 '--xattrs',
806 action='store_true', dest='xattrs', default=False,
807 help='Write metadata to the video file\'s xattrs (using dublin core and xdg standards)')
808 postproc.add_option(
809 '--fixup',
810 metavar='POLICY', dest='fixup', default='detect_or_warn',
811 help='Automatically correct known faults of the file. '
812 'One of never (do nothing), warn (only emit a warning), '
813 'detect_or_warn (the default; fix file if we can, warn otherwise)')
814 postproc.add_option(
815 '--prefer-avconv',
816 action='store_false', dest='prefer_ffmpeg',
817 help='Prefer avconv over ffmpeg for running the postprocessors (default)')
818 postproc.add_option(
819 '--prefer-ffmpeg',
820 action='store_true', dest='prefer_ffmpeg',
821 help='Prefer ffmpeg over avconv for running the postprocessors')
822 postproc.add_option(
823 '--ffmpeg-location', '--avconv-location', metavar='PATH',
824 dest='ffmpeg_location',
825 help='Location of the ffmpeg/avconv binary; either the path to the binary or its containing directory.')
826 postproc.add_option(
827 '--exec',
828 metavar='CMD', dest='exec_cmd',
829 help='Execute a command on the file after downloading, similar to find\'s -exec syntax. Example: --exec \'adb push {} /sdcard/Music/ && rm {}\'')
830 postproc.add_option(
831 '--convert-subs', '--convert-subtitles',
832 metavar='FORMAT', dest='convertsubtitles', default=None,
833 help='Convert the subtitles to other format (currently supported: srt|ass|vtt)')
834
835 parser.add_option_group(general)
836 parser.add_option_group(network)
837 parser.add_option_group(selection)
838 parser.add_option_group(downloader)
839 parser.add_option_group(filesystem)
840 parser.add_option_group(thumbnail)
841 parser.add_option_group(verbosity)
842 parser.add_option_group(workarounds)
843 parser.add_option_group(video_format)
844 parser.add_option_group(subtitles)
845 parser.add_option_group(authentication)
846 parser.add_option_group(adobe_pass)
847 parser.add_option_group(postproc)
848
849 if overrideArguments is not None:
850 opts, args = parser.parse_args(overrideArguments)
851 if opts.verbose:
852 write_string('[debug] Override config: ' + repr(overrideArguments) + '\n')
853 else:
854 def compat_conf(conf):
855 if sys.version_info < (3,):
856 return [a.decode(preferredencoding(), 'replace') for a in conf]
857 return conf
858
859 command_line_conf = compat_conf(sys.argv[1:])
860 opts, args = parser.parse_args(command_line_conf)
861
862 system_conf = user_conf = custom_conf = []
863
864 if '--config-location' in command_line_conf:
865 location = compat_expanduser(opts.config_location)
866 if os.path.isdir(location):
867 location = os.path.join(location, 'youtube-dl.conf')
868 if not os.path.exists(location):
869 parser.error('config-location %s does not exist.' % location)
870 custom_conf = _readOptions(location)
871 elif '--ignore-config' in command_line_conf:
872 pass
873 else:
874 system_conf = _readOptions('/etc/youtube-dl.conf')
875 if '--ignore-config' not in system_conf:
876 user_conf = _readUserConf()
877
878 argv = system_conf + user_conf + custom_conf + command_line_conf
879 opts, args = parser.parse_args(argv)
880 if opts.verbose:
881 for conf_label, conf in (
882 ('System config', system_conf),
883 ('User config', user_conf),
884 ('Custom config', custom_conf),
885 ('Command-line args', command_line_conf)):
886 write_string('[debug] %s: %s\n' % (conf_label, repr(_hide_login_info(conf))))
887
888 return parser, opts, args