mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-10-04 06:15:09 +00:00
ChuckandClaude Opus 5.5
f4bda50710
* perf(timing): say which render-thread work a late frame followed The soak already says how often a moving frame reached the panel late, but not what the render thread was doing just before it. Vegas does two kinds of work there between frames -- building its strip (compose, extend) and, with live elements, patching changed pixels into it -- and deciding whether either is affordable needs their own numbers. - FrameTimingRecorder.note_op(kind, nbytes) tags the next presented frame. Totals gain op_frames, late_op_frames, op_freezes and op_bytes per kind; aggregate() still takes frames without ops. The file schema is unchanged. - Vegas tags compose and every strip extension (with the bytes it copied). - frame_soak prints an "after work" table: frames, late %, freezes and MB moved per kind, only when something tagged its work. - render_bench gains --strip-screens (Vegas-sized strips), --patch-bytes / --patch-every / --patch-where (in-place column writes, as a live element update does) and --extend-every-screens / --extend-width (append + trim on a fixed cadence that holds the strip's width). No runtime behaviour changes: this is the measurement gate for live Vegas elements. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs(changelog): note the frame-op attribution and bench modes Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * perf(scroll): build the strip's PIL image only when something reads it Every Vegas strip extension rebuilt ScrollHelper.cached_image from cached_array in full, twice (append, then trim), on the render thread: Image.fromarray is 1.7ms for an 8,000px strip and 3.8ms for 20,000px on a Pi 4 (measured on ledpi), about two thirds of an extension's render-thread cost. Nothing on the frame path reads the image's pixels; every frame is cut from the array. cached_image is now a property. append_content and drop_scrolled_prefix defer it; the first read builds it from the array it started with and keeps it only if the strip has not changed meanwhile, so a sync push racing an extension cannot leave a stale image cached. Assigning cached_image stores exactly what was assigned, as before. has_strip() says whether there is a strip without building its image; the helper's frame path, Vegas and the adapter's scroll-cache invalidation use it. The strip is also no longer held in memory twice. In Vegas the image is now built only by a multi-display sync push. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * feat(vegas): live elements -- a plugin API for content that changes while it scrolls Vegas bakes each plugin's pictures into one strip, so a card already on its way across the panel keeps what it showed when it was drawn. This adds the API and bookkeeping for content that can be updated in place; the worker that redraws and swaps it follows separately. No shipped plugin implements the hook yet, so nothing changes for users. Plugin API (core 3.8.0), all no-ops by default: - BasePlugin.get_vegas_elements() -> [VegasElement(key, image, version, live, refresh_hz)]: named, fixed-width pieces of Vegas content. - BasePlugin.redraw_vegas_element(key, width, height, at): a lock-free redraw for content that changes with time. - BasePlugin.notify_vegas_data_changed(): data that lands outside update(). - src/plugin_system/vegas_elements.py (VegasElement, re-exported from base_plugin). Core: - PluginAdapter asks a plugin that implements the hook for elements on the background fetch only (under its lock, on its own canvas); every other path keeps get_vegas_content(). Live elements are pinned (padded with content_padding, never trimmed), tagged with their key, digest and data epoch in Image.info so the existing cache and group plumbing carry them unchanged, and untagged if a width budget crops them. - RenderPipeline records where each live element lands (ElementRecord), in absolute strip columns a trim does not move; the block-start arithmetic is shared with the STATIC markers. - PluginManager update listeners (add/remove_update_listener, notify_data_changed): told the moment update() completes, not at the next ~4s Vegas poll. The coordinator uses one to move each plugin's data epoch on. - vegas_scroll.live_refresh (kill switch), live_max_hz, live_min_interval, live_lead_screens; per-plugin core-owned vegas_live. Live elements are off under multi-display sync, in swap mode and with offscreen_prefetch off. - scripts/check_plugin.py checks the element contract (src/plugin_system/testing/vegas.py); test/fixtures/plugins/vegas-live-stub is a working example. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * feat(vegas): live elements update in place while they scroll One background worker (src/vegas_mode/live_worker.py) redraws a plugin's live elements when its data epoch moves on (update listener) or on their refresh_hz, nearest the screen first, and hands changed pixels lock-free to the render thread, which copies them into the strip between frames (RenderPipeline.apply_live_patches, ScrollHelper.patch_columns): at most four patches or two screens of bytes a frame, no drawing or locks there. The worker takes over group prefetch once a live element is placed, runs inside the render gate, and is supervised. Update tick 1s while live elements exist. Web UI switch for live_refresh. OFFSCREEN_RENDERING.md describes what was built and why SegmentStrip was not needed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
121 lines
4.4 KiB
Python
121 lines
4.4 KiB
Python
"""The adapter's side of live redraws: render_live_elements() and its memo.
|
|
|
|
The worker asks the adapter to redraw a plugin's elements whenever the plugin's
|
|
data moves on. What comes back is compared with what the strip shows, so the
|
|
adapter may skip converting an element it has seen before -- but only when it
|
|
is provably the same picture, and a bad element must cost only itself.
|
|
"""
|
|
import sys
|
|
import threading
|
|
from pathlib import Path
|
|
from types import SimpleNamespace
|
|
|
|
import pytest
|
|
from PIL import Image, ImageDraw
|
|
|
|
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
|
|
|
|
from src.plugin_system.vegas_elements import VegasElement # noqa: E402
|
|
from src.vegas_mode.config import VegasModeConfig # noqa: E402
|
|
from src.vegas_mode.elements import LiveEpochs # noqa: E402
|
|
from src.vegas_mode.plugin_adapter import PluginAdapter # noqa: E402
|
|
|
|
from test.test_vegas_elements_api import _DM, _Plugin, H # noqa: E402
|
|
|
|
|
|
def _card(width=40, colour=(255, 0, 0)):
|
|
image = Image.new("RGB", (width, H))
|
|
ImageDraw.Draw(image).rectangle([0, 0, width - 1, H - 1], outline=colour)
|
|
return image
|
|
|
|
|
|
def _adapter():
|
|
lock = threading.Lock()
|
|
pm = SimpleNamespace(get_plugin_lock=lambda pid: lock)
|
|
adapter = PluginAdapter(_DM(), VegasModeConfig(), plugin_manager=pm)
|
|
adapter.live_elements_enabled = True
|
|
adapter.live_epochs = LiveEpochs()
|
|
return adapter
|
|
|
|
|
|
def _render(adapter, plugin):
|
|
epoch, rendered = adapter.render_live_elements(plugin, "p", lock_timeout=1.0)
|
|
return rendered
|
|
|
|
|
|
def test_the_same_image_at_the_same_version_is_not_converted_again():
|
|
card = _card()
|
|
plugin = _Plugin(lambda: [VegasElement("c", card, version=1)])
|
|
adapter = _adapter()
|
|
first = _render(adapter, plugin)["c"]
|
|
again = _render(adapter, plugin)["c"]
|
|
assert again.pixels is first.pixels
|
|
|
|
|
|
def test_a_new_picture_at_the_same_version_is_converted():
|
|
# A config change (new colours) redraws the card without moving its data
|
|
# version; the strip must still get the new pixels.
|
|
colours = iter([(255, 0, 0), (0, 255, 0)])
|
|
plugin = _Plugin(lambda: [VegasElement("c", _card(colour=next(colours)), version=1)])
|
|
adapter = _adapter()
|
|
first = _render(adapter, plugin)["c"]
|
|
again = _render(adapter, plugin)["c"]
|
|
assert again.digest != first.digest
|
|
|
|
|
|
def test_the_same_image_at_a_new_version_is_converted():
|
|
card = _card()
|
|
versions = iter([1, 2])
|
|
plugin = _Plugin(lambda: [VegasElement("c", card, version=next(versions))])
|
|
adapter = _adapter()
|
|
first = _render(adapter, plugin)["c"]
|
|
again = _render(adapter, plugin)["c"]
|
|
assert again.pixels is not first.pixels
|
|
|
|
|
|
def test_invalidating_every_plugin_forgets_what_was_converted():
|
|
card = _card()
|
|
plugin = _Plugin(lambda: [VegasElement("c", card, version=1)])
|
|
adapter = _adapter()
|
|
first = _render(adapter, plugin)["c"]
|
|
adapter.invalidate_cache()
|
|
assert _render(adapter, plugin)["c"].pixels is not first.pixels
|
|
|
|
|
|
def test_an_element_that_cannot_be_converted_costs_only_itself(monkeypatch):
|
|
plugin = _Plugin(lambda: [VegasElement("bad", _card()), VegasElement("good", _card())])
|
|
adapter = _adapter()
|
|
real = adapter._element_image
|
|
|
|
def element_image(element):
|
|
if element.key == "bad":
|
|
raise OSError("closed file")
|
|
return real(element)
|
|
|
|
monkeypatch.setattr(adapter, "_element_image", element_image)
|
|
assert set(_render(adapter, plugin)) == {"good"}
|
|
placed = adapter.get_content(plugin, "p", offscreen_only=True)
|
|
from src.vegas_mode.elements import meta_of
|
|
assert [meta_of(img).key for img in placed] == ["good"]
|
|
|
|
|
|
@pytest.mark.parametrize("size", [(0, H), (40, 0)])
|
|
def test_an_empty_image_is_dropped(size):
|
|
plugin = _Plugin(lambda: [VegasElement("empty", Image.new("RGB", size)),
|
|
VegasElement("good", _card())])
|
|
adapter = _adapter()
|
|
assert set(_render(adapter, plugin)) == {"good"}
|
|
|
|
|
|
def test_a_bad_vegas_width_pct_is_reported_once(caplog):
|
|
plugin = _Plugin(lambda: [VegasElement("c", _card())], config={"vegas_width_pct": "wide"})
|
|
adapter = _adapter()
|
|
with caplog.at_level("WARNING"):
|
|
for _ in range(5):
|
|
adapter.resolve_render_width(plugin, "p")
|
|
assert sum("vegas_width_pct" in r.getMessage() for r in caplog.records) == 1
|
|
plugin.config["vegas_width_pct"] = 500
|
|
with caplog.at_level("WARNING"):
|
|
adapter.resolve_render_width(plugin, "p")
|
|
assert sum("out of range" in r.getMessage() for r in caplog.records) == 1
|