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