1 #ifndef foopulsesourcehfoo
2 #define foopulsesourcehfoo
5 This file is part of PulseAudio.
7 Copyright 2004-2006 Lennart Poettering
8 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
10 PulseAudio is free software; you can redistribute it and/or modify
11 it under the terms of the GNU Lesser General Public License as published
12 by the Free Software Foundation; either version 2.1 of the License,
13 or (at your option) any later version.
15 PulseAudio is distributed in the hope that it will be useful, but
16 WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 General Public License for more details.
20 You should have received a copy of the GNU Lesser General Public License
21 along with PulseAudio; if not, write to the Free Software
22 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
26 typedef struct pa_source pa_source
;
27 typedef struct pa_source_volume_change pa_source_volume_change
;
31 #include <pulse/def.h>
32 #include <pulse/format.h>
33 #include <pulse/sample.h>
34 #include <pulse/channelmap.h>
35 #include <pulse/volume.h>
37 #include <pulsecore/core.h>
38 #include <pulsecore/idxset.h>
39 #include <pulsecore/memchunk.h>
40 #include <pulsecore/sink.h>
41 #include <pulsecore/module.h>
42 #include <pulsecore/asyncmsgq.h>
43 #include <pulsecore/msgobject.h>
44 #include <pulsecore/rtpoll.h>
45 #include <pulsecore/card.h>
46 #include <pulsecore/device-port.h>
47 #include <pulsecore/queue.h>
48 #include <pulsecore/thread-mq.h>
49 #include <pulsecore/source-output.h>
51 #define PA_MAX_OUTPUTS_PER_SOURCE 32
53 /* Returns true if source is linked: registered and accessible from client side. */
54 static inline bool PA_SOURCE_IS_LINKED(pa_source_state_t x
) {
55 return x
== PA_SOURCE_RUNNING
|| x
== PA_SOURCE_IDLE
|| x
== PA_SOURCE_SUSPENDED
;
58 /* A generic definition for void callback functions */
59 typedef void(*pa_source_cb_t
)(pa_source
*s
);
67 pa_source_state_t state
;
68 pa_source_flags_t flags
;
69 pa_suspend_cause_t suspend_cause
;
72 char *driver
; /* may be NULL */
73 pa_proplist
*proplist
;
75 pa_module
*module
; /* may be NULL */
76 pa_card
*card
; /* may be NULL */
78 pa_sample_spec sample_spec
;
79 pa_channel_map channel_map
;
80 uint32_t default_sample_rate
;
81 uint32_t alternate_sample_rate
;
85 pa_sink
*monitor_of
; /* may be NULL */
86 pa_source_output
*output_from_master
; /* non-NULL only for filter sources */
88 pa_volume_t base_volume
; /* shall be constant */
89 unsigned n_volume_steps
; /* shall be constant */
91 /* Also see http://pulseaudio.org/wiki/InternalVolumes */
92 pa_cvolume reference_volume
; /* The volume exported and taken as reference base for relative source output volumes */
93 pa_cvolume real_volume
; /* The volume that the hardware is configured to */
94 pa_cvolume soft_volume
; /* The internal software volume we apply to all PCM data while it passes through */
98 bool refresh_volume
:1;
104 /* Saved volume state while we're in passthrough mode */
105 pa_cvolume saved_volume
;
106 bool saved_save_volume
:1;
108 pa_asyncmsgq
*asyncmsgq
;
113 pa_device_port
*active_port
;
114 pa_atomic_t mixer_dirty
;
116 /* The latency offset is inherited from the currently active port */
117 int64_t latency_offset
;
121 /* Called when the main loop requests a state change. Called from
122 * main loop context. If returns -1 the state change will be
124 int (*set_state
)(pa_source
*source
, pa_source_state_t state
); /* may be NULL */
126 /* Called when the volume is queried. Called from main loop
127 * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
128 * will be sent to the IO thread instead. If refresh_volume is
129 * false neither this function is called nor a message is sent.
131 * You must use the function pa_source_set_get_volume_callback() to
132 * set this callback. */
133 pa_source_cb_t get_volume
; /* may be NULL */
135 /* Called when the volume shall be changed. Called from main loop
136 * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
137 * will be sent to the IO thread instead.
139 * You must use the function pa_source_set_set_volume_callback() to
140 * set this callback. */
141 pa_source_cb_t set_volume
; /* may be NULL */
143 /* Source drivers that set PA_SOURCE_DEFERRED_VOLUME must provide this
144 * callback. This callback is not used with source that do not set
145 * PA_SOURCE_DEFERRED_VOLUME. This is called from the IO thread when a
146 * pending hardware volume change has to be written to the
147 * hardware. The requested volume is passed to the callback
148 * implementation in s->thread_info.current_hw_volume.
150 * The call is done inside pa_source_volume_change_apply(), which is
151 * not called automatically - it is the driver's responsibility to
152 * schedule that function to be called at the right times in the
155 * You must use the function pa_source_set_write_volume_callback() to
156 * set this callback. */
157 pa_source_cb_t write_volume
; /* may be NULL */
159 /* Called when the mute setting is queried. Called from main loop
160 * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
161 * will be sent to the IO thread instead. If refresh_mute is
162 * false neither this function is called nor a message is sent.
164 * You must use the function pa_source_set_get_mute_callback() to
165 * set this callback. */
166 pa_source_cb_t get_mute
; /* may be NULL */
168 /* Called when the mute setting shall be changed. Called from main
169 * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
170 * message will be sent to the IO thread instead.
172 * You must use the function pa_source_set_set_mute_callback() to
173 * set this callback. */
174 pa_source_cb_t set_mute
; /* may be NULL */
176 /* Called when a the requested latency is changed. Called from IO
178 pa_source_cb_t update_requested_latency
; /* may be NULL */
180 /* Called whenever the port shall be changed. Called from IO
181 * thread if deferred volumes are enabled, and main thread otherwise. */
182 int (*set_port
)(pa_source
*s
, pa_device_port
*port
); /*ditto */
184 /* Called to get the list of formats supported by the source, sorted
185 * in descending order of preference. */
186 pa_idxset
* (*get_formats
)(pa_source
*s
); /* ditto */
188 /* Called whenever the sampling frequency shall be changed. Called from
190 int (*update_rate
)(pa_source
*s
, uint32_t rate
);
192 /* Contains copies of the above data so that the real-time worker
193 * thread can work without access locking */
195 pa_source_state_t state
;
200 pa_cvolume soft_volume
;
203 bool requested_latency_valid
:1;
204 pa_usec_t requested_latency
;
206 /* Then number of bytes this source will be rewound for at
207 * max. (Only used on monitor sources) */
210 pa_usec_t min_latency
; /* we won't go below this latency */
211 pa_usec_t max_latency
; /* An upper limit for the latencies */
213 pa_usec_t fixed_latency
; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
215 /* This latency offset is a direct copy from s->latency_offset */
216 int64_t latency_offset
;
218 /* Delayed volume change events are queued here. The events
219 * are stored in expiration order. The one expiring next is in
220 * the head of the list. */
221 PA_LLIST_HEAD(pa_source_volume_change
, volume_changes
);
222 pa_source_volume_change
*volume_changes_tail
;
223 /* This value is updated in pa_source_volume_change_apply() and
224 * used only by sources with PA_SOURCE_DEFERRED_VOLUME. */
225 pa_cvolume current_hw_volume
;
227 /* The amount of usec volume up events are delayed and volume
228 * down events are made earlier. */
229 uint32_t volume_change_safety_margin
;
230 /* Usec delay added to all volume change events, may be negative. */
231 int32_t volume_change_extra_delay
;
237 PA_DECLARE_PUBLIC_CLASS(pa_source
);
238 #define PA_SOURCE(s) pa_source_cast(s)
240 typedef enum pa_source_message
{
241 PA_SOURCE_MESSAGE_ADD_OUTPUT
,
242 PA_SOURCE_MESSAGE_REMOVE_OUTPUT
,
243 PA_SOURCE_MESSAGE_GET_VOLUME
,
244 PA_SOURCE_MESSAGE_SET_SHARED_VOLUME
,
245 PA_SOURCE_MESSAGE_SET_VOLUME_SYNCED
,
246 PA_SOURCE_MESSAGE_SET_VOLUME
,
247 PA_SOURCE_MESSAGE_SYNC_VOLUMES
,
248 PA_SOURCE_MESSAGE_GET_MUTE
,
249 PA_SOURCE_MESSAGE_SET_MUTE
,
250 PA_SOURCE_MESSAGE_GET_LATENCY
,
251 PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY
,
252 PA_SOURCE_MESSAGE_SET_STATE
,
253 PA_SOURCE_MESSAGE_SET_LATENCY_RANGE
,
254 PA_SOURCE_MESSAGE_GET_LATENCY_RANGE
,
255 PA_SOURCE_MESSAGE_SET_FIXED_LATENCY
,
256 PA_SOURCE_MESSAGE_GET_FIXED_LATENCY
,
257 PA_SOURCE_MESSAGE_GET_MAX_REWIND
,
258 PA_SOURCE_MESSAGE_SET_MAX_REWIND
,
259 PA_SOURCE_MESSAGE_SET_PORT
,
260 PA_SOURCE_MESSAGE_UPDATE_VOLUME_AND_MUTE
,
261 PA_SOURCE_MESSAGE_SET_LATENCY_OFFSET
,
262 PA_SOURCE_MESSAGE_MAX
263 } pa_source_message_t
;
265 typedef struct pa_source_new_data
{
266 pa_suspend_cause_t suspend_cause
;
269 pa_proplist
*proplist
;
278 pa_sample_spec sample_spec
;
279 pa_channel_map channel_map
;
280 uint32_t alternate_sample_rate
;
284 bool volume_is_set
:1;
286 bool sample_spec_is_set
:1;
287 bool channel_map_is_set
:1;
288 bool alternate_sample_rate_is_set
:1;
295 } pa_source_new_data
;
297 pa_source_new_data
* pa_source_new_data_init(pa_source_new_data
*data
);
298 void pa_source_new_data_set_name(pa_source_new_data
*data
, const char *name
);
299 void pa_source_new_data_set_sample_spec(pa_source_new_data
*data
, const pa_sample_spec
*spec
);
300 void pa_source_new_data_set_channel_map(pa_source_new_data
*data
, const pa_channel_map
*map
);
301 void pa_source_new_data_set_alternate_sample_rate(pa_source_new_data
*data
, const uint32_t alternate_sample_rate
);
302 void pa_source_new_data_set_volume(pa_source_new_data
*data
, const pa_cvolume
*volume
);
303 void pa_source_new_data_set_muted(pa_source_new_data
*data
, bool mute
);
304 void pa_source_new_data_set_port(pa_source_new_data
*data
, const char *port
);
305 void pa_source_new_data_done(pa_source_new_data
*data
);
307 /*** To be called exclusively by the source driver, from main context */
309 pa_source
* pa_source_new(
311 pa_source_new_data
*data
,
312 pa_source_flags_t flags
);
314 void pa_source_set_get_volume_callback(pa_source
*s
, pa_source_cb_t cb
);
315 void pa_source_set_set_volume_callback(pa_source
*s
, pa_source_cb_t cb
);
316 void pa_source_set_write_volume_callback(pa_source
*s
, pa_source_cb_t cb
);
317 void pa_source_set_get_mute_callback(pa_source
*s
, pa_source_cb_t cb
);
318 void pa_source_set_set_mute_callback(pa_source
*s
, pa_source_cb_t cb
);
319 void pa_source_enable_decibel_volume(pa_source
*s
, bool enable
);
321 void pa_source_put(pa_source
*s
);
322 void pa_source_unlink(pa_source
*s
);
324 void pa_source_set_description(pa_source
*s
, const char *description
);
325 void pa_source_set_asyncmsgq(pa_source
*s
, pa_asyncmsgq
*q
);
326 void pa_source_set_rtpoll(pa_source
*s
, pa_rtpoll
*p
);
328 void pa_source_set_max_rewind(pa_source
*s
, size_t max_rewind
);
329 void pa_source_set_latency_range(pa_source
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
330 void pa_source_set_fixed_latency(pa_source
*s
, pa_usec_t latency
);
332 void pa_source_set_soft_volume(pa_source
*s
, const pa_cvolume
*volume
);
333 void pa_source_volume_changed(pa_source
*s
, const pa_cvolume
*new_volume
);
334 void pa_source_mute_changed(pa_source
*s
, bool new_muted
);
336 int pa_source_sync_suspend(pa_source
*s
);
338 void pa_source_update_flags(pa_source
*s
, pa_source_flags_t mask
, pa_source_flags_t value
);
340 /*** May be called by everyone, from main context */
342 void pa_source_set_latency_offset(pa_source
*s
, int64_t offset
);
344 /* The returned value is supposed to be in the time domain of the sound card! */
345 pa_usec_t
pa_source_get_latency(pa_source
*s
);
346 pa_usec_t
pa_source_get_requested_latency(pa_source
*s
);
347 void pa_source_get_latency_range(pa_source
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
);
348 pa_usec_t
pa_source_get_fixed_latency(pa_source
*s
);
350 size_t pa_source_get_max_rewind(pa_source
*s
);
352 int pa_source_update_status(pa_source
*s
);
353 int pa_source_suspend(pa_source
*s
, bool suspend
, pa_suspend_cause_t cause
);
354 int pa_source_suspend_all(pa_core
*c
, bool suspend
, pa_suspend_cause_t cause
);
356 /* Use this instead of checking s->flags & PA_SOURCE_FLAT_VOLUME directly. */
357 bool pa_source_flat_volume_enabled(pa_source
*s
);
359 /* Get the master source when sharing volumes */
360 pa_source
*pa_source_get_master(pa_source
*s
);
362 /* Is the source in passthrough mode? (that is, is this a monitor source for a sink
363 * that has a passthrough sink input connected to it. */
364 bool pa_source_is_passthrough(pa_source
*s
);
365 /* These should be called when a source enters/leaves passthrough mode */
366 void pa_source_enter_passthrough(pa_source
*s
);
367 void pa_source_leave_passthrough(pa_source
*s
);
369 void pa_source_set_volume(pa_source
*source
, const pa_cvolume
*volume
, bool sendmsg
, bool save
);
370 const pa_cvolume
*pa_source_get_volume(pa_source
*source
, bool force_refresh
);
372 void pa_source_set_mute(pa_source
*source
, bool mute
, bool save
);
373 bool pa_source_get_mute(pa_source
*source
, bool force_refresh
);
375 bool pa_source_update_proplist(pa_source
*s
, pa_update_mode_t mode
, pa_proplist
*p
);
377 int pa_source_set_port(pa_source
*s
, const char *name
, bool save
);
378 void pa_source_set_mixer_dirty(pa_source
*s
, bool is_dirty
);
380 int pa_source_update_rate(pa_source
*s
, uint32_t rate
, bool passthrough
);
382 unsigned pa_source_linked_by(pa_source
*s
); /* Number of connected streams */
383 unsigned pa_source_used_by(pa_source
*s
); /* Number of connected streams that are not corked */
384 unsigned pa_source_check_suspend(pa_source
*s
); /* Returns how many streams are active that don't allow suspensions */
385 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
387 /* Moves all inputs away, and stores them in pa_queue */
388 pa_queue
*pa_source_move_all_start(pa_source
*s
, pa_queue
*q
);
389 void pa_source_move_all_finish(pa_source
*s
, pa_queue
*q
, bool save
);
390 void pa_source_move_all_fail(pa_queue
*q
);
392 /* Returns a copy of the source formats. TODO: Get rid of this function (or at
393 * least get rid of the copying). There's no good reason to copy the formats
394 * every time someone wants to know what formats the source supports. The
395 * formats idxset could be stored directly in the pa_source struct.
396 * https://bugs.freedesktop.org/show_bug.cgi?id=71924 */
397 pa_idxset
* pa_source_get_formats(pa_source
*s
);
399 bool pa_source_check_format(pa_source
*s
, pa_format_info
*f
);
400 pa_idxset
* pa_source_check_formats(pa_source
*s
, pa_idxset
*in_formats
);
402 /*** To be called exclusively by the source driver, from IO context */
404 void pa_source_post(pa_source
*s
, const pa_memchunk
*chunk
);
405 void pa_source_post_direct(pa_source
*s
, pa_source_output
*o
, const pa_memchunk
*chunk
);
406 void pa_source_process_rewind(pa_source
*s
, size_t nbytes
);
408 int pa_source_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t, pa_memchunk
*chunk
);
410 void pa_source_attach_within_thread(pa_source
*s
);
411 void pa_source_detach_within_thread(pa_source
*s
);
413 pa_usec_t
pa_source_get_requested_latency_within_thread(pa_source
*s
);
415 void pa_source_set_max_rewind_within_thread(pa_source
*s
, size_t max_rewind
);
417 void pa_source_set_latency_range_within_thread(pa_source
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
418 void pa_source_set_fixed_latency_within_thread(pa_source
*s
, pa_usec_t latency
);
420 void pa_source_update_volume_and_mute(pa_source
*s
);
422 bool pa_source_volume_change_apply(pa_source
*s
, pa_usec_t
*usec_to_next
);
424 /*** To be called exclusively by source output drivers, from IO context */
426 void pa_source_invalidate_requested_latency(pa_source
*s
, bool dynamic
);
427 pa_usec_t
pa_source_get_latency_within_thread(pa_source
*s
);
429 #define pa_source_assert_io_context(s) \
430 pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))