Notoriously Punctual Manatee
    Wondering what’s next for npm?Check out our public roadmap! »

    musicmetadata
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/musicmetadata package

    2.0.5 • Public • Published

    Build Status NPM version npm downloads

    Streaming music metadata parser for node and the browser.

    Installation

    Install via npm:

    npm install musicmetadata
    

    You can also download a pre packaged browser release from dist/musicmetadata.js. See example/index.html for usage.

    Supports

    • mp3 (1.1, 2.2, 2.3, 2.4)
    • m4a (mp4)
    • vorbis (ogg, flac)
    • asf (wma, wmv)

    API

    var fs = require('fs');
    var mm = require('musicmetadata');
     
    // create a new parser from a node ReadStream
    var parser = mm(fs.createReadStream('sample.mp3'), function (err, metadata) {
      if (err) throw err;
      console.log(metadata);
    });

    This will output the standard music metadata:

    { artist : ['Spor'],
      album : 'Nightlife, Vol 5.',
      albumartist : [ 'Andy C', 'Spor' ],
      title : 'Stronger',
      year : '2010',
      track : { no : 1, of : 44 },
      disk : { no : 1, of : 2 },
      genre : ['Drum & Bass'],
      picture : [ { format : 'jpg', data : <Buffer> } ],
      duration : 302.41 // in seconds
    }

    Note, the stream is not closed by default. To prevent leaks, you must close it yourself:

    var readableStream = fs.createReadStream('sample.mp3');
    var parser = mm(readableStream, function (err, metadata) {
      if (err) throw err;
      readableStream.close();
    });

    musicmetadata also emits all metadata it discovers during parsing. For example if you wanted to read the TLEN frame from an id3v2.x file you can do this:

    parser.on('TLEN', function (result) {
      console.log(result);
    });

    You can also read the duration; to calculate the duration musicmetadata may need to parse the entire file so only enable this if you need the functionality.

    mm(fs.createReadStream('sample.mp3'), { duration: true }, function (err, metadata) {
     
    });

    Note that in order to read the duration for streams that are not file streams, you must also pass the size of the file in bytes.

    mm(fs.createReadStream('sample.mp3'), { duration: true, fileSize: 26838 }, function (err, metadata) {
     
    });

    Licence

    (The MIT License)

    Copyright (c) 2016 Lee Treveil leetreveil@gmail.com

    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.

    Install

    npm i musicmetadata

    DownloadsWeekly Downloads

    525

    Version

    2.0.5

    License

    MIT

    Last publish

    Collaborators

    • avatar