aeidon/agents/open.py¶
Source code for module aeidon.agents.open from file aeidon/agents/open.py.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 | # -*- coding: utf-8 -*-
# Copyright (C) 2005 Osmo Salomaa
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
"""Reading and parsing data from subtitle files."""
import aeidon
import bisect
class OpenAgent(aeidon.Delegate):
"""Reading and parsing data from subtitle files."""
def _align_translations_by_number(self, subtitles):
"""Add translation texts by aligning subtitle numbers."""
indices = list(range(len(self.subtitles), len(subtitles)))
self.insert_subtitles(indices, register=None)
for i, subtitle in enumerate(subtitles):
self.subtitles[i].tran_text = subtitle.main_text
def _align_translations_by_position(self, subtitles):
"""Add translation texts by aligning subtitle positions."""
subtitles = [x.copy() for x in subtitles]
mode = self.main_file.mode
i = 0
while subtitles:
# Examine subtitles to be added one-by-one by comparing
# their temporal middle positions with the start and end
# positions of existing subtitles.
ts = subtitles[0].get_start(mode)
te = subtitles[0].get_end(mode)
tm = self.calc.get_middle(ts, te)
while True:
# Skip over existing subtitles when
# no suitable match found among translations.
if i == len(self.subtitles): break
ms = self.subtitles[i].get_start(mode)
me = self.subtitles[i].get_end(mode)
if not self.calc.is_earlier(me, tm): break
i += 1
if i == len(self.subtitles) or self.calc.is_later(ms, tm):
# Add a new subtitle when no suitable match
# found among existing subtitles.
subtitle = self.new_subtitle()
subtitle.start = subtitles[0].start
subtitle.end = subtitles[0].end
self.subtitles.insert(i, subtitle)
self.subtitles[i].tran_text = subtitles[0].main_text
subtitles.pop(0)
i += 1
@aeidon.deco.export
def open(self, doc, path, encoding=None, align_method=None):
"""
Read and parse subtitle data for `doc` from `path`.
`encoding` can be ``None`` to use the system default encoding.
Return the amount of subtitles that needed to be moved in order
to arrange them in ascending chronological order.
Raise :exc:`IOError` if reading fails.
Raise :exc:`UnicodeError` if decoding fails.
Raise :exc:`aeidon.FormatError` if unable to detect format.
Raise :exc:`aeidon.ParseError` if parsing fails.
"""
if doc == aeidon.documents.MAIN:
return self.open_main(path, encoding)
if doc == aeidon.documents.TRAN:
return self.open_translation(path, encoding, align_method)
raise ValueError("Invalid document: {}".format(repr(doc)))
@aeidon.deco.export
@aeidon.deco.notify_frozen
def open_main(self, path, encoding=None):
"""
Read and parse subtitle data for main file from `path`.
`encoding` can be ``None`` to use the system default encoding.
Return the amount of subtitles that needed to be moved in order
to arrange them in ascending chronological order.
Raise :exc:`IOError` if reading fails.
Raise :exc:`UnicodeError` if decoding fails.
Raise :exc:`aeidon.FormatError` if unable to detect format.
Raise :exc:`aeidon.ParseError` if parsing fails.
"""
encoding = encoding or aeidon.util.get_default_encoding()
bom_encoding = aeidon.encodings.detect_bom(path)
if not bom_encoding in (encoding, None):
return self.open_main(path, bom_encoding)
format = aeidon.util.detect_format(path, encoding)
self.main_file = aeidon.files.new(format, path, encoding)
subtitles = self._read_file(self.main_file)
self.subtitles, sort_count = self._sort_subtitles(subtitles)
self.set_framerate(self.framerate, register=None)
self.main_changed = 0
# Deactivate possible translation file.
self.tran_file = None
self.tran_changed = None
self.emit("main-file-opened", self.main_file)
return sort_count
@aeidon.deco.export
@aeidon.deco.notify_frozen
def open_translation(self, path, encoding=None, align_method=None):
"""
Read and parse subtitle data for translation file from `path`.
`encoding` can be ``None`` to use the system default encoding.
`align_method` specifies how translation texts are attached to existing
subtitles. :attr:`aeidon.align_methods.NUMBER` is the simple way, which
adds the translation texts in order, one-by-one to the exising
subtitles. :attr:`aeidon.align_methods.POSITION` (the default) is the
smarter way, which compares the position data in the translation
subtitles with the existing subtitles, skips and inserts subtitles as
needed to have at least a rough chronological match. The latter thus
takes into account that not all subtitles are translated, or vice versa
and that one main subtitle may correspond to two translation subtitles,
or vice versa, as per length restrictions etc.
Return the amount of subtitles that needed to be moved in order
to arrange them in ascending chronological order.
Raise :exc:`IOError` if reading fails.
Raise :exc:`UnicodeError` if decoding fails.
Raise :exc:`aeidon.FormatError` if unable to detect format.
Raise :exc:`aeidon.ParseError` if parsing fails.
"""
encoding = encoding or aeidon.util.get_default_encoding()
align_method = align_method or aeidon.align_methods.POSITION
bom_encoding = aeidon.encodings.detect_bom(path)
if bom_encoding not in (encoding, None):
return self.open_translation(path, bom_encoding, align_method)
format = aeidon.util.detect_format(path, encoding)
self.tran_file = aeidon.files.new(format, path, encoding)
subtitles = self._read_file(self.tran_file)
subtitles, sort_count = self._sort_subtitles(subtitles)
for subtitle in subtitles:
subtitle.framerate = self.framerate
for subtitle in self.subtitles:
subtitle.tran_text = ""
blocked = self.block("subtitles-inserted")
if align_method == aeidon.align_methods.NUMBER:
self._align_translations_by_number(subtitles)
if align_method == aeidon.align_methods.POSITION:
self._align_translations_by_position(subtitles)
self.unblock("subtitles-inserted", blocked)
self.tran_changed = 0
self.emit("translation-file-opened", self.tran_file)
return sort_count
def _read_file(self, file):
"""
Read `file` and return subtitles.
Raise :exc:`IOError` if reading fails.
Raise :exc:`UnicodeError` if decoding fails.
Raise :exc:`aeidon.ParseError` if parsing fails.
"""
try:
return file.read()
except (IOError, UnicodeError):
raise
except Exception:
# It's difficult to tell the difference between a parse error,
# i.e. a syntactic problem in the file to be read and a bug
# in our own parsing code. Let's assume our code is bug-free!
raise aeidon.ParseError("Failed to parse file {}"
.format(repr(file.path)))
def _sort_subtitles(self, subtitles):
"""Return sorted `subtitles` and sort count."""
sort_count = 0
sorted_starts = []
for start in (x.start_frame for x in subtitles):
bisect.insort(sorted_starts, start)
if sorted_starts[-1] != start:
sort_count += 1
return sorted(subtitles), sort_count
|