Steganography

Encoding data into images and decoding it back.

Origin: ja-k-e/stega.

Modules

Stegassette is the current format and the only one carried by the published docs, alongside StegaAnimator and the helper functions. It subsumes what the pre-STGC modules each did separately — text, audio, and arbitrary bytes are all just entries.

| Module | Description | | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Stegassette | Multi-payload STGC format: audio + arbitrary entries, self-describing alpha header, 11 combine ops, 9 traversals, 6 keymaps. See Stegassette.md for format details. | | StegaAnimator| Animates an encoded image on a canvas |

The pre-STGC modules — Stega64, StegaCassette, StegaBinary, StegaKey, and StegaMetadata — were removed in 1.0. Their consumers were already gone: machines/sonic-pixels is retired, and the iOS StegaKit that ported the API to Swift is archived at _archive/stega-player. They were kept only because dropping them was a breaking change. Stegassette supersedes all of them.

To keep using them, pin @amplib/steganography@^0.1.0; that line is not maintained. The 1.0 surface is Stegassette, StegaAnimator, and the file and audio helpers.

Usage

Stegassette

import { Stegassette } from "@amplib/steganography";

// Build an audio entry from decoded PCM channels
const audioEntry = Stegassette.buildAudioEntry({
  channels: [leftChannel, rightChannel], // Float32Array[]
  sampleRate: 44100,
  bitsPerSample: 16,
});

// Encode into an image
const canvas = Stegassette.encode({
  source: image, // HTMLImageElement | HTMLCanvasElement
  entries: [audioEntry],
  combine: "xor", // 11 combine ops available
  traversal: "raster", // 9 traversal patterns
  keymap: "adjacent", // 6 keymaps
});

// Decode — self-keying, no separate key image needed
const { entries, opts } = Stegassette.decode({ source: canvas });
const { channels, sampleRate } = Stegassette.parseAudioEntry(entries[0]);

An entry is a mimetype, an optional name, and bytes — a string is encoded as UTF-8 — so text needs no separate module:

const canvas = Stegassette.encode({
  source: image,
  entries: [{ mimetype: "text/plain", name: "message.txt", data: "Hello world" }],
});

const { entries } = Stegassette.decode({ source: canvas });
const message = new TextDecoder().decode(entries[0].data);

Node.js (read/write PNG files)

import { Stegassette, readPng, writePng } from "@amplib/steganography/node";

const img = await readPng("input.png");
const out = Stegassette.encodeImageData({ source: img, entries: [audioEntry] });
await writePng("output.png", out);
const { entries } = Stegassette.decodeImageData({ source: out });