2 # -*- coding: utf-8 -*-
4 from __future__ import unicode_literals
6 __license__ = 'Public Domain'
15 from .options import (
22 workaround_optparse_bug9161,
39 from .update import update_self
40 from .downloader import (
43 from .extractor import gen_extractors, list_extractors
44 from .extractor.adobepass import MSO_INFO
45 from .YoutubeDL import YoutubeDL
48 def _real_main(argv=None):
49 # Compatibility fixes for Windows
50 if sys.platform == 'win32':
51 # https://github.com/rg3/youtube-dl/issues/820
52 codecs.register(lambda name: codecs.lookup('utf-8') if name == 'cp65001' else None)
54 workaround_optparse_bug9161()
56 setproctitle('youtube-dl')
58 parser, opts, args = parseOpts(argv)
61 if opts.user_agent is not None:
62 std_headers['User-Agent'] = opts.user_agent
65 if opts.referer is not None:
66 std_headers['Referer'] = opts.referer
69 if opts.headers is not None:
70 for h in opts.headers:
72 parser.error('wrong header formatting, it should be key:value, not "%s"' % h)
73 key, value = h.split(':', 1)
75 write_string('[debug] Adding header from command line option %s:%s\n' % (key, value))
76 std_headers[key] = value
79 if opts.dump_user_agent:
80 write_string(std_headers['User-Agent'] + '\n', out=sys.stdout)
83 # Batch file verification
85 if opts.batchfile is not None:
87 if opts.batchfile == '-':
91 compat_expanduser(opts.batchfile),
92 'r', encoding='utf-8', errors='ignore')
93 batch_urls = read_batch_urls(batchfd)
95 write_string('[debug] Batch file urls: ' + repr(batch_urls) + '\n')
97 sys.exit('ERROR: batch file could not be read')
98 all_urls = batch_urls + args
99 all_urls = [url.strip() for url in all_urls]
100 _enc = preferredencoding()
101 all_urls = [url.decode(_enc, 'ignore') if isinstance(url, bytes) else url for url in all_urls]
103 if opts.list_extractors:
104 for ie in list_extractors(opts.age_limit):
105 write_string(ie.IE_NAME + (' (CURRENTLY BROKEN)' if not ie._WORKING else '') + '\n', out=sys.stdout)
106 matchedUrls = [url for url in all_urls if ie.suitable(url)]
107 for mu in matchedUrls:
108 write_string(' ' + mu + '\n', out=sys.stdout)
110 if opts.list_extractor_descriptions:
111 for ie in list_extractors(opts.age_limit):
114 desc = getattr(ie, 'IE_DESC', ie.IE_NAME)
117 if hasattr(ie, 'SEARCH_KEY'):
118 _SEARCHES = ('cute kittens', 'slithering pythons', 'falling cat', 'angry poodle', 'purple fish', 'running tortoise', 'sleeping bunny', 'burping cow')
119 _COUNTS = ('', '5', '10', 'all')
120 desc += ' (Example: "%s%s:%s" )' % (ie.SEARCH_KEY, random.choice(_COUNTS), random.choice(_SEARCHES))
121 write_string(desc + '\n', out=sys.stdout)
123 if opts.list_ap_mso_ids:
124 table = [[mso_id, mso_info['name']] for mso_id, mso_info in MSO_INFO.items()]
125 write_string('Supported TV Providers:\n' + render_table(['mso id', 'mso name'], table) + '\n', out=sys.stdout)
128 # Conflicting, missing and erroneous options
129 if opts.usenetrc and (opts.username is not None or opts.password is not None):
130 parser.error('using .netrc conflicts with giving username/password')
131 if opts.password is not None and opts.username is None:
132 parser.error('account username missing\n')
133 if opts.ap_password is not None and opts.ap_username is None:
134 parser.error('TV Provider account username missing\n')
135 if opts.outtmpl is not None and (opts.usetitle or opts.autonumber or opts.useid):
136 parser.error('using output template conflicts with using title, video ID or auto number')
137 if opts.usetitle and opts.useid:
138 parser.error('using title conflicts with using video ID')
139 if opts.username is not None and opts.password is None:
140 opts.password = compat_getpass('Type account password and press [Return]: ')
141 if opts.ap_username is not None and opts.ap_password is None:
142 opts.ap_password = compat_getpass('Type TV provider account password and press [Return]: ')
143 if opts.ratelimit is not None:
144 numeric_limit = FileDownloader.parse_bytes(opts.ratelimit)
145 if numeric_limit is None:
146 parser.error('invalid rate limit specified')
147 opts.ratelimit = numeric_limit
148 if opts.min_filesize is not None:
149 numeric_limit = FileDownloader.parse_bytes(opts.min_filesize)
150 if numeric_limit is None:
151 parser.error('invalid min_filesize specified')
152 opts.min_filesize = numeric_limit
153 if opts.max_filesize is not None:
154 numeric_limit = FileDownloader.parse_bytes(opts.max_filesize)
155 if numeric_limit is None:
156 parser.error('invalid max_filesize specified')
157 opts.max_filesize = numeric_limit
158 if opts.sleep_interval is not None:
159 if opts.sleep_interval < 0:
160 parser.error('sleep interval must be positive or 0')
161 if opts.max_sleep_interval is not None:
162 if opts.max_sleep_interval < 0:
163 parser.error('max sleep interval must be positive or 0')
164 if opts.max_sleep_interval < opts.sleep_interval:
165 parser.error('max sleep interval must be greater than or equal to min sleep interval')
167 opts.max_sleep_interval = opts.sleep_interval
169 def parse_retries(retries):
170 if retries in ('inf', 'infinite'):
171 parsed_retries = float('inf')
174 parsed_retries = int(retries)
175 except (TypeError, ValueError):
176 parser.error('invalid retry count specified')
177 return parsed_retries
178 if opts.retries is not None:
179 opts.retries = parse_retries(opts.retries)
180 if opts.fragment_retries is not None:
181 opts.fragment_retries = parse_retries(opts.fragment_retries)
182 if opts.buffersize is not None:
183 numeric_buffersize = FileDownloader.parse_bytes(opts.buffersize)
184 if numeric_buffersize is None:
185 parser.error('invalid buffer size specified')
186 opts.buffersize = numeric_buffersize
187 if opts.playliststart <= 0:
188 raise ValueError('Playlist start must be positive')
189 if opts.playlistend not in (-1, None) and opts.playlistend < opts.playliststart:
190 raise ValueError('Playlist end must be greater than playlist start')
191 if opts.extractaudio:
192 if opts.audioformat not in ['best', 'aac', 'mp3', 'm4a', 'opus', 'vorbis', 'wav']:
193 parser.error('invalid audio format specified')
194 if opts.audioquality:
195 opts.audioquality = opts.audioquality.strip('k').strip('K')
196 if not opts.audioquality.isdigit():
197 parser.error('invalid audio quality specified')
198 if opts.recodevideo is not None:
199 if opts.recodevideo not in ['mp4', 'flv', 'webm', 'ogg', 'mkv', 'avi']:
200 parser.error('invalid video recode format specified')
201 if opts.convertsubtitles is not None:
202 if opts.convertsubtitles not in ['srt', 'vtt', 'ass']:
203 parser.error('invalid subtitle format specified')
205 if opts.date is not None:
206 date = DateRange.day(opts.date)
208 date = DateRange(opts.dateafter, opts.datebefore)
210 # Do not download videos when there are audio-only formats
211 if opts.extractaudio and not opts.keepvideo and opts.format is None:
212 opts.format = 'bestaudio/best'
214 # --all-sub automatically sets --write-sub if --write-auto-sub is not given
215 # this was the old behaviour if only --all-sub was given.
216 if opts.allsubtitles and not opts.writeautomaticsub:
217 opts.writesubtitles = True
219 outtmpl = ((opts.outtmpl is not None and opts.outtmpl) or
220 (opts.format == '-1' and opts.usetitle and '%(title)s-%(id)s-%(format)s.%(ext)s') or
221 (opts.format == '-1' and '%(id)s-%(format)s.%(ext)s') or
222 (opts.usetitle and opts.autonumber and '%(autonumber)s-%(title)s-%(id)s.%(ext)s') or
223 (opts.usetitle and '%(title)s-%(id)s.%(ext)s') or
224 (opts.useid and '%(id)s.%(ext)s') or
225 (opts.autonumber and '%(autonumber)s-%(id)s.%(ext)s') or
227 if not os.path.splitext(outtmpl)[1] and opts.extractaudio:
228 parser.error('Cannot download a video and extract audio into the same'
229 ' file! Use "{0}.%(ext)s" instead of "{0}" as the output'
230 ' template'.format(outtmpl))
232 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
233 any_printing = opts.print_json
234 download_archive_fn = compat_expanduser(opts.download_archive) if opts.download_archive is not None else opts.download_archive
238 # Add the metadata pp first, the other pps will copy it
239 if opts.metafromtitle:
240 postprocessors.append({
241 'key': 'MetadataFromTitle',
242 'titleformat': opts.metafromtitle
245 postprocessors.append({'key': 'FFmpegMetadata'})
246 if opts.extractaudio:
247 postprocessors.append({
248 'key': 'FFmpegExtractAudio',
249 'preferredcodec': opts.audioformat,
250 'preferredquality': opts.audioquality,
251 'nopostoverwrites': opts.nopostoverwrites,
254 postprocessors.append({
255 'key': 'FFmpegVideoConvertor',
256 'preferedformat': opts.recodevideo,
258 if opts.convertsubtitles:
259 postprocessors.append({
260 'key': 'FFmpegSubtitlesConvertor',
261 'format': opts.convertsubtitles,
263 if opts.embedsubtitles:
264 postprocessors.append({
265 'key': 'FFmpegEmbedSubtitle',
268 postprocessors.append({'key': 'XAttrMetadata'})
269 if opts.embedthumbnail:
270 already_have_thumbnail = opts.writethumbnail or opts.write_all_thumbnails
271 postprocessors.append({
272 'key': 'EmbedThumbnail',
273 'already_have_thumbnail': already_have_thumbnail
275 if not already_have_thumbnail:
276 opts.writethumbnail = True
277 # Please keep ExecAfterDownload towards the bottom as it allows the user to modify the final file in any way.
278 # So if the user is able to remove the file before your postprocessor runs it might cause a few problems.
280 postprocessors.append({
281 'key': 'ExecAfterDownload',
282 'exec_cmd': opts.exec_cmd,
284 if opts.xattr_set_filesize:
287 xattr # Confuse flake8
289 parser.error('setting filesize xattr requested but python-xattr is not available')
290 external_downloader_args = None
291 if opts.external_downloader_args:
292 external_downloader_args = compat_shlex_split(opts.external_downloader_args)
293 postprocessor_args = None
294 if opts.postprocessor_args:
295 postprocessor_args = compat_shlex_split(opts.postprocessor_args)
297 None if opts.match_filter is None
298 else match_filter_func(opts.match_filter))
301 'usenetrc': opts.usenetrc,
302 'username': opts.username,
303 'password': opts.password,
304 'twofactor': opts.twofactor,
305 'videopassword': opts.videopassword,
306 'ap_mso_id': opts.ap_mso_id,
307 'ap_username': opts.ap_username,
308 'ap_password': opts.ap_password,
309 'quiet': (opts.quiet or any_getting or any_printing),
310 'no_warnings': opts.no_warnings,
311 'forceurl': opts.geturl,
312 'forcetitle': opts.gettitle,
313 'forceid': opts.getid,
314 'forcethumbnail': opts.getthumbnail,
315 'forcedescription': opts.getdescription,
316 'forceduration': opts.getduration,
317 'forcefilename': opts.getfilename,
318 'forceformat': opts.getformat,
319 'forcejson': opts.dumpjson or opts.print_json,
320 'dump_single_json': opts.dump_single_json,
321 'simulate': opts.simulate or any_getting,
322 'skip_download': opts.skip_download,
323 'format': opts.format,
324 'listformats': opts.listformats,
326 'autonumber_size': opts.autonumber_size,
327 'restrictfilenames': opts.restrictfilenames,
328 'ignoreerrors': opts.ignoreerrors,
329 'force_generic_extractor': opts.force_generic_extractor,
330 'ratelimit': opts.ratelimit,
331 'nooverwrites': opts.nooverwrites,
332 'retries': opts.retries,
333 'fragment_retries': opts.fragment_retries,
334 'skip_unavailable_fragments': opts.skip_unavailable_fragments,
335 'buffersize': opts.buffersize,
336 'noresizebuffer': opts.noresizebuffer,
337 'continuedl': opts.continue_dl,
338 'noprogress': opts.noprogress,
339 'progress_with_newline': opts.progress_with_newline,
340 'playliststart': opts.playliststart,
341 'playlistend': opts.playlistend,
342 'playlistreverse': opts.playlist_reverse,
343 'noplaylist': opts.noplaylist,
344 'logtostderr': opts.outtmpl == '-',
345 'consoletitle': opts.consoletitle,
346 'nopart': opts.nopart,
347 'updatetime': opts.updatetime,
348 'writedescription': opts.writedescription,
349 'writeannotations': opts.writeannotations,
350 'writeinfojson': opts.writeinfojson,
351 'writethumbnail': opts.writethumbnail,
352 'write_all_thumbnails': opts.write_all_thumbnails,
353 'writesubtitles': opts.writesubtitles,
354 'writeautomaticsub': opts.writeautomaticsub,
355 'allsubtitles': opts.allsubtitles,
356 'listsubtitles': opts.listsubtitles,
357 'subtitlesformat': opts.subtitlesformat,
358 'subtitleslangs': opts.subtitleslangs,
359 'matchtitle': decodeOption(opts.matchtitle),
360 'rejecttitle': decodeOption(opts.rejecttitle),
361 'max_downloads': opts.max_downloads,
362 'prefer_free_formats': opts.prefer_free_formats,
363 'verbose': opts.verbose,
364 'dump_intermediate_pages': opts.dump_intermediate_pages,
365 'write_pages': opts.write_pages,
367 'keepvideo': opts.keepvideo,
368 'min_filesize': opts.min_filesize,
369 'max_filesize': opts.max_filesize,
370 'min_views': opts.min_views,
371 'max_views': opts.max_views,
373 'cachedir': opts.cachedir,
374 'youtube_print_sig_code': opts.youtube_print_sig_code,
375 'age_limit': opts.age_limit,
376 'download_archive': download_archive_fn,
377 'cookiefile': opts.cookiefile,
378 'nocheckcertificate': opts.no_check_certificate,
379 'prefer_insecure': opts.prefer_insecure,
381 'socket_timeout': opts.socket_timeout,
382 'bidi_workaround': opts.bidi_workaround,
383 'debug_printtraffic': opts.debug_printtraffic,
384 'prefer_ffmpeg': opts.prefer_ffmpeg,
385 'include_ads': opts.include_ads,
386 'default_search': opts.default_search,
387 'youtube_include_dash_manifest': opts.youtube_include_dash_manifest,
388 'encoding': opts.encoding,
389 'extract_flat': opts.extract_flat,
390 'mark_watched': opts.mark_watched,
391 'merge_output_format': opts.merge_output_format,
392 'postprocessors': postprocessors,
394 'source_address': opts.source_address,
395 'call_home': opts.call_home,
396 'sleep_interval': opts.sleep_interval,
397 'max_sleep_interval': opts.max_sleep_interval,
398 'external_downloader': opts.external_downloader,
399 'list_thumbnails': opts.list_thumbnails,
400 'playlist_items': opts.playlist_items,
401 'xattr_set_filesize': opts.xattr_set_filesize,
402 'match_filter': match_filter,
403 'no_color': opts.no_color,
404 'ffmpeg_location': opts.ffmpeg_location,
405 'hls_prefer_native': opts.hls_prefer_native,
406 'hls_use_mpegts': opts.hls_use_mpegts,
407 'external_downloader_args': external_downloader_args,
408 'postprocessor_args': postprocessor_args,
409 'cn_verification_proxy': opts.cn_verification_proxy,
410 'geo_verification_proxy': opts.geo_verification_proxy,
414 with YoutubeDL(ydl_opts) as ydl:
417 update_self(ydl.to_screen, opts.verbose, ydl._opener)
424 if (len(all_urls) < 1) and (opts.load_info_filename is None):
425 if opts.update_self or opts.rm_cachedir:
428 ydl.warn_if_short_id(sys.argv[1:] if argv is None else argv)
430 'You must provide at least one URL.\n'
431 'Type youtube-dl --help to see a list of all options.')
434 if opts.load_info_filename is not None:
435 retcode = ydl.download_with_info_file(compat_expanduser(opts.load_info_filename))
437 retcode = ydl.download(all_urls)
438 except MaxDownloadsReached:
439 ydl.to_screen('--max-download limit reached, aborting.')
448 except DownloadError:
450 except SameFileError:
451 sys.exit('ERROR: fixed output name but more than one file to download')
452 except KeyboardInterrupt:
453 sys.exit('\nERROR: Interrupted by user')
455 __all__ = ['main', 'YoutubeDL', 'gen_extractors', 'list_extractors']