Jack

JACK-AUDIO-CONNECTION-KIT Reference Manual
0.98.1
Generated by Doxygen 1.3.6-20040222
Tue Apr 27 12:27:40 2004

Contents
1 JACK Audio Connection Kit 1

1.1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 JACK Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.4 Porting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.5 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 JACK-AUDIO-CONNECTION-KIT Data Structure Index 5

2.1 JACK-AUDIO-CONNECTION-KIT Data Structures . . . . . . . . . 5
3 JACK-AUDIO-CONNECTION-KIT File Index 7

3.1 JACK-AUDIO-CONNECTION-KIT File List . . . . . . . . . . . . . 7
4 JACK-AUDIO-CONNECTION-KIT Page Index 9

4.1 JACK-AUDIO-CONNECTION-KIT Related Pages . . . . . . . . . . 9
5 JACK-AUDIO-CONNECTION-KIT Data Structure Documentation 11

5.1 jack_position_t Struct Reference . . . . . . . . . . . . . . . . . . . . 11
5.2 jack_ringbuffer_data_t Struct Reference . . . . . . . . . . . . . . . . 14
5.3 jack_ringbuffer_t Struct Reference . . . . . . . . . . . . . . . . . . . 15
5.4 jack_transport_info_t Struct Reference . . . . . . . . . . . . . . . . . 16
5.5 port_pair_t Struct Reference . . . . . . . . . . . . . . . . . . . . . . 19
6 JACK-AUDIO-CONNECTION-KIT File Documentation 21

6.1 inprocess.c File Reference . . . . . . . . . . . . . . . . . . . . . . . 21
ii CONTENTS
6.2 jack.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 23

6.3 mainpage.dox File Reference . . . . . . . . . . . . . . . . . . . . . . 40
6.4 porting.dox File Reference . . . . . . . . . . . . . . . . . . . . . . . 41
6.5 ringbuffer.h File Reference . . . . . . . . . . . . . . . . . . . . . . . 42
6.6 simple_client.c File Reference . . . . . . . . . . . . . . . . . . . . . 47
6.7 transport.dox File Reference . . . . . . . . . . . . . . . . . . . . . . 49
6.8 transport.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . 50
6.9 types.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . 59
7 JACK-AUDIO-CONNECTION-KIT Page Documentation 65

7.1 JACK Transport Design . . . . . . . . . . . . . . . . . . . . . . . . . 65
7.2 Porting JACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
7.3 Deprecated List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

Chapter 1
JACK Audio Connection Kit
1.1 Introduction
JACK is a low-latency audio server, written for POSIX conformant operating systems
such as GNU/Linux and Apple’s OS X. It can connect several client applications to
an audio device, and allow them to share audio with each other. Clients can run as
separate processes like normal applications, or within the JACK server as "plugins".
JACK was designed from the ground up for professional audio work, and its design
focuses on two key areas: synchronous execution of all clients, and low latency opera-
tion.
See also:
<http://jackit.sourceforge.net>
1.2 JACK Overview

Traditionally it has been hard if not impossible to write audio applications that can
share data with each other. In addition, configuring and managing audio interface
hardware has often been one of the most complex aspect of writing audio software.
JACK changes all this by providing an API that does several things:
1. provides a high level abstraction for programmers that removes the audio interface
hardware from the picture and allows them to concentrate on the core functionality of
their software.
2. allows applications to send and receive audio data to/from each other as well as
the audio interface. There is difference in how an application sends or receives data
regardless of whether it comes from another application or an audio interface.
2 JACK Audio Connection Kit
For programmers with experience of several other audio APIs such as PortAudio, Ap-
ple’s CoreAudio, Steinberg’s VST and ASIO as well as many others, JACK presents
a familiar model: your program provides a "callback" function that will be executed
at the right time. Your callback can send and receive data as well as do other signal
processing tasks. You are not responsible for managing audio interfaces or threading,
and there is no "format negotiation": all audio data within JACK is represented as 32
bit floating point values.
For those with experiences rooted in the Unix world, JACK presents a somewhat un-
familiar API. Most Unix APIs are based on the read/write model spawned by the "ev-
erything is a file" abstraction that Unix is rightly famous for. The problem with this
design is that it fails to take the realtime nature of audio interfaces into account, or
more precisely, it fails to force application developers to pay sufficient attention to this
aspect of their task. In addition, it becomes rather difficult to facilitate inter-application
audio routing when different programs are not all running synchronously.
Using JACK within your program is very simple, and typically consists of just:
• calling jack_client_new to connect to the JACK server.
• registering "ports" to enable data to be moved to and from your application.
• registering a "process callback" which will be called at the right time by the
JACK server.
• telling JACK that your application is ready to start processing data.
There is a lot more that you can do with JACK’s interfaces, but for many applications,
this is all that is needed. The simple_client.c example demonstrates a complete (sim-
ple!) JACK application that just copies the signal arriving at its input port to its output
port. Similarly, inprocess.c shows how to write an internal client "plugin" that runs
within the JACK server process.
1.3 Reference
The JACK programming interfaces are described in several header files:
• <jack/jack.h> defines most of the JACK interfaces.
• <jack/ringbuffer.h> defines a simple API for using lock-free ringbuffers. These

are a good way to pass data between threads, when streaming realtime data to
slower media, like audio file playback or recording.
• <jack/transport.h> defines a simple transport control mechanism for starting,

stopping and repositioning clients. This is described in the JACK Transport De-
sign document.

1.4 Porting 3
• <jack/types.h> defines most of the JACK data types.
In addition, the example-clients directory provides numerous examples of simple JACK

clients that nevertheless use the API to do something useful. It includes
• a metronome.
• a recording client that can capture any number of channels from any JACK
sources and store them as an audio file.
• command line clients to control the transport mechanism, change the buffer size
and more.
• simple examples of wrapping a GUI around a JACK application.
• tools for checking the status of a running JACK system.
1.4 Porting
JACK is designed to be portable to any system supporting the relevant POSIX and
ANSI C standards. It currently runs under GNU/Linux and Mac OS X on several
different processor architectures. If you want to port JACK to another platform, please
read the Porting JACK document.
1.5 License
Copyright (C) 2001-2003 by Paul Davis and others.
JACK is free software; you can redistribute it and/or modify it under the terms of
the GNU GPL and LGPL licenses as published by the Free Software Foundation,
<http://www.gnu.org>. The JACK server uses the GPL, as noted in the source
file headers. However, the JACK library is licensed under the LGPL, allowing propri-
etary programs to link with it and use JACK services. You should have received a copy
of these Licenses along with the program; if not, write to the Free Software Foundation,
Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FIT-
NESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.

4 JACK Audio Connection Kit

Chapter 2
JACK-AUDIO-CONNECTION-
KIT Data Structure
Index
2.1 JACK-AUDIO-CONNECTION-KIT Data Struc-

tures
Here are the data structures with brief descriptions:
jack_position_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
jack_ringbuffer_data_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
jack_ringbuffer_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
jack_transport_info_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
port_pair_t . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
6 JACK-AUDIO-CONNECTION-KIT Data Structure Index

Chapter 3
KIT File
Index
3.1 JACK-AUDIO-CONNECTION-KIT File List

Here is a list of all files with brief descriptions:
inprocess.c (This demonstrates the basic concepts for writing a client that
runs within the JACK server process ) . . . . . . . . . . . . . . . . 21
jack.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
mainpage.dox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
porting.dox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
ringbuffer.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
simple_client.c (This simple client demonstrates the basic features of JACK
as they would be used by many applications ) . . . . . . . . . . . . 47
transport.dox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
transport.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
types.h . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
8 JACK-AUDIO-CONNECTION-KIT File Index

Chapter 4
KIT Page
Index
4.1 JACK-AUDIO-CONNECTION-KIT Related

Pages
Here is a list of all related documentation pages:
JACK Transport Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Porting JACK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Deprecated List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
10 JACK-AUDIO-CONNECTION-KIT Page Index

Chapter 5
KIT Data Structure
Documentation
5.1 jack_position_t Struct Reference

#include <transport.h>
Data Fields
• jack_unique_t unique_1
• jack_time_t usecs
• jack_nframes_t frame_rate
• jack_nframes_t frame
• jack_position_bits_t valid
• int32_t bar
• int32_t beat
• int32_t tick
• double bar_start_tick
• float beats_per_bar
• float beat_type
• double ticks_per_beat
• double beats_per_minute
• double frame_time
• double next_time
• int32_t padding [10]
• jack_unique_t unique_2
12 JACK-AUDIO-CONNECTION-KIT Data Structure Documentation
5.1.1 Detailed Description
Struct for transport position information.
5.1.2 Field Documentation
5.1.2.1 int32_t jack_position_t::bar
current bar
5.1.2.2 double jack_position_t::bar_start_tick
5.1.2.3 int32_t jack_position_t::beat
current beat-within-bar
5.1.2.4 float jack_position_t::beat_type
5.1.2.5 float jack_position_t::beats_per_bar
5.1.2.6 double jack_position_t::beats_per_minute
5.1.2.7 jack_nframes_t jack_position_t::frame
frame number, always present
5.1.2.8 jack_nframes_t jack_position_t::frame_rate
current frame rate (per second)
5.1.2.9 double jack_position_t::frame_time
current time in seconds
5.1.2.10 double jack_position_t::next_time
next sequential frame_time (unless repositioned)

5.1 jack_position_t Struct Reference 13
5.1.2.11 int32_t jack_position_t::padding[10]
5.1.2.12 int32_t jack_position_t::tick
current tick-within-beat
5.1.2.13 double jack_position_t::ticks_per_beat
5.1.2.14 jack_unique_t jack_position_t::unique_1
unique ID
5.1.2.15 jack_unique_t jack_position_t::unique_2
unique ID
5.1.2.16 jack_time_t jack_position_t::usecs
monotonic, free-rolling
5.1.2.17 jack_position_bits_t jack_position_t::valid
which other fields are valid

The documentation for this struct was generated from the following file:
• transport.h

5.2 jack_ringbuffer_data_t Struct Reference

#include <ringbuffer.h>
Data Fields
• char ∗ buf
• size_t len
5.2.1.1 char∗ jack_ringbuffer_data_t::buf
5.2.1.2 size_t jack_ringbuffer_data_t::len
• ringbuffer.h

5.3 jack_ringbuffer_t Struct Reference 15
5.3 jack_ringbuffer_t Struct Reference

#include <ringbuffer.h>
Data Fields
• char ∗ buf
• volatile size_t write_ptr
• volatile size_t read_ptr
• size_t size
• size_t size_mask
• int mlocked
5.3.1.1 char∗ jack_ringbuffer_t::buf
5.3.1.2 int jack_ringbuffer_t::mlocked
5.3.1.3 volatile size_t jack_ringbuffer_t::read_ptr
5.3.1.4 size_t jack_ringbuffer_t::size
5.3.1.5 size_t jack_ringbuffer_t::size_mask
5.3.1.6 volatile size_t jack_ringbuffer_t::write_ptr
• ringbuffer.h

5.4 jack_transport_info_t Struct Reference
#include <transport.h>
Data Fields
• jack_nframes_t frame_rate
• jack_time_t usecs
• jack_transport_bits_t valid
• jack_transport_state_t transport_state
• jack_nframes_t frame
• jack_nframes_t loop_start
• jack_nframes_t loop_end
• long smpte_offset
• float smpte_frame_rate
• int bar
• int beat
• int tick
• double bar_start_tick
• float beats_per_bar
• float beat_type
• double ticks_per_beat
• double beats_per_minute
Deprecated struct for transport position information.
Deprecated
This is for compatibility with the earlier transport interface. Use the jack_-
position_t struct, instead.

5.4 jack_transport_info_t Struct Reference 17
5.4.2.1 int jack_transport_info_t::bar
5.4.2.2 double jack_transport_info_t::bar_start_tick
5.4.2.3 int jack_transport_info_t::beat
5.4.2.4 float jack_transport_info_t::beat_type
5.4.2.5 float jack_transport_info_t::beats_per_bar
5.4.2.6 double jack_transport_info_t::beats_per_minute
5.4.2.7 jack_nframes_t jack_transport_info_t::frame
5.4.2.8 jack_nframes_t jack_transport_info_t::frame_rate
current frame rate (per second)
5.4.2.9 jack_nframes_t jack_transport_info_t::loop_end
5.4.2.10 jack_nframes_t jack_transport_info_t::loop_start
5.4.2.11 float jack_transport_info_t::smpte_frame_rate
29.97, 30, 24 etc.
5.4.2.12 long jack_transport_info_t::smpte_offset
SMPTE offset (from frame 0)
5.4.2.13 int jack_transport_info_t::tick
5.4.2.14 double jack_transport_info_t::ticks_per_beat
5.4.2.15 jack_transport_state_t jack_transport_info_t::transport_state
5.4.2.16 jack_time_t jack_transport_info_t::usecs
monotonic, free-rolling

5.4.2.17 jack_transport_bits_t jack_transport_info_t::valid
which fields are legal to read

• transport.h

5.5 port_pair_t Struct Reference 19
5.5 port_pair_t Struct Reference
Data Fields
• jack_port_t ∗ input_port
• jack_port_t ∗ output_port
For the sake of example, an instance of this struct is allocated in jack_initialize(),

passed to inprocess() as an argument, then freed in jack_finish().
5.5.2.1 jack_port_t∗ port_pair_t::input_port
5.5.2.2 jack_port_t∗ port_pair_t::output_port
• inprocess.c


Chapter 6
KIT File
Documentation
6.1 inprocess.c File Reference
This demonstrates the basic concepts for writing a client that runs within the JACK
server process.
#include <stdlib.h>
#include <stdio.h>
#include <memory.h>
#include <jack/jack.h>
Data Structures
• struct port_pair_t
Functions
• int inprocess (jack_nframes_t nframes, void ∗arg)

• int jack_initialize (jack_client_t ∗client, const char ∗so_data)
• void jack_finish (void ∗arg)
22 JACK-AUDIO-CONNECTION-KIT File Documentation
This demonstrates the basic concepts for writing a client that runs within the JACK
server process.
For the sake of example, a port_pair_t is allocated in jack_initialize(), passed to inpro-
cess() as an argument, then freed in jack_finish().
6.1.2 Function Documentation
6.1.2.1 int inprocess (jack_nframes_t nframes, void ∗ arg)
Called in the realtime thread on every process cycle. The entry point name was
passed to jack_set_process_callback() from jack_initialize(). Although this is an in-
ternal client, its process() interface is identical to simple_client.c.
Returns:
0 if successful; otherwise jack_finish() will be called and the client terminated
immediately.
6.1.2.2 void jack_finish (void ∗ arg)
This required entry point is called immediately before the client is unloaded, which
could happen due to a call to jack_internal_client_close(), or a nonzero return from
either jack_initialize() or inprocess().
Parameters:
arg the same parameter provided to inprocess().
6.1.2.3 int jack_initialize (jack_client_t ∗ client, const char ∗ so_data)
This required entry point is called after the client is loaded by jack_internal_client_-
new().
Parameters:
client pointer to JACK client structure.
so_data character string passed from jack_internal_client_new().
Returns:
0 if successful; otherwise jack_finish() will be called and the client terminated
immediately.

6.2 jack.h File Reference 23
6.2 jack.h File Reference

#include <pthread.h>
#include <jack/types.h>
#include <jack/transport.h>
Functions
• jack_client_t ∗ jack_client_new (const char ∗client_name)
• int jack_client_close (jack_client_t ∗client)
• int jack_client_name_size (void)
• int jack_internal_client_new (const char ∗client_name, const char ∗so_name,
const char ∗so_data)
• void jack_internal_client_close (const char ∗client_name)
• int jack_is_realtime (jack_client_t ∗client)
• void jack_on_shutdown (jack_client_t ∗client, void(∗function)(void ∗arg), void
∗arg)
• int jack_set_process_callback (jack_client_t ∗client, JackProcessCallback
process_callback, void ∗arg)
• int jack_set_thread_init_callback (jack_client_t ∗client, JackThreadInitCallback
thread_init_callback, void ∗arg)
• int jack_set_freewheel_callback (jack_client_t ∗client, JackFreewheelCallback
freewheel_callback, void ∗arg)
• int jack_set_freewheel (jack_client_t ∗client, int onoff)
• int jack_set_buffer_size (jack_client_t ∗client, jack_nframes_t nframes)
• int jack_set_buffer_size_callback (jack_client_t ∗client, JackBufferSizeCallback
bufsize_callback, void ∗arg)
• int jack_set_sample_rate_callback (jack_client_t ∗client, JackSampleRate-
Callback srate_callback, void ∗arg)
• int jack_set_port_registration_callback (jack_client_t ∗, JackPortRegistration-
Callback registration_callback, void ∗arg)
• int jack_set_graph_order_callback (jack_client_t ∗, JackGraphOrderCallback
graph_callback, void ∗)
• int jack_set_xrun_callback (jack_client_t ∗, JackXRunCallback xrun_callback,
void ∗arg)
• int jack_activate (jack_client_t ∗client)
• int jack_deactivate (jack_client_t ∗client)
• 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)
• int jack_port_unregister (jack_client_t ∗, jack_port_t ∗)
• void ∗ jack_port_get_buffer (jack_port_t ∗, jack_nframes_t)
• const char ∗ jack_port_name (const jack_port_t ∗port)

• const char ∗ jack_port_short_name (const jack_port_t ∗port)

• int jack_port_flags (const jack_port_t ∗port)
• const char ∗ jack_port_type (const jack_port_t ∗port)
• int jack_port_is_mine (const jack_client_t ∗, const jack_port_t ∗port)
• int jack_port_connected (const jack_port_t ∗port)
• int jack_port_connected_to (const jack_port_t ∗port, const char ∗port_name)
• const char ∗∗ jack_port_get_connections (const jack_port_t ∗port)
• const char ∗∗ jack_port_get_all_connections (const jack_client_t ∗client, const
jack_port_t ∗port)
• int jack_port_tie (jack_port_t ∗src, jack_port_t ∗dst)
• int jack_port_untie (jack_port_t ∗port)
• int jack_port_lock (jack_client_t ∗, jack_port_t ∗)
• int jack_port_unlock (jack_client_t ∗, jack_port_t ∗)
• jack_nframes_t jack_port_get_latency (jack_port_t ∗port)
• jack_nframes_t jack_port_get_total_latency (jack_client_t ∗, jack_port_t ∗port)
• void jack_port_set_latency (jack_port_t ∗, jack_nframes_t)
• int jack_port_set_name (jack_port_t ∗port, const char ∗port_name)
• int jack_port_request_monitor (jack_port_t ∗port, int onoff)
• int jack_port_request_monitor_by_name (jack_client_t ∗client, const char
∗port_name, int onoff)
• int jack_port_ensure_monitor (jack_port_t ∗port, int onoff)
• int jack_port_monitoring_input (jack_port_t ∗port)
• int jack_connect (jack_client_t ∗, const char ∗source_port, const char
∗destination_port)
• int jack_disconnect (jack_client_t ∗, const char ∗source_port, const char
∗destination_port)
• int jack_port_disconnect (jack_client_t ∗, jack_port_t ∗)
• int jack_port_name_size (void)
• int jack_port_type_size (void)
• jack_nframes_t jack_get_sample_rate (jack_client_t ∗)
• jack_nframes_t jack_get_buffer_size (jack_client_t ∗)
• const char ∗∗ jack_get_ports (jack_client_t ∗, const char ∗port_name_pattern,
const char ∗type_name_pattern, unsigned long flags)
• jack_port_t ∗ jack_port_by_name (jack_client_t ∗, const char ∗port_name)
• jack_port_t ∗ jack_port_by_id (const jack_client_t ∗client, jack_port_id_t port_-
id)
• int jack_engine_takeover_timebase (jack_client_t ∗)
• jack_nframes_t jack_frames_since_cycle_start (const jack_client_t ∗)
• jack_nframes_t jack_frame_time (const jack_client_t ∗)
• float jack_cpu_load (jack_client_t ∗client)
• void jack_set_server_dir (const char ∗path)
• pthread_t jack_client_thread_id (jack_client_t ∗)
• void jack_set_error_function (void(∗func)(const char ∗))

Variables
• void(∗ jack_error_callback )(const char ∗msg)
6.2.1.1 int jack_activate (jack_client_t ∗ client)
Tell the Jack server that the program is ready to start processing audio.
Returns:
0 on success, otherwise a non-zero error code
6.2.1.2 int jack_client_close (jack_client_t ∗ client)
Disconnects an external client from a JACK server.
Returns:
6.2.1.3 int jack_client_name_size (void)
Returns:
the maximum number of characters in a JACK client name including the final
NULL character. This value is a constant.
6.2.1.4 jack_client_t∗ jack_client_new (const char ∗ client_name)
Attempt to become an external client of the Jack server.

JACK is evolving a mechanism for automatically starting the server when needed. As
a transition, jack_client_new() only does this when $JACK_START_SERVER is de-
fined in the environment of the calling process. In the future this will become normal
behavior. In either case, defining $JACK_NO_START_SERVER disables this feature.
Parameters:
client_name of at most jack_client_name_size() characters.
Returns:
Opaque client handle if successful, otherwise NULL.

Note:
Failure generally means that the JACK server is not running. If there was some
other problem, it will be reported via the jack_error_callback mechanism.
6.2.1.5 pthread_t jack_client_thread_id (jack_client_t ∗)
Returns:
the pthread ID of the thread running the JACK client side code.
6.2.1.6 int jack_connect (jack_client_t ∗, const char ∗ source_port, const char ∗

destination_port)
Establish a connection between two ports.

When a connection exists, data written to the source port will be available to be read at
the destination port.
Precondition:
The port types must be identical.
The JackPortFlags of the source_port must include JackPortIsOutput.
The JackPortFlags of the destination_port must include JackPortIsInput.
Returns:
0 on success, EEXIST if the connection is already made, otherwise a non-zero
error code
6.2.1.7 float jack_cpu_load (jack_client_t ∗ client)
Returns:
the current CPU load estimated by JACK. This is a running average of the time it
takes to execute a full process cycle for all clients as a percentage of the real time
available per cycle determined by the buffer size and sample rate.
6.2.1.8 int jack_deactivate (jack_client_t ∗ client)
Tell the Jack server to remove this client from the process graph. Also, disconnect all
ports belonging to it, since inactive clients have no port connections.
Returns:

6.2.1.9 int jack_disconnect (jack_client_t ∗, const char ∗ source_port, const char

∗ destination_port)
Remove a connection between two ports.
Precondition:
The port types must be identical.
The JackPortFlags of the source_port must include JackPortIsOutput.
The JackPortFlags of the destination_port must include JackPortIsInput.
Returns:
6.2.1.10 int jack_engine_takeover_timebase (jack_client_t ∗)
Old-style interface to become the timebase for the entire JACK subsystem.
Deprecated
This function still exists for compatibility with the earlier transport interface, but
it does nothing. Instead, see transport.h and use jack_set_timebase_callback().
Returns:
ENOSYS, function not implemented.
6.2.1.11 jack_nframes_t jack_frame_time (const jack_client_t ∗)
Returns:
an estimate of the current time in frames. This is a running counter, no significance
should be attached to its value, but it can be compared to a previously returned
value.
6.2.1.12 jack_nframes_t jack_frames_since_cycle_start (const jack_client_t ∗)
Returns:
the time in frames that has passed since the JACK server began the current process
cycle.

6.2.1.13 jack_nframes_t jack_get_buffer_size (jack_client_t ∗)
Returns:
the current maximum size that will ever be passed to the process_callback. It
should only be used ∗before∗ the client has been activated. This size may change,
clients that depend on it must register a bufsize_callback so they will be notified if
it does.
See also:
jack_set_buffer_size_callback()
6.2.1.14 const char∗∗ jack_get_ports (jack_client_t ∗, const char ∗

port_name_pattern, const char ∗ type_name_pattern, unsigned long
flags)
Parameters:
port_name_pattern A regular expression used to select ports by name. If NULL
or of zero length, no selection based on name will be carried out.
type_name_pattern A regular expression used to select ports by type. If NULL
or of zero length, no selection based on type will be carried out.
flags A value used to select ports by their flags. If zero, no selection based on
flags will be carried out.
Returns:
a NULL-terminated array of ports that match the specified arguments. The caller
is responsible for calling free(3) any non-NULL returned value.
See also:
jack_port_name_size(), jack_port_type_size()
6.2.1.15 jack_nframes_t jack_get_sample_rate (jack_client_t ∗)
Returns:
the sample rate of the jack system, as set by the user when jackd was started.
6.2.1.16 void jack_internal_client_close (const char ∗ client_name)
Removes an internal client from a JACK server.
Returns:

6.2.1.17 int jack_internal_client_new (const char ∗ client_name, const char ∗

so_name, const char ∗ so_data)
Attempt to load an internal client into the Jack server.

Internal clients run within the JACK server process. They can use of the same functions
as external clients. Each internal client must declare jack_initialize() and jack_finish()
entry points, called at load and unload times. See inprocess.c for an example of how to
write an internal client.
Parameters:
client_name of at most jack_client_name_size() characters.
so_name A path to a shared object file containing the code for the new client.
so_data An arbitary string containing information to be passed to the jack_-
initialize() routine of the new client.
6.2.1.18 int jack_is_realtime (jack_client_t ∗ client)
Parameters:
Check if the JACK subsystem is running with -R (–realtime).
Returns:
1 if JACK is running realtime, 0 otherwise
6.2.1.19 void jack_on_shutdown (jack_client_t ∗ client, void(∗ function)(void

∗arg), void ∗ arg)
Parameters:
function The jack_shutdown function pointer.
arg The arguments for the jack_shutdown function.
Register a function (and argument) to be called if and when the JACK server shuts down
the client thread. The function must be written as if it were an asynchonrous POSIX
signal handler — use only async-safe functions, and remember that it is executed from
another thread. A typical function might set a flag or write to a pipe so that the rest of
the application knows that the JACK client thread has shut down.
NOTE: clients do not need to call this. It exists only to help more complex clients
understand what is going on. It should be called before jack_client_activate().

6.2.1.20 jack_port_t∗ jack_port_by_id (const jack_client_t ∗ client,

jack_port_id_t port_id)
Returns:
address of the jack_port_t of a port_id.
6.2.1.21 jack_port_t∗ jack_port_by_name (jack_client_t ∗, const char ∗

port_name)
Returns:
address of the jack_port_t named port_name.
See also:
jack_port_name_size()
6.2.1.22 int jack_port_connected (const jack_port_t ∗ port)
Returns:
number of connections to or from port.
Precondition:
The calling client must own port.
6.2.1.23 int jack_port_connected_to (const jack_port_t ∗ port, const char ∗

port_name)
Returns:
TRUE if the locally-owned port is directly connected to the port_name.
See also:
6.2.1.24 int jack_port_disconnect (jack_client_t ∗, jack_port_t ∗)
Perform the same function as jack_disconnect() using port handles rather than names.
This avoids the name lookup inherent in the name-based version.
Clients connecting their own ports are likely to use this function, while generic con-
nection clients (e.g. patchbays) would use jack_disconnect().

6.2.1.25 int jack_port_ensure_monitor (jack_port_t ∗ port, int onoff)
If JackPortCanMonitor is set for a port, this function turns on input monitoring if it was
off, and turns it off if only one request has been made to turn it on. Otherwise it does
nothing.
Returns:
6.2.1.26 int jack_port_flags (const jack_port_t ∗ port)
Returns:
the JackPortFlags of the jack_port_t.
6.2.1.27 const char∗∗ jack_port_get_all_connections (const jack_client_t ∗

client, const jack_port_t ∗ port)
Returns:
a null-terminated array of full port names to which the port is connected. If none,
returns NULL.
The caller is responsible for calling free(3) on any non-NULL returned value.
This differs from jack_port_get_connections() in two important respects:
1) You may not call this function from code that is executed in response to a JACK
event. For example, you cannot use it in a GraphReordered handler.
2) You need not be the owner of the port to get information about its connections.
See also:
6.2.1.28 void∗ jack_port_get_buffer (jack_port_t ∗, jack_nframes_t)
This returns a pointer to the memory area associated with the specified port. For an
output port, it will be a memory area that can be written to; for an input port, it will
be an area containing the data from the port’s connection(s), or zero-filled. if there are
multiple inbound connections, the data will be mixed appropriately.
FOR OUTPUT PORTS ONLY ——————— You may cache the value returned,
but only between calls to your "blocksize" callback. For this reason alone, you should
either never cache the return value or ensure you have a "blocksize" callback and be
sure to invalidate the cached address from there.

6.2.1.29 const char∗∗ jack_port_get_connections (const jack_port_t ∗ port)
Returns:
a null-terminated array of full port names to which the port is connected. If none,
returns NULL.
The caller is responsible for calling free(3) on any non-NULL returned value.
Parameters:
port locally owned jack_port_t pointer.
See also:
jack_port_name_size(), jack_port_get_all_connections()
6.2.1.30 jack_nframes_t jack_port_get_latency (jack_port_t ∗ port)
Returns:
the time (in frames) between data being available or delivered at/to a port, and the
time at which it arrived at or is delivered to the "other side" of the port. E.g. for a
physical audio output port, this is the time between writing to the port and when
the signal will leave the connector. For a physical audio input port, this is the time
between the sound arriving at the connector and the corresponding frames being
readable from the port.
6.2.1.31 jack_nframes_t jack_port_get_total_latency (jack_client_t ∗,

jack_port_t ∗ port)
The maximum of the sum of the latencies in every connection path that can be drawn
between the port and other ports with the JackPortIsTerminal flag set.
6.2.1.32 int jack_port_is_mine (const jack_client_t ∗, const jack_port_t ∗ port)
Returns:
TRUE if the jack_port_t belongs to the jack_client_t.
6.2.1.33 int jack_port_lock (jack_client_t ∗, jack_port_t ∗)
A client may call this function to prevent other objects from changing the connection
status of a port. The port must be owned by the calling client.
Returns:

6.2.1.34 int jack_port_monitoring_input (jack_port_t ∗ port)
Returns:
TRUE if input monitoring has been requested for port.
6.2.1.35 const char∗ jack_port_name (const jack_port_t ∗ port)
Returns:
the full name of the jack_port_t (including the "client_name:" prefix).
See also:
jack_port_name_size().
6.2.1.36 int jack_port_name_size (void)
Returns:
the maximum number of characters in a full JACK port name including the final
A port’s full name contains the owning client name concatenated with a colon (:) fol-
lowed by its short name and a NULL character.
6.2.1.37 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)
Create a new port for the client. This is an object used for moving data of any type in
or out of the client. Ports may be connected in various ways.
Each port has a short name. The port’s full name contains the name of the client
concatenated with a colon (:) followed by its short name. The jack_port_name_size()
is the maximum length of this full name. Exceeding that will cause the port registration
to fail and return NULL.
All ports have a type, which may be any non-NULL and non-zero length string, passed
as an argument. Some port types are built into the JACK API, currently only JACK_-
DEFAULT_AUDIO_TYPE.
Parameters:
port_name non-empty short name for the new port (not including the leading
"client_name:").

port_type port type name. If longer than jack_port_type_size(), only that many
characters are significant.
flags JackPortFlags bit mask.
buffer_size must be non-zero if this is not a built-in port_type. Otherwise, it is
ignored.
Returns:
jack_port_t pointer on success, otherwise NULL.
6.2.1.38 int jack_port_request_monitor (jack_port_t ∗ port, int onoff)
If JackPortCanMonitor is set for this port, turn input monitoring on or off. Otherwise,
do nothing.
6.2.1.39 int jack_port_request_monitor_by_name (jack_client_t ∗ client, const

char ∗ port_name, int onoff)
If JackPortCanMonitor is set for this port_name, turn input monitoring on or off. Oth-
erwise, do nothing.
Returns:
0 on success, otherwise a non-zero error code.
See also:
6.2.1.40 void jack_port_set_latency (jack_port_t ∗, jack_nframes_t)
The port latency is zero by default. Clients that control physical hardware with non-
zero latency should call this to set the latency to its correct value. Note that the value
should include any systemic latency present "outside" the physical hardware controlled
by the client. For example, for a client controlling a digital audio interface connected
to an external digital converter, the latency setting should include both buffering by the
audio interface ∗and∗ the converter.
6.2.1.41 int jack_port_set_name (jack_port_t ∗ port, const char ∗ port_name)
Modify a port’s short name. May be called at any time. If the resulting full name
(including the "client_name:" prefix) is longer than jack_port_name_size(), it will be
truncated.

Returns:
6.2.1.42 const char∗ jack_port_short_name (const jack_port_t ∗ port)
Returns:
the short name of the jack_port_t (not including the "client_name:" prefix).
See also:
jack_port_name_size().
6.2.1.43 int jack_port_tie (jack_port_t ∗ src, jack_port_t ∗ dst)
A client may call this on a pair of its own ports to semi-permanently wire them together.
This means that a client that wants to direct-wire an input port to an output port can
call this and then no longer have to worry about moving data between them. Any data
arriving at the input port will appear automatically at the output port.
The ’destination’ port must be an output port. The ’source’ port must be an input port.
Both ports must belong to the same client. You cannot use this to tie ports between
clients. That is what a connection is for.
Returns:
6.2.1.44 const char∗ jack_port_type (const jack_port_t ∗ port)
Returns:
the port type, at most jack_port_type_size() characters including a final NULL.
6.2.1.45 int jack_port_type_size (void)
Returns:
the maximum number of characters in a JACK port type name including the final
6.2.1.46 int jack_port_unlock (jack_client_t ∗, jack_port_t ∗)
This allows other objects to change the connection status of a port.
Returns:

6.2.1.47 int jack_port_unregister (jack_client_t ∗, jack_port_t ∗)
Remove the port from the client, disconnecting any existing connections.
Returns:
6.2.1.48 int jack_port_untie (jack_port_t ∗ port)
This undoes the effect of jack_port_tie(). The port should be same as the ’destination’
port passed to jack_port_tie().
Returns:
6.2.1.49 int jack_set_buffer_size (jack_client_t ∗ client, jack_nframes_t

nframes)
Change the buffer size passed to the process_callback.

This operation stops the JACK engine process cycle, then calls all registered bufsize_-
callback functions before restarting the process cycle. This will cause a gap in the
audio flow, so it should only be done at appropriate stopping points.
See also:
jack_set_buffer_size_callback()
Parameters:
nframes new buffer size. Must be a power of two.
Returns:
6.2.1.50 int jack_set_buffer_size_callback (jack_client_t ∗ client,

JackBufferSizeCallback bufsize_callback, void ∗ arg)
Tell JACK to call bufsize_callback whenever the size of the the buffer that will be
passed to the process_callback is about to change. Clients that depend on knowing the
buffer size must supply a bufsize_callback before activating themselves.

Parameters:
bufsize_callback function to call when the buffer size changes.
arg argument for bufsize_callback.
Returns:
6.2.1.51 void jack_set_error_function (void(∗ func)(const char ∗))
Set the jack_error_callback for error message display.

The JACK library provides two built-in callbacks for this purpose: default_jack_error_-
callback() and silent_jack_error_callback().
6.2.1.52 int jack_set_freewheel (jack_client_t ∗ client, int onoff)
Start/Stop JACK’s "freewheel" mode.

When in "freewheel" mode, JACK no longer waits for any external event to begin the
start of the next process cycle.
As a result, freewheel mode causes "faster than realtime" execution of a JACK graph.
If possessed, real-time scheduling is dropped when entering freewheel mode, and if
appropriate it is reacquired when stopping.
Parameters:
client pointer to JACK client structure
onoff if non-zero, freewheel mode starts. Otherwise freewheel mode ends.
Returns:
6.2.1.53 int jack_set_freewheel_callback (jack_client_t ∗ client,

JackFreewheelCallback freewheel_callback, void ∗ arg)
Tell the Jack server to call freewheel_callback whenever we enter or leave "freewheel"
mode, passing arg as the second argument. The first argument to the callback will be
non-zero if JACK is entering freewheel mode, and zero otherwise.
Returns:

6.2.1.54 int jack_set_graph_order_callback (jack_client_t ∗,

JackGraphOrderCallback graph_callback, void ∗)
Tell the Jack server to call ’registration_callback’ whenever the processing graph is
reordered, passing ’arg’ as an argument.
Returns:
6.2.1.55 int jack_set_port_registration_callback (jack_client_t ∗,

JackPortRegistrationCallback registration_callback, void ∗ arg)
Tell the Jack server to call ’registration_callback’ whenever a port is registered or un-
registered, passing ’arg’ as a second argument.
Returns:
6.2.1.56 int jack_set_process_callback (jack_client_t ∗ client,

JackProcessCallback process_callback, void ∗ arg)
Tell the Jack server to call process_callback whenever there is work be done, passing
arg as the second argument.
The code in the supplied function must be suitable for real-time exe-
cution. That means that it cannot call functions that might block for
a long time.160 This includes malloc, free, printf, pthread_mutex_lock,
sleep, wait, poll, select, pthread_join, pthread_cond_wait, etc, etc.160 See
http://jackit.sourceforge.net/docs/design/design.html#SECTION004110000000000
for more information.
Returns:
0 on success, otherwise a non-zero error code, causing JACK to remove that client
from the process() graph.
6.2.1.57 int jack_set_sample_rate_callback (jack_client_t ∗ client,

JackSampleRateCallback srate_callback, void ∗ arg)
Tell the Jack server to call srate_callback whenever the system sample rate changes.
Returns:

6.2.1.58 void jack_set_server_dir (const char ∗ path)
Set the directory in which the server is expected to have put its communication FIFOs.
A client will need to call this before calling jack_client_new() if the server was started
with arguments telling it to use a non-standard directory.
Deprecated
This function is deprecated. Don’t use in new programs and remove it in old
programs.
6.2.1.59 int jack_set_thread_init_callback (jack_client_t ∗ client,

JackThreadInitCallback thread_init_callback, void ∗ arg)
Tell JACK to call thread_init_callback once just after the creation of the thread in
which all other callbacks will be handled.
The code in the supplied function does not need to be suitable for real-time execution.
Returns:
0 on success, otherwise a non-zero error code, causing JACK to remove that client
from the process() graph.
6.2.1.60 int jack_set_xrun_callback (jack_client_t ∗, JackXRunCallback

xrun_callback, void ∗ arg)
Tell the Jack server to call ’xrun_callback’ whenever there is a xrun, passing ’arg’ as
an argument.
Returns:
6.2.2 Variable Documentation
6.2.2.1 void(∗ jack_error_callback)(const char ∗msg)
Display JACK error message.

Set via jack_set_error_function(), otherwise a JACK-provided default will print msg
(plus a newline) to stderr.
Parameters:
msg error message text (no newline at end).

6.3 mainpage.dox File Reference

6.4 porting.dox File Reference 41
6.4 porting.dox File Reference

6.5 ringbuffer.h File Reference
#include <sys/types.h>
Data Structures
• struct jack_ringbuffer_data_t
• struct jack_ringbuffer_t
Functions
• jack_ringbuffer_t ∗ jack_ringbuffer_create (size_t sz)

• void jack_ringbuffer_free (jack_ringbuffer_t ∗rb)
• void jack_ringbuffer_get_read_vector (const jack_ringbuffer_t ∗rb, jack_-
ringbuffer_data_t ∗vec)
• void jack_ringbuffer_get_write_vector (const jack_ringbuffer_t ∗rb, jack_-
ringbuffer_data_t ∗vec)
• size_t jack_ringbuffer_read (jack_ringbuffer_t ∗rb, char ∗dest, size_t cnt)
• void jack_ringbuffer_read_advance (jack_ringbuffer_t ∗rb, size_t cnt)
• size_t jack_ringbuffer_read_space (const jack_ringbuffer_t ∗rb)
• int jack_ringbuffer_mlock (jack_ringbuffer_t ∗rb)
• void jack_ringbuffer_reset (jack_ringbuffer_t ∗rb)
• size_t jack_ringbuffer_write (jack_ringbuffer_t ∗rb, const char ∗src, size_t cnt)
• void jack_ringbuffer_write_advance (jack_ringbuffer_t ∗rb, size_t cnt)
• size_t jack_ringbuffer_write_space (const jack_ringbuffer_t ∗rb)
A set of library functions to make lock-free ringbuffers available to JACK clients. The
‘capture_client.c’ (in the example_clients directory) is a fully functioning user of this
API.
The key attribute of a ringbuffer is that it can be safely accessed by two threads si-
multaneously – one reading from the buffer and the other writing to it – without using
any synchronization or mutual exclusion primitives. For this to work correctly, there
can only be a single reader and a single writer thread. Their identities cannot be inter-
changed.

6.5 ringbuffer.h File Reference 43
6.5.2.1 jack_ringbuffer_t∗ jack_ringbuffer_create (size_t sz)
Allocates a ringbuffer data structure of a specified size. The caller must arrange for a
call to jack_ringbuffer_free() to release the memory associated with the ringbuffer.
Parameters:
sz the ringbuffer size in bytes.
Returns:
a pointer to a new jack_ringbuffer_t, if successful; NULL otherwise.
6.5.2.2 void jack_ringbuffer_free (jack_ringbuffer_t ∗ rb)
Frees the ringbuffer data structure allocated by an earlier call to jack_ringbuffer_-

create().
Parameters:
rb a pointer to the ringbuffer structure.
6.5.2.3 void jack_ringbuffer_get_read_vector (const jack_ringbuffer_t ∗ rb,

jack_ringbuffer_data_t ∗ vec)
Fill a data structure with a description of the current readable data held in the ringbuffer.
This description is returned in a two element array of jack_ringbuffer_data_t. Two
elements are needed because the data to be read may be split across the end of the
ringbuffer.
The first element will always contain a valid len field, which may be zero or greater. If
the len field is non-zero, then data can be read in a contiguous fashion using the address
given in the corresponding buf field.
If the second element has a non-zero len field, then a second contiguous stretch of data
can be read from the address given in its corresponding buf field.
Parameters:
vec a pointer to a 2 element array of jack_ringbuffer_data_t.

6.5.2.4 void jack_ringbuffer_get_write_vector (const jack_ringbuffer_t ∗ rb,

jack_ringbuffer_data_t ∗ vec)
Fill a data structure with a description of the current writable space in the ringbuffer.
The description is returned in a two element array of jack_ringbuffer_data_t. Two
elements are needed because the space available for writing may be split across the end
of the ringbuffer.
The first element will always contain a valid len field, which may be zero or greater.
If the len field is non-zero, then data can be written in a contiguous fashion using the
address given in the corresponding buf field.
If the second element has a non-zero len field, then a second contiguous stretch of data
can be written to the address given in the corresponding buf field.
Parameters:
vec a pointer to a 2 element array of jack_ringbuffer_data_t.
6.5.2.5 int jack_ringbuffer_mlock (jack_ringbuffer_t ∗ rb)
Lock a ringbuffer data block into memory.

Uses the mlock() system call. This is not a realtime operation.
Parameters:
6.5.2.6 size_t jack_ringbuffer_read (jack_ringbuffer_t ∗ rb, char ∗ dest, size_t

cnt)
Read data from the ringbuffer.
Parameters:
dest a pointer to a buffer where data read from the ringbuffer will go.
cnt the number of bytes to read.
Returns:
the number of bytes read, which may range from 0 to cnt.

6.5 ringbuffer.h File Reference 45
6.5.2.7 void jack_ringbuffer_read_advance (jack_ringbuffer_t ∗ rb, size_t cnt)
Advance the read pointer.

After data have been read from the ringbuffer using the pointers returned by jack_-
ringbuffer_get_read_vector(), use this function to advance the buffer pointers, making
that space available for future write operations.
Parameters:
cnt the number of bytes read.
6.5.2.8 size_t jack_ringbuffer_read_space (const jack_ringbuffer_t ∗ rb)
Return the number of bytes available for reading.
Parameters:
Returns:
the number of bytes available to read.
6.5.2.9 void jack_ringbuffer_reset (jack_ringbuffer_t ∗ rb)
Reset the read and write pointers, making an empty buffer.

This is not thread safe.
Parameters:
6.5.2.10 size_t jack_ringbuffer_write (jack_ringbuffer_t ∗ rb, const char ∗ src,

size_t cnt)
Write data into the ringbuffer.
Parameters:
src a pointer to the data to be written to the ringbuffer.
cnt the number of bytes to write.
Returns:
the number of bytes write, which may range from 0 to cnt

6.5.2.11 void jack_ringbuffer_write_advance (jack_ringbuffer_t ∗ rb, size_t cnt)
Advance the write pointer.

After data have been written the ringbuffer using the pointers returned by jack_-
ringbuffer_get_write_vector(), use this function to advance the buffer pointer, making
the data available for future read operations.
Parameters:
cnt the number of bytes written.
6.5.2.12 size_t jack_ringbuffer_write_space (const jack_ringbuffer_t ∗ rb)
Return the number of bytes available for writing.
Parameters:
Returns:
the amount of free space (in bytes) available for writing.

6.6 simple_client.c File Reference 47
6.6 simple_client.c File Reference
This simple client demonstrates the basic features of JACK as they would be used by
many applications.
#include <stdio.h>
#include <errno.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <jack/jack.h>
Functions
• int process (jack_nframes_t nframes, void ∗arg)

• void jack_shutdown (void ∗arg)
• int main (int argc, char ∗argv[ ])
Variables
• jack_port_t ∗ input_port
• jack_port_t ∗ output_port
This simple client demonstrates the basic features of JACK as they would be used by
many applications.
6.6.2.1 void jack_shutdown (void ∗ arg)
This is the shutdown callback for this JACK application. It is called by JACK if the
server ever shuts down or decides to disconnect the client.

6.6.2.2 int main (int argc, char ∗ argv[ ])
6.6.2.3 int process (jack_nframes_t nframes, void ∗ arg)
The process callback for this JACK application. It is called by JACK at the appropriate
times.
6.6.3 Variable Documentation
6.6.3.1 jack_port_t∗ input_port
6.6.3.2 jack_port_t∗ output_port

6.7 transport.dox File Reference 49
6.7 transport.dox File Reference

6.8 transport.h File Reference

#include <jack/types.h>
Data Structures
• struct jack_position_t
• struct jack_transport_info_t
Defines
• #define JACK_POSITION_MASK (JackPositionBBT|JackPositionTimecode)
• #define EXTENDED_TIME_INFO
Typedefs
• typedef uint64_t jack_unique_t
• typedef int(∗ JackSyncCallback )(jack_transport_state_t state, jack_position_t
∗pos, void ∗arg)
• typedef void(∗ JackTimebaseCallback )(jack_transport_state_t state, jack_-
nframes_t nframes, jack_position_t ∗pos, int new_pos, void ∗arg)
Enumerations
• enum jack_transport_state_t { JackTransportStopped = 0, JackTransportRolling
= 1, JackTransportLooping = 2, JackTransportStarting = 3 }
• enum jack_position_bits_t { JackPositionBBT = 0x10, JackPositionTimecode =
0x20 }
• enum jack_transport_bits_t {
JackTransportState = 0x1, JackTransportPosition = 0x2, JackTransportLoop =
0x4, JackTransportSMPTE = 0x8,
JackTransportBBT = 0x10 }
Functions
• int jack_release_timebase (jack_client_t ∗client)
• int jack_set_sync_callback (jack_client_t ∗client, JackSyncCallback sync_-
callback, void ∗arg)
• int jack_set_sync_timeout (jack_client_t ∗client, jack_time_t timeout)
• int jack_set_timebase_callback (jack_client_t ∗client, int conditional, Jack-
TimebaseCallback timebase_callback, void ∗arg)

6.8 transport.h File Reference 51
• int jack_transport_locate (jack_client_t ∗client, jack_nframes_t frame)

• jack_transport_state_t jack_transport_query (const jack_client_t ∗client, jack_-
position_t ∗pos)
• jack_nframes_t jack_get_current_transport_frame (const jack_client_t ∗client)
• int jack_transport_reposition (jack_client_t ∗client, jack_position_t ∗pos)
• void jack_transport_start (jack_client_t ∗client)
• void jack_transport_stop (jack_client_t ∗client)
• void jack_get_transport_info (jack_client_t ∗client, jack_transport_info_-
t ∗tinfo)
• void jack_set_transport_info (jack_client_t ∗client, jack_transport_info_t ∗tinfo)
6.8.1 Define Documentation
6.8.1.1 #define EXTENDED_TIME_INFO
6.8.1.2 #define JACK_POSITION_MASK (JackPositionBBT|JackPosition-

Timecode)
all valid position bits
6.8.2 Typedef Documentation
6.8.2.1 typedef uint64_t jack_unique_t
Unique ID (opaque)
6.8.2.2 typedef int(∗ JackSyncCallback)(jack_transport_state_t state,

jack_position_t ∗pos, void ∗arg)
Prototype for the sync_callback defined by slow-sync clients. When the client is active,
this callback is invoked just before process() in the same thread. This occurs once after
registration, then subsequently whenever some client requests a new position, or the
transport enters the JackTransportStarting state. This realtime function must not wait.
The transport state will be:
• JackTransportStopped when a new position is requested;
• JackTransportStarting when the transport is waiting to start;
• JackTransportRolling when the timeout has expired, and the position is now a
moving target.

Parameters:
state current transport state.
pos new transport position.
arg the argument supplied by jack_set_sync_callback().
Returns:
TRUE (non-zero) when ready to roll.
6.8.2.3 typedef void(∗ JackTimebaseCallback)(jack_transport_state_t state,

jack_nframes_t nframes, jack_position_t ∗pos, int new_pos, void ∗arg)
Prototype for the timebase_callback used to provide extended position information. Its
output affects all of the following process cycle. This realtime function must not wait.
This function is called immediately after process() in the same thread whenever the
transport is rolling, or when any client has requested a new position in the previous cy-
cle. The first cycle after jack_set_timebase_callback() is also treated as a new position,
or the first cycle after jack_activate() if the client had been inactive.
The timebase master may not use its pos argument to set pos->frame. To change
position, use jack_transport_reposition() or jack_transport_locate(). These functions
are realtime-safe, the timebase_callback can call them directly.
Parameters:
state current transport state.
nframes number of frames in current period.
pos address of the position structure for the next cycle; pos->frame will be its
frame number. If new_pos is FALSE, this structure contains extended posi-
tion information from the current cycle. If TRUE, it contains whatever was
set by the requester. The timebase_callback’s task is to update the extended
information here.
new_pos TRUE (non-zero) for a newly requested pos, or for the first cycle after
the timebase_callback is defined.
arg the argument supplied by jack_set_timebase_callback().
6.8.3 Enumeration Type Documentation
6.8.3.1 enum jack_position_bits_t
Optional struct jack_position_t fields.
Enumeration values:
JackPositionBBT Bar, Beat, Tick
JackPositionTimecode External timecode

6.8.3.2 enum jack_transport_bits_t
Optional struct jack_transport_info_t fields.
See also:
jack_position_bits_t.
Enumeration values:
JackTransportState Transport state
JackTransportPosition Frame number
JackTransportLoop Loop boundaries (ignored)
JackTransportSMPTE SMPTE (ignored)
JackTransportBBT Bar, Beat, Tick
6.8.3.3 enum jack_transport_state_t
Transport states.
Enumeration values:
JackTransportStopped Transport halted
JackTransportRolling Transport playing
JackTransportLooping For OLD_TRANSPORT, now ignored
JackTransportStarting Waiting for sync ready
6.8.4.1 jack_nframes_t jack_get_current_transport_frame (const jack_client_t

∗ client)
Return an estimate of the current transport frame, including any time elapsed since the
last transport positional update.
Parameters:
client the JACK client structure
6.8.4.2 void jack_get_transport_info (jack_client_t ∗ client,

jack_transport_info_t ∗ tinfo)
Gets the current transport info structure (deprecated).

Parameters:
client the JACK client structure.
tinfo current transport info structure. The "valid" field describes which fields con-
tain valid data.
Deprecated
This is for compatibility with the earlier transport interface. Use jack_transport_-
query(), instead.
Precondition:
Must be called from the process thread.
6.8.4.3 int jack_release_timebase (jack_client_t ∗ client)
Called by the timebase master to release itself from that responsibility.

If the timebase master releases the timebase or leaves the JACK graph for any rea-
son, the JACK engine takes over at the start of the next process cycle. The transport
state does not change. If rolling, it continues to play, with frame numbers as the only
available position information.
See also:
jack_set_timebase_callback
Parameters:
Returns:
6.8.4.4 int jack_set_sync_callback (jack_client_t ∗ client, JackSyncCallback

sync_callback, void ∗ arg)
Register (or unregister) as a slow-sync client, one that cannot respond immediately to
transport position changes.
The sync_callback will be invoked at the first available opportunity after its registration
is complete. If the client is currently active this will be the following process cycle, oth-
erwise it will be the first cycle after calling jack_activate(). After that, it runs according
to the JackSyncCallback rules. Clients that don’t set a sync_callback are assumed to
be ready immediately any time the transport wants to start.
Parameters:

sync_callback is a realtime function that returns TRUE when the client is ready.
Setting sync_callback to NULL declares that this client no longer requires
slow-sync processing.
arg an argument for the sync_callback function.
Returns:
6.8.4.5 int jack_set_sync_timeout (jack_client_t ∗ client, jack_time_t timeout)
Set the timeout value for slow-sync clients.

This timeout prevents unresponsive slow-sync clients from completely halting the
transport mechanism. The default is two seconds. When the timeout expires, the trans-
port starts rolling, even if some slow-sync clients are still unready. The sync_callbacks
of these clients continue being invoked, giving them a chance to catch up.
See also:
jack_set_sync_callback
Parameters:
timeout is delay (in microseconds) before the timeout expires.
Returns:
6.8.4.6 int jack_set_timebase_callback (jack_client_t ∗ client, int conditional,

JackTimebaseCallback timebase_callback, void ∗ arg)
Register as timebase master for the JACK subsystem.

The timebase master registers a callback that updates extended position information
such as beats or timecode whenever necessary. Without this extended information,
there is no need for this function.
There is never more than one master at a time. When a new client takes over, the
former timebase_callback is no longer called. Taking over the timebase may be done
conditionally, so it fails if there was a master already.
Parameters:
conditional non-zero for a conditional request.

timebase_callback is a realtime function that returns position information.

arg an argument for the timebase_callback function.
Returns:
• 0 on success;
• EBUSY if a conditional request fails because there was already a timebase
master;
• other non-zero error code.
6.8.4.7 void jack_set_transport_info (jack_client_t ∗ client,

jack_transport_info_t ∗ tinfo)
Set the transport info structure (deprecated).
Deprecated
This function still exists for compatibility with the earlier transport interface, but
it does nothing. Instead, define a JackTimebaseCallback.
6.8.4.8 int jack_transport_locate (jack_client_t ∗ client, jack_nframes_t frame)
Reposition the transport to a new frame number.

May be called at any time by any client. The new position takes effect in two process
cycles. If there are slow-sync clients and the transport is already rolling, it will enter the
JackTransportStarting state and begin invoking their sync_callbacks until ready. This
function is realtime-safe.
See also:
jack_transport_reposition, jack_set_sync_callback
Parameters:
frame frame number of new transport position.
Returns:
0 if valid request, non-zero otherwise.

6.8.4.9 jack_transport_state_t jack_transport_query (const jack_client_t ∗

client, jack_position_t ∗ pos)
Query the current transport state and position.

This function is realtime-safe, and can be called from any thread. If called from the
process thread, pos corresponds to the first frame of the current cycle and the state
returned is valid for the entire cycle.
Parameters:
pos pointer to structure for returning current transport position; pos->valid will
show which fields contain valid data. If pos is NULL, do not return position
information.
Returns:
Current transport state.
6.8.4.10 int jack_transport_reposition (jack_client_t ∗ client, jack_position_t ∗

pos)
Request a new transport position.

May be called at any time by any client. The new position takes effect in two process
cycles. If there are slow-sync clients and the transport is already rolling, it will enter the
JackTransportStarting state and begin invoking their sync_callbacks until ready. This
function is realtime-safe.
See also:
jack_transport_locate, jack_set_sync_callback
Parameters:
pos requested new transport position.
Returns:
0 if valid request, EINVAL if position structure rejected.
6.8.4.11 void jack_transport_start (jack_client_t ∗ client)
Start the JACK transport rolling.

Any client can make this request at any time. It takes effect no sooner than the next
process cycle, perhaps later if there are slow-sync clients. This function is realtime-
safe.

See also:
jack_set_sync_callback
Parameters:
6.8.4.12 void jack_transport_stop (jack_client_t ∗ client)
Stop the JACK transport.

Any client can make this request at any time. It takes effect on the next process cycle.
This function is realtime-safe.
Parameters:

6.9 types.h File Reference 59
6.9 types.h File Reference

#include <inttypes.h>
Defines
• #define JACK_MAX_FRAMES
• #define JACK_DEFAULT_AUDIO_TYPE "32 bit float mono audio"
Typedefs
• typedef char shm_name_t [32]
• typedef int32_t jack_shmsize_t
• typedef uint32_t jack_nframes_t
• typedef uint64_t jack_time_t
• typedef _jack_port jack_port_t
• typedef _jack_client jack_client_t
• typedef uint32_t jack_port_id_t
• typedef int(∗ JackProcessCallback )(jack_nframes_t nframes, void ∗arg)
• typedef void(∗ JackThreadInitCallback )(void ∗arg)
• typedef int(∗ JackGraphOrderCallback )(void ∗arg)
• typedef int(∗ JackXRunCallback )(void ∗arg)
• typedef int(∗ JackBufferSizeCallback )(jack_nframes_t nframes, void ∗arg)
• typedef int(∗ JackSampleRateCallback )(jack_nframes_t nframes, void ∗arg)
• typedef void(∗ JackPortRegistrationCallback )(jack_port_id_t port, int, void
∗arg)
• typedef void(∗ JackFreewheelCallback )(int starting, void ∗arg)
• typedef float jack_default_audio_sample_t
Enumerations
• enum JackPortFlags {
JackPortIsInput = 0x1, JackPortIsOutput = 0x2, JackPortIsPhysical = 0x4, Jack-
PortCanMonitor = 0x8,
JackPortIsTerminal = 0x10 }
6.9.1 Define Documentation
6.9.1.1 #define JACK_DEFAULT_AUDIO_TYPE "32 bit float mono audio"
Used for the type argument of jack_port_register() for default audio ports.

6.9.1.2 #define JACK_MAX_FRAMES
Value:
(4294967295U) /* This should be UINT32_MAX, but

C++ has a problem with that. */
Maximum value that can be stored in jack_nframes_t
6.9.2 Typedef Documentation
6.9.2.1 typedef struct _jack_client jack_client_t
jack_client_t is an opaque type. You may only access it using the API provided.
6.9.2.2 typedef float jack_default_audio_sample_t
For convenience, use this typedef if you want to be able to change between float and
double. You may want to typedef sample_t to jack_default_audio_sample_t in your
application.
6.9.2.3 typedef uint32_t jack_nframes_t
Type used to represent sample frame counts.
6.9.2.4 typedef uint32_t jack_port_id_t
Ports have unique ids. A port registration callback is the only place you ever need to
know their value.
6.9.2.5 typedef struct _jack_port jack_port_t
jack_port_t is an opaque type. You may only access it using the API provided.
6.9.2.6 typedef int32_t jack_shmsize_t
6.9.2.7 typedef uint64_t jack_time_t
Type used to represent the value of free running monotonic clock with units of mi-
croseconds.

6.9.2.8 typedef int(∗ JackBufferSizeCallback)(jack_nframes_t nframes, void

∗arg)
Prototype for the bufsize_callback that is invoked whenever the JACK engine buffer
size changes. Although this function is called in the JACK process thread, the normal
process cycle is suspended during its operation, causing a gap in the audio flow. So,
the bufsize_callback can allocate storage, touch memory not previously referenced, and
perform other operations that are not realtime safe.
Parameters:
nframes buffer size
arg pointer supplied by jack_set_buffer_size_callback().
Returns:
zero on success, non-zero on error
6.9.2.9 typedef void(∗ JackFreewheelCallback)(int starting, void ∗arg)
Prototype for the client supplied function that is called whenever jackd starts or stops
freewheeling.
Parameters:
starting non-zero if we start starting to freewheel, zero otherwise
arg pointer to a client supplied structure
6.9.2.10 typedef int(∗ JackGraphOrderCallback)(void ∗arg)
Prototype for the client supplied function that is called whenever the processing graph
is reordered.
Parameters:
Returns:
6.9.2.11 typedef void(∗ JackPortRegistrationCallback)(jack_port_id_t port, int,

void ∗arg)
Prototype for the client supplied function that is called whenever a port is registered or
unregistered.

Parameters:
6.9.2.12 typedef int(∗ JackProcessCallback)(jack_nframes_t nframes, void

∗arg)
Prototype for the client supplied function that is called by the engine anytime there is
work to be done.
Precondition:
nframes == jack_get_buffer_size()
nframes == pow(2,x)
Parameters:
nframes number of frames to process
Returns:
6.9.2.13 typedef int(∗ JackSampleRateCallback)(jack_nframes_t nframes, void

∗arg)
Prototype for the client supplied function that is called when the engine sample rate
changes.
Parameters:
nframes new engine sample rate
Returns:
6.9.2.14 typedef void(∗ JackThreadInitCallback)(void ∗arg)
Prototype for the client supplied function that is called once after the creation of the
thread in which other callbacks will be made. Special thread characteristics can be set
from this callback, for example. This is a highly specialized callback and most clients
will not and should not use it.
Parameters:

Returns:
void
6.9.2.15 typedef int(∗ JackXRunCallback)(void ∗arg)
Prototype for the client supplied function that is called whenever an xrun has occured.
Parameters:
Returns:
6.9.2.16 typedef char shm_name_t[32]
6.9.3 Enumeration Type Documentation
6.9.3.1 enum JackPortFlags
A port has a set of flags that are formed by AND-ing together the desired values from
the list below. The flags "JackPortIsInput" and "JackPortIsOutput" are mutually exclu-
sive and it is an error to use them both.
Enumeration values:
JackPortIsInput if JackPortIsInput is set, then the port can receive data.
JackPortIsOutput if JackPortIsOutput is set, then data can be read from the port.
JackPortIsPhysical if JackPortIsPhysical is set, then the port corresponds to

some kind of physical I/O connector.
JackPortCanMonitor if JackPortCanMonitor is set, then a call to jack_port_-
request_monitor() makes sense.
Precisely what this means is dependent on the client. A typical result of
it being called with TRUE as the second argument is that data that would
be available from an output port (with JackPortIsPhysical set) is sent to a
physical output connector as well, so that it can be heard/seen/whatever.
Clients that do not control physical interfaces should never create ports with
this bit set.
JackPortIsTerminal JackPortIsTerminal means:
for an input port: the data received by the port will not be passed on or made
available at any other port

for an output port: the data available at the port does not originate from any
other port
Audio synthesizers, I/O hardware interface clients, HDR systems are exam-
ples of clients that would set this flag for their ports.

Chapter 7
KIT Page
Documentation
7.1 JACK Transport Design

The JACK Audio Connection Kit provides simple transport interfaces for starting, stop-
ping and repositioning a set of clients. This document describes the overall design of
these interfaces, their detailed specifications are in <jack/transport.h>
• Requirements
• Overview
• Timebase Master
• Transport Control
• Transport Clients
• Compatibility
• Issues Not Addressed
7.1.1 Requirements
• We need sample-level accuracy for transport control. This implies that the trans-
port client logic has to be part of the realtime process chain.
66 JACK-AUDIO-CONNECTION-KIT Page Documentation
• We don’t want to add another context switch. So, the transport client logic has to
run in the context of the client’s process thread. To avoid making an extra pass
through the process graph, no transport changes take effect until the following
process cycle. That way, the transport info is stable throughout each cycle.
• We want to allow multiple clients to change the transport state. This is mostly a
usability issue. Any client can start or stop playback, or seek to a new location.
The user need not switch windows to accomplish these tasks.
• We want a way for clients with heavyweight state to sync up when the user
presses "play", before the transport starts rolling.
• We want to provide for ongoing binary compatibility as the transport design

evolves.
7.1.2 Overview
The former transport master role has been divided into two layers:
• Timebase Master - counting beats, frames, etc. on every cycle.

• Transport Control - start, stop and reposition the playback.
Existing transport clients continue to work in compatibility mode. But, old-style time-
base masters will no longer control the transport.
7.1.3 Timebase Master
The timebase master continuously updates extended position information, counting

beats, timecode, etc. Without this extended information, there is no need for this func-
tion. There is at most one master active at a time. If no client is registered as timebase
master, frame numbers will be the only position information available.
The timebase master registers a callback that updates position information while the
transport is rolling. Its output affects the following process cycle. This function is
called immediately after the process callback in the same thread whenever the transport
is rolling, or when any client has set a new position in the previous cycle. The first cycle
after jack_set_timebase_callback() is also treated as a new position, or the first cycle
after jack_activate() if the client had been inactive.
typedef int (*JackTimebaseCallback)(jack_transport_state_t state,

jack_nframes_t nframes,
jack_position_t *pos,
int new_pos,
void *arg);

7.1 JACK Transport Design 67
When a new client takes over, the former timebase callback is no longer called. Taking
over the timebase may be done conditionally, in which case the takeover fails when
there is a master already. The existing master can release it voluntarily, if desired.
int jack_set_timebase_callback (jack_client_t *client,

int conditional,
JackTimebaseCallback timebase_callback,
void *arg);
int jack_release_timebase(jack_client_t *client);
If the timebase master releases the timebase or exits the JACK graph for any reason, the
JACK engine takes over at the start of the next process cycle. The transport state does
not change. If rolling, it continues to play, with frame numbers as the only available
position information.
7.1.4 Transport Control
The JACK engine itself manages stopping and starting of the transport. Any client can
make transport control requests at any time. These requests take effect no sooner than
the next process cycle, sometimes later. The transport state is always valid, initially it
is JackTransportStopped.
void jack_transport_start (jack_client_t *client);

void jack_transport_stop (jack_client_t *client);
The engine handles polling of slow-sync clients. When someone calls jack_transport_-
start(), the engine resets the poll bits and changes to a new state, JackTransportStarting.
The sync_callback function for each slow-sync client will be invoked in the JACK
process thread while the transport is starting. If it has not already done so, the client
needs to initiate a seek to reach the starting position. The sync_callback returns false
until the seek completes and the client is ready to play. When all slow-sync clients are
ready, the state changes to JackTransportRolling.
typedef int (*JackSyncCallback)(jack_transport_state_t state,

jack_position_t *pos, void *arg);
This callback is a realtime function that runs in the JACK process thread.
int jack_set_sync_callback (jack_client_t *client,

JackSyncCallback sync_callback, void *arg);
Clients that don’t declare a sync_callback are assumed to be ready immediately, any
time the transport wants to start. If a client no longer requires slow-sync processing, it
can set its sync_callback to NULL.

int jack_set_sync_timeout (jack_client_t *client,

jack_time_t usecs);
There must be a timeout to prevent unresponsive slow-sync clients from completely

halting the transport mechanism. Two seconds is the default. When this timeout ex-
pires, the transport will start rolling, even if some slow-sync clients are still unready.
The sync_callback for these clients continues being invoked, giving them an opportu-
nity to catch up.
int jack_transport_reposition (jack_client_t *client,

jack_position_t *pos);
int jack_transport_locate (jack_client_t *client,
jack_nframes_t frame);
These request a new transport position. They can be called at any time by any client.
Even the timebase master must use them. If the request is valid, it goes into effect in
two process cycles. If there are slow-sync clients and the transport is already rolling, it
will enter the JackTransportStarting state and begin invoking their sync_callbacks until
ready.

7.1 JACK Transport Design 69
Figure 7.1: Transport State Transition Diagram
7.1.5 Transport Clients
Transport clients were formerly known as "transport slaves". We want to make it easy
for almost every JACK client to be a transport client.
jack_transport_state_t jack_transport_query (jack_client_t *client,

jack_position_t *pos);
This function can be called from any thread. If called from the process thread, pos
corresponds to the first frame of the current cycle and the state returned is valid for the
entire cycle.

7.1.6 Compatibility
During the transition period we will support the old-style interfaces in compatibility
mode as deprecated interfaces. This compatibility is not 100%, there are limitations.
The main reasons for doing this are:
• facilitate testing with clients that already have transport support

• provide a clean migration path, so application developers are not discouraged
from supporting the transport interface
These deprecated interfaces continue to work:
typedef struct jack_transport_info_t;
void jack_get_transport_info (jack_client_t *client,

jack_transport_info_t *tinfo);
Unfortunately, the old-style timebase master interface cannot coexist cleanly with such
new features as jack_transport_locate() and slow-sync clients. So, these interfaces are
only present as stubs:
void jack_set_transport_info (jack_client_t *client,

jack_transport_info_t *tinfo);
int jack_engine_takeover_timebase (jack_client_t *);
For compatibility with future changes, it would be good to avoid structures entirely.
Nevertheless, the jack_position_t structure provides a convenient way to collect time-
base information in several formats that clearly all refer to a single moment. To mini-
mize future binary compatibility problems, this structure has some padding at the end,
making it possible to extend it without necessarily breaking compatibility. New fields
can be allocated from the padding area, with access controlled by newly defined valid
bits, all of which are currently forced to zero. That allows the structure size and offsets
to remain constant.
7.1.7 Issues Not Addressed
This design currently does not address several issues. This means they will probably
not be included in JACK release 1.0.
• variable speed
• reverse play
• looping

7.2 Porting JACK 71
7.2 Porting JACK

The JACK Audio Connection Kit is designed to be portable to any system supporting
the relevant POSIX and C language standards. It currently works with GNU/Linux
and Mac OS X on several different processor architectures. This document describes
the steps needed to port JACK to another platform, and the methods used to provide
portability.
• Requirements
• Overview
• Operating System Dependencies
• Processor Dependencies
• Issues Not Addressed
7.2.1 Requirements
• Each platform should build directly from CVS or from a tarball using the GNU
./configure tools. Platform-specific toolsets can by used for development, but the
GNU tools should at least work for basic distribution and configuration.
• For long-term maintainability we want to minimize the use of conditional com-

pilation in source files.
• We should provide generic versions of all system-dependent headers, so plat-

forms need only provide those they modify.
• In some cases, operating system-specific information must be able to override

processor-specific data.
7.2.2 Overview
JACK relies on two types of platform-specific headers:
• Operating System Dependencies

• Processor Dependencies
OS-specific headers take precedence over CPU-specific headers.

The JACK configure.host script and its system-dependent header directories
were adapted from the libstdc++-v3 component of the GNU Compiler Collective,
<http://gcc.gnu.org>.

7.2.3 C Language Dependencies
JACK is written to conform with C99, as defined in International Standard ISO/IEC

9899:1999. Because many existing compilers do not fully support this standard, some
new features should be avoided for portablility reasons. For example, variables should
not be declared in the middle of a compound statement, because many compilers still
cannot handle that language extension.
7.2.4 Operating System Dependencies
JACK is written for a POSIX environment compliant with IEEE Std 1003.1-2001,
ISO/IEC 9945:2003, including the POSIX Threads Extension (1003.1c-1995) and the
Realtime and Realtime Threads feature groups. When some needed POSIX feature
is missing on a platform, the preferred solution is to provide a substitute, as with the
fakepoll.c implementation for Mac OS X.
Whenever possible, OS dependencies should be auto-detected by configure. Some-
times they can be isolated in OS-specific header files, found in subdirectories of
config/os and referenced with a <sysdeps/xxx.h> name.
If conditional compilation must be used in mainline platform-independent code, avoid
using the system name. Instead, #define a descriptive name in <config.h>, and
test it like this:
#ifdef JACK_USE_MACH_THREADS
allocate_mach_serverport(engine, client);
client->running = FALSE;
#endif
Be sure to place any generic implementation alternative in the #else or use an

#ifndef, so no other code needs to know your conditional labels.
7.2.5 Processor Dependencies
JACK uses some low-level machine operations for thread-safe updates to shared mem-
ory. A low-level implementation of <sysdeps/atomicity.h> is provided for ev-
ery target processor architecture. There is also a generic implementation using POSIX
spin locks, but that is not a good enough solution for serious use.
The GCC package provides versions that work on most modern hardware. We’ve tried
to keep things as close to the original as possible, while removing a bunch of os-specific
files that didn’t seem relevant. A primary goal has been to avoid changing the CPU-
dependent <sysdeps/atomicity.h> headers.
The relevant GCC documentation provides some help-
ful background, especially the atomicity.h discussion at
<http://gcc.gnu.org/onlinedocs/porting/Thread-safety.html>.

7.2 Porting JACK 73
7.2.6 Issues Not Addressed
• Cross-compilation has not been tested, or even thought through in much detail.
The host is the system on which JACK will run. This may differ from the build
system doing the compilation. These are selected using the standard ./configure
options -host and -build. Usually, ./config.guess can print the appropriate
canonical name for any system on which it runs.
• Platform-specific build tools like Apple’s Project Builder are not well-supported.

7.3 Deprecated List

Class jack_transport_info_t This is for compatibility with the earlier transport in-
terface. Use the jack_position_t struct, instead.
Global jack_engine_takeover_timebase(jack_client_t ∗) This function still exists

for compatibility with the earlier transport interface, but it does nothing. Instead,
see transport.h and use jack_set_timebase_callback().
Global jack_set_server_dir(const char ∗path) This function is deprecated. Don’t

use in new programs and remove it in old programs.
Global jack_get_transport_info(jack_client_t ∗client, jack_transport_info_t ∗tinfo)

This is for compatibility with the earlier transport interface. Use jack_transport_-
query(), instead.
Global jack_set_transport_info(jack_client_t ∗client, jack_transport_info_t ∗tinfo)

This function still exists for compatibility with the earlier transport interface,
but it does nothing. Instead, define a JackTimebaseCallback.

Index
bar inprocess, 22
jack_position_t, 12 jack_finish, 22
jack_transport_info_t, 17 jack_initialize, 22
bar_start_tick input_port
jack_position_t, 12 port_pair_t, 19
jack_transport_info_t, 17 simple_client.c, 48
beat
jack_position_t, 12 jack.h, 23
jack_transport_info_t, 17 jack_activate, 25
beat_type jack_client_close, 25
jack_position_t, 12 jack_client_name_size, 25
jack_transport_info_t, 17 jack_client_new, 25
beats_per_bar jack_client_thread_id, 26
jack_position_t, 12 jack_connect, 26
jack_transport_info_t, 17 jack_cpu_load, 26
beats_per_minute jack_deactivate, 26
jack_position_t, 12 jack_disconnect, 26
jack_transport_info_t, 17 jack_engine_takeover_timebase,
buf 27
jack_ringbuffer_data_t, 14 jack_error_callback, 39
jack_ringbuffer_t, 15 jack_frame_time, 27
jack_frames_since_cycle_start,
EXTENDED_TIME_INFO 27
transport.h, 51 jack_get_buffer_size, 27
jack_get_ports, 28
frame jack_get_sample_rate, 28
jack_position_t, 12 jack_internal_client_close, 28
jack_transport_info_t, 17 jack_internal_client_new, 28
frame_rate jack_is_realtime, 29
jack_position_t, 12 jack_on_shutdown, 29
jack_transport_info_t, 17 jack_port_by_id, 29
frame_time jack_port_by_name, 30
jack_position_t, 12 jack_port_connected, 30
jack_port_connected_to, 30
inprocess jack_port_disconnect, 30
inprocess.c, 22 jack_port_ensure_monitor, 30
inprocess.c, 21 jack_port_flags, 31
76 INDEX
jack_port_get_all_connections, jack_client_new
31 jack.h, 25
jack_port_get_buffer, 31 jack_client_t
jack_port_get_connections, 31 types.h, 60
jack_port_get_latency, 32 jack_client_thread_id
jack_port_get_total_latency, 32 jack.h, 26
jack_port_is_mine, 32 jack_connect
jack_port_lock, 32 jack.h, 26
jack_port_monitoring_input, 32 jack_cpu_load
jack_port_name, 33 jack.h, 26
jack_port_name_size, 33 jack_deactivate
jack_port_register, 33 jack.h, 26
jack_port_request_monitor, 34 jack_default_audio_sample_t
jack_port_request_monitor_by_- types.h, 60
name, 34 JACK_DEFAULT_AUDIO_TYPE
jack_port_set_latency, 34 types.h, 59
jack_port_set_name, 34 jack_disconnect
jack_port_short_name, 35 jack.h, 26
jack_port_tie, 35 jack_engine_takeover_timebase
jack_port_type, 35 jack.h, 27
jack_port_type_size, 35 jack_error_callback
jack_port_unlock, 35 jack.h, 39
jack_port_unregister, 35 jack_finish
jack_port_untie, 36 inprocess.c, 22
jack_set_buffer_size, 36 jack_frame_time
jack_set_buffer_size_callback, jack.h, 27
36 jack_frames_since_cycle_start
jack_set_error_function, 37 jack.h, 27
jack_set_freewheel, 37 jack_get_buffer_size
jack_set_freewheel_callback, 37 jack.h, 27
jack_set_graph_order_callback, jack_get_current_transport_frame
37 transport.h, 53
jack_set_port_registration_- jack_get_ports
callback, 38 jack.h, 28
jack_set_process_callback, 38 jack_get_sample_rate
jack_set_sample_rate_callback, jack.h, 28
38 jack_get_transport_info
jack_set_server_dir, 38 transport.h, 53
jack_set_thread_init_callback, 39 jack_initialize
jack_set_xrun_callback, 39 inprocess.c, 22
jack_activate jack_internal_client_close
jack.h, 25 jack.h, 28
jack_client_close jack_internal_client_new
jack_client_name_size jack_is_realtime

INDEX 77
JACK_MAX_FRAMES jack_port_request_monitor_by_name
types.h, 59 jack.h, 34
jack_nframes_t jack_port_set_latency
types.h, 60 jack.h, 34
jack_on_shutdown jack_port_set_name
jack_port_by_id jack_port_short_name
jack_port_by_name jack_port_t
jack.h, 30 types.h, 60
jack_port_connected jack_port_tie
jack_port_connected_to jack_port_type
jack_port_disconnect jack_port_type_size
jack_port_ensure_monitor jack_port_unlock
jack_port_flags jack_port_unregister
jack_port_get_all_connections jack_port_untie
jack_port_get_buffer jack_position_bits_t
jack.h, 31 transport.h, 52
jack_port_get_connections JACK_POSITION_MASK
jack_port_get_latency jack_position_t, 11
jack.h, 32 bar, 12
jack_port_get_total_latency bar_start_tick, 12
jack.h, 32 beat, 12
jack_port_id_t beat_type, 12
types.h, 60 beats_per_bar, 12
jack_port_is_mine beats_per_minute, 12
jack.h, 32 frame, 12
jack_port_lock frame_rate, 12
jack.h, 32 frame_time, 12
jack_port_monitoring_input next_time, 12
jack.h, 32 padding, 12
jack_port_name tick, 13
jack.h, 33 ticks_per_beat, 13
jack_port_name_size unique_1, 13
jack.h, 33 unique_2, 13
jack_port_register usecs, 13
jack.h, 33 valid, 13
jack_port_request_monitor jack_release_timebase

78 INDEX
jack_ringbuffer_create jack_set_port_registration_callback
ringbuffer.h, 43 jack.h, 38
jack_ringbuffer_data_t, 14 jack_set_process_callback
buf, 14 jack.h, 38
len, 14 jack_set_sample_rate_callback
jack_ringbuffer_free jack.h, 38
ringbuffer.h, 43 jack_set_server_dir
jack_ringbuffer_get_read_vector jack.h, 38
ringbuffer.h, 43 jack_set_sync_callback
jack_ringbuffer_get_write_vector transport.h, 54
ringbuffer.h, 43 jack_set_sync_timeout
jack_ringbuffer_mlock transport.h, 55
ringbuffer.h, 44 jack_set_thread_init_callback
jack_ringbuffer_read jack.h, 39
ringbuffer.h, 44 jack_set_timebase_callback
jack_ringbuffer_read_advance transport.h, 55
ringbuffer.h, 44 jack_set_transport_info
jack_ringbuffer_read_space transport.h, 56
ringbuffer.h, 45 jack_set_xrun_callback
jack_ringbuffer_reset jack.h, 39
ringbuffer.h, 45 jack_shmsize_t
jack_ringbuffer_t, 15 types.h, 60
buf, 15 jack_shutdown
mlocked, 15 simple_client.c, 47
read_ptr, 15 jack_time_t
size, 15 types.h, 60
size_mask, 15 jack_transport_bits_t
write_ptr, 15 transport.h, 52
jack_ringbuffer_write jack_transport_info_t, 16
ringbuffer.h, 45 bar, 17
jack_ringbuffer_write_advance bar_start_tick, 17
ringbuffer.h, 45 beat, 17
jack_ringbuffer_write_space beat_type, 17
ringbuffer.h, 46 beats_per_bar, 17
jack_set_buffer_size beats_per_minute, 17
jack.h, 36 frame, 17
jack_set_buffer_size_callback frame_rate, 17
jack.h, 36 loop_end, 17
jack_set_error_function loop_start, 17
jack.h, 37 smpte_frame_rate, 17
jack_set_freewheel smpte_offset, 17
jack.h, 37 tick, 17
jack_set_freewheel_callback ticks_per_beat, 17
jack.h, 37 transport_state, 17
jack_set_graph_order_callback usecs, 17
jack.h, 37 valid, 17

INDEX 79
jack_transport_locate JackTimebaseCallback
transport.h, 56 transport.h, 52
jack_transport_query JackTransportBBT
jack_transport_reposition JackTransportLoop
jack_transport_start JackTransportLooping
jack_transport_state_t JackTransportPosition
jack_transport_stop JackTransportRolling
jack_unique_t JackTransportSMPTE
JackBufferSizeCallback JackTransportStarting
types.h, 60 transport.h, 53
JackFreewheelCallback JackTransportState
JackGraphOrderCallback JackTransportStopped
JackPortCanMonitor JackXRunCallback
types.h, 63 types.h, 63
JackPortFlags
types.h, 63 len
JackPortIsInput jack_ringbuffer_data_t, 14
types.h, 63 loop_end
JackPortIsOutput jack_transport_info_t, 17
types.h, 63 loop_start
JackPortIsPhysical jack_transport_info_t, 17
types.h, 63
JackPortIsTerminal main
types.h, 63 simple_client.c, 47
JackPortRegistrationCallback mainpage.dox, 40
types.h, 61 mlocked
JackPositionBBT jack_ringbuffer_t, 15
transport.h, 52 next_time
JackPositionTimecode jack_position_t, 12
transport.h, 52
JackProcessCallback output_port
types.h, 62 port_pair_t, 19
JackSampleRateCallback simple_client.c, 48
types.h, 62
JackSyncCallback padding
transport.h, 51 jack_position_t, 12
JackThreadInitCallback port_pair_t, 19
types.h, 62 input_port, 19

80 INDEX
output_port, 19 jack_position_t, 13
porting.dox, 41 jack_transport_info_t, 17
process transport.dox, 49
simple_client.c, 48 transport.h, 50
EXTENDED_TIME_INFO, 51
read_ptr jack_get_current_transport_-
jack_ringbuffer_t, 15 frame, 53
ringbuffer.h, 42 jack_get_transport_info, 53
jack_ringbuffer_create, 43 jack_position_bits_t, 52
jack_ringbuffer_free, 43 JACK_POSITION_MASK, 51
jack_ringbuffer_get_read_vector, jack_release_timebase, 54
43 jack_set_sync_callback, 54
jack_ringbuffer_get_write_- jack_set_sync_timeout, 55
vector, 43 jack_set_timebase_callback, 55
jack_ringbuffer_mlock, 44 jack_set_transport_info, 56
jack_ringbuffer_read, 44 jack_transport_bits_t, 52
jack_ringbuffer_read_advance, jack_transport_locate, 56
44 jack_transport_query, 56
jack_ringbuffer_read_space, 45 jack_transport_reposition, 57
jack_ringbuffer_reset, 45 jack_transport_start, 57
jack_ringbuffer_write, 45 jack_transport_state_t, 53
jack_ringbuffer_write_advance, jack_transport_stop, 58
45 jack_unique_t, 51
jack_ringbuffer_write_space, 46 JackPositionBBT, 52
JackPositionTimecode, 52
shm_name_t JackSyncCallback, 51
types.h, 63 JackTimebaseCallback, 52
simple_client.c, 47 JackTransportBBT, 53
input_port, 48 JackTransportLoop, 53
jack_shutdown, 47 JackTransportLooping, 53
main, 47 JackTransportPosition, 53
output_port, 48 JackTransportRolling, 53
process, 48 JackTransportSMPTE, 53
size JackTransportStarting, 53
jack_ringbuffer_t, 15 JackTransportState, 53
size_mask JackTransportStopped, 53
jack_ringbuffer_t, 15 transport_state
smpte_frame_rate jack_transport_info_t, 17
jack_transport_info_t, 17 types.h, 59
smpte_offset jack_client_t, 60
jack_transport_info_t, 17 jack_default_audio_sample_t, 60
JACK_DEFAULT_AUDIO_-
tick TYPE, 59
jack_position_t, 13 JACK_MAX_FRAMES, 59
jack_transport_info_t, 17 jack_nframes_t, 60
ticks_per_beat jack_port_id_t, 60

INDEX 81
jack_port_t, 60
jack_shmsize_t, 60
jack_time_t, 60
JackBufferSizeCallback, 60
JackFreewheelCallback, 61
JackGraphOrderCallback, 61
JackPortCanMonitor, 63
JackPortFlags, 63
JackPortIsInput, 63
JackPortIsOutput, 63
JackPortIsPhysical, 63
JackPortIsTerminal, 63
JackPortRegistrationCallback, 61
JackProcessCallback, 62
JackSampleRateCallback, 62
JackThreadInitCallback, 62
JackXRunCallback, 63
shm_name_t, 63
unique_1
jack_position_t, 13
unique_2
jack_position_t, 13
usecs
jack_position_t, 13
jack_transport_info_t, 17
valid
jack_position_t, 13
jack_transport_info_t, 17
write_ptr
jack_ringbuffer_t, 15

Jack

Uploaded by

Jack

Uploaded by

JACK-AUDIO-CONNECTION-KIT Reference Manual

Generated by Doxygen 1.3.6-20040222

Tue Apr 27 12:27:40 2004

1 JACK Audio Connection Kit 1

2 JACK-AUDIO-CONNECTION-KIT Data Structure Index 5

3 JACK-AUDIO-CONNECTION-KIT File Index 7

4 JACK-AUDIO-CONNECTION-KIT Page Index 9

5 JACK-AUDIO-CONNECTION-KIT Data Structure Documentation 11

6 JACK-AUDIO-CONNECTION-KIT File Documentation 21

6.2 jack.h File Reference . . . . . . . . . . . . . . . . . . . . . . . . . . 23

7 JACK-AUDIO-CONNECTION-KIT Page Documentation 65

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

JACK Audio Connection Kit

1.2 JACK Overview

• calling jack_client_new to connect to the JACK server.

• registering "ports" to enable data to be moved to and from your application.

• telling JACK that your application is ready to start processing data.

• <jack/jack.h> defines most of the JACK interfaces.

• <jack/ringbuffer.h> defines a simple API for using lock-free ringbuffers. These

• <jack/transport.h> defines a simple transport control mechanism for starting,

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

• <jack/types.h> defines most of the JACK data types.

In addition, the example-clients directory provides numerous examples of simple JACK

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

2.1 JACK-AUDIO-CONNECTION-KIT Data Struc-

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

3.1 JACK-AUDIO-CONNECTION-KIT File List

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

4.1 JACK-AUDIO-CONNECTION-KIT Related

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

5.1 jack_position_t Struct Reference

5.1.1 Detailed Description

Struct for transport position information.

5.1.2 Field Documentation

5.1.2.1 int32_t jack_position_t::bar

5.1.2.2 double jack_position_t::bar_start_tick

5.1.2.3 int32_t jack_position_t::beat

5.1.2.4 float jack_position_t::beat_type

5.1.2.5 float jack_position_t::beats_per_bar

5.1.2.6 double jack_position_t::beats_per_minute

5.1.2.7 jack_nframes_t jack_position_t::frame

frame number, always present

5.1.2.8 jack_nframes_t jack_position_t::frame_rate

current frame rate (per second)

5.1.2.9 double jack_position_t::frame_time

current time in seconds

5.1.2.10 double jack_position_t::next_time

next sequential frame_time (unless repositioned)

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

5.1.2.11 int32_t jack_position_t::padding[10]

5.1.2.12 int32_t jack_position_t::tick

5.1.2.13 double jack_position_t::ticks_per_beat

5.1.2.14 jack_unique_t jack_position_t::unique_1

5.1.2.15 jack_unique_t jack_position_t::unique_2

5.1.2.16 jack_time_t jack_position_t::usecs

5.1.2.17 jack_position_bits_t jack_position_t::valid

which other fields are valid

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

5.2 jack_ringbuffer_data_t Struct Reference

5.2.1 Field Documentation

5.2.1.1 char∗ jack_ringbuffer_data_t::buf

5.2.1.2 size_t jack_ringbuffer_data_t::len

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

5.3 jack_ringbuffer_t Struct Reference

5.3.1 Field Documentation

5.3.1.1 char∗ jack_ringbuffer_t::buf

5.3.1.2 int jack_ringbuffer_t::mlocked

5.3.1.3 volatile size_t jack_ringbuffer_t::read_ptr

5.3.1.4 size_t jack_ringbuffer_t::size

5.3.1.5 size_t jack_ringbuffer_t::size_mask

5.3.1.6 volatile size_t jack_ringbuffer_t::write_ptr

Generated on Tue Apr 27 12:27:41 2004 for JACK-AUDIO-CONNECTION-KIT by Doxygen

5.4 jack_transport_info_t Struct Reference

5.4.1 Detailed Description

Deprecated struct for transport position information.