0.1.11 • Published 5 years ago

generate-sound-waveform v0.1.11

Weekly downloads
11
License
ISC
Repository
github
Last release
5 years ago

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 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?)

propertyvaluedesc
pathstringsound file path
widthnumberexport jpeg width
heightnumberexport jpeg height
optionobjectexport image settings

Options

propertyvaluedefault
paddingnumber8
stepMultipliernumber4
backgroundColorstring'#fff'
lineColornumber'#666'
globalAplhanumber0.6
lineWidthnumber0.5
centerLinebooleantrue
centerLineColorstring'#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

0.1.11

5 years ago

0.1.10

5 years ago

0.1.9

5 years ago

0.1.8

5 years ago

0.1.7

5 years ago

0.1.6

5 years ago

0.1.5

5 years ago

0.1.4

5 years ago

0.1.3

5 years ago