chris
/
jacket
1
1
Fork 0
Code Issues Pull Requests Releases Activity
A Nim wrapper for the JACK C API
41 Commits 2 Branches 1 Tag 323 KiB
Nim 100%
Go to file
Christopher Arndt 75e1266da4 docs: move comments for deprecated functions around 
Signed-off-by: Christopher Arndt <chris@chrisarndt.de>
 		2023-05-24 09:45:06 +02:00
examples feat: wrap metadata API and add one usage example 2023-05-24 07:49:14 +02:00
src docs: move comments for deprecated functions around 2023-05-24 09:45:06 +02:00
tests fix: use standard nimble package structure 2022-10-10 21:11:19 +02:00
.gitignore Add README, LICENSE and .gitignore 2022-10-06 04:19:20 +02:00
LICENSE docs: add copyright info to license file and links to readme 2022-10-06 15:16:57 +02:00
README.md feat: wrap transport API and add transport query example 2023-05-22 19:58:43 +02:00
jacket.nimble fix: use standard nimble package structure 2022-10-10 21:11:19 +02:00

README.md

jacket

A Nim wrapper for the JACK C API

Project status

This software is in alpha status and has no official release yet.

The basic JACK APIs (client lifecycle, ports, callbacks, MIDI, transport) have been wrapped and are functional (see examples), but latency, threading and meta-data APIs still need wrapping. Also, symbol names may still be changed and things moved around before the first public release.

Also, I plan to add a higher-level abstraction on top of the direct mapping from Nim procs and types to C functions and types, probably in the form of a JACK client object, which takes care of creating a JACK client instance, registering ports and setting up all the callbacks necessary for a well-behaved JACK application.

Installation

  • Clone this repository.
  • Change into the jacket directory.
  • Run nimble install (or nimble develop).
  • Run the examples with nim compile --run examples/<example>.nim.

License

This software is released under the MIT License. See the LICENSE file for more information.