|
|
@@ -60,6 +60,7 @@ extern "C" |
|
|
|
* @param major_ptr pointer to variable receiving protocol version of JACK. |
|
|
|
* |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void |
|
|
|
jack_get_version( |
|
|
|
int *major_ptr, |
|
|
@@ -73,6 +74,7 @@ jack_get_version( |
|
|
|
* @return Human readable string describing JACK version being used. |
|
|
|
* |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char * |
|
|
|
jack_get_version_string(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -114,6 +116,7 @@ jack_get_version_string(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* open operation failed, @a *status includes @ref JackFailure and the |
|
|
|
* caller is not a JACK client. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_client_t * jack_client_open (const char *client_name, |
|
|
|
jack_options_t options, |
|
|
|
jack_status_t *status, ...) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -124,6 +127,7 @@ jack_client_t * jack_client_open (const char *client_name, |
|
|
|
* |
|
|
|
* @deprecated Please use jack_client_open(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_client_t * jack_client_new (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -131,12 +135,14 @@ jack_client_t * jack_client_new (const char *client_name) JACK_OPTIONAL_WEAK_DEP |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_client_close (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the maximum number of characters in a JACK client name |
|
|
|
* including the final NULL character. This value is a constant. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_client_name_size (void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -145,6 +151,7 @@ int jack_client_name_size (void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* JackNameNotUnique status was returned. In that case, the actual |
|
|
|
* name will differ from the @a client_name requested. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
char * jack_get_client_name (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -155,6 +162,7 @@ char * jack_get_client_name (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* The caller is responsible for calling jack_free(3) on any non-NULL |
|
|
|
* returned value. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
char *jack_get_uuid_for_client_name (jack_client_t *client, |
|
|
|
const char *client_name) JACK_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -167,6 +175,7 @@ char *jack_get_uuid_for_client_name (jack_client_t *client, |
|
|
|
* The caller is responsible for calling jack_free(3) on any non-NULL |
|
|
|
* returned value. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
char *jack_get_client_name_by_uuid (jack_client_t *client, |
|
|
|
const char *client_uuid ) JACK_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -191,6 +200,7 @@ char *jack_get_client_name_by_uuid (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 if successful. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_internal_client_new (const char *client_name, |
|
|
|
const char *load_name, |
|
|
|
const char *load_init) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
@@ -200,6 +210,7 @@ int jack_internal_client_new (const char *client_name, |
|
|
|
* |
|
|
|
* @deprecated Please use jack_internal_client_unload(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_internal_client_close (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -208,6 +219,7 @@ void jack_internal_client_close (const char *client_name) JACK_OPTIONAL_WEAK_DEP |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_activate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -217,17 +229,20 @@ int jack_activate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_deactivate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return pid of client. If not available, 0 will be returned. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_get_client_pid (const char *name) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the pthread ID of the thread running the JACK client side |
|
|
|
* real-time code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_native_thread_t jack_client_thread_id (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -239,6 +254,7 @@ jack_native_thread_t jack_client_thread_id (jack_client_t *client) JACK_OPTIONAL |
|
|
|
* |
|
|
|
* @return 1 if JACK is running realtime, 0 otherwise |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_is_realtime (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -252,6 +268,7 @@ int jack_is_realtime (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @deprecated Please use jack_cycle_wait() and jack_cycle_signal() functions. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_thread_wait (jack_client_t *client, int status) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -261,6 +278,7 @@ jack_nframes_t jack_thread_wait (jack_client_t *client, int status) JACK_OPTIONA |
|
|
|
* |
|
|
|
* @return the number of frames of data to process |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_cycle_wait (jack_client_t* client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -269,6 +287,7 @@ jack_nframes_t jack_cycle_wait (jack_client_t* client) JACK_OPTIONAL_WEAK_EXPORT |
|
|
|
* @param client - pointer to a JACK client structure |
|
|
|
* @param status - if non-zero, calling thread should exit |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -287,6 +306,7 @@ void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EX |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_process_thread(jack_client_t* client, JackThreadCallback thread_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -310,6 +330,7 @@ int jack_set_process_thread(jack_client_t* client, JackThreadCallback thread_cal |
|
|
|
* @return 0 on success, otherwise a non-zero error code, causing JACK |
|
|
|
* to remove that client from the process() graph. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_thread_init_callback (jack_client_t *client, |
|
|
|
JackThreadInitCallback thread_init_callback, |
|
|
|
void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -342,6 +363,7 @@ int jack_set_thread_init_callback (jack_client_t *client, |
|
|
|
* (since "jack_client_close" cannot be called directly in the context |
|
|
|
* of the thread that calls the shutdown callback). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_on_shutdown (jack_client_t *client, |
|
|
|
JackShutdownCallback shutdown_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -372,6 +394,7 @@ void jack_on_shutdown (jack_client_t *client, |
|
|
|
* (since "jack_client_close" cannot be called directly in the context |
|
|
|
* of the thread that calls the shutdown callback). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_on_info_shutdown (jack_client_t *client, |
|
|
|
JackInfoShutdownCallback shutdown_callback, void *arg) JACK_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -392,6 +415,7 @@ void jack_on_info_shutdown (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_process_callback (jack_client_t *client, |
|
|
|
JackProcessCallback process_callback, |
|
|
|
void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -412,6 +436,7 @@ int jack_set_process_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_freewheel_callback (jack_client_t *client, |
|
|
|
JackFreewheelCallback freewheel_callback, |
|
|
|
void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -435,6 +460,7 @@ int jack_set_freewheel_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_buffer_size_callback (jack_client_t *client, |
|
|
|
JackBufferSizeCallback bufsize_callback, |
|
|
|
void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -452,6 +478,7 @@ int jack_set_buffer_size_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_sample_rate_callback (jack_client_t *client, |
|
|
|
JackSampleRateCallback srate_callback, |
|
|
|
void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -469,6 +496,7 @@ int jack_set_sample_rate_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_client_registration_callback (jack_client_t *client, |
|
|
|
JackClientRegistrationCallback |
|
|
|
registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -486,7 +514,8 @@ int jack_set_client_registration_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
int jack_set_port_registration_callback (jack_client_t *client, |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_port_registration_callback (jack_client_t *client, |
|
|
|
JackPortRegistrationCallback |
|
|
|
registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -503,6 +532,7 @@ int jack_set_client_registration_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_port_connect_callback (jack_client_t *client, |
|
|
|
JackPortConnectCallback |
|
|
|
connect_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -520,6 +550,7 @@ int jack_set_port_connect_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_port_rename_callback (jack_client_t *client, |
|
|
|
JackPortRenameCallback |
|
|
|
rename_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -537,6 +568,7 @@ int jack_set_port_rename_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_graph_order_callback (jack_client_t *client, |
|
|
|
JackGraphOrderCallback graph_callback, |
|
|
|
void *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -554,6 +586,7 @@ int jack_set_graph_order_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_xrun_callback (jack_client_t *client, |
|
|
|
JackXRunCallback xrun_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -616,6 +649,7 @@ int jack_set_xrun_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_latency_callback (jack_client_t *client, |
|
|
|
JackLatencyCallback latency_callback, |
|
|
|
void *) JACK_WEAK_EXPORT; |
|
|
@@ -650,6 +684,7 @@ int jack_set_latency_callback (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_freewheel(jack_client_t* client, int onoff) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -667,12 +702,14 @@ int jack_set_freewheel(jack_client_t* client, int onoff) JACK_OPTIONAL_WEAK_EXPO |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_set_buffer_size (jack_client_t *client, jack_nframes_t nframes) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the sample rate of the jack system, as set by the user when |
|
|
|
* jackd was started. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_get_sample_rate (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -684,6 +721,7 @@ jack_nframes_t jack_get_sample_rate (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @see jack_set_buffer_size_callback() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_get_buffer_size (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -696,6 +734,7 @@ jack_nframes_t jack_get_buffer_size (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @return ENOSYS, function not implemented. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_engine_takeover_timebase (jack_client_t *) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -704,6 +743,7 @@ int jack_engine_takeover_timebase (jack_client_t *) JACK_OPTIONAL_WEAK_DEPRECATE |
|
|
|
* all clients as a percentage of the real time available per cycle |
|
|
|
* determined by the buffer size and sample rate. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -742,6 +782,7 @@ float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @return jack_port_t pointer on success, otherwise NULL. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_port_t * jack_port_register (jack_client_t *client, |
|
|
|
const char *port_name, |
|
|
|
const char *port_type, |
|
|
@@ -754,6 +795,7 @@ jack_port_t * jack_port_register (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_unregister (jack_client_t *client, jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -775,6 +817,7 @@ int jack_port_unregister (jack_client_t *client, jack_port_t *port) JACK_OPTIONA |
|
|
|
* Caching output ports is DEPRECATED in Jack 2.0, due to some new optimization (like "pipelining"). |
|
|
|
* Port buffers have to be retrieved in each callback for proper functioning. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void * jack_port_get_buffer (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -782,6 +825,7 @@ void * jack_port_get_buffer (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WE |
|
|
|
* |
|
|
|
* @see jack_uuid_to_string() to convert into a string representation |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_uuid_t jack_port_uuid (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -790,6 +834,7 @@ jack_uuid_t jack_port_uuid (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @see jack_port_name_size(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char * jack_port_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -798,27 +843,32 @@ const char * jack_port_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @see jack_port_name_size(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char * jack_port_short_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the @ref JackPortFlags of the jack_port_t. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_flags (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the @a port type, at most jack_port_type_size() characters |
|
|
|
* including a final NULL. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char * jack_port_type (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the @a port type id. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_port_type_id_t jack_port_type_id (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return TRUE if the jack_port_t belongs to the jack_client_t. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_is_mine (const jack_client_t *client, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -826,6 +876,7 @@ int jack_port_is_mine (const jack_client_t *client, const jack_port_t *port) JAC |
|
|
|
* |
|
|
|
* @pre The calling client must own @a port. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_connected (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -834,6 +885,7 @@ int jack_port_connected (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @see jack_port_name_size() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_connected_to (const jack_port_t *port, |
|
|
|
const char *port_name) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -848,6 +900,7 @@ int jack_port_connected_to (const jack_port_t *port, |
|
|
|
* |
|
|
|
* @see jack_port_name_size(), jack_port_get_all_connections() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char ** jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -869,6 +922,7 @@ const char ** jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_ |
|
|
|
* |
|
|
|
* @see jack_port_name_size() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char ** jack_port_get_all_connections (const jack_client_t *client, |
|
|
|
const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -879,6 +933,7 @@ const char ** jack_port_get_all_connections (const jack_client_t *client, |
|
|
|
* turned out to serve essentially no purpose in real-life |
|
|
|
* JACK clients. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_tie (jack_port_t *src, jack_port_t *dst) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -888,6 +943,7 @@ int jack_port_tie (jack_port_t *src, jack_port_t *dst) JACK_OPTIONAL_WEAK_DEPREC |
|
|
|
* turned out to serve essentially no purpose in real-life |
|
|
|
* JACK clients. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_untie (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -900,6 +956,7 @@ int jack_port_untie (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -912,6 +969,7 @@ int jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_ |
|
|
|
* This differs from jack_port_set_name() by triggering PortRename notifications to |
|
|
|
* clients that have registered a port rename handler. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -927,6 +985,7 @@ int jack_port_rename (jack_client_t* client, jack_port_t *port, const char *port |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -937,6 +996,7 @@ int jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEA |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -944,12 +1004,14 @@ int jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_W |
|
|
|
* |
|
|
|
* @return the number of aliases discovered for the port |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_get_aliases (const jack_port_t *port, char* const aliases[2]) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* If @ref JackPortCanMonitor is set for this @a port, turn input |
|
|
|
* monitoring on or off. Otherwise, do nothing. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_request_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -960,6 +1022,7 @@ int jack_port_request_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_ |
|
|
|
* |
|
|
|
* @see jack_port_name_size() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_request_monitor_by_name (jack_client_t *client, |
|
|
|
const char *port_name, int onoff) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -970,11 +1033,13 @@ int jack_port_request_monitor_by_name (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_ensure_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return TRUE if input monitoring has been requested for @a port. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_monitoring_input (jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -994,6 +1059,7 @@ int jack_port_monitoring_input (jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* @return 0 on success, EEXIST if the connection is already made, |
|
|
|
* otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_connect (jack_client_t *client, |
|
|
|
const char *source_port, |
|
|
|
const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -1011,6 +1077,7 @@ int jack_connect (jack_client_t *client, |
|
|
|
* |
|
|
|
* @return 0 on success, otherwise a non-zero error code |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_disconnect (jack_client_t *client, |
|
|
|
const char *source_port, |
|
|
|
const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
@@ -1024,6 +1091,7 @@ int jack_disconnect (jack_client_t *client, |
|
|
|
* while generic connection clients (e.g. patchbays) would use |
|
|
|
* jack_disconnect(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_disconnect (jack_client_t *client, jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1034,12 +1102,14 @@ int jack_port_disconnect (jack_client_t *client, jack_port_t *port) JACK_OPTIONA |
|
|
|
* with a colon (:) followed by its short name and a NULL |
|
|
|
* character. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_name_size(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the maximum number of characters in a JACK port type name |
|
|
|
* including the final NULL character. This value is a constant. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_port_type_size(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1047,6 +1117,7 @@ int jack_port_type_size(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* this function may only be called in a buffer_size callback. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_type) JACK_WEAK_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -1115,6 +1186,7 @@ size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_t |
|
|
|
* be replaced by a latency callback that calls @ref |
|
|
|
* jack_port_set_latency_range(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_port_set_latency (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1129,6 +1201,7 @@ void jack_port_set_latency (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEA |
|
|
|
* the port is connected, and that gets signalled by the latency callback. |
|
|
|
* See @ref jack_set_latency_callback() for details. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1198,6 +1271,7 @@ void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_ |
|
|
|
* See the description of @ref jack_set_latency_callback for more |
|
|
|
* information. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1213,6 +1287,7 @@ void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_ |
|
|
|
* @return zero for successful execution of the request. non-zero |
|
|
|
* otherwise. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_recompute_total_latencies (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1230,6 +1305,7 @@ int jack_recompute_total_latencies (jack_client_t *client) JACK_OPTIONAL_WEAK_EX |
|
|
|
* be replaced by jack_port_get_latency_range() in any existing |
|
|
|
* use cases. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1242,6 +1318,7 @@ jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPR |
|
|
|
* be replaced by jack_port_get_latency_range() in any existing |
|
|
|
* use cases. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_port_get_total_latency (jack_client_t *client, |
|
|
|
jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
@@ -1261,6 +1338,7 @@ jack_nframes_t jack_port_get_total_latency (jack_client_t *client, |
|
|
|
* be replaced by jack_recompute_total_latencies() in any existing |
|
|
|
* use cases. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_recompute_total_latency (jack_client_t*, jack_port_t* port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -1286,6 +1364,7 @@ int jack_recompute_total_latency (jack_client_t*, jack_port_t* port) JACK_OPTION |
|
|
|
* |
|
|
|
* @see jack_port_name_size(), jack_port_type_size() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
const char ** jack_get_ports (jack_client_t *client, |
|
|
|
const char *port_name_pattern, |
|
|
|
const char *type_name_pattern, |
|
|
@@ -1296,11 +1375,13 @@ const char ** jack_get_ports (jack_client_t *client, |
|
|
|
* |
|
|
|
* @see jack_port_name_size() |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_port_t * jack_port_by_name (jack_client_t *client, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return address of the jack_port_t of a @a port_id. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_port_t * jack_port_by_id (jack_client_t *client, |
|
|
|
jack_port_id_t port_id) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
@@ -1319,6 +1400,7 @@ jack_port_t * jack_port_by_id (jack_client_t *client, |
|
|
|
* @return the estimated time in frames that has passed since the JACK |
|
|
|
* server began the current process cycle. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_frames_since_cycle_start (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1327,6 +1409,7 @@ jack_nframes_t jack_frames_since_cycle_start (const jack_client_t *) JACK_OPTION |
|
|
|
* callback). The return value can be compared with the value of |
|
|
|
* jack_last_frame_time to relate time in other threads to JACK time. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_frame_time (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1343,6 +1426,7 @@ jack_nframes_t jack_frame_time (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT |
|
|
|
* If an xrun occurs, clients must check this value again, as time |
|
|
|
* may have advanced in a non-linear way (e.g. cycles may have been skipped). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_last_frame_time (const jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1388,6 +1472,7 @@ jack_nframes_t jack_last_frame_time (const jack_client_t *client) JACK_OPTIONAL_ |
|
|
|
* |
|
|
|
* @return zero if OK, non-zero otherwise. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
int jack_get_cycle_times(const jack_client_t *client, |
|
|
|
jack_nframes_t *current_frames, |
|
|
|
jack_time_t *current_usecs, |
|
|
@@ -1397,11 +1482,13 @@ int jack_get_cycle_times(const jack_client_t *client, |
|
|
|
/** |
|
|
|
* @return the estimated time in microseconds of the specified frame time |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_time_t jack_frames_to_time(const jack_client_t *client, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
|
* @return the estimated time in frames for the specified system time. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_nframes_t jack_time_to_frames(const jack_client_t *client, jack_time_t) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1410,6 +1497,7 @@ jack_nframes_t jack_time_to_frames(const jack_client_t *client, jack_time_t) JAC |
|
|
|
* |
|
|
|
* The value returned is guaranteed to be monotonic, but not linear. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
jack_time_t jack_get_time(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -1427,6 +1515,7 @@ jack_time_t jack_get_time(void) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* |
|
|
|
* @param msg error message text (no newline at end). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
extern void (*jack_error_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1436,6 +1525,7 @@ extern void (*jack_error_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* The JACK library provides two built-in callbacks for this purpose: |
|
|
|
* default_jack_error_callback() and silent_jack_error_callback(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_set_error_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1446,6 +1536,7 @@ void jack_set_error_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXP |
|
|
|
* |
|
|
|
* @param msg info message text (no newline at end). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
extern void (*jack_info_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/** |
|
|
@@ -1455,6 +1546,7 @@ extern void (*jack_info_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
* The JACK library provides two built-in callbacks for this purpose: |
|
|
|
* default_jack_info_callback() and silent_jack_info_callback(). |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_set_info_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
/*@}*/ |
|
|
@@ -1467,6 +1559,7 @@ void jack_set_info_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPO |
|
|
|
* |
|
|
|
* @param ptr the memory pointer to be deallocated. |
|
|
|
*/ |
|
|
|
JACK_CLIENT_API_EXPORT |
|
|
|
void jack_free(void* ptr) JACK_OPTIONAL_WEAK_EXPORT; |
|
|
|
|
|
|
|
|
|
|
|