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.h>
37 #include <pulsecore/idxset.h>
38 #include <pulsecore/source.h>
39 #include <pulsecore/module.h>
40 #include <pulsecore/refcnt.h>
41 #include <pulsecore/msgobject.h>
42 #include <pulsecore/rtpoll.h>
44 #define PA_MAX_INPUTS_PER_SINK 32
46 typedef enum pa_sink_state {
54 static inline pa_bool_t PA_SINK_IS_OPENED(pa_sink_state_t x) {
55 return x == PA_SINK_RUNNING || x == PA_SINK_IDLE;
58 static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
59 return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
67 pa_sink_state_t state;
68 pa_sink_flags_t flags;
71 char *driver; /* may be NULL */
72 pa_proplist *proplist;
74 pa_module *module; /* may be NULL */
76 pa_sample_spec sample_spec;
77 pa_channel_map channel_map;
81 pa_source *monitor_source;
85 pa_bool_t refresh_volume;
86 pa_bool_t refresh_mute;
88 pa_asyncmsgq *asyncmsgq;
93 pa_usec_t min_latency; /* we won't go below this latency */
94 pa_usec_t max_latency; /* An upper limit for the latencies */
96 /* Called when the main loop requests a state change. Called from
97 * main loop context. If returns -1 the state change will be
99 int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
101 /* Callled when the volume is queried. Called from main loop
102 * context. If this is NULL a PA_SINK_MESSAGE_GET_VOLUME message
103 * will be sent to the IO thread instead. */
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. */
114 int (*get_mute)(pa_sink *s); /* dito */
116 /* Called when the mute setting shall be changed. Called from main
117 * loop context. If this is NULL a PA_SINK_MESSAGE_SET_MUTE
118 * message will be sent to the IO thread instead. */
119 int (*set_mute)(pa_sink *s); /* dito */
121 /* Called when a rewind request is issued. Called from IO thread
123 void (*request_rewind)(pa_sink *s); /* dito */
125 /* Called when a the requested latency is changed. Called from IO
127 void (*update_requested_latency)(pa_sink *s); /* dito */
129 /* Contains copies of the above data so that the real-time worker
130 * thread can work without access locking */
132 pa_sink_state_t state;
134 pa_cvolume soft_volume;
135 pa_bool_t soft_muted;
137 pa_bool_t requested_latency_valid;
138 pa_usec_t requested_latency;
140 /* The number of bytes we need keep around to be able to satisfy
141 * every DMA buffer rewrite */
144 /* Maximum of what clients requested to rewind in this cycle */
145 size_t rewind_nbytes;
151 PA_DECLARE_CLASS(pa_sink);
152 #define PA_SINK(s) (pa_sink_cast(s))
154 typedef enum pa_sink_message {
155 PA_SINK_MESSAGE_ADD_INPUT,
156 PA_SINK_MESSAGE_REMOVE_INPUT,
157 PA_SINK_MESSAGE_GET_VOLUME,
158 PA_SINK_MESSAGE_SET_VOLUME,
159 PA_SINK_MESSAGE_GET_MUTE,
160 PA_SINK_MESSAGE_SET_MUTE,
161 PA_SINK_MESSAGE_GET_LATENCY,
162 PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
163 PA_SINK_MESSAGE_SET_STATE,
164 PA_SINK_MESSAGE_START_MOVE,
165 PA_SINK_MESSAGE_FINISH_MOVE,
166 PA_SINK_MESSAGE_ATTACH,
167 PA_SINK_MESSAGE_DETACH,
171 typedef struct pa_sink_new_data {
173 pa_bool_t namereg_fail;
174 pa_proplist *proplist;
179 pa_sample_spec sample_spec;
180 pa_bool_t sample_spec_is_set;
181 pa_channel_map channel_map;
182 pa_bool_t channel_map_is_set;
185 pa_bool_t volume_is_set;
187 pa_bool_t muted_is_set;
190 pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
191 void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
192 void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
193 void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
194 void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
195 void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
196 void pa_sink_new_data_done(pa_sink_new_data *data);
198 /* To be called exclusively by the sink driver, from main context */
200 pa_sink* pa_sink_new(
202 pa_sink_new_data *data,
203 pa_sink_flags_t flags);
205 void pa_sink_put(pa_sink *s);
206 void pa_sink_unlink(pa_sink* s);
208 void pa_sink_set_description(pa_sink *s, const char *description);
209 void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
210 void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
212 void pa_sink_detach(pa_sink *s);
213 void pa_sink_attach(pa_sink *s);
215 /* May be called by everyone, from main context */
217 /* The returned value is supposed to be in the time domain of the sound card! */
218 pa_usec_t pa_sink_get_latency(pa_sink *s);
219 pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
221 int pa_sink_update_status(pa_sink*s);
222 int pa_sink_suspend(pa_sink *s, pa_bool_t suspend);
223 int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend);
225 void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume);
226 const pa_cvolume *pa_sink_get_volume(pa_sink *sink);
227 void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute);
228 pa_bool_t pa_sink_get_mute(pa_sink *sink);
230 unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
231 unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
232 #define pa_sink_get_state(s) ((s)->state)
234 /* To be called exclusively by the sink driver, from IO context */
236 void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
237 void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
238 void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
239 void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
241 void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
243 int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
245 void pa_sink_attach_within_thread(pa_sink *s);
246 void pa_sink_detach_within_thread(pa_sink *s);
248 pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
250 void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
252 /* To be called exclusively by sink input drivers, from IO context */
254 void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
256 void pa_sink_invalidate_requested_latency(pa_sink *s);