1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
|
/* -*- mode: c; c-file-style: "bsd"; -*- */
/*
Copyright (C) 2001-2003 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef __jack_engine_h__
#define __jack_engine_h__
#include <jack/jack.h>
#include "internal.h"
#include "driver_interface.h"
struct _jack_driver;
struct _jack_client_internal;
struct _jack_port_internal;
/* Structures is allocated by the engine in local memory to keep track
* of port buffers and connections.
*/
typedef struct {
jack_shm_info_t* shm_info;
jack_shmsize_t offset;
} jack_port_buffer_info_t;
/* The engine keeps an array of these in its local memory. */
typedef struct _jack_port_internal {
struct _jack_port_shared *shared;
JSList *connections;
jack_port_buffer_info_t *buffer_info;
} jack_port_internal_t;
/* The engine's internal port type structure. */
typedef struct _jack_port_buffer_list {
pthread_mutex_t lock; /* only lock within server */
JSList *freelist; /* list of free buffers */
jack_port_buffer_info_t *info; /* jack_buffer_info_t array */
} jack_port_buffer_list_t;
typedef struct _jack_reserved_name {
jack_uuid_t uuid;
char name[JACK_CLIENT_NAME_SIZE];
} jack_reserved_name_t;
#define JACKD_WATCHDOG_TIMEOUT 10000
#define JACKD_CLIENT_EVENT_TIMEOUT 2000
/* The main engine structure in local memory. */
struct _jack_engine {
jack_control_t *control;
JSList *drivers;
struct _jack_driver *driver;
jack_driver_desc_t *driver_desc;
JSList *driver_params;
JSList *slave_drivers;
/* these are "callbacks" made by the driver backend */
int (*set_buffer_size) (struct _jack_engine *, jack_nframes_t frames);
int (*set_sample_rate) (struct _jack_engine *, jack_nframes_t frames);
int (*run_cycle) (struct _jack_engine *, jack_nframes_t nframes,
float delayed_usecs);
void (*delay) (struct _jack_engine *, float delayed_usecs);
void (*transport_cycle_start) (struct _jack_engine *, jack_time_t time);
void (*driver_exit) (struct _jack_engine *);
jack_time_t (*get_microseconds)(void);
/* "private" sections starts here */
/* engine serialization -- use precedence for deadlock avoidance */
pthread_mutex_t request_lock; /* precedes client_lock */
pthread_rwlock_t client_lock;
pthread_mutex_t port_lock;
pthread_mutex_t problem_lock; /* must hold write lock on client_lock */
int process_errors;
int period_msecs;
/* Time to wait for clients in msecs. Used when jackd is run
* without realtime priority enabled. */
int client_timeout_msecs;
/* info on the shm segment containing this->control */
jack_shm_info_t control_shm;
/* address-space local port buffer and segment info,
indexed by the port type_id
*/
jack_port_buffer_list_t port_buffers[JACK_MAX_PORT_TYPES];
jack_shm_info_t port_segment[JACK_MAX_PORT_TYPES];
unsigned int port_max;
pthread_t server_thread;
int fds[2];
int cleanup_fifo[2];
size_t pfd_size;
size_t pfd_max;
struct pollfd *pfd;
char fifo_prefix[PATH_MAX+1];
int *fifo;
unsigned long fifo_size;
/* session handling */
int session_reply_fd;
int session_pending_replies;
unsigned long external_client_cnt;
int rtpriority;
volatile char freewheeling;
volatile char stop_freewheeling;
jack_uuid_t fwclient;
pthread_t freewheel_thread;
char verbose;
char do_munlock;
const char *server_name;
char temporary;
int reordered;
int feedbackcount;
int removing_clients;
pid_t wait_pid;
int nozombies;
int timeout_count_threshold;
volatile int problems;
volatile int timeout_count;
volatile int new_clients_allowed;
/* these lists are protected by `client_lock' */
JSList *clients;
JSList *clients_waiting;
JSList *reserved_client_names;
jack_port_internal_t *internal_ports;
jack_client_internal_t *timebase_client;
jack_port_buffer_info_t *silent_buffer;
jack_client_internal_t *current_client;
#define JACK_ENGINE_ROLLING_COUNT 32
#define JACK_ENGINE_ROLLING_INTERVAL 1024
jack_time_t rolling_client_usecs[JACK_ENGINE_ROLLING_COUNT];
int rolling_client_usecs_cnt;
int rolling_client_usecs_index;
int rolling_interval;
float max_usecs;
float spare_usecs;
int first_wakeup;
#ifdef JACK_USE_MACH_THREADS
/* specific resources for server/client real-time thread communication */
mach_port_t servertask, bp;
int portnum;
#endif
/* used for port names munging */
int audio_out_cnt;
int audio_in_cnt;
int midi_out_cnt;
int midi_in_cnt;
};
/* public functions */
jack_engine_t *jack_engine_new (int real_time, int real_time_priority,
int do_mlock, int do_unlock,
const char *server_name, int temporary,
int verbose, int client_timeout,
unsigned int port_max,
pid_t waitpid, jack_nframes_t frame_time_offset, int nozombies,
int timeout_count_threshold,
JSList *drivers);
void jack_engine_delete (jack_engine_t *);
int jack_run (jack_engine_t *engine);
int jack_wait (jack_engine_t *engine);
int jack_engine_load_driver (jack_engine_t *engine,
jack_driver_desc_t * driver_desc,
JSList * driver_params);
int jack_engine_load_slave_driver (jack_engine_t *engine,
jack_driver_desc_t * driver_desc,
JSList * driver_params);
void jack_dump_configuration(jack_engine_t *engine, int take_lock);
/* private engine functions */
void jack_engine_reset_rolling_usecs (jack_engine_t *engine);
int internal_client_request (void* ptr, jack_request_t *request);
int jack_get_fifo_fd (jack_engine_t *engine,
unsigned int which_fifo);
extern jack_timer_type_t clock_source;
extern jack_client_internal_t *
jack_client_internal_by_id (jack_engine_t *engine, jack_uuid_t id);
#define jack_rdlock_graph(e) { DEBUG ("acquiring graph read lock"); if (pthread_rwlock_rdlock (&e->client_lock)) abort(); }
#define jack_lock_graph(e) { DEBUG ("acquiring graph write lock"); if (pthread_rwlock_wrlock (&e->client_lock)) abort(); }
#define jack_try_rdlock_graph(e) pthread_rwlock_tryrdlock (&e->client_lock)
#define jack_unlock_graph(e) { DEBUG ("release graph lock"); if (pthread_rwlock_unlock (&e->client_lock)) abort(); }
#define jack_trylock_problems(e) pthread_mutex_trylock (&e->problem_lock)
#define jack_lock_problems(e) { DEBUG ("acquiring problem lock"); if (pthread_mutex_lock (&e->problem_lock)) abort(); }
#define jack_unlock_problems(e) { DEBUG ("release problem lock"); if (pthread_mutex_unlock (&e->problem_lock)) abort(); }
#if 0
static inline void jack_rdlock_graph (jack_engine_t* engine) {
DEBUG ("acquiring graph read lock");
pthread_rwlock_rdlock (&engine->client_lock);
}
static inline void jack_lock_graph (jack_engine_t* engine) {
DEBUG ("acquiring graph lock");
pthread_rwlock_wrlock (&engine->client_lock);
}
static inline int jack_try_rdlock_graph (jack_engine_t *engine)
{
DEBUG ("TRYING to acquiring graph read lock");
return pthread_rwlock_tryrdlock (&engine->client_lock);
}
static inline void jack_unlock_graph (jack_engine_t* engine)
{
DEBUG ("releasing graph lock");
pthread_rwlock_unlock (&engine->client_lock);
}
#endif
static inline unsigned int jack_power_of_two (unsigned int n)
{
return !(n & (n - 1));
}
/* Internal port handling interfaces for JACK engine. */
void jack_port_clear_connections (jack_engine_t *engine,
jack_port_internal_t *port);
void jack_port_registration_notify (jack_engine_t *, jack_port_id_t, int);
void jack_port_release (jack_engine_t *engine, jack_port_internal_t *);
void jack_sort_graph (jack_engine_t *engine);
int jack_stop_freewheeling (jack_engine_t* engine, int engine_exiting);
jack_client_internal_t *
jack_client_by_name (jack_engine_t *engine, const char *name);
int jack_deliver_event (jack_engine_t *, jack_client_internal_t *, const jack_event_t *, ...);
void
jack_engine_signal_problems (jack_engine_t* engine);
int
jack_use_driver (jack_engine_t *engine, struct _jack_driver *driver);
int
jack_drivers_start (jack_engine_t *engine);
int
jack_add_slave_driver (jack_engine_t *engine, struct _jack_driver *driver);
#endif /* __jack_engine_h__ */
|
