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>
44 #define PA_MAX_INPUTS_PER_SINK 32
46 /* Returns true if sink is linked: registered and accessible from client side. */
47 static inline pa_bool_t
PA_SINK_IS_LINKED(pa_sink_state_t x
) {
48 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
|| x
== PA_SINK_SUSPENDED
;
56 pa_sink_state_t state
;
57 pa_sink_flags_t flags
;
60 char *driver
; /* may be NULL */
61 pa_proplist
*proplist
;
63 pa_module
*module
; /* may be NULL */
64 pa_card
*card
; /* may be NULL */
66 pa_sample_spec sample_spec
;
67 pa_channel_map channel_map
;
71 pa_source
*monitor_source
;
74 pa_cvolume virtual_volume
;
77 pa_volume_t base_volume
; /* shall be constant */
79 pa_bool_t refresh_volume
:1;
80 pa_bool_t refresh_muted
:1;
82 pa_asyncmsgq
*asyncmsgq
;
87 /* Called when the main loop requests a state change. Called from
88 * main loop context. If returns -1 the state change will be
90 int (*set_state
)(pa_sink
*s
, pa_sink_state_t state
); /* may be NULL */
92 /* Callled when the volume is queried. Called from main loop
93 * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
94 * will be sent to the IO thread instead. If refresh_volume is
95 * FALSE neither this function is called nor a message is sent. */
96 int (*get_volume
)(pa_sink
*s
); /* may be NULL */
98 /* Called when the volume shall be changed. Called from main loop
99 * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
100 * will be sent to the IO thread instead. */
101 int (*set_volume
)(pa_sink
*s
); /* dito */
103 /* Called when the mute setting is queried. Called from main loop
104 * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
105 * will be sent to the IO thread instead. If refresh_mute is
106 * FALSE neither this function is called nor a message is sent.*/
107 int (*get_mute
)(pa_sink
*s
); /* dito */
109 /* Called when the mute setting shall be changed. Called from main
110 * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
111 * message will be sent to the IO thread instead. */
112 int (*set_mute
)(pa_sink
*s
); /* dito */
114 /* Called when a rewind request is issued. Called from IO thread
116 void (*request_rewind
)(pa_sink
*s
); /* dito */
118 /* Called when a the requested latency is changed. Called from IO
120 void (*update_requested_latency
)(pa_sink
*s
); /* dito */
122 /* Contains copies of the above data so that the real-time worker
123 * thread can work without access locking */
125 pa_sink_state_t state
;
127 pa_cvolume soft_volume
;
128 pa_bool_t soft_muted
:1;
130 pa_bool_t requested_latency_valid
:1;
131 pa_usec_t requested_latency
;
133 /* The number of bytes streams need to keep around as history to
134 * be able to satisfy every DMA buffer rewrite */
137 /* The number of bytes streams need to keep around to satisfy
138 * every DMA write request */
141 /* Maximum of what clients requested to rewind in this cycle */
142 size_t rewind_nbytes
;
143 pa_bool_t rewind_requested
;
145 pa_usec_t min_latency
; /* we won't go below this latency */
146 pa_usec_t max_latency
; /* An upper limit for the latencies */
152 PA_DECLARE_CLASS(pa_sink
);
153 #define PA_SINK(s) (pa_sink_cast(s))
155 typedef enum pa_sink_message
{
156 PA_SINK_MESSAGE_ADD_INPUT
,
157 PA_SINK_MESSAGE_REMOVE_INPUT
,
158 PA_SINK_MESSAGE_GET_VOLUME
,
159 PA_SINK_MESSAGE_SET_VOLUME
,
160 PA_SINK_MESSAGE_GET_MUTE
,
161 PA_SINK_MESSAGE_SET_MUTE
,
162 PA_SINK_MESSAGE_GET_LATENCY
,
163 PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
,
164 PA_SINK_MESSAGE_SET_STATE
,
165 PA_SINK_MESSAGE_START_MOVE
,
166 PA_SINK_MESSAGE_FINISH_MOVE
,
167 PA_SINK_MESSAGE_ATTACH
,
168 PA_SINK_MESSAGE_DETACH
,
169 PA_SINK_MESSAGE_SET_LATENCY_RANGE
,
170 PA_SINK_MESSAGE_GET_LATENCY_RANGE
,
171 PA_SINK_MESSAGE_GET_MAX_REWIND
,
172 PA_SINK_MESSAGE_GET_MAX_REQUEST
,
176 typedef struct pa_sink_new_data
{
178 pa_proplist
*proplist
;
184 pa_sample_spec sample_spec
;
185 pa_channel_map channel_map
;
189 pa_bool_t sample_spec_is_set
:1;
190 pa_bool_t channel_map_is_set
:1;
191 pa_bool_t volume_is_set
:1;
192 pa_bool_t muted_is_set
:1;
194 pa_bool_t namereg_fail
:1;
197 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
);
198 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
);
199 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
);
200 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
);
201 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
);
202 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
);
203 void pa_sink_new_data_done(pa_sink_new_data
*data
);
205 typedef struct pa_sink_set_volume_data
{
208 pa_cvolume virtual_volume
;
209 } pa_sink_set_volume_data
;
211 /* To be called exclusively by the sink driver, from main context */
213 pa_sink
* pa_sink_new(
215 pa_sink_new_data
*data
,
216 pa_sink_flags_t flags
);
218 void pa_sink_put(pa_sink
*s
);
219 void pa_sink_unlink(pa_sink
* s
);
221 void pa_sink_set_description(pa_sink
*s
, const char *description
);
222 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
);
223 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
);
225 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
227 void pa_sink_detach(pa_sink
*s
);
228 void pa_sink_attach(pa_sink
*s
);
230 /* May be called by everyone, from main context */
232 /* The returned value is supposed to be in the time domain of the sound card! */
233 pa_usec_t
pa_sink_get_latency(pa_sink
*s
);
234 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
);
235 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
);
237 size_t pa_sink_get_max_rewind(pa_sink
*s
);
238 size_t pa_sink_get_max_request(pa_sink
*s
);
240 int pa_sink_update_status(pa_sink
*s
);
241 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
);
242 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
);
244 void pa_sink_set_volume(pa_sink
*sink
, const pa_cvolume
*volume
);
245 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
);
246 const pa_cvolume
*pa_sink_get_volume(pa_sink
*sink
, pa_bool_t force_refresh
);
247 void pa_sink_set_mute(pa_sink
*sink
, pa_bool_t mute
);
248 pa_bool_t
pa_sink_get_mute(pa_sink
*sink
, pa_bool_t force_refres
);
250 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
);
252 unsigned pa_sink_linked_by(pa_sink
*s
); /* Number of connected streams */
253 unsigned pa_sink_used_by(pa_sink
*s
); /* Number of connected streams which are not corked */
254 unsigned pa_sink_check_suspend(pa_sink
*s
); /* Returns how many streams are active that don't allow suspensions */
255 #define pa_sink_get_state(s) ((s)->state)
257 /* To be called exclusively by the sink driver, from IO context */
259 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
260 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
261 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
);
262 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
);
264 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
);
266 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
268 void pa_sink_attach_within_thread(pa_sink
*s
);
269 void pa_sink_detach_within_thread(pa_sink
*s
);
271 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
);
273 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
);
274 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
);
276 void pa_sink_update_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
278 /* To be called exclusively by sink input drivers, from IO context */
280 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
);
282 void pa_sink_invalidate_requested_latency(pa_sink
*s
);