Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

audio-splitter

mpirescarvalho2.9kISC1.1.4TypeScript support: included

Simple package to split a merged audio track to parts by silence analysis

audio, split, audio-split, audio-splitter, ffmpeg, merged, tracks, songs, song-slitter, merged-audio

readme

Audio Splitter

Simple package to split a merged audio track to parts by silence analysis.

Prerequisites

To use this project, you need to have a local installation of FFmpeg present on your system. You can download it from https://www.ffmpeg.org/download.html

Installation

$ npm i audio-splitter

Example

Auto split

const { splitAudio } = require("audio-splitter");

splitAudio({
    mergedTrack: "path/to/file.mp3",
    outputDir: "path/to/outdir/",
});

API

splitAudio(params)

Automatically split audio based on silence analysis.

// split audio params
type SplitAudioParams = {
    mergedTrack: string; // source track
    outputDir: string; // directory, where to put the tracks (with all the required slashes)
    ffmpegPath?: string; // path to ffmpeg.exe
    artist?: string; // meta info, optional
    album?: string; // meta info, optional
    trackNames?: string[]; // meta info, optional
    maxNoiseLevel?: number; // silence is defined below this dB value
    minSilenceLength?: number; // (sec) we are searching for silence intervals at least of this lenght
    minSongLength?: number; // (sec) if a track is sorter than this, we merge it to the previous track
    fastStart?: boolean; // optional flag for faststart
};

extractAudio(params)

Manually extract a track

// extract audio params
type ExtractAudioParams = {
    ffmpegPath: string; // path to ffmpeg.exe
    inputTrack: string; // source track
    start: number | string; // start seconds in the source
    length: number; // duration to extract
    artist?: string; // meta info, optional
    album?: string; // meta info, optional
    outputTrack: string; // output track
    fastStart?: boolean; // optional flag for faststart
};

Contributing

  1. Fork it (https://github.com/mpirescarvalho/audio-splitter/fork)
  2. Create your feature branch (git checkout -b feature/awesome)
  3. Commit your changes (git commit -am 'Add awesome feature')
  4. Push to the branch (git push origin feature/awesome)
  5. Create a new Pull Request

Contact

made by Marcelo Carvalho made by Marcelo Carvalho