{"id":50816061,"url":"https://github.com/ydah/jack-ruby","last_synced_at":"2026-06-13T09:33:44.480Z","repository":{"id":342791276,"uuid":"1174468218","full_name":"ydah/jack-ruby","owner":"ydah","description":"Ruby FFI bindings for the core JACK Audio Connection Kit client APIs.","archived":false,"fork":false,"pushed_at":"2026-03-07T13:39:51.000Z","size":56,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-07T17:56:44.718Z","etag":null,"topics":["api","audio","audio-connections","bindings","client","ffi","jack","ruby"],"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-06T13:30:20.000Z","updated_at":"2026-03-07T13:39:54.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ydah/jack-ruby","commit_stats":null,"previous_names":["ydah/jack-ruby"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/ydah/jack-ruby","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fjack-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fjack-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fjack-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fjack-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ydah","download_url":"https://codeload.github.com/ydah/jack-ruby/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ydah%2Fjack-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":["api","audio","audio-connections","bindings","client","ffi","jack","ruby"],"created_at":"2026-06-13T09:33:43.615Z","updated_at":"2026-06-13T09:33:44.475Z","avatar_url":"https://github.com/ydah.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jack\n\nRuby FFI bindings for the core [JACK Audio Connection Kit](https://jackaudio.org/) client APIs.\n\nThis gem targets `libjack` from both JACK1 and JACK2. It covers client lifecycle, audio and MIDI ports, callbacks, transport, session management, metadata, ring buffers, UUID helpers, thread/statistics helpers, and internal client APIs.\n\n`net.h` / NetJACK (`libjacknet`) is a separate library and is not currently bound by this gem.\n\n## Installation\n\nAdd the gem with Bundler:\n\n```bash\nbundle add jack-ruby\n```\n\nOr install it directly:\n\n```bash\ngem install jack-ruby\n```\n\nJACK itself must already be installed:\n\n- macOS: `brew install jack`\n- Ubuntu/Debian: `sudo apt-get install jackd2 libjack-jackd2-dev`\n- Fedora: `sudo dnf install jack-audio-connection-kit-devel`\n\n## Quick Start\n\n```ruby\nrequire \"jack\"\n\nputs \"JACK #{Jack.version_string}\"\n\nJack::Client.open(\"simple\") do |client|\n  puts \"Client name: #{client.name}\"\n  puts \"Sample rate: #{client.sample_rate}\"\n  puts \"Buffer size: #{client.buffer_size}\"\n  puts \"Realtime: #{client.realtime?}\"\n\n  client.activate\n\n  client.get_ports.each do |port_name|\n    puts port_name\n  end\nend\n```\n\n## Examples\n\n### Audio Passthrough\n\n```ruby\nrequire \"jack\"\n\nJack::Client.open(\"passthrough\") do |client|\n  input = client.register_audio_input(\"in\")\n  output = client.register_audio_output(\"out\")\n\n  client.on_process do |nframes|\n    in_buf = input.buffer_pointer(nframes)\n    out_buf = output.buffer_pointer(nframes)\n    out_buf.write_bytes(in_buf.read_bytes(nframes * 4))\n    0\n  end\n\n  client.activate\n\n  capture = client.get_ports(flags: Jack::JackPortIsPhysical | Jack::JackPortIsOutput).first\n  playback = client.get_ports(flags: Jack::JackPortIsPhysical | Jack::JackPortIsInput).first\n  client.connect(capture, \"passthrough:in\") if capture\n  client.connect(\"passthrough:out\", playback) if playback\n\n  sleep\nend\n```\n\n### MIDI Monitor\n\n```ruby\nrequire \"jack\"\n\nJack::Client.open(\"midi_monitor\") do |client|\n  midi_in = client.register_midi_input(\"in\")\n\n  client.on_process do |nframes|\n    midi_in.read_all_events(nframes).each do |event|\n      puts \"Note ON #{event.note}\" if event.note_on?\n      puts \"Note OFF #{event.note}\" if event.note_off?\n    end\n    0\n  end\n\n  client.activate\n  sleep\nend\n```\n\n### Transport Control\n\n```ruby\nrequire \"jack\"\n\nJack::Client.open(\"transport_ctl\") do |client|\n  transport = client.transport\n\n  client.activate\n  transport.locate(0)\n  transport.start\n\n  sleep 2\n\n  position = transport.query\n  puts \"State: #{transport.state}\"\n  puts \"Frame: #{position[:frame]}\"\n\n  transport.stop\nend\n```\n\nMore runnable examples live in `examples/`:\n\n- `audio_passthrough.rb`\n- `meter.rb`\n- `midi_generator.rb`\n- `midi_monitor.rb`\n- `port_connector.rb`\n- `ringbuffer_recorder.rb`\n- `simple_client.rb`\n- `sine_generator.rb`\n- `transport_control.rb`\n\n## API Overview\n\n| API | Description |\n|---|---|\n| `Jack` | Library-wide helpers like `version`, `version_string`, `client_pid`, `on_error`, `on_info` |\n| `Jack::Client` | Client open/close, activation, port registration, connection management, callbacks, stats, RT scheduling, internal clients |\n| `Jack::Port` | Common port metadata, aliases, monitor control, latency helpers, legacy tie/untie support |\n| `Jack::AudioPort` | Raw audio buffer access |\n| `Jack::MidiPort` | MIDI event read/write, buffer reset/clear helpers |\n| `Jack::Midi::Event` | MIDI message inspection helpers |\n| `Jack::Transport` | Transport query/control, sync callback, timebase callback, legacy transport info helpers |\n| `Jack::Session` | Session callback, notify/reply, UUID and reservation helpers |\n| `Jack::Metadata` | Property set/get/remove and property change callback |\n| `Jack::RingBuffer` | Lock-free ring buffer, vectors, mlock, reset/reset_size |\n| `Jack::UUID` | UUID generation, parse/unparse, compare/copy/clear helpers |\n\n## Optional APIs and Compatibility\n\nJACK exports some symbols conditionally depending on the server and library version. When a method relies on an optional symbol and that symbol is not present, this gem raises `Jack::NotImplementedError`.\n\nCommon examples:\n\n- `Jack::Metadata` methods on JACK installations without metadata support\n- `Jack::Port#rename` on older JACK versions\n- `Jack::RingBuffer#reset_size`\n- Legacy compatibility helpers such as `Jack::Port#latency`, `Jack::Port#total_latency`, and `Jack::Transport#legacy_info`\n\nThe gem supports both JACK1 and JACK2 `libjack`, but some helpers are only available on JACK2 or newer JACK releases.\n\n## Top-Level Helpers\n\n```ruby\nrequire \"jack\"\n\nJack.on_error { |message| warn \"JACK error: #{message}\" }\nJack.on_info { |message| puts \"JACK info: #{message}\" }\n\np Jack.version\nputs Jack.version_string\nputs Jack.client_pid(\"system\")\n\nuuid = Jack::UUID.generate_client\nputs Jack::UUID.unparse(uuid)\n```\n\n## Development\n\nInstall dependencies and run the test suite:\n\n```bash\nbundle install\nbundle exec rspec\n```\n\nIntegration tests require a running JACK server and are only enabled when `JACK_TEST=1` is set:\n\n```bash\njackd -d dummy \u0026\nJACK_TEST=1 bundle exec rspec spec/integration/\n```\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/ydah/jack.\n\n## Environment Variables\n\n- `JACK_LIB_PATH`: override the `libjack` path loaded by FFI\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydah%2Fjack-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fydah%2Fjack-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fydah%2Fjack-ruby/lists"}