This release adds microphone processing controls and local chat controls, expands platform packages, and synchronizes the website and guides. It also fixes native H.264 input/format handling, signaling recovery, fresh STUN discovery, and UDP ownership during overlapping connections. This is **v1.8.0**. Browser/Server v23, Native control v9 and capture v7 remain unchanged, with the existing 1440p ceiling. Additional resolutions, capability negotiation and Magicsock are separate follow-up work. ## Validation - Full local Web check: 79 files / 1,317 tests, TypeScript and production build. - Full Go checks, platform builds and Windows native capture regressions/probe. - Native H.264 Host lifecycle, Browser-to-App fanout and App-exit recovery, and Native H.264 through embedded SFU: all passed with owned process/port/profile cleanup. - Website build, documentation and repository hygiene passed. Existing UI acceptance covers narrow screens, both languages/themes, architecture downloads and all 23 film checks; final packaging and Go race checks run on the merged revision in CI. - Physical macOS/Linux capture, representative public networks and unmatched field reports retain their documented evidence limits. No claim that every blur/disconnection report is resolved. ## Release notes ### 中文 这是一次功能与兼容性更新:麦克风和聊天增加了实用的小选项,App 与 Server 支持更多设备,同时修复了原生分享和连接恢复中的若干问题。现有 1.x 协议保持不变。 #### 新增与改进 - 浏览器麦克风新增「降噪与回声消除」开关,默认开启回声消除、降噪和自动增益;分享音乐或使用虚拟音频输入时,可按需关闭。 - 可调整弹幕字号和透明度,并将当前保留的聊天记录导出为 TXT。当前会话最多保留 1,000 条文字消息,刷新页面后清空;需要保存时请先导出。 - 新增 Intel Mac、Linux ARM64 App,以及 Linux ARM64 Server 和容器镜像。官网下载区可直接选择对应架构,并显示最新版本和发布时间。 - 更新官网演示、README 截图和中英文教程,明确浏览器分享也可选择窗口或屏幕;开始分享前显示房间号占位,保持底栏控件位置稳定。 - 官网新增直达问题排查的入口,补充浏览器 WebRTC 限制、校园网和 Windows 显卡相关的排查步骤。 - App 模式选择页显示免费开源说明、作者与贡献者署名,以及官方网站和源码链接。 #### 修复 - 修正部分 H.264 原生分享的格式兼容性校验,以及 Windows 编码器输入长度和输出缓冲区对齐问题。 - 清理已失效的重连任务和 Native 接收信令,避免旧连接继续影响当前会话。 - 修复 App 重连时可能复用过期公网地址的问题;重新探测使用当前地址,并处理探测丢包和过期响应,保留其他正常连接。 - 修复 App 新旧媒体连接重叠时共用端口造成的冲突,避免准备或撤销新连接打断仍在使用的画面;关闭连接时及时取消未完成的端口映射请求。 - 无站点密码时,连接恢复不再误引导用户输入站点密码。 - 房间失效或会话终止时,开播前后的原因提示统一显示在电视状态图标中,避免额外提示条。 - 修正 Linux 原生采集的时间戳与关键帧时间基准。感谢 Pedro Antonio 在 [#449](https://github.com/TNTcraftHIM/Piik/pull/449) 的贡献。 #### 使用说明 下载对应平台的完整压缩包,退出旧 App 后解压使用。Windows 继续提供 x64;macOS 提供 Apple 芯片与 Intel 版本,原生采集需要 macOS 13 或更新版本。Linux 提供 x64 与 ARM64,原生采集还需安装[系统组件](https://github.com/TNTcraftHIM/Piik/blob/main/native/capture/linux/README.md)。macOS 和 Linux 的实机覆盖仍有限,欢迎反馈。 ### English This update adds useful microphone and chat controls, brings Piik to more devices, and fixes several native-sharing and connection-recovery issues. The existing 1.x protocols remain unchanged. #### New and improved - Browser microphones now have a “Noise & echo reduction” toggle. Echo cancellation, noise suppression and automatic gain control are on by default; turn them off when appropriate for music or virtual audio inputs. - Adjust chat-overlay text size and opacity, and export retained messages as TXT. The current session keeps up to 1,000 text messages and clears on page refresh; export first if you want to keep them. - Added Intel Mac and Linux ARM64 App packages, plus Linux ARM64 Server and container images. The website provides architecture selectors and shows the latest release and publication date. - Updated the website demonstration, README screenshots and bilingual guides, clarifying that browser capture can also select windows or screens. A room-code placeholder keeps the bottom bar stable before sharing starts. - Added direct website links to troubleshooting, with steps for browser WebRTC restrictions, campus networks and Windows graphics issues. - The App mode-selection page now shows its free and open-source status, author and contributor credit, and links to the official website and source. #### Fixes - Corrected H.264 format compatibility checks and Windows encoder input-length and output-buffer alignment handling. - Retired stale reconnect tasks and Native receive signals so they cannot continue affecting the current session. - Fixed App reconnection reusing an expired public address. Fresh discovery handles lost probes and stale responses while preserving other working connections. - Fixed UDP socket conflicts between overlapping App media connections so preparing or canceling a replacement preserves the active picture. Closing a connection now cancels unfinished gateway mapping requests. - Connection recovery on passwordless sites no longer incorrectly asks for a site passphrase. - Expired-room and session-termination reasons now use the same TV status indicator before and during sharing, without an extra notice strip. - Corrected Linux native capture timestamps and keyframe time bases. Thanks to Pedro Antonio for [#449](https://github.com/TNTcraftHIM/Piik/pull/449). #### Updating Download the complete archive for your platform, quit the old App, and extract the new package. Windows remains x64-only. macOS packages support Apple silicon and Intel; native capture requires macOS 13 or newer. Linux supports x64 and ARM64 and requires additional [system components](https://github.com/TNTcraftHIM/Piik/blob/main/native/capture/linux/README.md) for native capture. Physical-device coverage on macOS and Linux remains limited; feedback is welcome. ## Attribution Co-authored-by: Pedro Antonio <wrenchwastaken@gmail.com>
138 lines
6.7 KiB
JavaScript
138 lines
6.7 KiB
JavaScript
#!/usr/bin/env node
|
|
|
|
import assert from "node:assert/strict";
|
|
import { execFileSync } from "node:child_process";
|
|
import { randomBytes, randomUUID } from "node:crypto";
|
|
import { createSocket } from "node:dgram";
|
|
import { copyFileSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync } from "node:fs";
|
|
import { dirname, join, resolve } from "node:path";
|
|
import { setTimeout as delay } from "node:timers/promises";
|
|
import { fileURLToPath } from "node:url";
|
|
import { resetBuildWorkspace } from "./build-workspace.mjs";
|
|
|
|
const [image, revision] = process.argv.slice(2);
|
|
if (process.argv.length !== 4 || !image || !/^[0-9a-f]{40}$/.test(revision ?? "")) {
|
|
throw new Error("Usage: node scripts/check-container.mjs <local-image> <full-source-sha>");
|
|
}
|
|
const root = resolve(dirname(fileURLToPath(import.meta.url)), "..");
|
|
const project = `piik-check-${randomUUID()}`;
|
|
const workspace = resetBuildWorkspace(root, "container-check", project);
|
|
const environment = { ...process.env, PIIK_IMAGE: image };
|
|
function docker(...args) {
|
|
return execFileSync("docker", args, {
|
|
cwd: workspace, env: environment, encoding: "utf8", timeout: 90_000,
|
|
stdio: ["ignore", "pipe", "pipe"], windowsHide: true,
|
|
}).trim();
|
|
}
|
|
function compose(...args) {
|
|
return docker("compose", "--project-name", project, "--file", "compose.yaml", ...args);
|
|
}
|
|
async function until(check, label) {
|
|
const deadline = Date.now() + 20_000;
|
|
let failure;
|
|
do {
|
|
try { return await check(); } catch (error) { failure = error; }
|
|
await delay(200);
|
|
} while (Date.now() < deadline);
|
|
throw new Error(`Container check timed out: ${label}`, { cause: failure });
|
|
}
|
|
async function request(path, options) {
|
|
const response = await fetch(`http://127.0.0.1:8787${path}`, {
|
|
...options, signal: AbortSignal.timeout(2_000),
|
|
});
|
|
assert.ok(response.ok, `${path}: HTTP ${response.status}`);
|
|
return response;
|
|
}
|
|
async function expectServices(sfu, natPrediction) {
|
|
const capabilities = await (await request("/api/capabilities")).json();
|
|
// Capability metadata is extensible. This gate checks configured services,
|
|
// not the absence of other compatible capabilities.
|
|
assert.equal(capabilities.sfu, sfu);
|
|
assert.equal(capabilities.natPrediction, natPrediction);
|
|
}
|
|
async function binding(port) {
|
|
const socket = createSocket("udp4");
|
|
const packet = Buffer.alloc(20);
|
|
packet.writeUInt16BE(1); // RFC 8489 Binding Request, no attributes.
|
|
packet.writeUInt32BE(0x2112a442, 4);
|
|
randomBytes(12).copy(packet, 8);
|
|
try {
|
|
await new Promise((resolve, reject) => {
|
|
const timer = setTimeout(() => reject(new Error(`STUN ${port} timed out`)), 2_000);
|
|
const finish = (error) => { clearTimeout(timer); error ? reject(error) : resolve(); };
|
|
socket.once("error", finish);
|
|
socket.once("message", (reply) => {
|
|
try {
|
|
assert.ok(reply.length >= 20);
|
|
assert.equal(reply.readUInt16BE(0), 0x0101);
|
|
assert.deepEqual(reply.subarray(4, 20), packet.subarray(4, 20));
|
|
finish();
|
|
} catch (error) { finish(error); }
|
|
});
|
|
socket.send(packet, port, "127.0.0.1", (error) => { if (error) finish(error); });
|
|
});
|
|
} finally { socket.close(); }
|
|
}
|
|
|
|
copyFileSync(join(root, "deploy/container/compose.yaml"), join(workspace, "compose.yaml"));
|
|
const sample = readFileSync(join(root, "deploy/container/.env.example"), "utf8");
|
|
writeFileSync(join(workspace, ".env"), sample);
|
|
try {
|
|
const metadata = JSON.parse(docker("image", "inspect", image))[0];
|
|
assert.equal(metadata.Config.User, "65532:65532");
|
|
assert.equal(metadata.Config.Labels["org.opencontainers.image.revision"], revision);
|
|
assert.equal(metadata.Os, "linux");
|
|
assert.equal(metadata.Architecture, process.arch === "x64" ? "amd64" : process.arch);
|
|
assert.ok(["amd64", "arm64"].includes(metadata.Architecture));
|
|
assert.match(compose("run", "--rm", "--no-deps", "piik", "--check-config"), /config=ok/);
|
|
compose("up", "-d", "--pull", "never");
|
|
await until(async () => assert.deepEqual(await (await request("/healthz")).json(), { status: "ok" }), "ready");
|
|
await expectServices(false, false);
|
|
assert.equal((await (await request("/api/site-access")).json()).required, false);
|
|
const html = await (await request("/")).text();
|
|
const asset = html.match(/src="(\/assets\/index-[A-Za-z0-9_-]+\.js)"/)?.[1];
|
|
assert.ok(asset, "Server must embed the Web UI");
|
|
const script = await (await request(asset)).text();
|
|
assert.ok(script.includes(revision), "Web and Server must have the same source identity");
|
|
await binding(3478);
|
|
const room = await (await request("/api/rooms", {
|
|
method: "POST", headers: { Origin: "https://share.example.com", "Content-Type": "application/json" },
|
|
body: JSON.stringify({ codeEntryPolicy: "open" }),
|
|
})).json();
|
|
assert.match(room.roomId, /^[1-9][0-9]{3}$/);
|
|
assert.ok(room.hostToken);
|
|
const container = JSON.parse(docker("inspect", compose("ps", "-q", "piik")))[0];
|
|
assert.equal(container.HostConfig.ReadonlyRootfs, true);
|
|
assert.ok(container.HostConfig.CapDrop.includes("ALL"));
|
|
assert.ok(container.HostConfig.SecurityOpt.some((value) => value.startsWith("no-new-privileges")));
|
|
|
|
// Recreate with optional services on the same persistent room volume.
|
|
writeFileSync(join(workspace, ".env"), `${sample}\nSFU_UDP_PORT=7882\nSFU_PUBLIC_IP=127.0.0.1\nNAT_PREDICTION_ENABLED=true\nPIIK_DEBUG=server\n`);
|
|
compose("up", "-d", "--force-recreate", "--pull", "never");
|
|
await until(() => expectServices(true, true), "optional services");
|
|
await request(`/api/rooms/${room.roomId}/access`, {
|
|
method: "POST",
|
|
headers: { Origin: "https://share.example.com", Authorization: `Bearer ${room.hostToken}`, "Content-Type": "application/json" },
|
|
body: JSON.stringify({ action: "set-code-entry-policy", policy: "private" }),
|
|
});
|
|
for (const port of [3478, 3479, 3480]) await binding(port);
|
|
compose("kill", "--signal", "SIGUSR1", "piik");
|
|
const state = join(workspace, "state");
|
|
mkdirSync(state);
|
|
await until(() => {
|
|
compose("cp", "piik:/home/nonroot/.", state);
|
|
assert.ok(readdirSync(join(state, "logs")).some((name) => name.endsWith(".zip")));
|
|
}, "diagnostic export");
|
|
assert.equal(readFileSync(join(state, "rooms.sqlite")).subarray(0, 16).toString(), "SQLite format 3\0");
|
|
compose("stop");
|
|
const stopped = JSON.parse(docker("inspect", compose("ps", "-aq", "piik")))[0];
|
|
assert.equal(stopped.State.ExitCode, 0, "SIGTERM must shut down cleanly");
|
|
process.stdout.write("Container checks passed: P2P, embedded services, room persistence, diagnostics and shutdown.\n");
|
|
} catch (error) {
|
|
try { process.stderr.write(`${compose("logs", "--no-color", "--tail", "60")}\n`); } catch { /* Startup may have failed. */ }
|
|
throw error;
|
|
} finally {
|
|
try { compose("down", "--volumes", "--remove-orphans"); }
|
|
finally { rmSync(workspace, { recursive: true, force: true }); }
|
|
}
|