{"id":50816137,"url":"https://github.com/ydah/mtmidi-ruby","last_synced_at":"2026-06-13T09:33:59.889Z","repository":{"id":342733967,"uuid":"1174164741","full_name":"ydah/mtmidi-ruby","owner":"ydah","description":"Ruby FFI bindings for RtMidi with Ruby-idiomatic MIDI input/output, typed messages, and low-level C API access.","archived":false,"fork":false,"pushed_at":"2026-03-07T05:04:32.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-07T12:16:17.157Z","etag":null,"topics":["audio","bindings","ffi","gem","linux","macos","music","ruby","windows"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ydah.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-06T06:15:54.000Z","updated_at":"2026-03-07T04:45:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ydah/mtmidi-ruby","commit_stats":null,"previous_names":["ydah/mtmidi-ruby"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ydah/mtmidi-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fmtmidi-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fmtmidi-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fmtmidi-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fmtmidi-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ydah","download_url":"https://codeload.github.com/ydah/mtmidi-ruby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fmtmidi-ruby/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34279898,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-13T02:00:06.617Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["audio","bindings","ffi","gem","linux","macos","music","ruby","windows"],"created_at":"2026-06-13T09:33:56.249Z","updated_at":"2026-06-13T09:33:59.884Z","avatar_url":"https://github.com/ydah.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# rtmidi-ruby\n\n`rtmidi-ruby` is a Ruby FFI binding for the RtMidi C API (`rtmidi_c.h`).\nIt exposes the low-level C bindings through `Rtmidi::Native` and a higher-level\nRuby API through `Rtmidi::MidiIn`, `Rtmidi::MidiOut`, and `Rtmidi::Message`.\n\n## Features\n\n- `Rtmidi.version`, `Rtmidi.compiled_apis`, and API name helpers\n- low-level access to the RtMidi C API via `Rtmidi::Native`\n- `Rtmidi::MidiIn` with callback and polling based input\n- `Rtmidi::MidiOut` helpers for channel, system common, and realtime messages\n- typed MIDI messages through `Rtmidi::Message`\n- virtual port support\n\n## Requirements\n\n- Ruby 3.1+\n- a system `librtmidi` that provides the RtMidi C API\n\nInstall `librtmidi` with your package manager:\n\n- macOS: `brew install rtmidi`\n- Ubuntu/Debian: `sudo apt install librtmidi-dev`\n- Fedora: `sudo dnf install rtmidi-devel`\n- Arch: `sudo pacman -S rtmidi`\n- Windows: install an RtMidi DLL and make sure it is on `PATH`\n\nIf the library is installed in a non-standard location, set `RTMIDI_LIB_PATH`.\n\n```bash\nRTMIDI_LIB_PATH=/path/to/librtmidi.dylib bundle exec ruby your_script.rb\n```\n\nSome `librtmidi` builds do not expose `rtmidi_set_error_callback`. In that case,\nnormal MIDI I/O still works, but `on_error` callbacks are unavailable.\n\n## Installation\n\nAdd the gem to your Gemfile:\n\n```ruby\ngem \"rtmidi-ruby\"\n```\n\nThen install dependencies:\n\n```bash\nbundle install\n```\n\nOr install the gem directly:\n\n```bash\ngem install rtmidi-ruby\n```\n\n## Quick Start\n\n```ruby\nrequire \"rtmidi\"\n\nputs \"RtMidi version: #{Rtmidi.version}\"\nputs \"Compiled APIs: #{Rtmidi.compiled_apis.inspect}\"\n```\n\n### List Ports\n\n```ruby\nrequire \"rtmidi\"\n\nout = Rtmidi::MidiOut.new\nputs \"Output ports:\"\nout.port_names.each_with_index { |name, index| puts \"  #{index}: #{name}\" }\nout.close\n\ninput = Rtmidi::MidiIn.new\nputs \"Input ports:\"\ninput.port_names.each_with_index { |name, index| puts \"  #{index}: #{name}\" }\ninput.close\n```\n\n### Send Note On/Off\n\n```ruby\nrequire \"rtmidi\"\n\nout = Rtmidi::MidiOut.new\n\nif out.port_count.zero?\n  warn \"No output ports available.\"\nelse\n  begin\n    out.open_port(0)\n    out.note_on(0, 60, 100)\n    sleep 0.5\n    out.note_off(0, 60)\n  ensure\n    out.close\n  end\nend\n```\n\n### Receive With Callback\n\n```ruby\nrequire \"rtmidi\"\n\nmidi_in = Rtmidi::MidiIn.new\n\nif midi_in.port_count.zero?\n  warn \"No input ports available.\"\n  midi_in.close\n  exit 0\nend\n\nbegin\n  midi_in.ignore_types(sysex: false, timing: false, active_sensing: false)\n  midi_in.open_port(0)\n\n  midi_in.on_message do |message, timestamp|\n    puts \"#{timestamp}: #{message.map { |byte| format('%02X', byte) }.join(' ')}\"\n  end\n\n  puts \"Listening... (Ctrl-C to quit)\"\n  sleep\nensure\n  midi_in\u0026.close\nend\n```\n\n### Receive With Polling\n\n```ruby\nrequire \"rtmidi\"\n\nmidi_in = Rtmidi::MidiIn.new\n\nif midi_in.port_count.zero?\n  warn \"No input ports available.\"\n  midi_in.close\n  exit 0\nend\n\nbegin\n  midi_in.open_port(0)\n\n  loop do\n    packet = midi_in.get_message\n    next if packet.nil?\n\n    message, timestamp = packet\n    puts \"#{timestamp}: #{message.inspect}\"\n\n    sleep 0.001\n  end\nensure\n  midi_in\u0026.close\nend\n```\n\n### Typed Messages\n\n`Rtmidi::Message` can parse raw bytes into typed structs and `MidiOut#send_message`\naccepts either raw byte arrays or typed messages.\n\n```ruby\nrequire \"rtmidi\"\n\nmessage = Rtmidi::Message.parse([0x92, 64, 96])\np message\n# =\u003e #\u003cstruct Rtmidi::Message::NoteOn channel=2, note=64, velocity=96\u003e\n\nout = Rtmidi::MidiOut.new\n\nif out.port_count.zero?\n  warn \"No output ports available.\"\nelse\n  begin\n    out.open_port(0)\n    out.send_message(Rtmidi::Message::ProgramChange.new(channel: 1, program: 10))\n  ensure\n    out.close\n  end\nend\n```\n\nFor typed input callbacks:\n\n```ruby\nmidi_in.on_message(parsed: true) do |message, timestamp|\n  p [message.class, message, timestamp]\nend\n```\n\n### System/Common and Realtime Helpers\n\n`Rtmidi::MidiOut` includes helpers for common output messages:\n\n- `sysex`\n- `control_change`\n- `program_change`\n- `pitch_bend`\n- `channel_aftertouch`\n- `poly_aftertouch`\n- `time_code_quarter_frame`\n- `song_position_pointer`\n- `song_select`\n- `tune_request`\n- `timing_clock`\n- `start`\n- `continue`\n- `stop`\n- `active_sensing`\n- `system_reset`\n- `nrpn`\n\nExample:\n\n```ruby\nrequire \"rtmidi\"\n\nout = Rtmidi::MidiOut.new\n\nif out.port_count.zero?\n  warn \"No output ports available.\"\nelse\n  begin\n    out.open_port(0)\n    out.sysex([0x7D, 0x01])\n    out.song_select(3)\n    out.start\n    out.nrpn(0, 0x1234, 0x0567)\n  ensure\n    out.close\n  end\nend\n```\n\n### Virtual Ports\n\n```ruby\nrequire \"rtmidi\"\n\nmidi_in = Rtmidi::MidiIn.new\nmidi_out = Rtmidi::MidiOut.new\n\nbegin\n  midi_in.open_virtual_port(name: \"Rtmidi Ruby Virtual In\")\n  midi_out.open_virtual_port(name: \"Rtmidi Ruby Virtual Out\")\n\n  puts \"Virtual ports opened.\"\n  sleep\nensure\n  midi_out\u0026.close\n  midi_in\u0026.close\nend\n```\n\n### Low-Level C API\n\n```ruby\nrequire \"rtmidi\"\n\nhandle = nil\n\nbegin\n  handle = Rtmidi::Native.rtmidi_out_create_default\n  Rtmidi::Native.check_error(handle)\n\n  count = Rtmidi::Native.rtmidi_get_port_count(handle)\n  Rtmidi::Native.check_error(handle)\n\n  puts \"#{count} output ports found\"\nensure\n  Rtmidi::Native.rtmidi_out_free(handle) if handle \u0026\u0026 !handle.null?\nend\n```\n\n## Error Handling\n\nSynchronous operations raise `Rtmidi::Error` subclasses where possible, including:\n\n- `Rtmidi::NoDevicesError`\n- `Rtmidi::InvalidPortError`\n- `Rtmidi::InvalidUseError`\n- `Rtmidi::DriverError`\n\nValidation failures use `ArgumentError`.\n\nIf a callback raises, the exception is stored and surfaced on the next locked API call.\n\n## Callback Notes\n\n- Keep callback processing lightweight.\n- For heavier work, pass the event to a `Queue` and handle it in another thread.\n- Do not call `close` or `close_port` from inside an input callback.\n- `parsed: true` yields `Rtmidi::Message::*` structs instead of raw byte arrays.\n\n## Examples\n\nThe repository includes runnable examples in [`examples/`](examples):\n\n- `examples/list_ports.rb`\n- `examples/send_note.rb`\n- `examples/sysex_send.rb`\n- `examples/receive_callback.rb`\n- `examples/receive_polling.rb`\n- `examples/virtual_port.rb`\n\nRun them against the local checkout with:\n\n```bash\nbundle exec ruby -Ilib examples/list_ports.rb\n```\n\n## Development\n\n```bash\nbundle install\nbundle exec rspec\nbundle exec rake\n```\n\n## License\n\nReleased under the MIT License. See `LICENSE.txt`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydah%2Fmtmidi-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fydah%2Fmtmidi-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydah%2Fmtmidi-ruby/lists"}