import pysrt
import tempfile
import os
import re
import xml.etree.ElementTree as ElementTree
import inspect
from typing import Optional, List
from pysrt import SubRipFile, SubRipItem
from copy import deepcopy
from .utils import Utils
from .exception import UnsupportedFormatException
[docs]class Subtitle(object):
"""Load a subtitle file into internal data structure
"""
__secret = object()
ElementTree.register_namespace("", "http://www.w3.org/ns/ttml")
ElementTree.register_namespace("tts", "http://www.w3.org/ns/ttml#styling")
ElementTree.register_namespace("ttm", "http://www.w3.org/ns/ttml#metadata")
ElementTree.register_namespace("ttp", "http://www.w3.org/ns/ttml#parameter")
ElementTree.register_namespace("ebuttm", "urn:ebu:tt:metadata")
ElementTree.register_namespace("ebutts", "urn:ebu:tt:style")
TT_NS = {"tt": "http://www.w3.org/ns/ttml"}
SUBRIP_EXTENTIONS = [".srt"]
TTML_EXTENSIONS = [".xml", ".ttml", ".dfxp"]
WEBVTT_EXTENSIONS = [".vtt"]
SSA_EXTENTIONS = [".ssa"]
ADVANCED_SSA_EXTENTIONS = [".ass"]
MICRODVD_EXTENSIONS = [".sub"]
MPL2_EXTENSIONS = [".txt"]
TMP_EXTENSIONS = [".tmp"]
SAMI_EXTENSIONS = [".smi", ".sami"]
STL_EXTENSIONS = [".stl"]
SCC_EXTENSIONS = [".scc"]
SBV_EXTENSIONS = [".sbv"]
YT_TRANSCRIPT_EXTENSIONS = [".ytt"]
def __init__(self, secret: object, subtitle_file_path: str, subtitle_format: str) -> None:
"""Subtitle object initialiser.
Arguments:
secret {object} -- A hash only known by factory methods.
subtitle_file_path {string} -- The path to the subtitle file.
format {string} -- Supported subtitle formats: subrip and ttml.
Raises:
NotImplementedError -- Thrown when any subtitle attributes are modified.
"""
assert (
secret == Subtitle.__secret
), "Only factory methods are supported when creating instances"
self.__subtitle_file_path = subtitle_file_path
if subtitle_format == "subrip":
self.__subs = self.__load_subrip(subtitle_file_path)
elif subtitle_format == "subrip_raw":
self.__subs = pysrt.SubRipFile().from_string(subtitle_file_path)
elif subtitle_format == "ttml":
self.__subs = self.__convert_ttml_to_subs(subtitle_file_path)
elif subtitle_format == "webvtt":
self.__subs = self.__convert_vtt_to_subs(subtitle_file_path)
elif subtitle_format == "ssa":
self.__subs = self.__convert_ssa_to_subs(subtitle_file_path)
elif subtitle_format == "ass":
self.__subs = self.__convert_ass_to_subs(subtitle_file_path)
elif subtitle_format == "microdvd":
self.__subs = self.__convert_microdvd_to_subs(subtitle_file_path)
elif subtitle_format == "mpl2":
self.__subs = self.__convert_mpl2_to_subs(subtitle_file_path)
elif subtitle_format == "tmp":
self.__subs = self.__convert_tmp_to_subs(subtitle_file_path)
elif subtitle_format == "sami":
self.__subs = self.__convert_sami_to_subs(subtitle_file_path)
elif subtitle_format == "stl":
self.__subs = self.__convert_stl_to_subs(subtitle_file_path)
elif subtitle_format == "scc":
self.__subs = self.__convert_scc_to_subs(subtitle_file_path)
elif subtitle_format == "sbv":
self.__subs = self.__convert_sbv_to_subs(subtitle_file_path)
elif subtitle_format == "ytt":
self.__subs = self.__convert_ytt_to_subs(subtitle_file_path)
else:
raise UnsupportedFormatException(
"Unknown subtitle format for file: {}".format(subtitle_file_path)
)
if not self.__subs:
raise UnsupportedFormatException(
"No subtitle found in file: {}".format(subtitle_file_path)
)
[docs] @classmethod
def load_subrip(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a SubRip subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "subrip")
[docs] @classmethod
def load_subrip_str(cls, subrip_raw: str) -> "Subtitle":
"""Load a SubRip subtitle string.
Arguments:
subrip_str {string} -- The string representation of the SubRip content.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subrip_raw, "subrip_raw")
[docs] @classmethod
def load_ttml(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a TTML subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "ttml")
[docs] @classmethod
def load_webvtt(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a WebVTT subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "webvtt")
[docs] @classmethod
def load_ssa(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a SubStation Alpha v4.0 subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "ssa")
[docs] @classmethod
def load_ass(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a Advanced SubStation Alpha v4.0+ subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "ass")
[docs] @classmethod
def load_microdvd(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a MicroDVD subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "microdvd")
[docs] @classmethod
def load_mpl2(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a MPL2 subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "mpl2")
[docs] @classmethod
def load_tmp(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a TMP subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "tmp")
[docs] @classmethod
def load_sami(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a SAMI subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "sami")
[docs] @classmethod
def load_stl(cls, subtitle_file_path: str) -> "Subtitle":
"""Load an EBU STL subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "stl")
[docs] @classmethod
def load_scc(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a Scenarist Closed Caption subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "scc")
[docs] @classmethod
def load_sbv(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a SubViewer subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "sbv")
[docs] @classmethod
def load_ytt(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a YouTube transcript subtitle file.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
return cls(cls.__secret, subtitle_file_path, "ytt")
[docs] @classmethod
def load(cls, subtitle_file_path: str) -> "Subtitle":
"""Load a SubRip or TTML subtitle file based on the file extension.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
Returns:
Subtitle -- Subtitle object.
"""
_, file_extension = os.path.splitext(subtitle_file_path.lower())
if file_extension in cls.SUBRIP_EXTENTIONS:
return cls(cls.__secret, subtitle_file_path, "subrip")
elif file_extension in cls.TTML_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "ttml")
elif file_extension in cls.WEBVTT_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "webvtt")
elif file_extension in cls.SSA_EXTENTIONS:
return cls(cls.__secret, subtitle_file_path, "ssa")
elif file_extension in cls.ADVANCED_SSA_EXTENTIONS:
return cls(cls.__secret, subtitle_file_path, "ass")
elif file_extension in cls.MICRODVD_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "microdvd")
elif file_extension in cls.MPL2_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "mpl2")
elif file_extension in cls.TMP_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "tmp")
elif file_extension in cls.SAMI_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "sami")
elif file_extension in cls.STL_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "stl")
elif file_extension in cls.SCC_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "scc")
elif file_extension in cls.SBV_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "sbv")
elif file_extension in cls.YT_TRANSCRIPT_EXTENSIONS:
return cls(cls.__secret, subtitle_file_path, "ytt")
else:
return cls(cls.__secret, subtitle_file_path, "unknown")
[docs] @classmethod
def shift_subtitle(
cls,
subtitle_file_path: str,
seconds: float,
shifted_subtitle_file_path: Optional[str] = None,
suffix: str = "_shifted",
) -> Optional[str]:
"""Shift subtitle cues based on the input seconds.
Arguments:
subtitle_file_path {string} -- The path to the subtitle file.
seconds {float} -- The number of seconds by which the cues are shifted.
Keyword Arguments:
shifted_subtitle_file_path {string} -- The path to the shifted subtitle file (default: {None}).
suffix {string} -- The suffix used as part of the aligned subtitle file name.
Returns:
string -- The path to the shifted subtitle file.
"""
_, file_extension = os.path.splitext(subtitle_file_path)
if shifted_subtitle_file_path is None:
shifted_subtitle_file_path = subtitle_file_path.replace(
file_extension, "{}{}".format(suffix, file_extension)
)
if file_extension.lower() in cls.TTML_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "ttml").subs
subs.shift(seconds=seconds)
tree = ElementTree.parse(subtitle_file_path)
tt = tree.getroot()
cues = (tt.find("tt:body", Subtitle.TT_NS).find("tt:div", Subtitle.TT_NS).findall("tt:p", Subtitle.TT_NS)) # type: ignore
for index, cue in enumerate(cues):
cue.attrib["begin"] = str(subs[index].start).replace(",", ".")
cue.attrib["end"] = str(subs[index].end).replace(",", ".")
encoding = Utils.detect_encoding(subtitle_file_path)
tree.write(shifted_subtitle_file_path, encoding=encoding)
elif file_extension.lower() in cls.STL_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "stl").subs
subs.shift(seconds=seconds)
Subtitle.__export_with_format(subs, subtitle_file_path, shifted_subtitle_file_path, ".srt", suffix)
else:
if file_extension.lower() in cls.SUBRIP_EXTENTIONS:
subs = cls(cls.__secret, subtitle_file_path, "subrip").subs
elif file_extension.lower() in cls.WEBVTT_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "webvtt").subs
elif file_extension.lower() in cls.SSA_EXTENTIONS:
subs = cls(cls.__secret, subtitle_file_path, "ssa").subs
elif file_extension.lower() in cls.ADVANCED_SSA_EXTENTIONS:
subs = cls(cls.__secret, subtitle_file_path, "ass").subs
elif file_extension.lower() in cls.MICRODVD_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "microdvd").subs
elif file_extension.lower() in cls.MPL2_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "mpl2").subs
elif file_extension.lower() in cls.TMP_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "tmp").subs
elif file_extension.lower() in cls.SAMI_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "sami").subs
elif file_extension.lower() in cls.SCC_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "scc").subs
elif file_extension.lower() in cls.SBV_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "sbv").subs
elif file_extension.lower() in cls.YT_TRANSCRIPT_EXTENSIONS:
subs = cls(cls.__secret, subtitle_file_path, "ytt").subs
else:
raise UnsupportedFormatException(
"Unknown subtitle format for file: {}".format(subtitle_file_path)
)
subs.shift(seconds=seconds)
Subtitle.__export_with_format(subs, subtitle_file_path, shifted_subtitle_file_path, file_extension, suffix)
return shifted_subtitle_file_path
[docs] @staticmethod
def export_subtitle(source_file_path: str, subs: List[SubRipItem], target_file_path: str, frame_rate: float = 25.0, encoding: Optional[str] = None) -> None:
"""Export subtitle in the format determined by the file extension.
Arguments:
source_file_path {string} -- The path to the original subtitle file.
subs {list} -- A list of SubRipItems.
target_file_path {string} -- The path to the exported subtitle file.
frame_rate {float} -- The frame rate for frame-based subtitle formats {default: 25.0}.
encoding {str} -- The encoding of the exported subtitle file {default: None}.
"""
encoding = Utils.detect_encoding(source_file_path) if encoding is None else encoding
_, file_extension = os.path.splitext(source_file_path.lower())
Subtitle.__save_subtitle_by_extension(file_extension, subs, source_file_path, target_file_path, encoding, frame_rate, is_exporting=True)
[docs] @staticmethod
def remove_sound_effects_by_case(subs: List[SubRipItem], se_uppercase: bool = True) -> List[SubRipItem]:
"""Remove subtitles of sound effects based on case
Arguments:
subs {list} -- A list of SubRipItems.
se_uppercase {bool} -- True when the sound effect is in uppercase or False when in lowercase (default: {True}).
Returns:
{list} -- A list of SubRipItems.
"""
new_subs = deepcopy(subs)
for sub in subs:
if se_uppercase is not None:
if se_uppercase and sub.text.isupper():
new_subs.remove(sub)
elif not se_uppercase and sub.text.islower():
new_subs.remove(sub)
return new_subs
[docs] @staticmethod
def remove_sound_effects_by_affixes(subs: List[SubRipItem], se_prefix: str, se_suffix: Optional[str] = None) -> List[SubRipItem]:
"""Remove subtitles of sound effects based on prefix or prefix and suffix
Arguments:
subs {list} -- A list of SubRipItems.
se_prefix {string} -- A prefix indicating the start of the sound effect.
se_suffix {string} -- A suffix indicating the end of the sound effect (default: {None}).
Returns:
{list} -- A list of SubRipItems.
"""
new_subs = deepcopy(subs)
for sub in subs:
if se_suffix is not None:
match = re.search(
"^{0}[^{0}{1}]+{1}$".format(
re.escape(se_prefix), re.escape(se_suffix)
),
sub.text,
)
else:
match = re.search("^{0}[^{0}]+$".format(re.escape(se_prefix)), sub.text)
if match:
new_subs.remove(sub)
return new_subs
[docs] @staticmethod
def subtitle_extensions() -> set:
"""Get the file extensions of the supported subtitles.
Returns:
{set} -- The subtitle extensions.
"""
return set(Subtitle.SUBRIP_EXTENTIONS + Subtitle.TTML_EXTENSIONS + Subtitle.WEBVTT_EXTENSIONS
+ Subtitle.SSA_EXTENTIONS + Subtitle.ADVANCED_SSA_EXTENTIONS + Subtitle.MICRODVD_EXTENSIONS
+ Subtitle.MPL2_EXTENSIONS + Subtitle.TMP_EXTENSIONS + Subtitle.SAMI_EXTENSIONS
+ Subtitle.STL_EXTENSIONS + Subtitle.SCC_EXTENSIONS + Subtitle.SBV_EXTENSIONS
+ Subtitle.YT_TRANSCRIPT_EXTENSIONS)
@property
def subtitle_file_path(self) -> str:
return self.__subtitle_file_path
@property
def subs(self) -> SubRipFile:
return self.__subs
@staticmethod
def __load_subrip(subrip_file_path: str) -> SubRipFile:
"""Load a subtitle file in the SubRip format
Arguments:
subrip_file_path {string} -- The path to the SubRip subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
return Subtitle.__get_srt_subs(subrip_file_path)
@staticmethod
def __convert_ttml_to_subs(ttml_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the TTML format to the SubRip format
Arguments:
ttml_file_path {string} -- The path to the TTML subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.ttml2srt(ttml_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_vtt_to_subs(vtt_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the WebVTT format to the SubRip format
Arguments:
vtt_file_path {string} -- The path to the WebVTT subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.vtt2srt(vtt_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_ssa_to_subs(ssa_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the SubStation Alpha v4.0 format to the SubRip format
Arguments:
ass_file_path {string} -- The path to the SubStation Alpha v4.0 subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
path = "%s.srt" % path
Utils.ssa2srt(ssa_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_ass_to_subs(ass_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the Advanced SubStation Alpha v4.0+ format to the SubRip format
Arguments:
ass_file_path {string} -- The path to the Advanced SubStation Alpha v4.0+ subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
path = "%s.srt" % path
Utils.ass2srt(ass_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_microdvd_to_subs(microdvd_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the MicroDVD format to the SubRip format
Arguments:
microdvd_file_path {string} -- The path to the MicroDVD subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
path = "%s.srt" % path
Utils.microdvd2srt(microdvd_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_mpl2_to_subs(mpl2_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the MPL2 format to the SubRip format
Arguments:
mpl2_file_path {string} -- The path to the MPL2 subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
path = "%s.srt" % path
Utils.mpl22srt(mpl2_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_tmp_to_subs(tmp_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the TMP format to the SubRip format
Arguments:
tmp_file_path {string} -- The path to the TMP subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
path = "%s.srt" % path
Utils.tmp2srt(tmp_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_sami_to_subs(sami_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the SAMI format to the SubRip format
Arguments:
sami_file_path {string} -- The path to the SAMI subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.sami2srt(sami_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_stl_to_subs(stl_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the EBU STL format to the SubRip format
Arguments:
stl_file_path {string} -- The path to the STL subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.stl2srt(stl_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_scc_to_subs(scc_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the SCC format to the SubRip format
Arguments:
scc_file_path {string} -- The path to the SCC subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.scc2srt(scc_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_sbv_to_subs(sbv_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the SubViewer format to the SubRip format
Arguments:
sbv_file_path {string} -- The path to the SubViewer subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.sbv2srt(sbv_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __convert_ytt_to_subs(ytt_file_path: str) -> SubRipFile:
"""Convert a subtitle file from the YouTube transcript format to the SubRip format
Arguments:
ytt_file_path {string} -- The path to the YouTube transcript subtitle file.
Returns:
{list} -- A list of SubRipItems.
"""
_, path = tempfile.mkstemp()
Utils.ytt2srt(ytt_file_path, path)
return Subtitle.__get_srt_subs(path, housekeep=True)
@staticmethod
def __export_with_format(subs: List[SubRipItem], source_file_path: str, target_file_path: Optional[str], file_extension: str, suffix: str) -> None:
if target_file_path is None:
target_file_path = source_file_path.replace(
file_extension, "{}{}".format(suffix, file_extension)
)
Subtitle.export_subtitle(source_file_path, subs, target_file_path)
@staticmethod
def __get_srt_subs(subrip_file_path: str, housekeep: bool = False) -> SubRipFile:
encoding = Utils.detect_encoding(subrip_file_path)
try:
subs = pysrt.open(subrip_file_path, encoding=encoding)
except Exception as e:
raise UnsupportedFormatException("Error occurred when loading subtitle from %s" % subrip_file_path) from e
finally:
if housekeep:
os.remove(subrip_file_path)
return subs
@staticmethod
def __save_subtitle_by_extension(file_extension: str,
subs: List[SubRipItem],
source_file_path: str,
target_file_path: str,
encoding: str,
frame_rate: Optional[float],
is_exporting: bool = False):
if file_extension in Subtitle.SUBRIP_EXTENTIONS:
SubRipFile(subs).save(target_file_path, encoding=encoding)
Utils.remove_trailing_newlines(target_file_path, encoding)
elif file_extension in Subtitle.TTML_EXTENSIONS:
if is_exporting:
tree = ElementTree.parse(source_file_path)
tt = tree.getroot()
cues = (tt.find("tt:body", Subtitle.TT_NS).find("tt:div", Subtitle.TT_NS).findall("tt:p", Subtitle.TT_NS)) # type: ignore
for index, cue in enumerate(cues):
cue.attrib["begin"] = str(subs[index].start).replace(",", ".")
cue.attrib["end"] = str(subs[index].end).replace(",", ".")
# Change single quotes in the XML header to double quotes
with open(target_file_path, "w", encoding=encoding) as target:
if "xml_declaration" in inspect.getfullargspec(ElementTree.tostring).kwonlyargs: # for >= python 3.8
encoded = ElementTree.tostring(tt, encoding=encoding, method="xml", xml_declaration=True) # type: ignore
else:
encoded = ElementTree.tostring(tt, encoding=encoding, method="xml")
normalised = encoded.decode(encoding) \
.replace("<?xml version='1.0' encoding='", '<?xml version="1.0" encoding="',) \
.replace("'?>", '"?>')
target.write(normalised)
else:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2ttml(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.WEBVTT_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2vtt(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.SSA_EXTENTIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2ssa(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.ADVANCED_SSA_EXTENTIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2ass(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.MICRODVD_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2microdvd(path, target_file_path, frame_rate=frame_rate)
finally:
os.remove(path)
elif file_extension in Subtitle.MPL2_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2mpl2(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.TMP_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2tmp(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.SAMI_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2sami(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.STL_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(target_file_path, encoding=encoding)
finally:
os.remove(path)
elif file_extension in Subtitle.SCC_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2scc(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.SBV_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2sbv(path, target_file_path)
finally:
os.remove(path)
elif file_extension in Subtitle.YT_TRANSCRIPT_EXTENSIONS:
try:
_, path = tempfile.mkstemp()
SubRipFile(subs).save(path, encoding=encoding)
Utils.srt2ytt(path, target_file_path)
finally:
os.remove(path)
else:
raise UnsupportedFormatException(
"Unknown subtitle format for file: {}".format(source_file_path)
)