sox-async v1.0.6

sox-async

A wrapper around SoX. Transcode audio files easily!

Examples

Simple transcode:

const SoxAsync = require('sox-async')
const sox = new SoxAsync()
sox.run({
	inputFile: 'song.wav',
	outputFile: 'song.flac'
})
.then(outputFilePath => {
	console.log(outputFilePath) // => song2.flac
})
.catch(err => console.log(err))

Lower volume:

const SoxAsync = require('sox-async')
const sox = new SoxAsync()
sox.run({
	input: { volume: 0.8 },
	inputFile: 'song.flac',
	outputFile: 'song2.flac'
})
.then(outputFilePath => {
	console.log(outputFilePath) // => song2.flac
})
.catch(err => console.log(err))

Transcode with options and effects:

const SoxAsync = require('sox-async')
const sox = new SoxAsync('C:\\Program Files (x86)\\sox-14-4-2\\sox.exe')
sox.run({
	inputFile: 'song.ogg',
	output: {
		bits: 16,
		rate: 44100,
		channels: 2
	},
	outputFile: 'song.wav'
	effects: 'phaser 0.6 0.66 3 0.6 2 −t'
})
.then(outputFilePath => {
	console.log(outputFilePath) // => song2.flac
})
.catch(err => console.log(err))

API

const SoxAsync = require('sox-async')
const sox = new SoxAsync()

new SoxAsync(soxPath)

• soxPath string optional - The path to SoX. E.g. 'C:\Program Files\Sox\sox.exe'. Defaults to 'sox', which works if the SoX binary is in your path.

sox.run(options)

• options object required - The following parameters are supported: - global object optional - Global SoX options - inputFile string required - The file path of the input file - outputFile string required - The file path of the output file - input object optional - These options will be used to interpret the incoming stream. - output object optional - These options will be used to format the outgoing stream. When an output option isn't supplied, the output file will have the same format as the input file where possible. - effects string|array of strings/numbers optional

options object

An object of options. Every option is optional except options.inputFile and options.outputFile.

If you want an exhaustive list of each option in depth, take a look at the SoX documentation.

Internally, these options are transformed into the command-line arguments passed to a SoX child process.

options.inputFile / options.outputFile string, required

A file path, like './song.wav'.

options.global object|array of strings/numbers

You can supply an array of strings/numbers, or an object that will be transformed into an array of strings/numbers using hash-to-array.

Currently, sox-stream only supports one input file, so some of these options don't really make sense.

sox.run({
	global: {
		buffer: 4096,
		norm: true,
		'single-threaded': true
	},
	output: { type: 'ogg' }
})
.then(result => {...})
.catch(err => {...})

options.input / options.output object|array of strings/numbers

You can supply an array of strings/numbers, or an object that will be transformed into an array of strings/numbers using hash-to-array.

sox.run({
	input: [
		[ '--volume', 1.1 ],
		[ '--endian', 'big' ],
		[ '--no-glob' ]
	],
	output: { type: 'ogg' }
})
.then(result => {...})
.catch(err => {...})
// same as
sox.run({
	input: {
		volume: 1.1,
		endian: 'big',
		'no-glob': true
	],
	output: [
		'--type', 'ogg'
	]
}, cb)
// same as
sox.run({
	input: '--volume 1.1 --endian big --no-glob',
	output: '--type ogg'
})
.then(result => {...})
.catch(err => {...})

options.effects string|array of strings/numbers/arrays

Please see the SoX Documentation on Effects to see all the options.

You can put strings/numbers into sub-arrays, which will be flattened internally.

Pass them into sox.js like this:

sox.run({
	input: { type: 'ogg' },
	output: { type: 'wav' },


	effects: 'speed 1.5 swap'
	// same as
	effects: [
		'speed 1.5 swap'
	]
	// same as
	effects: [
		'speed', 1.5,
		'swap'
	]
	// same as
	effects: [
		[ 'speed', '1.5' ],
		'swap'
	]
})
.then(result => {...})
.catch(err => {...})

Install

• Install SoX. You can download it, or you can do apt-get install sox.
• Install this package with npm: npm install sox-async

Test

To run the tests, you must also have SoX in your PATH. Then run: npm test

I run the tests using SoX 14.4.2, but other versions of SoX should work fine.

Codec Support

FLAC

• Problem: FLAC was disabled accidentally in 14.4.1. [Stack Overflow]
• Solution: Install SoX 14.4.2.

MP3

• Problem: MP3 is proprietary.
• Solution: Compile the LAME encoder, and/or the MAD decoder.
• Links: - Windows (Precompiled) - Windows (How-To) - Ubuntu (How-To) - Ubuntu (How-To) 2 - CentOS (How-To)

License

MIT