Code Monkey home page Code Monkey logo

midiexplorer's Introduction

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.

midiexplorer's People

Contributors

denilsonsa avatar dependabot[bot] avatar rdoursenaud avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar

Forkers

denilsonsa

midiexplorer's Issues

DearPyGUI v1.9.x compatibility

Tried updating to DearPyGui v1.9.1 under Python 3.11 on Microsoft Windows 11.

The GUI doesn't respond to any MIDI input despite the messages showing in the DEBUG log.

Investigate.

Missing Project Roadmap

I found this project by a Google search and is very interested, especially around the “Support proprietary formats”. I’m only able to find a “To-do list”, but not a planned “roadmap” for when the different features are planned to be rolled out.

Improve font rendering on Windows

Improve the font rendering for Windows specifically by using the following code.

import ctypes
# Include the following code before showing the viewport/calling `dearpygui.dearpygui.show_viewport` and set a bigger font size with DPG.
ctypes.windll.shcore.SetProcessDpiAwareness(2)

Dependency on dearpygui 1.6.2?

Hi there,
This seems like a great tool! I've been trying to install midiexplorer on macOS, but pip complains that that there is a dependency on the 1.6.2 version of dearpygui specifically, and it can't acquire that version.
Is it actually dependent on that exact version, or would 1.6.2 or later be compatible? I believe the current version is now 1.9.1.
Thanks!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.