Pre-release

This release is a pre-release and may not be stable for production use.

MIDI Explorer LogoMIDI Explorer

License: GPL v3 PyPI - Python Version Downloads PyPI - Version

Yet another MIDI monitor, analyzer, debugger and manipulation tool.

GUI

SMF GUI

The intent is to be specifications compliant to help debugging, reverse-engineering and developing products based on the MIDI protocol while learning everything there is to know in the process.

The reference specifications used are linked below and comes from the following standards bodies:

There is two specification supplement types:

  • Recommended Practices (RP) 001-054
  • Confirmation of Approval for MIDI Standard (CA) 018-035

A nice history list is provided by the MSC [JP].
I have made a translated and slightly updated Google Sheet for easier browsing.

Language is currently Python to help with rapid prototyping and fast iteration. It may change at any time as I see fit.

Table of Contents

Status

Basic features implemented.

First alpha released!

Testers welcome ;)

Installation (Python)

Install Python 3.10

From python.org (recommended) or your favorite package manager.

Install PipX

Follow the instructions for your operating system.

Microsoft Windows

In a terminal

py -m pip install --user pipx
py -m pipx ensurepath

Close and reopen your terminal.

Mac OS X / Linux

python3 -m pip install --user pipx

Install MIDI Explorer

pipx install midiexplorer

Installation (Native)

Nuitka (alpha)

You may also build a compiled, single-file executable from a properly configured venv using:

python -m nuitka --follow-imports --include-package=rtmidi --include-package=mido --include-package=dearpygui --include-package=dearpygui_ext --include-package=midiexplorer --include-package-data=midiexplorer --onefile --disable-console --windows-icon-from-ico=src\midiexplorer\icons\midiexplorer.ico src/midiexplorer

Features & TODO

Documentation

Quality

  • Linting
    • Code style checks? (PEP8 pycodestyle)
    • Docstrings? (darglint)
    • Typechecking? (mypy)
  • Unit tests? (pytest)
    • Coverage
  • Packaging
  • Continuous Integration? (GitHub Actions workflow)

MIDI protocols

  • (WIP) v1.0
    includes RP-001/RP-002/RP-003/RP-004/RP-005/RP-006/RP-007/RP-008/RP-009/RP-010/RP-011/RP-012/RP-013/RP-014
    (1983 - February 1996)
    Using a modified mido
  • v2.0
    (Planned long term: after v1.0 and all its extensions are fully stable)

Platform support

Interactive GUI

  • Icons
  • Fonts
  • Custom theme
  • About window
  • Connections window (Node editor based)
    • Inputs
    • Outputs
    • Modules
  • History window (Table)
  • Monitor data window (Decoding with live feedback)
  • Generator data window
  • (WIP) Standard MIDI file window
  • Log window
    • Insert comment
    • Save to file
      • Overwrite
      • Append
  • Actions (Menus and/or keyboard shortcuts)
    • Toggle connections (F1)
    • Toggle history (F2)
    • Toggle monitor (F3)
    • Toggle generator (F4)
    • Toggle standard MIDI file (F5)
    • Toggle full-screen (F11)
    • Toggle log (F12)
    • Save & restore windows state
      (Buggy at the moment)

I/O management

  • List MIDI I/O
    • USB MIDI 1.0
      • OS Level
      • Direct Access?
    • USB MIDI 2.0
      • OS Level?
      • Direct Access?
    • IEEE-1394
      RP-027 (MMA) MIDI Media Adaptation Layer for IEEE-1394 v1.0
      RP-027 (AMEI/MSC) MIDI Media Adaptation Layer for IEEE-1394 v1.0
      • OS Level?
        (Probably works but no hardware to test with)
      • Direct Access?
    • Bluetooth Low Energy (BLE-MIDI)
      RP-052 (MMA) Specification for MIDI over Bluetooth Low Energy (BLE-MIDI) v1.0
      RP-052 (AMEI/MSC) Specification for MIDI over Bluetooth Low Energy (BLE-MIDI) v1.0
      • OS Level
        Requires WinRt MIDI for Microsoft Windows
      • Direct Access?
    • RTP-MIDI
      RTP Payload Format for MIDI (MMA)
      IETF RFC 6295 RTP Payload Format for MIDI
      • (Partial) OS Level
        Requires rtpMIDI for Microsoft Windows
        (Works with Microsoft Windows. Untested on other OS)
      • Direct Access?
    • Virtual
      • OS Level
        Requires loopMIDI for Microsoft Windows
      • Native
        Provided by RtMidi for Linux & Apple Mac OS X
    • Custom Hardware
      (Planned in the near future. Prototyping in progress.)
  • Select mido backend?
    (Only RtMidi suits our needs)
  • Input reading modes
    • Polling
    • Callback
  • Sort by ID/Name
    (Forced name sorting is enough for now)
  • Connections
    • Port to probe
    • Probe to port
    • Port to port
    • Port to any module
    • Any module to port
    • Module to module
  • Refresh
    • Manual
    • Auto with reconnect
  • Virtual ports
    • Add/Remove
  • Save/restore connections status
  • Timing
    • System
      (Computed using the highest resolution local clock available)
    • Hardware
      (Retrieved using a modified mido RtMidi backend)

History view (Table decode)

  • Input
  • Output
  • Selection decodes to monitor
  • Selection prepares generator
  • Color code?
    • Per source
    • Per channel
    • Per message type

Modules

MIDI implementation charts

Prior art

Legal notice

License

GPLv3

Author: ©2021-2023 Raphaël Doursenaud.

This software is released under the terms of the GNU General Public License, version 3.0 or later (GPL-3.0-or-later).

See LICENSE.

Logo and icons released under the Creative Commons Attribution-Share Alike 4.0 International.

Dependencies & License Acknowledgment

  • Python v3.10
    Copyright © 2001-2022 Python Software Foundation.
    Used under the terms of the PSF License Agreement.
  • RtMidi
    Copyright (c) 2003-2021 Gary P. Scavone.
    Used under the terms of the MIT license.
  • via python-rtmidi
    Copyright (c) 2012 - 2021 Christopher Arndt.
    Used under the terms of the MIT license.
  • via mido
    Copyright (c) 2013-infinity Ole Martin Bjørndalen.
    Used under the terms of the MIT license.
  • Dear ImGui
    Copyright (c) 2014-2022 Omar Cornut.
    Used under the terms of the MIT license.
  • via Dear PyGui
    Copyright (c) 2021 Dear PyGui, LLC.
    Used under the terms of the MIT license.

Fonts

  • Roboto
    Copyright (c) 2015 The Roboto Project Authors.
    Used under the terms of the Apache License, Version 2.0.
  • Roboto Mono
    Copyright (c) 2015 The Roboto Mono Project Authors.
    Used under the terms of the Apache License, Version 2.0.

Logo and icons

Composite work based upon:

Trademarks

MIDI is a trademark of the MIDI Manufacturers Association (MMA) in the United States of America.

This is not a registered trademark in the European Union and France where I reside.

Other

Other trademarks are property of their respective owners and used fairly for descriptive and nominative purposes only.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for rdoursenaud from gravatar.com rdoursenaud

Credits

Author: Raphaël Doursenaud

License

GNU General Public License v3 or later (GPLv3+) (GNU GENERAL PUBLIC LICENSE)

Requires

Python >=3.10

Tags

Analyzer Debugger MIDI

Classifiers

Metadata

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for rdoursenaud from gravatar.com rdoursenaud

Credits

Author: Raphaël Doursenaud

License

GNU General Public License v3 or later (GPLv3+) (GNU GENERAL PUBLIC LICENSE)

Requires

Python >=3.10

Tags

Analyzer Debugger MIDI

Classifiers

Release files for midiexplorer 0.0.1a5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for midiexplorer 0.0.1a5
File Size Uploaded Provenance
midiexplorer-0.0.1a5.tar.gz 351.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for midiexplorer 0.0.1a5
File Interpreter ABI Platform
midiexplorer-0.0.1a5-py3-none-any.whl 364.2 kB Without provenance Python 3 none any Details

Total release size: 715.2 kB

Release files / midiexplorer-0.0.1a5.tar.gz

Download URL midiexplorer-0.0.1a5.tar.gz
Size 351.0 kB
Tags Source
SHA-256 checksum
How to use checksums 		ba8c13b79dcfc7cbae6f57e179ee4a155d94eaa87950cf5041d81cf945cc04c2
BLAKE2b-256 checksum
How to use checksums 		61dfc83b047bc57e143ec3f27a5c97a7e566fe037e4a98a70cc1c0a7ac1c4059
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via python-httpx/0.24.1

Release files / midiexplorer-0.0.1a5-py3-none-any.whl

Download URL midiexplorer-0.0.1a5-py3-none-any.whl
Size 364.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums 		830ff3f08b32651d29c2aad999ba68b44357eef11c7f909fa211a7134ee52e6a
BLAKE2b-256 checksum
How to use checksums 		761bdb1afb00b84ad37feec926d9050685757818cfce0a244465107678d3bdf6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing? 		No
Uploaded via python-httpx/0.24.1

Security for midiexplorer 0.0.1a5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page