vtskit 0.2.0__tar.gz → 0.3.0__tar.gz

{vtskit-0.2.0/vtskit.egg-info → vtskit-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vtskit
-Version: 0.2.0
+Version: 0.3.0
 Summary: DVD-Video titlesets in pure Python: VOBs, navigation packs and IFO files
 Author: kajisho5
 License-Expression: LGPL-3.0-or-later
@@ -146,10 +146,13 @@ oncemore writing its discs with vtskit.
   to an end, the buttons, the palette entries that draw them): their
   overlay is a forced subpicture added with `vtskit.subtitles`, and the
   highlight information goes only into the VOBUs that play during the
-  stretch, with the stretch's start and end as its start time, end time
+  stretch (where two stretches meet inside a VOBU, the one covering more
+  of it), with the stretch's start and end as its start time, end time
   and the end of the selection (dvdinfo's hli_s_ptm, hli_e_ptm,
   btn_sl_e_ptm). dvdauthor gives a title's buttons the whole title (every
-  VOBU, never ending), which is what buttons without an end write.
+  VOBU, never ending), which is what buttons without an end write. As
+  dvdauthor does, a title with buttons starts with its first button
+  highlighted (SetHL_BTNN 1 before its own pre commands).
 * `vtskit.subtitles` adds subtitles to a title's program stream, as spumux
   does: each cue a picture of up to four colours placed on the screen and
   shown for a while, as subpicture packs a little before their time.
@@ -157,8 +160,8 @@ oncemore writing its discs with vtskit.
   `if (g5 != 0) { button = g5; }`, `call menu entry root;`) for the domain
   a text runs in, to the same commands dvdauthor writes for it: a tool
   that already speaks the language, as oncemore does, keeps its text. A
-  button of several commands runs them from the menu's post through a
-  dispatcher, and a jump to a chapter of another titleset goes through pad
+  button of several commands, a menu's or a title's, runs them from the
+  program chain's post through a dispatcher, and a jump to a chapter of another titleset goes through pad
   program chains, as dvdauthor's "jumppads" do.
 * `vtskit.vmg` writes the video manager: VIDEO_TS.IFO and its BUP, with
   the first-play commands, the table of titles and the titlesets'
@@ -190,8 +193,9 @@ dvdauthor's (its buttons made with spumux), and a menu's overlay in a
 normal colour is spumux's unit byte for byte; subtitles muxed by vtskit are
 spumux's units, placed where spumux places them, and the title written
 from that stream (4:3, and 16:9 with and without pan-scan or letterbox) is
-dvdauthor's; a title with buttons over the whole of it is dvdauthor's
-VOB byte for byte. A VIDEO_TS written by vtskit alone plays
+dvdauthor's; a title with buttons over the whole of it (one of them of
+several commands) is dvdauthor's VOB and IFO byte for byte, but for the
+palette. A VIDEO_TS written by vtskit alone plays
 its titles and chapters in order under libdvdnav, its commands jumping
 between titles, its menus' buttons lead where they say, and its jumps into
 another titleset's chapters land; a title with an angle block plays and

{vtskit-0.2.0 → vtskit-0.3.0}/README.md

@@ -129,10 +129,13 @@ oncemore writing its discs with vtskit.
   to an end, the buttons, the palette entries that draw them): their
   overlay is a forced subpicture added with `vtskit.subtitles`, and the
   highlight information goes only into the VOBUs that play during the
-  stretch, with the stretch's start and end as its start time, end time
+  stretch (where two stretches meet inside a VOBU, the one covering more
+  of it), with the stretch's start and end as its start time, end time
   and the end of the selection (dvdinfo's hli_s_ptm, hli_e_ptm,
   btn_sl_e_ptm). dvdauthor gives a title's buttons the whole title (every
-  VOBU, never ending), which is what buttons without an end write.
+  VOBU, never ending), which is what buttons without an end write. As
+  dvdauthor does, a title with buttons starts with its first button
+  highlighted (SetHL_BTNN 1 before its own pre commands).
 * `vtskit.subtitles` adds subtitles to a title's program stream, as spumux
   does: each cue a picture of up to four colours placed on the screen and
   shown for a while, as subpicture packs a little before their time.
@@ -140,8 +143,8 @@ oncemore writing its discs with vtskit.
   `if (g5 != 0) { button = g5; }`, `call menu entry root;`) for the domain
   a text runs in, to the same commands dvdauthor writes for it: a tool
   that already speaks the language, as oncemore does, keeps its text. A
-  button of several commands runs them from the menu's post through a
-  dispatcher, and a jump to a chapter of another titleset goes through pad
+  button of several commands, a menu's or a title's, runs them from the
+  program chain's post through a dispatcher, and a jump to a chapter of another titleset goes through pad
   program chains, as dvdauthor's "jumppads" do.
 * `vtskit.vmg` writes the video manager: VIDEO_TS.IFO and its BUP, with
   the first-play commands, the table of titles and the titlesets'
@@ -173,8 +176,9 @@ dvdauthor's (its buttons made with spumux), and a menu's overlay in a
 normal colour is spumux's unit byte for byte; subtitles muxed by vtskit are
 spumux's units, placed where spumux places them, and the title written
 from that stream (4:3, and 16:9 with and without pan-scan or letterbox) is
-dvdauthor's; a title with buttons over the whole of it is dvdauthor's
-VOB byte for byte. A VIDEO_TS written by vtskit alone plays
+dvdauthor's; a title with buttons over the whole of it (one of them of
+several commands) is dvdauthor's VOB and IFO byte for byte, but for the
+palette. A VIDEO_TS written by vtskit alone plays
 its titles and chapters in order under libdvdnav, its commands jumping
 between titles, its menus' buttons lead where they say, and its jumps into
 another titleset's chapters land; a title with an angle block plays and

{vtskit-0.2.0 → vtskit-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "vtskit"
-version = "0.2.0"
+version = "0.3.0"
 description = "DVD-Video titlesets in pure Python: VOBs, navigation packs and IFO files"
 readme = "README.md"
 license = "LGPL-3.0-or-later"

{vtskit-0.2.0 → vtskit-0.3.0}/tests/test_lang.py

@@ -138,6 +138,17 @@ class TestForms(unittest.TestCase):
         self.assertEqual(hexes(self.d.compile("g1 = 0; exit;", "vts", 1)), ["7100000100000000", "3001000000000000"])
         self.assertEqual(hexes(self.d.compile("call menu entry root resume 3;", "vts", 1)), ["3008000003830000"])
 
+    def test_title_buttons(self):
+        # dvdauthor's bytes for the same buttons in a title's <pgc>, with
+        # <post>jump title 2;</post>: the same dispatcher as a menu's
+        buttons, post = self.d.menu(["g1 = 2; g2 = 3; jump title 2 chapter 1;", "g3 = 4; g4 = 5; jump title 2;"],
+                                    "jump title 2;", "vts", 1)
+        self.assertEqual(hexes(buttons), ["7101000f0001000d", "7101000f0002000d"])
+        self.assertEqual(hexes(post), ["6100000e000f0000", "7100000f00000000", "00a1000e00010006",
+                                       "00a1000e00020009", "3003000000020000", "7100000100020000",
+                                       "7100000200030000", "3005000100020000", "7100000300040000",
+                                       "7100000400050000", "3003000000020000"])
+
     def test_dead_code_after_a_jump(self):
         self.assertEqual(hexes(self.d.compile("g1 = 0; resume; g1 = 0; jump title 1 chapter 2; "
                                               "subtitle = 65; audio = 1;", "vtsm", 1)),
@@ -191,7 +202,7 @@ class TestForms(unittest.TestCase):
         with self.assertRaises(VtsError):
             self.d.menu(["g1 = 1; g2 = 2;"], "g3 = 3;", "vtsm", 1)   # post that does not leave
         with self.assertRaises(VtsError):
-            self.d.menu(["exit;"], "exit;", "vts", 1)
+            self.d.menu(["exit;"], "exit;", "fp")                   # no buttons in the first play
 
 
 def author(folder, menu_n, menu_h, a, b):

{vtskit-0.2.0 → vtskit-0.3.0}/tests/test_title_buttons.py

@@ -13,7 +13,7 @@ import sys
 import tempfile
 import unittest
 
-from vtskit import VtsError, menu, ps, spu, subtitles, titleset, vm, vmg
+from vtskit import VtsError, lang, menu, ps, spu, subtitles, titleset, vm, vmg
 from vtskit.menu import Button, TitleButtons
 from vtskit.titleset import Audio, Title
 
@@ -104,7 +104,7 @@ class TestTitleButtons(unittest.TestCase):
     def test_whole_title_as_dvdauthor(self):
         # spumux's buttons over the whole title, then dvdauthor; vtskit
         # given the same stream and buttons without an end writes the same
-        # VOB (dvdauthor writes the HLI in every VOBU, never ending)
+        # VOB (dvdauthor writes the HLI in every VOBU, never ending) and IFO
         t = self.tmp
         png(f"{t}/hl.png", 720, 480, RECTS, (255, 255, 0))
         png(f"{t}/sel.png", 720, 480, RECTS, (255, 0, 0))
@@ -118,17 +118,35 @@ class TestTitleButtons(unittest.TestCase):
         with open(self.plain, "rb") as src, open(sp, "wb") as dst:
             subprocess.run(["spumux", "-s", "0", f"{t}/spu.xml"], stdin=src, stdout=dst, check=True,
                            stderr=subprocess.DEVNULL, env=ENV)
+        texts = ["g1 = 2; g2 = 3; jump title 2 chapter 1;", "exit;"]
         with open(f"{t}/dvd.xml", "w") as f:
             f.write(f'<dvdauthor dest="{t}/dvd"><vmgm/><titleset><titles>'
                     '<video format="ntsc" aspect="4:3"/><audio format="ac3" channels="2" lang="en"/>'
-                    f'<pgc><vob file="{sp}"/><button name="b1">jump title 1 chapter 1;</button>'
-                    '<button name="b2">exit;</button></pgc></titles></titleset></dvdauthor>')
+                    f'<pgc><vob file="{sp}"/><button name="b1">{texts[0]}</button>'
+                    f'<button name="b2">{texts[1]}</button><post>jump title 2;</post></pgc>'
+                    f'<pgc><vob file="{self.short}"/></pgc></titles></titleset></dvdauthor>')
         subprocess.run(["dvdauthor", "-x", f"{t}/dvd.xml"], check=True, capture_output=True, env=ENV)
+        # vtskit: the same buttons compiled with vtskit.lang (a button of
+        # several commands runs them from the post, through a dispatcher)
+        disc = lang.Disc({(1, 1): 1, (1, 2): 2}, titlesets={1: lang.Menus()})
+        commands, post = disc.menu(texts, "jump title 2;", "vts", 1)
+        tb = buttons(0, None)
+        for b, c in zip(tb.buttons, commands):
+            b.command = c
         mine = f"{t}/mine-whole"
-        titleset.write(mine, 1, [Title(sp, audio=(Audio("en", 2),), buttons=(buttons(0, None),))])
-        a, b = read(f"{mine}/VTS_01_1.VOB"), read(f"{t}/dvd/VIDEO_TS/VTS_01_1.VOB")
+        titleset.write(mine, 1, [Title(sp, audio=(Audio("en", 2),), post=tuple(post), buttons=(tb,)),
+                                 Title(self.short, audio=(Audio("en", 2),))])
+        theirs = f"{t}/dvd/VIDEO_TS"
+        a, b = read(f"{mine}/VTS_01_1.VOB"), read(f"{theirs}/VTS_01_1.VOB")
         self.assertEqual([n[2] for n in navs(a)], [n[2] for n in navs(b)])
         self.assertEqual(a, b)
+        # the IFO: the same, the title's pre (SetHL_BTNN 1) and post
+        # included, but for the palette (spumux's colours)
+        a, b = read(f"{mine}/VTS_01_0.IFO"), read(f"{theirs}/VTS_01_0.IFO")
+        self.assertEqual(len(a), len(b))
+        pgc = struct.unpack_from(">I", a, 0xCC)[0] * 2048 + 16
+        self.assertEqual(a[:pgc + 0xA4], b[:pgc + 0xA4])
+        self.assertEqual(a[pgc + 0xE4:], b[pgc + 0xE4:])
 
     def stretch_disc(self, start, end):
         """Title 1 (10 s) with buttons from `start` to `end` (button 1:
@@ -173,10 +191,29 @@ class TestTitleButtons(unittest.TestCase):
         with self.assertRaisesRegex(VtsError, "overlap"):
             write(buttons(1, None), buttons(3, 5))
         with self.assertRaisesRegex(VtsError, "one set of buttons"):
-            write(buttons(1, 2.8), buttons(2.9, 5))                   # in the VOBU from 2.4 s to 3.0 s
+            write(buttons(1, 3.0), buttons(3.05, 3.2), buttons(3.25, 5))   # in the VOBU from 3.0 s
         with self.assertRaisesRegex(VtsError, "after the title ends"):
             write(buttons(30, 40))
 
+    def test_stretches_meeting_in_a_vobu(self):
+        # the VOBUs start every 0.6006 s; where two stretches meet inside a
+        # VOBU, it carries the one covering more of it
+        def starts(*tbs):
+            """{VOBU start (s, rounded): its HLI's start from the title's start}"""
+            out = os.path.join(self.tmp, "meeting")
+            titleset.write(out, 1, [Title(self.plain, audio=(Audio("en", 2),), buttons=tbs)])
+            packs = navs(read(f"{out}/VTS_01_1.VOB"))
+            s0 = packs[0][1]
+            return {round((s - s0) / 90000, 1): struct.unpack_from(">I", h, 2)[0] - s0 if h[1] else None
+                    for _, s, h in packs}
+        got = starts(buttons(1, 2.8), buttons(2.9, 5))
+        self.assertEqual((got[1.8], got[2.4], got[3.0]), (90000, 90000, 261000))
+        # buttons that change a frame before or after a VOBU's start (as a
+        # film title's frames fall): each VOBU still carries its own
+        for edge in (3.003 - 3003 / 90000, 3.003 + 3003 / 90000):
+            got = starts(buttons(1, edge), buttons(edge, 5))
+            self.assertEqual((got[2.4], got[3.0]), (90000, int(round(edge * 90000))), edge)
+
     @unittest.skipUnless(LIBDVDNAV, "needs libdvdnav")
     def test_under_libdvdnav(self):
         out = self.stretch_disc(3.0, 6.0)

{vtskit-0.2.0 → vtskit-0.3.0}/vtskit/__init__.py

@@ -21,5 +21,5 @@ subtitles and angles, and dvdauthor's command language:
 
 from .errors import VtsError
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 __all__ = ["VtsError"]

{vtskit-0.2.0 → vtskit-0.3.0}/vtskit/lang.py

@@ -25,10 +25,10 @@ authored):
 * `audio = 1; subtitle = 65;` next to each other are one SetSTN; `g1 = 0;
   jump menu 2;` is one command (vtskit.vm folds a Set and a Link), and
   what follows an unconditional jump in a block is left out;
-* a menu's button runs one command: a button whose text compiles to more
-  sets GPRM 15 to its number and links to the end of the program chain,
-  whose post commands start with a dispatcher (`g14 = g15; g15 = 0;` and a
-  Goto per such button) and end with each button's code;
+* a menu's or a title's button runs one command: a button whose text
+  compiles to more sets GPRM 15 to its number and links to the end of the
+  program chain, whose post commands start with a dispatcher (`g14 = g15;
+  g15 = 0;` and a Goto per such button) and end with each button's code;
 * a jump into another titleset (dvdauthor's "jumppad") cannot be one
   command: from the video manager a jump to a chapter sets GPRM 15 to a
   code naming the title and chapter and jumps to the titleset's chapter
@@ -572,10 +572,12 @@ class Disc:
     def menu(self, buttons, post, domain="vtsm", vts=0):
         """A menu's buttons and post commands: ([one command a button],
         post commands). A button whose text takes several commands runs
-        them from the post, through a dispatcher, as dvdauthor arranges."""
+        them from the post, through a dispatcher, as dvdauthor arranges.
+        A title's buttons (domain "vts") are compiled the same way, as
+        dvdauthor compiles them."""
         self._check_domain(domain)
-        if domain not in ("vtsm", "vmgm"):
-            raise VtsError("buttons belong to menus")
+        if domain not in ("vtsm", "vmgm", "vts"):
+            raise VtsError("buttons belong to menus and titles")
         commands, deferred = [], []
         for n, text in enumerate(buttons, 1):
             items = self.instructions(text, domain, vts)

{vtskit-0.2.0 → vtskit-0.3.0}/vtskit/titleset.py

@@ -63,7 +63,7 @@ import os
 import struct
 from dataclasses import dataclass, field
 
-from . import menu as menus_, nav, ps, spu
+from . import menu as menus_, nav, ps, spu, vm
 from .errors import VtsError
 
 SECTOR = ps.SECTOR
@@ -748,12 +748,25 @@ def _lay_title(number, title, offset, vob_id, loaded):
     return w, sector, vob_id
 
 
+def _pre(title):
+    """A title's pre commands: with buttons, first the first button
+    highlighted (SetHL_BTNN 1), as dvdauthor writes it for a title with
+    buttons (tests/test_title_buttons.py)."""
+    if not title.buttons:
+        return tuple(title.pre)
+    return (vm.set_hl_btnn(1 << 10).encode(),) + tuple(title.pre)
+
+
 def _title_buttons(number, title, loaded, part_start):
     """The HLI of the title's buttons: {(part, angle): {VOBU: HLI}}, in the
     VOBUs that play during each stretch (every angle's), shown from the
     stretch's start to its end in the VOB's time (a stretch that began in
     an earlier part from the VOB's start; one that goes on into a later
-    part to the VOB's end; one without an end never ending)."""
+    part to the VOB's end; one without an end never ending). Where two
+    stretches meet inside a VOBU, it carries the one that covers more of
+    it: buttons that change between VOBUs (oncemore starts a VOBU there)
+    are not lost to a picture's difference between a time and the VOBU's
+    start, as in a film title with pulldown."""
     if not title.buttons:
         return {}
     width, height = loaded[0][0][0].sequence[:2]
@@ -768,26 +781,35 @@ def _title_buttons(number, title, loaded, part_start):
         if e1 is None or e1 > s2:
             raise VtsError(f"{w1} and {w2} overlap in time")
     out = {}
-    used = set()
+    touched, used = set(), set()
     for k, part in enumerate(loaded):
         for a, (_, vs, _) in enumerate(part):
             base, vob_end = vs[0].s_ptm, vs[-1].e_ptm
             table = out[(k, a)] = {}
-            for s, e, tb, what in stretches:
-                for i, v in enumerate(vs):
-                    t0 = part_start[k] + v.s_ptm - base
-                    t1 = part_start[k] + v.e_ptm - base
-                    if t1 <= s or e is not None and t0 >= e:
-                        continue
-                    if i in table:
-                        raise VtsError(f"{what} start in the VOBU (part {k + 1}, VOBU {i + 1}) where "
-                                       "the buttons before end: a VOBU carries one set of buttons")
-                    he = 0xFFFFFFFF if e is None else min(base + e - part_start[k], vob_end)
-                    table[i] = tb.hli(base + max(s - part_start[k], 0), he)
-                    used.add(what)
+            for i, v in enumerate(vs):
+                t0 = part_start[k] + v.s_ptm - base
+                t1 = part_start[k] + v.e_ptm - base
+                # (two stretches in a VOBU: the one covering more of it, the
+                # later on a tie; a VOBU carries one set of buttons)
+                best = None
+                for s, e, tb, what in stretches:
+                    cover = min(t1, e if e is not None else t1) - max(t0, s)
+                    if cover > 0:
+                        touched.add(what)
+                        if best is None or cover >= best[0]:
+                            best = (cover, s, e, tb, what)
+                if best is None:
+                    continue
+                _, s, e, tb, what = best
+                he = 0xFFFFFFFF if e is None else min(base + e - part_start[k], vob_end)
+                table[i] = tb.hli(base + max(s - part_start[k], 0), he)
+                used.add(what)
     for _, _, _, what in stretches:
-        if what not in used:
+        if what not in touched:
             raise VtsError(f"{what} start after the title ends")
+        if what not in used:
+            raise VtsError(f"{what} are shown for less of each VOBU they fall in than the buttons "
+                           "beside them: a VOBU carries one set of buttons")
     return out
 
 
@@ -955,7 +977,7 @@ def _write(folder, vts, titles, written, menus, language, pan_scan, letterbox, c
         for name in ("next_pgc", "prev_pgc", "up_pgc"):
             if not 0 <= getattr(t, name) <= len(titles):
                 raise VtsError(f"title {n}: {name} {getattr(t, name)}: the titleset has {len(titles)} program chains")
-    pgcs = [_pgc((t.pre, t.post, t.cell_commands), w, frame, sorted(w.stream.subpictures), t.palette,
+    pgcs = [_pgc((_pre(t), t.post, t.cell_commands), w, frame, sorted(w.stream.subpictures), t.palette,
                  stills=t.stills, uops=t.uops, video=video, links=(t.next_pgc, t.prev_pgc, t.up_pgc))
             for t, w in zip(titles, written)]
     pgci = struct.pack(">HHI", len(pgcs), 0, 0)

{vtskit-0.2.0 → vtskit-0.3.0/vtskit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vtskit
-Version: 0.2.0
+Version: 0.3.0
 Summary: DVD-Video titlesets in pure Python: VOBs, navigation packs and IFO files
 Author: kajisho5
 License-Expression: LGPL-3.0-or-later
@@ -146,10 +146,13 @@ oncemore writing its discs with vtskit.
   to an end, the buttons, the palette entries that draw them): their
   overlay is a forced subpicture added with `vtskit.subtitles`, and the
   highlight information goes only into the VOBUs that play during the
-  stretch, with the stretch's start and end as its start time, end time
+  stretch (where two stretches meet inside a VOBU, the one covering more
+  of it), with the stretch's start and end as its start time, end time
   and the end of the selection (dvdinfo's hli_s_ptm, hli_e_ptm,
   btn_sl_e_ptm). dvdauthor gives a title's buttons the whole title (every
-  VOBU, never ending), which is what buttons without an end write.
+  VOBU, never ending), which is what buttons without an end write. As
+  dvdauthor does, a title with buttons starts with its first button
+  highlighted (SetHL_BTNN 1 before its own pre commands).
 * `vtskit.subtitles` adds subtitles to a title's program stream, as spumux
   does: each cue a picture of up to four colours placed on the screen and
   shown for a while, as subpicture packs a little before their time.
@@ -157,8 +160,8 @@ oncemore writing its discs with vtskit.
   `if (g5 != 0) { button = g5; }`, `call menu entry root;`) for the domain
   a text runs in, to the same commands dvdauthor writes for it: a tool
   that already speaks the language, as oncemore does, keeps its text. A
-  button of several commands runs them from the menu's post through a
-  dispatcher, and a jump to a chapter of another titleset goes through pad
+  button of several commands, a menu's or a title's, runs them from the
+  program chain's post through a dispatcher, and a jump to a chapter of another titleset goes through pad
   program chains, as dvdauthor's "jumppads" do.
 * `vtskit.vmg` writes the video manager: VIDEO_TS.IFO and its BUP, with
   the first-play commands, the table of titles and the titlesets'
@@ -190,8 +193,9 @@ dvdauthor's (its buttons made with spumux), and a menu's overlay in a
 normal colour is spumux's unit byte for byte; subtitles muxed by vtskit are
 spumux's units, placed where spumux places them, and the title written
 from that stream (4:3, and 16:9 with and without pan-scan or letterbox) is
-dvdauthor's; a title with buttons over the whole of it is dvdauthor's
-VOB byte for byte. A VIDEO_TS written by vtskit alone plays
+dvdauthor's; a title with buttons over the whole of it (one of them of
+several commands) is dvdauthor's VOB and IFO byte for byte, but for the
+palette. A VIDEO_TS written by vtskit alone plays
 its titles and chapters in order under libdvdnav, its commands jumping
 between titles, its menus' buttons lead where they say, and its jumps into
 another titleset's chapters land; a title with an angle block plays and