subverter 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- subverter/__init__.py +24 -0
- subverter/_errors.py +12 -0
- subverter/_values.py +8 -0
- subverter/markup.py +13 -0
- subverter/py.typed +0 -0
- subverter/readers/__init__.py +52 -0
- subverter/readers/fields.py +96 -0
- subverter/readers/lrc.py +29 -0
- subverter/readers/subrip.py +83 -0
- subverter/readers/table.py +38 -0
- subverter/readers/whisper.py +185 -0
- subverter/transcript.py +68 -0
- subverter-0.1.0.dist-info/METADATA +79 -0
- subverter-0.1.0.dist-info/RECORD +17 -0
- subverter-0.1.0.dist-info/WHEEL +4 -0
- subverter-0.1.0.dist-info/licenses/LICENSE-APACHE +202 -0
- subverter-0.1.0.dist-info/licenses/LICENSE-MIT +18 -0
subverter/__init__.py
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
"""Subtitle and transcript readers into one model: cues, word timings, notes, refusals.
|
|
2
|
+
|
|
3
|
+
SubRip, WebVTT, LRC, CSV and TSV, and whisper-cli's and WhisperX's JSON (``readers.FORMATS``).
|
|
4
|
+
"""
|
|
5
|
+
|
|
6
|
+
from subverter._errors import Error
|
|
7
|
+
from subverter.markup import untagged
|
|
8
|
+
from subverter.readers import FORMATS, read
|
|
9
|
+
from subverter.transcript import Chunk, Cue, Reading, Timing, Transcript, Word
|
|
10
|
+
|
|
11
|
+
__all__ = [
|
|
12
|
+
"FORMATS",
|
|
13
|
+
"Chunk",
|
|
14
|
+
"Cue",
|
|
15
|
+
"Error",
|
|
16
|
+
"Reading",
|
|
17
|
+
"Timing",
|
|
18
|
+
"Transcript",
|
|
19
|
+
"Word",
|
|
20
|
+
"read",
|
|
21
|
+
"untagged",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
Error.__module__ = "subverter" # tracebacks name the public subverter.Error, not its private module
|
subverter/_errors.py
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""The one way subverter refuses: a subverter.Error, its message the reason."""
|
|
2
|
+
|
|
3
|
+
from typing import Never
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
class Error(Exception):
|
|
7
|
+
"""subverter's refusal: the input cannot be read as it stands; the message says why."""
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def refuse(message: str) -> Never:
|
|
11
|
+
"""Refuse with ``message``."""
|
|
12
|
+
raise Error(message)
|
subverter/_values.py
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
"""Numbers exactly: the one rounding subverter needs."""
|
|
2
|
+
|
|
3
|
+
from fractions import Fraction
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
def round_half_up(value: Fraction) -> int:
|
|
7
|
+
"""The nearest integer, halves up: the floor of ``value`` + 1/2, exactly -- (2n + d) // 2d."""
|
|
8
|
+
return (2 * value.numerator + value.denominator) // (2 * value.denominator)
|
subverter/markup.py
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"""A transcript's markup: its tags, which a reader reads its words without."""
|
|
2
|
+
|
|
3
|
+
import re
|
|
4
|
+
from typing import Final
|
|
5
|
+
|
|
6
|
+
__all__ = ["untagged"]
|
|
7
|
+
|
|
8
|
+
_TAG: Final = re.compile(r"<[^>]*>") # <u>, <i>, <font ...>: SubRip's and WebVTT's
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def untagged(text: str) -> str:
|
|
12
|
+
"""``text`` without its tags."""
|
|
13
|
+
return _TAG.sub("", text)
|
subverter/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"""The readers: a transcript's format to what it holds -- cues, word timings, notes, refusals."""
|
|
2
|
+
|
|
3
|
+
import csv
|
|
4
|
+
from typing import Final
|
|
5
|
+
|
|
6
|
+
from subverter._errors import refuse
|
|
7
|
+
from subverter.readers import lrc, subrip, table, whisper
|
|
8
|
+
from subverter.transcript import Reading
|
|
9
|
+
|
|
10
|
+
__all__ = ["FORMATS", "read"]
|
|
11
|
+
|
|
12
|
+
FORMATS: Final = ("srt", "vtt", "lrc", "csv", "tsv", "json") # the formats a reader reads
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
def read(fmt: str, data: bytes, name: str) -> Reading:
|
|
16
|
+
"""One format's reader, on the transcript's bytes (``name``: its name, in messages)."""
|
|
17
|
+
if fmt == "txt":
|
|
18
|
+
use = "use whisper-cli -osrt, -ovtt, -olrc, -ocsv, -oj or -ojf"
|
|
19
|
+
refuse(f"a .txt transcript has no timestamps; {use}, or WhisperX srt, vtt, tsv or json")
|
|
20
|
+
if fmt not in FORMATS:
|
|
21
|
+
refuse(f"unsupported subtitle format '.{fmt}' ({', '.join(FORMATS)})")
|
|
22
|
+
match fmt:
|
|
23
|
+
case "srt" | "vtt":
|
|
24
|
+
cues = subrip.rows(_lines(data))
|
|
25
|
+
if not subrip.is_highlighted(cues):
|
|
26
|
+
return Reading(f".{fmt}", has_words=False, cues=tuple(cues))
|
|
27
|
+
sentences, words = subrip.highlighted(cues)
|
|
28
|
+
source = f"WhisperX --highlight_words .{fmt}"
|
|
29
|
+
return Reading(source, has_words=True, cues=tuple(sentences), words=tuple(words))
|
|
30
|
+
case "lrc":
|
|
31
|
+
return Reading(".lrc", has_words=False, cues=tuple(lrc.rows(_lines(data))))
|
|
32
|
+
case "csv" | "tsv":
|
|
33
|
+
try:
|
|
34
|
+
cues = table.rows(fmt, _text(data))
|
|
35
|
+
except csv.Error as error: # a field past csv's limit (128 KiB): no subtitle's text
|
|
36
|
+
refuse(f"unreadable .{fmt}: {name}: {error}")
|
|
37
|
+
return Reading(f".{fmt}", has_words=False, cues=tuple(cues))
|
|
38
|
+
case _:
|
|
39
|
+
return whisper.read(data, name)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
def _text(data: bytes) -> str:
|
|
43
|
+
"""The bytes as UTF-8 (undecodable bytes kept, as the shell kept them), a BOM off."""
|
|
44
|
+
return data.decode("utf-8", "surrogateescape").removeprefix("\ufeff")
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
def _lines(data: bytes) -> list[str]:
|
|
48
|
+
"""The text's lines, a trailing CR off each (awk sees no record after the last newline)."""
|
|
49
|
+
lines = [line.removesuffix("\r") for line in _text(data).split("\n")]
|
|
50
|
+
if lines and lines[-1] == "":
|
|
51
|
+
_ = lines.pop()
|
|
52
|
+
return lines
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
"""What a reader makes of a field: a number, exactly, or none; a time, in whole milliseconds.
|
|
2
|
+
|
|
3
|
+
One grammar, one rounding, every format: a time is read from its decimal text -- never
|
|
4
|
+
through a float -- and rounded half up to the millisecond. Reading is bounded: a text's
|
|
5
|
+
size or exponent cannot make it slow (``exact``).
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
import re
|
|
9
|
+
import sys
|
|
10
|
+
from fractions import Fraction
|
|
11
|
+
from typing import Final
|
|
12
|
+
|
|
13
|
+
from subverter._values import round_half_up
|
|
14
|
+
|
|
15
|
+
__all__ = ["exact", "json_number", "ms", "number", "prefix", "time_ms"]
|
|
16
|
+
|
|
17
|
+
# a decimal, as jq's tonumber and awk read one: ASCII digits, a sign, a fraction, an exponent,
|
|
18
|
+
# blanks around (Python's float() also takes "1_000", other scripts' digits, "nan" and "inf")
|
|
19
|
+
_DECIMAL: Final = re.compile(
|
|
20
|
+
r"\s*([-+]?)(?:([0-9]+)\.?([0-9]*)|\.([0-9]+))(?:[eE]([-+]?[0-9]+))?\s*", re.ASCII
|
|
21
|
+
)
|
|
22
|
+
_PREFIX: Final = re.compile(
|
|
23
|
+
r"[ \t\n]*[-+]?(?:[0-9]+\.?[0-9]*|\.[0-9]+)(?:[eE][-+]?[0-9]+)?", re.ASCII
|
|
24
|
+
)
|
|
25
|
+
_HIGHEST: Final = 308 # a double's largest power of ten: a first digit above it, no number
|
|
26
|
+
_LOWEST: Final = -400 # under a double's least (5e-324): zero, as a double underflows
|
|
27
|
+
_DIGITS: Final = 400 # significant digits read: more than any rounding of a time here looks at
|
|
28
|
+
_EXPONENT_DIGITS: Final = 6 # an exponent of 10**6 or more is far past either bound
|
|
29
|
+
_LONGEST: Final = Fraction(sys.float_info.max) # a time past a double's range is none
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def exact(text: str) -> Fraction | None:
|
|
33
|
+
"""A decimal text's value -- exactly, for every rounding here -- in bounded work; else None.
|
|
34
|
+
|
|
35
|
+
A first significant digit past 10**308 is no number; one under 10**-400 is zero (as a
|
|
36
|
+
double underflows). The first 400 significant digits are read, and nonzero digits past
|
|
37
|
+
them as one more (a sticky 1): every boundary a time's rounding meets lies far above the
|
|
38
|
+
400th digit, so the value falls on the same side of each as the text's own.
|
|
39
|
+
"""
|
|
40
|
+
match = _DECIMAL.fullmatch(text)
|
|
41
|
+
if match is None:
|
|
42
|
+
return None
|
|
43
|
+
sign, whole, fraction, only, exponent = match.groups()
|
|
44
|
+
integral = whole or ""
|
|
45
|
+
digits = integral + (fraction if whole is not None else only)
|
|
46
|
+
significant = digits.lstrip("0")
|
|
47
|
+
if not significant:
|
|
48
|
+
return Fraction(0)
|
|
49
|
+
if exponent and len(exponent.lstrip("+-").lstrip("0")) > _EXPONENT_DIGITS:
|
|
50
|
+
return Fraction(0) if exponent.startswith("-") else None
|
|
51
|
+
top = len(integral) - (len(digits) - len(significant)) - 1 + int(exponent or 0)
|
|
52
|
+
if top > _HIGHEST:
|
|
53
|
+
return None
|
|
54
|
+
if top < _LOWEST:
|
|
55
|
+
return Fraction(0)
|
|
56
|
+
kept = significant[:_DIGITS]
|
|
57
|
+
if significant[_DIGITS:].strip("0"):
|
|
58
|
+
kept += "1" # sticky: the rest is nonzero, below every boundary a rounding meets
|
|
59
|
+
value = int(kept) * Fraction(10) ** (top - len(kept) + 1)
|
|
60
|
+
return -value if sign == "-" else value
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
def number(value: object) -> Fraction | None:
|
|
64
|
+
"""A JSON number (its fraction read exactly, ``exact``) or a decimal string; else None."""
|
|
65
|
+
if isinstance(value, bool): # a JSON true is no number (Python's bool is an int)
|
|
66
|
+
return None
|
|
67
|
+
if isinstance(value, int | Fraction):
|
|
68
|
+
return Fraction(value)
|
|
69
|
+
if isinstance(value, str):
|
|
70
|
+
return exact(value)
|
|
71
|
+
return None # a float: JSON's NaN, Infinity, or a number past a double -- no number
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
def json_number(text: str) -> Fraction | float:
|
|
75
|
+
"""``json.loads``'s ``parse_float``: the number exactly; past a double, the float JSON gave."""
|
|
76
|
+
found = exact(text)
|
|
77
|
+
return found if found is not None else float(text)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
def prefix(text: str) -> Fraction | None:
|
|
81
|
+
"""A field's leading number, as awk reads it (``$1 + 0``), exactly; 0 if none, None if huge."""
|
|
82
|
+
match = _PREFIX.match(text)
|
|
83
|
+
return exact(match[0]) if match else Fraction(0)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
def ms(value: Fraction | None, per_unit: int) -> int | None:
|
|
87
|
+
"""``value`` (of ``per_unit`` ms each) in whole ms, rounded half up; past a double, none."""
|
|
88
|
+
if value is None:
|
|
89
|
+
return None
|
|
90
|
+
scaled = value * per_unit
|
|
91
|
+
return round_half_up(scaled) if abs(scaled) <= _LONGEST else None
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
def time_ms(value: object, per_unit: int) -> int | None:
|
|
95
|
+
"""A field read as a time (``number``), in whole ms (``ms``); None if it is none."""
|
|
96
|
+
return ms(number(value), per_unit)
|
subverter/readers/lrc.py
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"""LRC: a line's time, its text."""
|
|
2
|
+
|
|
3
|
+
import re
|
|
4
|
+
from typing import Final
|
|
5
|
+
|
|
6
|
+
from subverter.readers.fields import exact, ms
|
|
7
|
+
from subverter.transcript import Cue
|
|
8
|
+
|
|
9
|
+
__all__ = ["rows"]
|
|
10
|
+
|
|
11
|
+
_STAMP: Final = re.compile(r"\[([0-9]+):([0-9]+(?:[.][0-9]+)?)\](.*)") # [mm:ss.xx]text
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
def rows(lines: list[str]) -> list[Cue]:
|
|
15
|
+
"""Starts only: each line ends where the next starts (the last 3 s later)."""
|
|
16
|
+
timed: list[tuple[int, str]] = []
|
|
17
|
+
for line in lines:
|
|
18
|
+
m = _STAMP.fullmatch(line)
|
|
19
|
+
if m is None:
|
|
20
|
+
continue
|
|
21
|
+
minutes, seconds = exact(m[1]), exact(m[2])
|
|
22
|
+
if minutes is None or seconds is None: # past a double's range: no time, no line
|
|
23
|
+
continue
|
|
24
|
+
start = ms(minutes * 60 + seconds, 1000)
|
|
25
|
+
if start is not None:
|
|
26
|
+
timed.append((start, m[3]))
|
|
27
|
+
timed.sort(key=lambda t: t[0]) # stable, as sort -s
|
|
28
|
+
ends = [t[0] for t in timed[1:]] + ([timed[-1][0] + 3000] if timed else [])
|
|
29
|
+
return [Cue(s, e, t) for (s, t), e in zip(timed, ends, strict=True)]
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
"""SubRip and WebVTT: cues; WhisperX's highlighted cues, read back into words."""
|
|
2
|
+
|
|
3
|
+
import re
|
|
4
|
+
from fractions import Fraction
|
|
5
|
+
from typing import Final
|
|
6
|
+
|
|
7
|
+
from subverter.markup import untagged
|
|
8
|
+
from subverter.readers.fields import ms, prefix
|
|
9
|
+
from subverter.transcript import Cue, Timing
|
|
10
|
+
|
|
11
|
+
__all__ = ["highlighted", "is_highlighted", "rows"]
|
|
12
|
+
|
|
13
|
+
_ARROW: Final = re.compile(r"[ \t]*-->[ \t]*") # a cue's times, either side
|
|
14
|
+
_BLANKS: Final = re.compile(r"[ \t]") # after the end time: its settings (WebVTT)
|
|
15
|
+
_BLANK_LINE: Final = re.compile(r"[ \t]*") # a cue's end
|
|
16
|
+
_UNDERLINE: Final = re.compile(r"<u>([^<]*)</u>") # WhisperX --highlight_words: the word
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def _time(text: str) -> int | None:
|
|
20
|
+
"""subs_srt_vtt's ms(): HH:MM:SS,mmm or MM:SS.mmm, each part as awk read it, exactly."""
|
|
21
|
+
parts = text.replace(",", ".").split(":")
|
|
22
|
+
if len(parts) == 3: # noqa: PLR2004 -- hours, minutes, seconds
|
|
23
|
+
h, m, s = (prefix(p) for p in parts)
|
|
24
|
+
else:
|
|
25
|
+
h, m, s = Fraction(0), prefix(parts[0]), prefix(parts[1] if len(parts) > 1 else "")
|
|
26
|
+
if h is None or m is None or s is None: # a part past a double's range: no time
|
|
27
|
+
return None
|
|
28
|
+
return ms(h * 3600 + m * 60 + s, 1000)
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
def rows(lines: list[str]) -> list[Cue]:
|
|
32
|
+
"""Cues, their text kept with its tags (a WhisperX <u> marks a word).
|
|
33
|
+
|
|
34
|
+
A cue opens at its "-->" line and closes at a blank line, or at the next cue
|
|
35
|
+
(bash's intext and its set st, which always changed together).
|
|
36
|
+
"""
|
|
37
|
+
found: list[Cue] = []
|
|
38
|
+
cue: tuple[int | None, int | None] | None = None
|
|
39
|
+
text = ""
|
|
40
|
+
for line in lines:
|
|
41
|
+
if "-->" in line:
|
|
42
|
+
if cue is not None:
|
|
43
|
+
found.append(Cue(*cue, text))
|
|
44
|
+
left, right = _ARROW.split(line, maxsplit=1)
|
|
45
|
+
cue, text = (_time(left), _time(_BLANKS.split(right)[0])), ""
|
|
46
|
+
elif cue is not None and _BLANK_LINE.fullmatch(line):
|
|
47
|
+
found.append(Cue(*cue, text))
|
|
48
|
+
cue, text = None, ""
|
|
49
|
+
elif cue is not None:
|
|
50
|
+
text = f"{text} {line}" if text else line
|
|
51
|
+
if cue is not None:
|
|
52
|
+
found.append(Cue(*cue, text))
|
|
53
|
+
return found
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
def is_highlighted(cues: list[Cue]) -> bool:
|
|
57
|
+
"""WhisperX --highlight_words, by structure: <u> somewhere, most neighbours one text."""
|
|
58
|
+
plains = [untagged(c.text) for c in cues]
|
|
59
|
+
underlined = any("<u>" in c.text for c in cues)
|
|
60
|
+
same = sum(1 for i in range(1, len(plains)) if plains[i] == plains[i - 1])
|
|
61
|
+
return underlined and len(cues) > 1 and same / (len(cues) - 1) >= 0.5 # noqa: PLR2004 -- most
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
def highlighted(cues: list[Cue]) -> tuple[list[Cue], list[Timing]]:
|
|
65
|
+
"""One sentence a run of one text (new when the underline moves back); each <u> a word."""
|
|
66
|
+
sentences: list[Cue] = []
|
|
67
|
+
words: list[Timing] = []
|
|
68
|
+
current, cs, ce, last, sid = "", None, None, -1, -1
|
|
69
|
+
for cue in cues:
|
|
70
|
+
plain = untagged(cue.text)
|
|
71
|
+
underline = _UNDERLINE.search(cue.text)
|
|
72
|
+
offset = len(untagged(cue.text[: underline.start()])) if underline else -1
|
|
73
|
+
if plain != current or (underline and offset <= last):
|
|
74
|
+
if current:
|
|
75
|
+
sentences.append(Cue(cs, ce, current, str(sid)))
|
|
76
|
+
sid, current, cs, last = sid + 1, plain, cue.start, -1
|
|
77
|
+
ce = cue.end
|
|
78
|
+
if underline:
|
|
79
|
+
words.append(Timing(str(sid), cue.start, cue.end, underline[1]))
|
|
80
|
+
last = offset
|
|
81
|
+
if current:
|
|
82
|
+
sentences.append(Cue(cs, ce, current, str(sid)))
|
|
83
|
+
return sentences, words
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"""CSV and TSV, as whisper-cli and WhisperX write them: start, end, text (ms), columns by header.
|
|
2
|
+
|
|
3
|
+
A header is a first record naming start and end, in any order (bash: one starting with
|
|
4
|
+
start); without one, the columns are start, end, text.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import csv
|
|
8
|
+
import io
|
|
9
|
+
|
|
10
|
+
from subverter.readers.fields import time_ms
|
|
11
|
+
from subverter.transcript import Cue
|
|
12
|
+
|
|
13
|
+
__all__ = ["rows"]
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
def rows(kind: str, text: str) -> list[Cue]:
|
|
17
|
+
"""whisper-cli .csv (RFC 4180 quoting) or WhisperX .tsv (tabs, none); a time read, or none."""
|
|
18
|
+
lines = io.StringIO(text, newline="")
|
|
19
|
+
records = (
|
|
20
|
+
csv.reader(lines, delimiter="\t", quoting=csv.QUOTE_NONE)
|
|
21
|
+
if kind == "tsv"
|
|
22
|
+
else csv.reader(lines)
|
|
23
|
+
)
|
|
24
|
+
si, ei, ti = 1, 2, 3
|
|
25
|
+
found: list[Cue] = []
|
|
26
|
+
for n, fields in enumerate(records):
|
|
27
|
+
names = [f.lower() for f in fields] if n == 0 else []
|
|
28
|
+
if "start" in names and "end" in names: # a header: its columns, any order (the last named)
|
|
29
|
+
for i, name in enumerate(names, 1):
|
|
30
|
+
si = i if name == "start" else si
|
|
31
|
+
ei = i if name == "end" else ei
|
|
32
|
+
ti = i if name == "text" else ti
|
|
33
|
+
continue
|
|
34
|
+
if fields and len(fields) >= ti:
|
|
35
|
+
found.append(
|
|
36
|
+
Cue(time_ms(fields[si - 1], 1), time_ms(fields[ei - 1], 1), fields[ti - 1])
|
|
37
|
+
)
|
|
38
|
+
return found
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
"""whisper-cli's and WhisperX's JSON: chunks and word timings, their values as they are typed.
|
|
2
|
+
|
|
3
|
+
A time is a number (fields.number: a JSON number, or a decimal string); any other value
|
|
4
|
+
is no time. A text is the JSON string, or a non-string written as JSON (jq's tostring).
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import json
|
|
8
|
+
from dataclasses import dataclass
|
|
9
|
+
from fractions import Fraction
|
|
10
|
+
from typing import Final, cast
|
|
11
|
+
|
|
12
|
+
from subverter._errors import refuse
|
|
13
|
+
from subverter.readers.fields import json_number, ms, number, time_ms
|
|
14
|
+
from subverter.transcript import Cue, Reading, Timing
|
|
15
|
+
|
|
16
|
+
__all__ = ["read"]
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def read(data: bytes, name: str) -> Reading:
|
|
20
|
+
"""A whisper JSON's source name, word timings or not, its cues, its words, its notes."""
|
|
21
|
+
try:
|
|
22
|
+
root = cast("object", json.loads(data, parse_float=json_number)) # exact, bounded
|
|
23
|
+
except ValueError:
|
|
24
|
+
refuse(f"not valid JSON: {name}")
|
|
25
|
+
except RecursionError: # past Python's recursion limit: no transcript nests so
|
|
26
|
+
refuse(f"JSON nested too deeply to be a transcript: {name}")
|
|
27
|
+
doc = _obj(root)
|
|
28
|
+
if isinstance(doc.get("transcription"), list):
|
|
29
|
+
return _whisper_cli(doc, name)
|
|
30
|
+
if not isinstance(doc.get("segments"), list):
|
|
31
|
+
kinds = "a whisper-cli (.transcription) or WhisperX (.segments) JSON transcript"
|
|
32
|
+
refuse(f"not {kinds}: {name}")
|
|
33
|
+
cues, words = _whisperx(doc)
|
|
34
|
+
return Reading("WhisperX JSON", has_words=bool(words), cues=cues, words=words)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
def _obj(value: object) -> dict[str, object]:
|
|
38
|
+
"""``value`` if an object, else an empty one: a missing key and a wrong type alike."""
|
|
39
|
+
return cast("dict[str, object]", value) if isinstance(value, dict) else {}
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
def _list(value: object) -> list[object]:
|
|
43
|
+
return cast("list[object]", value) if isinstance(value, list) else []
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
def _text(value: object) -> str:
|
|
47
|
+
"""``.text // "" | tostring``: a string as is, null or false nothing, else its JSON."""
|
|
48
|
+
if value is None or value is False:
|
|
49
|
+
return ""
|
|
50
|
+
if isinstance(value, str):
|
|
51
|
+
return value
|
|
52
|
+
return json.dumps(value, separators=(",", ":"), ensure_ascii=False, default=float)
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
# whisper-cli: .transcription[] -- offsets in ms; with -ojf, its tokens (and their DTW times)
|
|
56
|
+
|
|
57
|
+
# the languages written without spaces between words: every token a word
|
|
58
|
+
_NO_SPACES: Final = frozenset({"zh", "yue", "ja", "th", "lo", "km", "my"})
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
def _whisper_cli(doc: dict[str, object], name: str) -> Reading:
|
|
62
|
+
entries = _list(doc["transcription"])
|
|
63
|
+
found: list[Cue] = []
|
|
64
|
+
for key, entry in enumerate(entries):
|
|
65
|
+
e = _obj(entry)
|
|
66
|
+
offsets = _obj(e.get("offsets"))
|
|
67
|
+
found.append(
|
|
68
|
+
Cue(
|
|
69
|
+
time_ms(offsets.get("from"), 1),
|
|
70
|
+
time_ms(offsets.get("to"), 1),
|
|
71
|
+
_text(e.get("text")),
|
|
72
|
+
str(key),
|
|
73
|
+
)
|
|
74
|
+
)
|
|
75
|
+
cues = tuple(found)
|
|
76
|
+
if not any(isinstance(e, dict) and "tokens" in e for e in entries):
|
|
77
|
+
return Reading("whisper-cli JSON", has_words=False, cues=cues)
|
|
78
|
+
language = _text(_obj(doc.get("result")).get("language"))
|
|
79
|
+
words, fallback, timed = _tokens(entries, no_spaces=language in _NO_SPACES, name=name)
|
|
80
|
+
notes: tuple[str, ...] = ()
|
|
81
|
+
if fallback:
|
|
82
|
+
where = f"outside their sentence or not in order in {fallback} of {timed} sentences"
|
|
83
|
+
notes = (f"DTW word times were {where}: used token offsets there",)
|
|
84
|
+
return Reading("whisper-cli -ojf JSON", has_words=True, cues=cues, words=words, notes=notes)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
def _tokens(
|
|
88
|
+
entries: list[object], *, no_spaces: bool, name: str
|
|
89
|
+
) -> tuple[tuple[Timing, ...], int, int]:
|
|
90
|
+
"""Words from tokens, timed by DTW where its times sit in order inside their sentence."""
|
|
91
|
+
words: list[Timing] = []
|
|
92
|
+
fallback: set[int] = set()
|
|
93
|
+
timed: set[int] = set()
|
|
94
|
+
for key, entry in enumerate(entries):
|
|
95
|
+
e = _obj(entry)
|
|
96
|
+
offsets = _obj(e.get("offsets"))
|
|
97
|
+
a, z = time_ms(offsets.get("from"), 1), time_ms(offsets.get("to"), 1)
|
|
98
|
+
ws = _token_words(e.get("tokens"), no_spaces=no_spaces, name=name)
|
|
99
|
+
# t_dtw: in 10 ms units
|
|
100
|
+
dtws = [ms(w.dtw, 10) if w.dtw is not None and w.dtw >= 0 else None for w in ws]
|
|
101
|
+
has = bool(dtws) and all(t is not None for t in dtws)
|
|
102
|
+
times = [t for t in dtws if t is not None] if has else []
|
|
103
|
+
inside = has and a is not None and z is not None and all(a <= t < z for t in times)
|
|
104
|
+
dtw_ok = inside and all(times[i] > times[i - 1] for i in range(1, len(times)))
|
|
105
|
+
for k, w in enumerate(ws):
|
|
106
|
+
if dtw_ok:
|
|
107
|
+
words.append(
|
|
108
|
+
Timing(str(key), times[k], times[k + 1] if k + 1 < len(ws) else z, w.text)
|
|
109
|
+
)
|
|
110
|
+
else:
|
|
111
|
+
words.append(Timing(str(key), w.start, w.end, w.text))
|
|
112
|
+
if ws and has:
|
|
113
|
+
timed.add(key)
|
|
114
|
+
if not dtw_ok:
|
|
115
|
+
fallback.add(key)
|
|
116
|
+
return tuple(words), len(fallback), len(timed)
|
|
117
|
+
|
|
118
|
+
|
|
119
|
+
@dataclass(slots=True)
|
|
120
|
+
class _Word:
|
|
121
|
+
"""A word gathered from its tokens: its text, its token offsets, its first token's DTW time."""
|
|
122
|
+
|
|
123
|
+
text: str
|
|
124
|
+
start: int | None
|
|
125
|
+
end: int | None
|
|
126
|
+
dtw: Fraction | None
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
def _token_words(tokens: object, *, no_spaces: bool, name: str) -> list[_Word]:
|
|
130
|
+
"""A sentence's words from its tokens: a leading space starts one ([_...] tokens dropped)."""
|
|
131
|
+
ws: list[_Word] = []
|
|
132
|
+
for token in _list(tokens):
|
|
133
|
+
if not isinstance(token, dict):
|
|
134
|
+
continue
|
|
135
|
+
t = cast("dict[str, object]", token)
|
|
136
|
+
text = t.get("text")
|
|
137
|
+
if _text(text).startswith("[_"):
|
|
138
|
+
continue
|
|
139
|
+
if not isinstance(text, str): # malformed: bash's jq stopped here, "unreadable"
|
|
140
|
+
refuse(f"unreadable whisper-cli -ojf JSON: {name}")
|
|
141
|
+
span = _obj(t.get("offsets"))
|
|
142
|
+
if not ws or text.startswith(" ") or no_spaces:
|
|
143
|
+
dtw = t.get("t_dtw")
|
|
144
|
+
ws.append(
|
|
145
|
+
_Word(
|
|
146
|
+
text,
|
|
147
|
+
time_ms(span.get("from"), 1),
|
|
148
|
+
time_ms(span.get("to"), 1),
|
|
149
|
+
number(dtw),
|
|
150
|
+
)
|
|
151
|
+
)
|
|
152
|
+
else:
|
|
153
|
+
ws[-1].text += text
|
|
154
|
+
ws[-1].end = time_ms(span.get("to"), 1)
|
|
155
|
+
return ws
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
# WhisperX: .segments[] -- seconds; their words, each its own
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
def _whisperx(doc: dict[str, object]) -> tuple[tuple[Cue, ...], tuple[Timing, ...]]:
|
|
162
|
+
cues: list[Cue] = []
|
|
163
|
+
words: list[Timing] = []
|
|
164
|
+
for key, segment in enumerate(_list(doc["segments"])):
|
|
165
|
+
s = _obj(segment)
|
|
166
|
+
cues.append(
|
|
167
|
+
Cue(
|
|
168
|
+
time_ms(s.get("start"), 1000),
|
|
169
|
+
time_ms(s.get("end"), 1000),
|
|
170
|
+
_text(s.get("text")),
|
|
171
|
+
str(key),
|
|
172
|
+
)
|
|
173
|
+
)
|
|
174
|
+
for word in _list(s.get("words")):
|
|
175
|
+
if isinstance(word, dict):
|
|
176
|
+
w = cast("dict[str, object]", word)
|
|
177
|
+
words.append(
|
|
178
|
+
Timing(
|
|
179
|
+
str(key),
|
|
180
|
+
time_ms(w.get("start"), 1000),
|
|
181
|
+
time_ms(w.get("end"), 1000),
|
|
182
|
+
_text(w.get("word")),
|
|
183
|
+
)
|
|
184
|
+
)
|
|
185
|
+
return tuple(cues), tuple(words)
|
subverter/transcript.py
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
"""A transcript, as ffman reads one: its chunks and words, and what its readers found."""
|
|
2
|
+
|
|
3
|
+
from dataclasses import dataclass
|
|
4
|
+
|
|
5
|
+
__all__ = ["Chunk", "Cue", "Reading", "Timing", "Transcript", "Word"]
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
@dataclass(frozen=True, slots=True)
|
|
9
|
+
class Chunk:
|
|
10
|
+
"""A timed piece of text, its times in milliseconds (bash's chunks.tsv)."""
|
|
11
|
+
|
|
12
|
+
start: int
|
|
13
|
+
end: int
|
|
14
|
+
text: str
|
|
15
|
+
segment: str
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
@dataclass(frozen=True, slots=True)
|
|
19
|
+
class Word:
|
|
20
|
+
"""A timed word of a chunk, its times in milliseconds (bash's words.tsv)."""
|
|
21
|
+
|
|
22
|
+
segment: str
|
|
23
|
+
start: int
|
|
24
|
+
end: int
|
|
25
|
+
text: str
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
@dataclass(frozen=True, slots=True)
|
|
29
|
+
class Transcript:
|
|
30
|
+
"""What ingesting found: the format, its source's name, the chunks, the words, the notes."""
|
|
31
|
+
|
|
32
|
+
fmt: str # bash's SUBFMT: the extension
|
|
33
|
+
source: str # bash's SUBSRC: the source's name, in messages
|
|
34
|
+
has_words: bool # bash's HAS_WORDS: the source times words
|
|
35
|
+
chunks: tuple[Chunk, ...]
|
|
36
|
+
words: tuple[Word, ...]
|
|
37
|
+
notes: tuple[str, ...]
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
@dataclass(frozen=True, slots=True)
|
|
41
|
+
class Cue:
|
|
42
|
+
"""A timed text as its reader found it: whole ms (None: no time read), its markup kept."""
|
|
43
|
+
|
|
44
|
+
start: int | None
|
|
45
|
+
end: int | None
|
|
46
|
+
text: str
|
|
47
|
+
segment: str = "" # the sentence its words name, where words are timed
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
@dataclass(frozen=True, slots=True)
|
|
51
|
+
class Timing:
|
|
52
|
+
"""A word as its reader found it: its sentence, whole ms (None: no time read), its text."""
|
|
53
|
+
|
|
54
|
+
segment: str
|
|
55
|
+
start: int | None
|
|
56
|
+
end: int | None
|
|
57
|
+
text: str
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
@dataclass(frozen=True, slots=True)
|
|
61
|
+
class Reading:
|
|
62
|
+
"""A reader's answer: its source's name, word timings or not, its cues, words and notes."""
|
|
63
|
+
|
|
64
|
+
source: str
|
|
65
|
+
has_words: bool
|
|
66
|
+
cues: tuple[Cue, ...]
|
|
67
|
+
words: tuple[Timing, ...] = ()
|
|
68
|
+
notes: tuple[str, ...] = ()
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: subverter
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Subtitle and transcript readers -- SubRip, WebVTT, LRC, CSV, TSV, whisper's JSON -- into one model
|
|
5
|
+
Project-URL: Changelog, https://github.com/veramachine/ffsuite/blob/main/packages/subverter/CHANGELOG.md
|
|
6
|
+
Project-URL: Homepage, https://github.com/veramachine/ffsuite/tree/main/packages/subverter
|
|
7
|
+
Project-URL: Issues, https://github.com/veramachine/ffsuite/issues
|
|
8
|
+
Project-URL: Repository, https://github.com/veramachine/ffsuite
|
|
9
|
+
Author-email: VERA LVX <veralvx@veralvx.com>
|
|
10
|
+
Maintainer-email: VERA LVX <veralvx@veralvx.com>
|
|
11
|
+
License-Expression: MIT OR Apache-2.0
|
|
12
|
+
License-File: LICENSE-APACHE
|
|
13
|
+
License-File: LICENSE-MIT
|
|
14
|
+
Keywords: captions,lrc,srt,subtitles,transcript,vtt,webvtt,whisper,whisperx
|
|
15
|
+
Classifier: Development Status :: 4 - Beta
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Natural Language :: English
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
23
|
+
Classifier: Topic :: Multimedia :: Video
|
|
24
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
25
|
+
Classifier: Topic :: Text Processing
|
|
26
|
+
Classifier: Typing :: Typed
|
|
27
|
+
Requires-Python: >=3.13
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# subverter
|
|
31
|
+
|
|
32
|
+
Subtitle and transcript readers into one model: SubRip, WebVTT, LRC, CSV and
|
|
33
|
+
TSV, and whisper-cli's and WhisperX's JSON.
|
|
34
|
+
|
|
35
|
+
A file read becomes what it holds: its cues, the word timings where the format
|
|
36
|
+
keeps them, notes on what it held that the model does not, and a refusal --
|
|
37
|
+
with its reason -- for what cannot be read.
|
|
38
|
+
|
|
39
|
+
| Format | Read as |
|
|
40
|
+
| ------- | ------------------------------------------------------------------------------------------ |
|
|
41
|
+
| SubRip | cues; WhisperX's highlighted cues read back into words |
|
|
42
|
+
| WebVTT | cues, as SubRip's |
|
|
43
|
+
| LRC | a line's time, its text |
|
|
44
|
+
| CSV/TSV | start, end, text (milliseconds), columns by header, as whisper-cli and WhisperX write them |
|
|
45
|
+
| JSON | whisper-cli's and WhisperX's: chunks and word timings |
|
|
46
|
+
|
|
47
|
+
## Installing
|
|
48
|
+
|
|
49
|
+
```sh
|
|
50
|
+
pip install subverter
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Python 3.13 or later; the standard library alone.
|
|
54
|
+
|
|
55
|
+
## Using it
|
|
56
|
+
|
|
57
|
+
```pycon
|
|
58
|
+
>>> import subverter
|
|
59
|
+
>>> reading = subverter.read("srt", b"1\n00:00:01,000 --> 00:00:02,500\nHello <i>there</i>\n", "talk.srt")
|
|
60
|
+
>>> reading.cues
|
|
61
|
+
(Cue(start=1000, end=2500, text='Hello <i>there</i>', segment=''),)
|
|
62
|
+
>>> subverter.untagged(reading.cues[0].text)
|
|
63
|
+
'Hello there'
|
|
64
|
+
>>> subverter.read("json", b"[1, 2]", "talk.json")
|
|
65
|
+
Traceback (most recent call last):
|
|
66
|
+
...
|
|
67
|
+
subverter.Error: not a whisper-cli (.transcription) or WhisperX (.segments) JSON transcript: talk.json
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
Times are milliseconds. A text that cannot be read is refused:
|
|
71
|
+
`subverter.Error`, its message the reason.
|
|
72
|
+
|
|
73
|
+
## Licence
|
|
74
|
+
|
|
75
|
+
Part of [ffsuite](https://github.com/veramachine/ffsuite), beside ffman: its own package.
|
|
76
|
+
Licensed under either of
|
|
77
|
+
[MIT](https://github.com/veramachine/ffsuite/blob/main/packages/subverter/LICENSE-MIT)
|
|
78
|
+
or [Apache-2.0](https://github.com/veramachine/ffsuite/blob/main/packages/subverter/LICENSE-APACHE),
|
|
79
|
+
at your option.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
subverter/__init__.py,sha256=b0HGXO6X_dCalYtm9NPneK2ZrgoDF3suqhvYQYKnMQM,642
|
|
2
|
+
subverter/_errors.py,sha256=dRTkcb0lcRvYMKREet_2DnOJZjf0dlhPl-EacTrXF2M,321
|
|
3
|
+
subverter/_values.py,sha256=JRwwhXXYAfVenLESY6NWzM_QfLKQA3rDUD8WtgziG10,313
|
|
4
|
+
subverter/markup.py,sha256=lPoEWhUx3kx8DMujeME6yX6Iasnn1u-piWC6hDxB2sw,325
|
|
5
|
+
subverter/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
6
|
+
subverter/transcript.py,sha256=XYwGpFJny_XajiOYpmy--b5_0Ou4Pr8KTt_yeJMlO5g,1769
|
|
7
|
+
subverter/readers/__init__.py,sha256=t-1irxFjUvDTQcuEWrQ04xCvwB0zJNFWn1lN7Zhkn20,2240
|
|
8
|
+
subverter/readers/fields.py,sha256=lwd53DXHup1BvS7j-_rDhhe4Th8qswM98ftiluJcTN4,4215
|
|
9
|
+
subverter/readers/lrc.py,sha256=JhGVn4ocUNSJHMGfUZNzPbpEr5x4q8tMZotA5ZbAKnc,1023
|
|
10
|
+
subverter/readers/subrip.py,sha256=fV499tWP-jYYBMDImsiFAsC3QNVOqHoCFcYrWOcEhaY,3457
|
|
11
|
+
subverter/readers/table.py,sha256=K3Zvb8MR_ASRGmFd1LpfpQiQL0o-e3Q-Zq7KuHIBOPQ,1363
|
|
12
|
+
subverter/readers/whisper.py,sha256=BK-wxxUcb24E0_eCyDEK7PaNAYdKxl5OAyibnIUnr-g,7116
|
|
13
|
+
subverter-0.1.0.dist-info/METADATA,sha256=pOdrwuzZflWNUV0HnsoIqmTlN85kGaHKRt0jpitCh88,3477
|
|
14
|
+
subverter-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
|
|
15
|
+
subverter-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
|
|
16
|
+
subverter-0.1.0.dist-info/licenses/LICENSE-MIT,sha256=u5n8W7sr5yYLX-wgv86t74HbbnxW0Ty-62zKt_4jeHI,1064
|
|
17
|
+
subverter-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 veralvx
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
|
6
|
+
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
|
7
|
+
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
8
|
+
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
|
9
|
+
following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial
|
|
12
|
+
portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
|
15
|
+
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
|
16
|
+
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
17
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
18
|
+
USE OR OTHER DEALINGS IN THE SOFTWARE.
|