Jack2: jack.h Source File

00001 /*
00002   Copyright (C) 2001 Paul Davis
00003   Copyright (C) 2004 Jack O'Quin
00004 
00005   This program is free software; you can redistribute it and/or modify
00006   it under the terms of the GNU Lesser General Public License as published by
00007   the Free Software Foundation; either version 2.1 of the License, or
00008   (at your option) any later version.
00009 
00010   This program is distributed in the hope that it will be useful,
00011   but WITHOUT ANY WARRANTY; without even the implied warranty of
00012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013   GNU Lesser General Public License for more details.
00014 
00015   You should have received a copy of the GNU Lesser General Public License
00016   along with this program; if not, write to the Free Software
00017   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 
00019 */
00020 
00021 #ifndef __jack_h__
00022 #define __jack_h__
00023 
00024 #ifdef __cplusplus
00025 extern "C"
00026 {
00027 #endif
00028 
00029 #include <jack/systemdeps.h>
00030 #include <jack/types.h>
00031 #include <jack/transport.h>
00032 
00037     /*************************************************************
00038      * NOTE: JACK_WEAK_EXPORT ***MUST*** be used on every function
00039      * added to the JACK API after the 0.116.2 release.
00040      *
00041      * Functions that predate this release are marked with
00042      * JACK_WEAK_OPTIONAL_EXPORT which can be defined at compile
00043      * time in a variety of ways. The default definition is empty,
00044      * so that these symbols get normal linkage. If you wish to
00045      * use all JACK symbols with weak linkage, include
00046      * <jack/weakjack.h> before jack.h.
00047      *************************************************************/
00048 
00049 #include <jack/weakmacros.h>
00050 
00063 void
00064 jack_get_version(
00065     int *major_ptr,
00066     int *minor_ptr,
00067     int *micro_ptr,
00068     int *proto_ptr) JACK_OPTIONAL_WEAK_EXPORT;
00069 
00076 const char *
00077 jack_get_version_string() JACK_OPTIONAL_WEAK_EXPORT;
00078 
00117 jack_client_t * jack_client_open (const char *client_name,
00118                                   jack_options_t options,
00119                                   jack_status_t *status, ...) JACK_OPTIONAL_WEAK_EXPORT;
00120 
00127 jack_client_t * jack_client_new (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
00128 
00134 int jack_client_close (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00135 
00140 int jack_client_name_size (void) JACK_OPTIONAL_WEAK_EXPORT;
00141 
00148 char * jack_get_client_name (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00149 
00171 int jack_internal_client_new (const char *client_name,
00172                               const char *load_name,
00173                               const char *load_init) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
00174 
00180 void jack_internal_client_close (const char *client_name) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
00181 
00188 int jack_activate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00189 
00197 int jack_deactivate (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00198 
00202 int jack_get_client_pid (const char *name) JACK_OPTIONAL_WEAK_EXPORT;
00203 
00208 jack_native_thread_t jack_client_thread_id (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00209 
00219 int jack_is_realtime (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00220 
00232 jack_nframes_t jack_thread_wait (jack_client_t *client, int status) JACK_OPTIONAL_WEAK_EXPORT;
00233 
00241 jack_nframes_t jack_cycle_wait (jack_client_t* client) JACK_OPTIONAL_WEAK_EXPORT;
00242 
00249 void jack_cycle_signal (jack_client_t* client, int status) JACK_OPTIONAL_WEAK_EXPORT;
00250 
00267 int jack_set_process_thread(jack_client_t* client, JackThreadCallback thread_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00268 
00290 int jack_set_thread_init_callback (jack_client_t *client,
00291                                    JackThreadInitCallback thread_init_callback,
00292                                    void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00293 
00317 void jack_on_shutdown (jack_client_t *client,
00318                        JackShutdownCallback shutdown_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00319 
00343 void jack_on_info_shutdown (jack_client_t *client,
00344                             JackInfoShutdownCallback shutdown_callback, void *arg) JACK_WEAK_EXPORT;
00345 
00363 int jack_set_process_callback (jack_client_t *client,
00364                                JackProcessCallback process_callback,
00365                                void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00366 
00383 int jack_set_freewheel_callback (jack_client_t *client,
00384                                  JackFreewheelCallback freewheel_callback,
00385                                  void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00386 
00406 int jack_set_buffer_size_callback (jack_client_t *client,
00407                                    JackBufferSizeCallback bufsize_callback,
00408                                    void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00409 
00423 int jack_set_sample_rate_callback (jack_client_t *client,
00424                                    JackSampleRateCallback srate_callback,
00425                                    void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00426 
00440 int jack_set_client_registration_callback (jack_client_t *client,
00441                                             JackClientRegistrationCallback
00442                                             registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00443 
00457  int jack_set_port_registration_callback (jack_client_t *client,
00458                                           JackPortRegistrationCallback
00459                                           registration_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00460 
00474 int jack_set_port_connect_callback (jack_client_t *client,
00475                                     JackPortConnectCallback
00476                                     connect_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00477 
00491 int jack_set_port_rename_callback (jack_client_t *client,
00492                                    JackPortRenameCallback
00493                                    rename_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00494 
00508 int jack_set_graph_order_callback (jack_client_t *client,
00509                                    JackGraphOrderCallback graph_callback,
00510                                    void *) JACK_OPTIONAL_WEAK_EXPORT;
00511 
00525 int jack_set_xrun_callback (jack_client_t *client,
00526                             JackXRunCallback xrun_callback, void *arg) JACK_OPTIONAL_WEAK_EXPORT;
00527 
00583 int jack_set_latency_callback (jack_client_t *client,
00584                                JackLatencyCallback latency_callback,
00585                                void *) JACK_WEAK_EXPORT;
00617 int jack_set_freewheel(jack_client_t* client, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
00618 
00634 int jack_set_buffer_size (jack_client_t *client, jack_nframes_t nframes) JACK_OPTIONAL_WEAK_EXPORT;
00635 
00640 jack_nframes_t jack_get_sample_rate (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
00641 
00651 jack_nframes_t jack_get_buffer_size (jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
00652 
00663 int jack_engine_takeover_timebase (jack_client_t *) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
00664 
00671 float jack_cpu_load (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
00672 
00709 jack_port_t * jack_port_register (jack_client_t *client,
00710                                   const char *port_name,
00711                                   const char *port_type,
00712                                   unsigned long flags,
00713                                   unsigned long buffer_size) JACK_OPTIONAL_WEAK_EXPORT;
00714 
00721 int jack_port_unregister (jack_client_t *client, jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00722 
00742 void * jack_port_get_buffer (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT;
00743 
00750 const char * jack_port_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00751 
00758 const char * jack_port_short_name (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00759 
00763 int jack_port_flags (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00764 
00769 const char * jack_port_type (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00770 
00774 jack_port_type_id_t jack_port_type_id (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00775 
00779 int jack_port_is_mine (const jack_client_t *client, const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00780 
00786 int jack_port_connected (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00787 
00794 int jack_port_connected_to (const jack_port_t *port,
00795                             const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
00796 
00808 const char ** jack_port_get_connections (const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00809 
00829 const char ** jack_port_get_all_connections (const jack_client_t *client,
00830                                              const jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00831 
00839 int jack_port_tie (jack_port_t *src, jack_port_t *dst) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
00840 
00848 int jack_port_untie (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
00849 
00857 int jack_port_set_name (jack_port_t *port, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
00858 
00872 int jack_port_set_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT;
00873 
00882 int jack_port_unset_alias (jack_port_t *port, const char *alias) JACK_OPTIONAL_WEAK_EXPORT;
00883 
00889 int jack_port_get_aliases (const jack_port_t *port, char* const aliases[2]) JACK_OPTIONAL_WEAK_EXPORT;
00890 
00895 int jack_port_request_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
00896 
00905 int jack_port_request_monitor_by_name (jack_client_t *client,
00906                                        const char *port_name, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
00907 
00915 int jack_port_ensure_monitor (jack_port_t *port, int onoff) JACK_OPTIONAL_WEAK_EXPORT;
00916 
00920 int jack_port_monitoring_input (jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00921 
00939 int jack_connect (jack_client_t *client,
00940                   const char *source_port,
00941                   const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT;
00942 
00956 int jack_disconnect (jack_client_t *client,
00957                      const char *source_port,
00958                      const char *destination_port) JACK_OPTIONAL_WEAK_EXPORT;
00959 
00969 int jack_port_disconnect (jack_client_t *client, jack_port_t *port) JACK_OPTIONAL_WEAK_EXPORT;
00970 
00979 int jack_port_name_size(void) JACK_OPTIONAL_WEAK_EXPORT;
00980 
00985 int jack_port_type_size(void) JACK_OPTIONAL_WEAK_EXPORT;
00986 
00992 size_t jack_port_type_get_buffer_size (jack_client_t *client, const char *port_type) JACK_WEAK_EXPORT;
00993 
01060 void jack_port_set_latency (jack_port_t *port, jack_nframes_t) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
01061 
01071 void jack_port_get_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT;
01072 
01140 void jack_port_set_latency_range (jack_port_t *port, jack_latency_callback_mode_t mode, jack_latency_range_t *range) JACK_WEAK_EXPORT;
01141 
01155 int jack_recompute_total_latencies (jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
01156 
01172 jack_nframes_t jack_port_get_latency (jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
01173 
01184 jack_nframes_t jack_port_get_total_latency (jack_client_t *client,
01185                                             jack_port_t *port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
01186 
01203 int jack_recompute_total_latency (jack_client_t*, jack_port_t* port) JACK_OPTIONAL_WEAK_DEPRECATED_EXPORT;
01204 
01228 const char ** jack_get_ports (jack_client_t *client,
01229                               const char *port_name_pattern,
01230                               const char *type_name_pattern,
01231                               unsigned long flags) JACK_OPTIONAL_WEAK_EXPORT;
01232 
01238 jack_port_t * jack_port_by_name (jack_client_t *client, const char *port_name) JACK_OPTIONAL_WEAK_EXPORT;
01239 
01243 jack_port_t * jack_port_by_id (jack_client_t *client,
01244                                jack_port_id_t port_id) JACK_OPTIONAL_WEAK_EXPORT;
01245 
01261 jack_nframes_t jack_frames_since_cycle_start (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
01262 
01269 jack_nframes_t jack_frame_time (const jack_client_t *) JACK_OPTIONAL_WEAK_EXPORT;
01270 
01285 jack_nframes_t jack_last_frame_time (const jack_client_t *client) JACK_OPTIONAL_WEAK_EXPORT;
01286 
01330 int jack_get_cycle_times(const jack_client_t *client,
01331                         jack_nframes_t *current_frames,
01332                         jack_time_t    *current_usecs,
01333                         jack_time_t    *next_usecs,
01334                         float          *period_usecs) JACK_OPTIONAL_WEAK_EXPORT;
01335                   
01339 jack_time_t jack_frames_to_time(const jack_client_t *client, jack_nframes_t) JACK_OPTIONAL_WEAK_EXPORT;
01340 
01344 jack_nframes_t jack_time_to_frames(const jack_client_t *client, jack_time_t) JACK_OPTIONAL_WEAK_EXPORT;
01345 
01352 jack_time_t jack_get_time() JACK_OPTIONAL_WEAK_EXPORT;
01353 
01360 
01369 extern void (*jack_error_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT;
01370 
01378 void jack_set_error_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPORT;
01379 
01388 extern void (*jack_info_callback)(const char *msg) JACK_OPTIONAL_WEAK_EXPORT;
01389 
01397 void jack_set_info_function (void (*func)(const char *)) JACK_OPTIONAL_WEAK_EXPORT;
01398 
01408 void jack_free(void* ptr) JACK_OPTIONAL_WEAK_EXPORT;
01409 
01410 
01411 #ifdef __cplusplus
01412 }
01413 #endif
01414 
01415 #endif /* __jack_h__ */