Jack2  1.9.8
jack.h
1 /*
2  Copyright (C) 2001 Paul Davis
3  Copyright (C) 2004 Jack O'Quin
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation; either version 2.1 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with this program; if not, write to the Free Software
17  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 
19 */
20 
21 #ifndef __jack_h__
22 #define __jack_h__
23 
24 #ifdef __cplusplus
25 extern "C"
26 {
27 #endif
28 
29 #include <jack/systemdeps.h>
30 #include <jack/types.h>
31 #include <jack/transport.h>
32 
37  /*************************************************************
38  * NOTE: JACK_WEAK_EXPORT ***MUST*** be used on every function
39  * added to the JACK API after the 0.116.2 release.
40  *
41  * Functions that predate this release are marked with
42  * JACK_WEAK_OPTIONAL_EXPORT which can be defined at compile
43  * time in a variety of ways. The default definition is empty,
44  * so that these symbols get normal linkage. If you wish to
45  * use all JACK symbols with weak linkage, include
46  * <jack/weakjack.h> before jack.h.
47  *************************************************************/
48 
49 #include <jack/weakmacros.h>
50 
63 void
64 jack_get_version(
65  int *major_ptr,
66  int *minor_ptr,
67  int *micro_ptr,
68  int *proto_ptr) JACK_OPTIONAL_WEAK_EXPORT;
69 
76 const char *
77 jack_get_version_string() JACK_OPTIONAL_WEAK_EXPORT;
78 
112 jack_client_t * jack_client_open (const char *client_name,
113  jack_options_t options,
114  jack_status_t *status, ...) JACK_OPTIONAL_WEAK_EXPORT;
115 
122 jack_client_t * jack_client_new (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
123 
129 int jack_client_close (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
130 
135 int jack_client_name_size (void) JACK_OPTIONAL_WEAK_EXPORT;
136 
143 char * jack_get_client_name (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
144 
166 int jack_internal_client_new (const char *client_name,
167  const char *load_name,
168  const char *load_init) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
169 
175 void jack_internal_client_close (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
176 
183 int jack_activate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
184 
192 int jack_deactivate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
193 
197 int jack_get_client_pid (const char *name) JACK_OPTIONAL_WEAK_EXPORT;
198 
203 jack_native_thread_t jack_client_thread_id (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
204 
214 int jack_is_realtime (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
215 
227 jack_nframes_t jack_thread_wait (jack_client_t*, int status) JACK_OPTIONAL_WEAK_EXPORT;
228 
236 jack_nframes_t jack_cycle_wait (jack_client_t* client) JACK_OPTIONAL_WEAK_EXPORT;
237 
244 void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EXPORT;
245 
262 int jack_set_process_thread(jack_client_t* client, JackThreadCallback thread_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
263 
285 int jack_set_thread_init_callback (jack_client_t *client,
286  JackThreadInitCallback thread_init_callback,
287  void *arg) JACK_OPTIONAL_WEAK_EXPORT;
288 
312 void jack_on_shutdown (jack_client_t *client,
313  JackShutdownCallback shutdown_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
314 
338 void jack_on_info_shutdown (jack_client_t *client,
339  JackInfoShutdownCallback shutdown_callback, void *arg) JACK_WEAK_EXPORT;
340 
358 int jack_set_process_callback (jack_client_t *client,
359  JackProcessCallback process_callback,
360  void *arg) JACK_OPTIONAL_WEAK_EXPORT;
361 
378 int jack_set_freewheel_callback (jack_client_t *client,
379  JackFreewheelCallback freewheel_callback,
380  void *arg) JACK_OPTIONAL_WEAK_EXPORT;
381 
401 int jack_set_buffer_size_callback (jack_client_t *client,
402  JackBufferSizeCallback bufsize_callback,
403  void *arg) JACK_OPTIONAL_WEAK_EXPORT;
404 
418 int jack_set_sample_rate_callback (jack_client_t *client,
419  JackSampleRateCallback srate_callback,
420  void *arg) JACK_OPTIONAL_WEAK_EXPORT;
421 
435 int jack_set_client_registration_callback (jack_client_t *,
436  JackClientRegistrationCallback
437  registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
438 
452  int jack_set_port_registration_callback (jack_client_t *,
453  JackPortRegistrationCallback
454  registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
455 
469 int jack_set_port_connect_callback (jack_client_t *,
470  JackPortConnectCallback
471  connect_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
472 
486 int jack_set_port_rename_callback (jack_client_t *,
487  JackPortRenameCallback
488  rename_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
489 
503 int jack_set_graph_order_callback (jack_client_t *,
504  JackGraphOrderCallback graph_callback,
505  void *) JACK_OPTIONAL_WEAK_EXPORT;
506 
520 int jack_set_xrun_callback (jack_client_t *,
521  JackXRunCallback xrun_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
522 
578 int jack_set_latency_callback (jack_client_t *,
579  JackLatencyCallback latency_callback,
580  void *) JACK_WEAK_EXPORT;
612 int jack_set_freewheel(jack_client_t* client, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
613 
629 int jack_set_buffer_size (jack_client_t *client, jack_nframes_t nframes) JACK_OPTIONAL_WEAK_EXPORT;
630 
635 jack_nframes_t jack_get_sample_rate (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
636 
646 jack_nframes_t jack_get_buffer_size (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
647 
658 int jack_engine_takeover_timebase (jack_client_t *) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
659 
666 float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
667 
704 jack_port_t * jack_port_register (jack_client_t *client,
705  const char *port_name,
706  const char *port_type,
707  unsigned long flags,
708  unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT;
709 
716 int jack_port_unregister (jack_client_t *, jack_port_t *) JACK_OPTIONAL_WEAK_EXPORT;
717 
737 void * jack_port_get_buffer (jack_port_t *, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT;
738 
745 const char * jack_port_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
746 
753 const char * jack_port_short_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
754 
758 int jack_port_flags (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
759 
764 const char * jack_port_type (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
765 
769 jack_port_type_id_t jack_port_type_id (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
770 
774 int jack_port_is_mine (const jack_client_t *, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
775 
781 int jack_port_connected (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
782 
789 int jack_port_connected_to (const jack_port_t *port,
790  const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
791 
803 const char ** jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
804 
824 const char ** jack_port_get_all_connections (const jack_client_t *client,
825  const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
826 
834 int jack_port_tie (jack_port_t *src, jack_port_t *dst) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
835 
843 int jack_port_untie (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
844 
852 int jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
853 
867 int jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT;
868 
877 int jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT;
878 
884 int jack_port_get_aliases (const jack_port_t *port, char* const aliases[2]) JACK_OPTIONAL_WEAK_EXPORT;
885 
890 int jack_port_request_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
891 
900 int jack_port_request_monitor_by_name (jack_client_t *client,
901  const char *port_name, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
902 
910 int jack_port_ensure_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
911 
915 int jack_port_monitoring_input (jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
916 
934 int jack_connect (jack_client_t *,
935  const char *source_port,
936  const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT;
937 
951 int jack_disconnect (jack_client_t *,
952  const char *source_port,
953  const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT;
954 
964 int jack_port_disconnect (jack_client_t *, jack_port_t *) JACK_OPTIONAL_WEAK_EXPORT;
965 
974 int jack_port_name_size(void) JACK_OPTIONAL_WEAK_EXPORT;
975 
980 int jack_port_type_size(void) JACK_OPTIONAL_WEAK_EXPORT;
981 
987 size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_type) JACK_WEAK_EXPORT;
988 
1055 void jack_port_set_latency (jack_port_t *, jack_nframes_t) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
1056 
1066 void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT;
1067 
1135 void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT;
1136 
1150 int jack_recompute_total_latencies (jack_client_t*) JACK_OPTIONAL_WEAK_EXPORT;
1151 
1167 jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
1168 
1179 jack_nframes_t jack_port_get_total_latency (jack_client_t *,
1180  jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
1181 
1198 int jack_recompute_total_latency (jack_client_t*, jack_port_t* port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
1199 
1223 const char ** jack_get_ports (jack_client_t *,
1224  const char *port_name_pattern,
1225  const char *type_name_pattern,
1226  unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT;
1227 
1233 jack_port_t * jack_port_by_name (jack_client_t *, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
1234 
1238 jack_port_t * jack_port_by_id (jack_client_t *client,
1239  jack_port_id_t port_id) JACK_OPTIONAL_WEAK_EXPORT;
1240 
1256 jack_nframes_t jack_frames_since_cycle_start (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
1257 
1264 jack_nframes_t jack_frame_time (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
1265 
1280 jack_nframes_t jack_last_frame_time (const jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
1281 
1285 jack_time_t jack_frames_to_time(const jack_client_t *client, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT;
1286 
1290 jack_nframes_t jack_time_to_frames(const jack_client_t *client, jack_time_t) JACK_OPTIONAL_WEAK_EXPORT;
1291 
1298 jack_time_t jack_get_time() JACK_OPTIONAL_WEAK_EXPORT;
1299 
1306 
1315 extern void (*jack_error_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT;
1316 
1324 void jack_set_error_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPORT;
1325 
1334 extern void (*jack_info_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT;
1335 
1343 void jack_set_info_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPORT;
1344 
1354 void jack_free(void* ptr) JACK_OPTIONAL_WEAK_EXPORT;
1355 
1356 
1357 #ifdef __cplusplus
1358 }
1359 #endif
1360 
1361 #endif /* __jack_h__ */

Generated for Jack2 by doxygen 1.8.1.2