Make sure the open source you're using is safe to use
midifile
v2.0.0Read/write standard MIDI files.
npm install midifile
We couldn't find any similar packages Browse all packages
Package Health Score
49 / 100
- Popularity Limited
- Maintenance Inactive
- Security No known security issues
- Community Limited
Make sure the open source you're using is safe to usePopularity
Limited
Weekly Downloads (73)- Dependents
- 9
- GitHub Stars
- 176
- Forks
- 28
- Contributors
- 10
The npm package midifile receives a total of 73 downloads a week. As such, we scored midifile popularity level to be Limited.
Based on project statistics from the GitHub repository for the npm package midifile, we found that it has been starred 176 times, and that 9 other projects in the ecosystem are dependent on it.
Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.
Security
No known security issues
Security and license risk for significant versions
All VersionsDirect Vulnerabilities
0.1.3
0.2.0
1.0.4
2.0.0
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
Indirect Vulnerabilities
0.1.3
0.2.0
1.0.4
2.0.0
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
License Risks
0.1.3
0.2.0
1.0.4
2.0.0
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
- 0H
- 0M
- 0L
All security vulnerabilities belong to
production dependencies of direct and indirect
packages.
We found a way for you to contribute to the project! Looks like midifile is missing a security policy.
You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.
We found a way for you to contribute to the project! Looks like midifile is missing a security policy.
# Install the Snyk CLI and test your project
npm i snyk && snyk test midifile
Maintenance
Inactive
Commit Frequency- Open Issues
- 5
- Merged PR
- 10
- Open PR
- 0
- Last Commit
- 3 years ago
Further analysis of the maintenance status of midifile based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.
An important project maintenance signal to consider for midifile is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.
In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.
Community
Limited
- Readme.md
- No
- Contributing.md
- No
- Code of Conduct
- Yes
- Contributors
- 10
- Funding
- No
This project has seen only 10 or less contributors.
How about a good first contribution to this project? It seems that midifile is missing a README file.
Embed Package Health Score Badge
Package
- Node.js Compatibility
- >=6.9.5
- Age
- 8 years
- Dependencies
- 2 Direct / 2 Total
- Versions
- 11
- Install Size
- 1.34 MB
- Dist-tags
- 1
- # of Files
- 128
- Maintainers
- 3
- TS Typings
- No
We detected a total of 2 direct & transitive dependencies for midifile. See the full dependency tree of midifile
midifile has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.
midifile
Read/write standard MIDI files.
MIDIFile uses the MIDIEvents project and is part of the MIDIPlayer one. You can also check this Karaoke Player built on top of those libraries.
What it does
- Read MIDI files
- Check MIDI file structure (using strictMode)
- Write MIDI files (still experimental)
What it doesn't do
- Playing MIDI files. It's the role of the MIDIPlayer project.
Usage
// Your variable with your MIDI file as an ArrayBuffer or UInt8Array instance
var anyBuffer;
// Creating the MIDIFile instance
var midiFile = new MIDIFile(anyBuffer);
// Reading headers
midiFile.header.getFormat(); // 0, 1 or 2
midiFile.header.getTracksCount(); // n
// Time division
if(midiFile.header.getTimeDivision() === MIDIFile.Header.TICKS_PER_BEAT) {
midiFile.header.getTicksPerBeat();
} else {
midiFile.header.getSMPTEFrames();
midiFile.header.getTicksPerFrame();
}
// MIDI events retriever
var events = midiFile.getMidiEvents();
events[0].subtype; // type of [MIDI event](https://github.com/nfroidure/MIDIFile/blob/master/src/MIDIFile.js#L34)
events[0].playTime; // time in ms at wich the event must be played
events[0].param1; // first parameter
events[0].param2; // second one
// Lyrics retriever
var lyrics = midiFile.getLyrics();
if ( lyrics.length ) {
lyrics[0].playTime; // Time at wich the text must be displayed
lyrics[0].text; // The text content to be displayed
}
// Reading whole track events and filtering them yourself
var events = midiFile.getTrackEvents(0);
events.forEach(console.log.bind(console));
// Or for a single track
var trackEventsChunk = midiFile.tracks[0].getTrackContent();
var events = MIDIEvents.createParser(trackEventsChunk);
var event;
while(event = events.next()) {
// Printing meta events containing text only
if(event.type === MIDIEvents.EVENT_META && event.text) {
console.log('Text meta: '+event.text);
}
}
Testing
Unit tests are using mocha and NodeJS. Install them and run the following command:
mocha tests/*.mocha.js
Why ArrayBuffers ?
ArrayBuffer instances are the best way to manage binary data like MIDI files.
Why not streams ?
The Standard MIDI files format isn't streamable by nature. If you want to stream MIDI file contents, you should consider transforming your files in another format (plain linearized MIDI events should do the job).
Requirements
- ArrayBuffer, DataView or their polyfills
Contributing
- Feel free to PR
- If you find a MIDI File the library can't read an if it's under a free, PR the file in the sounds folder and add tests for him. I'll work on it asap.
License
midifile versions
| Version | Published | Tag | Node.js Compatability | Licenses | Dependencies | Direct Vulnerabilities | Publisher |
|---|---|---|---|---|---|---|---|
| 2.0.0 | 29 April 2018 | latest | >=6.9.5 | MIT | 2 |
| nfroidure |
| 1.0.4 | 09 January 2016 | * | MIT | 2 |
| nfroidure | |
| 0.2.0 | 16 December 2013 | * | 2 |
| nfroidure | ||
| All Versions | |||||||
midifile dependencies
Last updated on
11 January-2021, at 20:58 (UTC).