README.md

Note

This is one of 199 standalone projects, maintained as part of the @thi.ng/umbrella monorepo and anti-framework.

🚀 Please help me to work full-time on these projects by sponsoring me on GitHub. Thank you! ❤️

• About
• Status
• Installation
• Dependencies
• Usage examples
• API
• Authors
• License

About

WAV file format generation. This is a support package for @thi.ng/dsp.

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/dsp-io-wav

ESM import:

import * as wav from "@thi.ng/dsp-io-wav";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/dsp-io-wav"></script>

JSDelivr documentation

For Node.js REPL:

const wav = await import("@thi.ng/dsp-io-wav");

Package sizes (brotli'd, pre-treeshake): ESM: 488 bytes

Dependencies

• @thi.ng/api
• @thi.ng/binary
• @thi.ng/errors
• @thi.ng/transducers
• @thi.ng/transducers-binary

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

Usage examples

One project in this repo's /examples directory is using this package:

Screenshot	Description	Live demo	Source
	Generative audio synth offline renderer and WAV file export	Demo	Source

API

Generated API docs

TODO

import { osc, sin } from "@thi.ng/dsp";
import { wavByteArray } from "@thi.ng/dsp-io-wav";

const FS = 48000;

// write 1 second 24bit mono WAV file of 440Hz sine
fs.writeFileSync(
  "sine-440.wav",
  wavByteArray(
    { sampleRate: FS, channels: 1, length: FS, bits: 24 },
    osc(sin, 440 / FS)
  )
);

Authors

• Karsten Schmidt

If this project contributes to an academic publication, please cite it as:

@misc{thing-dsp-io-wav,
  title = "@thi.ng/dsp-io-wav",
  author = "Karsten Schmidt",
  note = "https://thi.ng/dsp-io-wav",
  year = 2020
}

License

© 2020 - 2024 Karsten Schmidt // Apache License 2.0