# wav-decoder

> promise-based wav decoder

Latest version **1.3.0** (published 2017-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install wav-decoder
pnpm add wav-decoder
yarn add wav-decoder
bun add wav-decoder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2017-08-10 |
| First published | 2015-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 42 |
| Author | Nao Yonamine |
| Maintainers | mohayonao |
| Keywords | decode, universal, wav |

## Links

- npm: https://www.npmjs.com/package/wav-decoder
- Repository: https://github.com/mohayonao/wav-decoder
- Homepage: https://github.com/mohayonao/wav-decoder/
- Issues: https://github.com/mohayonao/wav-decoder/issues
- npm.io page: https://npm.io/package/wav-decoder

## Alternatives

- [flatbuffers](https://npm.io/package/flatbuffers.md) — 6.0M weekly downloads
- [jwt-simple](https://npm.io/package/jwt-simple.md) — 259.5K weekly downloads
- [@exodus/patch-broken-hermes-typed-arrays](https://npm.io/package/@exodus/patch-broken-hermes-typed-arrays.md) — 28.5K weekly downloads
- [@native-to-anchor/buffer-layout](https://npm.io/package/@native-to-anchor/buffer-layout.md) — 12.2K weekly downloads
- [binary-parser-encoder](https://npm.io/package/binary-parser-encoder.md) — 5.3K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2017-08-10
- 1.2.0 — 2017-08-09
- 1.1.1 — 2017-06-24
- 1.1.0 — 2016-04-05
- 1.0.0 — 2015-12-21
- 0.3.0 — 2015-06-10
- 0.2.1 — 2015-03-19
- 0.2.0 — 2015-03-18
- 0.1.1 — 2015-03-17
- 0.1.0 — 2015-03-17
- 0.0.1 — 2015-03-16

## README

# wav-decoder
[![Build Status](https://img.shields.io/travis/mohayonao/wav-decoder.svg?style=flat-square)](https://travis-ci.org/mohayonao/wav-decoder)
[![NPM Version](https://img.shields.io/npm/v/wav-decoder.svg?style=flat-square)](https://www.npmjs.org/package/wav-decoder)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://mohayonao.mit-license.org/)

> promise-based wav decoder

## Installation

```
$ npm install wav-decoder
```

## API

- `decode(src: ArrayBuffer, [opts: object]): Promise<AudioData>`
  - if provide an instance of `Buffer`, it is converted to `ArrayBuffer` like `Uint8Array.from(src).buffer` implicitly.
  - `opts.symmetric` decode to symmetrical values (see [#14](https://github.com/mohayonao/wav-decoder/issues/14))
- `decode.sync(src: ArrayBuffer, [opts: object]): AudioData`
  - synchronous version

##### Returns

```js
interface AudioData {
  sampleRate: number;
  channelData: Float32Array[];
}
```

## Usage

```js
const fs = require("fs");
const WavDecoder = require("wav-decoder");

const readFile = (filepath) => {
  return new Promise((resolve, reject) => {
    fs.readFile(filepath, (err, buffer) => {
      if (err) {
        return reject(err);
      }
      return resolve(buffer);
    });
  });
};

readFile("foobar.wav").then((buffer) => {
  return WavDecoder.decode(buffer);
}).then(function(audioData) {
  console.log(audioData.sampleRate);
  console.log(audioData.channelData[0]); // Float32Array
  console.log(audioData.channelData[1]); // Float32Array
});
```

## License
MIT

---
_Source: https://npm.io/package/wav-decoder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._