jacket/src/jacket.nim

# jacket.nim


# Possible names/install locations of libjack, according to:
# https://github.com/x42/weakjack/blob/master/weak_libjack.c#L108
proc getJackLibName: string =
    when system.hostOS == "windows":
        when sizeof(int) == 4:
            result = "libjack.dll"
        else:
            result = "libjack64.dll"
    elif system.hostOS == "macosx":
        result = "(|/usr/local/lib/|/opt/homebrew/lib/|/opt/local/lib/)libjack.dylib"
    else:
        result = "libjack.so.0"
  
{.push dynlib: getJackLibName().}

# ------------------------------ Constants --------------------------------

const
    JACK_MAX_FRAMES* = (4294967295'i64)
    JACK_LOAD_INIT_LIMIT* = 1024
    JACK_DEFAULT_AUDIO_TYPE* = "32 bit float mono audio"
    JACK_DEFAULT_MIDI_TYPE* = "8 bit raw midi"

# ----------------------------- Custom Types ------------------------------

type
    Time* = culonglong
    NFrames* = culong
    Uuid* = culonglong
    PortId* = culong
    PortTypeId* = culong
    DefaultAudioSample* = cfloat

type
    Client = distinct object
    ClientP* = ptr Client
    Port = distinct object
    PortP* = ptr Port

type
    MidiData* = uint8
    MidiEvent* = object
        time*: NFrames
        size*: csize_t
        buffer*: ptr UncheckedArray[MidiData]
    MidiEventP* = ptr MidiEvent

type
    JackOptions* {.size: sizeof(cint) pure.} = enum
        NullOption = 0x00,
        NoStartServer = 0x01,
        UseExactName = 0x02,
        ServerName = 0x04,
        LoadName = 0x08,
        LoadInit = 0x10,
        SessionID = 0x20

type
    JackStatus* {.size: sizeof(cint).} = enum
        Success = 0x00,
        Failure = 0x01,
        InvalidOption = 0x02,
        NameNotUnique = 0x04,
        ServerStarted = 0x08,
        ServerFailed = 0x10,
        ServerError = 0x20,
        NoSuchClient = 0x40,
        LoadFailure = 0x80,
        InitFailure = 0x100,
        ShmFailure = 0x200,
        VersionError = 0x400,
        BackendError = 0x800,
        ClientZombie = 0x1000

type
    JackPortFlags* {.size: sizeof(culong) pure.} = enum
        PortIsInput = 0x1,
        PortIsOutput = 0x2,
        PortIsPhysical = 0x4,
        PortCanMonitor = 0x8,
        PortIsTerminal = 0x10

type
    JackLatencyCallbackMode* {.size: sizeof(cint) pure.} = enum
        CaptureLatency,
        PlaybackLatency

# Callback function types
type
    JackProcessCallback* = proc (nframes: NFrames; arg: pointer): cint {.cdecl.}
    JackThreadCallback* = proc (arg: pointer): pointer {.cdecl.}
    JackThreadInitCallback* = proc (arg: pointer) {.cdecl.}
    JackGraphOrderCallback* = proc (arg: pointer): cint {.cdecl.}
    JackXRunCallback* = proc (arg: pointer): cint {.cdecl.}
    JackBufferSizeCallback* = proc (nframes: NFrames; arg: pointer): cint {.cdecl.}
    JackSampleRateCallback* = proc (nframes: NFrames; arg: pointer): cint {.cdecl.}
    JackPortRegistrationCallback* = proc (port: PortId; flag: cint; arg: pointer) {.cdecl.}
    JackClientRegistrationCallback* = proc (name: cstring; flag: cint; arg: pointer) {.cdecl.}
    JackPortConnectCallback* = proc (portA: PortId; portB: PortId; connect: cint; arg: pointer) {.cdecl.}
    JackPortRenameCallback* = proc (port: PortId; oldName: cstring; newName: cstring; arg: pointer) {.cdecl.}
    JackFreewheelCallback* = proc (starting: cint; arg: pointer) {.cdecl.}
    JackShutdownCallback* = proc (arg: pointer) {.cdecl.}
    JackInfoShutdownCallback* = proc (code: JackStatus; reason: cstring; arg: pointer) {.cdecl.}
    JackLatencyCallback* = proc (mode: JackLatencyCallbackMode; arg: pointer) {.cdecl.}
    JackInfoCallback* = proc (msg: cstring) {.cdecl.}
    JackErrorCallback* = proc (msg: cstring) {.cdecl.}


# ----------------------------- Version info ------------------------------

# void jack_get_version(int *major_ptr, int *minor_ptr, int *micro_ptr, int *proto_ptr) ;
proc getVersion*(major: ptr cint; minor: ptr cint; micro: ptr cint; proto: ptr cint) {.importc: "jack_get_version".}

# const char * jack_get_version_string(void) ;
proc getVersionString*(): cstring {.importc: "jack_get_version_string".}


# --------------------------- Memory management ---------------------------

# void jack_free(void* ptr) ;
proc free*(`ptr`: pointer) {.importc: "jack_free".}


# -------------------------------- Clients --------------------------------

# jack_client_t * jack_client_open (char *client_name,
#                                   jack_options_t options,
#                                   jack_status_t *status, ...) ;
proc clientOpen*(clientName: cstring; options: cint; status: ptr cint): ClientP {.
    varargs, importc: "jack_client_open".}

# DEPRECATED
# proc clientNew*(clientName: cstring): ClientP {.importc: "jack_client_new".}

# int jack_client_close (jack_client_t *client) ;
proc clientClose*(client: ClientP): cint {.importc: "jack_client_close"}

# int jack_client_name_size (void) ;
proc clientNameSize*(): cint {.importc: "jack_client_name_size"}

# char * jack_get_client_name (jack_client_t *client) ;
proc getClientName*(client: ClientP): cstring {.importc: "jack_get_client_name".}

# char *jack_get_uuid_for_client_name (jack_client_t *client,
#                                      const char    *client_name) ;
proc getUuidForClientName*(client: ClientP; clientName: cstring): cstring {.
    importc: "jack_get_uuid_for_client_name".}

# char *jack_get_client_name_by_uuid (jack_client_t *client,
#                                     const char    *client_uuid ) ;
proc getClientNameByUuid*(client: ClientP; clientUuid: cstring): cstring {.
    importc: "jack_get_client_name_by_uuid".}

#[ FIXME: not implemented yet
proc internalClientNew*(clientName: cstring; loadName: cstring; loadInit: cstring): cint {.
    importc: "jack_internal_client_new".}

proc internalClientClose*(clientName: cstring) {.importc: "jack_internal_client_close".}
]#

# int jack_activate (jack_client_t *client) ;
proc activate*(client: ClientP): cint {.importc: "jack_activate".}

# int jack_deactivate (jack_client_t *client) ;
proc deactivate*(client: ClientP): cint {.importc: "jack_deactivate".}

# int jack_get_client_pid (const char *name) ;
proc getClientPid*(name: cstring): cint {.importc: "jack_get_client_pid".}

# FIXME: not implemented yet
# jack_native_thread_t jack_client_thread_id (jack_client_t *client) ;
# proc clientThreadId*(client: ClientP): NativeThread {.
#    importc: "jack_client_thread_id".}

# int jack_is_realtime (jack_client_t *client) ;
proc isRealtime*(client: ClientP): cint {.importc: "jack_is_realtime".}

# DEPRECATED
# proc threadWait*(client: ClientP; status: cint): NFrames {.
#     importc: "jack_thread_wait".}

# jack_nframes_t jack_cycle_wait (jack_client_t* client) ;
proc cycleWait*(client: ClientP): NFrames {.importc: "jack_cycle_wait".}

# void jack_cycle_signal (jack_client_t* client, int status) ;
proc cycleSignal*(client: ClientP; status: cint) {.importc: "jack_cycle_signal".}


# ------------------------------- Callbacks -------------------------------

proc setProcessThread*(client: ClientP; threadCallback: JackThreadCallback; arg: pointer): cint {.
    importc: "jack_set_process_thread".}

proc setThreadInitCallback*(client: ClientP; threadInitCallback: JackThreadInitCallback; arg: pointer): cint {.
    importc: "jack_set_thread_init_callback".}

proc onShutdown*(client: ClientP; shutdownCallback: JackShutdownCallback; arg: pointer) {.
    importc: "jack_on_shutdown".}

proc onInfoShutdown*(client: ClientP; shutdownCallback: JackInfoShutdownCallback; arg: pointer) {.
    importc: "jack_on_info_shutdown".}

proc setProcessCallback*(client: ClientP; processCallback: JackProcessCallback; arg: pointer): cint {.
    importc: "jack_set_process_callback".}

proc setFreewheelCallback*(client: ClientP; freewheelCallback: JackFreewheelCallback; arg: pointer): cint {.
    importc: "jack_set_freewheel_callback".}

proc setBufferSizeCallback*(client: ClientP; bufsizeCallback: JackBufferSizeCallback; arg: pointer): cint {.
    importc: "jack_set_buffer_size_callback".}

proc setSampleRateCallback*(client: ClientP; srateCallback: JackSampleRateCallback; arg: pointer): cint {.
    importc: "jack_set_sample_rate_callback".}

proc setClientRegistrationCallback*(client: ClientP; registrationCallback: JackClientRegistrationCallback;
                                    arg: pointer): cint {.
    importc: "jack_set_client_registration_callback".}

proc setPortRegistrationCallback*(client: ClientP; registrationCallback: JackPortRegistrationCallback;
                                  arg: pointer): cint {.
    importc: "jack_set_port_registration_callback".}

proc setPortConnectCallback*(client: ClientP; connectCallback: JackPortConnectCallback; arg: pointer): cint {.
    importc: "jack_set_port_connect_callback".}

proc setPortRenameCallback*(client: ClientP; renameCallback: JackPortRenameCallback; arg: pointer): cint {.
    importc: "jack_set_port_rename_callback".}

proc setGraphOrderCallback*(client: ClientP; graphCallback: JackGraphOrderCallback; a3: pointer): cint {.
    importc: "jack_set_graph_order_callback".}

proc setXrunCallback*(client: ClientP; xrunCallback: JackXRunCallback; arg: pointer): cint {.
    importc: "jack_set_xrun_callback".}

proc setLatencyCallback*(client: ClientP; latencyCallback: JackLatencyCallback; arg: pointer): cint {.
    importc: "jack_set_latency_callback".}


# -------------------------- Server Client Control ------------------------

# int jack_set_freewheel(jack_client_t* client, int onoff) ;
proc setFreewheel*(client: ClientP; onoff: cint): cint {.importc: "jack_set_freewheel".}

# int jack_set_buffer_size (jack_client_t *client, jack_nframes_t nframes) ;
proc setBufferSize*(client: ClientP; nframes: NFrames): cint {.importc: "jack_set_buffer_size".}

#jack_nframes_t jack_get_sample_rate (jack_client_t *) ;
proc getSampleRate*(client: ClientP): NFrames {.importc: "jack_get_sample_rate".}

# jack_nframes_t jack_get_buffer_size (jack_client_t *) ;
proc getBufferSize*(client: ClientP): NFrames {.importc: "jack_get_buffer_size".}

# DEPRECATED
# proc engineTakeoverTimebase*(a1: ClientP): cint {.
#    importc: "jack_engine_takeover_timebase".}

# float jack_cpu_load (jack_client_t *client) ;
proc cpuLoad*(client: ClientP): cfloat {.importc: "jack_cpu_load".}


# --------------------------------- Ports ---------------------------------

# jack_port_t * jack_port_register (jack_client_t *client,
#                                   const char *port_name,
#                                   const char *port_type,
#                                   unsigned long flags,
#                                   unsigned long buffer_size) ;
proc portRegister*(client: ClientP; portName: cstring; portType: cstring;
                   flags: culong; bufferSize: culong): PortP {.importc: "jack_port_register".}

# int jack_port_unregister (jack_client_t *client, jack_port_t *port) ;
proc portUnregister*(client: ClientP; port: PortP): cint {.importc: "jack_port_unregister".}

# void * jack_port_get_buffer (jack_port_t *port, jack_nframes_t) ;
proc portGetBuffer*(port: PortP; nframes: NFrames): pointer {.importc: "jack_port_get_buffer".}

# jack_uuid_t jack_port_uuid (const jack_port_t *port) ;
proc portUuid*(port: PortP): Uuid {.importc: "jack_port_uuid".}

# const char * jack_port_name (const jack_port_t *port) ;
proc portName*(port: PortP): cstring {.importc: "jack_port_name".}

# const char * jack_port_short_name (const jack_port_t *port) ;
proc portShortName*(port: PortP): cstring {.importc: "jack_port_short_name".}

# int jack_port_flags (const jack_port_t *port) ;
proc portFlags*(port: PortP): cint {.importc: "jack_port_flags".}

# const char * jack_port_type (const jack_port_t *port) ;
proc portType*(port: PortP): cstring {.importc: "jack_port_type".}

# jack_port_type_id_t jack_port_type_id (const jack_port_t *port) ;
proc portTypeId*(port: PortP): PortTypeId {.importc: "jack_port_type_id".}

# int jack_port_is_mine (const jack_client_t *client, const jack_port_t *port) ;
proc portIsMine*(client: ClientP; port: PortP): cint {.
    importc: "jack_port_is_mine".}

# int jack_port_connected (const jack_port_t *port) ;
proc portConnected*(port: PortP): cint {.importc: "jack_port_connected".}

# int jack_port_connected_to (const jack_port_t *port,
#                             const char *port_name) ;
proc portConnectedTo*(port: PortP; portName: cstring): cint {.importc: "jack_port_connected_to".}

# const char ** jack_port_get_connections (const jack_port_t *port) ;
#
# CAVEAT: The caller is responsible for calling jack_free() on any non-NULL
# returned value.
proc portGetConnections*(port: PortP): cstringArray {.importc: "jack_port_get_connections".}

# const char ** jack_port_get_all_connections (const jack_client_t *client,
#                                              const jack_port_t *port) ;
#
# CAVEAT: The caller is responsible for calling jack_free() on any non-NULL
# returned value.
proc portGetAllConnections*(client: ClientP; port: PortP): cstringArray {.
    importc: "jack_port_get_all_connections".}

#[ DEPRECATED
proc portTie*(src: PortP; dst: PortP): cint {.importc: "jack_port_tie".}

proc portUntie*(port: PortP): cint {.importc: "jack_port_untie".}

proc portSetName*(port: PortP; portName: cstring): cint {.importc: "jack_port_set_name".}
]#

# int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port_name) ;
proc portRename*(client: ClientP; port: PortP; portName: cstring): cint {.importc: "jack_port_rename".}

# int jack_port_set_alias (jack_port_t *port, const char *alias) ;
proc portSetAlias*(port: PortP; alias: cstring): cint {.importc: "jack_port_set_alias".}

# int jack_port_unset_alias (jack_port_t *port, const char *alias) ;
proc portUnsetAlias*(port: PortP; alias: cstring): cint {.importc: "jack_port_unset_alias".}

# int jack_port_get_aliases (const jack_port_t *port, char* const aliases[2]) ;
proc portGetAliases*(port: PortP; aliases: array[2, cstring]): cint {.importc: "jack_port_get_aliases".}

#int jack_port_request_monitor (jack_port_t *port, int onoff) ;
proc portRequestMonitor*(port: PortP; onoff: cint): cint {.importc: "jack_port_request_monitor".}

# int jack_port_request_monitor_by_name (jack_client_t *client,
#                                        const char *port_name, int onoff) ;
proc portRequestMonitorByName*(client: ClientP; portName: cstring; onoff: cint): cint {.
    importc: "jack_port_request_monitor_by_name".}

# int jack_port_ensure_monitor (jack_port_t *port, int onoff) ;
proc portEnsureMonitor*(port: PortP; onoff: cint): cint {.
    importc: "jack_port_ensure_monitor".}

# int jack_port_monitoring_input (jack_port_t *port) ;
proc portMonitoringInput*(port: PortP): cint {.importc: "jack_port_monitoring_input".}

# ------------------------------ Connections ------------------------------

# int jack_connect (jack_client_t *client,
#                   const char *source_port,
#                   const char *destination_port) ;
proc connect*(client: ClientP; srcPort: cstring; destPort: cstring): cint {.importc: "jack_connect".}

# int jack_disconnect (jack_client_t *client,
#                      const char *source_port,
#                      const char *destination_port) ;
proc disconnect*(client: ClientP; srcPort: cstring; destPort: cstring): cint {.importc: "jack_disconnect".}

# int jack_port_disconnect (jack_client_t *client, jack_port_t *port) ;
proc portDisconnect*(client: ClientP; port: PortP): cint {.importc: "jack_port_disconnect".}

# int jack_port_name_size(void) ;
proc portNameSize*(): cint {.importc: "jack_port_name_size".}

# int jack_port_type_size(void) ;
proc portTypeSize*(): cint {.importc: "jack_port_type_size".}

# size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_type) ;
proc portTypeGetBufferSize*(client: ClientP; portType: cstring): csize_t {.
    importc: "jack_port_type_get_buffer_size".}

# --------------------------------- MIDI ----------------------------------

# jack_nframes_t jack_midi_get_event_count (void *port_buffer)
proc midiGetEventCount*(portBuffer: pointer): NFrames {.importc: "jack_midi_get_event_count".}

# int jack_midi_event_get (jack_midi_event_t *event, void *port_buffer, uint32_t event_index)
proc midiEventGet*(event: MidiEventP, portBuffer: pointer, eventIndex: uint32): cint {.
    importc: "jack_midi_event_get".}

# void jack_midi_clear_buffer (void *port_buffer)
proc midiClearBuffer*(portBuffer: pointer) {.importc: "jack_midi_clear_buffer".}

# size_t jack_midi_max_event_size (void *port_buffer)
proc midiMaxEventSize*(portBuffer: pointer): csize_t {.importc: "jack_midi_max_event_size".}

# jack_midi_data_t * jack_midi_event_reserve (void *port_buffer, jack_nframes_t time, size_t data_size)
proc midiEventReserve*(portBuffer: pointer, time: NFrames, dataSize: csize_t): ptr MidiData {.
    importc: "jack_midi_event_reserve".}

# int jack_midi_event_write (void *port_buffer, jack_nframes_t time, const jack_midi_data_t *data, size_t data_size)
proc midiEventWrite*(portBuffer: pointer, time: NFrames, data: ptr MidiData, dataSize: csize_t): int {.
    importc: "jack_midi_event_write".}

# uint32_t jack_midi_get_lost_event_count (void *port_buffer)
proc midiGetLostEventCount*(portBuffer: pointer): uint32 {.importc: "jack_midi_get_lost_event_count".}

# -------------------------------- Latency --------------------------------

#[ FIXME: not implemented yet
# void jack_port_set_latency (jack_port_t *port, jack_nframes_t) ;
proc portSetLatency*(port: PortP; a2: NFrames) {.importc: "jack_port_set_latency".}

#[ FIXME: not implemented yet
# void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) ;
proc portGetLatencyRange*(port: PortP; mode: LatencyCallbackMode;
                         range: ptr LatencyRange) {.importc: "jack_port_get_latency_range".}

proc portSetLatencyRange*(port: PortP; mode: LatencyCallbackMode;
                         range: ptr LatencyRange) {.importc: "jack_port_set_latency_range".}
]#

proc recomputeTotalLatencies*(client: ClientP): cint {.importc: "jack_recompute_total_latencies".}

proc portGetLatency*(port: PortP): NFrames {.importc: "jack_port_get_latency".}

proc portGetTotalLatency*(client: ClientP; port: PortP): NFrames {.importc: "jack_port_get_total_latency".}

proc recomputeTotalLatency*(a1: ClientP; port: PortP): cint {.importc: "jack_recompute_total_latency".}
]#

# ------------------------------ Port Lookup ------------------------------

# const char ** jack_get_ports (jack_client_t *client,
#                               const char *port_name_pattern,
#                               const char *type_name_pattern,
#                               unsigned long flags) ;
#
# CAVEAT: The caller is responsible for calling jack_free() on any non-NULL
# returned value.
proc getPorts*(client: ClientP; portNamePattern: cstring;
               typeNamePattern: cstring; flags: culong): cstringArray {.importc: "jack_get_ports".}

# jack_port_t * jack_port_by_name (jack_client_t *client, const char *port_name) ;
proc portByName*(client: ClientP; portName: cstring): PortP {.importc: "jack_port_by_name".}

# jack_port_t * jack_port_by_id (jack_client_t *client, jack_port_id_t port_id) ;
proc portById*(client: ClientP; portId: PortId): PortP {.importc: "jack_port_by_id".}

# ----------------------------- Time handling -----------------------------

# jack_nframes_t jack_frames_since_cycle_start (const jack_client_t *) ;
proc framesSinceCycleStart*(client: ClientP): NFrames {.importc: "jack_frames_since_cycle_start".}

# jack_nframes_t jack_frame_time (const jack_client_t *) ;
proc frameTime*(client: ClientP): NFrames {.importc: "jack_frame_time".}

# jack_nframes_t jack_last_frame_time (const jack_client_t *client) ;
proc lastFrameTime*(client: ClientP): NFrames {.importc: "jack_last_frame_time".}

# int jack_get_cycle_times(const jack_client_t *client,
#                         jack_nframes_t *current_frames,
#                         jack_time_t    *current_usecs,
#                         jack_time_t    *next_usecs,
#                         float          *period_usecs) ;
proc getCycleTimes*(client: ClientP; currentFrames: ptr NFrames;
                    currentUsecs: ptr Time; nextUsecs: ptr Time;
                    periodUsecs: ptr cfloat): cint {.importc: "jack_get_cycle_times".}

# jack_time_t jack_frames_to_time(const jack_client_t *client, jack_nframes_t) ;
proc framesToTime*(client: ClientP; nframes: NFrames): Time {.importc: "jack_frames_to_time".}

# jack_nframes_t jack_time_to_frames(const jack_client_t *client, jack_time_t) ;
proc timeToFrames*(client: ClientP; time: Time): NFrames {.importc: "jack_time_to_frames".}

# jack_time_t jack_get_time(void) ;
proc getTime*(): Time {.importc: "jack_get_time".}

# ---------------------------- Error handling -----------------------------

proc setErrorFunction*(errorCallback: JackErrorCallback) {.importc: "jack_set_error_function".}

proc setInfoFunction*(infoCallback: JackInfoCallback) {.importc: "jack_set_info_function".}

{.pop.}

# --------------------------- Helper functions ----------------------------

proc getJackStatusErrorString*(status: cint): string =
    # Get JACK error status as string.
    if status == Success.ord:
        return ""

    if status == Failure.ord:
        # Only include this generic message if no other error status is set
        result = "Overall operation failed"
    if (status and InvalidOption.ord) > 0:
        result.add("\nThe operation contained an invalid and unsupported option")
    if (status and NameNotUnique.ord) > 0:
        result.add("\nThe desired client name was not unique")
    if (status and ServerStarted.ord) > 0:
        result.add("\nThe JACK server was started as a result of this operation")
    if (status and ServerFailed.ord) > 0:
        result.add("\nUnable to connect to the JACK server")
    if (status and ServerError.ord) > 0:
        result.add("\nCommunication error with the JACK server")
    if (status and NoSuchClient.ord) > 0:
        result.add("\nRequested client does not exist")
    if (status and LoadFailure.ord) > 0:
        result.add("\nUnable to load internal client")
    if (status and InitFailure.ord) > 0:
        result.add("\nUnable to initialize client")
    if (status and ShmFailure.ord) > 0:
        result.add("\nUnable to access shared memory")
    if (status and VersionError.ord) > 0:
        result.add("\nClient's protocol version does not match")
    if (status and BackendError.ord) > 0:
        result.add("\nBackend Error")
    if (status and ClientZombie.ord) > 0:
        result.add("\nClient is being shutdown against its will")