5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2.1 of the License,
12 or (at your option) any later version.
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
23 #include <pulsecore/typedefs.h>
24 #include <pulse/mainloop-api.h>
25 #include <pulse/sample.h>
26 #include <pulsecore/cpu.h>
28 /* This is a bitmask that encodes the cause why a sink/source is
30 typedef enum pa_suspend_cause {
31 PA_SUSPEND_USER = 1, /* Exposed to the user via some protocol */
32 PA_SUSPEND_APPLICATION = 2, /* Used by the device reservation logic */
33 PA_SUSPEND_IDLE = 4, /* Used by module-suspend-on-idle */
34 PA_SUSPEND_SESSION = 8, /* Used by module-hal for mark inactive sessions */
35 PA_SUSPEND_PASSTHROUGH = 16, /* Used to suspend monitor sources when the sink is in passthrough mode */
36 PA_SUSPEND_INTERNAL = 32, /* This is used for short period server-internal suspends, such as for sample rate updates */
37 PA_SUSPEND_ALL = 0xFFFF /* Magic cause that can be used to resume forcibly */
40 #include <pulsecore/idxset.h>
41 #include <pulsecore/hashmap.h>
42 #include <pulsecore/memblock.h>
43 #include <pulsecore/resampler.h>
44 #include <pulsecore/llist.h>
45 #include <pulsecore/hook-list.h>
46 #include <pulsecore/asyncmsgq.h>
47 #include <pulsecore/sample-util.h>
48 #include <pulsecore/sink.h>
49 #include <pulsecore/source.h>
50 #include <pulsecore/core-subscribe.h>
51 #include <pulsecore/msgobject.h>
53 typedef enum pa_server_type {
56 PA_SERVER_TYPE_SYSTEM,
60 typedef enum pa_core_state {
66 typedef enum pa_core_hook {
67 PA_CORE_HOOK_SINK_NEW,
68 PA_CORE_HOOK_SINK_FIXATE,
69 PA_CORE_HOOK_SINK_PUT,
70 PA_CORE_HOOK_SINK_UNLINK,
71 PA_CORE_HOOK_SINK_UNLINK_POST,
72 PA_CORE_HOOK_SINK_STATE_CHANGED,
73 PA_CORE_HOOK_SINK_PROPLIST_CHANGED,
74 PA_CORE_HOOK_SINK_PORT_CHANGED,
75 PA_CORE_HOOK_SINK_FLAGS_CHANGED,
76 PA_CORE_HOOK_SINK_VOLUME_CHANGED,
77 PA_CORE_HOOK_SINK_MUTE_CHANGED,
78 PA_CORE_HOOK_SINK_PORT_LATENCY_OFFSET_CHANGED,
79 PA_CORE_HOOK_SOURCE_NEW,
80 PA_CORE_HOOK_SOURCE_FIXATE,
81 PA_CORE_HOOK_SOURCE_PUT,
82 PA_CORE_HOOK_SOURCE_UNLINK,
83 PA_CORE_HOOK_SOURCE_UNLINK_POST,
84 PA_CORE_HOOK_SOURCE_STATE_CHANGED,
85 PA_CORE_HOOK_SOURCE_PROPLIST_CHANGED,
86 PA_CORE_HOOK_SOURCE_PORT_CHANGED,
87 PA_CORE_HOOK_SOURCE_FLAGS_CHANGED,
88 PA_CORE_HOOK_SOURCE_VOLUME_CHANGED,
89 PA_CORE_HOOK_SOURCE_MUTE_CHANGED,
90 PA_CORE_HOOK_SOURCE_PORT_LATENCY_OFFSET_CHANGED,
91 PA_CORE_HOOK_SINK_INPUT_NEW,
92 PA_CORE_HOOK_SINK_INPUT_FIXATE,
93 PA_CORE_HOOK_SINK_INPUT_PUT,
94 PA_CORE_HOOK_SINK_INPUT_UNLINK,
95 PA_CORE_HOOK_SINK_INPUT_UNLINK_POST,
96 PA_CORE_HOOK_SINK_INPUT_MOVE_START,
97 PA_CORE_HOOK_SINK_INPUT_MOVE_FINISH,
98 PA_CORE_HOOK_SINK_INPUT_MOVE_FAIL,
99 PA_CORE_HOOK_SINK_INPUT_STATE_CHANGED,
100 PA_CORE_HOOK_SINK_INPUT_PROPLIST_CHANGED,
101 PA_CORE_HOOK_SINK_INPUT_VOLUME_CHANGED,
102 PA_CORE_HOOK_SINK_INPUT_MUTE_CHANGED,
103 PA_CORE_HOOK_SINK_INPUT_SEND_EVENT,
104 PA_CORE_HOOK_SOURCE_OUTPUT_NEW,
105 PA_CORE_HOOK_SOURCE_OUTPUT_FIXATE,
106 PA_CORE_HOOK_SOURCE_OUTPUT_PUT,
107 PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK,
108 PA_CORE_HOOK_SOURCE_OUTPUT_UNLINK_POST,
109 PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_START,
110 PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FINISH,
111 PA_CORE_HOOK_SOURCE_OUTPUT_MOVE_FAIL,
112 PA_CORE_HOOK_SOURCE_OUTPUT_STATE_CHANGED,
113 PA_CORE_HOOK_SOURCE_OUTPUT_PROPLIST_CHANGED,
114 PA_CORE_HOOK_SOURCE_OUTPUT_VOLUME_CHANGED,
115 PA_CORE_HOOK_SOURCE_OUTPUT_MUTE_CHANGED,
116 PA_CORE_HOOK_SOURCE_OUTPUT_SEND_EVENT,
117 PA_CORE_HOOK_CLIENT_NEW,
118 PA_CORE_HOOK_CLIENT_PUT,
119 PA_CORE_HOOK_CLIENT_UNLINK,
120 PA_CORE_HOOK_CLIENT_PROPLIST_CHANGED,
121 PA_CORE_HOOK_CLIENT_SEND_EVENT,
122 PA_CORE_HOOK_CARD_NEW,
123 PA_CORE_HOOK_CARD_CHOOSE_INITIAL_PROFILE,
124 PA_CORE_HOOK_CARD_PUT,
125 PA_CORE_HOOK_CARD_UNLINK,
126 PA_CORE_HOOK_CARD_PREFERRED_PORT_CHANGED,
127 PA_CORE_HOOK_CARD_PROFILE_CHANGED,
128 PA_CORE_HOOK_CARD_PROFILE_ADDED,
129 PA_CORE_HOOK_CARD_PROFILE_AVAILABLE_CHANGED,
130 PA_CORE_HOOK_CARD_SUSPEND_CHANGED,
131 PA_CORE_HOOK_PORT_AVAILABLE_CHANGED,
132 PA_CORE_HOOK_PORT_LATENCY_OFFSET_CHANGED,
133 PA_CORE_HOOK_DEFAULT_SINK_CHANGED,
134 PA_CORE_HOOK_DEFAULT_SOURCE_CHANGED,
135 PA_CORE_HOOK_MODULE_NEW,
136 PA_CORE_HOOK_MODULE_PROPLIST_CHANGED,
137 PA_CORE_HOOK_MODULE_UNLINK,
138 PA_CORE_HOOK_SAMPLE_CACHE_NEW,
139 PA_CORE_HOOK_SAMPLE_CACHE_CHANGED,
140 PA_CORE_HOOK_SAMPLE_CACHE_UNLINK,
144 #ifdef TIZEN_PCM_DUMP
145 #define PA_PCM_DUMP_PATH_PREFIX "/tmp/pcm"
146 #define PA_PCM_DUMP_VCONF_KEY "memory/private/sound/pcm_dump"
149 PA_PCM_DUMP_GST_DECODER_OUT = 0x00000001U,
150 PA_PCM_DUMP_GST_RESAMPLER_IN = 0x00000008U,
151 PA_PCM_DUMP_GST_RESAMPLER_OUT = 0x00000010U,
152 PA_PCM_DUMP_GST_AUDIO_SINK_IN = 0x00000400U,
153 PA_PCM_DUMP_PA_STREAM_WRITE = 0x00000800U,
154 PA_PCM_DUMP_PA_SINK_INPUT = 0x00002000U,
155 PA_PCM_DUMP_PA_SINK = 0x00004000U,
156 PA_PCM_DUMP_PA_SOURCE = 0x00020000U,
157 PA_PCM_DUMP_PA_SOURCE_OUTPUT = 0x00040000U,
158 PA_PCM_DUMP_PA_STREAM_READ = 0x00100000U,
159 PA_PCM_DUMP_GST_AUDIO_SRC_OUT = 0x00200000U,
160 PA_PCM_DUMP_GST_ENCODER_IN = 0x80000000U,
164 PA_PCM_DUMP_OPTION_SEPARATED = 0x0001U,
165 PA_PCM_DUMP_OPTION_MONITOR = 0x0002U,
169 /* The core structure of PulseAudio. Every PulseAudio daemon contains
170 * exactly one of these. It is used for storing kind of global
171 * variables for the daemon. */
176 pa_core_state_t state;
178 /* A random value which may be used to identify this instance of
179 * PulseAudio. Not cryptographically secure in any way. */
182 pa_mainloop_api *mainloop;
184 /* idxset of all kinds of entities */
185 pa_idxset *clients, *cards, *sinks, *sources, *sink_inputs, *source_outputs, *modules, *scache;
187 /* Some hashmaps for all sorts of entities */
188 pa_hashmap *namereg, *shared;
190 /* The default sink/source as configured by the user. If the user hasn't
191 * explicitly configured anything, these are set to NULL. These are strings
192 * instead of sink/source pointers, because that allows us to reference
193 * devices that don't currently exist. That's useful for remembering that
194 * a hotplugged USB sink was previously set as the default sink. */
195 char *configured_default_sink;
196 char *configured_default_source;
198 /* The effective default sink/source. If no sink or source is explicitly
199 * configured as the default, we pick the device that ranks highest
200 * according to the compare_sinks() and compare_sources() functions in
201 * core.c. pa_core_update_default_sink/source() has to be called whenever
202 * anything changes that might change the comparison results. */
203 pa_sink *default_sink;
204 pa_source *default_source;
206 pa_channel_map default_channel_map;
207 pa_sample_spec default_sample_spec;
208 uint32_t alternate_sample_rate;
209 unsigned default_n_fragments, default_fragment_size_msec;
210 unsigned deferred_volume_safety_margin_usec;
211 int deferred_volume_extra_delay_usec;
212 unsigned lfe_crossover_freq;
214 pa_defer_event *module_defer_unload_event;
215 pa_hashmap *modules_pending_unload; /* pa_module -> pa_module (hashmap-as-a-set) */
217 pa_defer_event *subscription_defer_event;
218 PA_LLIST_HEAD(pa_subscription, subscriptions);
219 PA_LLIST_HEAD(pa_subscription_event, subscription_event_queue);
220 pa_subscription_event *subscription_event_last;
222 /* The mempool is used for data we write to, it's readonly for the client. */
225 /* Shared memory size, as specified either by daemon configuration
226 * or PA daemon defaults (~ 64 MiB). */
229 pa_silence_cache silence_cache;
231 pa_time_event *exit_event;
232 pa_time_event *scache_auto_unload_event;
234 int exit_idle_time, scache_idle_time;
237 bool disallow_module_loading:1;
238 bool disallow_exit:1;
239 bool running_as_daemon:1;
240 bool realtime_scheduling:1;
241 bool avoid_resampling:1;
242 bool disable_remixing:1;
243 bool remixing_use_all_sink_channels:1;
244 bool disable_lfe_remixing:1;
245 bool deferred_volume:1;
247 pa_resample_method_t resample_method;
248 int realtime_priority;
250 pa_server_type_t server_type;
251 pa_cpu_info cpu_info;
254 pa_hook hooks[PA_CORE_HOOK_MAX];
255 #ifdef TIZEN_PCM_DUMP
257 uint32_t pcm_dump_option;
259 #ifdef TIZEN_EMPTY_POP
260 unsigned empty_pop_threshold;
264 PA_DECLARE_PUBLIC_CLASS(pa_core);
265 #define PA_CORE(o) pa_core_cast(o)
268 PA_CORE_MESSAGE_UNLOAD_MODULE,
272 pa_core* pa_core_new(pa_mainloop_api *m, bool shared, bool enable_memfd, size_t shm_size);
274 void pa_core_set_configured_default_sink(pa_core *core, const char *sink);
275 void pa_core_set_configured_default_source(pa_core *core, const char *source);
277 /* These should be called whenever something changes that may affect the
278 * default sink or source choice.
280 * If the default source choice happens between two monitor sources, the
281 * monitored sinks are compared, so if the default sink changes, the default
282 * source may change too. However, pa_core_update_default_sink() calls
283 * pa_core_update_default_source() internally, so it's sufficient to only call
284 * pa_core_update_default_sink() when something happens that affects the sink
286 void pa_core_update_default_sink(pa_core *core);
287 void pa_core_update_default_source(pa_core *core);
289 /* Check whether no one is connected to this core */
290 void pa_core_check_idle(pa_core *c);
292 int pa_core_exit(pa_core *c, bool force, int retval);
294 void pa_core_maybe_vacuum(pa_core *c);
296 /* wrapper for c->mainloop->time_*() RT time events */
297 pa_time_event* pa_core_rttime_new(pa_core *c, pa_usec_t usec, pa_time_event_cb_t cb, void *userdata);
298 void pa_core_rttime_restart(pa_core *c, pa_time_event *e, pa_usec_t usec);