1 #ifndef foopulsesinkhfoo
2 #define foopulsesinkhfoo
7 This file is part of PulseAudio.
9 Copyright 2004-2006 Lennart Poettering
10 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
12 PulseAudio is free software; you can redistribute it and/or modify
13 it under the terms of the GNU Lesser General Public License as published
14 by the Free Software Foundation; either version 2 of the License,
15 or (at your option) any later version.
17 PulseAudio is distributed in the hope that it will be useful, but
18 WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU Lesser General Public License
23 along with PulseAudio; if not, write to the Free Software
24 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
28 typedef struct pa_sink pa_sink
;
32 #include <pulse/sample.h>
33 #include <pulse/channelmap.h>
34 #include <pulse/volume.h>
36 #include <pulsecore/core-def.h>
37 #include <pulsecore/core.h>
38 #include <pulsecore/idxset.h>
39 #include <pulsecore/source.h>
40 #include <pulsecore/module.h>
41 #include <pulsecore/refcnt.h>
42 #include <pulsecore/msgobject.h>
43 #include <pulsecore/rtpoll.h>
45 #define PA_MAX_INPUTS_PER_SINK 32
47 typedef enum pa_sink_state
{
55 static inline pa_bool_t
PA_SINK_OPENED(pa_sink_state_t x
) {
56 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
;
59 static inline pa_bool_t
PA_SINK_LINKED(pa_sink_state_t x
) {
60 return x
== PA_SINK_RUNNING
|| x
== PA_SINK_IDLE
|| x
== PA_SINK_SUSPENDED
;
68 pa_sink_state_t state
;
69 pa_sink_flags_t flags
;
72 char *driver
; /* may be NULL */
73 pa_proplist
*proplist
;
75 pa_module
*module
; /* may be NULL */
77 pa_sample_spec sample_spec
;
78 pa_channel_map channel_map
;
82 pa_source
*monitor_source
;
86 pa_bool_t refresh_volume
;
87 pa_bool_t refresh_mute
;
89 pa_asyncmsgq
*asyncmsgq
;
94 pa_usec_t min_latency
; /* we won't go below this latency */
95 pa_usec_t max_latency
; /* An upper limit for the latencies */
97 int (*set_state
)(pa_sink
*s
, pa_sink_state_t state
); /* may be NULL */
98 int (*set_volume
)(pa_sink
*s
); /* dito */
99 int (*get_volume
)(pa_sink
*s
); /* dito */
100 int (*get_mute
)(pa_sink
*s
); /* dito */
101 int (*set_mute
)(pa_sink
*s
); /* dito */
102 pa_usec_t (*get_latency
)(pa_sink
*s
); /* dito */
103 void (*request_rewind
)(pa_sink
*s
); /* dito */
104 void (*update_requested_latency
)(pa_sink
*s
); /* dito */
106 /* Contains copies of the above data so that the real-time worker
107 * thread can work without access locking */
109 pa_sink_state_t state
;
111 pa_cvolume soft_volume
;
112 pa_bool_t soft_muted
;
114 pa_bool_t requested_latency_valid
;
115 size_t requested_latency
;
117 /* The number of bytes we need keep around to be able to satisfy
118 * every DMA buffer rewrite */
121 /* Maximum of what clients requested to rewind in this cycle */
122 size_t rewind_nbytes
;
128 PA_DECLARE_CLASS(pa_sink
);
129 #define PA_SINK(s) (pa_sink_cast(s))
131 typedef enum pa_sink_message
{
132 PA_SINK_MESSAGE_ADD_INPUT
,
133 PA_SINK_MESSAGE_REMOVE_INPUT
,
134 PA_SINK_MESSAGE_GET_VOLUME
,
135 PA_SINK_MESSAGE_SET_VOLUME
,
136 PA_SINK_MESSAGE_GET_MUTE
,
137 PA_SINK_MESSAGE_SET_MUTE
,
138 PA_SINK_MESSAGE_GET_LATENCY
,
139 PA_SINK_MESSAGE_GET_REQUESTED_LATENCY
,
140 PA_SINK_MESSAGE_SET_STATE
,
141 PA_SINK_MESSAGE_PING
,
142 PA_SINK_MESSAGE_REMOVE_INPUT_AND_BUFFER
,
143 PA_SINK_MESSAGE_ATTACH
,
144 PA_SINK_MESSAGE_DETACH
,
148 typedef struct pa_sink_new_data
{
150 pa_bool_t namereg_fail
;
151 pa_proplist
*proplist
;
156 pa_sample_spec sample_spec
;
157 pa_bool_t sample_spec_is_set
;
158 pa_channel_map channel_map
;
159 pa_bool_t channel_map_is_set
;
162 pa_bool_t volume_is_set
;
164 pa_bool_t muted_is_set
;
167 pa_sink_new_data
* pa_sink_new_data_init(pa_sink_new_data
*data
);
168 void pa_sink_new_data_set_name(pa_sink_new_data
*data
, const char *name
);
169 void pa_sink_new_data_set_sample_spec(pa_sink_new_data
*data
, const pa_sample_spec
*spec
);
170 void pa_sink_new_data_set_channel_map(pa_sink_new_data
*data
, const pa_channel_map
*map
);
171 void pa_sink_new_data_set_volume(pa_sink_new_data
*data
, const pa_cvolume
*volume
);
172 void pa_sink_new_data_set_muted(pa_sink_new_data
*data
, pa_bool_t mute
);
173 void pa_sink_new_data_done(pa_sink_new_data
*data
);
175 /* To be called exclusively by the sink driver, from main context */
177 pa_sink
* pa_sink_new(
179 pa_sink_new_data
*data
,
180 pa_sink_flags_t flags
);
182 void pa_sink_put(pa_sink
*s
);
183 void pa_sink_unlink(pa_sink
* s
);
185 void pa_sink_set_description(pa_sink
*s
, const char *description
);
186 void pa_sink_set_asyncmsgq(pa_sink
*s
, pa_asyncmsgq
*q
);
187 void pa_sink_set_rtpoll(pa_sink
*s
, pa_rtpoll
*p
);
189 void pa_sink_detach(pa_sink
*s
);
190 void pa_sink_attach(pa_sink
*s
);
192 /* May be called by everyone, from main context */
194 /* The returned value is supposed to be in the time domain of the sound card! */
195 pa_usec_t
pa_sink_get_latency(pa_sink
*s
);
196 pa_usec_t
pa_sink_get_requested_latency(pa_sink
*s
);
198 int pa_sink_update_status(pa_sink
*s
);
199 int pa_sink_suspend(pa_sink
*s
, pa_bool_t suspend
);
200 int pa_sink_suspend_all(pa_core
*c
, pa_bool_t suspend
);
202 void pa_sink_rewind(pa_sink
*s
, size_t length
);
204 /* Sends a ping message to the sink thread, to make it wake up and
205 * check for data to process even if there is no real message is
207 void pa_sink_ping(pa_sink
*s
);
209 void pa_sink_set_volume(pa_sink
*sink
, const pa_cvolume
*volume
);
210 const pa_cvolume
*pa_sink_get_volume(pa_sink
*sink
);
211 void pa_sink_set_mute(pa_sink
*sink
, pa_bool_t mute
);
212 pa_bool_t
pa_sink_get_mute(pa_sink
*sink
);
214 unsigned pa_sink_linked_by(pa_sink
*s
); /* Number of connected streams */
215 unsigned pa_sink_used_by(pa_sink
*s
); /* Number of connected streams which are not corked */
216 #define pa_sink_get_state(s) ((s)->state)
218 /* To be called exclusively by the sink driver, from IO context */
220 void pa_sink_process_rewind(pa_sink
*s
);
222 void pa_sink_render(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
223 void pa_sink_render_full(pa_sink
*s
, size_t length
, pa_memchunk
*result
);
224 void pa_sink_render_into(pa_sink
*s
, pa_memchunk
*target
);
225 void pa_sink_render_into_full(pa_sink
*s
, pa_memchunk
*target
);
226 void pa_sink_skip(pa_sink
*s
, size_t length
);
228 int pa_sink_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
230 void pa_sink_attach_within_thread(pa_sink
*s
);
231 void pa_sink_detach_within_thread(pa_sink
*s
);
233 pa_usec_t
pa_sink_get_requested_latency_within_thread(pa_sink
*s
);
235 void pa_sink_set_max_rewind(pa_sink
*s
, size_t max_rewind
);
237 /* To be called exclusively by sink input drivers, from IO context */
239 void pa_sink_request_rewind(pa_sink
*s
, size_t nbytes
);
241 void pa_sink_invalidate_requested_latency(pa_sink
*s
);