2 # -*- coding: utf-8 -*-
4 from __future__ import with_statement
7 'Ricardo Garcia Gonzalez',
15 'Philipp Hagemeister',
23 __license__ = 'Public Domain'
24 __version__ = '2012.11.17'
26 UPDATE_URL = 'https://raw.github.com/rg3/youtube-dl/master/youtube-dl'
27 UPDATE_URL_VERSION = 'https://raw.github.com/rg3/youtube-dl/master/LATEST_VERSION'
28 UPDATE_URL_EXE = 'https://raw.github.com/rg3/youtube-dl/master/youtube-dl.exe'
44 from FileDownloader import *
45 from InfoExtractors import *
46 from PostProcessor import *
48 def updateSelf(downloader, filename):
49 ''' Update the program file with the latest version from the repository '''
50 # Note: downloader only used for options
52 if not os.access(filename, os.W_OK):
53 sys.exit('ERROR: no write permissions on %s' % filename)
55 downloader.to_screen(u'Updating to latest version...')
57 urlv = urllib2.urlopen(UPDATE_URL_VERSION)
58 newversion = urlv.read().strip()
59 if newversion == __version__:
60 downloader.to_screen(u'youtube-dl is up-to-date (' + __version__ + ')')
64 if hasattr(sys, "frozen"): #py2exe
65 exe = os.path.abspath(filename)
66 directory = os.path.dirname(exe)
67 if not os.access(directory, os.W_OK):
68 sys.exit('ERROR: no write permissions on %s' % directory)
71 urlh = urllib2.urlopen(UPDATE_URL_EXE)
72 newcontent = urlh.read()
74 with open(exe + '.new', 'wb') as outf:
75 outf.write(newcontent)
76 except (IOError, OSError), err:
77 sys.exit('ERROR: unable to download latest version')
80 bat = os.path.join(directory, 'youtube-dl-updater.bat')
84 echo Updating youtube-dl...
85 ping 127.0.0.1 -n 5 -w 1000 > NUL
93 except (IOError, OSError), err:
94 sys.exit('ERROR: unable to overwrite current version')
98 urlh = urllib2.urlopen(UPDATE_URL)
99 newcontent = urlh.read()
101 except (IOError, OSError), err:
102 sys.exit('ERROR: unable to download latest version')
105 with open(filename, 'wb') as outf:
106 outf.write(newcontent)
107 except (IOError, OSError), err:
108 sys.exit('ERROR: unable to overwrite current version')
110 downloader.to_screen(u'Updated youtube-dl. Restart youtube-dl to use the new version.')
113 def _readOptions(filename_bytes):
115 optionf = open(filename_bytes)
117 return [] # silently skip if file is not present
121 res += shlex.split(l, comments=True)
126 def _format_option_string(option):
127 ''' ('-o', '--option') -> -o, --format METAVAR'''
131 if option._short_opts: opts.append(option._short_opts[0])
132 if option._long_opts: opts.append(option._long_opts[0])
133 if len(opts) > 1: opts.insert(1, ', ')
135 if option.takes_value(): opts.append(' %s' % option.metavar)
139 def _find_term_columns():
140 columns = os.environ.get('COLUMNS', None)
145 sp = subprocess.Popen(['stty', 'size'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
146 out,err = sp.communicate()
147 return int(out.split()[1])
153 max_help_position = 80
155 # No need to wrap help messages if we're on a wide console
156 columns = _find_term_columns()
157 if columns: max_width = columns
159 fmt = optparse.IndentedHelpFormatter(width=max_width, max_help_position=max_help_position)
160 fmt.format_option_strings = _format_option_string
163 'version' : __version__,
165 'usage' : '%prog [options] url [url...]',
166 'conflict_handler' : 'resolve',
169 parser = optparse.OptionParser(**kw)
172 general = optparse.OptionGroup(parser, 'General Options')
173 selection = optparse.OptionGroup(parser, 'Video Selection')
174 authentication = optparse.OptionGroup(parser, 'Authentication Options')
175 video_format = optparse.OptionGroup(parser, 'Video Format Options')
176 postproc = optparse.OptionGroup(parser, 'Post-processing Options')
177 filesystem = optparse.OptionGroup(parser, 'Filesystem Options')
178 verbosity = optparse.OptionGroup(parser, 'Verbosity / Simulation Options')
180 general.add_option('-h', '--help',
181 action='help', help='print this help text and exit')
182 general.add_option('-v', '--version',
183 action='version', help='print program version and exit')
184 general.add_option('-U', '--update',
185 action='store_true', dest='update_self', help='update this program to latest version')
186 general.add_option('-i', '--ignore-errors',
187 action='store_true', dest='ignoreerrors', help='continue on download errors', default=False)
188 general.add_option('-r', '--rate-limit',
189 dest='ratelimit', metavar='LIMIT', help='download rate limit (e.g. 50k or 44.6m)')
190 general.add_option('-R', '--retries',
191 dest='retries', metavar='RETRIES', help='number of retries (default is %default)', default=10)
192 general.add_option('--dump-user-agent',
193 action='store_true', dest='dump_user_agent',
194 help='display the current browser identification', default=False)
195 general.add_option('--user-agent',
196 dest='user_agent', help='specify a custom user agent', metavar='UA')
197 general.add_option('--list-extractors',
198 action='store_true', dest='list_extractors',
199 help='List all supported extractors and the URLs they would handle', default=False)
201 selection.add_option('--playlist-start',
202 dest='playliststart', metavar='NUMBER', help='playlist video to start at (default is %default)', default=1)
203 selection.add_option('--playlist-end',
204 dest='playlistend', metavar='NUMBER', help='playlist video to end at (default is last)', default=-1)
205 selection.add_option('--match-title', dest='matchtitle', metavar='REGEX',help='download only matching titles (regex or caseless sub-string)')
206 selection.add_option('--reject-title', dest='rejecttitle', metavar='REGEX',help='skip download for matching titles (regex or caseless sub-string)')
207 selection.add_option('--max-downloads', metavar='NUMBER', dest='max_downloads', help='Abort after downloading NUMBER files', default=None)
209 authentication.add_option('-u', '--username',
210 dest='username', metavar='USERNAME', help='account username')
211 authentication.add_option('-p', '--password',
212 dest='password', metavar='PASSWORD', help='account password')
213 authentication.add_option('-n', '--netrc',
214 action='store_true', dest='usenetrc', help='use .netrc authentication data', default=False)
217 video_format.add_option('-f', '--format',
218 action='store', dest='format', metavar='FORMAT', help='video format code')
219 video_format.add_option('--all-formats',
220 action='store_const', dest='format', help='download all available video formats', const='all')
221 video_format.add_option('--prefer-free-formats',
222 action='store_true', dest='prefer_free_formats', default=False, help='prefer free video formats unless a specific one is requested')
223 video_format.add_option('--max-quality',
224 action='store', dest='format_limit', metavar='FORMAT', help='highest quality format to download')
225 video_format.add_option('-F', '--list-formats',
226 action='store_true', dest='listformats', help='list all available formats (currently youtube only)')
227 video_format.add_option('--write-srt',
228 action='store_true', dest='writesubtitles',
229 help='write video closed captions to a .srt file (currently youtube only)', default=False)
230 video_format.add_option('--srt-lang',
231 action='store', dest='subtitleslang', metavar='LANG',
232 help='language of the closed captions to download (optional) use IETF language tags like \'en\'')
235 verbosity.add_option('-q', '--quiet',
236 action='store_true', dest='quiet', help='activates quiet mode', default=False)
237 verbosity.add_option('-s', '--simulate',
238 action='store_true', dest='simulate', help='do not download the video and do not write anything to disk', default=False)
239 verbosity.add_option('--skip-download',
240 action='store_true', dest='skip_download', help='do not download the video', default=False)
241 verbosity.add_option('-g', '--get-url',
242 action='store_true', dest='geturl', help='simulate, quiet but print URL', default=False)
243 verbosity.add_option('-e', '--get-title',
244 action='store_true', dest='gettitle', help='simulate, quiet but print title', default=False)
245 verbosity.add_option('--get-thumbnail',
246 action='store_true', dest='getthumbnail',
247 help='simulate, quiet but print thumbnail URL', default=False)
248 verbosity.add_option('--get-description',
249 action='store_true', dest='getdescription',
250 help='simulate, quiet but print video description', default=False)
251 verbosity.add_option('--get-filename',
252 action='store_true', dest='getfilename',
253 help='simulate, quiet but print output filename', default=False)
254 verbosity.add_option('--get-format',
255 action='store_true', dest='getformat',
256 help='simulate, quiet but print output format', default=False)
257 verbosity.add_option('--no-progress',
258 action='store_true', dest='noprogress', help='do not print progress bar', default=False)
259 verbosity.add_option('--console-title',
260 action='store_true', dest='consoletitle',
261 help='display progress in console titlebar', default=False)
262 verbosity.add_option('-v', '--verbose',
263 action='store_true', dest='verbose', help='print various debugging information', default=False)
266 filesystem.add_option('-t', '--title',
267 action='store_true', dest='usetitle', help='use title in file name', default=False)
268 filesystem.add_option('--id',
269 action='store_true', dest='useid', help='use video ID in file name', default=False)
270 filesystem.add_option('-l', '--literal',
271 action='store_true', dest='usetitle', help='[deprecated] alias of --title', default=False)
272 filesystem.add_option('-A', '--auto-number',
273 action='store_true', dest='autonumber',
274 help='number downloaded files starting from 00000', default=False)
275 filesystem.add_option('-o', '--output',
276 dest='outtmpl', metavar='TEMPLATE', help='output filename template. Use %(stitle)s to get the title, %(uploader)s for the uploader name, %(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.')
277 filesystem.add_option('-a', '--batch-file',
278 dest='batchfile', metavar='FILE', help='file containing URLs to download (\'-\' for stdin)')
279 filesystem.add_option('-w', '--no-overwrites',
280 action='store_true', dest='nooverwrites', help='do not overwrite files', default=False)
281 filesystem.add_option('-c', '--continue',
282 action='store_true', dest='continue_dl', help='resume partially downloaded files', default=True)
283 filesystem.add_option('--no-continue',
284 action='store_false', dest='continue_dl',
285 help='do not resume partially downloaded files (restart from beginning)')
286 filesystem.add_option('--cookies',
287 dest='cookiefile', metavar='FILE', help='file to read cookies from and dump cookie jar in')
288 filesystem.add_option('--no-part',
289 action='store_true', dest='nopart', help='do not use .part files', default=False)
290 filesystem.add_option('--no-mtime',
291 action='store_false', dest='updatetime',
292 help='do not use the Last-modified header to set the file modification time', default=True)
293 filesystem.add_option('--write-description',
294 action='store_true', dest='writedescription',
295 help='write video description to a .description file', default=False)
296 filesystem.add_option('--write-info-json',
297 action='store_true', dest='writeinfojson',
298 help='write video metadata to a .info.json file', default=False)
301 postproc.add_option('-x', '--extract-audio', action='store_true', dest='extractaudio', default=False,
302 help='convert video files to audio-only files (requires ffmpeg or avconv and ffprobe or avprobe)')
303 postproc.add_option('--audio-format', metavar='FORMAT', dest='audioformat', default='best',
304 help='"best", "aac", "vorbis", "mp3", "m4a", or "wav"; best by default')
305 postproc.add_option('--audio-quality', metavar='QUALITY', dest='audioquality', default='5',
306 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)')
307 postproc.add_option('-k', '--keep-video', action='store_true', dest='keepvideo', default=False,
308 help='keeps the video file on disk after the post-processing; the video is erased by default')
311 parser.add_option_group(general)
312 parser.add_option_group(selection)
313 parser.add_option_group(filesystem)
314 parser.add_option_group(verbosity)
315 parser.add_option_group(video_format)
316 parser.add_option_group(authentication)
317 parser.add_option_group(postproc)
319 xdg_config_home = os.environ.get('XDG_CONFIG_HOME')
321 userConf = os.path.join(xdg_config_home, 'youtube-dl.conf')
323 userConf = os.path.join(os.path.expanduser('~'), '.config', 'youtube-dl.conf')
324 argv = _readOptions('/etc/youtube-dl.conf') + _readOptions(userConf) + sys.argv[1:]
325 opts, args = parser.parse_args(argv)
327 return parser, opts, args
329 def gen_extractors():
330 """ Return a list of an instance of every supported extractor.
331 The order does matter; the first extractor matched is the one handling the URL.
359 StanfordOpenClassroomIE(),
369 parser, opts, args = parseOpts()
371 # Open appropriate CookieJar
372 if opts.cookiefile is None:
373 jar = cookielib.CookieJar()
376 jar = cookielib.MozillaCookieJar(opts.cookiefile)
377 if os.path.isfile(opts.cookiefile) and os.access(opts.cookiefile, os.R_OK):
379 except (IOError, OSError), err:
380 sys.exit(u'ERROR: unable to open cookie file')
382 if opts.user_agent is not None:
383 std_headers['User-Agent'] = opts.user_agent
386 if opts.dump_user_agent:
387 print std_headers['User-Agent']
390 # Batch file verification
392 if opts.batchfile is not None:
394 if opts.batchfile == '-':
397 batchfd = open(opts.batchfile, 'r')
398 batchurls = batchfd.readlines()
399 batchurls = [x.strip() for x in batchurls]
400 batchurls = [x for x in batchurls if len(x) > 0 and not re.search(r'^[#/;]', x)]
402 sys.exit(u'ERROR: batch file could not be read')
403 all_urls = batchurls + args
404 all_urls = map(lambda url: url.strip(), all_urls)
406 # General configuration
407 cookie_processor = urllib2.HTTPCookieProcessor(jar)
408 proxy_handler = urllib2.ProxyHandler()
409 opener = urllib2.build_opener(proxy_handler, cookie_processor, YoutubeDLHandler())
410 urllib2.install_opener(opener)
411 socket.setdefaulttimeout(300) # 5 minutes should be enough (famous last words)
413 extractors = gen_extractors()
415 if opts.list_extractors:
416 for ie in extractors:
418 matchedUrls = filter(lambda url: ie.suitable(url), all_urls)
419 all_urls = filter(lambda url: url not in matchedUrls, all_urls)
420 for mu in matchedUrls:
424 # Conflicting, missing and erroneous options
425 if opts.usenetrc and (opts.username is not None or opts.password is not None):
426 parser.error(u'using .netrc conflicts with giving username/password')
427 if opts.password is not None and opts.username is None:
428 parser.error(u'account username missing')
429 if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
430 parser.error(u'using output template conflicts with using title, video ID or auto number')
431 if opts.usetitle and opts.useid:
432 parser.error(u'using title conflicts with using video ID')
433 if opts.username is not None and opts.password is None:
434 opts.password = getpass.getpass(u'Type account password and press return:')
435 if opts.ratelimit is not None:
436 numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
437 if numeric_limit is None:
438 parser.error(u'invalid rate limit specified')
439 opts.ratelimit = numeric_limit
440 if opts.retries is not None:
442 opts.retries = long(opts.retries)
443 except (TypeError, ValueError), err:
444 parser.error(u'invalid retry count specified')
446 opts.playliststart = int(opts.playliststart)
447 if opts.playliststart <= 0:
448 raise ValueError(u'Playlist start must be positive')
449 except (TypeError, ValueError), err:
450 parser.error(u'invalid playlist start number specified')
452 opts.playlistend = int(opts.playlistend)
453 if opts.playlistend != -1 and (opts.playlistend <= 0 or opts.playlistend < opts.playliststart):
454 raise ValueError(u'Playlist end must be greater than playlist start')
455 except (TypeError, ValueError), err:
456 parser.error(u'invalid playlist end number specified')
457 if opts.extractaudio:
458 if opts.audioformat not in ['best', 'aac', 'mp3', 'vorbis', 'm4a', 'wav']:
459 parser.error(u'invalid audio format specified')
460 if opts.audioquality:
461 opts.audioquality = opts.audioquality.strip('k').strip('K')
462 if not opts.audioquality.isdigit():
463 parser.error(u'invalid audio quality specified')
466 fd = FileDownloader({
467 'usenetrc': opts.usenetrc,
468 'username': opts.username,
469 'password': opts.password,
470 'quiet': (opts.quiet or opts.geturl or opts.gettitle or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat),
471 'forceurl': opts.geturl,
472 'forcetitle': opts.gettitle,
473 'forcethumbnail': opts.getthumbnail,
474 'forcedescription': opts.getdescription,
475 'forcefilename': opts.getfilename,
476 'forceformat': opts.getformat,
477 'simulate': opts.simulate,
478 '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),
479 'format': opts.format,
480 'format_limit': opts.format_limit,
481 'listformats': opts.listformats,
482 'outtmpl': ((opts.outtmpl is not None and opts.outtmpl.decode(preferredencoding()))
483 or (opts.format == '-1' and opts.usetitle and u'%(stitle)s-%(id)s-%(format)s.%(ext)s')
484 or (opts.format == '-1' and u'%(id)s-%(format)s.%(ext)s')
485 or (opts.usetitle and opts.autonumber and u'%(autonumber)s-%(stitle)s-%(id)s.%(ext)s')
486 or (opts.usetitle and u'%(stitle)s-%(id)s.%(ext)s')
487 or (opts.useid and u'%(id)s.%(ext)s')
488 or (opts.autonumber and u'%(autonumber)s-%(id)s.%(ext)s')
489 or u'%(id)s.%(ext)s'),
490 'ignoreerrors': opts.ignoreerrors,
491 'ratelimit': opts.ratelimit,
492 'nooverwrites': opts.nooverwrites,
493 'retries': opts.retries,
494 'continuedl': opts.continue_dl,
495 'noprogress': opts.noprogress,
496 'playliststart': opts.playliststart,
497 'playlistend': opts.playlistend,
498 'logtostderr': opts.outtmpl == '-',
499 'consoletitle': opts.consoletitle,
500 'nopart': opts.nopart,
501 'updatetime': opts.updatetime,
502 'writedescription': opts.writedescription,
503 'writeinfojson': opts.writeinfojson,
504 'writesubtitles': opts.writesubtitles,
505 'subtitleslang': opts.subtitleslang,
506 'matchtitle': opts.matchtitle,
507 'rejecttitle': opts.rejecttitle,
508 'max_downloads': opts.max_downloads,
509 'prefer_free_formats': opts.prefer_free_formats,
510 'verbose': opts.verbose,
514 fd.to_screen(u'[debug] Proxy map: ' + str(proxy_handler.proxies))
516 for extractor in extractors:
517 fd.add_info_extractor(extractor)
520 if opts.extractaudio:
521 fd.add_post_processor(FFmpegExtractAudioPP(preferredcodec=opts.audioformat, preferredquality=opts.audioquality, keepvideo=opts.keepvideo))
525 updateSelf(fd, sys.argv[0])
528 if len(all_urls) < 1:
529 if not opts.update_self:
530 parser.error(u'you must provide at least one URL')
535 retcode = fd.download(all_urls)
536 except MaxDownloadsReached:
537 fd.to_screen(u'--max-download limit reached, aborting.')
540 # Dump cookie jar if requested
541 if opts.cookiefile is not None:
544 except (IOError, OSError), err:
545 sys.exit(u'ERROR: unable to save cookie jar')
552 except DownloadError:
554 except SameFileError:
555 sys.exit(u'ERROR: fixed output name but more than one file to download')
556 except KeyboardInterrupt:
557 sys.exit(u'\nERROR: Interrupted by user')