node-lame v1.3.2

node-lame

LAME is an open-source encoder that encodes and decodes audio to the MP3 file format. For all MP3 needs a Node.js wrapper of the full LAME command line.

The encoder reads WAV-, MP1-, MP2- and MP3-format and encodes it into an MP3 file. The decoder reads MP3-format and decodes it into WAV.

Requirements

• Linux or MacOS (This package is NOT tested on Windows)
• Lame Installed (View instructions below)
• Node 12.20.* or newer

Installation

You can install it with npm:

$ npm install node-lame

If you have not installed LAME yet, please use the following instruction.

Install on Debian

$ sudo apt-get install lame

Install on MacOS with brew

$ brew install lame

Install on Windows

1. Go to the the Lame Download Page and download the EXE or ZIP file.
2. Navigate to the directory Lame was installed in (most commonly C:\Program Files (x86)\Lame For Audacity).
3. Add the directory to your Environment Variables.

Examples

Encode from file to file

const Lame = require("node-lame").Lame;

const encoder = new Lame({
    output: "./audio-files/demo.mp3",
    bitrate: 192,
}).setFile("./audio-files/demo.wav");

encoder
    .encode()
    .then(() => {
        // Encoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

Encode from file to buffer

const Lame = require("node-lame").Lame;

const encoder = new Lame({
    output: "buffer",
    bitrate: 192,
}).setFile("./audio-files/demo.wav");

encoder
    .encode()
    .then(() => {
        // Encoding finished
        const buffer = encoder.getBuffer();
    })
    .catch((error) => {
        // Something went wrong
    });

Encode from buffer to file

[...]

const Lame = require("node-lame").Lame;

const encoder = new Lame({
    "output": "./audio-files/demo.mp3",
    "bitrate": 192
}).setBuffer(audioFileBuffer);

encoder.encode()
    .then(() => {
        // Encoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

Encode from buffer to buffer

[...]

const Lame = require("node-lame").Lame;

const encoder = new Lame({
    "output": "buffer",
    "bitrate": 192
}).setBuffer(audioFileBuffer);

encoder.encode()
    .then(() => {
        // Encoding finished
        const buffer = encoder.getBuffer();
    })
    .catch((error) => {
        // Something went wrong
    });

Get status of encoder as object

const Lame = require("node-lame").Lame;

const encoder = new Lame({
    output: "buffer",
    bitrate: 192,
}).setFile("./audio-files/demo.wav");

encoder
    .encode()
    .then(() => {
        // Encoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

const status = encoder.getStatus();

Get status of encoder as EventEmitter

const Lame = require("node-lame").Lame;

const encoder = new Lame({
    output: "buffer",
    bitrate: 192,
}).setFile("./audio-files/demo.wav");

const emitter = encoder.getEmitter();

emitter.on("progress", ([progress, eta]) => {
    // On progress of encoding. Progress in percent and estimated time of arrival as mm:ss
});

emitter.on("finish", () => {
    // On finish
});

emitter.on("error", (error) => {
    // On error
});

encoder
    .encode()
    .then(() => {
        // Encoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

Decode from file to file

const Lame = require("node-lame").Lame;

const decoder = new Lame({
    output: "./audio-files/demo.wav",
}).setFile("./audio-files/demo.mp3");

decoder
    .decode()
    .then(() => {
        // Decoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

Decode from file to buffer

const Lame = require("node-lame").Lame;

const decoder = new Lame({
    output: "buffer",
}).setFile("./audio-files/demo.mp3");

decoder
    .decode()
    .then(() => {
        // Decoding finished
        const buffer = decoder.getBuffer();
    })
    .catch((error) => {
        // Something went wrong
    });

Decode from buffer to file

[...]

const Lame = require("node-lame").Lame;

const decoder = new Lame({
    "output": "./audio-files/demo.wav"
}).setBuffer(mp3InputBuffer);

decoder.decode()
    .then(() => {
        // Decoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

Decode from buffer to buffer

[...]

const Lame = require("node-lame").Lame;

const decoder = new Lame({
    "output": "buffer"
}).setBuffer(mp3InputBuffer);

decoder.decode()
    .then(() => {
        // Decoding finished
        const buffer = decoder.getBuffer();
    })
    .catch((error) => {
        // Something went wrong
    });

Get status of decoder as object

const Lame = require("node-lame").Lame;

const decoder = new Lame({
    output: "buffer",
}).setFile("./audio-files/demo.mp3");

decoder
    .encode()
    .then(() => {
        // Decoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

const status = decoder.getStatus();

Get status of decoder as EventEmitter

const Lame = require("node-lame").Lame;

const decoder = new Lame({
    output: "buffer",
}).setFile("./audio-files/demo.mp3");

const emitter = decoder.getEmitter();

emitter.on("progress", ([progress]) => {
    // On progress of decoder; in percent
});

emitter.on("finish", () => {
    // On finish
});

emitter.on("error", (error) => {
    // On error
});

decoder
    .decode()
    .then(() => {
        // Decoding finished
    })
    .catch((error) => {
        // Something went wrong
    });

All options

Meta options

Option description text from LAME man page. Based on LAME version 3.99.5 from Feb 28, 2012.