| Name | miditoolkit JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | |
| Summary | A python package for working with MIDI data files. |
| upload_time | 2023-11-23 08:22:32 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7.0 |
| license | |
| keywords |
midi
mir
music
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Miditoolkit
A Python package for working with MIDI files.
[](https://pypi.python.org/pypi/miditoolkit/)
[](https://www.python.org/downloads/release/)
[](https://github.com/YatingMusic/miditoolkit/actions/workflows/pytest.yml)
[](https://github.com/YatingMusic/miditoolkit/blob/main/LICENSE)
[](https://pepy.tech/project/miditoolkit)
[](https://github.com/psf/black)
Miditoolkit works by loading/writing MIDIs with [mido](https://github.com/mido/mido) in a user-friendly way. It is inspired from [pretty_midi](https://github.com/craffel/pretty-midi), with similar usage and core features, but handles the MIDI events in native **[ticks](https://www.recordingblogs.com/wiki/midi-tick)** time unit instead of seconds. It also comes with a few optimizations and speed-ups, and can parse MIDI tracks into **piano-rolls** for computation or visualization purposes.
If you are working with seconds time units (for e.g. music transcription), you'll be likely better with pretty_midi. Otherwise, if you are working solely on MIDI and symbolic music, miditoolkit should provide slightly faster performances.
## Main Features
* MIDI
* Global
* ticks per beat
* tempo changes
* key signatures
* time signatures
* lyrics
* markers
* Instruments
* control changes
* pitch bend
* Editing
* chunk/cropping
* IO
* BytesIO
* Piano-rolls
* Tools
* notes to piano-rolls
* piano-rolls to notes
* chromagram
* Visualization
* External Library
* [structure analysis](https://github.com/wayne391/sf_segmenter)
## TODO
* better documentation;
* finish the code cleaning of the pianoroll methods (vis);
* a way to switch the time in seconds across the whole MidiFile object;
* cropping Control Changes and bars;
* symbolic features
* new structural analysis
## Installation
You can install miditoolkit via [PYPI](https://pypi.org/project/miditoolkit/):
```bash
pip install miditoolkit
```
... or directly from git if you want to get the latest features or fixes (only recommended if you need it):
```bash
pip install git+https://github.com/YatingMusic/miditoolkit
```
## Example Usage
```python
from miditoolkit import MidiFile
from miditoolkit.midi.utils import example_midi_file
path_midi = example_midi_file()
midi_obj = MidiFile(path_midi)
print(midi_obj)
```
Output:
```
ticks per beat: 480
max tick: 72002
tempo changes: 68
time sig: 2
key sig: 0
markers: 71
lyrics: False
instruments: 2
```
A. [Parse and create MIDI files](examples/parse_and_create_MIDI_files.ipynb)
B. [Piano-roll Manipulation](examples/pinoroll_manipulation.ipynb)
## Philosophy
* [mido](https://github.com/mido/mido) processes MIDI files in the lower level such as messages and ports, and is the backend pretty_midi and miditoolkit;
* [pretty_midi](https://github.com/craffel/pretty-midi) parses MIDI files and pianorolls in seconds time unit, plus has audio related features;
* [pypianoroll](https://github.com/salu133445/pypianoroll) parses MIDI files into pianorolls in ticks time unit.
**Miditoolkit** is designed for handling MIDI in **[ticks](https://www.recordingblogs.com/wiki/midi-tick)**, the native time unit of the MIDI protocol. We keep the midi parser as simple as possible, and offer several important functions to complete the versatility. For example, piano-rolls, tick-to-second, chromagram, etc.
Raw data
{
"_id": null,
"home_page": "",
"name": "miditoolkit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": "",
"keywords": "midi,mir,music",
"author": "",
"author_email": "wayne391 <s101062219@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ed/85/67eb411c91e5b3ff1c04c2396c1ca4464acad533905b7998283844739242/miditoolkit-1.0.1.tar.gz",
"platform": null,
"description": "# Miditoolkit\n\nA Python package for working with MIDI files.\n\n[](https://pypi.python.org/pypi/miditoolkit/)\n[](https://www.python.org/downloads/release/)\n[](https://github.com/YatingMusic/miditoolkit/actions/workflows/pytest.yml)\n[](https://github.com/YatingMusic/miditoolkit/blob/main/LICENSE)\n[](https://pepy.tech/project/miditoolkit)\n[](https://github.com/psf/black)\n\nMiditoolkit works by loading/writing MIDIs with [mido](https://github.com/mido/mido) in a user-friendly way. It is inspired from [pretty_midi](https://github.com/craffel/pretty-midi), with similar usage and core features, but handles the MIDI events in native **[ticks](https://www.recordingblogs.com/wiki/midi-tick)** time unit instead of seconds. It also comes with a few optimizations and speed-ups, and can parse MIDI tracks into **piano-rolls** for computation or visualization purposes.\nIf you are working with seconds time units (for e.g. music transcription), you'll be likely better with pretty_midi. Otherwise, if you are working solely on MIDI and symbolic music, miditoolkit should provide slightly faster performances.\n\n## Main Features\n\n* MIDI\n * Global\n * ticks per beat\n * tempo changes\n * key signatures\n * time signatures\n * lyrics\n * markers\n * Instruments\n * control changes\n * pitch bend\n * Editing\n * chunk/cropping\n * IO\n * BytesIO\n* Piano-rolls\n * Tools\n * notes to piano-rolls\n * piano-rolls to notes\n * chromagram\n * Visualization\n* External Library\n * [structure analysis](https://github.com/wayne391/sf_segmenter)\n\n## TODO\n\n* better documentation;\n* finish the code cleaning of the pianoroll methods (vis);\n* a way to switch the time in seconds across the whole MidiFile object;\n* cropping Control Changes and bars;\n* symbolic features\n* new structural analysis\n\n## Installation\n\nYou can install miditoolkit via [PYPI](https://pypi.org/project/miditoolkit/):\n\n```bash\npip install miditoolkit\n```\n\n... or directly from git if you want to get the latest features or fixes (only recommended if you need it):\n\n```bash\npip install git+https://github.com/YatingMusic/miditoolkit\n```\n\n## Example Usage\n\n```python\nfrom miditoolkit import MidiFile\nfrom miditoolkit.midi.utils import example_midi_file\n\npath_midi = example_midi_file()\nmidi_obj = MidiFile(path_midi)\n\nprint(midi_obj)\n```\n\nOutput:\n\n```\nticks per beat: 480\nmax tick: 72002\ntempo changes: 68\ntime sig: 2\nkey sig: 0\nmarkers: 71\nlyrics: False\ninstruments: 2\n```\n\nA. [Parse and create MIDI files](examples/parse_and_create_MIDI_files.ipynb)\nB. [Piano-roll Manipulation](examples/pinoroll_manipulation.ipynb)\n\n## Philosophy\n\n* [mido](https://github.com/mido/mido) processes MIDI files in the lower level such as messages and ports, and is the backend pretty_midi and miditoolkit;\n* [pretty_midi](https://github.com/craffel/pretty-midi) parses MIDI files and pianorolls in seconds time unit, plus has audio related features;\n* [pypianoroll](https://github.com/salu133445/pypianoroll) parses MIDI files into pianorolls in ticks time unit.\n\n**Miditoolkit** is designed for handling MIDI in **[ticks](https://www.recordingblogs.com/wiki/midi-tick)**, the native time unit of the MIDI protocol. We keep the midi parser as simple as possible, and offer several important functions to complete the versatility. For example, piano-rolls, tick-to-second, chromagram, etc.\n",
"bugtrack_url": null,
"license": "",
"summary": "A python package for working with MIDI data files.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/YatingMusic/miditoolkit"
},
"split_keywords": [
"midi",
"mir",
"music"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "173ad2c741e404efe31700e971b5b93c96eb5a8e9a5100dc69cb7fef39f83d80",
"md5": "54b43730d19e3890c151c12bfaad6923",
"sha256": "b2067e896e99b2f33934678202853664324eb2ad51999bbfc909d85c8e665e2d"
},
"downloads": -1,
"filename": "miditoolkit-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "54b43730d19e3890c151c12bfaad6923",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 24463,
"upload_time": "2023-11-23T08:22:30",
"upload_time_iso_8601": "2023-11-23T08:22:30.767522Z",
"url": "https://files.pythonhosted.org/packages/17/3a/d2c741e404efe31700e971b5b93c96eb5a8e9a5100dc69cb7fef39f83d80/miditoolkit-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed8567eb411c91e5b3ff1c04c2396c1ca4464acad533905b7998283844739242",
"md5": "4afbcaa6c637afdfa500d41aaaa8f332",
"sha256": "88f7ba5bcf6438bd303a0654f808a6eef6f573bcb6b9f5ebd649e78fc786b2c5"
},
"downloads": -1,
"filename": "miditoolkit-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "4afbcaa6c637afdfa500d41aaaa8f332",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 22369,
"upload_time": "2023-11-23T08:22:32",
"upload_time_iso_8601": "2023-11-23T08:22:32.918718Z",
"url": "https://files.pythonhosted.org/packages/ed/85/67eb411c91e5b3ff1c04c2396c1ca4464acad533905b7998283844739242/miditoolkit-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-23 08:22:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "YatingMusic",
"github_project": "miditoolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "miditoolkit"
}
