2 # -*- coding: utf-8 -*-
4 from __future__ import with_statement
5 from __future__ import absolute_import
8 'Ricardo Garcia Gonzalez',
16 'Philipp Hagemeister',
24 'Jaime Marquínez Ferrándiz',
30 __license__ = 'Public Domain'
44 from .update import update_self
45 from .version import __version__
46 from .FileDownloader import *
47 from .InfoExtractors import gen_extractors
48 from .PostProcessor import *
51 def _readOptions(filename_bytes):
53 optionf = open(filename_bytes)
55 return [] # silently skip if file is not present
59 res += shlex.split(l, comments=True)
64 def _format_option_string(option):
65 ''' ('-o', '--option') -> -o, --format METAVAR'''
69 if option._short_opts:
70 opts.append(option._short_opts[0])
72 opts.append(option._long_opts[0])
76 if option.takes_value(): opts.append(' %s' % option.metavar)
80 def _find_term_columns():
81 columns = os.environ.get('COLUMNS', None)
86 sp = subprocess.Popen(['stty', 'size'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
87 out,err = sp.communicate()
88 return int(out.split()[1])
94 max_help_position = 80
96 # No need to wrap help messages if we're on a wide console
97 columns = _find_term_columns()
98 if columns: max_width = columns
100 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
101 fmt.format_option_strings = _format_option_string
104 'version' : __version__,
106 'usage' : '%prog [options] url [url...]',
107 'conflict_handler' : 'resolve',
110 parser = optparse.OptionParser(**kw)
113 general = optparse.OptionGroup(parser, 'General Options')
114 selection = optparse.OptionGroup(parser, 'Video Selection')
115 authentication = optparse.OptionGroup(parser, 'Authentication Options')
116 video_format = optparse.OptionGroup(parser, 'Video Format Options')
117 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
118 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
119 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
121 general.add_option('-h', '--help',
122 action='help', help='print this help text and exit')
123 general.add_option('-v', '--version',
124 action='version', help='print program version and exit')
125 general.add_option('-U', '--update',
126 action='store_true', dest='update_self', help='update this program to latest version')
127 general.add_option('-i', '--ignore-errors',
128 action='store_true', dest='ignoreerrors', help='continue on download errors', default=False)
129 general.add_option('-r', '--rate-limit',
130 dest='ratelimit', metavar='LIMIT', help='maximum download rate (e.g. 50k or 44.6m)')
131 general.add_option('-R', '--retries',
132 dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
133 general.add_option('--buffer-size',
134 dest='buffersize', metavar='SIZE', help='size of download buffer (e.g. 1024 or 16k) (default is %default)', default="1024")
135 general.add_option('--no-resize-buffer',
136 action='store_true', dest='noresizebuffer',
137 help='do not automatically adjust the buffer size. By default, the buffer size is automatically resized from an initial value of SIZE.', default=False)
138 general.add_option('--dump-user-agent',
139 action='store_true', dest='dump_user_agent',
140 help='display the current browser identification', default=False)
141 general.add_option('--user-agent',
142 dest='user_agent', help='specify a custom user agent', metavar='UA')
143 general.add_option('--list-extractors',
144 action='store_true', dest='list_extractors',
145 help='List all supported extractors and the URLs they would handle', default=False)
146 general.add_option('--test', action='store_true', dest='test', default=False, help=optparse.SUPPRESS_HELP)
148 selection.add_option('--playlist-start',
149 dest='playliststart', metavar='NUMBER', help='playlist video to start at (default is %default)', default=1)
150 selection.add_option('--playlist-end',
151 dest='playlistend', metavar='NUMBER', help='playlist video to end at (default is last)', default=-1)
152 selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
153 selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
154 selection.add_option('--max-downloads', metavar='NUMBER', dest='max_downloads', help='Abort after downloading NUMBER files', default=None)
155 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)
156 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)
159 authentication.add_option('-u', '--username',
160 dest='username', metavar='USERNAME', help='account username')
161 authentication.add_option('-p', '--password',
162 dest='password', metavar='PASSWORD', help='account password')
163 authentication.add_option('-n', '--netrc',
164 action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False)
167 video_format.add_option('-f', '--format',
168 action='store', dest='format', metavar='FORMAT', help='video format code')
169 video_format.add_option('--all-formats',
170 action='store_const', dest='format', help='download all available video formats', const='all')
171 video_format.add_option('--prefer-free-formats',
172 action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested')
173 video_format.add_option('--max-quality',
174 action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
175 video_format.add_option('-F', '--list-formats',
176 action='store_true', dest='listformats', help='list all available formats (currently youtube only)')
177 video_format.add_option('--write-sub', '--write-srt',
178 action='store_true', dest='writesubtitles',
179 help='write subtitle file (currently youtube only)', default=False)
180 video_format.add_option('--only-sub',
181 action='store_true', dest='onlysubtitles',
182 help='downloads only the subtitles (no video)', default=False)
183 video_format.add_option('--all-subs',
184 action='store_true', dest='allsubtitles',
185 help='downloads all the available subtitles of the video (currently youtube only)', default=False)
186 video_format.add_option('--list-subs',
187 action='store_true', dest='listsubtitles',
188 help='lists all available subtitles for the video (currently youtube only)', default=False)
189 video_format.add_option('--sub-format',
190 action='store', dest='subtitlesformat', metavar='LANG',
191 help='subtitle format [srt/sbv] (default=srt) (currently youtube only)', default='srt')
192 video_format.add_option('--sub-lang', '--srt-lang',
193 action='store', dest='subtitleslang', metavar='LANG',
194 help='language of the subtitles to download (optional) use IETF language tags like \'en\'')
196 verbosity.add_option('-q', '--quiet',
197 action='store_true', dest='quiet', help='activates quiet mode', default=False)
198 verbosity.add_option('-s', '--simulate',
199 action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False)
200 verbosity.add_option('--skip-download',
201 action='store_true', dest='skip_download', help='do not download the video', default=False)
202 verbosity.add_option('-g', '--get-url',
203 action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False)
204 verbosity.add_option('-e', '--get-title',
205 action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False)
206 verbosity.add_option('--get-thumbnail',
207 action='store_true', dest='getthumbnail',
208 help='simulate, quiet but print thumbnail URL', default=False)
209 verbosity.add_option('--get-description',
210 action='store_true', dest='getdescription',
211 help='simulate, quiet but print video description', default=False)
212 verbosity.add_option('--get-filename',
213 action='store_true', dest='getfilename',
214 help='simulate, quiet but print output filename', default=False)
215 verbosity.add_option('--get-format',
216 action='store_true', dest='getformat',
217 help='simulate, quiet but print output format', default=False)
218 verbosity.add_option('--newline',
219 action='store_true', dest='progress_with_newline', help='output progress bar as new lines', default=False)
220 verbosity.add_option('--no-progress',
221 action='store_true', dest='noprogress', help='do not print progress bar', default=False)
222 verbosity.add_option('--console-title',
223 action='store_true', dest='consoletitle',
224 help='display progress in console titlebar', default=False)
225 verbosity.add_option('-v', '--verbose',
226 action='store_true', dest='verbose', help='print various debugging information', default=False)
228 filesystem.add_option('-t', '--title',
229 action='store_true', dest='usetitle', help='use title in file name', default=False)
230 filesystem.add_option('--id',
231 action='store_true', dest='useid', help='use video ID in file name', default=False)
232 filesystem.add_option('-l', '--literal',
233 action='store_true', dest='usetitle', help='[deprecated] alias of --title', default=False)
234 filesystem.add_option('-A', '--auto-number',
235 action='store_true', dest='autonumber',
236 help='number downloaded files starting from 00000', default=False)
237 filesystem.add_option('-o', '--output',
238 dest='outtmpl', metavar='TEMPLATE', help='output filename template. Use %(title)s to get the title, %(uploader)s for the uploader name, %(uploader_id)s for the uploader nickname if different, %(autonumber)s to get an automatically incremented number, %(ext)s for the filename extension, %(upload_date)s for the upload date (YYYYMMDD), %(extractor)s for the provider (youtube, metacafe, etc), %(id)s for the video id and %% for a literal percent. Use - to output to stdout. Can also be used to download to a different directory, for example with -o \'/my/downloads/%(uploader)s/%(title)s-%(id)s.%(ext)s\' .')
239 filesystem.add_option('--restrict-filenames',
240 action='store_true', dest='restrictfilenames',
241 help='Restrict filenames to only ASCII characters, and avoid "&" and spaces in filenames', default=False)
242 filesystem.add_option('-a', '--batch-file',
243 dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)')
244 filesystem.add_option('-w', '--no-overwrites',
245 action='store_true', dest='nooverwrites', help='do not overwrite files', default=False)
246 filesystem.add_option('-c', '--continue',
247 action='store_true', dest='continue_dl', help='resume partially downloaded files', default=True)
248 filesystem.add_option('--no-continue',
249 action='store_false', dest='continue_dl',
250 help='do not resume partially downloaded files (restart from beginning)')
251 filesystem.add_option('--cookies',
252 dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in')
253 filesystem.add_option('--no-part',
254 action='store_true', dest='nopart', help='do not use .part files', default=False)
255 filesystem.add_option('--no-mtime',
256 action='store_false', dest='updatetime',
257 help='do not use the Last-modified header to set the file modification time', default=True)
258 filesystem.add_option('--write-description',
259 action='store_true', dest='writedescription',
260 help='write video description to a .description file', default=False)
261 filesystem.add_option('--write-info-json',
262 action='store_true', dest='writeinfojson',
263 help='write video metadata to a .info.json file', default=False)
266 postproc.add_option('-x', '--extract-audio', action='store_true', dest='extractaudio', default=False,
267 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
268 postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best',
269 help='"best", "aac", "vorbis", "mp3", "m4a", "opus", or "wav"; best by default')
270 postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5',
271 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)')
272 postproc.add_option('--recode-video', metavar='FORMAT', dest='recodevideo', default=None,
273 help='Encode the video to another format if necessary (currently supported: mp4|flv|ogg|webm)')
274 postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False,
275 help='keeps the video file on disk after the post-processing; the video is erased by default')
276 postproc.add_option('--no-post-overwrites', action='store_true', dest='nopostoverwrites', default=False,
277 help='do not overwrite post-processed files; the post-processed files are overwritten by default')
280 parser.add_option_group(general)
281 parser.add_option_group(selection)
282 parser.add_option_group(filesystem)
283 parser.add_option_group(verbosity)
284 parser.add_option_group(video_format)
285 parser.add_option_group(authentication)
286 parser.add_option_group(postproc)
288 xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
290 userConfFile = os.path.join(xdg_config_home, 'youtube-dl.conf')
292 userConfFile = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
293 systemConf = _readOptions('/etc/youtube-dl.conf')
294 userConf = _readOptions(userConfFile)
295 commandLineConf = sys.argv[1:]
296 argv = systemConf + userConf + commandLineConf
297 opts, args = parser.parse_args(argv)
300 print(u'[debug] System config: ' + repr(systemConf))
301 print(u'[debug] User config: ' + repr(userConf))
302 print(u'[debug] Command-line args: ' + repr(commandLineConf))
304 return parser, opts, args
307 parser, opts, args = parseOpts()
309 # Open appropriate CookieJar
310 if opts.cookiefile is None:
311 jar = compat_cookiejar.CookieJar()
314 jar = compat_cookiejar.MozillaCookieJar(opts.cookiefile)
315 if os.access(opts.cookiefile, os.R_OK):
317 except (IOError, OSError) as err:
319 traceback.print_exc()
320 sys.stderr.write(u'ERROR: unable to open cookie file\n')
323 if opts.user_agent is not None:
324 std_headers['User-Agent'] = opts.user_agent
327 if opts.dump_user_agent:
328 print(std_headers['User-Agent'])
331 # Batch file verification
333 if opts.batchfile is not None:
335 if opts.batchfile == '-':
338 batchfd = open(opts.batchfile, 'r')
339 batchurls = batchfd.readlines()
340 batchurls = [x.strip() for x in batchurls]
341 batchurls = [x for x in batchurls if len(x) > 0 and not re.search(r'^[#/;]', x)]
343 sys.exit(u'ERROR: batch file could not be read')
344 all_urls = batchurls + args
345 all_urls = [url.strip() for url in all_urls]
347 # General configuration
348 cookie_processor = compat_urllib_request.HTTPCookieProcessor(jar)
349 proxy_handler = compat_urllib_request.ProxyHandler()
350 opener = compat_urllib_request.build_opener(proxy_handler, cookie_processor, YoutubeDLHandler())
351 compat_urllib_request.install_opener(opener)
352 socket.setdefaulttimeout(300) # 5 minutes should be enough (famous last words)
354 extractors = gen_extractors()
356 if opts.list_extractors:
357 for ie in extractors:
358 print(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else ''))
359 matchedUrls = [url for url in all_urls if ie.suitable(url)]
360 all_urls = [url for url in all_urls if url not in matchedUrls]
361 for mu in matchedUrls:
365 # Conflicting, missing and erroneous options
366 if opts.usenetrc and (opts.username is not None or opts.password is not None):
367 parser.error(u'using .netrc conflicts with giving username/password')
368 if opts.password is not None and opts.username is None:
369 parser.error(u'account username missing')
370 if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
371 parser.error(u'using output template conflicts with using title, video ID or auto number')
372 if opts.usetitle and opts.useid:
373 parser.error(u'using title conflicts with using video ID')
374 if opts.username is not None and opts.password is None:
375 opts.password = getpass.getpass(u'Type account password and press return:')
376 if opts.ratelimit is not None:
377 numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
378 if numeric_limit is None:
379 parser.error(u'invalid rate limit specified')
380 opts.ratelimit = numeric_limit
381 if opts.min_filesize is not None:
382 numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
383 if numeric_limit is None:
384 parser.error(u'invalid min_filesize specified')
385 opts.min_filesize = numeric_limit
386 if opts.max_filesize is not None:
387 numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
388 if numeric_limit is None:
389 parser.error(u'invalid max_filesize specified')
390 opts.max_filesize = numeric_limit
391 if opts.retries is not None:
393 opts.retries = int(opts.retries)
394 except (TypeError, ValueError) as err:
395 parser.error(u'invalid retry count specified')
396 if opts.buffersize is not None:
397 numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
398 if numeric_buffersize is None:
399 parser.error(u'invalid buffer size specified')
400 opts.buffersize = numeric_buffersize
402 opts.playliststart = int(opts.playliststart)
403 if opts.playliststart <= 0:
404 raise ValueError(u'Playlist start must be positive')
405 except (TypeError, ValueError) as err:
406 parser.error(u'invalid playlist start number specified')
408 opts.playlistend = int(opts.playlistend)
409 if opts.playlistend != -1 and (opts.playlistend <= 0 or opts.playlistend < opts.playliststart):
410 raise ValueError(u'Playlist end must be greater than playlist start')
411 except (TypeError, ValueError) as err:
412 parser.error(u'invalid playlist end number specified')
413 if opts.extractaudio:
414 if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']:
415 parser.error(u'invalid audio format specified')
416 if opts.audioquality:
417 opts.audioquality = opts.audioquality.strip('k').strip('K')
418 if not opts.audioquality.isdigit():
419 parser.error(u'invalid audio quality specified')
420 if opts.recodevideo is not None:
421 if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg']:
422 parser.error(u'invalid video recode format specified')
424 if sys.version_info < (3,):
425 # In Python 2, sys.argv is a bytestring (also note http://bugs.python.org/issue2128 for Windows systems)
426 if opts.outtmpl is not None:
427 opts.outtmpl = opts.outtmpl.decode(preferredencoding())
428 outtmpl =((opts.outtmpl is not None and opts.outtmpl)
429 or (opts.format == '-1' and opts.usetitle and u'%(title)s-%(id)s-%(format)s.%(ext)s')
430 or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s')
431 or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(title)s-%(id)s.%(ext)s')
432 or (opts.usetitle and u'%(title)s-%(id)s.%(ext)s')
433 or (opts.useid and u'%(id)s.%(ext)s')
434 or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
435 or u'%(id)s.%(ext)s')
438 fd = FileDownloader({
439 'usenetrc': opts.usenetrc,
440 'username': opts.username,
441 'password': opts.password,
442 'quiet': (opts.quiet or opts.geturl or opts.gettitle or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat),
443 'forceurl': opts.geturl,
444 'forcetitle': opts.gettitle,
445 'forcethumbnail': opts.getthumbnail,
446 'forcedescription': opts.getdescription,
447 'forcefilename': opts.getfilename,
448 'forceformat': opts.getformat,
449 'simulate': opts.simulate,
450 'skip_download': (opts.skip_download or opts.simulate or opts.geturl or opts.gettitle or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat),
451 'format': opts.format,
452 'format_limit': opts.format_limit,
453 'listformats': opts.listformats,
455 'restrictfilenames': opts.restrictfilenames,
456 'ignoreerrors': opts.ignoreerrors,
457 'ratelimit': opts.ratelimit,
458 'nooverwrites': opts.nooverwrites,
459 'retries': opts.retries,
460 'buffersize': opts.buffersize,
461 'noresizebuffer': opts.noresizebuffer,
462 'continuedl': opts.continue_dl,
463 'noprogress': opts.noprogress,
464 'progress_with_newline': opts.progress_with_newline,
465 'playliststart': opts.playliststart,
466 'playlistend': opts.playlistend,
467 'logtostderr': opts.outtmpl == '-',
468 'consoletitle': opts.consoletitle,
469 'nopart': opts.nopart,
470 'updatetime': opts.updatetime,
471 'writedescription': opts.writedescription,
472 'writeinfojson': opts.writeinfojson,
473 'writesubtitles': opts.writesubtitles,
474 'onlysubtitles': opts.onlysubtitles,
475 'allsubtitles': opts.allsubtitles,
476 'listsubtitles': opts.listsubtitles,
477 'subtitlesformat': opts.subtitlesformat,
478 'subtitleslang': opts.subtitleslang,
479 'matchtitle': decodeOption(opts.matchtitle),
480 'rejecttitle': decodeOption(opts.rejecttitle),
481 'max_downloads': opts.max_downloads,
482 'prefer_free_formats': opts.prefer_free_formats,
483 'verbose': opts.verbose,
485 'keepvideo': opts.keepvideo,
486 'min_filesize': opts.min_filesize,
487 'max_filesize': opts.max_filesize
491 fd.to_screen(u'[debug] youtube-dl version ' + __version__)
493 sp = subprocess.Popen(['git', 'rev-parse', '--short', 'HEAD'], stdout=subprocess.PIPE, stderr=subprocess.PIPE,
494 cwd=os.path.dirname(os.path.abspath(__file__)))
495 out, err = sp.communicate()
496 out = out.decode().strip()
497 if re.match('[0-9a-f]+', out):
498 fd.to_screen(u'[debug] Git HEAD: ' + out)
501 fd.to_screen(u'[debug] Python version %s - %s' %(platform.python_version(), platform.platform()))
502 fd.to_screen(u'[debug] Proxy map: ' + str(proxy_handler.proxies))
504 for extractor in extractors:
505 fd.add_info_extractor(extractor)
508 if opts.extractaudio:
509 fd.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, nopostoverwrites=opts.nopostoverwrites))
511 fd.add_post_processor(FFmpegVideoConvertor(preferedformat=opts.recodevideo))
515 update_self(fd.to_screen, opts.verbose, sys.argv[0])
518 if len(all_urls) < 1:
519 if not opts.update_self:
520 parser.error(u'you must provide at least one URL')
525 retcode = fd.download(all_urls)
526 except MaxDownloadsReached:
527 fd.to_screen(u'--max-download limit reached, aborting.')
530 # Dump cookie jar if requested
531 if opts.cookiefile is not None:
534 except (IOError, OSError) as err:
535 sys.exit(u'ERROR: unable to save cookie jar')
542 except DownloadError:
544 except SameFileError:
545 sys.exit(u'ERROR: fixed output name but more than one file to download')
546 except KeyboardInterrupt:
547 sys.exit(u'\nERROR: Interrupted by user')