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
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
#ifndef foocorehfoo
#define foocorehfoo
/***
This file is part of PulseAudio.
Copyright 2004-2006 Lennart Poettering
PulseAudio is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License,
or (at your option) any later version.
PulseAudio 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 Lesser General Public License
along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
***/
#include <pulsecore/typedefs.h>
#include <pulse/mainloop-api.h>
#include <pulse/sample.h>
#include <pulsecore/cpu.h>
/* This is a bitmask that encodes the cause why a sink/source is
* suspended.
*
* When adding new causes, remember to update pa_suspend_cause_to_string() and
* PA_SUSPEND_CAUSE_TO_STRING_BUF_SIZE! */
typedef enum pa_suspend_cause {
PA_SUSPEND_USER = 1, /* Exposed to the user via some protocol */
PA_SUSPEND_APPLICATION = 2, /* Used by the device reservation logic */
PA_SUSPEND_IDLE = 4, /* Used by module-suspend-on-idle */
PA_SUSPEND_SESSION = 8, /* Used by module-hal for mark inactive sessions */
PA_SUSPEND_PASSTHROUGH = 16, /* Used to suspend monitor sources when the sink is in passthrough mode */
PA_SUSPEND_INTERNAL = 32, /* This is used for short period server-internal suspends, such as for sample rate updates */
PA_SUSPEND_UNAVAILABLE = 64, /* Used by device implementations that have to suspend when the device is unavailable */
PA_SUSPEND_ALL = 0xFFFF /* Magic cause that can be used to resume forcibly */
} pa_suspend_cause_t;
#include <pulsecore/idxset.h>
#include <pulsecore/hashmap.h>
#include <pulsecore/memblock.h>
#include <pulsecore/resampler.h>
#include <pulsecore/llist.h>
#include <pulsecore/hook-list.h>
#include <pulsecore/asyncmsgq.h>
#include <pulsecore/sample-util.h>
#include <pulsecore/sink.h>
#include <pulsecore/source.h>
#include <pulsecore/core-subscribe.h>
#include <pulsecore/msgobject.h>
typedef enum pa_server_type {
PA_SERVER_TYPE_UNSET,
PA_SERVER_TYPE_USER,
PA_SERVER_TYPE_SYSTEM,
PA_SERVER_TYPE_NONE
} pa_server_type_t;
typedef enum pa_core_state {
PA_CORE_STARTUP,
PA_CORE_RUNNING,
PA_CORE_SHUTDOWN
} pa_core_state_t;
typedef enum pa_core_hook {
PA_CORE_HOOK_SINK_NEW,
PA_CORE_HOOK_SINK_FIXATE,
PA_CORE_HOOK_SINK_PUT,
PA_CORE_HOOK_SINK_UNLINK,
PA_CORE_HOOK_SINK_UNLINK_POST,
PA_CORE_HOOK_SINK_STATE_CHANGED,
PA_CORE_HOOK_SINK_PROPLIST_CHANGED,
PA_CORE_HOOK_SINK_PORT_CHANGED,
PA_CORE_HOOK_SINK_FLAGS_CHANGED,
PA_CORE_HOOK_SINK_VOLUME_CHANGED,
PA_CORE_HOOK_SINK_MUTE_CHANGED,
PA_CORE_HOOK_SINK_PORT_LATENCY_OFFSET_CHANGED,
PA_CORE_HOOK_SOURCE_NEW,
PA_CORE_HOOK_SOURCE_FIXATE,
PA_CORE_HOOK_SOURCE_PUT,
PA_CORE_HOOK_SOURCE_UNLINK,
PA_CORE_HOOK_SOURCE_UNLINK_POST,
PA_CORE_HOOK_SOURCE_STATE_CHANGED,
PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED,
PA_CORE_HOOK_SOURCE_PORT_CHANGED,
PA_CORE_HOOK_SOURCE_FLAGS_CHANGED,
PA_CORE_HOOK_SOURCE_VOLUME_CHANGED,
PA_CORE_HOOK_SOURCE_MUTE_CHANGED,
PA_CORE_HOOK_SOURCE_PORT_LATENCY_OFFSET_CHANGED,
PA_CORE_HOOK_SINK_INPUT_NEW,
PA_CORE_HOOK_SINK_INPUT_FIXATE,
PA_CORE_HOOK_SINK_INPUT_PUT,
PA_CORE_HOOK_SINK_INPUT_UNLINK,
PA_CORE_HOOK_SINK_INPUT_UNLINK_POST,
PA_CORE_HOOK_SINK_INPUT_MOVE_START,
PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH,
PA_CORE_HOOK_SINK_INPUT_MOVE_FAIL,
PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED,
PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED,
PA_CORE_HOOK_SINK_INPUT_VOLUME_CHANGED,
PA_CORE_HOOK_SINK_INPUT_MUTE_CHANGED,
PA_CORE_HOOK_SINK_INPUT_PREFERRED_SINK_CHANGED,
PA_CORE_HOOK_SINK_INPUT_SEND_EVENT,
PA_CORE_HOOK_SOURCE_OUTPUT_NEW,
PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE,
PA_CORE_HOOK_SOURCE_OUTPUT_PUT,
PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK,
PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST,
PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START,
PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH,
PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL,
PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED,
PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED,
PA_CORE_HOOK_SOURCE_OUTPUT_VOLUME_CHANGED,
PA_CORE_HOOK_SOURCE_OUTPUT_MUTE_CHANGED,
PA_CORE_HOOK_SOURCE_OUTPUT_PREFERRED_SOURCE_CHANGED,
PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT,
PA_CORE_HOOK_CLIENT_NEW,
PA_CORE_HOOK_CLIENT_PUT,
PA_CORE_HOOK_CLIENT_UNLINK,
PA_CORE_HOOK_CLIENT_PROPLIST_CHANGED,
PA_CORE_HOOK_CLIENT_SEND_EVENT,
PA_CORE_HOOK_CARD_NEW,
PA_CORE_HOOK_CARD_CHOOSE_INITIAL_PROFILE,
PA_CORE_HOOK_CARD_PUT,
PA_CORE_HOOK_CARD_UNLINK,
PA_CORE_HOOK_CARD_PREFERRED_PORT_CHANGED,
PA_CORE_HOOK_CARD_PROFILE_CHANGED,
PA_CORE_HOOK_CARD_PROFILE_ADDED,
PA_CORE_HOOK_CARD_PROFILE_AVAILABLE_CHANGED,
PA_CORE_HOOK_CARD_SUSPEND_CHANGED,
PA_CORE_HOOK_PORT_AVAILABLE_CHANGED,
PA_CORE_HOOK_PORT_LATENCY_OFFSET_CHANGED,
PA_CORE_HOOK_DEFAULT_SINK_CHANGED,
PA_CORE_HOOK_DEFAULT_SOURCE_CHANGED,
PA_CORE_HOOK_MODULE_NEW,
PA_CORE_HOOK_MODULE_PROPLIST_CHANGED,
PA_CORE_HOOK_MODULE_UNLINK,
PA_CORE_HOOK_SAMPLE_CACHE_NEW,
PA_CORE_HOOK_SAMPLE_CACHE_CHANGED,
PA_CORE_HOOK_SAMPLE_CACHE_UNLINK,
PA_CORE_HOOK_MAX
} pa_core_hook_t;
/* The core structure of PulseAudio. Every PulseAudio daemon contains
* exactly one of these. It is used for storing kind of global
* variables for the daemon. */
struct pa_core {
pa_msgobject parent;
pa_core_state_t state;
/* A random value which may be used to identify this instance of
* PulseAudio. Not cryptographically secure in any way. */
uint32_t cookie;
pa_mainloop_api *mainloop;
/* idxset of all kinds of entities */
pa_idxset *clients, *cards, *sinks, *sources, *sink_inputs, *source_outputs, *modules, *scache;
/* Some hashmaps for all sorts of entities */
pa_hashmap *namereg, *shared, *message_handlers;
/* The default sink/source as configured by the user. If the user hasn't
* explicitly configured anything, these are set to NULL. These are strings
* instead of sink/source pointers, because that allows us to reference
* devices that don't currently exist. That's useful for remembering that
* a hotplugged USB sink was previously set as the default sink. */
char *configured_default_sink;
char *configured_default_source;
/* The default sink/source set by some policy module. This will override
* the user configured default sink/source, so that the default will
* return to the user configured sink/source once the sink/source set by
* the policy module is no longer available. */
char *policy_default_sink;
char *policy_default_source;
/* The effective default sink/source. If no sink or source is explicitly
* configured as the default, we pick the device that ranks highest
* according to the compare_sinks() and compare_sources() functions in
* core.c. pa_core_update_default_sink/source() has to be called whenever
* anything changes that might change the comparison results. */
pa_sink *default_sink;
pa_source *default_source;
pa_channel_map default_channel_map;
pa_sample_spec default_sample_spec;
uint32_t alternate_sample_rate;
unsigned default_n_fragments, default_fragment_size_msec;
unsigned deferred_volume_safety_margin_usec;
int deferred_volume_extra_delay_usec;
unsigned lfe_crossover_freq;
pa_defer_event *module_defer_unload_event;
pa_hashmap *modules_pending_unload; /* pa_module -> pa_module (hashmap-as-a-set) */
pa_defer_event *subscription_defer_event;
PA_LLIST_HEAD(pa_subscription, subscriptions);
PA_LLIST_HEAD(pa_subscription_event, subscription_event_queue);
pa_subscription_event *subscription_event_last;
/* The mempool is used for data we write to, it's readonly for the client. */
pa_mempool *mempool;
/* Shared memory size, as specified either by daemon configuration
* or PA daemon defaults (~ 64 MiB). */
size_t shm_size;
pa_silence_cache silence_cache;
pa_time_event *exit_event;
pa_time_event *scache_auto_unload_event;
int exit_idle_time, scache_idle_time;
bool flat_volumes:1;
bool rescue_streams:1;
bool disallow_module_loading:1;
bool disallow_exit:1;
bool running_as_daemon:1;
bool realtime_scheduling:1;
bool avoid_resampling:1;
bool disable_remixing:1;
bool remixing_use_all_sink_channels:1;
bool remixing_produce_lfe:1;
bool remixing_consume_lfe:1;
bool deferred_volume:1;
pa_resample_method_t resample_method;
int realtime_priority;
pa_server_type_t server_type;
pa_cpu_info cpu_info;
/* hooks */
pa_hook hooks[PA_CORE_HOOK_MAX];
};
PA_DECLARE_PUBLIC_CLASS(pa_core);
#define PA_CORE(o) pa_core_cast(o)
enum {
PA_CORE_MESSAGE_UNLOAD_MODULE,
PA_CORE_MESSAGE_MAX
};
pa_core* pa_core_new(pa_mainloop_api *m, bool shared, bool enable_memfd, size_t shm_size);
void pa_core_set_configured_default_sink(pa_core *core, const char *sink);
void pa_core_set_configured_default_source(pa_core *core, const char *source);
void pa_core_set_policy_default_sink(pa_core *core, const char *sink);
void pa_core_set_policy_default_source(pa_core *core, const char *source);
/* These should be called whenever something changes that may affect the
* default sink or source choice.
*
* If the default source choice happens between two monitor sources, the
* monitored sinks are compared, so if the default sink changes, the default
* source may change too. However, pa_core_update_default_sink() calls
* pa_core_update_default_source() internally, so it's sufficient to only call
* pa_core_update_default_sink() when something happens that affects the sink
* ordering. */
void pa_core_update_default_sink(pa_core *core);
void pa_core_update_default_source(pa_core *core);
void pa_core_set_exit_idle_time(pa_core *core, int time);
/* Check whether no one is connected to this core */
void pa_core_check_idle(pa_core *c);
int pa_core_exit(pa_core *c, bool force, int retval);
void pa_core_maybe_vacuum(pa_core *c);
/* wrapper for c->mainloop->time_*() RT time events */
pa_time_event* pa_core_rttime_new(pa_core *c, pa_usec_t usec, pa_time_event_cb_t cb, void *userdata);
void pa_core_rttime_restart(pa_core *c, pa_time_event *e, pa_usec_t usec);
static const size_t PA_SUSPEND_CAUSE_TO_STRING_BUF_SIZE =
sizeof("USER|APPLICATION|IDLE|SESSION|PASSTHROUGH|INTERNAL|UNAVAILABLE");
/* Converts the given suspend cause to a string. The string is written to the
* provided buffer. The same buffer is the return value of this function. */
const char *pa_suspend_cause_to_string(pa_suspend_cause_t cause, char buf[PA_SUSPEND_CAUSE_TO_STRING_BUF_SIZE]);
void pa_core_move_streams_to_newly_available_preferred_sink(pa_core *c, pa_sink *s);
void pa_core_move_streams_to_newly_available_preferred_source(pa_core *c, pa_source *s);
#endif
|