Git Product home page Git Product logo

audio-format's Introduction

audio-format Build Status unstable Greenkeeper badge

Audio data format parser/detector/serializer.

npm install audio-format

obj = format.parse(string)

Parse format properties from a string. Returns only guaranteed properties and does not try to guess them.

format.parse('interleaved uint8 le stereo 44100')
// {interleaved: true, type: 'uint8', endianness: 'le', channels: 2, sampleRate: 44100}

format.parse('stereo audiobuffer 96000')
// {channels: 2, type: 'audiobuffer', sampleRate: 96000, interleaved: false, endianness: 'le'}

str = format.stringify(obj, defaults?)

Get string identifying a format object. Optional defaults can indicate properties to skip if format value matches them.

format.stringify({channels: 2, interleaved: false})
// 'stereo planar'

format.stringify(
	{type: 'float32', endianness: 'le', interleaved: false, channels: 2},
	{endianness: 'le', type: 'float32'}
)
// 'stereo planar'

format.stringify(new AudioBuffer(null, {length: 10}))
// 'mono audiobuffer 44100'

obj = format.detect(obj)

Retrieve available format properties from an audio-like object.

format.detect(new AudioBuffer(null, {length: 10, numberOfChannels: 2}))
// {channels: 2, type: 'audiobuffer', sampleRate: 44100, endianness: 'le', interleaved: false}

format.detect(new Uint8ClampedArray([0, 255, 0, 255]))
// {type: 'uint8_clamped'}

format.detect(ndarray([0,0,0,0], [2,2]))
// {type: 'ndarray', interleaved: false, channels: 2}

str = format.type(obj)

Get type string identifying data container.

format.type(new AudioBuffer(ctx, {length: 1024})) // 'audiobuffer'
format.type(new Float32Array([-1, 1])) // 'float32'
format.type(new Float32Array([-1, 1]).buffer) // 'arraybuffer'
format.type(Array(100)) // 'array'
format.type(Buffer.from([0, 1, ...])) // 'buffer'
format.type(ndarray([0,0,0,0], [2,2])) // 'ndarray'

format.interleaved marker

Value Meaning
'interleaved', 'interleave' interleaved is true, channels is 2 or more.
'planar' interleaved is false, channels is 2 or more.

format.endianness marker

Value Meaning
'le' endianness is 'le' (little endian), type is not 'int8' or 'uint8'
'be' endianness is 'be' (big endian), type is not 'int8' or 'uint8'

format.channels marker

Value Meaning
'mono' 1 channel
'stereo' 2 channels
'2.1' 3 channels
'quad' 4 channels
'5.1' 5 channels
'*-channel' N channels

format.sampleRate marker

Value Meaning
Number Any number, primarily default sample-rates

format.type marker

Value Meaning
'uint8' Uint8Array
'uint8_clamped' Uint8ClampedArray
'uint16' Uint16Array
'uint32' Uint32Array
'int8' Int8Array
'int16' Int16Array
'int32' Int32Array
'float32', 'float' Float32Array
'float64' Float64Array
'array' Array
'arraybuffer' ArrayBuffer
'buffer' Buffer
'audiobuffer' AudioBuffer
'ndarray' ndarray
'ndsamples' ndsamples

See also

  • pcm-convert converts low-level pcm data from one format to another

License

(c) 2017 Dmitry Yvanov @ audiojs. MIT License

audio-format's People

Contributors

dy avatar greenkeeper[bot] avatar hemanth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

audio-format's Issues

channelarray

Sometimes audio data is in [[l,l,l,l], [r,r,r,r]] container. Should we add channelarray or something to handle that?

An in-range update of audio-buffer is breaking the build 🚨

Version 4.0.4 of audio-buffer was just published.

Branch Build failing 🚨
Dependency audio-buffer
Current Version 4.0.3
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

audio-buffer is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

Commits

The new version differs by 2 commits.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Make compatible with React Native?

Everything seems to excellent for this, but I'm going to have to fork this and audio-format in order to create a failsafe or alternative to switch to Platform.OS which react native uses. Would you consider implementing this?

Otherwise I'm happy to fork and send a PR if time/work is of the essence

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.