Skip to content

Releases: devowlio/node-lame

2.0.0

09 Nov 16:56
@jankarres jankarres
v2.0.0
8df2b1e

Choose a tag to compare

View all tags
2.0.0 Latest
Latest

Breaking Changes

  • Postinstall now auto-downloads a platform-specific LAME binary into vendor/lame/<platform>-<arch>/. Pipelines must permit the download step or configure LAME_BINARY, LAME_SKIP_DOWNLOAD, or LAME_FORCE_DOWNLOAD to control it (more details see README.md).
  • The minimum Node.js version is 20 and the library is published as an ESM-first package with explicit exports. CommonJS imports are still supported. Deep imports like require("node-lame/lib/...") are no longer supported.

Features

  • Introduced duplex streaming helpers (createLameEncoderStream / createLameDecoderStream) so audio can flow through stdin/stdout while progress events continue to fire (#11).
  • Lame#setBuffer accepts ArrayBuffer and all typed arrays, automatically normalizing samples to the requested bit depth and endianness (#33).
  • Broadened CLI option support: gapless playback controls, priority/disptime tuning, channel swapping, gain, decode delay trimming, VBR fine-tuning, verbosity toggles, and custom ID3 frames via meta.custom.
  • Exported resolveBundledLameBinary and resolveLameBinary so applications can inspect or override the binary chosen at runtime.

Improvements

  • spawnLameProcess now drives all CLI interaction, guaranteeing consistent progress parsing and normalized warning/error messages.
  • Temp files live under join(tmpdir(), "node-lame"), are created lazily, and are cleaned up automatically, even after failures.
  • Documentation now covers the installer environment variables, typed-array ingestion, gapless workflows, and streaming usage.

Tooling & Quality

  • Builds now originate from modern TypeScript sources compiled by tsup into dual ESM/CJS bundles with generated typings.
  • Vitest-based unit and integration suites stub binaries, simulate streaming backpressure, and assert option coverage.
  • The installer maintains a deterministic vendor layout, making binary resolution reproducible across platforms.
  • Introduced CI/CD pipelines that lint, type-check, run unit and integration suites, and gate release publishing so every change ships through the same automated path.

Releases of v1.x

All releases up to this version were created without a changelog. Please refer to the comment messages for details on changes!

Summary of features in version 1.x:

  • Promise-based Node.js wrapper for the native LAME CLI that can both encode WAV/MP1/MP2/MP3 sources to MP3 and decode MP3 files back to WAV while reporting progress through getStatus() and an EventEmitter (progress, finish, error).
  • Supports file- and buffer-based workflows for both inputs and outputs, including optional in-memory pipelines, configurable temp directories, and custom binary paths so projects can bundle their own LAME builds.
  • Provides raw PCM ingestion controls (sample frequency, bit width, signed/unsigned, endian toggles) and format hints (mp2Input, mp3Input) so the CLI can be tuned for atypical sources.
  • Exposes the majority of LAME’s encoding knobs: stereo/joint/mono modes, mono downmix (to-mono), block-size tweaks, ReplayGain detection, channel scaling, presets, CPU feature flags, quality ladders, and the full suite of bitrate strategies (constant, forced, average, variable with quality targets, and noise-shaping helpers).
  • Includes resampling plus low-pass/high-pass filter controls and ISO-compliance/reservoir toggles for shaping output to device requirements or archival specs.
  • Ships rich ID3 tooling that can embed titles, artists, albums, years, comments, tracks, genres, artwork, genre lists, padding, and ID3v1/v2 variants while allowing strict tag validation.
  • Publishes TypeScript typings alongside the compiled library and maintains a Mocha/Chai suite that exercises encode/decode happy paths, buffer handling, metadata arguments, and failure cases (bad files, invalid options, unexpected process exits).
Assets 2
Loading