Installations

npm install generate-sound-waveform

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

11.3.0

NPM Version

6.7.0 Pull Requests

Open

2

Total

4

Closed

1

Merged

1

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Languages

1

JavaScript

JavaScript (100%)

Developer

hyunwoo

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

2 Stars

26 Commits

1 Forks

1 Watchers

3 Branches

1 Contributors

Updated on May 12, 2022

Maintainers

1

View All 1 Contributors

Package Meta Information

Latest Version

0.1.11

Package Id

generate-sound-waveform@0.1.11

Unpacked Size

6.10 kB

Size

2.29 kB

File Count

3

NPM Version

6.7.0

Node Version

11.3.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

7

audio-context audio-decode av canvas flac.js ogg.js vorbis.js

generate-sound-waveform

This package converts sound files such as wav and mp3 to waveform images in Nodejs environment.\

The node gyp related installation may take a long time.

Supported sound formats:

wav
mp3
ogg
flac

Output

1250x250 padding:10px 1250x250 padding:60px

Usage

const lib = require('generate-sound-waveform');
const fs = require('fs');
// generateSoundImage([SOUND FILE PATH], [WIDTH], [HEIGHT])
lib
  .generateSoundImage('./samples/sample1.ogg', 1250, 200, {
    stepMultiplier: 10, // Density of waveform [default : 4]
    backgroundColor: '#666', // image background color [default : '#fff']
    lineColor: '#fff', // image line color [default : '#666']
    globalAplha: 0.8, // draw line global alpha value [default : 0.6]
    padding: 60, // padding height [default : 8]
    lineWidth : 1 // draw line width [default : 0.5]
    centerLine: false, // center guide line [default : true]
    centerLineColor: '#fff', // center guild line color [default : '#fff']
  })
  .then((stream) => {
    const out = fs.createWriteStream('./test.jpeg');
    stream.pipe(out);
    out.on('finish', () => console.log('complete'));
  })
  .catch((err) => {
    console.log(err);
  });

API

method :

generateSoundImage(path, width, height, option?)

property	value	desc
path	string	sound file path
width	number	export jpeg width
height	number	export jpeg height
option	object	export image settings

Options

property	value	default
padding	number	8
stepMultiplier	number	4
backgroundColor	string	'#fff'
lineColor	number	'#666'
globalAplha	number	0.6
lineWidth	number	0.5
centerLine	boolean	true
centerLineColor	string	'#fff'

Development paradigm

The package should be easy to use.
The background color and color of the output jpeg file should be changed according to the user's options.

The Sample Project is available in GitHub - hyunwoo/generate-sound-waveform along with a sample sound file.

Thanks To

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.3

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More