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/sample.h>
31 #include <pulse/channelmap.h>
32 #include <pulse/volume.h>
34 #include <pulsecore/core.h>
35 #include <pulsecore/idxset.h>
36 #include <pulsecore/source.h>
37 #include <pulsecore/module.h>
38 #include <pulsecore/refcnt.h>
39 #include <pulsecore/msgobject.h>
40 #include <pulsecore/rtpoll.h>
42 #define PA_MAX_INPUTS_PER_SINK 32
44 typedef enum pa_sink_state
{
52 static inline pa_bool_t
PA_SINK_IS_OPENED(pa_sink_state_t x
) {
53 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
;
56 static inline pa_bool_t
PA_SINK_IS_LINKED(pa_sink_state_t x
) {
57 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
|| x
== PA_SINK_SUSPENDED
;
65 pa_sink_state_t state
;
66 pa_sink_flags_t flags
;
69 char *driver
; /* may be NULL */
70 pa_proplist
*proplist
;
72 pa_module
*module
; /* may be NULL */
74 pa_sample_spec sample_spec
;
75 pa_channel_map channel_map
;
79 pa_source
*monitor_source
;
82 pa_cvolume virtual_volume
;
85 pa_volume_t base_volume
; /* shall be constant */
87 pa_bool_t refresh_volume
:1;
88 pa_bool_t refresh_muted
:1;
90 pa_asyncmsgq
*asyncmsgq
;
95 /* Called when the main loop requests a state change. Called from
96 * main loop context. If returns -1 the state change will be
98 int (*set_state
)(pa_sink
*s
, pa_sink_state_t state
); /* may be NULL */
100 /* Callled when the volume is queried. Called from main loop
101 * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
102 * will be sent to the IO thread instead. If refresh_volume is
103 * FALSE neither this function is called nor a message is sent. */
104 int (*get_volume
)(pa_sink
*s
); /* may be NULL */
106 /* Called when the volume shall be changed. Called from main loop
107 * context. If this is NULL a PA_SINK_MESSAGE_SET_VOLUME message
108 * will be sent to the IO thread instead. */
109 int (*set_volume
)(pa_sink
*s
); /* dito */
111 /* Called when the mute setting is queried. Called from main loop
112 * context. If this is NULL a PA_SINK_MESSAGE_GET_MUTE message
113 * will be sent to the IO thread instead. If refresh_mute is
114 * FALSE neither this function is called nor a message is sent.*/
115 int (*get_mute
)(pa_sink
*s
); /* dito */
117 /* Called when the mute setting shall be changed. Called from main
118 * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
119 * message will be sent to the IO thread instead. */
120 int (*set_mute
)(pa_sink
*s
); /* dito */
122 /* Called when a rewind request is issued. Called from IO thread
124 void (*request_rewind
)(pa_sink
*s
); /* dito */
126 /* Called when a the requested latency is changed. Called from IO
128 void (*update_requested_latency
)(pa_sink
*s
); /* dito */
130 /* Contains copies of the above data so that the real-time worker
131 * thread can work without access locking */
133 pa_sink_state_t state
;
135 pa_cvolume soft_volume
;
136 pa_bool_t soft_muted
:1;
138 pa_bool_t requested_latency_valid
:1;
139 pa_usec_t requested_latency
;
141 /* The number of bytes streams need to keep around as history to
142 * be able to satisfy every DMA buffer rewrite */
145 /* The number of bytes streams need to keep around to satisfy
146 * every DMA write request */
149 /* Maximum of what clients requested to rewind in this cycle */
150 size_t rewind_nbytes
;
151 pa_bool_t rewind_requested
;
153 pa_usec_t min_latency
; /* we won't go below this latency */
154 pa_usec_t max_latency
; /* An upper limit for the latencies */
160 PA_DECLARE_CLASS(pa_sink
);
161 #define PA_SINK(s) (pa_sink_cast(s))
163 typedef enum pa_sink_message
{
164 PA_SINK_MESSAGE_ADD_INPUT
,
165 PA_SINK_MESSAGE_REMOVE_INPUT
,
166 PA_SINK_MESSAGE_GET_VOLUME
,
167 PA_SINK_MESSAGE_SET_VOLUME
,
168 PA_SINK_MESSAGE_GET_MUTE
,
169 PA_SINK_MESSAGE_SET_MUTE
,
170 PA_SINK_MESSAGE_GET_LATENCY
,
171 PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
,
172 PA_SINK_MESSAGE_SET_STATE
,
173 PA_SINK_MESSAGE_START_MOVE
,
174 PA_SINK_MESSAGE_FINISH_MOVE
,
175 PA_SINK_MESSAGE_ATTACH
,
176 PA_SINK_MESSAGE_DETACH
,
177 PA_SINK_MESSAGE_SET_LATENCY_RANGE
,
178 PA_SINK_MESSAGE_GET_LATENCY_RANGE
,
179 PA_SINK_MESSAGE_GET_MAX_REWIND
,
180 PA_SINK_MESSAGE_GET_MAX_REQUEST
,
184 typedef struct pa_sink_new_data
{
186 pa_proplist
*proplist
;
191 pa_sample_spec sample_spec
;
192 pa_channel_map channel_map
;
196 pa_bool_t sample_spec_is_set
:1;
197 pa_bool_t channel_map_is_set
:1;
198 pa_bool_t volume_is_set
:1;
199 pa_bool_t muted_is_set
:1;
201 pa_bool_t namereg_fail
:1;
204 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
);
205 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
);
206 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
);
207 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
);
208 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
);
209 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
);
210 void pa_sink_new_data_done(pa_sink_new_data
*data
);
212 typedef struct pa_sink_set_volume_data
{
215 pa_cvolume virtual_volume
;
216 } pa_sink_set_volume_data
;
218 /* To be called exclusively by the sink driver, from main context */
220 pa_sink
* pa_sink_new(
222 pa_sink_new_data
*data
,
223 pa_sink_flags_t flags
);
225 void pa_sink_put(pa_sink
*s
);
226 void pa_sink_unlink(pa_sink
* s
);
228 void pa_sink_set_description(pa_sink
*s
, const char *description
);
229 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
);
230 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
);
232 void pa_sink_set_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
234 void pa_sink_detach(pa_sink
*s
);
235 void pa_sink_attach(pa_sink
*s
);
237 /* May be called by everyone, from main context */
239 /* The returned value is supposed to be in the time domain of the sound card! */
240 pa_usec_t
pa_sink_get_latency(pa_sink
*s
);
241 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
);
242 void pa_sink_get_latency_range(pa_sink
*s
, pa_usec_t
*min_latency
, pa_usec_t
*max_latency
);
244 size_t pa_sink_get_max_rewind(pa_sink
*s
);
245 size_t pa_sink_get_max_request(pa_sink
*s
);
247 int pa_sink_update_status(pa_sink
*s
);
248 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
);
249 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
);
251 void pa_sink_set_volume(pa_sink
*sink
, const pa_cvolume
*volume
);
252 void pa_sink_set_soft_volume(pa_sink
*s
, const pa_cvolume
*volume
);
253 const pa_cvolume
*pa_sink_get_volume(pa_sink
*sink
, pa_bool_t force_refresh
);
254 void pa_sink_set_mute(pa_sink
*sink
, pa_bool_t mute
);
255 pa_bool_t
pa_sink_get_mute(pa_sink
*sink
, pa_bool_t force_refres
);
257 pa_bool_t
pa_sink_update_proplist(pa_sink
*s
, pa_update_mode_t mode
, pa_proplist
*p
);
259 unsigned pa_sink_linked_by(pa_sink
*s
); /* Number of connected streams */
260 unsigned pa_sink_used_by(pa_sink
*s
); /* Number of connected streams which are not corked */
261 unsigned pa_sink_check_suspend(pa_sink
*s
); /* Returns how many streams are active that don't allow suspensions */
262 #define pa_sink_get_state(s) ((s)->state)
264 /* To be called exclusively by the sink driver, from IO context */
266 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
267 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
268 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
);
269 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
);
271 void pa_sink_process_rewind(pa_sink
*s
, size_t nbytes
);
273 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
275 void pa_sink_attach_within_thread(pa_sink
*s
);
276 void pa_sink_detach_within_thread(pa_sink
*s
);
278 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
);
280 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
);
281 void pa_sink_set_max_request(pa_sink
*s
, size_t max_request
);
283 void pa_sink_update_latency_range(pa_sink
*s
, pa_usec_t min_latency
, pa_usec_t max_latency
);
285 /* To be called exclusively by sink input drivers, from IO context */
287 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
);
289 void pa_sink_invalidate_requested_latency(pa_sink
*s
);