@industral/music-metadata-browser
v0.7.1
Published
Browserifed version of music-metadata
Downloads
30
Maintainers
Readme
music-metadata-browser
music-metadata release for the browser.
Features
- Supports metadata of the following audio and tag types:
Support for audio file types
| Audio format | Description | Wiki | | | ------------- |---------------------------------| -------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------:| | AIFF / AIFF-C | Audio Interchange File Format | :link: | | | APE | Monkey's Audio | :link: | | | ASF | Advanced Systems Format | :link: | | | FLAC | Free Lossless Audio Codec | :link: | | | MP2 | MPEG-1 Audio Layer II | :link: | | | MP3 | MPEG-1 / MPEG-2 Audio Layer III | :link: | | | MPC | Musepack SV7 | :link: | | | MPEG 4 | mp4, m4a, m4v, aac | :link: | | | Ogg / Opus | | :link: | | | Ogg / Speex | | :link: | | | Ogg / Vorbis | | :link: | | | WAV | | :link: | | | WV | WavPack | :link: | | | WMA | Windows Media Audio | :link: | |
Support for tags
Support for MusicBrainz tags as written by Picard.
Audio format & encoding details
Support for encoding / format details:
- Bit rate
- Audio bit depth
- Duration
- encoding profile (e.g. CBR, V0, V2)
Online demo's
Donation
Not required, but would be extremely motivating. PayPal.me
Installation
Install via npm:
npm install music-metadata
or yarn
yarn add music-metadata
Import music-metadata
This is how you can import music-metadata in JavaScript, in you code:
var mm = require('music-metadata-browser');
This is how it's done in TypeScript:
import * as mm from 'music-metadata-browser';
Module Functions
There are currently three ways to parse (read) audio tracks:
- parsing a Web API blob or file with the parseBlob function.
- Using ReadableStream using the parseReadableStream function.
- Using Node.js streams using the parseNodeStream function.
- Provide a URL to fetch the audio track from.
parseBlob function
To convert a Blob or File into a stream, filereader-stream is used.
import * as mm from 'music-metadata-browser';
/**
* @param blob Blob (e.g. Web API File)
*/
function readFromBlob(blob) {
// blob is a Web API Blob or File
mm.parseBlob(blob).then(metadata => {
// metadata has all the metadata found in the blob or file
});
}
parseReadableStream function
import * as mm from 'music-metadata-browser';
mm.parseReadableStream(readableStream)
.then( metadata => {
console.log(util.inspect(metadata, { showHidden: false, depth: null }));
readableStream.close();
});
Parse from a Web API ReadableStream.
If available, pass the mime-type and file-size. Without the mime-type, the content will be audio type will be automatically detected.
It is recommended to provide the corresponding MIME-type.
An extension (e.g.: .mp3
), filename or path will also work.
If the MIME-type or filename is not provided, or not understood, music-metadata will try to derive the type from the content.
import * as mm from 'music-metadata-browser';
const readableStream = result.node;
mm.parseReadableStream(readableStream, 'audio/mpeg', { fileSize: 26838 })
.then( metadata => {
console.log(util.inspect(metadata, { showHidden: false, depth: null }));
someReadStream.cancel();
});
parseNodeStream function
import * as mm from 'music-metadata-browser';
mm.parseNodeStream(readableStream)
.then( metadata => {
console.log(util.inspect(metadata, { showHidden: false, depth: null }));
readableStream.destroy();
});
The readable stream is derived from Node's readable stream.
If available, pass the mime-type and file-size. Without the mime-type, the content will be audio type will be automatically detected.
import * as mm from 'music-metadata-browser';
mm.parseNodeStream(someReadStream, 'audio/mpeg', { fileSize: 26838 })
.then( metadata => {
console.log(util.inspect(metadata, { showHidden: false, depth: null }));
someReadStream.close();
});
fetchUrl function
If you wish to stream your audio track over HTTP you need can use fetchFromUrl
which is using the Fetch API to retrieve the audio track:
import * as mm from 'music-metadata-browser';
/**
* Stream over HTTP from URL
*/
return mm.fetchFromUrl(audioTrackUrl, options)
orderTags function
Utility to Converts the native tags to a dictionary index on the tag identifier
orderTags(nativeTags: ITag[]): [tagId: string]: any[]
ratingToStars function
Can be used to convert the normalized rating value to the 0..5 stars, where 0 an undefined rating, 1 the star the lowest rating and 5 the highest rating.
ratingToStars(rating: number): number
Options
The following (optional) configurations can be passed:
duration
: default:false
, if set totrue
, it will parse the whole media file if required to determine the duration.fileSize
: provide this if parsing from a stream.loadParser: (moduleName: string) => Promise<ITokenParser>;
: default: lazy load using require, allows custom async lazy loading of parser modules. The resolvedITokenParser
will not be cached.native
: default:false
, if set totrue
, it will return native tags in addition to thecommon
tags.observer: (update: MetadataEvent) => void;
: Will be called after each change tocommon
(generic) tag, orformat
properties.skipCovers
: default:false
, if set totrue
, it will not return embedded cover-art (images).skipPostHeaders? boolean
default:false
, if set totrue
, it will not search all the entire track for additional headers. Only recommenced to use in combination with streams.
Although in most cases duration is included, in some cases it requires music-metadata
parsing the entire file.
To enforce parsing the entire file if needed you should set duration
to true
.
Metadata result:
If the returned promise resolves, the metadata (TypeScript IAudioMetadata
interface) contains:
format: IFormat
Audio format informationnative: INativeTags
List of native (original) tags found in the parsed audio file. If the native option is set to false, this property is not defined.common: ICommonTagsResult
Is a generic (abstract) way of reading metadata information.
Format
Audio format information. Defined in the TypeScript IFormat
interface:
dataformat?: string
Audio encoding format. e.g.: 'flac'tagTypes?: TagType[]
List of tagging formats found in parsed audio fileduration?: number
Duration in secondsbitrate?: number
Number bits per second of encoded audio filesampleRate?: number
Sampling rate in Samples per second (S/s)bitsPerSample?: number
Audio bit depthencoder?
Encoder namecodecProfile?: string
Codec profilelossless?: boolean
True if lossless, false for lossy encodingnumberOfChannels?: number
Number of audio channelsnumberOfSamples?: number
Number of samples frames, one sample contains all channels. The duration is: numberOfSamples / sampleRate
Common
Common tag documentation is automatically generated.
Automated testing
Automated unit tests are planned to be tested with different browsers. This service has been made available by:
Licence
(The MIT License)
Copyright (c) 2017 Borewit
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.