@uploadfilm/sdk 0.0.0-stage → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (267) hide show
  1. package/LICENSE +4 -0
  2. package/README.md +529 -2
  3. package/dist/ai/embed.d.ts +58 -0
  4. package/dist/ai/fake.d.ts +41 -0
  5. package/dist/ai/http.d.ts +17 -0
  6. package/dist/ai/index.d.ts +27 -0
  7. package/dist/ai/languages.d.ts +2 -0
  8. package/dist/ai/ollama.d.ts +23 -0
  9. package/dist/ai/openaiCompatible.d.ts +54 -0
  10. package/dist/ai/passages.d.ts +28 -0
  11. package/dist/ai/transcribe.d.ts +84 -0
  12. package/dist/ai/types.d.ts +141 -0
  13. package/dist/ai/usage.d.ts +66 -0
  14. package/dist/ai/whisperJson.d.ts +15 -0
  15. package/dist/ai/workersAi.d.ts +56 -0
  16. package/dist/ai.js +1 -0
  17. package/dist/ai.mjs +1 -0
  18. package/dist/cards/files.d.ts +91 -0
  19. package/dist/cards/index.d.ts +15 -0
  20. package/dist/cards/layouts.d.ts +121 -0
  21. package/dist/cards/probe.d.ts +69 -0
  22. package/dist/cards/proxies.d.ts +70 -0
  23. package/dist/cards/select.d.ts +68 -0
  24. package/dist/cards/volumes.d.ts +170 -0
  25. package/dist/cards/xml.d.ts +80 -0
  26. package/dist/cards.js +1 -0
  27. package/dist/cards.mjs +1 -0
  28. package/dist/copy/checksums.d.ts +66 -0
  29. package/dist/copy/engine.d.ts +24 -0
  30. package/dist/copy/errors.d.ts +109 -0
  31. package/dist/copy/index.d.ts +15 -0
  32. package/dist/copy/steps.d.ts +28 -0
  33. package/dist/copy/sweep.d.ts +24 -0
  34. package/dist/copy/types.d.ts +363 -0
  35. package/dist/embed/player.js +2 -0
  36. package/dist/host/adapters.d.ts +107 -0
  37. package/dist/host/detect.d.ts +68 -0
  38. package/dist/host/encoders.d.ts +34 -0
  39. package/dist/host/environment.d.ts +53 -0
  40. package/dist/host/index.d.ts +20 -0
  41. package/dist/host/linux.d.ts +94 -0
  42. package/dist/host/mac.d.ts +47 -0
  43. package/dist/host/network.d.ts +54 -0
  44. package/dist/host/node.d.ts +13 -0
  45. package/dist/host/policy.d.ts +101 -0
  46. package/dist/host/tuner.d.ts +48 -0
  47. package/dist/host/types.d.ts +118 -0
  48. package/dist/host-node.js +1 -0
  49. package/dist/host-node.mjs +1 -0
  50. package/dist/host.js +1 -0
  51. package/dist/host.mjs +1 -0
  52. package/dist/images/index.d.ts +11 -0
  53. package/dist/images/settings.d.ts +43 -0
  54. package/dist/images/types.d.ts +83 -0
  55. package/dist/images/url.d.ts +65 -0
  56. package/dist/index.d.ts +16 -0
  57. package/dist/index.js +1 -0
  58. package/dist/index.mjs +1 -0
  59. package/dist/player/adapters/hlsjs.d.ts +28 -0
  60. package/dist/player/bandwidthMemory.d.ts +28 -0
  61. package/dist/player/captions/index.d.ts +55 -0
  62. package/dist/player/embed/code.d.ts +195 -0
  63. package/dist/player/embed/constants.d.ts +4 -0
  64. package/dist/player/embed/controller.d.ts +62 -0
  65. package/dist/player/embed/element.d.ts +32 -0
  66. package/dist/player/embed/frame.d.ts +65 -0
  67. package/dist/player/embed/global.d.ts +14 -0
  68. package/dist/player/embed/index.d.ts +15 -0
  69. package/dist/player/embed/loader.d.ts +1 -0
  70. package/dist/player/embed/oembed.d.ts +74 -0
  71. package/dist/player/embed/protocol.d.ts +64 -0
  72. package/dist/player/engine.d.ts +215 -0
  73. package/dist/player/index.d.ts +18 -0
  74. package/dist/player/start.d.ts +62 -0
  75. package/dist/player/store.d.ts +10 -0
  76. package/dist/player/storyboard/index.d.ts +161 -0
  77. package/dist/player/stream.d.ts +206 -0
  78. package/dist/player/tracks.d.ts +41 -0
  79. package/dist/player.js +1 -0
  80. package/dist/player.mjs +1 -0
  81. package/dist/proxies/args.d.ts +19 -0
  82. package/dist/proxies/budget.d.ts +57 -0
  83. package/dist/proxies/camera.d.ts +104 -0
  84. package/dist/proxies/formats.d.ts +36 -0
  85. package/dist/proxies/index.d.ts +18 -0
  86. package/dist/proxies/jobs.d.ts +98 -0
  87. package/dist/proxies/node.d.ts +32 -0
  88. package/dist/proxies/plan.d.ts +89 -0
  89. package/dist/proxies/probe.d.ts +39 -0
  90. package/dist/proxies/render.d.ts +104 -0
  91. package/dist/proxies/safety.d.ts +45 -0
  92. package/dist/proxies/types.d.ts +83 -0
  93. package/dist/proxies/upload.d.ts +14 -0
  94. package/dist/react/BigPlay.d.ts +26 -0
  95. package/dist/react/Player.d.ts +58 -0
  96. package/dist/react/embed/index.d.ts +45 -0
  97. package/dist/react/examples/CustomControls.d.ts +8 -0
  98. package/dist/react/images/Image.d.ts +16 -0
  99. package/dist/react/images/index.d.ts +4 -0
  100. package/dist/react/images/useImage.d.ts +47 -0
  101. package/dist/react/index.d.ts +17 -0
  102. package/dist/react/storyboard/index.d.ts +58 -0
  103. package/dist/react/theme.d.ts +37 -0
  104. package/dist/react/useAdapterErrors.d.ts +8 -0
  105. package/dist/react/usePlaybackStart.d.ts +18 -0
  106. package/dist/react/usePlayer.d.ts +28 -0
  107. package/dist/react/useReducedMotion.d.ts +2 -0
  108. package/dist/react/useTimedTrack.d.ts +22 -0
  109. package/dist/react.js +1 -0
  110. package/dist/react.mjs +1 -0
  111. package/dist/server/auth/apiKeys.d.ts +30 -0
  112. package/dist/server/auth/cache.d.ts +21 -0
  113. package/dist/server/auth/deviceTokens.d.ts +38 -0
  114. package/dist/server/auth/envelope.d.ts +15 -0
  115. package/dist/server/auth/grants.d.ts +76 -0
  116. package/dist/server/auth/index.d.ts +19 -0
  117. package/dist/server/auth/jwt.d.ts +65 -0
  118. package/dist/server/auth/keyring.d.ts +31 -0
  119. package/dist/server/auth/kv.d.ts +12 -0
  120. package/dist/server/auth/repository.d.ts +45 -0
  121. package/dist/server/auth/revocations.d.ts +21 -0
  122. package/dist/server/auth/scope.d.ts +4 -0
  123. package/dist/server/auth/serviceAuth.d.ts +24 -0
  124. package/dist/server/auth/signedUrls.d.ts +28 -0
  125. package/dist/server/embed/index.d.ts +36 -0
  126. package/dist/server/embed/lifecycle.d.ts +53 -0
  127. package/dist/server/embed/playerScript.d.ts +4 -0
  128. package/dist/server/images/index.d.ts +15 -0
  129. package/dist/server/images/job.d.ts +80 -0
  130. package/dist/server/images/layout.d.ts +24 -0
  131. package/dist/server/images/params.d.ts +90 -0
  132. package/dist/server/images/route.d.ts +101 -0
  133. package/dist/server/images/sign.d.ts +55 -0
  134. package/dist/server/index.d.ts +42 -0
  135. package/dist/server/media/client.d.ts +99 -0
  136. package/dist/server/media/frameCheck.d.ts +62 -0
  137. package/dist/server/media/index.d.ts +10 -0
  138. package/dist/server/media/protocol.d.ts +556 -0
  139. package/dist/server/media/storyboard.d.ts +144 -0
  140. package/dist/server/media/transcript.d.ts +143 -0
  141. package/dist/server/pipeline/index.d.ts +12 -0
  142. package/dist/server/pipeline/match.d.ts +10 -0
  143. package/dist/server/pipeline/pipeline.d.ts +182 -0
  144. package/dist/server/pipeline/queues.d.ts +108 -0
  145. package/dist/server/pipeline/sources.d.ts +54 -0
  146. package/dist/server/r2/client.d.ts +164 -0
  147. package/dist/server/r2/crc32.d.ts +24 -0
  148. package/dist/server/r2/encoding.d.ts +35 -0
  149. package/dist/server/r2/errors.d.ts +9 -0
  150. package/dist/server/r2/integrity.d.ts +25 -0
  151. package/dist/server/r2/parts.d.ts +46 -0
  152. package/dist/server/r2/sign.d.ts +47 -0
  153. package/dist/server/redis/index.d.ts +39 -0
  154. package/dist/server/state/memory.d.ts +18 -0
  155. package/dist/server/state/r2.d.ts +73 -0
  156. package/dist/server/state/types.d.ts +57 -0
  157. package/dist/server/storage/chunked.d.ts +25 -0
  158. package/dist/server/storage/index.d.ts +12 -0
  159. package/dist/server/storage/r2.d.ts +96 -0
  160. package/dist/server/storage/s3.d.ts +144 -0
  161. package/dist/server/testing/fake-r2.d.ts +410 -0
  162. package/dist/server/testing/index.d.ts +10 -0
  163. package/dist/server/testing/kv-contract.d.ts +14 -0
  164. package/dist/server/transfer/handler.d.ts +217 -0
  165. package/dist/server/transfer/keys.d.ts +45 -0
  166. package/dist/server/transfer/protocol.d.ts +190 -0
  167. package/dist/server/zip/client.d.ts +32 -0
  168. package/dist/server/zip/generations.d.ts +83 -0
  169. package/dist/server/zip/index.d.ts +12 -0
  170. package/dist/server/zip/planner.d.ts +94 -0
  171. package/dist/server/zip/sign.d.ts +22 -0
  172. package/dist/server-media.js +1 -0
  173. package/dist/server-media.mjs +1 -0
  174. package/dist/server-redis.js +1 -0
  175. package/dist/server-redis.mjs +1 -0
  176. package/dist/server-testing.js +1 -0
  177. package/dist/server-testing.mjs +1 -0
  178. package/dist/server.js +1 -0
  179. package/dist/server.mjs +1 -0
  180. package/dist/storage/browserFile.d.ts +19 -0
  181. package/dist/storage/index.d.ts +12 -0
  182. package/dist/storage/local.d.ts +9 -0
  183. package/dist/storage/presigned.d.ts +22 -0
  184. package/dist/sync/ffmpeg.d.ts +44 -0
  185. package/dist/sync/index.d.ts +17 -0
  186. package/dist/sync/match.d.ts +28 -0
  187. package/dist/sync/probe.d.ts +30 -0
  188. package/dist/sync/timecode.d.ts +50 -0
  189. package/dist/sync/transcript.d.ts +35 -0
  190. package/dist/sync/types.d.ts +172 -0
  191. package/dist/sync/waveform.d.ts +89 -0
  192. package/dist/sync.js +1 -0
  193. package/dist/sync.mjs +1 -0
  194. package/dist/transfer/claims.d.ts +41 -0
  195. package/dist/transfer/client.d.ts +267 -0
  196. package/dist/transfer/download.d.ts +192 -0
  197. package/dist/transfer/engine.d.ts +402 -0
  198. package/dist/transfer/errors.d.ts +50 -0
  199. package/dist/transfer/growing/bytes.d.ts +17 -0
  200. package/dist/transfer/growing/index.d.ts +12 -0
  201. package/dist/transfer/growing/parts.d.ts +157 -0
  202. package/dist/transfer/growing/retry.d.ts +38 -0
  203. package/dist/transfer/growing/store.d.ts +66 -0
  204. package/dist/transfer/growing/upload.d.ts +126 -0
  205. package/dist/transfer/index.d.ts +40 -0
  206. package/dist/transfer/integrity.d.ts +93 -0
  207. package/dist/transfer/limits.d.ts +34 -0
  208. package/dist/transfer/node.d.ts +63 -0
  209. package/dist/transfer/pool.d.ts +83 -0
  210. package/dist/transfer/protocol.d.ts +172 -0
  211. package/dist/transfer/signer.d.ts +29 -0
  212. package/dist/transfer/storage.d.ts +135 -0
  213. package/dist/transfer/timing.d.ts +132 -0
  214. package/dist/transfer/transports/electronNet.d.ts +62 -0
  215. package/dist/transfer/transports/fetch.d.ts +15 -0
  216. package/dist/transfer/transports/retryAfter.d.ts +12 -0
  217. package/dist/transfer/transports/undici.d.ts +72 -0
  218. package/dist/transfer/tuner.d.ts +56 -0
  219. package/dist/workers/cli.mjs +115 -0
  220. package/dist/workers/media/config.mjs +53 -0
  221. package/dist/workers/media/container/Dockerfile +19 -0
  222. package/dist/workers/media/container/FFMPEG.md +129 -0
  223. package/dist/workers/media/container/runner.mjs +2690 -0
  224. package/dist/workers/media/index.mjs +1011 -0
  225. package/dist/workers/media/init/config.ts +52 -0
  226. package/dist/workers/media/init/worker.ts +8 -0
  227. package/dist/workers/media/init/wrangler.toml +44 -0
  228. package/dist/workers/media/runner.mjs +2656 -0
  229. package/dist/workers/media/types/build/entry/config.d.mts +6 -0
  230. package/dist/workers/media/types/build/entry/index.d.mts +43 -0
  231. package/dist/workers/media/types/build/entry/program.d.mts +13 -0
  232. package/dist/workers/media/types/build/entry/runner.d.mts +12 -0
  233. package/dist/workers/media/types/build/entry/settings.d.mts +40 -0
  234. package/dist/workers/media/types/src/config.d.mts +135 -0
  235. package/dist/workers/media/types/src/jobs.d.mts +73 -0
  236. package/dist/workers/media/types/src/runner/container.d.mts +32 -0
  237. package/dist/workers/media/types/src/runner/ffmpeg.d.mts +227 -0
  238. package/dist/workers/media/types/src/runner/job.d.mts +107 -0
  239. package/dist/workers/media/types/src/runner/node.d.mts +71 -0
  240. package/dist/workers/media/types/src/runner/plugins.d.mts +45 -0
  241. package/dist/workers/media/types/src/serve.d.mts +107 -0
  242. package/dist/workers/media/types/src/steps/audio.d.mts +33 -0
  243. package/dist/workers/media/types/src/steps/edit.d.mts +62 -0
  244. package/dist/workers/media/types/src/steps/frameCheck.d.mts +44 -0
  245. package/dist/workers/media/types/src/steps/gate.d.mts +18 -0
  246. package/dist/workers/media/types/src/steps/paths.d.mts +1 -0
  247. package/dist/workers/media/types/src/steps/prep.d.mts +60 -0
  248. package/dist/workers/media/types/src/steps/render.d.mts +40 -0
  249. package/dist/workers/media/types/src/steps/runner.d.mts +30 -0
  250. package/dist/workers/media/types/src/steps/transcribe.d.mts +89 -0
  251. package/dist/workers/media/types/src/storyboard/index.d.mts +61 -0
  252. package/dist/workers/media/types/src/transcoder.d.mts +30 -0
  253. package/dist/workers/media/types/src/worker.d.mts +30 -0
  254. package/dist/workers/zip/index.mjs +589 -0
  255. package/dist/workers/zip/init/config.ts +22 -0
  256. package/dist/workers/zip/init/worker.ts +5 -0
  257. package/dist/workers/zip/init/wrangler.toml +25 -0
  258. package/dist/workers/zip/types/build/entry/index.d.mts +5 -0
  259. package/dist/workers/zip/types/src/config.d.mts +35 -0
  260. package/dist/workers/zip/types/src/serve.d.mts +86 -0
  261. package/dist/workers/zip/types/src/worker.d.mts +12 -0
  262. package/dist/zip/index.d.ts +13 -0
  263. package/dist/zip/layout.d.ts +129 -0
  264. package/dist/zip/names.d.ts +34 -0
  265. package/dist/zip/plan.d.ts +115 -0
  266. package/dist/zip/sw.d.ts +7 -0
  267. package/package.json +313 -4
@@ -0,0 +1,56 @@
1
+ /**
2
+ * Connection tuners (gap 5): how many requests to run at once, decided from measured throughput.
3
+ *
4
+ * - createTuner (policy "uploadfilm", the engine core's own): slow start (double while throughput still gains ≥ 10%),
5
+ * then hill-climb in steps of 2 (turn around when a move cost > 5%; stop adding at ≥ 12 when flat within 3%), never
6
+ * outside [min, max]. Errors only cut it when they cluster: 3 within ERROR_BURST_WINDOW_MS → ×0.7 (and climbing
7
+ * waits TUNE_SETTLE_AFTER_ERROR_MS). It doesn't judge while fewer than target − 1 requests run (not enough work).
8
+ * - createHalvingTuner (policy "halve-on-error", SuperBuilder cloud-transfer's PartPool): every tuneIntervalMs, ±1
9
+ * from the measured rate (turn around below 95%, step down when ≤ 103%), only while work is queued; every
10
+ * retryable error halves it and holds it for errorCooldownMs.
11
+ *
12
+ * Both are plain state machines: the caller feeds them rates/bytes and errors, and reads `target`.
13
+ */
14
+ import type { TransferTiming } from "./timing";
15
+ export interface TunerBounds {
16
+ min?: number;
17
+ max?: number;
18
+ start?: number;
19
+ }
20
+ /** The engine core's tuner. `now` and the timing table are read live (tests warp them). */
21
+ export declare function createTuner(o: TunerBounds & {
22
+ now: () => number;
23
+ timing: TransferTiming;
24
+ }): {
25
+ readonly target: number;
26
+ readonly pinned: number | null;
27
+ /** One tuning step from the current smoothed `rate` (bytes/s) with `active` requests running. */
28
+ tune(rate: number, active: number): void;
29
+ /**
30
+ * New bounds (already checked: limits.ts sanitizeLimits), applied at once: the target is clamped into them unless
31
+ * pinned; `start` only counts before the first step.
32
+ */
33
+ setBounds(b: {
34
+ min: number;
35
+ max: number;
36
+ start?: number;
37
+ }): void;
38
+ /** A request failed (any error). */
39
+ onError(): void;
40
+ /** Hold the target at `n` (null: tune again). */
41
+ pin(n: number | null): void;
42
+ };
43
+ export type Tuner = ReturnType<typeof createTuner>;
44
+ /** cloud-transfer's PartPool tuner. */
45
+ export declare function createHalvingTuner(o: TunerBounds & {
46
+ tuneIntervalMs: number;
47
+ errorCooldownMs: number;
48
+ now?: () => number;
49
+ }): {
50
+ readonly target: number;
51
+ /** `bytes` more were sent; `queued`: work is waiting (only then is the target moved). */
52
+ sample(n: number, queued: boolean, at?: number): void;
53
+ /** A retryable failure: halve, and hold for errorCooldownMs. */
54
+ onError(): void;
55
+ };
56
+ export type HalvingTuner = ReturnType<typeof createHalvingTuner>;
@@ -0,0 +1,115 @@
1
+ #!/usr/bin/env node
2
+ // The @uploadfilm/sdk command (bin "uploadfilm-sdk"; shipped as dist/workers/cli.mjs, from sdks/workers/cli.mjs):
3
+ //
4
+ // npx @uploadfilm/sdk init media-worker [dir] [--force]
5
+ // npx @uploadfilm/sdk init zip-worker [dir] [--force]
6
+ // write worker.ts, config.ts and wrangler.toml into dir (default: the current folder). Never overwrites a file
7
+ // unless --force is given. The media Worker's wrangler.toml image path is written relative to dir.
8
+ // npx @uploadfilm/sdk media-worker runner --queue <url> [--once] [--work <dir>] [--version <settings version>]
9
+ // the self-hosted runner (RUNNER_TOKEN in the env): jobs from your queue, on this machine's FFmpeg.
10
+ import { copyFileSync, existsSync, mkdirSync, readFileSync, realpathSync, writeFileSync } from "node:fs";
11
+ import { dirname, join, relative, resolve, sep } from "node:path";
12
+
13
+ const NAME = "@uploadfilm/sdk";
14
+ const FILES = ["worker.ts", "config.ts", "wrangler.toml"];
15
+ const WORKERS = {
16
+ "media-worker": { dir: "media", what: "your media Worker" },
17
+ "zip-worker": { dir: "zip", what: "your zip download Worker" },
18
+ };
19
+ const args = process.argv.slice(2);
20
+ const words = args.filter((a) => !a.startsWith("-"));
21
+ const force = args.includes("--force");
22
+ const USAGE = `usage: npx ${NAME} init media-worker [dir] [--force] writes ${FILES.join(", ")} for your media Worker
23
+ npx ${NAME} init zip-worker [dir] [--force] writes ${FILES.join(", ")} for your zip download Worker
24
+ npx ${NAME} media-worker runner --queue <url> [--once] [--work <dir>] [--version <v>] the self-hosted runner`;
25
+
26
+ if (words[0] === "media-worker" && words[1] === "runner") {
27
+ const { pullLoop, RUNNER_DEFAULT_VERSION } = await import("./media/runner.mjs");
28
+ const { ladderSettings } = await import("@uploadfilm/sdk/server/media");
29
+ const usage = () => {
30
+ console.error(`usage: npx ${NAME} media-worker runner --queue <url> [--once] [--work <dir>] [--version <settings version>]`);
31
+ process.exit(2);
32
+ };
33
+ // An option's value is the next argument, never another option (`--queue --once` with an unset variable is an error,
34
+ // not a queue named "--once" that runs nothing and exits 0).
35
+ const arg = (name) => {
36
+ const i = args.indexOf(`--${name}`);
37
+ if (i < 0) return undefined;
38
+ const v = args[i + 1];
39
+ if (v === undefined || v.startsWith("-") || !v) usage();
40
+ return v;
41
+ };
42
+ const queue = arg("queue");
43
+ const isUrl = (s) => {
44
+ try {
45
+ return ["http:", "https:"].includes(new URL(s).protocol);
46
+ } catch {
47
+ return false;
48
+ }
49
+ };
50
+ if (!queue || !isUrl(queue)) usage();
51
+ const ac = new AbortController();
52
+ for (const sig of ["SIGTERM", "SIGINT"])
53
+ process.on(sig, () => {
54
+ ac.abort();
55
+ process.exit(0);
56
+ });
57
+ const n = await pullLoop({ queue, token: process.env.RUNNER_TOKEN, ladder: ladderSettings(arg("version") ?? process.env.MEDIA_VERSION ?? RUNNER_DEFAULT_VERSION), workDir: arg("work"), once: args.includes("--once"), signal: ac.signal });
58
+ console.log(`runner: ${n} job(s) run`);
59
+ process.exit(0);
60
+ }
61
+
62
+ const worker = WORKERS[words[1]];
63
+ if (words[0] !== "init" || !worker) {
64
+ if (words.length) {
65
+ console.error(USAGE);
66
+ process.exit(2);
67
+ }
68
+ console.log(USAGE);
69
+ process.exit(0);
70
+ }
71
+ const dir = resolve(words[2] ?? ".");
72
+ const from = resolve(import.meta.dirname, worker.dir, "init");
73
+ const clash = FILES.filter((f) => existsSync(join(dir, f)));
74
+ if (clash.length && !force) {
75
+ console.error(`${NAME} init ${words[1]}: ${clash.join(", ")} already exist in ${dir} (nothing written; --force overwrites)`);
76
+ process.exit(1);
77
+ }
78
+ mkdirSync(dir, { recursive: true });
79
+ for (const f of FILES) copyFileSync(join(from, f), join(dir, f));
80
+
81
+ if (words[1] === "media-worker") {
82
+ // wrangler resolves `image` from wrangler.toml's folder: point it at the package as installed, seen from dir. The
83
+ // nearest node_modules/@uploadfilm/sdk above dir (a stable path across upgrades), else this package itself.
84
+ const DOCKERFILE = "node_modules/@uploadfilm/sdk/dist/workers/media/container/Dockerfile";
85
+ let up = dir;
86
+ let found = null;
87
+ for (;;) {
88
+ if (existsSync(join(up, DOCKERFILE))) {
89
+ found = join(up, DOCKERFILE);
90
+ break;
91
+ }
92
+ if (dirname(up) === up) break;
93
+ up = dirname(up);
94
+ }
95
+ const target = found ?? join(realpathSync(import.meta.dirname), "media/container/Dockerfile");
96
+ let rel = relative(dir, target).split(sep).join("/");
97
+ if (!rel.startsWith(".")) rel = `./${rel}`;
98
+ const toml = join(dir, "wrangler.toml");
99
+ writeFileSync(toml, readFileSync(toml, "utf8").replace(/^image = ".*"$/m, `image = "${rel}"`));
100
+ console.log(`${NAME} init media-worker: wrote ${FILES.join(", ")} in ${dir}
101
+
102
+ Next:
103
+ 1. EDIT config.ts (callback URL, grant salt, key layout) and wrangler.toml (name, bucket, max_instances)
104
+ 2. npm install @cloudflare/containers@^0.3.7 @cloudflare/workers-types (optional peers of ${NAME}, for the media Worker)
105
+ 3. npx wrangler secret put MEDIA_SECRET
106
+ 4. set a Cloudflare budget alert (containers bill per running second)
107
+ 5. npx wrangler deploy`);
108
+ } else {
109
+ console.log(`${NAME} init zip-worker: wrote ${FILES.join(", ")} in ${dir}
110
+
111
+ Next:
112
+ 1. EDIT config.ts (key layout, domain tags, key policy) and wrangler.toml (name, route, bucket)
113
+ 2. npx wrangler secret put ZIP_SIGNING_KEY
114
+ 3. npx wrangler deploy`);
115
+ }
@@ -0,0 +1,53 @@
1
+ // ../media-worker/build/out/stage/src/config.ts
2
+ import { DEFAULT_STEP_SETTINGS, jobVersion } from "@uploadfilm/sdk/server/media";
3
+ var DEFAULT_BINDINGS = {
4
+ bucket: "BUCKET",
5
+ secret: "MEDIA_SECRET",
6
+ transcoder: "TRANSCODER",
7
+ keyPrefix: "KEY_PREFIX",
8
+ paused: "STREAM_PAUSED",
9
+ allowLocalCallback: "ALLOW_LOCAL_CALLBACK"
10
+ };
11
+ var DEFAULT_TIMING = {
12
+ jobTimeoutMs: 3 * 36e5,
13
+ queueTimeoutMs: 3 * 36e5,
14
+ heartbeatS: 30,
15
+ maxStarts: 3,
16
+ imageRetryS: 300,
17
+ maxStaleStarts: 6,
18
+ reportTries: 20,
19
+ sleepAfter: "3m"
20
+ };
21
+ var segmentNamesOf = (l) => [l.segmentName, ...l.legacySegmentNames ?? []];
22
+ var stepSettingsOf = (cfg) => cfg.stepSettings ?? DEFAULT_STEP_SETTINGS;
23
+ var versionFor = (cfg, steps) => jobVersion(cfg.ladder.version, steps, stepSettingsOf(cfg));
24
+
25
+ // ../media-worker/build/out/stage/build/entry/settings.ts
26
+ var SETTINGS_ENV = "UPLOADFILM_MEDIA_SETTINGS";
27
+ function settingsEnv(cfg, pkg) {
28
+ const s = { v: 1, pkg, ladder: cfg.ladder, defaultSteps: cfg.steps.default, ...cfg.stepSettings ? { stepSettings: cfg.stepSettings } : {} };
29
+ return JSON.stringify(s);
30
+ }
31
+ function readSettings(raw, imagePkg) {
32
+ if (!raw) return { error: `${SETTINGS_ENV} is not set: start this image from @uploadfilm/sdk/workers/media's Transcoder` };
33
+ let s;
34
+ try {
35
+ s = JSON.parse(raw);
36
+ } catch {
37
+ return { error: `${SETTINGS_ENV} is not JSON` };
38
+ }
39
+ if (s.v !== 1 || typeof s.pkg !== "string" || !s.ladder || typeof s.ladder.version !== "string" || !Array.isArray(s.ladder.rungs) || !Array.isArray(s.defaultSteps))
40
+ return { error: `${SETTINGS_ENV} has an unknown shape` };
41
+ const ladder = s.pkg === imagePkg ? s.ladder : { ...s.ladder, version: `${s.ladder.version} (image ${imagePkg}, Worker ${s.pkg})` };
42
+ return { ladder, defaultSteps: s.defaultSteps, ...s.stepSettings ? { stepSettings: s.stepSettings } : {} };
43
+ }
44
+ export {
45
+ DEFAULT_BINDINGS,
46
+ DEFAULT_TIMING,
47
+ SETTINGS_ENV,
48
+ readSettings,
49
+ segmentNamesOf,
50
+ settingsEnv,
51
+ stepSettingsOf,
52
+ versionFor
53
+ };
@@ -0,0 +1,19 @@
1
+ # @uploadfilm/sdk/workers/media 0.2.0: the media worker's container. Node + a pinned FFmpeg + the runner (runner.mjs).
2
+ # The build context is this folder (wrangler's default: the Dockerfile's directory), so in wrangler.toml:
3
+ # image = "./node_modules/@uploadfilm/sdk/dist/workers/media/container/Dockerfile"
4
+ # Nothing product-specific is baked in: the Worker passes your ladder and step settings when it starts a container.
5
+ # PINNED: base image by digest, FFmpeg by version from a dated Debian snapshot (FFMPEG.md records the build).
6
+ FROM node:24.22.3-trixie-slim@sha256:af02d57b57719b9657a45199a79264a9437940cd55b3c7b3fc99615654f124a0
7
+ ARG DEBIAN_SNAPSHOT=20261114T000000Z
8
+ ARG FFMPEG_VERSION=7:7.1.5-0+deb13u1
9
+ RUN rm -f /etc/apt/sources.list.d/debian.sources \
10
+ && printf 'deb [check-valid-until=no] http://snapshot.debian.org/archive/debian/%s trixie main\ndeb [check-valid-until=no] http://snapshot.debian.org/archive/debian/%s trixie-updates main\ndeb [check-valid-until=no] http://snapshot.debian.org/archive/debian-security/%s trixie-security main\n' "$DEBIAN_SNAPSHOT" "$DEBIAN_SNAPSHOT" "$DEBIAN_SNAPSHOT" > /etc/apt/sources.list \
11
+ && apt-get -o Acquire::Retries=5 update \
12
+ && apt-get install -y --no-install-recommends "ffmpeg=$FFMPEG_VERSION" \
13
+ && rm -rf /var/lib/apt/lists/*
14
+ WORKDIR /app
15
+ COPY runner.mjs FFMPEG.md ./
16
+ ENV PORT=8080 WORK_DIR=/tmp/work NODE_ENV=production
17
+ EXPOSE 8080
18
+ USER node
19
+ CMD ["node", "runner.mjs"]
@@ -0,0 +1,129 @@
1
+ # The FFmpeg build the media worker's container runs
2
+
3
+ Pinned in `container/Dockerfile` (and UploadFilm's `worker/media/container/Dockerfile`, same lines):
4
+
5
+ | | |
6
+ |---|---|
7
+ | Base image | `node:24.22.3-trixie-slim@sha256:af02d57b57719b9657a45199a79264a9437940cd55b3c7b3fc99615654f124a0` (Node 24.22.3, Debian 13.7) |
8
+ | Package source | Debian snapshot `20261114T000000Z` (`snapshot.debian.org`: trixie, trixie-updates, trixie-security) |
9
+ | FFmpeg | Debian package `ffmpeg=7:7.1.5-0+deb13u1` (FFmpeg 7.1.5, libavcodec 61), libx264 `2:0.164.3108+git31e19f9-2+b1` (x264 core 164) |
10
+
11
+ Why Debian's package from a dated snapshot: maintained (security fixes land as new package versions), built with
12
+ libx264 and the native AAC encoder, and the snapshot makes every rebuild install the very same bytes. Moving to a newer
13
+ FFmpeg is a deliberate change: bump `DEBIAN_SNAPSHOT` and `FFMPEG_VERSION` in both Dockerfiles, rebuild, re-run the
14
+ container tests inside the image, re-record the block below, and change the ladder's settings version if outputs change.
15
+
16
+ `test/ffmpegPin.test.ts` checks, inside the image (`MEDIA_IMAGE_TEST=1`), that `ffmpeg -version` and `-buildconf` are
17
+ exactly what is recorded here.
18
+
19
+ ## ffmpeg -version (first line)
20
+
21
+ ```
22
+ ffmpeg version 7.1.5-0+deb13u1 Copyright (c) 2000-2026 the FFmpeg developers
23
+ ```
24
+
25
+ ## ffmpeg -buildconf (linux/amd64: what Cloudflare runs)
26
+
27
+ Recorded from the image built with `--platform linux/amd64`. A linux/arm64 build (a Mac's local `docker build`) differs
28
+ only in `--libdir`, `--incdir`, `--arch` and `--disable-libvpl` (Intel's VPL exists only on amd64); the pin test ignores
29
+ those four.
30
+
31
+ ```
32
+ configuration:
33
+ --prefix=/usr
34
+ --extra-version=0+deb13u1
35
+ --toolchain=hardened
36
+ --libdir=/usr/lib/x86_64-linux-gnu
37
+ --incdir=/usr/include/x86_64-linux-gnu
38
+ --arch=amd64
39
+ --enable-gpl
40
+ --disable-stripping
41
+ --disable-libmfx
42
+ --disable-omx
43
+ --enable-gnutls
44
+ --enable-libaom
45
+ --enable-libass
46
+ --enable-libbs2b
47
+ --enable-libcdio
48
+ --enable-libcodec2
49
+ --enable-libdav1d
50
+ --enable-libflite
51
+ --enable-libfontconfig
52
+ --enable-libfreetype
53
+ --enable-libfribidi
54
+ --enable-libglslang
55
+ --enable-libgme
56
+ --enable-libgsm
57
+ --enable-libharfbuzz
58
+ --enable-libmp3lame
59
+ --enable-libmysofa
60
+ --enable-libopenjpeg
61
+ --enable-libopenmpt
62
+ --enable-libopus
63
+ --enable-librubberband
64
+ --enable-libshine
65
+ --enable-libsnappy
66
+ --enable-libsoxr
67
+ --enable-libspeex
68
+ --enable-libtheora
69
+ --enable-libtwolame
70
+ --enable-libvidstab
71
+ --enable-libvorbis
72
+ --enable-libvpx
73
+ --enable-libwebp
74
+ --enable-libx265
75
+ --enable-libxml2
76
+ --enable-libxvid
77
+ --enable-libzimg
78
+ --enable-openal
79
+ --enable-opencl
80
+ --enable-opengl
81
+ --disable-sndio
82
+ --enable-libvpl
83
+ --enable-libdc1394
84
+ --enable-libdrm
85
+ --enable-libiec61883
86
+ --enable-chromaprint
87
+ --enable-frei0r
88
+ --enable-ladspa
89
+ --enable-libbluray
90
+ --enable-libcaca
91
+ --enable-libdvdnav
92
+ --enable-libdvdread
93
+ --enable-libjack
94
+ --enable-libpulse
95
+ --enable-librabbitmq
96
+ --enable-librist
97
+ --enable-libsrt
98
+ --enable-libssh
99
+ --enable-libsvtav1
100
+ --enable-libx264
101
+ --enable-libzmq
102
+ --enable-libzvbi
103
+ --enable-lv2
104
+ --enable-sdl2
105
+ --enable-libplacebo
106
+ --enable-librav1e
107
+ --enable-pocketsphinx
108
+ --enable-librsvg
109
+ --enable-libjxl
110
+ --enable-shared
111
+ ```
112
+
113
+ ## Known issues
114
+
115
+ **Debian's libx264 writes undecodable 10-bit 4:2:2 at 720p and above** (found 2026-11-14 running the tests inside the
116
+ image; amd64 and arm64 alike). The stream is flagged "High 4:2:2 Intra" (constraint_set3) while it holds P-frames, so
117
+ every decoder (this image's FFmpeg 7.1.5 and FFmpeg 9.0.2 alike) reports `decode_slice_header error` / `reference
118
+ count overflow` and drops frames. 640x360 and every 4:2:0 or 8-bit format are fine. Decoding is not affected: real
119
+ 10-bit 4:2:2 camera files (and ones made by another x264 build) decode cleanly in the image.
120
+
121
+ - Impact: none on jobs (the runner never encodes 10-bit; its rungs are 8-bit 4:2:0). Tests must not make 10-bit 4:2:2
122
+ clips with the image's encoder: they use `app/test/fixtures/media/h264-10bit-422.mp4`. Note that UploadFilm's
123
+ `worker/media/test/container.test.ts` "FX30's format" case still makes one in the image; it passes because FFmpeg
124
+ conceals the damage, so inside the image that case proves less than its name says.
125
+ - Minimal repro (in the image):
126
+ `ffmpeg -f lavfi -i testsrc2=size=1280x720:rate=24 -t 2 -c:v libx264 -preset ultrafast -pix_fmt yuv422p10le c.mov && ffprobe -v error -show_entries stream=profile c.mov && ffmpeg -v error -i c.mov -f null -`
127
+ → `profile=High 4:2:2 Intra`, then ~200 decode errors.
128
+ - Upstream draft (for the owner to file, Debian `x264` package, 2:0.164.3108+git31e19f9-2+b1): "10-bit 4:2:2 encodes at
129
+ ≥ 720p signal High 4:2:2 Intra although inter frames are coded; output undecodable by libavcodec. Repro above."