pup-recorder 0.3.2 → 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,8 +104,6 @@ export declare function buildRust(): Promise<void>;
 
 export declare function buildStegoHTML(targetURL: string, size: Size): string;
 
-export declare function buildTickInjector(): string;
-
 export declare function buildUnifiedExtradata(opts: UnifiedExtradataOptions): Buffer;
 
 export declare const canIUseGPU: Promise<boolean>;
@@ -193,10 +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 drainPackets(ctx: CodecContext, pkt: Packet, stream: Stream, muxer: FormatMuxer): Promise<void>;
 
 export declare function electronOpts(disableGpu: boolean): Promise<string[]>;
@@ -597,15 +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 const STEGO_TICK_CHANNEL = "stego-tick";
 
-export declare function stopStego(cdp: Debugger): Promise<any>;
+export declare function stopStego(frame: WebFrameMain): Promise<void>;
 
-export declare const TICK_SYMBOL = "__pup_tick__";
+export declare function swapBuffer(frame: WebFrameMain, expected: number): Promise<void>;
+
+export declare function tick(frame: WebFrameMain | undefined, timestampMs: number): Promise<void>;
 
-export declare function tickStego(cdp: Debugger, ms: number): Promise<any>;
+export declare const TICK_SYMBOL = "__pup_tick__";
 
 export declare interface UnifiedExtradataOptions {
     baseExtradata: Buffer;