aniren 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2026 Tomas Ravinskas
+
+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

@@ -0,0 +1,59 @@
+# aniren
+
+A simple command line tool to render/convert HTML/SVG content, optionally animated with CSS/JS/SMIL, to static or animated raster formats, i.e. WEBP/GIF/PNG.
+Note that rendering and encoding is _pretty slow_ for animated images: it takes the full duration of the animation + encoding/compression (varies by encoder and compression/quality level). Still, there aren't many alternatives out there that support animations, especially free/scriptable/open-source.
+
+## Usage
+
+```shell
+npx aniren -v 192 -q 70 -e 6 input.svg output.webp
+```
+
+This will produce static `output.webp` at 70% quality and maximum compression (slow).
+
+```shell
+npx aniren -d 5 -v 256x256 -l input.svg output.png
+```
+
+This will render `input.svg` for 5 seconds at `256px` width and `256px` height, capturing frames and producing a lossless (faster) animated (apng) `output.png`.
+
+### Options
+
+```
+aniren [flags] <input> <output>
+
+A CLI tool to render static or animated HTML/SVG/CSS/JS/SMIL content to static or animated WEBP/GIF/PNG
+
+Arguments:
+  <input>                               The path to the file to render
+  <output>                              Where to write the resulting image
+
+Flags:
+  --duration|-d <duration>              The duration in seconds of the input animation.
+    If this flag isn't specified or is 0 the output will be static
+  --viewport|-v [dimensions]            The viewport dimensions for rendering input.
+    This will also be the resolution of the output.
+    If a single value is given, it'll be used for both width and height (default: 1280x720)
+  --frames-per-second|-f [frame-rate]   The frame rate of the output image in frames per second (default: 30)
+  --color-scheme|-c [light|dark]        The color scheme to render the input with.
+    If the input does not use media queries, this has no effect (choices: light, dark) (default: light)
+  --lossless|-l                         Wether the output should be lossless.
+    Setting this speeds things up, but produces significantly larger images.
+    Doesn't apply to GIF and static PNG (default: false)
+  --quality|-q [quality]                The quality of the output, from 1 to 100.
+    Lower values are faster and produce smaller images, but there may be visual artifacts.
+    Only applies to WEBP and static PNG (default: 80)
+  --palette|-p [number-of-colors]       The number of colors to use for the output, between 2 and 256.
+    Lower values are faster and produce smaller images, but visual quality may suffer.
+    Ignored if --lossless is specified.
+    Doesn't apply to WEBP (default: 256)
+  --effort|-e [cpu-effort]              The CPU effort to use for compression, from 1 to 6 for WEBP and 1 to 10 for GIF and static PNG.
+    Lower values are faster, but produce larger images.
+    Doesn't apply to animated PNG (default: 4)
+  --debug                               Print error stack traces (default: false)
+  --help|-h                             Show help
+```
+
+## License
+
+Apache-2.0

package/bin/aniren.js

@@ -0,0 +1,292 @@
+#! /usr/bin/env node
+import { spawn } from "node:child_process"
+import fs from "node:fs/promises"
+import path from "node:path"
+import { URL, pathToFileURL } from "node:url"
+import getMimeType from "get-mime-type"
+import { arg, bail, command, flag, summary } from "paparam"
+import { chromium } from "playwright"
+import PNG from "@pdf-lib/upng"
+import sharp from "sharp"
+import pkg from "../package.json" with { type: "json" }
+
+const png = PNG.default
+
+const OUTPUT_FORMAT = ["image/webp", "image/png", "image/gif"]
+const DEFAULT_DIMENSIONS = "1280x720"
+const DEFAULT_FPS = "30"
+const COLOR_SCHEMES = ["light", "dark"]
+const INTEGER_REGEX = /^\d+$/
+const FLOAT_REGEX = /^\d+(?:\.\d+)?$/
+
+const cmd = command(
+  pkg.name,
+  summary(pkg.description),
+  arg("<input>", "The path to the file to render"),
+  arg("<output>", "Where to write the resulting image"),
+  flag(
+    "--duration|-d <duration>",
+    `The duration in seconds of the input animation.
+    If this flag isn't specified or is 0 the output will be static`,
+  ),
+  flag(
+    "--viewport|-v [dimensions]",
+    `The viewport dimensions for rendering input.
+    This will also be the resolution of the output.
+    If a single value is given, it'll be used for both width and height`,
+  ).default(DEFAULT_DIMENSIONS),
+  flag(
+    "--frames-per-second|-f [frame-rate]",
+    `The frame rate of the output image in frames per second`,
+  ).default(DEFAULT_FPS),
+  flag(
+    "--color-scheme|-c [light|dark]",
+    `The color scheme to render the input with.
+    If the input does not use media queries, this has no effect`,
+  )
+    .choices(COLOR_SCHEMES)
+    .default(COLOR_SCHEMES[0]),
+  flag(
+    "--lossless|-l",
+    `Wether the output should be lossless.
+    Setting this speeds things up, but produces significantly larger images.
+    Doesn't apply to GIF and static PNG`,
+  ).default(false),
+  flag(
+    "--quality|-q [quality]",
+    `The quality of the output, from 1 to 100.
+    Lower values are faster and produce smaller images, but there may be visual artifacts.
+    Only applies to WEBP and static PNG`,
+  ).default(80),
+  flag(
+    "--palette|-p [number-of-colors]",
+    `The number of colors to use for the output, between 2 and 256.
+    Lower values are faster and produce smaller images, but visual quality may suffer.
+    Ignored if --lossless is specified.
+    Doesn't apply to WEBP`,
+  ).default(256),
+  flag(
+    "--effort|-e [cpu-effort]",
+    `The CPU effort to use for compression, from 1 to 6 for WEBP and 1 to 10 for GIF and static PNG.
+    Lower values are faster, but produce larger images.
+    Doesn't apply to animated PNG`,
+  ).default(4),
+  flag("--debug", "Print error stack traces").default(false),
+  bail(bailer),
+  runner,
+)
+
+const app = cmd.parse()
+
+async function runner({ args, flags }) {
+  let browser = null
+
+  try {
+    const input = URL.canParse(args.input) ? args.input : pathToFileURL(args.input).href
+    const mime = getMimeType(args.output)
+    const output = path.resolve(process.cwd(), args.output)
+
+    if (!OUTPUT_FORMAT.includes(mime)) {
+      throw new Error(
+        `Unsupported output format: "${mime}". Supported formats are: ${OUTPUT_FORMAT.map(JSON.stringify).join(", ")}.`,
+      )
+    }
+
+    const { width, height } = parseViewport(flags.viewport)
+    const duration = flags.duration && parseDuration(flags.duration)
+    const animated = duration > 0
+    const colorScheme = flags.colorScheme
+    const lossless = flags.lossless
+    const quality = parseInteger(flags.quality, 1, 100, "Quality")
+    const colors = parseInteger(flags.palette, 2, 256, "Palette (number of colors)")
+    const effort = parseInteger(flags.effort, 1, 10, "CPU effort")
+    const interval = 1_000 / parseInteger(flags.framesPerSecond, 1, 60, "Frames per second")
+
+    let buffer = null
+
+    browser = await chromium.launch()
+
+    const page = await browser.newPage({ colorScheme, viewport: { width, height } })
+
+    await page.goto(input, { waitUntil: "domcontentloaded" })
+
+    if (animated) {
+      const frames = []
+      const delay = []
+
+      let wait = 0
+
+      for (let i = 0; i < duration; ) {
+        if (wait) await page.waitForTimeout(wait)
+
+        const start = Date.now()
+
+        frames.push(await page.screenshot({ type: "png", omitBackground: true }))
+
+        const elapsed = Date.now() - start
+
+        i += Math.max(interval, wait + elapsed)
+
+        wait = Math.max(0, interval - elapsed)
+
+        delay.push(Math.max(Math.floor(interval), elapsed))
+      }
+
+      const image =
+        mime === "image/png"
+          ? frames.map((frame) => png.decode(frame.buffer).data)
+          : sharp(frames, { join: { animated: true } })
+
+      switch (mime) {
+        case "image/webp": {
+          buffer = await image.webp({ delay, lossless, quality, effort }).toBuffer()
+          break
+        }
+        case "image/gif": {
+          buffer = await image.gif({ delay, colors, effort }).toBuffer()
+          break
+        }
+        case "image/png": {
+          buffer = Buffer.from(png.encode(image, width, height, lossless ? 0 : colors, delay))
+          break
+        }
+        default: {
+          throw new Error(`Shouldn't happen! Unknown format: "${mime}"`)
+        }
+      }
+    } else {
+      const frame = await page.screenshot({
+        animations: "disabled",
+        type: "png",
+        omitBackground: true,
+      })
+      const image = sharp(frame)
+
+      switch (mime) {
+        case "image/webp": {
+          buffer = await image.webp({ lossless, quality, effort }).toBuffer()
+          break
+        }
+        case "image/gif": {
+          buffer = await image.gif({ colors, effort }).toBuffer()
+          break
+        }
+        case "image/png": {
+          buffer = await image.png({ quality, colors, effort }).toBuffer()
+          break
+        }
+        default: {
+          throw new Error(`Shouldn't happen! Unknown format: "${mime}"`)
+        }
+      }
+    }
+
+    if (!buffer) {
+      throw new Error(`Failed to encode output image`)
+    }
+
+    await fs.writeFile(output, buffer)
+  } catch (err) {
+    if (flags.debug) console.error(`⛔️ ${err.stack}`)
+    else console.error(`⛔️ ${err.message}`)
+    process.exit(1)
+  } finally {
+    await browser?.close()
+  }
+}
+
+function parseViewport(viewport) {
+  const dimensions = viewport.split("x")
+
+  if (dimensions.length > 2 || dimensions.find((dim) => !INTEGER_REGEX.test(dim))) {
+    throw new Error(
+      `Viewport dimensions must be in the form "INTEGERxINTEGER" or "INTEGER". Got "${viewport}" instead.`,
+    )
+  }
+
+  const [width, height = width] = dimensions.map(parseInt)
+
+  return { width, height }
+}
+
+function parseDuration(duration) {
+  const float = parseFloat(duration)
+
+  if (!FLOAT_REGEX.test(duration) || Number.isNaN(float)) {
+    throw new Error(
+      `Invalid duration. Duration must be a valid number in seconds, e.g. "3" or "5.75". Got "${duration}" instead.`,
+    )
+  }
+
+  return float * 1_000
+}
+
+function parseInteger(int, min, max, option) {
+  if (!INTEGER_REGEX.test(int)) {
+    throw new Error(`${option} must be a positive integer. Got "${int}" instead.`)
+  }
+
+  const value = parseInt(int)
+
+  if (value < min || value > max) {
+    throw new Error(`${option} must be between ${min} and ${max}. Got ${value} instead.`)
+  }
+
+  return value
+}
+
+async function install_browser(cwd) {
+  return new Promise((resolve, reject) => {
+    const installer = spawn(
+      "npx",
+      ["playwright", "install", "--with-deps", "--only-shell", "chromium"],
+      {
+        cwd: process.cwd(),
+        stdio: "inherit",
+      },
+    )
+
+    installer.on("error", reject)
+    installer.on("exit", (status) => {
+      if (status) {
+        return reject(
+          new Error(
+            `Failed to install headless browser. Process exited with status code ${status}.`,
+          ),
+        )
+      }
+
+      resolve()
+    })
+  })
+}
+
+function bailer({
+  command: {
+    flags: { debug },
+    args,
+  },
+  arg,
+  flag,
+  reason,
+  err,
+}) {
+  if (arg) {
+    console.error(
+      `⛔️ ${reason}: Invalid positional arguments supplied:`
+        + Object.entries(args)
+          .map(([k, v]) => `\n\t${k}: "${v}"`)
+          .join("")
+        + `\n\tunknown: "${arg.value}"`,
+    )
+  }
+  if (flag) {
+    console.error(
+      `⛔️ ${reason}: The value for the flag "${flag.long ? "--" : "-"}${flag.name}" is invalid`,
+    )
+  }
+  if (err) {
+    console.error(`⛔️ Error processing arguments:\n${debug ? reason : err.message}`)
+  }
+  process.exit(1)
+}

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "aniren",
+  "version": "0.1.0",
+  "description": "A CLI tool to render static or animated HTML/SVG/CSS/JS/SMIL content to static or animated WEBP/GIF/PNG",
+  "author": {
+    "name": "Tomas Ravinskas",
+    "email": "tomas@tomasrav.me",
+    "url": "https://tomasrav.me/"
+  },
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/OzymandiasTheGreat/aniren",
+  "repository": "https://github.com/OzymandiasTheGreat/aniren",
+  "bugs": "https://github.com/OzymandiasTheGreat/aniren/issues",
+  "type": "module",
+  "bin": {
+    "aniren": "./bin/aniren.js"
+  },
+  "exports": {
+    "./package": "./package.json"
+  },
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/OzymandiasTheGreat"
+    }
+  ],
+  "keywords": [
+    "html",
+    "svg",
+    "webp",
+    "gif",
+    "apng",
+    "animated",
+    "render",
+    "convert"
+  ],
+  "files": [
+    "bin",
+    "NOTICE"
+  ],
+  "dependencies": {
+    "@pdf-lib/upng": "^1.0.1",
+    "get-mime-type": "^2.0.2",
+    "paparam": "^1.10.1",
+    "playwright": "^1.60.0",
+    "sharp": "^0.34.5"
+  },
+  "devDependencies": {
+    "prettier": "^3.6.2"
+  }
+}