@openvidstudio/capture 0.0.0-stage → 1.4.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the
+      purposes of this License, Derivative Works shall not include works
+      that remain separable from, or merely link (or bind by name) to the
+      interfaces of, the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Anay Dhawan
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,93 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @openvidstudio/capture
+
+Getting a true frame out of a running product. No Remotion, no React, no video pipeline.
+
+This is the half of [openvidstudio](https://github.com/AnayDhawan/openvidstudio) that is
+hard, and it is useful on its own. If you want reliable captures of your app and you are
+not making a video, take this package and ignore the rest.
+
+## What is in it
+
+**Browser capture that measures the zoom instead of assuming it.** Chrome keeps zoom
+per origin, so `setViewportSize(1600x1000)` can leave you with an effective viewport that
+is not 1600x1000, and every crop rect computed against the requested size is then wrong.
+Nothing errors. `detectAndCompensateZoom` measures `window.innerWidth` live, re-requests a
+compensated size, verifies convergence, and throws rather than proceed with a crop measured
+against the wrong viewport. The ratio is never hardcoded: it differs per machine and per
+profile.
+
+**Interaction replay.** A small declarative `Interaction[]` (click, fill, select, hover,
+scroll, wait) with a zod schema, replayed in array order, so two capture callers cannot
+drift apart in how they drive the page.
+
+**Backends for what a browser cannot reach.** Desktop windows and regions through ffmpeg
+(`gdigrab`, `avfoundation`, `x11grab`, `pipewiregrab`), Android through `adb screenrecord`,
+the iOS Simulator through `simctl io recordVideo`, and terminals through a recorded cast.
+These are pure argv builders plus a thin spawn wrapper, so they are testable without a
+screen attached and safe with argument values containing spaces.
+
+## Install
+
+```bash
+npm install @openvidstudio/capture
+npx playwright install chromium   # browser capture only
+```
+
+`ffmpeg` on PATH is required for the native backends, `adb` for Android, Xcode command
+line tools for the iOS Simulator.
+
+Terminal recording works out of the box through pipes. For a faithful recording, with the
+program's colour and cursor addressing intact, also install `node-pty`:
+
+```bash
+npm install node-pty
+```
+
+It is deliberately not declared as a dependency of any kind here, not even an optional
+peer: package managers install optional peers anyway, and `node-pty` compiles a native
+addon. Requiring everyone to build one in order to record `npm test` is a bad trade. The
+module is loaded at runtime if it is present, and `recordTerminal` reports which mode it
+actually used.
+
+## Use
+
+```ts
+import { launchChromium, detectAndCompensateZoom, replayInteractions } from "@openvidstudio/capture";
+
+const browser = await launchChromium();
+const page = await browser.newPage();
+await page.setViewportSize({ width: 1600, height: 1000 });
+await page.goto("http://localhost:3000");
+
+const { zoom } = await detectAndCompensateZoom(page, { width: 1600, height: 1000 });
+await replayInteractions(page, [{ type: "click", selector: "[data-tour=start]" }]);
+await page.screenshot({ path: "shot.png" });
+await browser.close();
+```
+
+Save it as `capture.mjs`, start an app on `localhost:3000`, and run it. The click targets
+`[data-tour=start]`, so change that selector to one that exists in your app (a missing
+selector fails after a 30 second timeout). `browser.close()` matters: without it the script
+writes `shot.png` and then never exits, because the open browser keeps Node alive.
+
+```bash
+npx playwright install chromium
+node capture.mjs
+```
+
+```ts
+import { buildDesktopCaptureArgs } from "@openvidstudio/capture";
+
+const args = buildDesktopCaptureArgs({
+  platform: "win32",
+  window: "My App",
+  framerate: 30,
+  durationSeconds: 8,
+  outPath: "out.mp4",
+});
+// spawn("ffmpeg", args)
+```
+
+## License
+
+Apache-2.0

package/dist/browser.d.ts

@@ -0,0 +1,161 @@
+import type { Browser, Page } from "playwright";
+import { chromium } from "playwright";
+import type { CursorPoint } from "./cursor";
+import { z } from "zod";
+/**
+ * Shared building blocks for capture_screenshot and capture_screen_recording:
+ * the Interaction type both replay identically, and CAPTURE.md's zoom-desync
+ * detection/compensation math, extracted once so the two tools' protocols
+ * cannot silently drift apart from each other.
+ */
+export interface Viewport {
+    width: number;
+    height: number;
+}
+/** CAPTURE.md's worked example. */
+export declare const DEFAULT_VIEWPORT: Viewport;
+/**
+ * Capture at twice the CSS resolution by default.
+ *
+ * This is the single biggest quality lever in the pipeline and it used to be missing.
+ * A capture taken at 1x is exactly as many pixels as the viewport, and the video then
+ * puts it on a 1920x1080 stage and pushes a camera into it. Every one of those steps
+ * is an upscale, so a 1440x900 capture shown at a 1.33 camera scale is being asked for
+ * roughly 1.8x the pixels it has, and the result is the soft, slightly smeared text
+ * that makes a demo look cheap.
+ *
+ * At 2x there are pixels to spare for both the stage and the push-in, so the frame stays
+ * sharp all the way through. The cost is memory and file size during capture, which is
+ * the right trade for an asset that gets rendered once and watched many times.
+ */
+export declare const DEFAULT_DEVICE_SCALE = 2;
+export declare const viewportSchema: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+}, z.core.$strip>;
+export type Interaction = {
+    type: "click";
+    selector: string;
+} | {
+    type: "fill";
+    selector: string;
+    value: string;
+} | {
+    type: "select";
+    selector: string;
+    value: string;
+} | {
+    type: "hover";
+    selector: string;
+} | {
+    type: "scroll";
+    selector?: string;
+    x?: number;
+    y?: number;
+    durationMs?: number;
+} | {
+    type: "wait";
+    ms?: number;
+    selector?: string;
+} | {
+    type: "settle";
+    ms?: number;
+};
+export declare const interactionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"click">;
+    selector: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"fill">;
+    selector: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"select">;
+    selector: z.ZodString;
+    value: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"hover">;
+    selector: z.ZodString;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"scroll">;
+    selector: z.ZodOptional<z.ZodString>;
+    x: z.ZodOptional<z.ZodNumber>;
+    y: z.ZodOptional<z.ZodNumber>;
+    durationMs: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"wait">;
+    ms: z.ZodOptional<z.ZodNumber>;
+    selector: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"settle">;
+    ms: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>], "type">;
+/**
+ * Replays a beat's interactions in array order. Shared verbatim by both capture
+ * tools so their replay semantics never drift apart -- called after navigation
+ * and (for both tools) after the zoom-desync compensation below, in the same
+ * effective CSS-pixel viewport CAPTURE.md measured.
+ *
+ * Returns every click/hover/fill/select target's real measured center, in replay order,
+ * for capture_screenshot/capture_screen_recording to persist as a cursor sidecar (see
+ * cursor.ts) -- this is what lets scaffold_scene's cursor overlay land on real coordinates
+ * instead of a hand-authored guess.
+ */
+export declare function replayInteractions(page: Page, interactions: Interaction[] | undefined): Promise<CursorPoint[]>;
+export declare const ZOOM_EPSILON = 0.01;
+export interface ZoomCompensation {
+    /** The viewport actually in effect for capture: `target` unchanged, or the compensated size. */
+    viewport: Viewport;
+    /** Measured zoom = target.width / (effective width before compensation). 1 means no desync. */
+    zoom: number;
+    /** The last-measured `[window.innerWidth, window.innerHeight]`. */
+    effective: Viewport;
+}
+/**
+ * Thrown when a single compensation attempt doesn't converge -- CAPTURE.md
+ * doesn't explicitly cover this case (it assumes the desync ratio is
+ * consistent), so this is surfaced as a real error rather than silently
+ * proceeding with a crop rect measured against the wrong effective viewport.
+ */
+export declare class ZoomCompensationError extends Error {
+    readonly target: Viewport;
+    readonly zoom: number;
+    readonly effective: Viewport;
+    constructor(target: Viewport, zoom: number, effective: Viewport);
+}
+/**
+ * CAPTURE.md's zoom-desync detection + compensation (protocol steps 1-2).
+ * Assumes the caller already called `page.setViewportSize(target)` and
+ * `page.goto(...)` -- this only measures and, if needed, re-requests a
+ * compensated viewport and re-verifies once.
+ *
+ * Never hardcodes a zoom constant (CAPTURE.md is explicit the ratio "can
+ * differ per machine/profile") -- it is measured live on every call. If the
+ * one compensation attempt doesn't bring the effective viewport back to
+ * `target` within `ZOOM_EPSILON`, throws `ZoomCompensationError` rather than
+ * silently proceeding.
+ */
+export declare function detectAndCompensateZoom(page: Page, target: Viewport): Promise<ZoomCompensation>;
+/**
+ * Playwright's bundled browser binary is not installed by a plain `npm
+ * install`/`pnpm install` (it needs a separate `npx playwright install
+ * chromium`, deliberately not wired as a postinstall script -- see this
+ * package's README/tool descriptions). Rather than let that surface as a
+ * cryptic native-binary launch error, catch it here and return a clear,
+ * actionable message.
+ */
+export declare function launchChromium(): Promise<Browser>;
+/**
+ * Re-exports the exact `chromium` BrowserType this file already imports from "playwright"
+ * above (the one launchChromium calls .launch() on), so preflight.ts's environment check can
+ * call chromium.executablePath() on the literal same resolution real capture uses, instead of
+ * a second "import playwright" of its own that could resolve a different installed copy
+ * (a different node_modules nesting, or a different PLAYWRIGHT_BROWSERS_PATH-relative build)
+ * and pass preflight while real capture still fails, or the reverse.
+ */
+export { chromium };
+/**
+ * The version of the `chromium` BrowserType re-exported above, read from that same resolved
+ * package rather than a fresh "playwright" lookup, so a report naming this version can never
+ * name a different install than the one executablePath() below actually resolved against.
+ */
+export declare function resolvedPlaywrightVersion(): string;