pup-recorder 0.3.2 → 0.3.4

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

@@ -6,7 +6,7 @@ import { BrowserWindow } from 'electron';
 import { ChildProcess } from 'child_process';
 import { Codec } from 'node-av';
 import { CodecContext } from 'node-av';
-import type { Debugger } from 'electron';
+import { Debugger } from 'electron';
 import { EventEmitter } from 'events';
 import { FFAudioEncoder } from 'node-av/constants';
 import { FFVideoEncoder } from 'node-av/constants';
@@ -16,10 +16,10 @@ import { HardwareContext } from 'node-av/api';
 import type { NativeImage } from 'electron';
 import { Packet } from 'node-av';
 import { Size } from 'electron';
-import { Socket } from 'net';
 import { SoftwareScaleContext } from 'node-av';
 import { SpawnOptions } from 'child_process';
 import { Stream } from 'node-av';
+import type { WebFrameMain } from 'electron';
 import z from 'zod';
 
 /** Insert emulation prevention bytes (00 00 03) for Annex B compliance. */
@@ -103,8 +103,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>;
@@ -157,10 +155,6 @@ declare class ConcurrencyLimiter {
 export { ConcurrencyLimiter }
 export { ConcurrencyLimiter as ConcurrencyLimiter_alias_1 }
 
-export declare function connectIpc(socketPath: string): Promise<IpcWriter>;
-
-export declare function createIpcServer(socketPath: string): Promise<IpcServer>;
-
 export declare function createStegoURL(src: string, size: Size): string;
 
 export declare function createVideoEncoder(opts: VideoFactoryOptions, muxer: FormatMuxer): Promise<VideoSetup>;
@@ -193,9 +187,7 @@ 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 disposeWindow(win: BrowserWindow): Promise<void>;
 
 export declare function drainPackets(ctx: CodecContext, pkt: Packet, stream: Stream, muxer: FormatMuxer): Promise<void>;
 
@@ -315,40 +307,26 @@ export declare interface IpcDonePayload {
 }
 
 export declare const enum IpcMsgType {
-    PROGRESS = 1,
-    DONE = 2,
-    ERROR = 3
+    PROGRESS = "progress",
+    DONE = "done",
+    ERROR = "error"
 }
 
 export declare class IpcReader extends EventEmitter<{
     progress: [value: number];
-    message: [type: IpcMsgType, buffer: Buffer];
+    message: [msg: Msg];
     done: [payload: IpcDonePayload];
     error: [error: Error];
     close: [];
 }> {
-    private readonly _socket;
-    private _chunks;
-    private _buffered;
-    constructor(_socket: Socket);
-    private onData;
-    private flush;
-    private peek;
-    private consume;
-}
-
-export declare interface IpcServer {
-    waitForConnection(): Promise<IpcReader>;
-    close(): void;
+    constructor(child: ChildProcess);
 }
 
 export declare class IpcWriter {
-    private readonly _socket;
-    constructor(_socket: Socket);
     writeProgress(value: number): void;
-    writeError(error: string): void;
-    writeDone(payload: IpcDonePayload): void;
-    private write;
+    writeError(error: string): Promise<void>;
+    writeDone(payload: IpcDonePayload): Promise<void>;
+    private send;
 }
 
 export declare function isEmpty(image: NativeImage): boolean;
@@ -404,6 +382,17 @@ export declare function makeFrame(width: number, height: number, pixFmt: AVPixel
 
 export declare function makePacket(): Packet;
 
+declare type Msg = {
+    type: IpcMsgType.PROGRESS;
+    value: number;
+} | {
+    type: IpcMsgType.DONE;
+    payload: IpcDonePayload;
+} | {
+    type: IpcMsgType.ERROR;
+    error: string;
+};
+
 export declare const NAL_HEADER_SIZE = 2;
 
 export declare interface NalUnit {
@@ -468,6 +457,7 @@ export { periodical as periodical_alias_1 }
 declare interface ProcessHandle {
     process: ChildProcess;
     wait: Promise<void>;
+    get killed(): boolean;
     kill(): void;
 }
 export { ProcessHandle }
@@ -499,10 +489,6 @@ declare const pupDisableHwCodec: boolean;
 export { pupDisableHwCodec }
 export { pupDisableHwCodec as pupDisableHwCodec_alias_1 }
 
-declare const pupIpcSocket: string | undefined;
-export { pupIpcSocket }
-export { pupIpcSocket as pupIpcSocket_alias_1 }
-
 declare const pupLogLevel: number;
 export { pupLogLevel }
 export { pupLogLevel as pupLogLevel_alias_1 }
@@ -569,6 +555,8 @@ declare const RenderSchema: z.ZodObject<{
 export { RenderSchema }
 export { RenderSchema as RenderSchema_alias_1 }
 
+export declare function resizeDrawable(cdp: Debugger, size: Size): Promise<void>;
+
 declare interface RetryOptions<Args extends any[], Ret> {
     fn: (...args: Args) => Promise<Ret>;
     maxAttempts?: number;
@@ -580,7 +568,12 @@ export { RetryOptions as RetryOptions_alias_1 }
 /** Rewrite nuh_layer_id in a NAL unit (returns copy). */
 export declare function rewriteNalLayerId(nal: Buffer, layerId: number): Buffer;
 
-export declare function runElectronApp(size: Size, args: unknown[], ipcSocketPath: string): Promise<ProcessHandle>;
+export declare function runElectronApp({ args, display }: RunElectronAppOptions): Promise<ProcessHandle>;
+
+export declare interface RunElectronAppOptions {
+    args: unknown[];
+    display?: number;
+}
 
 export declare function setInterceptor({ source, window, useInnerProxy }: NetworkOptions): void;
 
@@ -590,6 +583,8 @@ export declare function setupPupProtocol(): void;
 
 export declare function shoot(writer: IpcWriter, source: string, options: RenderOptions): Promise<IpcDonePayload>;
 
+export declare function sizeEquals(a: Size, b: Size): boolean;
+
 declare function sleep(ms: number): Promise<void>;
 export { sleep }
 export { sleep as sleep_alias_1 }
@@ -597,15 +592,21 @@ 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 startElectronCrashReporter(): void;
+
+export declare function startStego(cdp: Debugger): Promise<void>;
+
+export declare function startXvfb(width: number, height: number): XvfbHandle;
 
 export declare const STEGO_TICK_CHANNEL = "stego-tick";
 
-export declare function stopStego(cdp: Debugger): Promise<any>;
+export declare function stopStego(cdp: Debugger): Promise<void>;
 
-export declare const TICK_SYMBOL = "__pup_tick__";
+export declare function swapBuffer(cdp: Debugger, 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;
@@ -707,4 +708,9 @@ export declare interface WindowOptions {
     tolerant?: boolean;
 }
 
+export declare interface XvfbHandle {
+    display: number;
+    stop(): void;
+}
+
 export { }