aboutsummaryrefslogtreecommitdiff
path: root/youtube_dl/extractor/subtitles.py
diff options
context:
space:
mode:
Diffstat (limited to 'youtube_dl/extractor/subtitles.py')
-rw-r--r--youtube_dl/extractor/subtitles.py75
1 files changed, 75 insertions, 0 deletions
diff --git a/youtube_dl/extractor/subtitles.py b/youtube_dl/extractor/subtitles.py
new file mode 100644
index 000000000..caacea5fe
--- /dev/null
+++ b/youtube_dl/extractor/subtitles.py
@@ -0,0 +1,75 @@
+import socket
+
+from .common import InfoExtractor
+
+from ..utils import (
+ compat_http_client,
+ compat_urllib_error,
+ compat_urllib_request,
+ compat_str,
+)
+
+
+class SubtitlesIE(InfoExtractor):
+
+ def _list_available_subtitles(self, video_id):
+ """ outputs the available subtitles for the video """
+ sub_lang_list = self._get_available_subtitles(video_id)
+ sub_lang = ",".join(list(sub_lang_list.keys()))
+ self.to_screen(u'%s: Available subtitles for video: %s' %
+ (video_id, sub_lang))
+
+ def _extract_subtitles(self, video_id):
+ """ returns {sub_lang: sub} or {} if subtitles not found """
+ sub_lang_list = self._get_available_subtitles(video_id)
+ if not sub_lang_list: # error, it didn't get the available subtitles
+ return {}
+
+ if self._downloader.params.get('writesubtitles', False):
+ if self._downloader.params.get('subtitleslang', False):
+ sub_lang = self._downloader.params.get('subtitleslang')
+ elif 'en' in sub_lang_list:
+ sub_lang = 'en'
+ else:
+ sub_lang = list(sub_lang_list.keys())[0]
+ if not sub_lang in sub_lang_list:
+ self._downloader.report_warning(u'no closed captions found in the specified language "%s"' % sub_lang)
+ return {}
+ sub_lang_list = {sub_lang: sub_lang_list[sub_lang]}
+
+ subtitles = {}
+ for sub_lang, url in sub_lang_list.iteritems():
+ subtitle = self._request_subtitle_url(sub_lang, url)
+ if subtitle:
+ subtitles[sub_lang] = subtitle
+ return subtitles
+
+ def _request_subtitle_url(self, sub_lang, url):
+ """ makes the http request for the subtitle """
+ try:
+ sub = compat_urllib_request.urlopen(url).read().decode('utf-8')
+ except (compat_urllib_error.URLError, compat_http_client.HTTPException, socket.error) as err:
+ self._downloader.report_warning(u'unable to download video subtitles for %s: %s' % (sub_lang, compat_str(err)))
+ return
+ if not sub:
+ self._downloader.report_warning(u'Did not fetch video subtitles')
+ return
+ return sub
+
+ def _get_available_subtitles(self, video_id):
+ """ returns {sub_lang: url} or {} if not available """
+ """ Must be redefined by the subclasses """
+ pass
+
+ def _request_automatic_caption(self, video_id, webpage):
+ """ returns {sub_lang: sub} or {} if not available """
+ """ Must be redefined by the subclasses """
+ pass
+
+
+class NoAutoSubtitlesIE(SubtitlesIE):
+ """ A subtitle class for the servers that don't support auto-captions"""
+
+ def _request_automatic_caption(self, video_id, webpage):
+ self._downloader.report_warning(u'Automatic Captions not supported by this server')
+ return {}