1 #ifndef foopulsesinkhfoo
2 #define foopulsesinkhfoo
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 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_sink pa_sink
;
30 #include <pulse/def.h>
31 #include <pulse/sample.h>
32 #include <pulse/channelmap.h>
33 #include <pulse/volume.h>
35 #include <pulsecore/core.h>
36 #include <pulsecore/idxset.h>
37 #include <pulsecore/source.h>
38 #include <pulsecore/module.h>
39 #include <pulsecore/refcnt.h>
40 #include <pulsecore/msgobject.h>
41 #include <pulsecore/rtpoll.h>
42 #include <pulsecore/card.h>
43 #include <pulsecore/queue.h>
45 #define PA_MAX_INPUTS_PER_SINK 32
47 /* Returns true if sink is linked: registered and accessible from client side. */
48 static inline pa_bool_t
PA_SINK_IS_LINKED(pa_sink_state_t x
) {
49 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
|| x
== PA_SINK_SUSPENDED
;
57 pa_sink_state_t state
;
58 pa_sink_flags_t flags
;
61 char *driver
; /* may be NULL */
62 pa_proplist
*proplist
;
64 pa_module
*module
; /* may be NULL */
65 pa_card
*card
; /* may be NULL */
67 pa_sample_spec sample_spec
;
68 pa_channel_map channel_map
;
72 pa_source
*monitor_source
;
74 pa_volume_t base_volume
; /* shall be constant */
75 unsigned n_volume_steps
; /* shall be constant */
77 pa_cvolume virtual_volume
, soft_volume
;
80 pa_bool_t refresh_volume
:1;
81 pa_bool_t refresh_muted
:1;
83 pa_asyncmsgq
*asyncmsgq
;
88 /* Called when the main loop requests a state change. Called from
89 * main loop context. If returns -1 the state change will be
91 int (*set_state
)(pa_sink
*s
, pa_sink_state_t state
); /* may be NULL */
93 /* Callled when the volume is queried. Called from main loop
94 * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
95 * will be sent to the IO thread instead. If refresh_volume is
96 * FALSE neither this function is called nor a message is sent. */
97 void (*get_volume
)(pa_sink
*s
); /* may be NULL */
99 /* Called when the volume shall be changed. Called from main loop
100 * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
101 * will be sent to the IO thread instead. */
102 void (*set_volume
)(pa_sink
*s
); /* dito */
104 /* Called when the mute setting is queried. Called from main loop
105 * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
106 * will be sent to the IO thread instead. If refresh_mute is
107 * FALSE neither this function is called nor a message is sent.*/
108 void (*get_mute
)(pa_sink
*s
); /* dito */
110 /* Called when the mute setting shall be changed. Called from main
111 * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
112 * message will be sent to the IO thread instead. */
113 void (*set_mute
)(pa_sink
*s
); /* dito */
115 /* Called when a rewind request is issued. Called from IO thread
117 void (*request_rewind
)(pa_sink
*s
); /* dito */
119 /* Called when a the requested latency is changed. Called from IO
121 void (*update_requested_latency
)(pa_sink
*s
); /* dito */
123 /* Contains copies of the above data so that the real-time worker
124 * thread can work without access locking */
126 pa_sink_state_t state
;
129 pa_cvolume soft_volume
;
130 pa_bool_t soft_muted
:1;
132 pa_bool_t requested_latency_valid
:1;
133 pa_usec_t requested_latency
;
135 /* The number of bytes streams need to keep around as history to
136 * be able to satisfy every DMA buffer rewrite */
139 /* The number of bytes streams need to keep around to satisfy
140 * every DMA write request */
143 /* Maximum of what clients requested to rewind in this cycle */
144 size_t rewind_nbytes
;
145 pa_bool_t rewind_requested
;
147 pa_usec_t min_latency
; /* we won't go below this latency */
148 pa_usec_t max_latency
; /* An upper limit for the latencies */
154 PA_DECLARE_CLASS(pa_sink
);
155 #define PA_SINK(s) (pa_sink_cast(s))
157 typedef enum pa_sink_message
{
158 PA_SINK_MESSAGE_ADD_INPUT
,
159 PA_SINK_MESSAGE_REMOVE_INPUT
,
160 PA_SINK_MESSAGE_GET_VOLUME
,
161 PA_SINK_MESSAGE_SET_VOLUME
,
162 PA_SINK_MESSAGE_GET_MUTE
,
163 PA_SINK_MESSAGE_SET_MUTE
,
164 PA_SINK_MESSAGE_GET_LATENCY
,
165 PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
,
166 PA_SINK_MESSAGE_SET_STATE
,
167 PA_SINK_MESSAGE_START_MOVE
,
168 PA_SINK_MESSAGE_FINISH_MOVE
,
169 PA_SINK_MESSAGE_ATTACH
,
170 PA_SINK_MESSAGE_DETACH
,
171 PA_SINK_MESSAGE_SET_LATENCY_RANGE
,
172 PA_SINK_MESSAGE_GET_LATENCY_RANGE
,
173 PA_SINK_MESSAGE_GET_MAX_REWIND
,
174 PA_SINK_MESSAGE_GET_MAX_REQUEST
,
178 typedef struct pa_sink_new_data
{
180 pa_proplist
*proplist
;
186 pa_sample_spec sample_spec
;
187 pa_channel_map channel_map
;
191 pa_bool_t sample_spec_is_set
:1;
192 pa_bool_t channel_map_is_set
:1;
193 pa_bool_t volume_is_set
:1;
194 pa_bool_t muted_is_set
:1;
196 pa_bool_t namereg_fail
:1;
199 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
);
200 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
);
201 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
);
202 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
);
203 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
);
204 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
);
205 void pa_sink_new_data_done(pa_sink_new_data
*data
);
207 /*** To be called exclusively by the sink driver, from main context */
209 pa_sink
* pa_sink_new(
211 pa_sink_new_data
*data
,
212 pa_sink_flags_t flags
);
214 void pa_sink_put(pa_sink
*s
);
215 void pa_sink_unlink(pa_sink
* s
);
217 void pa_sink_set_description(pa_sink
*s
, const char *description
);
218 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
);
219 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
);
221 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
223 void pa_sink_detach(pa_sink
*s
);
224 void pa_sink_attach(pa_sink
*s
);
226 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
);
228 pa_bool_t
pa_device_init_description(pa_proplist
*p
);
229 pa_bool_t
pa_device_init_icon(pa_proplist
*p
, pa_bool_t is_sink
);
231 /**** May be called by everyone, from main context */
233 /* The returned value is supposed to be in the time domain of the sound card! */
234 pa_usec_t
pa_sink_get_latency(pa_sink
*s
);
235 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
);
236 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
);
238 size_t pa_sink_get_max_rewind(pa_sink
*s
);
239 size_t pa_sink_get_max_request(pa_sink
*s
);
241 int pa_sink_update_status(pa_sink
*s
);
242 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
);
243 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
);
245 void pa_sink_update_flat_volume(pa_sink
*s
, pa_cvolume
*new_volume
);
246 void pa_sink_propagate_flat_volume(pa_sink
*s
, const pa_cvolume
*old_volume
);
248 void pa_sink_set_volume(pa_sink
*sink
, const pa_cvolume
*volume
, pa_bool_t propagate
, pa_bool_t sendmsg
);
249 const pa_cvolume
*pa_sink_get_volume(pa_sink
*sink
, pa_bool_t force_refresh
);
250 void pa_sink_set_mute(pa_sink
*sink
, pa_bool_t mute
);
251 pa_bool_t
pa_sink_get_mute(pa_sink
*sink
, pa_bool_t force_refresh
);
253 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
);
255 unsigned pa_sink_linked_by(pa_sink
*s
); /* Number of connected streams */
256 unsigned pa_sink_used_by(pa_sink
*s
); /* Number of connected streams which are not corked */
257 unsigned pa_sink_check_suspend(pa_sink
*s
); /* Returns how many streams are active that don't allow suspensions */
258 #define pa_sink_get_state(s) ((s)->state)
260 /* Moves all inputs away, and stores them in pa_queue */
261 pa_queue
*pa_sink_move_all_start(pa_sink
*s
);
262 void pa_sink_move_all_finish(pa_sink
*s
, pa_queue
*q
, pa_bool_t save
);
263 void pa_sink_move_all_fail(pa_queue
*q
);
265 /*** To be called exclusively by the sink driver, from IO context */
267 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
268 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
269 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
);
270 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
);
272 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
);
274 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
276 void pa_sink_attach_within_thread(pa_sink
*s
);
277 void pa_sink_detach_within_thread(pa_sink
*s
);
279 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
);
281 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
);
282 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
);
284 void pa_sink_update_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
286 /*** To be called exclusively by sink input drivers, from IO context */
288 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
);
290 void pa_sink_invalidate_requested_latency(pa_sink
*s
);