pymididefs 0.2.4__tar.gz

pymididefs-0.2.4/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.pyc
+.pytest_cache/
+*.egg-info/
+dist/
+build/
+.claude/settings.local.json

pymididefs-0.2.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simon Holliday
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pymididefs-0.2.4/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: pymididefs
+Version: 0.2.4
+Summary: Comprehensive MIDI 1.0 and 2.0 constant definitions for Python.
+Project-URL: Homepage, https://github.com/simonholliday/PyMidiDefs
+Project-URL: Repository, https://github.com/simonholliday/PyMidiDefs
+Project-URL: Issues, https://github.com/simonholliday/PyMidiDefs/issues
+Author: Simon Holliday
+License-Expression: MIT
+License-File: LICENSE
+Keywords: constants,definitions,general-midi,midi,midi2,music
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio :: MIDI
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# PyMidiDefs
+
+Comprehensive MIDI 1.0 and 2.0 constant definitions for Python.
+
+A zero-dependency reference library providing named constants, lookup
+dictionaries, and utility functions for the MIDI specification. Covers
+note numbers, Control Change assignments, General MIDI instruments and
+percussion, status bytes, Standard MIDI File meta-events, MIDI 2.0
+Universal MIDI Packet (UMP) message types, and MIDI-CI capability inquiry
+constants.
+
+## Why PyMidiDefs?
+
+If you're building a Python synthesiser, sequencer, DAW, MIDI controller
+interface, music generator, or any application that sends or receives MIDI
+messages, you need the same set of protocol constants: note numbers, CC
+assignments, program change values, status bytes. These numbers are defined
+by the MIDI specification and never change, yet most projects end up
+re-defining them from scratch or copying them from unreliable sources.
+
+PyMidiDefs gives you a single, authoritative package with every constant
+sourced directly from the official MIDI specifications. It
+has no runtime dependencies and works with any MIDI library or framework --
+python-rtmidi, mido, pygame.midi, or your own socket-level implementation.
+
+## About MIDI
+
+MIDI (Musical Instrument Digital Interface) is a technical standard for
+communication between electronic musical instruments, computers, and audio
+devices. It was conceived in the early 1980s by Dave Smith of Sequential
+Circuits and Ikutaro Kakehashi of Roland, who proposed a Universal
+Synthesizer Interface to allow instruments from different manufacturers to
+talk to each other. The MIDI 1.0 Detailed Specification was published in
+August 1983 by the International MIDI Association (now the MIDI
+Manufacturers Association, MMA) and has remained backwards-compatible ever
+since.
+
+General MIDI (GM), standardised in 1991, defined a common set of 128
+instrument sounds and a percussion key map so that a MIDI file created on
+one device would sound broadly similar on another. The Standard MIDI File
+(SMF) format, also formalised in the early 1990s, became the universal way
+to store and exchange MIDI sequences.
+
+In January 2020, the MIDI Association announced MIDI 2.0 -- the first major
+update to the protocol in nearly four decades. MIDI 2.0 introduces the
+Universal MIDI Packet (UMP) format with higher-resolution velocity and
+controller values, per-note controllers, and bidirectional communication via
+MIDI-CI (Capability Inquiry) for automatic device configuration, profile
+negotiation, and property exchange. MIDI 2.0 is a strict superset of MIDI
+1.0; all existing MIDI 1.0 definitions remain valid.
+
+## Installation
+
+```bash
+pip install git+https://github.com/simonholliday/PyMidiDefs.git
+```
+
+## Modules
+
+| Module | Description |
+|--------|-------------|
+| `pymididefs.notes` | MIDI note numbers (C-1 to G9) and name/number conversion |
+| `pymididefs.cc` | Control Change number assignments (0-127), plus 14-bit pack/unpack helpers |
+| `pymididefs.rpn` | Standard Registered Parameter Numbers (RPN) and the 14-bit parameter conventions shared with NRPN |
+| `pymididefs.drums` | General MIDI Level 1 percussion key map |
+| `pymididefs.gm` | General MIDI Level 1 instrument program numbers and families |
+| `pymididefs.status` | MIDI 1.0 status bytes (channel voice, system common, system real-time) |
+| `pymididefs.meta` | Standard MIDI File meta-event type bytes |
+| `pymididefs.ump` | MIDI 2.0 Universal MIDI Packet message types and constants |
+| `pymididefs.ci` | MIDI 2.0 Capability Inquiry (MIDI-CI) constants |
+
+## Usage
+
+```python
+import pymididefs.notes
+import pymididefs.cc
+import pymididefs.drums
+import pymididefs.gm
+
+# Note constants
+pymididefs.notes.C4    # 60  (Middle C)
+pymididefs.notes.A4    # 69  (Concert pitch)
+
+# Note name conversion
+pymididefs.notes.note_to_name(60)     # "C4"
+pymididefs.notes.name_to_note("Db4")  # 61
+
+# Control Change numbers
+pymididefs.cc.SUSTAIN_PEDAL    # 64
+pymididefs.cc.FILTER_CUTOFF    # 74
+pymididefs.cc.CC_MAP["pan"]    # 10
+
+# GM percussion
+pymididefs.drums.KICK_1              # 36
+pymididefs.drums.HI_HAT_CLOSED       # 42
+pymididefs.drums.GM_DRUM_MAP["snare_1"]  # 38
+pymididefs.drums.KICK                # 36  (unnumbered "primary" alias of KICK_1)
+pymididefs.drums.GM_DRUM_PRIMARY_ALIASES["crash"]  # 49
+
+# GM instruments
+pymididefs.gm.ACOUSTIC_GRAND_PIANO   # 0
+pymididefs.gm.VIOLIN                 # 40
+pymididefs.gm.GM_INSTRUMENT_NAMES[40]    # "Violin"
+pymididefs.gm.GM_INSTRUMENT_MAP["flute"]  # 73
+```
+
+### RPN and 14-bit values
+
+```python
+import pymididefs.rpn
+import pymididefs.cc
+
+# Standard Registered Parameter Numbers
+pymididefs.rpn.PITCH_BEND_SENSITIVITY  # 0
+pymididefs.rpn.MODULATION_DEPTH_RANGE  # 5  (added in GM2)
+pymididefs.rpn.NULL_PARAMETER          # 16383  (sent as MSB=127, LSB=127)
+
+# 14-bit pack/unpack — works for any MIDI 1.0 14-bit value
+# (Bank Select, Data Entry, RPN/NRPN parameter numbers, pitch bend, ...)
+pymididefs.cc.pack_14bit(8192)         # (64, 0)   pitch bend centre
+pymididefs.cc.unpack_14bit(64, 0)      # 8192
+```
+
+### MIDI 2.0
+
+```python
+import pymididefs.ump
+import pymididefs.ci
+
+# Universal MIDI Packet message types
+pymididefs.ump.MIDI2_CHANNEL_VOICE  # 0x4
+pymididefs.ump.NOTE_ON              # 0x9
+pymididefs.ump.PROTOCOL_MIDI2       # 0x02
+
+# MIDI-CI
+pymididefs.ci.DISCOVERY       # 0x70
+pymididefs.ci.PROFILE_INQUIRY # 0x20
+```
+
+## Sources
+
+All definitions are sourced from the official MIDI specifications published by
+the [MIDI Association](https://midi.org/specs):
+
+- [MIDI 1.0 Detailed Specification](https://midi.org/midi-1-0-detailed-specification) (MMA/AMEI)
+- [General MIDI Level 1 Specification](https://midi.org/general-midi-level-1)
+- [General MIDI 2 Specification](https://midi.org/general-midi-2)
+- [Standard MIDI File 1.0 Specification](https://midi.org/standard-midi-files)
+- [M2-104-UM v1.1 — Universal MIDI Packet (UMP) Format and MIDI 2.0 Protocol Specification](https://midi.org/universal-midi-packet-ump-and-midi-2-0-protocol-specification)
+- [M2-101-UM v1.2 — MIDI-CI Specification](https://midi.org/midi-ci-specification)
+
+Some specifications require a free [MIDI Association membership](https://midi.org/membership)
+to download.
+
+## License
+
+MIT -- you are free to use, copy, modify, merge, publish, distribute,
+sublicense, and sell copies of this software in any project, including
+commercial and closed-source applications. The only requirement is that you include the
+LICENSE file when redistributing the software. See [LICENSE](LICENSE)
+for the full text.

pymididefs-0.2.4/README.md

@@ -0,0 +1,161 @@
+# PyMidiDefs
+
+Comprehensive MIDI 1.0 and 2.0 constant definitions for Python.
+
+A zero-dependency reference library providing named constants, lookup
+dictionaries, and utility functions for the MIDI specification. Covers
+note numbers, Control Change assignments, General MIDI instruments and
+percussion, status bytes, Standard MIDI File meta-events, MIDI 2.0
+Universal MIDI Packet (UMP) message types, and MIDI-CI capability inquiry
+constants.
+
+## Why PyMidiDefs?
+
+If you're building a Python synthesiser, sequencer, DAW, MIDI controller
+interface, music generator, or any application that sends or receives MIDI
+messages, you need the same set of protocol constants: note numbers, CC
+assignments, program change values, status bytes. These numbers are defined
+by the MIDI specification and never change, yet most projects end up
+re-defining them from scratch or copying them from unreliable sources.
+
+PyMidiDefs gives you a single, authoritative package with every constant
+sourced directly from the official MIDI specifications. It
+has no runtime dependencies and works with any MIDI library or framework --
+python-rtmidi, mido, pygame.midi, or your own socket-level implementation.
+
+## About MIDI
+
+MIDI (Musical Instrument Digital Interface) is a technical standard for
+communication between electronic musical instruments, computers, and audio
+devices. It was conceived in the early 1980s by Dave Smith of Sequential
+Circuits and Ikutaro Kakehashi of Roland, who proposed a Universal
+Synthesizer Interface to allow instruments from different manufacturers to
+talk to each other. The MIDI 1.0 Detailed Specification was published in
+August 1983 by the International MIDI Association (now the MIDI
+Manufacturers Association, MMA) and has remained backwards-compatible ever
+since.
+
+General MIDI (GM), standardised in 1991, defined a common set of 128
+instrument sounds and a percussion key map so that a MIDI file created on
+one device would sound broadly similar on another. The Standard MIDI File
+(SMF) format, also formalised in the early 1990s, became the universal way
+to store and exchange MIDI sequences.
+
+In January 2020, the MIDI Association announced MIDI 2.0 -- the first major
+update to the protocol in nearly four decades. MIDI 2.0 introduces the
+Universal MIDI Packet (UMP) format with higher-resolution velocity and
+controller values, per-note controllers, and bidirectional communication via
+MIDI-CI (Capability Inquiry) for automatic device configuration, profile
+negotiation, and property exchange. MIDI 2.0 is a strict superset of MIDI
+1.0; all existing MIDI 1.0 definitions remain valid.
+
+## Installation
+
+```bash
+pip install git+https://github.com/simonholliday/PyMidiDefs.git
+```
+
+## Modules
+
+| Module | Description |
+|--------|-------------|
+| `pymididefs.notes` | MIDI note numbers (C-1 to G9) and name/number conversion |
+| `pymididefs.cc` | Control Change number assignments (0-127), plus 14-bit pack/unpack helpers |
+| `pymididefs.rpn` | Standard Registered Parameter Numbers (RPN) and the 14-bit parameter conventions shared with NRPN |
+| `pymididefs.drums` | General MIDI Level 1 percussion key map |
+| `pymididefs.gm` | General MIDI Level 1 instrument program numbers and families |
+| `pymididefs.status` | MIDI 1.0 status bytes (channel voice, system common, system real-time) |
+| `pymididefs.meta` | Standard MIDI File meta-event type bytes |
+| `pymididefs.ump` | MIDI 2.0 Universal MIDI Packet message types and constants |
+| `pymididefs.ci` | MIDI 2.0 Capability Inquiry (MIDI-CI) constants |
+
+## Usage
+
+```python
+import pymididefs.notes
+import pymididefs.cc
+import pymididefs.drums
+import pymididefs.gm
+
+# Note constants
+pymididefs.notes.C4    # 60  (Middle C)
+pymididefs.notes.A4    # 69  (Concert pitch)
+
+# Note name conversion
+pymididefs.notes.note_to_name(60)     # "C4"
+pymididefs.notes.name_to_note("Db4")  # 61
+
+# Control Change numbers
+pymididefs.cc.SUSTAIN_PEDAL    # 64
+pymididefs.cc.FILTER_CUTOFF    # 74
+pymididefs.cc.CC_MAP["pan"]    # 10
+
+# GM percussion
+pymididefs.drums.KICK_1              # 36
+pymididefs.drums.HI_HAT_CLOSED       # 42
+pymididefs.drums.GM_DRUM_MAP["snare_1"]  # 38
+pymididefs.drums.KICK                # 36  (unnumbered "primary" alias of KICK_1)
+pymididefs.drums.GM_DRUM_PRIMARY_ALIASES["crash"]  # 49
+
+# GM instruments
+pymididefs.gm.ACOUSTIC_GRAND_PIANO   # 0
+pymididefs.gm.VIOLIN                 # 40
+pymididefs.gm.GM_INSTRUMENT_NAMES[40]    # "Violin"
+pymididefs.gm.GM_INSTRUMENT_MAP["flute"]  # 73
+```
+
+### RPN and 14-bit values
+
+```python
+import pymididefs.rpn
+import pymididefs.cc
+
+# Standard Registered Parameter Numbers
+pymididefs.rpn.PITCH_BEND_SENSITIVITY  # 0
+pymididefs.rpn.MODULATION_DEPTH_RANGE  # 5  (added in GM2)
+pymididefs.rpn.NULL_PARAMETER          # 16383  (sent as MSB=127, LSB=127)
+
+# 14-bit pack/unpack — works for any MIDI 1.0 14-bit value
+# (Bank Select, Data Entry, RPN/NRPN parameter numbers, pitch bend, ...)
+pymididefs.cc.pack_14bit(8192)         # (64, 0)   pitch bend centre
+pymididefs.cc.unpack_14bit(64, 0)      # 8192
+```
+
+### MIDI 2.0
+
+```python
+import pymididefs.ump
+import pymididefs.ci
+
+# Universal MIDI Packet message types
+pymididefs.ump.MIDI2_CHANNEL_VOICE  # 0x4
+pymididefs.ump.NOTE_ON              # 0x9
+pymididefs.ump.PROTOCOL_MIDI2       # 0x02
+
+# MIDI-CI
+pymididefs.ci.DISCOVERY       # 0x70
+pymididefs.ci.PROFILE_INQUIRY # 0x20
+```
+
+## Sources
+
+All definitions are sourced from the official MIDI specifications published by
+the [MIDI Association](https://midi.org/specs):
+
+- [MIDI 1.0 Detailed Specification](https://midi.org/midi-1-0-detailed-specification) (MMA/AMEI)
+- [General MIDI Level 1 Specification](https://midi.org/general-midi-level-1)
+- [General MIDI 2 Specification](https://midi.org/general-midi-2)
+- [Standard MIDI File 1.0 Specification](https://midi.org/standard-midi-files)
+- [M2-104-UM v1.1 — Universal MIDI Packet (UMP) Format and MIDI 2.0 Protocol Specification](https://midi.org/universal-midi-packet-ump-and-midi-2-0-protocol-specification)
+- [M2-101-UM v1.2 — MIDI-CI Specification](https://midi.org/midi-ci-specification)
+
+Some specifications require a free [MIDI Association membership](https://midi.org/membership)
+to download.
+
+## License
+
+MIT -- you are free to use, copy, modify, merge, publish, distribute,
+sublicense, and sell copies of this software in any project, including
+commercial and closed-source applications. The only requirement is that you include the
+LICENSE file when redistributing the software. See [LICENSE](LICENSE)
+for the full text.

pymididefs-0.2.4/pymididefs/__init__.py

@@ -0,0 +1,34 @@
+"""PyMidiDefs — comprehensive MIDI 1.0 and 2.0 constant definitions for Python.
+
+A zero-dependency reference library covering the MIDI 1.0 Detailed Specification,
+General MIDI Level 1, Universal MIDI Packet (UMP) format, and MIDI-CI.
+
+Modules
+-------
+notes   — MIDI note numbers and name/number conversion.
+cc      — Control Change number assignments and 14-bit pack/unpack helpers.
+rpn     — Standard Registered Parameter Numbers and the 14-bit parameter conventions shared with NRPN.
+drums   — General MIDI Level 1 percussion key map.
+gm      — General MIDI Level 1 instrument program numbers and families.
+status  — MIDI 1.0 status bytes (channel voice, system common, system real-time).
+meta    — Standard MIDI File meta-event type bytes.
+ump     — MIDI 2.0 Universal MIDI Packet message types and constants.
+ci      — MIDI 2.0 Capability Inquiry (MIDI-CI) constants.
+"""
+
+import importlib.metadata
+
+import pymididefs.notes
+
+# Version is derived from the latest git tag at build time via hatch-vcs;
+# `importlib.metadata` then reads it from the installed package metadata.
+# The fallback only fires if someone runs from a raw source checkout without
+# installing the package (e.g. directly from a git clone with no `pip install`).
+try:
+	__version__ = importlib.metadata.version("pymididefs")
+except importlib.metadata.PackageNotFoundError:
+	__version__ = "0.0.0+unknown"
+
+# Convenience re-exports for the most common operations.
+note_to_name = pymididefs.notes.note_to_name
+name_to_note = pymididefs.notes.name_to_note