Branch data Line data Source code
1 : : #ifndef foopulsesinkinputhfoo
2 : : #define foopulsesinkinputhfoo
3 : :
4 : : /***
5 : : This file is part of PulseAudio.
6 : :
7 : : Copyright 2004-2006 Lennart Poettering
8 : : Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
9 : :
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.1 of the License,
13 : : or (at your option) any later version.
14 : :
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.
19 : :
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
23 : : USA.
24 : : ***/
25 : :
26 : : #include <inttypes.h>
27 : :
28 : : typedef struct pa_sink_input pa_sink_input;
29 : :
30 : : #include <pulse/sample.h>
31 : : #include <pulse/format.h>
32 : : #include <pulsecore/memblockq.h>
33 : : #include <pulsecore/resampler.h>
34 : : #include <pulsecore/module.h>
35 : : #include <pulsecore/client.h>
36 : : #include <pulsecore/sink.h>
37 : : #include <pulsecore/core.h>
38 : :
39 : : typedef enum pa_sink_input_state {
40 : : PA_SINK_INPUT_INIT, /*< The stream is not active yet, because pa_sink_input_put() has not been called yet */
41 : : PA_SINK_INPUT_DRAINED, /*< The stream stopped playing because there was no data to play */
42 : : PA_SINK_INPUT_RUNNING, /*< The stream is alive and kicking */
43 : : PA_SINK_INPUT_CORKED, /*< The stream was corked on user request */
44 : : PA_SINK_INPUT_UNLINKED /*< The stream is dead */
45 : : /* FIXME: we need a state for MOVING here */
46 : : } pa_sink_input_state_t;
47 : :
48 : : static inline pa_bool_t PA_SINK_INPUT_IS_LINKED(pa_sink_input_state_t x) {
49 : 0 : return x == PA_SINK_INPUT_DRAINED || x == PA_SINK_INPUT_RUNNING || x == PA_SINK_INPUT_CORKED;
50 : : }
51 : :
52 : : typedef enum pa_sink_input_flags {
53 : : PA_SINK_INPUT_VARIABLE_RATE = 1,
54 : : PA_SINK_INPUT_DONT_MOVE = 2,
55 : : PA_SINK_INPUT_START_CORKED = 4,
56 : : PA_SINK_INPUT_NO_REMAP = 8,
57 : : PA_SINK_INPUT_NO_REMIX = 16,
58 : : PA_SINK_INPUT_FIX_FORMAT = 32,
59 : : PA_SINK_INPUT_FIX_RATE = 64,
60 : : PA_SINK_INPUT_FIX_CHANNELS = 128,
61 : : PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND = 256,
62 : : PA_SINK_INPUT_NO_CREATE_ON_SUSPEND = 512,
63 : : PA_SINK_INPUT_KILL_ON_SUSPEND = 1024,
64 : : PA_SINK_INPUT_PASSTHROUGH = 2048
65 : : } pa_sink_input_flags_t;
66 : :
67 : : struct pa_sink_input {
68 : : pa_msgobject parent;
69 : :
70 : : uint32_t index;
71 : : pa_core *core;
72 : :
73 : : /* Please note that this state should only be read with
74 : : * pa_sink_input_get_state(). That function will transparently
75 : : * merge the thread_info.drained value in. */
76 : : pa_sink_input_state_t state;
77 : : pa_sink_input_flags_t flags;
78 : :
79 : : char *driver; /* may be NULL */
80 : : pa_proplist *proplist;
81 : :
82 : : pa_module *module; /* may be NULL */
83 : : pa_client *client; /* may be NULL */
84 : :
85 : : pa_sink *sink; /* NULL while we are being moved */
86 : : pa_sink *origin_sink; /* only set by filter sinks */
87 : :
88 : : /* A sink input may be connected to multiple source outputs
89 : : * directly, so that they don't get mixed data of the entire
90 : : * source. */
91 : : pa_idxset *direct_outputs;
92 : :
93 : : pa_sample_spec sample_spec;
94 : : pa_channel_map channel_map;
95 : : pa_format_info *format;
96 : :
97 : : pa_sink_input *sync_prev, *sync_next;
98 : :
99 : : /* Also see http://pulseaudio.org/wiki/InternalVolumes */
100 : : pa_cvolume volume; /* The volume clients are informed about */
101 : : pa_cvolume reference_ratio; /* The ratio of the stream's volume to the sink's reference volume */
102 : : pa_cvolume real_ratio; /* The ratio of the stream's volume to the sink's real volume */
103 : : pa_cvolume volume_factor; /* An internally used volume factor that can be used by modules to apply effects and suchlike without having that visible to the outside */
104 : : pa_cvolume soft_volume; /* The internal software volume we apply to all PCM data while it passes through. Usually calculated as real_ratio * volume_factor */
105 : :
106 : : pa_cvolume volume_factor_sink; /* A second volume factor in format of the sink this stream is connected to */
107 : :
108 : : pa_bool_t volume_writable:1;
109 : :
110 : : pa_bool_t muted:1;
111 : :
112 : : /* if TRUE then the sink we are connected to and/or the volume
113 : : * set is worth remembering, i.e. was explicitly chosen by the
114 : : * user and not automatically. module-stream-restore looks for
115 : : * this.*/
116 : : pa_bool_t save_sink:1, save_volume:1, save_muted:1;
117 : :
118 : : pa_resample_method_t requested_resample_method, actual_resample_method;
119 : :
120 : : /* Returns the chunk of audio data and drops it from the
121 : : * queue. Returns -1 on failure. Called from IO thread context. If
122 : : * data needs to be generated from scratch then please in the
123 : : * specified length request_nbytes. This is an optimization
124 : : * only. If less data is available, it's fine to return a smaller
125 : : * block. If more data is already ready, it is better to return
126 : : * the full block. */
127 : : int (*pop) (pa_sink_input *i, size_t request_nbytes, pa_memchunk *chunk); /* may NOT be NULL */
128 : :
129 : : /* Rewind the queue by the specified number of bytes. Called just
130 : : * before peek() if it is called at all. Only called if the sink
131 : : * input driver ever plans to call
132 : : * pa_sink_input_request_rewind(). Called from IO context. */
133 : : void (*process_rewind) (pa_sink_input *i, size_t nbytes); /* may NOT be NULL */
134 : :
135 : : /* Called whenever the maximum rewindable size of the sink
136 : : * changes. Called from IO context. */
137 : : void (*update_max_rewind) (pa_sink_input *i, size_t nbytes); /* may be NULL */
138 : :
139 : : /* Called whenever the maximum request size of the sink
140 : : * changes. Called from IO context. */
141 : : void (*update_max_request) (pa_sink_input *i, size_t nbytes); /* may be NULL */
142 : :
143 : : /* Called whenever the configured latency of the sink
144 : : * changes. Called from IO context. */
145 : : void (*update_sink_requested_latency) (pa_sink_input *i); /* may be NULL */
146 : :
147 : : /* Called whenever the latency range of the sink changes. Called
148 : : * from IO context. */
149 : : void (*update_sink_latency_range) (pa_sink_input *i); /* may be NULL */
150 : :
151 : : /* Called whenever the fixed latency of the sink changes, if there
152 : : * is one. Called from IO context. */
153 : : void (*update_sink_fixed_latency) (pa_sink_input *i); /* may be NULL */
154 : :
155 : : /* If non-NULL this function is called when the input is first
156 : : * connected to a sink or when the rtpoll/asyncmsgq fields
157 : : * change. You usually don't need to implement this function
158 : : * unless you rewrite a sink that is piggy-backed onto
159 : : * another. Called from IO thread context */
160 : : void (*attach) (pa_sink_input *i); /* may be NULL */
161 : :
162 : : /* If non-NULL this function is called when the output is
163 : : * disconnected from its sink. Called from IO thread context */
164 : : void (*detach) (pa_sink_input *i); /* may be NULL */
165 : :
166 : : /* If non-NULL called whenever the sink this input is attached
167 : : * to suspends or resumes. Called from main context */
168 : : void (*suspend) (pa_sink_input *i, pa_bool_t b); /* may be NULL */
169 : :
170 : : /* If non-NULL called whenever the sink this input is attached
171 : : * to suspends or resumes. Called from IO context */
172 : : void (*suspend_within_thread) (pa_sink_input *i, pa_bool_t b); /* may be NULL */
173 : :
174 : : /* If non-NULL called whenever the sink input is moved to a new
175 : : * sink. Called from main context after the sink input has been
176 : : * detached from the old sink and before it has been attached to
177 : : * the new sink. If dest is NULL the move was executed in two
178 : : * phases and the second one failed; the stream will be destroyed
179 : : * after this call. */
180 : : void (*moving) (pa_sink_input *i, pa_sink *dest); /* may be NULL */
181 : :
182 : : /* Supposed to unlink and destroy this stream. Called from main
183 : : * context. */
184 : : void (*kill) (pa_sink_input *i); /* may NOT be NULL */
185 : :
186 : : /* Return the current latency (i.e. length of buffered audio) of
187 : : this stream. Called from main context. This is added to what the
188 : : PA_SINK_INPUT_MESSAGE_GET_LATENCY message sent to the IO thread
189 : : returns */
190 : : pa_usec_t (*get_latency) (pa_sink_input *i); /* may be NULL */
191 : :
192 : : /* If non-NULL this function is called from thread context if the
193 : : * state changes. The old state is found in thread_info.state. */
194 : : void (*state_change) (pa_sink_input *i, pa_sink_input_state_t state); /* may be NULL */
195 : :
196 : : /* If non-NULL this function is called before this sink input is
197 : : * move to a sink and if it returns FALSE the move will not
198 : : * be allowed */
199 : : pa_bool_t (*may_move_to) (pa_sink_input *i, pa_sink *s); /* may be NULL */
200 : :
201 : : /* If non-NULL this function is used to dispatch asynchronous
202 : : * control events. Called from main context. */
203 : : void (*send_event)(pa_sink_input *i, const char *event, pa_proplist* data); /* may be NULL */
204 : :
205 : : /* If non-NULL this function is called whenever the sink input
206 : : * volume changes. Called from main context */
207 : : void (*volume_changed)(pa_sink_input *i); /* may be NULL */
208 : :
209 : : /* If non-NULL this function is called whenever the sink input
210 : : * mute status changes. Called from main context */
211 : : void (*mute_changed)(pa_sink_input *i); /* may be NULL */
212 : :
213 : : struct {
214 : : pa_sink_input_state_t state;
215 : : pa_atomic_t drained;
216 : :
217 : : pa_cvolume soft_volume;
218 : : pa_bool_t muted:1;
219 : :
220 : : pa_bool_t attached:1; /* True only between ->attach() and ->detach() calls */
221 : :
222 : : /* rewrite_nbytes: 0: rewrite nothing, (size_t) -1: rewrite everything, otherwise how many bytes to rewrite */
223 : : pa_bool_t rewrite_flush:1, dont_rewind_render:1;
224 : : size_t rewrite_nbytes;
225 : : uint64_t underrun_for, playing_for;
226 : :
227 : : pa_sample_spec sample_spec;
228 : :
229 : : pa_resampler *resampler; /* may be NULL */
230 : :
231 : : /* We maintain a history of resampled audio data here. */
232 : : pa_memblockq *render_memblockq;
233 : :
234 : : pa_sink_input *sync_prev, *sync_next;
235 : :
236 : : /* The requested latency for the sink */
237 : : pa_usec_t requested_sink_latency;
238 : :
239 : : pa_hashmap *direct_outputs;
240 : : } thread_info;
241 : :
242 : : void *userdata;
243 : : };
244 : :
245 [ # # ][ # # ]: 0 : PA_DECLARE_PUBLIC_CLASS(pa_sink_input);
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
[ # # ][ # # ]
246 : : #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
247 : :
248 : : enum {
249 : : PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME,
250 : : PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE,
251 : : PA_SINK_INPUT_MESSAGE_GET_LATENCY,
252 : : PA_SINK_INPUT_MESSAGE_SET_RATE,
253 : : PA_SINK_INPUT_MESSAGE_SET_STATE,
254 : : PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY,
255 : : PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY,
256 : : PA_SINK_INPUT_MESSAGE_MAX
257 : : };
258 : :
259 : : typedef struct pa_sink_input_send_event_hook_data {
260 : : pa_sink_input *sink_input;
261 : : const char *event;
262 : : pa_proplist *data;
263 : : } pa_sink_input_send_event_hook_data;
264 : :
265 : : typedef struct pa_sink_input_new_data {
266 : : pa_sink_input_flags_t flags;
267 : :
268 : : pa_proplist *proplist;
269 : :
270 : : const char *driver;
271 : : pa_module *module;
272 : : pa_client *client;
273 : :
274 : : pa_sink *sink;
275 : : pa_sink *origin_sink;
276 : :
277 : : pa_resample_method_t resample_method;
278 : :
279 : : pa_sink_input *sync_base;
280 : :
281 : : pa_sample_spec sample_spec;
282 : : pa_channel_map channel_map;
283 : : pa_format_info *format;
284 : : pa_idxset *req_formats;
285 : : pa_idxset *nego_formats;
286 : :
287 : : pa_cvolume volume, volume_factor, volume_factor_sink;
288 : : pa_bool_t muted:1;
289 : :
290 : : pa_bool_t sample_spec_is_set:1;
291 : : pa_bool_t channel_map_is_set:1;
292 : :
293 : : pa_bool_t volume_is_set:1, volume_factor_is_set:1, volume_factor_sink_is_set:1;
294 : : pa_bool_t muted_is_set:1;
295 : :
296 : : pa_bool_t volume_is_absolute:1;
297 : :
298 : : pa_bool_t volume_writable:1;
299 : :
300 : : pa_bool_t save_sink:1, save_volume:1, save_muted:1;
301 : : } pa_sink_input_new_data;
302 : :
303 : : pa_sink_input_new_data* pa_sink_input_new_data_init(pa_sink_input_new_data *data);
304 : : void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data *data, const pa_sample_spec *spec);
305 : : void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data *data, const pa_channel_map *map);
306 : : pa_bool_t pa_sink_input_new_data_is_passthrough(pa_sink_input_new_data *data);
307 : : void pa_sink_input_new_data_set_volume(pa_sink_input_new_data *data, const pa_cvolume *volume);
308 : : void pa_sink_input_new_data_apply_volume_factor(pa_sink_input_new_data *data, const pa_cvolume *volume_factor);
309 : : void pa_sink_input_new_data_apply_volume_factor_sink(pa_sink_input_new_data *data, const pa_cvolume *volume_factor);
310 : : void pa_sink_input_new_data_set_muted(pa_sink_input_new_data *data, pa_bool_t mute);
311 : : pa_bool_t pa_sink_input_new_data_set_sink(pa_sink_input_new_data *data, pa_sink *s, pa_bool_t save);
312 : : pa_bool_t pa_sink_input_new_data_set_formats(pa_sink_input_new_data *data, pa_idxset *formats);
313 : : void pa_sink_input_new_data_done(pa_sink_input_new_data *data);
314 : :
315 : : /* To be called by the implementing module only */
316 : :
317 : : int pa_sink_input_new(
318 : : pa_sink_input **i,
319 : : pa_core *core,
320 : : pa_sink_input_new_data *data);
321 : :
322 : : void pa_sink_input_put(pa_sink_input *i);
323 : : void pa_sink_input_unlink(pa_sink_input* i);
324 : :
325 : : void pa_sink_input_set_name(pa_sink_input *i, const char *name);
326 : :
327 : : pa_usec_t pa_sink_input_set_requested_latency(pa_sink_input *i, pa_usec_t usec);
328 : :
329 : : /* Request that the specified number of bytes already written out to
330 : : the hw device is rewritten, if possible. Please note that this is
331 : : only a kind request. The sink driver may not be able to fulfill it
332 : : fully -- or at all. If the request for a rewrite was successful, the
333 : : sink driver will call ->rewind() and pass the number of bytes that
334 : : could be rewound in the HW device. This functionality is required for
335 : : implementing the "zero latency" write-through functionality. */
336 : : void pa_sink_input_request_rewind(pa_sink_input *i, size_t nbytes, pa_bool_t rewrite, pa_bool_t flush, pa_bool_t dont_rewind_render);
337 : :
338 : : void pa_sink_input_cork(pa_sink_input *i, pa_bool_t b);
339 : :
340 : : int pa_sink_input_set_rate(pa_sink_input *i, uint32_t rate);
341 : : int pa_sink_input_update_rate(pa_sink_input *i);
342 : :
343 : : /* This returns the sink's fields converted into out sample type */
344 : : size_t pa_sink_input_get_max_rewind(pa_sink_input *i);
345 : : size_t pa_sink_input_get_max_request(pa_sink_input *i);
346 : :
347 : : /* Callable by everyone from main thread*/
348 : :
349 : : /* External code may request disconnection with this function */
350 : : void pa_sink_input_kill(pa_sink_input*i);
351 : :
352 : : pa_usec_t pa_sink_input_get_latency(pa_sink_input *i, pa_usec_t *sink_latency);
353 : :
354 : : pa_bool_t pa_sink_input_is_passthrough(pa_sink_input *i);
355 : : pa_bool_t pa_sink_input_is_volume_readable(pa_sink_input *i);
356 : : void pa_sink_input_set_volume(pa_sink_input *i, const pa_cvolume *volume, pa_bool_t save, pa_bool_t absolute);
357 : : pa_cvolume *pa_sink_input_get_volume(pa_sink_input *i, pa_cvolume *volume, pa_bool_t absolute);
358 : :
359 : : void pa_sink_input_set_mute(pa_sink_input *i, pa_bool_t mute, pa_bool_t save);
360 : : pa_bool_t pa_sink_input_get_mute(pa_sink_input *i);
361 : :
362 : : void pa_sink_input_update_proplist(pa_sink_input *i, pa_update_mode_t mode, pa_proplist *p);
363 : :
364 : : pa_resample_method_t pa_sink_input_get_resample_method(pa_sink_input *i);
365 : :
366 : : void pa_sink_input_send_event(pa_sink_input *i, const char *name, pa_proplist *data);
367 : :
368 : : int pa_sink_input_move_to(pa_sink_input *i, pa_sink *dest, pa_bool_t save);
369 : : pa_bool_t pa_sink_input_may_move(pa_sink_input *i); /* may this sink input move at all? */
370 : : pa_bool_t pa_sink_input_may_move_to(pa_sink_input *i, pa_sink *dest); /* may this sink input move to this sink? */
371 : :
372 : : /* The same as pa_sink_input_move_to() but in two separate steps,
373 : : * first the detaching from the old sink, then the attaching to the
374 : : * new sink */
375 : : int pa_sink_input_start_move(pa_sink_input *i);
376 : : int pa_sink_input_finish_move(pa_sink_input *i, pa_sink *dest, pa_bool_t save);
377 : : void pa_sink_input_fail_move(pa_sink_input *i);
378 : :
379 : : pa_sink_input_state_t pa_sink_input_get_state(pa_sink_input *i);
380 : :
381 : : pa_usec_t pa_sink_input_get_requested_latency(pa_sink_input *i);
382 : :
383 : : /* To be used exclusively by the sink driver IO thread */
384 : :
385 : : void pa_sink_input_peek(pa_sink_input *i, size_t length, pa_memchunk *chunk, pa_cvolume *volume);
386 : : void pa_sink_input_drop(pa_sink_input *i, size_t length);
387 : : void pa_sink_input_process_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */);
388 : : void pa_sink_input_update_max_rewind(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */);
389 : : void pa_sink_input_update_max_request(pa_sink_input *i, size_t nbytes /* in the sink's sample spec */);
390 : :
391 : : void pa_sink_input_set_state_within_thread(pa_sink_input *i, pa_sink_input_state_t state);
392 : :
393 : : int pa_sink_input_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
394 : :
395 : : pa_usec_t pa_sink_input_set_requested_latency_within_thread(pa_sink_input *i, pa_usec_t usec);
396 : :
397 : : pa_bool_t pa_sink_input_safe_to_remove(pa_sink_input *i);
398 : :
399 : : pa_memchunk* pa_sink_input_get_silence(pa_sink_input *i, pa_memchunk *ret);
400 : :
401 : : #define pa_sink_input_assert_io_context(s) \
402 : : pa_assert(pa_thread_mq_get() || !PA_SINK_INPUT_IS_LINKED((s)->state))
403 : :
404 : : #endif
|
