jack_common.h File Reference

#include <cassert>
#include <cerrno>
#include <cstring>
#include <jack/jack.h>
#include <stdio.h>
#include <stdlib.h>
#include "compat/dlfunc.h"
#include "debug.h"
#include "types.h"
#include "utils/macros.h"

Include dependency graph for jack_common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	libjack_connection

Macros
#define	JACK_DLSYM(sym)
#define	MOD_NAME   "[jack_common] "

Typedefs
typedef int(*	jack_activate_t) (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT
typedef int(*	jack_client_close_t) (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT
typedef jack_client_t *(*	jack_client_open_t) (const char *client_name, jack_options_t options, jack_status_t *status,...) JACK_OPTIONAL_WEAK_EXPORT
typedef int(*	jack_connect_t) (jack_client_t *client, const char *source_port, const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT
typedef int(*	jack_deactivate_t) (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT
typedef int(*	jack_disconnect_t) (jack_client_t *client, const char *source_port, const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT
typedef void(*	jack_free_t) (void *ptr) JACK_OPTIONAL_WEAK_EXPORT
typedef const char **(*	jack_get_ports_t) (jack_client_t *client, const char *port_name_pattern, const char *type_name_pattern, unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT
typedef jack_nframes_t(*	jack_get_sample_rate_t) (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT
typedef void *(*	jack_port_get_buffer_t) (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT
typedef const char *(*	jack_port_name_t) (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT
typedef jack_port_t *(*	jack_port_register_t) (jack_client_t *client, const char *port_name, const char *port_type, unsigned long flags, unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT
typedef int(*	jack_set_process_callback_t) (jack_client_t *client, JackProcessCallback process_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT
typedef int(*	jack_set_sample_rate_callback_t) (jack_client_t *client, JackSampleRateCallback srate_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT

Functions
static struct device_info *	audio_jack_probe (const char *client_name, unsigned long port_flags, int *count)
static void	close_libjack (struct libjack_connection *s)
static bool	load_jack_symbols (struct libjack_connection *s)
static struct libjack_connection *	open_libjack (void)

Detailed Description

Author

Martin Piatka piatk.nosp@m.a@ce.nosp@m.snet..nosp@m.cz Martin Pulec pulec.nosp@m.@ces.nosp@m.net.c.nosp@m.z

Definition in file jack_common.h.

Macro Definition Documentation

JACK_DLSYM

#define JACK_DLSYM

(

sym

)

Value:

s->sym = (void *) dlsym(s->libjack, "jack_" #sym); if (s->sym == NULL) { log_msg(LOG_LEVEL_ERROR, "JACK symbol %s not found: %s\n", "jack_" #sym, dlerror()); return false; }

Definition at line 135 of file jack_common.h.

Referenced by load_jack_symbols().

MOD_NAME

#define MOD_NAME   "[jack_common] "

Definition at line 67 of file jack_common.h.

Typedef Documentation

jack_activate_t

typedef int(* jack_activate_t) (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 69 of file jack_common.h.

jack_client_close_t

typedef int(* jack_client_close_t) (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 70 of file jack_common.h.

jack_client_open_t

typedef jack_client_t *(* jack_client_open_t) (const char *client_name, jack_options_t options, jack_status_t *status,...) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 71 of file jack_common.h.

jack_connect_t

typedef int(* jack_connect_t) (jack_client_t *client, const char *source_port, const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 74 of file jack_common.h.

jack_deactivate_t

typedef int(* jack_deactivate_t) (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 77 of file jack_common.h.

jack_disconnect_t

typedef int(* jack_disconnect_t) (jack_client_t *client, const char *source_port, const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 78 of file jack_common.h.

jack_free_t

typedef void(* jack_free_t) (void *ptr) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 81 of file jack_common.h.

jack_get_ports_t

typedef const char **(* jack_get_ports_t) (jack_client_t *client, const char *port_name_pattern, const char *type_name_pattern, unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 82 of file jack_common.h.

jack_get_sample_rate_t

typedef jack_nframes_t(* jack_get_sample_rate_t) (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 86 of file jack_common.h.

jack_port_get_buffer_t

typedef void *(* jack_port_get_buffer_t) (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 87 of file jack_common.h.

jack_port_name_t

typedef const char *(* jack_port_name_t) (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 88 of file jack_common.h.

jack_port_register_t

typedef jack_port_t *(* jack_port_register_t) (jack_client_t *client, const char *port_name, const char *port_type, unsigned long flags, unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 89 of file jack_common.h.

jack_set_process_callback_t

typedef int(* jack_set_process_callback_t) (jack_client_t *client, JackProcessCallback process_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 94 of file jack_common.h.

jack_set_sample_rate_callback_t

typedef int(* jack_set_sample_rate_callback_t) (jack_client_t *client, JackSampleRateCallback srate_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT

Definition at line 97 of file jack_common.h.

Function Documentation

audio_jack_probe()

static struct device_info * audio_jack_probe ( const char * client_name, unsigned long port_flags, int * count )

inlinestatic

Definition at line 213 of file jack_common.h.

{
        jack_client_t *client;
        jack_status_t status;
        char *last_name = NULL;
        int i;
        const char **ports;
        int port_count = 0; 
        struct libjack_connection *libjack = open_libjack();
        if (!libjack) {
                return NULL;
        }
 
        *count = 0;
        client = libjack->client_open(client_name, JackNoStartServer, &status);
        if(status & JackFailure) {
                log_msg(LOG_LEVEL_ERROR, "Opening JACK client failed.\n");
                close_libjack(libjack);
                return NULL;
        }
 
        ports = libjack->get_ports(client, NULL, NULL, port_flags);
        if(ports == NULL) {
                log_msg(LOG_LEVEL_ERROR, "Unable to enumerate JACK ports.\n");
                close_libjack(libjack);
                return NULL;
        }
 
        for(port_count = 0; ports[port_count] != NULL; port_count++);
 
        struct device_info *available_devices = port_count > 0 ? calloc(port_count, sizeof(struct device_info)) : NULL;
 
        int channel_count = 0;
        for(i = 0; ports[i] != NULL; i++) {
                char *item = strdup(ports[i]);
                assert(item != NULL);
                char *save_ptr = NULL;
                char *name;
 
                ++channel_count;
                name = strtok_r(item, "_", &save_ptr);
                if (name == NULL) { // shouldn't happen
                        log_msg(LOG_LEVEL_ERROR, "Incorrect JACK name: %s!\n", ports[i]);
                        free(item);
                        continue;
                }
                if(last_name && strcmp(last_name, name) != 0) {
                        snprintf(available_devices[*count].name, sizeof available_devices[*count].name, "jack:%s (%d channels)", last_name, channel_count);
                        snprintf(available_devices[*count].dev, sizeof available_devices[*count].dev, ":\"%s\"", last_name);
                        channel_count = 0;
                        (*count)++;
                }
                free(last_name);
                last_name = strdup(name);
                free(item);
        }
        if(last_name) {
                snprintf(available_devices[*count].name, sizeof available_devices[*count].name, "jack:%s (%d channels)", last_name, channel_count);
                snprintf(available_devices[*count].dev, sizeof available_devices[*count].dev, ":\"%s\"", last_name);
                (*count)++;
        }
        free(last_name);
        libjack->free(ports);
        libjack->client_close(client);
        close_libjack(libjack);
 
        return available_devices;
}

References libjack_connection::client_close, close_libjack(), count, device_info::dev, libjack_connection::free, libjack_connection::libjack, LOG_LEVEL_ERROR, log_msg(), name, and open_libjack().

Referenced by audio_cap_jack_help(), audio_cap_jack_probe(), audio_play_jack_help(), and audio_play_jack_probe().

Here is the call graph for this function:

close_libjack()

static void close_libjack ( struct libjack_connection * s )

static

Definition at line 120 of file jack_common.h.

{
        if (s == NULL) {
                return;
        }
#ifdef RTLD_DEFAULT
        if (s->libjack != RTLD_DEFAULT) {
                dlclose(s->libjack);
        }
#else
        dlclose(s->libjack);
#endif // defined RTLD_DEFAULT
        free(s);
}

References libjack_connection::libjack.

Referenced by audio_cap_jack_done(), audio_cap_jack_init(), audio_jack_probe(), audio_play_jack_done(), audio_play_jack_init(), jack_start(), and open_libjack().

load_jack_symbols()

static bool load_jack_symbols ( struct libjack_connection * s )

static

Definition at line 137 of file jack_common.h.

{
        JACK_DLSYM(activate);
        JACK_DLSYM(client_close)
        JACK_DLSYM(client_open)
        JACK_DLSYM(connect);
        JACK_DLSYM(deactivate);
        JACK_DLSYM(disconnect);
        JACK_DLSYM(free)
        JACK_DLSYM(get_ports)
        JACK_DLSYM(get_sample_rate);
        JACK_DLSYM(set_sample_rate_callback);
        JACK_DLSYM(port_get_buffer);
        JACK_DLSYM(port_name);
        JACK_DLSYM(port_register);
        JACK_DLSYM(set_process_callback);
        return true;
}

References JACK_DLSYM.

Referenced by open_libjack().

open_libjack()

static struct libjack_connection * open_libjack ( void )

static

Definition at line 156 of file jack_common.h.

{
        struct libjack_connection *s = calloc(1, sizeof(struct libjack_connection));
 
#ifdef RTLD_DEFAULT
        // try to load from already loaded library (eg. by LD_PRELOAD), RTLD_DEFAULT is POSIX-only
        if (dlsym(RTLD_DEFAULT, "jack_activate") != NULL) {
                s->libjack = RTLD_DEFAULT;
                if (load_jack_symbols(s)) {
                        log_msg(LOG_LEVEL_VERBOSE, "Using preloaded JACK library.\n");
                        return s;
                }
        }
#endif
 
        const char *shlib[] = {
#ifdef _WIN32
                "C:/Windows/libjack64.dll"
#elif defined(__APPLE__)
#ifdef __aarch64__
                "/opt/homebrew/lib/libjack.dylib",
#endif // defined __aarch64__
                "libjack.dylib",
                "/usr/local/lib/libjack.dylib"
#elif defined(__linux__)
                "libjack.so"
#endif
        };
        char err[STR_LEN];
        err[0] = '\0';
        for (unsigned i = 0; i < sizeof shlib / sizeof shlib[0]; ++i) {
                s->libjack = dlopen(shlib[i], RTLD_NOW);
                if (s->libjack != NULL) {
                        MSG(VERBOSE, "library loaded from: %s\n", shlib[i]);
                        break;
                }
                snprintf(err + strlen(err), sizeof err - strlen(err),
                         "JACK library \"%s\" opening failed: %s\n", shlib[i],
                         dlerror());
        }
        if (s->libjack == NULL) {
                log_msg(LOG_LEVEL_ERROR, "%s", err);
                free(s);
                return NULL;
        }
        if (!load_jack_symbols(s)) {
                close_libjack(s);
                return NULL;
        }
#ifdef HAVE_DLINFO
        char path[MAX_PATH_SIZE] = "(unknown)";
        dlinfo(s->libjack, RTLD_DI_ORIGIN, path); // nonstandard GNU extension
        log_msg(LOG_LEVEL_VERBOSE, "Loaded JACK library from %s.\n", path);
#endif // defined HAVE_DLINFO
        return s;
}

References close_libjack(), libjack_connection::free, libjack_connection::libjack, load_jack_symbols(), LOG_LEVEL_ERROR, LOG_LEVEL_VERBOSE, log_msg(), MAX_PATH_SIZE, MSG, and STR_LEN.

Referenced by audio_cap_jack_init(), audio_jack_probe(), audio_play_jack_init(), and jack_start().

Here is the call graph for this function: