riff-file
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    riff-file

    Copyright (c) 2019 Rafael da Silva Rocha.
    https://github.com/rochars/riff-file

    NPM version Docs Tests
    Codecov Unix Build Windows Build Scrutinizer

    Read data from RIFF files.

    • MIT licensed
    • Use it in the browser
    • Use it with Node.js

    Install

    npm install riff-file
    

    Use

    const RIFFFile = require('riff-file').RIFFFile;
    let wavFile = fs.readFileSync("file.wav");
    let riff = new RIFFFile();
    riff.setSignature(wavFile);
    console.log(riff.signature);

    The signature is an object representing the structure of the RIFF file. Chunks are listed in the subChunks property in the order they appear in the binary file. An example of what the signature of a RIFF WAVE file might look like:

    {
      chunkId: 'RIFF',
      chunkSize: 96096,
      format: 'WAVE',
      subChunks:
        [ 
          {
           chunkId: 'fmt ',
           chunkSize: 16,
           chunkData: { start: 20, end: 36 }
          },
          {
           chunkId: 'junk',
           chunkSize: 52,
           chunkData: { start: 44, end: 96 }
          },
          {
           chunkId: 'data',
           chunkSize: 96000,
           chunkData: { start: 104, end: 96104 }
          }
        ]
     }

    API

    The RIFFFile methods

    /**
     * Read the signature of the chunks in a RIFF/RIFX file.
     * @param {!Uint8Array} buffer The file bytes.
     */
    RIFFFile.fromBuffer = function(buffer) {};
     
    /**
     * Find a chunk by its fourCC_ in a array of RIFF chunks.
     * @param {string} chunkId The chunk fourCC_.
     * @param {boolean} multiple True if there may be multiple chunks
     *    with the same chunkId.
     * @return {Object} 
     */
    RIFFFile.findChunk = function(chunkId, multiple=false) {};

    The RIFFFile properties

    /**
     * The container identifier.
     * @type {string} 
     */
    RIFFFile.container = '';
    /**
     * The main chunk size, in bytes.
     * @type {number} 
     */
    RIFFFile.chunkSize = 0;
    /**
     * The format identifier.
     * @type {string} 
     */
    RIFFFile.format = '';
    /**
     * An object representing the signature of all chunks in the file.
     * @type {
      {chunkId: string, chunkSize: number, format: string, subChunks: Array}
     }
     */
    RIFFFile.signature = {
      /** @type {string} */
      chunkId: '',
      /** @type {number} */
      chunkSize: 0,
      /** @type {string} */
      format: '',
      /** @type {!Array<Object>} */
      subChunks: []
    };

    Contributing to riff-file

    riff-file welcomes all contributions from anyone willing to work in good faith with other contributors and the community. No contribution is too small and all contributions are valued.

    See CONTRIBUTING.md for details.

    Style guide

    riff-file code should follow the Google JavaScript Style Guide:
    https://google.github.io/styleguide/jsguide.html

    Code of conduct

    This project is bound by a Code of Conduct: The Contributor Covenant, version 1.4, also available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

    LICENSE

    Copyright (c) 2019 Rafael da Silva Rocha.

    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 riff-file

    DownloadsWeekly Downloads

    141

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    25.5 kB

    Total Files

    9

    Last publish

    Collaborators

    • rochars