You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

801 lines
36 KiB

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