pup-recorder 0.3.1 → 0.3.3

package/README.md

@@ -7,6 +7,8 @@ pup-recorder — record web pages as video
 ## SYNOPSIS
 
     pup source [-W width] [-H height] [-f fps] [-t duration] [-o file] [-a] [-d]
+               [--disable-gpu] [--disable-hw-codec] [--window-tolerant]
+               [--use-inner-proxy]
 
 ## OPTIONS
 
@@ -14,19 +16,25 @@ pup-recorder — record web pages as video
     -W, --width <number>      default: 1920
     -H, --height <number>     default: 1080
     -f, --fps <number>        default: 30
-    -t, --duration <number>   default: 5
+    -t, --duration <number>   default: 5 (seconds)
     -o, --out-file <path>     default: output.mp4
     -a, --with-audio
-    -d, --deterministic       frame-by-frame rendering mode
-    --use-inner-proxy         use Bilibili inner proxy
+    -d, --deterministic       frame-by-frame via CDP virtual time
+    --use-inner-proxy         Bilibili inner proxy
+    --disable-gpu             force SwiftShader software rendering
+    --disable-hw-codec        software x265 instead of NVENC/VideoToolbox
+    --window-tolerant         accept dom-ready when did-stop-loading hangs
 
 ## ENVIRONMENT
 
-    PUP_LOG_LEVEL              0=error 1=warn 2=info 3=debug (default: 2)
-    PUP_USE_INNER_PROXY        1=on
-    PUP_DISABLE_GPU            1=on
-    PUP_DETERMINISTIC          1=on
-    PUP_EXPERIMENTAL_PUPPETEER 1=on (Linux puppeteer mode)
+    PUP_LOG_LEVEL          0=error 1=warn 2=info 3=debug (default: 2)
+    PUP_USE_INNER_PROXY    1=on
+    PUP_DISABLE_GPU        1=on
+    PUP_DISABLE_HW_CODEC   1=on
+    PUP_DETERMINISTIC      1=on
+    PUP_WINDOW_TOLERANT    1=on
+
+CLI flags override environment variables.
 
 ## API
 
@@ -36,8 +44,10 @@ import { pup } from "pup-recorder";
 const result = await pup(source, {
   width, height, fps, duration, outFile,
   withAudio, deterministic, useInnerProxy,
+  disableGpu, disableHwCodec, windowTolerant,
   signal, onProgress,
 });
+// => { written, jank, outFile, options }
 ```
 
 ## SEE ALSO

package/dist/_tsup-dts-rollup.d.ts

@@ -20,6 +20,7 @@ import { Socket } from 'net';
 import { SoftwareScaleContext } from 'node-av';
 import { SpawnOptions } from 'child_process';
 import { Stream } from 'node-av';
+import { WebFrameMain } from 'electron';
 import z from 'zod';
 
 /** Insert emulation prevention bytes (00 00 03) for Annex B compliance. */
@@ -103,15 +104,6 @@ export declare function buildRust(): Promise<void>;
 
 export declare function buildStegoHTML(targetURL: string, size: Size): string;
 
-/**
- * Builds the JS injector that hooks all time-related globals in the target frame.
- * In Electron/stego mode (default), guards against running in the top-level frame.
- * In Puppeteer mode (skipFrameGuard: true), injects directly into the main document.
- * Must be injected via Page.addScriptToEvaluateOnNewDocument AND directly into
- * already-loaded frames.
- */
-export declare function buildTickInjector(opts?: TickInjectorOptions): string;
-
 export declare function buildUnifiedExtradata(opts: UnifiedExtradataOptions): Buffer;
 
 export declare const canIUseGPU: Promise<boolean>;
@@ -200,12 +192,6 @@ declare const defaultRenderOptions: RenderOptions;
 export { defaultRenderOptions }
 export { defaultRenderOptions as defaultRenderOptions_alias_1 }
 
-export declare function doEject(): string;
-
-export declare function doProcess(timestampMs: number): string;
-
-export declare function doPuppeteer(source: string, options: RenderOptions, onProgress?: (p: number) => void): Promise<IpcDonePayload>;
-
 export declare function drainPackets(ctx: CodecContext, pkt: Packet, stream: Stream, muxer: FormatMuxer): Promise<void>;
 
 export declare function electronOpts(disableGpu: boolean): Promise<string[]>;
@@ -477,6 +463,7 @@ export { periodical as periodical_alias_1 }
 declare interface ProcessHandle {
     process: ChildProcess;
     wait: Promise<void>;
+    kill(): void;
 }
 export { ProcessHandle }
 export { ProcessHandle as ProcessHandle_alias_1 }
@@ -507,10 +494,6 @@ declare const pupDisableHwCodec: boolean;
 export { pupDisableHwCodec }
 export { pupDisableHwCodec as pupDisableHwCodec_alias_1 }
 
-declare const pupExperimentalPuppeteer: boolean;
-export { pupExperimentalPuppeteer }
-export { pupExperimentalPuppeteer as pupExperimentalPuppeteer_alias_1 }
-
 declare const pupIpcSocket: string | undefined;
 export { pupIpcSocket }
 export { pupIpcSocket as pupIpcSocket_alias_1 }
@@ -543,6 +526,10 @@ declare const pupUseInnerProxy: boolean;
 export { pupUseInnerProxy }
 export { pupUseInnerProxy as pupUseInnerProxy_alias_1 }
 
+declare const pupWindowTolerant: boolean;
+export { pupWindowTolerant }
+export { pupWindowTolerant as pupWindowTolerant_alias_1 }
+
 /** Remove emulation prevention bytes (00 00 03 → 00 00) from RBSP. */
 export declare function removeEmulationPrevention(data: Buffer): Buffer;
 
@@ -572,6 +559,7 @@ declare const RenderSchema: z.ZodObject<{
     deterministic: z.ZodBoolean;
     disableGpu: z.ZodBoolean;
     disableHwCodec: z.ZodBoolean;
+    windowTolerant: z.ZodBoolean;
 }, z.core.$strip>;
 export { RenderSchema }
 export { RenderSchema as RenderSchema_alias_1 }
@@ -604,20 +592,17 @@ export { sleep as sleep_alias_1 }
 /** Split Annex B bitstream into NAL units. */
 export declare function splitNalUnits(bitstream: Buffer): NalUnit[];
 
-export declare function startStego(cdp: Debugger): Promise<any>;
+export declare function startStego(frame: WebFrameMain): Promise<void>;
 
-export declare function stopStego(cdp: Debugger): Promise<any>;
+export declare const STEGO_TICK_CHANNEL = "stego-tick";
 
-export declare const TICK_SYMBOL = "__pup_tick__";
+export declare function stopStego(frame: WebFrameMain): Promise<void>;
 
-export declare interface TickInjectorOptions {
-    /**
-     * When true, skips the top-frame guard so the injector runs in the main document.
-     * Required for Puppeteer mode where the page is loaded directly (no stego iframe wrapper).
-     * Default: false (Electron/stego mode — only inject in iframes).
-     */
-    skipFrameGuard?: boolean;
-}
+export declare function swapBuffer(frame: WebFrameMain, expected: number): Promise<void>;
+
+export declare function tick(frame: WebFrameMain | undefined, timestampMs: number): Promise<void>;
+
+export declare const TICK_SYMBOL = "__pup_tick__";
 
 export declare interface UnifiedExtradataOptions {
     baseExtradata: Buffer;
@@ -716,6 +701,7 @@ export declare interface WindowOptions {
     onCreated?: (window: BrowserWindow) => Promise<void>;
     renderer: RenderOptions;
     warmup?: boolean;
+    tolerant?: boolean;
 }
 
 export { }