]> Raphaƫl G. Git Repositories - youtubedl/blob - youtube_dl/__init__.py
debian/copyright: Fix lintian's dep5-copyright-license-name-not-unique.
[youtubedl] / youtube_dl / __init__.py
1 #!/usr/bin/env python
2 # -*- coding: utf-8 -*-
3
4 from __future__ import unicode_literals
5
6 __license__ = 'Public Domain'
7
8 import codecs
9 import io
10 import os
11 import random
12 import shlex
13 import sys
14
15
16 from .options import (
17 parseOpts,
18 )
19 from .compat import (
20 compat_expanduser,
21 compat_getpass,
22 compat_print,
23 workaround_optparse_bug9161,
24 )
25 from .utils import (
26 DateRange,
27 decodeOption,
28 DEFAULT_OUTTMPL,
29 DownloadError,
30 match_filter_func,
31 MaxDownloadsReached,
32 preferredencoding,
33 read_batch_urls,
34 SameFileError,
35 setproctitle,
36 std_headers,
37 write_string,
38 )
39 from .update import update_self
40 from .downloader import (
41 FileDownloader,
42 )
43 from .extractor import gen_extractors, list_extractors
44 from .YoutubeDL import YoutubeDL
45
46
47 def _real_main(argv=None):
48 # Compatibility fixes for Windows
49 if sys.platform == 'win32':
50 # https://github.com/rg3/youtube-dl/issues/820
51 codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
52
53 workaround_optparse_bug9161()
54
55 setproctitle('youtube-dl')
56
57 parser, opts, args = parseOpts(argv)
58
59 # Set user agent
60 if opts.user_agent is not None:
61 std_headers['User-Agent'] = opts.user_agent
62
63 # Set referer
64 if opts.referer is not None:
65 std_headers['Referer'] = opts.referer
66
67 # Custom HTTP headers
68 if opts.headers is not None:
69 for h in opts.headers:
70 if h.find(':', 1) < 0:
71 parser.error('wrong header formatting, it should be key:value, not "%s"' % h)
72 key, value = h.split(':', 2)
73 if opts.verbose:
74 write_string('[debug] Adding header from command line option %s:%s\n' % (key, value))
75 std_headers[key] = value
76
77 # Dump user agent
78 if opts.dump_user_agent:
79 compat_print(std_headers['User-Agent'])
80 sys.exit(0)
81
82 # Batch file verification
83 batch_urls = []
84 if opts.batchfile is not None:
85 try:
86 if opts.batchfile == '-':
87 batchfd = sys.stdin
88 else:
89 batchfd = io.open(opts.batchfile, 'r', encoding='utf-8', errors='ignore')
90 batch_urls = read_batch_urls(batchfd)
91 if opts.verbose:
92 write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n')
93 except IOError:
94 sys.exit('ERROR: batch file could not be read')
95 all_urls = batch_urls + args
96 all_urls = [url.strip() for url in all_urls]
97 _enc = preferredencoding()
98 all_urls = [url.decode(_enc, 'ignore') if isinstance(url, bytes) else url for url in all_urls]
99
100 if opts.list_extractors:
101 for ie in list_extractors(opts.age_limit):
102 compat_print(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else ''))
103 matchedUrls = [url for url in all_urls if ie.suitable(url)]
104 for mu in matchedUrls:
105 compat_print(' ' + mu)
106 sys.exit(0)
107 if opts.list_extractor_descriptions:
108 for ie in list_extractors(opts.age_limit):
109 if not ie._WORKING:
110 continue
111 desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
112 if desc is False:
113 continue
114 if hasattr(ie, 'SEARCH_KEY'):
115 _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
116 _COUNTS = ('', '5', '10', 'all')
117 desc += ' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES))
118 compat_print(desc)
119 sys.exit(0)
120
121 # Conflicting, missing and erroneous options
122 if opts.usenetrc and (opts.username is not None or opts.password is not None):
123 parser.error('using .netrc conflicts with giving username/password')
124 if opts.password is not None and opts.username is None:
125 parser.error('account username missing\n')
126 if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
127 parser.error('using output template conflicts with using title, video ID or auto number')
128 if opts.usetitle and opts.useid:
129 parser.error('using title conflicts with using video ID')
130 if opts.username is not None and opts.password is None:
131 opts.password = compat_getpass('Type account password and press [Return]: ')
132 if opts.ratelimit is not None:
133 numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
134 if numeric_limit is None:
135 parser.error('invalid rate limit specified')
136 opts.ratelimit = numeric_limit
137 if opts.min_filesize is not None:
138 numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
139 if numeric_limit is None:
140 parser.error('invalid min_filesize specified')
141 opts.min_filesize = numeric_limit
142 if opts.max_filesize is not None:
143 numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
144 if numeric_limit is None:
145 parser.error('invalid max_filesize specified')
146 opts.max_filesize = numeric_limit
147 if opts.retries is not None:
148 if opts.retries in ('inf', 'infinite'):
149 opts_retries = float('inf')
150 else:
151 try:
152 opts_retries = int(opts.retries)
153 except (TypeError, ValueError):
154 parser.error('invalid retry count specified')
155 if opts.buffersize is not None:
156 numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
157 if numeric_buffersize is None:
158 parser.error('invalid buffer size specified')
159 opts.buffersize = numeric_buffersize
160 if opts.playliststart <= 0:
161 raise ValueError('Playlist start must be positive')
162 if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart:
163 raise ValueError('Playlist end must be greater than playlist start')
164 if opts.extractaudio:
165 if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']:
166 parser.error('invalid audio format specified')
167 if opts.audioquality:
168 opts.audioquality = opts.audioquality.strip('k').strip('K')
169 if not opts.audioquality.isdigit():
170 parser.error('invalid audio quality specified')
171 if opts.recodevideo is not None:
172 if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg', 'mkv']:
173 parser.error('invalid video recode format specified')
174 if opts.convertsubtitles is not None:
175 if opts.convertsubtitles not in ['srt', 'vtt', 'ass']:
176 parser.error('invalid subtitle format specified')
177
178 if opts.date is not None:
179 date = DateRange.day(opts.date)
180 else:
181 date = DateRange(opts.dateafter, opts.datebefore)
182
183 # Do not download videos when there are audio-only formats
184 if opts.extractaudio and not opts.keepvideo and opts.format is None:
185 opts.format = 'bestaudio/best'
186
187 # --all-sub automatically sets --write-sub if --write-auto-sub is not given
188 # this was the old behaviour if only --all-sub was given.
189 if opts.allsubtitles and not opts.writeautomaticsub:
190 opts.writesubtitles = True
191
192 outtmpl = ((opts.outtmpl is not None and opts.outtmpl) or
193 (opts.format == '-1' and opts.usetitle and '%(title)s-%(id)s-%(format)s.%(ext)s') or
194 (opts.format == '-1' and '%(id)s-%(format)s.%(ext)s') or
195 (opts.usetitle and opts.autonumber and '%(autonumber)s-%(title)s-%(id)s.%(ext)s') or
196 (opts.usetitle and '%(title)s-%(id)s.%(ext)s') or
197 (opts.useid and '%(id)s.%(ext)s') or
198 (opts.autonumber and '%(autonumber)s-%(id)s.%(ext)s') or
199 DEFAULT_OUTTMPL)
200 if not os.path.splitext(outtmpl)[1] and opts.extractaudio:
201 parser.error('Cannot download a video and extract audio into the same'
202 ' file! Use "{0}.%(ext)s" instead of "{0}" as the output'
203 ' template'.format(outtmpl))
204
205 any_getting = opts.geturl or opts.gettitle or opts.getid or opts.getthumbnail or opts.getdescription or opts.getfilename or opts.getformat or opts.getduration or opts.dumpjson or opts.dump_single_json
206 any_printing = opts.print_json
207 download_archive_fn = compat_expanduser(opts.download_archive) if opts.download_archive is not None else opts.download_archive
208
209 # PostProcessors
210 postprocessors = []
211 # Add the metadata pp first, the other pps will copy it
212 if opts.metafromtitle:
213 postprocessors.append({
214 'key': 'MetadataFromTitle',
215 'titleformat': opts.metafromtitle
216 })
217 if opts.addmetadata:
218 postprocessors.append({'key': 'FFmpegMetadata'})
219 if opts.extractaudio:
220 postprocessors.append({
221 'key': 'FFmpegExtractAudio',
222 'preferredcodec': opts.audioformat,
223 'preferredquality': opts.audioquality,
224 'nopostoverwrites': opts.nopostoverwrites,
225 })
226 if opts.recodevideo:
227 postprocessors.append({
228 'key': 'FFmpegVideoConvertor',
229 'preferedformat': opts.recodevideo,
230 })
231 if opts.convertsubtitles:
232 postprocessors.append({
233 'key': 'FFmpegSubtitlesConvertor',
234 'format': opts.convertsubtitles,
235 })
236 if opts.embedsubtitles:
237 postprocessors.append({
238 'key': 'FFmpegEmbedSubtitle',
239 })
240 if opts.xattrs:
241 postprocessors.append({'key': 'XAttrMetadata'})
242 if opts.embedthumbnail:
243 already_have_thumbnail = opts.writethumbnail or opts.write_all_thumbnails
244 postprocessors.append({
245 'key': 'EmbedThumbnail',
246 'already_have_thumbnail': already_have_thumbnail
247 })
248 if not already_have_thumbnail:
249 opts.writethumbnail = True
250 # Please keep ExecAfterDownload towards the bottom as it allows the user to modify the final file in any way.
251 # So if the user is able to remove the file before your postprocessor runs it might cause a few problems.
252 if opts.exec_cmd:
253 postprocessors.append({
254 'key': 'ExecAfterDownload',
255 'exec_cmd': opts.exec_cmd,
256 })
257 if opts.xattr_set_filesize:
258 try:
259 import xattr
260 xattr # Confuse flake8
261 except ImportError:
262 parser.error('setting filesize xattr requested but python-xattr is not available')
263 external_downloader_args = None
264 if opts.external_downloader_args:
265 external_downloader_args = shlex.split(opts.external_downloader_args)
266 match_filter = (
267 None if opts.match_filter is None
268 else match_filter_func(opts.match_filter))
269
270 ydl_opts = {
271 'usenetrc': opts.usenetrc,
272 'username': opts.username,
273 'password': opts.password,
274 'twofactor': opts.twofactor,
275 'videopassword': opts.videopassword,
276 'quiet': (opts.quiet or any_getting or any_printing),
277 'no_warnings': opts.no_warnings,
278 'forceurl': opts.geturl,
279 'forcetitle': opts.gettitle,
280 'forceid': opts.getid,
281 'forcethumbnail': opts.getthumbnail,
282 'forcedescription': opts.getdescription,
283 'forceduration': opts.getduration,
284 'forcefilename': opts.getfilename,
285 'forceformat': opts.getformat,
286 'forcejson': opts.dumpjson or opts.print_json,
287 'dump_single_json': opts.dump_single_json,
288 'simulate': opts.simulate or any_getting,
289 'skip_download': opts.skip_download,
290 'format': opts.format,
291 'listformats': opts.listformats,
292 'outtmpl': outtmpl,
293 'autonumber_size': opts.autonumber_size,
294 'restrictfilenames': opts.restrictfilenames,
295 'ignoreerrors': opts.ignoreerrors,
296 'ratelimit': opts.ratelimit,
297 'nooverwrites': opts.nooverwrites,
298 'retries': opts_retries,
299 'buffersize': opts.buffersize,
300 'noresizebuffer': opts.noresizebuffer,
301 'continuedl': opts.continue_dl,
302 'noprogress': opts.noprogress,
303 'progress_with_newline': opts.progress_with_newline,
304 'playliststart': opts.playliststart,
305 'playlistend': opts.playlistend,
306 'playlistreverse': opts.playlist_reverse,
307 'noplaylist': opts.noplaylist,
308 'logtostderr': opts.outtmpl == '-',
309 'consoletitle': opts.consoletitle,
310 'nopart': opts.nopart,
311 'updatetime': opts.updatetime,
312 'writedescription': opts.writedescription,
313 'writeannotations': opts.writeannotations,
314 'writeinfojson': opts.writeinfojson,
315 'writethumbnail': opts.writethumbnail,
316 'write_all_thumbnails': opts.write_all_thumbnails,
317 'writesubtitles': opts.writesubtitles,
318 'writeautomaticsub': opts.writeautomaticsub,
319 'allsubtitles': opts.allsubtitles,
320 'listsubtitles': opts.listsubtitles,
321 'subtitlesformat': opts.subtitlesformat,
322 'subtitleslangs': opts.subtitleslangs,
323 'matchtitle': decodeOption(opts.matchtitle),
324 'rejecttitle': decodeOption(opts.rejecttitle),
325 'max_downloads': opts.max_downloads,
326 'prefer_free_formats': opts.prefer_free_formats,
327 'verbose': opts.verbose,
328 'dump_intermediate_pages': opts.dump_intermediate_pages,
329 'write_pages': opts.write_pages,
330 'test': opts.test,
331 'keepvideo': opts.keepvideo,
332 'min_filesize': opts.min_filesize,
333 'max_filesize': opts.max_filesize,
334 'min_views': opts.min_views,
335 'max_views': opts.max_views,
336 'daterange': date,
337 'cachedir': opts.cachedir,
338 'youtube_print_sig_code': opts.youtube_print_sig_code,
339 'age_limit': opts.age_limit,
340 'download_archive': download_archive_fn,
341 'cookiefile': opts.cookiefile,
342 'nocheckcertificate': opts.no_check_certificate,
343 'prefer_insecure': opts.prefer_insecure,
344 'proxy': opts.proxy,
345 'socket_timeout': opts.socket_timeout,
346 'bidi_workaround': opts.bidi_workaround,
347 'debug_printtraffic': opts.debug_printtraffic,
348 'prefer_ffmpeg': opts.prefer_ffmpeg,
349 'include_ads': opts.include_ads,
350 'default_search': opts.default_search,
351 'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
352 'encoding': opts.encoding,
353 'extract_flat': opts.extract_flat,
354 'merge_output_format': opts.merge_output_format,
355 'postprocessors': postprocessors,
356 'fixup': opts.fixup,
357 'source_address': opts.source_address,
358 'call_home': opts.call_home,
359 'sleep_interval': opts.sleep_interval,
360 'external_downloader': opts.external_downloader,
361 'list_thumbnails': opts.list_thumbnails,
362 'playlist_items': opts.playlist_items,
363 'xattr_set_filesize': opts.xattr_set_filesize,
364 'match_filter': match_filter,
365 'no_color': opts.no_color,
366 'ffmpeg_location': opts.ffmpeg_location,
367 'hls_prefer_native': opts.hls_prefer_native,
368 'external_downloader_args': external_downloader_args,
369 'cn_verification_proxy': opts.cn_verification_proxy,
370 }
371
372 with YoutubeDL(ydl_opts) as ydl:
373 # Update version
374 if opts.update_self:
375 update_self(ydl.to_screen, opts.verbose)
376
377 # Remove cache dir
378 if opts.rm_cachedir:
379 ydl.cache.remove()
380
381 # Maybe do nothing
382 if (len(all_urls) < 1) and (opts.load_info_filename is None):
383 if opts.update_self or opts.rm_cachedir:
384 sys.exit()
385
386 ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv)
387 parser.error(
388 'You must provide at least one URL.\n'
389 'Type youtube-dl --help to see a list of all options.')
390
391 try:
392 if opts.load_info_filename is not None:
393 retcode = ydl.download_with_info_file(opts.load_info_filename)
394 else:
395 retcode = ydl.download(all_urls)
396 except MaxDownloadsReached:
397 ydl.to_screen('--max-download limit reached, aborting.')
398 retcode = 101
399
400 sys.exit(retcode)
401
402
403 def main(argv=None):
404 try:
405 _real_main(argv)
406 except DownloadError:
407 sys.exit(1)
408 except SameFileError:
409 sys.exit('ERROR: fixed output name but more than one file to download')
410 except KeyboardInterrupt:
411 sys.exit('\nERROR: Interrupted by user')
412
413 __all__ = ['main', 'YoutubeDL', 'gen_extractors', 'list_extractors']