bdmvkit 0.3.0__tar.gz → 0.4.0__tar.gz

{bdmvkit-0.3.0/bdmvkit.egg-info → bdmvkit-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bdmvkit
-Version: 0.3.0
+Version: 0.4.0
 Summary: Blu-ray (BDMV) authoring in pure Python: playlists, clip information, HDMV navigation, PGS subtitles
 Author: kajisho5
 License-Expression: LGPL-3.0-or-later
@@ -35,14 +35,14 @@ only to encode.
 
 日本語の説明は [README.ja.md](README.ja.md) にあります。
 
-**Status: 0.3.** Titles with chapters, sound and subtitle tracks;
+**Status: 0.4.** Titles with chapters, sound and subtitle tracks;
 playlists (in order, at random or shuffled) and play all; menus whose
 buttons start titles, chapters, playlists and other menus, switch sound and
 subtitle tracks, or open a menu on a chosen button; loop counts, end-action
 overrides, link transitions, remote keys a title turns off, and 720p. This
 navigation is the one [oncemore](https://github.com/kajisho5/oncemore)
-writes, byte for byte. Encoding pop-up menus and menus with motion or music
-comes next.
+writes, byte for byte. 0.4 adds pop-up menus over a playing title. Menus
+with motion or music come next.
 
 ## Why
 
@@ -132,6 +132,19 @@ disc.add_menu("main", "menu.png", [
 ], loop=3, end="playall", seconds=10)
 ```
 
+A title can have a pop-up menu: buttons over its picture, opened with the
+remote's Pop-up Menu key. Their pictures are placed on the 1920 x 1080 frame
+as a menu's are; a button that only switches the sound or subtitle track
+closes the menu.
+
+```python
+disc.add_popup(a, [
+    MenuButton("scenes", 160, 900, "scenes.png", "scenes-on.png", "scenes-off.png",
+               action="menu:main"),
+    MenuButton("ja", 560, 900, "ja.png", normal="ja-off.png", action="audio:2"),
+])
+```
+
 Underneath, `bdmvkit.program` describes a disc made of encoded clips
 (titles, playlists, menu clips that carry their buttons, transitions) and
 `bdmvkit.nav.write_program` writes it; `nav.Navigation` gives the commands a
@@ -196,6 +209,8 @@ The tests encode real clips, write a disc, and read it back with
   the titles, chapters, playlists and menus they link to, that a shuffled
   playlist plays each item once, and that a menu with a loop count goes on
   by itself;
+* that a pop-up menu opens over a playing title with the Pop-up Menu key and
+  its buttons start another title or a chapter;
 * the commands every kind of action, title, playlist and menu turns into.
 
 The files' fixed bytes are checked as well.

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/README.md

@@ -18,14 +18,14 @@ only to encode.
 
 日本語の説明は [README.ja.md](README.ja.md) にあります。
 
-**Status: 0.3.** Titles with chapters, sound and subtitle tracks;
+**Status: 0.4.** Titles with chapters, sound and subtitle tracks;
 playlists (in order, at random or shuffled) and play all; menus whose
 buttons start titles, chapters, playlists and other menus, switch sound and
 subtitle tracks, or open a menu on a chosen button; loop counts, end-action
 overrides, link transitions, remote keys a title turns off, and 720p. This
 navigation is the one [oncemore](https://github.com/kajisho5/oncemore)
-writes, byte for byte. Encoding pop-up menus and menus with motion or music
-comes next.
+writes, byte for byte. 0.4 adds pop-up menus over a playing title. Menus
+with motion or music come next.
 
 ## Why
 
@@ -115,6 +115,19 @@ disc.add_menu("main", "menu.png", [
 ], loop=3, end="playall", seconds=10)
 ```
 
+A title can have a pop-up menu: buttons over its picture, opened with the
+remote's Pop-up Menu key. Their pictures are placed on the 1920 x 1080 frame
+as a menu's are; a button that only switches the sound or subtitle track
+closes the menu.
+
+```python
+disc.add_popup(a, [
+    MenuButton("scenes", 160, 900, "scenes.png", "scenes-on.png", "scenes-off.png",
+               action="menu:main"),
+    MenuButton("ja", 560, 900, "ja.png", normal="ja-off.png", action="audio:2"),
+])
+```
+
 Underneath, `bdmvkit.program` describes a disc made of encoded clips
 (titles, playlists, menu clips that carry their buttons, transitions) and
 `bdmvkit.nav.write_program` writes it; `nav.Navigation` gives the commands a
@@ -179,6 +192,8 @@ The tests encode real clips, write a disc, and read it back with
   the titles, chapters, playlists and menus they link to, that a shuffled
   playlist plays each item once, and that a menu with a loop count goes on
   by itself;
+* that a pop-up menu opens over a playing title with the Pop-up Menu key and
+  its buttons start another title or a chapter;
 * the commands every kind of action, title, playlist and menu turns into.
 
 The files' fixed bytes are checked as well.

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit/__init__.py

@@ -1,7 +1,7 @@
 """bdmvkit: Blu-ray (BDMV) authoring in pure Python.
 
 * `bdmvkit.Disc`: a BDMV folder from encoded clips (titles, chapters, sound
-  and subtitle tracks), playlists and menus (`MenuButton`).
+  and subtitle tracks), playlists, menus and pop-up menus (`MenuButton`).
 * `bdmvkit.program` and `bdmvkit.nav`: the model underneath (titles,
   playlists, menu clips, transitions, actions) and its writer,
   `nav.write_program`, with the navigation commands (`nav.Navigation`).
@@ -15,5 +15,5 @@
 from .disc import Disc, MenuButton
 from .errors import BdmvError
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"
 __all__ = ["Disc", "MenuButton", "BdmvError"]

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit/__main__.py

@@ -11,7 +11,8 @@ DISC.json: {"titles": [{"clip": "a.m2ts", "fps": "24000/1001",
 file. A button may also have "activated" and "normal" pictures, "nav"
 ({"up": id, ...}), "auto", "audio", "subtitle" and "override"; a menu
 "default" (a button id), "fps", "loop", "end", "seconds" and "prohibit"; a
-title "default_audio", "default_subtitle" and "prohibit". The disc may have
+title "default_audio", "default_subtitle", "prohibit" and "popup" ({"buttons":
+[...], "default"}: its pop-up menu, buttons as a menu's). The disc may have
 "playlists" ([{"id", "items": [n or [n, first, last]], "order", "end"}]),
 "first_play" and "title_key".
 """
@@ -75,15 +76,20 @@ def main(argv=None):
         def file(name):
             return os.path.join(base, name) if name else None
 
+        def buttons(spec_buttons):
+            return [MenuButton(b["id"], int(b["x"]), int(b["y"]), file(b["selected"]),
+                               file(b.get("activated")), file(b.get("normal")), b.get("action"),
+                               dict(b.get("nav", {})), bool(b.get("auto")), b.get("audio"),
+                               b.get("subtitle"), b.get("override")) for b in spec_buttons]
+
+        for n, t in enumerate(spec.get("titles", []), 1):
+            if t.get("popup"):
+                disc.add_popup(n, buttons(t["popup"]["buttons"]), t["popup"].get("default"))
         for m in spec.get("menus", []):
-            disc.add_menu(m["id"], file(m["background"]), [
-                MenuButton(b["id"], int(b["x"]), int(b["y"]), file(b["selected"]),
-                           file(b.get("activated")), file(b.get("normal")), b.get("action"),
-                           dict(b.get("nav", {})), bool(b.get("auto")), b.get("audio"),
-                           b.get("subtitle"), b.get("override"))
-                for b in m["buttons"]], fps=_fps(m.get("fps", "24000/1001")),
-                default=m.get("default"), loop=m.get("loop"), end=m.get("end"),
-                prohibit=m.get("prohibit", []), seconds=float(m.get("seconds", 1.0)))
+            disc.add_menu(m["id"], file(m["background"]), buttons(m["buttons"]),
+                          fps=_fps(m.get("fps", "24000/1001")), default=m.get("default"),
+                          loop=m.get("loop"), end=m.get("end"), prohibit=m.get("prohibit", []),
+                          seconds=float(m.get("seconds", 1.0)))
         res = disc.write(args.out, play_all=spec.get("play_all", True), fast=args.fast)
     except (BdmvError, OSError, KeyError, ValueError) as e:
         print(f"bdmvkit: {getattr(e, 'message', e)}", file=sys.stderr)

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit/disc.py

@@ -34,10 +34,11 @@ import dataclasses
 import os
 import tempfile
 
-from . import encode, igs, program
+from . import encode, hdmv, igs, program
 from .errors import BdmvError
 from .formats import AUDIO_PID, CODECS, FORMATS, HEIGHT, PG_PID, WIDTH, lang3
 from .m2ts import stream_pids
+from .program import parse_action
 from .nav import DIRS, Navigation, _write, chapter_marks, write_program  # noqa: F401
 
 
@@ -103,6 +104,7 @@ class Disc:
         self.titles = []
         self.menus = []
         self.playlists = []
+        self.popups = {}                 # title number -> (buttons, default)
         self.first_play = first_play
         self.title_key = title_key
 
@@ -162,6 +164,19 @@ class Disc:
         self.menus.append(Menu(menu_id, background, list(buttons), tuple(fps), default, loop,
                                end, list(prohibit), seconds))
 
+    def add_popup(self, title, buttons, default=None):
+        """Give title `title` (its number) a pop-up menu: `buttons`
+        (MenuButtons, their pictures placed on the 1920 x 1080 picture over
+        the playing title) shown by the remote's Pop-up Menu key. A button
+        that switches the sound or subtitle track closes the menu; one that
+        goes elsewhere goes there. The menu's IG stream is muxed into the
+        title's clip when the disc is written."""
+        if not 1 <= title <= len(self.titles):
+            raise BdmvError(f"there is no title {title}")
+        if not buttons:
+            raise BdmvError(f"title {title}: a pop-up menu needs at least one button")
+        self.popups[title] = (list(buttons), default)
+
     def program(self, play_all=True):
         """The disc as a program.Program (titles "1", "2" ...; menus with no
         clip yet: write makes them)."""
@@ -174,10 +189,11 @@ class Disc:
                 [program.Audio(CODECS[c], ch, _lang(lang), k == t.default_audio)
                  for k, (c, ch, lang) in enumerate(t.audio, 1)],
                 [program.Subtitle(_lang(lang), k == t.default_subtitle)
-                 for k, lang in enumerate(t.subtitles, 1)], end, list(t.prohibit)))
+                 for k, lang in enumerate(t.subtitles, 1)], end, list(t.prohibit),
+                popup=n in self.popups,
+                popup_buttons=[_button(b) for b in self.popups.get(n, ((), None))[0]]))
         menus = [program.Menu(m.id, None,
-                              [program.Button(b.id, b.action, b.audio, b.subtitle,
-                                              override=b.override) for b in m.buttons],
+                              [_button(b) for b in m.buttons],
                               fps=m.fps, default=m.default, loop=m.loop, end=m.end,
                               still_time=max(1, round(m.seconds)) if m.loop is not None
                               else None,
@@ -203,6 +219,10 @@ class Disc:
         for k, (m, pm) in enumerate(zip(self.menus, prog.menus), len(self.titles) + 1):
             pm.clip = os.path.join(out_dir, "BDMV", "STREAM", f"{k:05d}.m2ts")
             self._encode_menu(m, pm, nav, fast)
+        for n, (buttons, default) in sorted(self.popups.items()):
+            pt = prog.titles[n - 1]
+            pt.clip = os.path.join(out_dir, "BDMV", "STREAM", f"{n:05d}.m2ts")
+            self._add_popup(self.titles[n - 1], buttons, default, pt, nav)
         out = write_program(prog, out_dir, move=move)
         return {"titles": len(self.titles), "menus": len(self.menus),
                 "playlists": out["playlists"], "chapters": out["chapters"]}
@@ -210,16 +230,7 @@ class Disc:
     def _encode_menu(self, m, pm, nav, fast):
         """Menu `m`'s clip (pm.clip): its buttons' pictures read, the IG
         stream made with their commands and encoded with its picture."""
-        buttons = []
-        for b, pb in zip(m.buttons, pm.buttons):
-            w, h, sel = encode.picture(b.selected)
-            if b.x < 0 or b.y < 0 or b.x + w > WIDTH or b.y + h > HEIGHT:
-                raise BdmvError(f"menu {m.id!r}: button {b.id!r} ({w} x {h} at {b.x}, {b.y}) "
-                                f"is not inside the {WIDTH} x {HEIGHT} frame")
-            act = encode.picture(b.activated, (w, h))[2] if b.activated else None
-            nor = encode.picture(b.normal, (w, h))[2] if b.normal else None
-            buttons.append(igs.Button(b.id, b.x, b.y, w, h, sel, act, nor,
-                                      nav.button(pb) if b.action else [], dict(b.nav), b.auto))
+        buttons = _ig_buttons(f"menu {m.id!r}", m.buttons, pm.buttons, nav)
         _, frame_rate = FORMATS[m.fps]
         with tempfile.TemporaryDirectory(prefix="bdmvkit-") as work:
             sup = os.path.join(work, "menu.sup")
@@ -229,6 +240,42 @@ class Disc:
             encode.encode_menu(m.background, sup, pm.clip, m.fps, seconds=m.seconds, fast=fast)
 
 
+    def _add_popup(self, t, buttons, default, pt, nav):
+        """The title's clip with its pop-up menu's IG stream, as pt.clip."""
+        _, frame_rate = FORMATS[t.fps]
+        ig = _ig_buttons(f"title {pt.id}'s pop-up menu", buttons, pt.popup_buttons, nav,
+                         popup=True)
+        with tempfile.TemporaryDirectory(prefix="bdmvkit-") as work:
+            sup = os.path.join(work, "popup.sup")
+            with open(sup, "wb") as f:
+                f.write(igs.ig_stream(ig, frame_rate, default=default, popup=True))
+            encode.add_ig_stream(t.clip, sup, pt.clip)
+
+
+def _button(b):
+    return program.Button(b.id, b.action, b.audio, b.subtitle, override=b.override)
+
+
+def _ig_buttons(where, buttons, program_buttons, nav, popup=False):
+    """MenuButtons as igs.Buttons: their pictures read, their commands the
+    navigation's (in a pop-up menu, a button that only switches streams
+    closes the menu too)."""
+    out = []
+    for b, pb in zip(buttons, program_buttons):
+        w, h, sel = encode.picture(b.selected)
+        if b.x < 0 or b.y < 0 or b.x + w > WIDTH or b.y + h > HEIGHT:
+            raise BdmvError(f"{where}: button {b.id!r} ({w} x {h} at {b.x}, {b.y}) "
+                            f"is not inside the {WIDTH} x {HEIGHT} frame")
+        act = encode.picture(b.activated, (w, h))[2] if b.activated else None
+        nor = encode.picture(b.normal, (w, h))[2] if b.normal else None
+        commands = nav.button(pb) if b.action else []
+        if popup and b.action and parse_action(b.action)[0] in ("audio", "subtitle"):
+            commands.append(hdmv.popup_off())
+        out.append(igs.Button(b.id, b.x, b.y, w, h, sel, act, nor, commands, dict(b.nav),
+                              b.auto))
+    return out
+
+
 def _lang(code):
     code = (code or "").lower()
     return code if len(code) == 3 and code.isalpha() else lang3(code)

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit/encode.py

@@ -9,6 +9,7 @@ interlaced (1080i) stream, as the format has no 1080p at those rates.
 """
 
 import dataclasses
+import os
 import shutil
 import subprocess
 
@@ -207,3 +208,49 @@ def encode_menu(background, sup, out, fps=(24000, 1001), seconds=1.0, fast=False
                         f"{p.stderr.strip()[-800:]}")
     patch_ig_stream_type(out)
     return out
+
+
+def add_ig_stream(clip, sup, out, ffmpeg=None):
+    """`clip` with the IG stream `sup` (igs.ig_stream, a pop-up menu) muxed
+    in, as `out`: the clip's streams copied with their PIDs and their times,
+    the buttons with IG_PID at the clip's first picture, marked Interactive
+    Graphics in the PMT. (Segments before the first picture are before the
+    play item's start, and players leave them out: so the buttons are timed
+    at it, not at the clip's own start, which the sound may begin.)"""
+    ffmpeg = ffmpeg or shutil.which("ffmpeg")
+    if not ffmpeg:
+        raise BdmvError("muxing needs ffmpeg")
+    from .igs import patch_ig_stream_type
+    probe = shutil.which("ffprobe") or ffmpeg.replace("ffmpeg", "ffprobe")
+    p = subprocess.run([probe, "-v", "error", "-show_entries", "stream=index,id", "-of",
+                        "csv=p=0", clip], capture_output=True, text=True)
+    # (ffprobe lists a stream again under its program: one each, by index)
+    streams = dict(line.split(",")[:2] for line in p.stdout.split() if "," in line)
+    pids = [int(streams[k], 16) for k in sorted(streams, key=int)]
+    if not pids:
+        raise BdmvError(f"cannot read the streams of {clip}")
+    from .m2ts import scan_m2ts
+    start = scan_m2ts(clip).first_pts
+    with open(sup, "rb") as f:
+        data = bytearray(f.read())
+    i = 0
+    while i + 13 <= len(data):                   # each segment's PTS and DTS: the start
+        data[i + 2:i + 10] = (start & 0xFFFFFFFF).to_bytes(4, "big") * 2
+        i += 13 + int.from_bytes(data[i + 11:i + 13], "big")
+    timed = out + ".sup"
+    with open(timed, "wb") as f:
+        f.write(data)
+    cmd = [ffmpeg, "-hide_banner", "-nostdin", "-v", "error", "-y", "-copyts", "-i", clip,
+           "-f", "sup", "-i", timed, "-map", "0", "-map", "1:0", "-c", "copy"]
+    for k, pid in enumerate(pids + [IG_PID]):
+        cmd += ["-streamid", f"{k}:{pid}"]
+    cmd += ["-f", "mpegts", "-mpegts_m2ts_mode", "1", "-mpegts_pmt_start_pid", str(PMT_PID),
+            out]
+    p = subprocess.run(cmd, capture_output=True, text=True)
+    os.remove(timed)
+    if p.returncode != 0:
+        raise BdmvError(f"ffmpeg could not add the pop-up menu to {clip}: "
+                        f"{p.stderr.strip()[-800:]}")
+    patch_ig_stream_type(out)
+    return out
+

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit/nav.py

@@ -121,7 +121,7 @@ class Navigation:
         # own default subtitles over the chosen ones (_start)
         self.stream_links = any(
             (b.audio or b.subtitle is not None) and b.action and parse_action(b.action)[0] in PLAYS
-            for m in p.menus for b in m.buttons)
+            for b in p.buttons())
 
     def menu_number(self, menu_id):
         return self.numbers.get(f"menu:{menu_id}")

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit/program.py

@@ -74,6 +74,10 @@ class Title:
     end: str = None              # action after it (None: stop)
     prohibit: list = dataclasses.field(default_factory=list)           # uops.KEYS names
     popup: bool = False          # its clip carries a pop-up menu (an IG stream)
+    popup_buttons: list = dataclasses.field(default_factory=list)
+    # (Buttons of a pop-up menu the Program writes into the clip, as
+    # Disc.add_popup does; empty when the clip's IG stream is made elsewhere
+    # from a menu's buttons)
     hold: bool = False           # each chapter a picture held until Next (a slideshow)
 
 
@@ -147,8 +151,15 @@ class Program:
             if m.loop is not None:
                 out.append(m.end)
         out += [t.end for t in self.titles] + [p.end for p in self.playlists]
+        for t in self.titles:
+            out += [b.action for b in t.popup_buttons] + [b.override for b in t.popup_buttons]
         return [a for a in out if a]
 
+    def buttons(self):
+        """Every button: the menus', then the pop-up menus' of the titles."""
+        return [b for m in self.menus for b in m.buttons] + \
+            [b for t in self.titles for b in t.popup_buttons]
+
     @property
     def uses_playall(self):
         return "playall" in self.actions()
@@ -157,7 +168,7 @@ class Program:
     def overrides(self):
         """End-action overrides buttons use, in a fixed order (1-based numbers
         in the override register)."""
-        return sorted({b.override for m in self.menus for b in m.buttons if b.override})
+        return sorted({b.override for b in self.buttons() if b.override})
 
     @property
     def link_transitions(self):
@@ -221,6 +232,11 @@ class Program:
                 if b.transition and b.transition not in self.transitions:
                     raise BdmvError(f"menu {m.id!r}, button {b.id!r}: no transition "
                                     f"{b.transition!r}")
+        for t in self.titles:
+            for b in t.popup_buttons:
+                if b.transition:
+                    raise BdmvError(f"title {t.id!r}: a pop-up menu's button ({b.id!r}) "
+                                    "cannot play a transition")
 
 
 def transition_key(button):

{bdmvkit-0.3.0 → bdmvkit-0.4.0/bdmvkit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bdmvkit
-Version: 0.3.0
+Version: 0.4.0
 Summary: Blu-ray (BDMV) authoring in pure Python: playlists, clip information, HDMV navigation, PGS subtitles
 Author: kajisho5
 License-Expression: LGPL-3.0-or-later
@@ -35,14 +35,14 @@ only to encode.
 
 日本語の説明は [README.ja.md](README.ja.md) にあります。
 
-**Status: 0.3.** Titles with chapters, sound and subtitle tracks;
+**Status: 0.4.** Titles with chapters, sound and subtitle tracks;
 playlists (in order, at random or shuffled) and play all; menus whose
 buttons start titles, chapters, playlists and other menus, switch sound and
 subtitle tracks, or open a menu on a chosen button; loop counts, end-action
 overrides, link transitions, remote keys a title turns off, and 720p. This
 navigation is the one [oncemore](https://github.com/kajisho5/oncemore)
-writes, byte for byte. Encoding pop-up menus and menus with motion or music
-comes next.
+writes, byte for byte. 0.4 adds pop-up menus over a playing title. Menus
+with motion or music come next.
 
 ## Why
 
@@ -132,6 +132,19 @@ disc.add_menu("main", "menu.png", [
 ], loop=3, end="playall", seconds=10)
 ```
 
+A title can have a pop-up menu: buttons over its picture, opened with the
+remote's Pop-up Menu key. Their pictures are placed on the 1920 x 1080 frame
+as a menu's are; a button that only switches the sound or subtitle track
+closes the menu.
+
+```python
+disc.add_popup(a, [
+    MenuButton("scenes", 160, 900, "scenes.png", "scenes-on.png", "scenes-off.png",
+               action="menu:main"),
+    MenuButton("ja", 560, 900, "ja.png", normal="ja-off.png", action="audio:2"),
+])
+```
+
 Underneath, `bdmvkit.program` describes a disc made of encoded clips
 (titles, playlists, menu clips that carry their buttons, transitions) and
 `bdmvkit.nav.write_program` writes it; `nav.Navigation` gives the commands a
@@ -196,6 +209,8 @@ The tests encode real clips, write a disc, and read it back with
   the titles, chapters, playlists and menus they link to, that a shuffled
   playlist plays each item once, and that a menu with a loop count goes on
   by itself;
+* that a pop-up menu opens over a playing title with the Pop-up Menu key and
+  its buttons start another title or a chapter;
 * the commands every kind of action, title, playlist and menu turns into.
 
 The files' fixed bytes are checked as well.

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/bdmvkit.egg-info/SOURCES.txt

@@ -26,4 +26,5 @@ tests/test_disc.py
 tests/test_files.py
 tests/test_menus.py
 tests/test_nav.py
-tests/test_pgs.py
+tests/test_pgs.py
+tests/test_popup.py

{bdmvkit-0.3.0 → bdmvkit-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "bdmvkit"
-version = "0.3.0"
+version = "0.4.0"
 description = "Blu-ray (BDMV) authoring in pure Python: playlists, clip information, HDMV navigation, PGS subtitles"
 readme = "README.md"
 license = "LGPL-3.0-or-later"

bdmvkit-0.4.0/tests/test_popup.py

@@ -0,0 +1,107 @@
+"""Pop-up menus: buttons over a playing title, muxed into its clip as an IG
+stream, opened with the remote's Pop-up Menu key and played by libbluray."""
+
+import os
+import shutil
+import tempfile
+import unittest
+
+from bdmvkit import BdmvError, Disc, MenuButton, hdmv
+from bdmvkit.encode import encode_clip
+from bdmvkit.formats import CODING_IG, IG_PID
+from bdmvkit.m2ts import stream_pids
+
+from .test_disc import ENCODE_OK, source
+from .test_menus import png
+
+try:
+    from . import bluray_sim
+    LIBBLURAY = bluray_sim.load_library()
+except Exception:  # pragma: no cover
+    LIBBLURAY = None
+
+
+@unittest.skipUnless(ENCODE_OK and LIBBLURAY, "needs ffmpeg with libx264, and libbluray")
+class TestPopup(unittest.TestCase):
+    """Title 1 has a pop-up menu: TWO (title 2) and SCENE (its own chapter 2)."""
+
+    @classmethod
+    def setUpClass(cls):
+        cls.tmp = d = tempfile.mkdtemp(prefix="bdmvkit-popup-")
+        a = encode_clip(source(os.path.join(d, "a.mp4"), 8), os.path.join(d, "a.m2ts"),
+                        chapters=[0, 4], fast=True)
+        b = encode_clip(source(os.path.join(d, "b.mp4"), 2), os.path.join(d, "b.m2ts"),
+                        fast=True)
+        lit = png(os.path.join(d, "lit.png"), 300, 60, "orange")
+        off = png(os.path.join(d, "off.png"), 300, 60, "gray")
+        disc = Disc()
+        cls.a = a
+        disc.add_title(a, chapters=[0, 4], end="stop")
+        disc.add_title(b, end="stop")
+        disc.add_popup(1, [MenuButton("two", 160, 900, lit, normal=off, action="title:2"),
+                           MenuButton("scene", 760, 900, lit, normal=off,
+                                      action="chapter:1:2"),
+                           MenuButton("sub", 1360, 900, lit, normal=off, action="subtitle:off")])
+        cls.out = os.path.join(d, "disc")
+        disc.write(cls.out, play_all=False, fast=True)
+
+    @classmethod
+    def tearDownClass(cls):
+        shutil.rmtree(cls.tmp, ignore_errors=True)
+
+    def test_in_the_clip(self):
+        clip = os.path.join(self.out, "BDMV", "STREAM", "00001.m2ts")
+        self.assertEqual(stream_pids(clip).get(IG_PID), CODING_IG)
+        # (the clip given is left as it was)
+        self.assertNotIn(IG_PID, stream_pids(self.a))
+        # the second title has none
+        self.assertNotIn(IG_PID, stream_pids(os.path.join(self.out, "BDMV", "STREAM",
+                                                          "00002.m2ts")))
+
+    def test_opens_and_its_buttons_work(self):
+        with bluray_sim.Disc(LIBBLURAY, self.out) as disc:
+            disc.info()
+            ev = [e for e in disc.play(keys=("live:popup", "live:enter"))
+                  if e[0] in ("title", "key", "menu") and e[1] != 0xFFFF]
+        keys = [e for e in ev if e[0] in ("title", "key")]
+        # title 1, the pop-up opened over it, TWO chosen: title 2
+        self.assertEqual(keys[:4], [("title", 1), ("key", "live:popup"), ("key", "live:enter"),
+                                    ("title", 2)])
+        drawn = [d for e in ev if e[0] == "menu" for d in e[1]]
+        xs = sorted({d[1] for d in drawn if d[0] == "draw"})
+        self.assertTrue({160, 760, 1360} <= set(xs), drawn)
+
+    def test_a_chapter_from_the_popup(self):
+        with bluray_sim.Disc(LIBBLURAY, self.out) as disc:
+            disc.info()
+            ev = disc.play(keys=("live:popup", "live:right", "live:enter"))
+        after = ev[next(i for i, e in enumerate(ev) if e == ("key", "live:enter")):]
+        self.assertIn(("at_chapter", 2), after)
+
+    def test_a_stream_button_closes_the_menu(self):
+        disc = Disc()
+        disc.add_title("x.m2ts")
+        p = disc.program()
+        from bdmvkit.disc import _ig_buttons
+        from bdmvkit.nav import Navigation
+        lit = os.path.join(self.tmp, "lit.png")
+        nav = Navigation(p)
+        sub = MenuButton("sub", 100, 100, lit, action="subtitle:off")
+        two = MenuButton("one", 100, 300, lit, action="title:1")
+        from bdmvkit.disc import _button
+        ig = _ig_buttons("t", [sub, two], [_button(sub), _button(two)], nav, popup=True)
+        self.assertEqual(ig[0].commands[-1], hdmv.popup_off())
+        self.assertNotIn(hdmv.popup_off(), ig[1].commands)
+
+
+class TestChecks(unittest.TestCase):
+    def test_refused(self):
+        disc = Disc()
+        with self.assertRaises(BdmvError):
+            disc.add_popup(1, [MenuButton("a", 0, 0, "a.png", action="title:1")])
+        disc.add_title("x.m2ts")
+        with self.assertRaises(BdmvError):
+            disc.add_popup(1, [])
+        disc.add_popup(1, [MenuButton("a", 0, 0, "a.png", action="title:9")])
+        with self.assertRaises(BdmvError):               # leads nowhere
+            disc.program().check()