Skip to main content

CircuitPython helper for parsing MIDI files

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython helper for parsing MIDI files

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-midi-parser

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-midi-parser

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-midi-parser

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_midi_parser

Or the following command to update an existing version:

circup update

Usage Example

import os

import adafruit_midi_parser

midi_file = "/song.mid"

print("MIDI File Analyzer")
print("=================")
print(f"Looking for: {midi_file}")
file_list = os.listdir("/")
if midi_file[1:] in file_list:
    print(f"\nFound MIDI file {midi_file}")
    parser = adafruit_midi_parser.MIDIParser(midi_file)
    print("\nParsing MIDI file...")
    parser.parse()
    print("\nMIDI File Information:")
    print("=====================")
    print(f"Format Type: {parser.format_type}")
    print(f"Number of Tracks: {parser.num_tracks}")
    print(f"Ticks per Beat: {parser.ticks_per_beat}")
    print(f"Tempo: {parser.tempo} microseconds per quarter note")
    print(f"BPM: {parser.bpm:.1f}")
    print(f"Total Events: {len(parser.events)}")
    print(f"Note Count: {parser.note_count}")
else:
    print(f"MIDI file {midi_file} not found!")
print("\nDone!")

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_midi_parser-1.0.0.tar.gz (28.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit_circuitpython_midi_parser-1.0.0.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_midi_parser-1.0.0.tar.gz
Algorithm Hash digest
SHA256 ce5e16ddaf1f66b85d81ae773364fe200f3f7d51bef9fd430174011af27e18e4
MD5 0c613a5012c12d93c54fc117a8232e6f
BLAKE2b-256 aae277cfc5651967ec6cfc259136a0c01f60a9dcb2cb32565696e54af00b091c

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_midi_parser-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_midi_parser-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 614b9b14ac0fac539c73e096f95be2b07fdba1777cd82b4bd1a56195425b0e4c
MD5 097481cbc05b0851980f1bae7d323903
BLAKE2b-256 96d9e11ef775ac8b51e6a5899d74f0e7f71ec6da3ca4a41e79ff043b5f38a611

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page