mirror of
https://github.com/YusufB5/ASCILINE.git
synced 2026-06-23 22:48:06 +02:00
feat: server-side frame dropping under client backpressure (#30)
The live WebSocket pushed every frame on a wall-clock schedule regardless of whether the client could keep up. On a slow device frames piled into the client decode queue, and the client paid the inflate+delta-patch cost for each one before dropping the excess in its render loop. CPU spent on frames never shown. Client now reports its decoded-frame backlog (frameBuffer depth) ~4x/sec over the existing command channel. When the backlog exceeds BACKLOG_HIGH the server skips frames: it advances the source cheaply (grab, no decode/encode/send) so video stays time-aligned with audio, and crucially holds prev_frame across the gap so the next sent frame is a correct delta against the last SENT frame. No keyframe resync needed - deltas are always relative to the last sent frame. MAX_CONSEC_DROPS caps the gap and guarantees liveness for slow/non-reporting clients. Fully backward compatible: a client that never reports keeps backlog=0 and behaviour is unchanged. test/test_backpressure_gap.js encodes a keyframe + a dropped gap via codec.py and decodes through the shipped codec.js, asserting the post-gap frame is reconstructed bit-exact (and is a real DELTA), matching the no-drop path.
This commit is contained in:
parent
cacf262d61
commit
d9480e9f85
4 changed files with 238 additions and 0 deletions
81
test/_gap_fixture.py
Normal file
81
test/_gap_fixture.py
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
"""
|
||||
Fixture generator for the backpressure frame-drop test (see test_backpressure_gap.js).
|
||||
|
||||
Emits JSON on stdout describing two encodings of the SAME synthetic frame
|
||||
sequence, both ending on frame 4:
|
||||
|
||||
drop : keyframe(0), then frames 1-3 are DROPPED server-side (prev_frame held),
|
||||
then frame 4 encoded as a delta against frame 0's shown state.
|
||||
full : every frame 0..4 encoded against the previous shown frame.
|
||||
|
||||
The decode side (codec.js, the shipped path) must reconstruct frame 4 bit-exact
|
||||
in BOTH cases -- that is the correctness claim behind server-side dropping:
|
||||
holding prev_frame across the gap keeps the delta chain exact. The drop case
|
||||
must also send strictly fewer messages, which is the whole point.
|
||||
|
||||
Run standalone: python3 test/_gap_fixture.py
|
||||
"""
|
||||
import base64
|
||||
import json
|
||||
import os
|
||||
import sys
|
||||
|
||||
import numpy as np
|
||||
|
||||
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
|
||||
from codec import encode_frame, TAG_DELTA # noqa: E402
|
||||
|
||||
ROWS, COLS, C = 8, 8, 4 # ASCII colour: [char, R, G, B]
|
||||
|
||||
|
||||
def make_sequence():
|
||||
"""Deterministic frames where only a few cells change each step, so the
|
||||
post-gap frame still differs from frame 0 by a small fraction (-> DELTA path)."""
|
||||
rng = np.random.default_rng(1234)
|
||||
base = rng.integers(0, 256, size=(ROWS, COLS, C), dtype=np.uint8)
|
||||
frames = [base.copy()]
|
||||
f = base.copy()
|
||||
for step in range(1, 5):
|
||||
f = f.copy()
|
||||
# Mutate one distinct cell per step (structure + colour), small delta.
|
||||
r, col = step % ROWS, (step * 3) % COLS
|
||||
f[r, col, 0] = (int(f[r, col, 0]) + 7 * step) % 256 # char plane
|
||||
f[r, col, 1:] = (f[r, col, 1:].astype(int) + 30 * step) % 256
|
||||
frames.append(f)
|
||||
return frames
|
||||
|
||||
|
||||
def b64(buf: bytes) -> str:
|
||||
return base64.b64encode(buf).decode("ascii")
|
||||
|
||||
|
||||
def main():
|
||||
frames = make_sequence()
|
||||
expected = frames[4]
|
||||
|
||||
# ── DROP path: keyframe 0, drop 1-3 (hold prev), delta 4 vs frame 0 ──
|
||||
msg0, shown0 = encode_frame(frames[0], None, 0, tolerance=0)
|
||||
msg4_drop, _ = encode_frame(frames[4], shown0, 4, tolerance=0)
|
||||
drop_tag = msg4_drop[4] # byte after the 4-byte frame index
|
||||
|
||||
# ── FULL path: every frame against the previous shown ──
|
||||
full_msgs = []
|
||||
prev = None
|
||||
for i, fr in enumerate(frames):
|
||||
m, prev = encode_frame(fr, prev, i, tolerance=0)
|
||||
full_msgs.append(b64(m))
|
||||
|
||||
out = {
|
||||
"cellBytes": C,
|
||||
"rows": ROWS,
|
||||
"cols": COLS,
|
||||
"expected": b64(expected.tobytes()),
|
||||
"drop": {"messages": [b64(msg0), b64(msg4_drop)], "gapTag": drop_tag},
|
||||
"full": {"messages": full_msgs},
|
||||
"delta_tag": TAG_DELTA,
|
||||
}
|
||||
json.dump(out, sys.stdout)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
83
test/test_backpressure_gap.js
Normal file
83
test/test_backpressure_gap.js
Normal file
|
|
@ -0,0 +1,83 @@
|
|||
/**
|
||||
* Backpressure frame-drop correctness test (issue #30).
|
||||
*
|
||||
* Proves the claim behind server-side frame dropping: when the server drops
|
||||
* frames for a slow client, it holds prev_frame across the gap, so the next
|
||||
* SENT frame is a delta against the last sent frame. Decoding through the
|
||||
* SHIPPED codec.js must reconstruct that post-gap frame bit-exact, identical to
|
||||
* the no-drop path -- the client just decodes fewer frames to get there.
|
||||
*
|
||||
* Encoding is done by codec.py via _gap_fixture.py (the encoder only exists in
|
||||
* Python); decoding uses codec.js, so this exercises the real Python<->JS path.
|
||||
*
|
||||
* Usage: node test/test_backpressure_gap.js
|
||||
*/
|
||||
const { execFileSync } = require('child_process');
|
||||
const path = require('path');
|
||||
const codec = require('../codec.js');
|
||||
|
||||
function b64ToU8(s) {
|
||||
return new Uint8Array(Buffer.from(s, 'base64'));
|
||||
}
|
||||
|
||||
async function decodeLast(messagesB64, cellBytes) {
|
||||
const decoder = codec.makeDecoder(cellBytes);
|
||||
let last = null;
|
||||
for (const m of messagesB64) {
|
||||
// decode() expects an ArrayBuffer (as WebSocket delivers); give it a fresh one.
|
||||
const u8 = b64ToU8(m);
|
||||
const ab = u8.buffer.slice(u8.byteOffset, u8.byteOffset + u8.byteLength);
|
||||
last = (await decoder.decode(ab)).frame;
|
||||
}
|
||||
return last;
|
||||
}
|
||||
|
||||
function eq(a, b) {
|
||||
if (a.length !== b.length) return { ok: false, why: `len ${a.length} != ${b.length}` };
|
||||
for (let i = 0; i < a.length; i++) {
|
||||
if (a[i] !== b[i]) return { ok: false, why: `byte ${i}: ${a[i]} != ${b[i]}` };
|
||||
}
|
||||
return { ok: true };
|
||||
}
|
||||
|
||||
(async () => {
|
||||
const fixturePath = path.join(__dirname, '_gap_fixture.py');
|
||||
const raw = execFileSync('python3', [fixturePath], { encoding: 'utf8' });
|
||||
const fx = JSON.parse(raw);
|
||||
|
||||
const expected = b64ToU8(fx.expected);
|
||||
const checks = [];
|
||||
|
||||
// 1. Drop path reconstructs frame 4 bit-exact (prev_frame held across the gap).
|
||||
const dropFrame = await decodeLast(fx.drop.messages, fx.cellBytes);
|
||||
const dropEq = eq(dropFrame, expected);
|
||||
checks.push(['drop path decodes frame 4 bit-exact', dropEq.ok, dropEq.why]);
|
||||
|
||||
// 2. The post-gap frame is a real DELTA, not a fallback keyframe -- otherwise
|
||||
// we wouldn't be exercising the held-prev_frame delta path at all.
|
||||
checks.push([
|
||||
'post-gap frame is a DELTA (tag 2)',
|
||||
fx.drop.gapTag === fx.delta_tag,
|
||||
`gapTag=${fx.drop.gapTag} expected=${fx.delta_tag}`,
|
||||
]);
|
||||
|
||||
// 3. No-drop path also reconstructs frame 4 bit-exact (sanity / same endpoint).
|
||||
const fullFrame = await decodeLast(fx.full.messages, fx.cellBytes);
|
||||
const fullEq = eq(fullFrame, expected);
|
||||
checks.push(['full path decodes frame 4 bit-exact', fullEq.ok, fullEq.why]);
|
||||
|
||||
// 4. The win: drop path makes the client decode strictly fewer frames.
|
||||
checks.push([
|
||||
'drop path sends fewer frames than full path',
|
||||
fx.drop.messages.length < fx.full.messages.length,
|
||||
`drop=${fx.drop.messages.length} full=${fx.full.messages.length}`,
|
||||
]);
|
||||
|
||||
let failed = 0;
|
||||
for (const [name, ok, why] of checks) {
|
||||
console.log(`${ok ? 'PASS' : 'FAIL'} ${name}${ok ? '' : ' -> ' + why}`);
|
||||
if (!ok) failed++;
|
||||
}
|
||||
console.log(`\n${checks.length - failed}/${checks.length} passed`);
|
||||
process.exit(failed === 0 ? 0 : 1);
|
||||
})().catch((e) => { console.error('ERROR', e); process.exit(2); });
|
||||
Loading…
Add table
Add a link
Reference in a new issue