Add --load-info option (#972)
[youtube-dl] / youtube_dl / __init__.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 __authors__  = (
5     'Ricardo Garcia Gonzalez',
6     'Danny Colligan',
7     'Benjamin Johnson',
8     'Vasyl\' Vavrychuk',
9     'Witold Baryluk',
10     'Paweł Paprota',
11     'Gergely Imreh',
12     'Rogério Brito',
13     'Philipp Hagemeister',
14     'Sören Schulze',
15     'Kevin Ngo',
16     'Ori Avtalion',
17     'shizeeg',
18     'Filippo Valsorda',
19     'Christian Albrecht',
20     'Dave Vasilevsky',
21     'Jaime Marquínez Ferrándiz',
22     'Jeff Crouse',
23     'Osama Khalid',
24     'Michael Walter',
25     'M. Yasoob Ullah Khalid',
26     'Julien Fraichard',
27     'Johny Mo Swag',
28     'Axel Noack',
29     'Albert Kim',
30     'Pierre Rudloff',
31     'Huarong Huo',
32     'Ismael Mejía',
33     'Steffan \'Ruirize\' James',
34     'Andras Elso',
35     'Jelle van der Waa',
36     'Marcin Cieślak',
37     'Anton Larionov',
38     'Takuya Tsuchida',
39     'Sergey M.',
40 )
41
42 __license__ = 'Public Domain'
43
44 import codecs
45 import getpass
46 import optparse
47 import os
48 import random
49 import re
50 import shlex
51 import subprocess
52 import sys
53
54
55 from .utils import (
56     compat_print,
57     DateRange,
58     decodeOption,
59     determine_ext,
60     DownloadError,
61     get_cachedir,
62     MaxDownloadsReached,
63     preferredencoding,
64     SameFileError,
65     std_headers,
66     write_string,
67 )
68 from .update import update_self
69 from .FileDownloader import (
70     FileDownloader,
71 )
72 from .extractor import gen_extractors
73 from .version import __version__
74 from .YoutubeDL import YoutubeDL
75 from .PostProcessor import (
76     FFmpegMetadataPP,
77     FFmpegVideoConvertor,
78     FFmpegExtractAudioPP,
79     FFmpegEmbedSubtitlePP,
80 )
81
82
83 def parseOpts(overrideArguments=None):
84     def _readOptions(filename_bytes, default=[]):
85         try:
86             optionf = open(filename_bytes)
87         except IOError:
88             return default  # silently skip if file is not present
89         try:
90             res = []
91             for l in optionf:
92                 res += shlex.split(l, comments=True)
93         finally:
94             optionf.close()
95         return res
96
97     def _format_option_string(option):
98         ''' ('-o', '--option') -> -o, --format METAVAR'''
99
100         opts = []
101
102         if option._short_opts:
103             opts.append(option._short_opts[0])
104         if option._long_opts:
105             opts.append(option._long_opts[0])
106         if len(opts) > 1:
107             opts.insert(1, ', ')
108
109         if option.takes_value(): opts.append(' %s' % option.metavar)
110
111         return "".join(opts)
112
113     def _comma_separated_values_options_callback(option, opt_str, value, parser):
114         setattr(parser.values, option.dest, value.split(','))
115
116     def _find_term_columns():
117         columns = os.environ.get('COLUMNS', None)
118         if columns:
119             return int(columns)
120
121         try:
122             sp = subprocess.Popen(['stty', 'size'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
123             out,err = sp.communicate()
124             return int(out.split()[1])
125         except:
126             pass
127         return None
128
129     def _hide_login_info(opts):
130         opts = list(opts)
131         for private_opt in ['-p', '--password', '-u', '--username', '--video-password']:
132             try:
133                 i = opts.index(private_opt)
134                 opts[i+1] = '<PRIVATE>'
135             except ValueError:
136                 pass
137         return opts
138
139     max_width = 80
140     max_help_position = 80
141
142     # No need to wrap help messages if we're on a wide console
143     columns = _find_term_columns()
144     if columns: max_width = columns
145
146     fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
147     fmt.format_option_strings = _format_option_string
148
149     kw = {
150         'version'   : __version__,
151         'formatter' : fmt,
152         'usage' : '%prog [options] url [url...]',
153         'conflict_handler' : 'resolve',
154     }
155
156     parser = optparse.OptionParser(**kw)
157
158     # option groups
159     general        = optparse.OptionGroup(parser, 'General Options')
160     selection      = optparse.OptionGroup(parser, 'Video Selection')
161     authentication = optparse.OptionGroup(parser, 'Authentication Options')
162     video_format   = optparse.OptionGroup(parser, 'Video Format Options')
163     subtitles      = optparse.OptionGroup(parser, 'Subtitle Options')
164     downloader     = optparse.OptionGroup(parser, 'Download Options')
165     postproc       = optparse.OptionGroup(parser, 'Post-processing Options')
166     filesystem     = optparse.OptionGroup(parser, 'Filesystem Options')
167     verbosity      = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
168
169     general.add_option('-h', '--help',
170             action='help', help='print this help text and exit')
171     general.add_option('-v', '--version',
172             action='version', help='print program version and exit')
173     general.add_option('-U', '--update',
174             action='store_true', dest='update_self', help='update this program to latest version. Make sure that you have sufficient permissions (run with sudo if needed)')
175     general.add_option('-i', '--ignore-errors',
176             action='store_true', dest='ignoreerrors', help='continue on download errors, for example to to skip unavailable videos in a playlist', default=False)
177     general.add_option('--abort-on-error',
178             action='store_false', dest='ignoreerrors',
179             help='Abort downloading of further videos (in the playlist or the command line) if an error occurs')
180     general.add_option('--dump-user-agent',
181             action='store_true', dest='dump_user_agent',
182             help='display the current browser identification', default=False)
183     general.add_option('--user-agent',
184             dest='user_agent', help='specify a custom user agent', metavar='UA')
185     general.add_option('--referer',
186             dest='referer', help='specify a custom referer, use if the video access is restricted to one domain',
187             metavar='REF', default=None)
188     general.add_option('--list-extractors',
189             action='store_true', dest='list_extractors',
190             help='List all supported extractors and the URLs they would handle', default=False)
191     general.add_option('--extractor-descriptions',
192             action='store_true', dest='list_extractor_descriptions',
193             help='Output descriptions of all supported extractors', default=False)
194     general.add_option(
195         '--proxy', dest='proxy', default=None, metavar='URL',
196         help='Use the specified HTTP/HTTPS proxy. Pass in an empty string (--proxy "") for direct connection')
197     general.add_option('--no-check-certificate', action='store_true', dest='no_check_certificate', default=False, help='Suppress HTTPS certificate validation.')
198     general.add_option(
199         '--cache-dir', dest='cachedir', default=get_cachedir(), metavar='DIR',
200         help='Location in the filesystem where youtube-dl can store downloaded information permanently. By default $XDG_CACHE_HOME/youtube-dl or ~/.cache/youtube-dl .')
201     general.add_option(
202         '--no-cache-dir', action='store_const', const=None, dest='cachedir',
203         help='Disable filesystem caching')
204     general.add_option(
205         '--socket-timeout', dest='socket_timeout',
206         type=float, default=None, help=optparse.SUPPRESS_HELP)
207
208
209     selection.add_option('--playlist-start',
210             dest='playliststart', metavar='NUMBER', help='playlist video to start at (default is %default)', default=1)
211     selection.add_option('--playlist-end',
212             dest='playlistend', metavar='NUMBER', help='playlist video to end at (default is last)', default=-1)
213     selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
214     selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
215     selection.add_option('--max-downloads', metavar='NUMBER',
216                          dest='max_downloads', type=int, default=None,
217                          help='Abort after downloading NUMBER files')
218     selection.add_option('--min-filesize', metavar='SIZE', dest='min_filesize', help="Do not download any videos smaller than SIZE (e.g. 50k or 44.6m)", default=None)
219     selection.add_option('--max-filesize', metavar='SIZE', dest='max_filesize', help="Do not download any videos larger than SIZE (e.g. 50k or 44.6m)", default=None)
220     selection.add_option('--date', metavar='DATE', dest='date', help='download only videos uploaded in this date', default=None)
221     selection.add_option('--datebefore', metavar='DATE', dest='datebefore', help='download only videos uploaded before this date', default=None)
222     selection.add_option('--dateafter', metavar='DATE', dest='dateafter', help='download only videos uploaded after this date', default=None)
223     selection.add_option('--no-playlist', action='store_true', dest='noplaylist', help='download only the currently playing video', default=False)
224     selection.add_option('--age-limit', metavar='YEARS', dest='age_limit',
225                          help='download only videos suitable for the given age',
226                          default=None, type=int)
227     selection.add_option('--download-archive', metavar='FILE',
228                          dest='download_archive',
229                          help='Download only videos not listed in the archive file. Record the IDs of all downloaded videos in it.')
230
231
232     authentication.add_option('-u', '--username',
233             dest='username', metavar='USERNAME', help='account username')
234     authentication.add_option('-p', '--password',
235             dest='password', metavar='PASSWORD', help='account password')
236     authentication.add_option('-n', '--netrc',
237             action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False)
238     authentication.add_option('--video-password',
239             dest='videopassword', metavar='PASSWORD', help='video password (vimeo only)')
240
241
242     video_format.add_option('-f', '--format',
243             action='store', dest='format', metavar='FORMAT', default='best',
244             help='video format code, specify the order of preference using slashes: "-f 22/17/18". "-f mp4" and "-f flv" are also supported')
245     video_format.add_option('--all-formats',
246             action='store_const', dest='format', help='download all available video formats', const='all')
247     video_format.add_option('--prefer-free-formats',
248             action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested')
249     video_format.add_option('--max-quality',
250             action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
251     video_format.add_option('-F', '--list-formats',
252             action='store_true', dest='listformats', help='list all available formats (currently youtube only)')
253
254     subtitles.add_option('--write-sub', '--write-srt',
255             action='store_true', dest='writesubtitles',
256             help='write subtitle file', default=False)
257     subtitles.add_option('--write-auto-sub', '--write-automatic-sub',
258             action='store_true', dest='writeautomaticsub',
259             help='write automatic subtitle file (youtube only)', default=False)
260     subtitles.add_option('--all-subs',
261             action='store_true', dest='allsubtitles',
262             help='downloads all the available subtitles of the video', default=False)
263     subtitles.add_option('--list-subs',
264             action='store_true', dest='listsubtitles',
265             help='lists all available subtitles for the video', default=False)
266     subtitles.add_option('--sub-format',
267             action='store', dest='subtitlesformat', metavar='FORMAT',
268             help='subtitle format (default=srt) ([sbv/vtt] youtube only)', default='srt')
269     subtitles.add_option('--sub-lang', '--sub-langs', '--srt-lang',
270             action='callback', dest='subtitleslangs', metavar='LANGS', type='str',
271             default=[], callback=_comma_separated_values_options_callback,
272             help='languages of the subtitles to download (optional) separated by commas, use IETF language tags like \'en,pt\'')
273
274     downloader.add_option('-r', '--rate-limit',
275             dest='ratelimit', metavar='LIMIT', help='maximum download rate in bytes per second (e.g. 50K or 4.2M)')
276     downloader.add_option('-R', '--retries',
277             dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
278     downloader.add_option('--buffer-size',
279             dest='buffersize', metavar='SIZE', help='size of download buffer (e.g. 1024 or 16K) (default is %default)', default="1024")
280     downloader.add_option('--no-resize-buffer',
281             action='store_true', dest='noresizebuffer',
282             help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.', default=False)
283     downloader.add_option('--test', action='store_true', dest='test', default=False, help=optparse.SUPPRESS_HELP)
284
285     verbosity.add_option('-q', '--quiet',
286             action='store_true', dest='quiet', help='activates quiet mode', default=False)
287     verbosity.add_option('-s', '--simulate',
288             action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False)
289     verbosity.add_option('--skip-download',
290             action='store_true', dest='skip_download', help='do not download the video', default=False)
291     verbosity.add_option('-g', '--get-url',
292             action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False)
293     verbosity.add_option('-e', '--get-title',
294             action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False)
295     verbosity.add_option('--get-id',
296             action='store_true', dest='getid', help='simulate, quiet but print id', default=False)
297     verbosity.add_option('--get-thumbnail',
298             action='store_true', dest='getthumbnail',
299             help='simulate, quiet but print thumbnail URL', default=False)
300     verbosity.add_option('--get-description',
301             action='store_true', dest='getdescription',
302             help='simulate, quiet but print video description', default=False)
303     verbosity.add_option('--get-filename',
304             action='store_true', dest='getfilename',
305             help='simulate, quiet but print output filename', default=False)
306     verbosity.add_option('--get-format',
307             action='store_true', dest='getformat',
308             help='simulate, quiet but print output format', default=False)
309     verbosity.add_option('-j', '--dump-json',
310             action='store_true', dest='dumpjson',
311             help='simulate, quiet but print JSON information', default=False)
312     verbosity.add_option('--newline',
313             action='store_true', dest='progress_with_newline', help='output progress bar as new lines', default=False)
314     verbosity.add_option('--no-progress',
315             action='store_true', dest='noprogress', help='do not print progress bar', default=False)
316     verbosity.add_option('--console-title',
317             action='store_true', dest='consoletitle',
318             help='display progress in console titlebar', default=False)
319     verbosity.add_option('-v', '--verbose',
320             action='store_true', dest='verbose', help='print various debugging information', default=False)
321     verbosity.add_option('--dump-intermediate-pages',
322             action='store_true', dest='dump_intermediate_pages', default=False,
323             help='print downloaded pages to debug problems(very verbose)')
324     verbosity.add_option('--write-pages',
325             action='store_true', dest='write_pages', default=False,
326             help='Write downloaded intermediary pages to files in the current directory to debug problems')
327     verbosity.add_option('--youtube-print-sig-code',
328             action='store_true', dest='youtube_print_sig_code', default=False,
329             help=optparse.SUPPRESS_HELP)
330
331
332     filesystem.add_option('-t', '--title',
333             action='store_true', dest='usetitle', help='use title in file name (default)', default=False)
334     filesystem.add_option('--id',
335             action='store_true', dest='useid', help='use only video ID in file name', default=False)
336     filesystem.add_option('-l', '--literal',
337             action='store_true', dest='usetitle', help='[deprecated] alias of --title', default=False)
338     filesystem.add_option('-A', '--auto-number',
339             action='store_true', dest='autonumber',
340             help='number downloaded files starting from 00000', default=False)
341     filesystem.add_option('-o', '--output',
342             dest='outtmpl', metavar='TEMPLATE',
343             help=('output filename template. Use %(title)s to get the title, '
344                   '%(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, '
345                   '%(autonumber)s to get an automatically incremented number, '
346                   '%(ext)s for the filename extension, '
347                   '%(format)s for the format description (like "22 - 1280x720" or "HD"),'
348                   '%(format_id)s for the unique id of the format (like Youtube\'s itags: "137"),'
349                   '%(upload_date)s for the upload date (YYYYMMDD), '
350                   '%(extractor)s for the provider (youtube, metacafe, etc), '
351                   '%(id)s for the video id , %(playlist)s for the playlist the video is in, '
352                   '%(playlist_index)s for the position in the playlist and %% for a literal percent. '
353                   'Use - to output to stdout. Can also be used to download to a different directory, '
354                   'for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .'))
355     filesystem.add_option('--autonumber-size',
356             dest='autonumber_size', metavar='NUMBER',
357             help='Specifies the number of digits in %(autonumber)s when it is present in output filename template or --auto-number option is given')
358     filesystem.add_option('--restrict-filenames',
359             action='store_true', dest='restrictfilenames',
360             help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames', default=False)
361     filesystem.add_option('-a', '--batch-file',
362             dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)')
363     filesystem.add_option('--load-info',
364             dest='load_info_filename', metavar='FILE',
365             help='json file containing the video information (created with the "--write-json" option')
366     filesystem.add_option('-w', '--no-overwrites',
367             action='store_true', dest='nooverwrites', help='do not overwrite files', default=False)
368     filesystem.add_option('-c', '--continue',
369             action='store_true', dest='continue_dl', help='force resume of partially downloaded files. By default, youtube-dl will resume downloads if possible.', default=True)
370     filesystem.add_option('--no-continue',
371             action='store_false', dest='continue_dl',
372             help='do not resume partially downloaded files (restart from beginning)')
373     filesystem.add_option('--cookies',
374             dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in')
375     filesystem.add_option('--no-part',
376             action='store_true', dest='nopart', help='do not use .part files', default=False)
377     filesystem.add_option('--no-mtime',
378             action='store_false', dest='updatetime',
379             help='do not use the Last-modified header to set the file modification time', default=True)
380     filesystem.add_option('--write-description',
381             action='store_true', dest='writedescription',
382             help='write video description to a .description file', default=False)
383     filesystem.add_option('--write-info-json',
384             action='store_true', dest='writeinfojson',
385             help='write video metadata to a .info.json file', default=False)
386     filesystem.add_option('--write-annotations',
387             action='store_true', dest='writeannotations',
388             help='write video annotations to a .annotation file', default=False)
389     filesystem.add_option('--write-thumbnail',
390             action='store_true', dest='writethumbnail',
391             help='write thumbnail image to disk', default=False)
392
393
394     postproc.add_option('-x', '--extract-audio', action='store_true', dest='extractaudio', default=False,
395             help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
396     postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best',
397             help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; best by default')
398     postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5',
399             help='ffmpeg/avconv audio quality specification, insert a value between 0 (better) and 9 (worse) for VBR or a specific bitrate like 128K (default 5)')
400     postproc.add_option('--recode-video', metavar='FORMAT', dest='recodevideo', default=None,
401             help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm)')
402     postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False,
403             help='keeps the video file on disk after the post-processing; the video is erased by default')
404     postproc.add_option('--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False,
405             help='do not overwrite post-processed files; the post-processed files are overwritten by default')
406     postproc.add_option('--embed-subs', action='store_true', dest='embedsubtitles', default=False,
407             help='embed subtitles in the video (only for mp4 videos)')
408     postproc.add_option('--add-metadata', action='store_true', dest='addmetadata', default=False,
409             help='add metadata to the files')
410
411
412     parser.add_option_group(general)
413     parser.add_option_group(selection)
414     parser.add_option_group(downloader)
415     parser.add_option_group(filesystem)
416     parser.add_option_group(verbosity)
417     parser.add_option_group(video_format)
418     parser.add_option_group(subtitles)
419     parser.add_option_group(authentication)
420     parser.add_option_group(postproc)
421
422     if overrideArguments is not None:
423         opts, args = parser.parse_args(overrideArguments)
424         if opts.verbose:
425             write_string(u'[debug] Override config: ' + repr(overrideArguments) + '\n')
426     else:
427         systemConf = _readOptions('/etc/youtube-dl.conf')
428
429         xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
430         if xdg_config_home:
431             userConfFile = os.path.join(xdg_config_home, 'youtube-dl', 'config')
432             if not os.path.isfile(userConfFile):
433                 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
434         else:
435             userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl', 'config')
436             if not os.path.isfile(userConfFile):
437                 userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
438         userConf = _readOptions(userConfFile, None)
439
440         if userConf is None:
441             appdata_dir = os.environ.get('appdata')
442             if appdata_dir:
443                 userConf = _readOptions(
444                     os.path.join(appdata_dir, 'youtube-dl', 'config'),
445                     default=None)
446                 if userConf is None:
447                     userConf = _readOptions(
448                         os.path.join(appdata_dir, 'youtube-dl', 'config.txt'),
449                         default=None)
450
451         if userConf is None:
452             userConf = _readOptions(
453                 os.path.join(os.path.expanduser('~'), 'youtube-dl.conf'),
454                 default=None)
455         if userConf is None:
456             userConf = _readOptions(
457                 os.path.join(os.path.expanduser('~'), 'youtube-dl.conf.txt'),
458                 default=None)
459
460         if userConf is None:
461             userConf = []
462
463         commandLineConf = sys.argv[1:]
464         argv = systemConf + userConf + commandLineConf
465         opts, args = parser.parse_args(argv)
466         if opts.verbose:
467             write_string(u'[debug] System config: ' + repr(_hide_login_info(systemConf)) + '\n')
468             write_string(u'[debug] User config: ' + repr(_hide_login_info(userConf)) + '\n')
469             write_string(u'[debug] Command-line args: ' + repr(_hide_login_info(commandLineConf)) + '\n')
470
471     return parser, opts, args
472
473 def _real_main(argv=None):
474     # Compatibility fixes for Windows
475     if sys.platform == 'win32':
476         # https://github.com/rg3/youtube-dl/issues/820
477         codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
478
479     parser, opts, args = parseOpts(argv)
480
481     # Set user agent
482     if opts.user_agent is not None:
483         std_headers['User-Agent'] = opts.user_agent
484
485     # Set referer
486     if opts.referer is not None:
487         std_headers['Referer'] = opts.referer
488
489     # Dump user agent
490     if opts.dump_user_agent:
491         compat_print(std_headers['User-Agent'])
492         sys.exit(0)
493
494     # Batch file verification
495     batchurls = []
496     if opts.batchfile is not None:
497         try:
498             if opts.batchfile == '-':
499                 batchfd = sys.stdin
500             else:
501                 batchfd = open(opts.batchfile, 'r')
502             batchurls = batchfd.readlines()
503             batchurls = [x.strip() for x in batchurls]
504             batchurls = [x for x in batchurls if len(x) > 0 and not re.search(r'^[#/;]', x)]
505             if opts.verbose:
506                 write_string(u'[debug] Batch file urls: ' + repr(batchurls) + u'\n')
507         except IOError:
508             sys.exit(u'ERROR: batch file could not be read')
509     all_urls = batchurls + args
510     all_urls = [url.strip() for url in all_urls]
511
512     extractors = gen_extractors()
513
514     if opts.list_extractors:
515         for ie in sorted(extractors, key=lambda ie: ie.IE_NAME.lower()):
516             compat_print(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else ''))
517             matchedUrls = [url for url in all_urls if ie.suitable(url)]
518             all_urls = [url for url in all_urls if url not in matchedUrls]
519             for mu in matchedUrls:
520                 compat_print(u'  ' + mu)
521         sys.exit(0)
522     if opts.list_extractor_descriptions:
523         for ie in sorted(extractors, key=lambda ie: ie.IE_NAME.lower()):
524             if not ie._WORKING:
525                 continue
526             desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
527             if desc is False:
528                 continue
529             if hasattr(ie, 'SEARCH_KEY'):
530                 _SEARCHES = (u'cute kittens', u'slithering pythons', u'falling cat', u'angry poodle', u'purple fish', u'running tortoise')
531                 _COUNTS = (u'', u'5', u'10', u'all')
532                 desc += u' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES))
533             compat_print(desc)
534         sys.exit(0)
535
536
537     # Conflicting, missing and erroneous options
538     if opts.usenetrc and (opts.username is not None or opts.password is not None):
539         parser.error(u'using .netrc conflicts with giving username/password')
540     if opts.password is not None and opts.username is None:
541         parser.error(u' account username missing\n')
542     if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
543         parser.error(u'using output template conflicts with using title, video ID or auto number')
544     if opts.usetitle and opts.useid:
545         parser.error(u'using title conflicts with using video ID')
546     if opts.username is not None and opts.password is None:
547         opts.password = getpass.getpass(u'Type account password and press return:')
548     if opts.ratelimit is not None:
549         numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
550         if numeric_limit is None:
551             parser.error(u'invalid rate limit specified')
552         opts.ratelimit = numeric_limit
553     if opts.min_filesize is not None:
554         numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
555         if numeric_limit is None:
556             parser.error(u'invalid min_filesize specified')
557         opts.min_filesize = numeric_limit
558     if opts.max_filesize is not None:
559         numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
560         if numeric_limit is None:
561             parser.error(u'invalid max_filesize specified')
562         opts.max_filesize = numeric_limit
563     if opts.retries is not None:
564         try:
565             opts.retries = int(opts.retries)
566         except (TypeError, ValueError):
567             parser.error(u'invalid retry count specified')
568     if opts.buffersize is not None:
569         numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
570         if numeric_buffersize is None:
571             parser.error(u'invalid buffer size specified')
572         opts.buffersize = numeric_buffersize
573     try:
574         opts.playliststart = int(opts.playliststart)
575         if opts.playliststart <= 0:
576             raise ValueError(u'Playlist start must be positive')
577     except (TypeError, ValueError):
578         parser.error(u'invalid playlist start number specified')
579     try:
580         opts.playlistend = int(opts.playlistend)
581         if opts.playlistend != -1 and (opts.playlistend <= 0 or opts.playlistend < opts.playliststart):
582             raise ValueError(u'Playlist end must be greater than playlist start')
583     except (TypeError, ValueError):
584         parser.error(u'invalid playlist end number specified')
585     if opts.extractaudio:
586         if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']:
587             parser.error(u'invalid audio format specified')
588     if opts.audioquality:
589         opts.audioquality = opts.audioquality.strip('k').strip('K')
590         if not opts.audioquality.isdigit():
591             parser.error(u'invalid audio quality specified')
592     if opts.recodevideo is not None:
593         if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg']:
594             parser.error(u'invalid video recode format specified')
595     if opts.date is not None:
596         date = DateRange.day(opts.date)
597     else:
598         date = DateRange(opts.dateafter, opts.datebefore)
599
600     # --all-sub automatically sets --write-sub if --write-auto-sub is not given
601     # this was the old behaviour if only --all-sub was given.
602     if opts.allsubtitles and (opts.writeautomaticsub == False):
603         opts.writesubtitles = True
604
605     if sys.version_info < (3,):
606         # In Python 2, sys.argv is a bytestring (also note http://bugs.python.org/issue2128 for Windows systems)
607         if opts.outtmpl is not None:
608             opts.outtmpl = opts.outtmpl.decode(preferredencoding())
609     outtmpl =((opts.outtmpl is not None and opts.outtmpl)
610             or (opts.format == '-1' and opts.usetitle and u'%(title)s-%(id)s-%(format)s.%(ext)s')
611             or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s')
612             or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(title)s-%(id)s.%(ext)s')
613             or (opts.usetitle and u'%(title)s-%(id)s.%(ext)s')
614             or (opts.useid and u'%(id)s.%(ext)s')
615             or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
616             or u'%(title)s-%(id)s.%(ext)s')
617     if '%(ext)s' not in outtmpl and opts.extractaudio:
618         parser.error(u'Cannot download a video and extract audio into the same'
619                      u' file! Use "%%(ext)s" instead of %r' %
620                      determine_ext(outtmpl, u''))
621
622     ydl_opts = {
623         'usenetrc': opts.usenetrc,
624         'username': opts.username,
625         'password': opts.password,
626         'videopassword': opts.videopassword,
627         'quiet': (opts.quiet or opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.dumpjson),
628         'forceurl': opts.geturl,
629         'forcetitle': opts.gettitle,
630         'forceid': opts.getid,
631         'forcethumbnail': opts.getthumbnail,
632         'forcedescription': opts.getdescription,
633         'forcefilename': opts.getfilename,
634         'forceformat': opts.getformat,
635         'forcejson': opts.dumpjson,
636         'simulate': opts.simulate,
637         'skip_download': (opts.skip_download or opts.simulate or opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.dumpjson),
638         'format': opts.format,
639         'format_limit': opts.format_limit,
640         'listformats': opts.listformats,
641         'outtmpl': outtmpl,
642         'autonumber_size': opts.autonumber_size,
643         'restrictfilenames': opts.restrictfilenames,
644         'ignoreerrors': opts.ignoreerrors,
645         'ratelimit': opts.ratelimit,
646         'nooverwrites': opts.nooverwrites,
647         'retries': opts.retries,
648         'buffersize': opts.buffersize,
649         'noresizebuffer': opts.noresizebuffer,
650         'continuedl': opts.continue_dl,
651         'noprogress': opts.noprogress,
652         'progress_with_newline': opts.progress_with_newline,
653         'playliststart': opts.playliststart,
654         'playlistend': opts.playlistend,
655         'noplaylist': opts.noplaylist,
656         'logtostderr': opts.outtmpl == '-',
657         'consoletitle': opts.consoletitle,
658         'nopart': opts.nopart,
659         'updatetime': opts.updatetime,
660         'writedescription': opts.writedescription,
661         'writeannotations': opts.writeannotations,
662         'writeinfojson': opts.writeinfojson,
663         'writethumbnail': opts.writethumbnail,
664         'writesubtitles': opts.writesubtitles,
665         'writeautomaticsub': opts.writeautomaticsub,
666         'allsubtitles': opts.allsubtitles,
667         'listsubtitles': opts.listsubtitles,
668         'subtitlesformat': opts.subtitlesformat,
669         'subtitleslangs': opts.subtitleslangs,
670         'matchtitle': decodeOption(opts.matchtitle),
671         'rejecttitle': decodeOption(opts.rejecttitle),
672         'max_downloads': opts.max_downloads,
673         'prefer_free_formats': opts.prefer_free_formats,
674         'verbose': opts.verbose,
675         'dump_intermediate_pages': opts.dump_intermediate_pages,
676         'write_pages': opts.write_pages,
677         'test': opts.test,
678         'keepvideo': opts.keepvideo,
679         'min_filesize': opts.min_filesize,
680         'max_filesize': opts.max_filesize,
681         'daterange': date,
682         'cachedir': opts.cachedir,
683         'youtube_print_sig_code': opts.youtube_print_sig_code,
684         'age_limit': opts.age_limit,
685         'download_archive': opts.download_archive,
686         'cookiefile': opts.cookiefile,
687         'nocheckcertificate': opts.no_check_certificate,
688         'proxy': opts.proxy,
689         'socket_timeout': opts.socket_timeout,
690     }
691
692     with YoutubeDL(ydl_opts) as ydl:
693         ydl.print_debug_header()
694         ydl.add_default_info_extractors()
695
696         # PostProcessors
697         # Add the metadata pp first, the other pps will copy it
698         if opts.addmetadata:
699             ydl.add_post_processor(FFmpegMetadataPP())
700         if opts.extractaudio:
701             ydl.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, nopostoverwrites=opts.nopostoverwrites))
702         if opts.recodevideo:
703             ydl.add_post_processor(FFmpegVideoConvertor(preferedformat=opts.recodevideo))
704         if opts.embedsubtitles:
705             ydl.add_post_processor(FFmpegEmbedSubtitlePP(subtitlesformat=opts.subtitlesformat))
706
707         # Update version
708         if opts.update_self:
709             update_self(ydl.to_screen, opts.verbose)
710
711         # Maybe do nothing
712         if (len(all_urls) < 1) and (opts.load_info_filename is None):
713             if not opts.update_self:
714                 parser.error(u'you must provide at least one URL')
715             else:
716                 sys.exit()
717
718         try:
719             if opts.load_info_filename is not None:
720                 retcode = ydl.download_with_info_file(opts.load_info_filename)
721             else:
722                 retcode = ydl.download(all_urls)
723         except MaxDownloadsReached:
724             ydl.to_screen(u'--max-download limit reached, aborting.')
725             retcode = 101
726
727     sys.exit(retcode)
728
729
730 def main(argv=None):
731     try:
732         _real_main(argv)
733     except DownloadError:
734         sys.exit(1)
735     except SameFileError:
736         sys.exit(u'ERROR: fixed output name but more than one file to download')
737     except KeyboardInterrupt:
738         sys.exit(u'\nERROR: Interrupted by user')