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.

688 lines
30 KiB

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