1 #ifndef foopulsesinkinputhfoo
2 #define foopulsesinkinputhfoo
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
28 typedef struct pa_sink_input pa_sink_input
;
30 #include <pulse/sample.h>
31 #include <pulsecore/hook-list.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>
39 typedef enum pa_sink_input_state
{
40 PA_SINK_INPUT_INIT
, /*< The stream is not active yet, because pa_sink_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 } pa_sink_input_state_t
;
47 static inline pa_bool_t
PA_SINK_INPUT_IS_LINKED(pa_sink_input_state_t x
) {
48 return x
== PA_SINK_INPUT_DRAINED
|| x
== PA_SINK_INPUT_RUNNING
|| x
== PA_SINK_INPUT_CORKED
;
51 typedef enum pa_sink_input_flags
{
52 PA_SINK_INPUT_VARIABLE_RATE
= 1,
53 PA_SINK_INPUT_DONT_MOVE
= 2,
54 PA_SINK_INPUT_START_CORKED
= 4,
55 PA_SINK_INPUT_NO_REMAP
= 8,
56 PA_SINK_INPUT_NO_REMIX
= 16,
57 PA_SINK_INPUT_FIX_FORMAT
= 32,
58 PA_SINK_INPUT_FIX_RATE
= 64,
59 PA_SINK_INPUT_FIX_CHANNELS
= 128,
60 PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
= 256,
61 } pa_sink_input_flags_t
;
63 struct pa_sink_input
{
69 /* Please note that this state should only be read with
70 * pa_sink_input_get_state(). That function will transparently
71 * merge the thread_info.drained value in. */
72 pa_sink_input_state_t state
;
73 pa_sink_input_flags_t flags
;
75 char *driver
; /* may be NULL */
76 pa_proplist
*proplist
;
78 pa_module
*module
; /* may be NULL */
79 pa_client
*client
; /* may be NULL */
81 pa_sink
*sink
; /* NULL while we are being moved */
83 /* A sink input may be connected to multiple source outputs
84 * directly, so that they don't get mixed data of the entire
86 pa_idxset
*direct_outputs
;
88 pa_sample_spec sample_spec
;
89 pa_channel_map channel_map
;
91 pa_sink_input
*sync_prev
, *sync_next
;
93 pa_cvolume virtual_volume
, soft_volume
;
96 /* if TRUE then the source we are connected to and/or the volume
97 * set is worth remembering, i.e. was explicitly chosen by the
98 * user and not automatically. module-stream-restore looks for
100 pa_bool_t save_sink
:1, save_volume
:1, save_muted
:1;
102 pa_resample_method_t requested_resample_method
, actual_resample_method
;
104 /* Returns the chunk of audio data and drops it from the
105 * queue. Returns -1 on failure. Called from IO thread context. If
106 * data needs to be generated from scratch then please in the
107 * specified length request_nbytes. This is an optimization
108 * only. If less data is available, it's fine to return a smaller
109 * block. If more data is already ready, it is better to return
111 int (*pop
) (pa_sink_input
*i
, size_t request_nbytes
, pa_memchunk
*chunk
); /* may NOT be NULL */
113 /* Rewind the queue by the specified number of bytes. Called just
114 * before peek() if it is called at all. Only called if the sink
115 * input driver ever plans to call
116 * pa_sink_input_request_rewind(). Called from IO context. */
117 void (*process_rewind
) (pa_sink_input
*i
, size_t nbytes
); /* may NOT be NULL */
119 /* Called whenever the maximum rewindable size of the sink
120 * changes. Called from IO context. */
121 void (*update_max_rewind
) (pa_sink_input
*i
, size_t nbytes
); /* may be NULL */
123 /* Called whenever the maxiumum request size of the sink
124 * changes. Called from IO context. */
125 void (*update_max_request
) (pa_sink_input
*i
, size_t nbytes
); /* may be NULL */
127 /* Called whenever the configured latency of the sink
128 * changes. Called from IO context. */
129 void (*update_sink_requested_latency
) (pa_sink_input
*i
); /* may be NULL */
131 /* Called whenver the latency range of the sink changes. Called
132 * from IO context. */
133 void (*update_sink_latency_range
) (pa_sink_input
*i
); /* may be NULL */
135 /* If non-NULL this function is called when the input is first
136 * connected to a sink or when the rtpoll/asyncmsgq fields
137 * change. You usually don't need to implement this function
138 * unless you rewrite a sink that is piggy-backed onto
139 * another. Called from IO thread context */
140 void (*attach
) (pa_sink_input
*i
); /* may be NULL */
142 /* If non-NULL this function is called when the output is
143 * disconnected from its sink. Called from IO thread context */
144 void (*detach
) (pa_sink_input
*i
); /* may be NULL */
146 /* If non-NULL called whenever the the sink this input is attached
147 * to suspends or resumes. Called from main context */
148 void (*suspend
) (pa_sink_input
*i
, pa_bool_t b
); /* may be NULL */
150 /* If non-NULL called whenever the the sink this input is attached
151 * to changes. Called from main context */
152 void (*moved
) (pa_sink_input
*i
); /* may be NULL */
154 /* Supposed to unlink and destroy this stream. Called from main
156 void (*kill
) (pa_sink_input
*i
); /* may NOT be NULL */
158 /* Return the current latency (i.e. length of bufferd audio) of
159 this stream. Called from main context. This is added to what the
160 PA_SINK_INPUT_MESSAGE_GET_LATENCY message sent to the IO thread
162 pa_usec_t (*get_latency
) (pa_sink_input
*i
); /* may be NULL */
164 /* If non-NULL this function is called from thread context if the
165 * state changes. The old state is found in thread_info.state. */
166 void (*state_change
) (pa_sink_input
*i
, pa_sink_input_state_t state
); /* may be NULL */
168 /* If non-NULL this function is called before this sink input is
169 * move to a sink and if it returns FALSE the move will not
171 pa_bool_t (*may_move_to
) (pa_sink_input
*i
, pa_sink
*s
); /* may be NULL */
174 pa_sink_input_state_t state
;
177 pa_cvolume soft_volume
;
180 pa_bool_t attached
:1; /* True only between ->attach() and ->detach() calls */
182 /* 0: rewrite nothing, (size_t) -1: rewrite everything, otherwise how many bytes to rewrite */
183 pa_bool_t rewrite_flush
:1, dont_rewind_render
:1;
184 size_t rewrite_nbytes
;
185 uint64_t underrun_for
, playing_for
;
187 pa_sample_spec sample_spec
;
189 pa_resampler
*resampler
; /* may be NULL */
191 /* We maintain a history of resampled audio data here. */
192 pa_memblockq
*render_memblockq
;
194 pa_sink_input
*sync_prev
, *sync_next
;
196 /* The requested latency for the sink */
197 pa_usec_t requested_sink_latency
;
199 pa_hashmap
*direct_outputs
;
205 PA_DECLARE_CLASS(pa_sink_input
);
206 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
209 PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME
,
210 PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE
,
211 PA_SINK_INPUT_MESSAGE_GET_LATENCY
,
212 PA_SINK_INPUT_MESSAGE_SET_RATE
,
213 PA_SINK_INPUT_MESSAGE_SET_STATE
,
214 PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
,
215 PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
,
216 PA_SINK_INPUT_MESSAGE_MAX
219 typedef struct pa_sink_input_new_data
{
220 pa_proplist
*proplist
;
228 pa_resample_method_t resample_method
;
230 pa_sink_input
*sync_base
;
232 pa_sample_spec sample_spec
;
233 pa_channel_map channel_map
;
235 pa_cvolume virtual_volume
, soft_volume
;
238 pa_bool_t sample_spec_is_set
:1;
239 pa_bool_t channel_map_is_set
:1;
241 pa_bool_t virtual_volume_is_set
:1, soft_volume_is_set
:1;
242 pa_bool_t muted_is_set
:1;
244 pa_bool_t virtual_volume_is_absolute
:1;
246 pa_bool_t save_sink
:1, save_volume
:1, save_muted
:1;
247 } pa_sink_input_new_data
;
249 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
);
250 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
);
251 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
);
252 void pa_sink_input_new_data_set_soft_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
);
253 void pa_sink_input_new_data_set_virtual_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
);
254 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, pa_bool_t mute
);
255 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
);
257 /* To be called by the implementing module only */
259 pa_sink_input
* pa_sink_input_new(
261 pa_sink_input_new_data
*data
,
262 pa_sink_input_flags_t flags
);
264 void pa_sink_input_put(pa_sink_input
*i
);
265 void pa_sink_input_unlink(pa_sink_input
* i
);
267 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
);
269 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
);
271 /* Request that the specified number of bytes already written out to
272 the hw device is rewritten, if possible. Please note that this is
273 only a kind request. The sink driver may not be able to fulfill it
274 fully -- or at all. If the request for a rewrite was successful, the
275 sink driver will call ->rewind() and pass the number of bytes that
276 could be rewound in the HW device. This functionality is required for
277 implementing the "zero latency" write-through functionality. */
278 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
);
280 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
);
282 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
);
284 /* Callable by everyone from main thread*/
286 /* External code may request disconnection with this function */
287 void pa_sink_input_kill(pa_sink_input
*i
);
289 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
, pa_usec_t
*sink_latency
);
291 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
, pa_bool_t save
);
292 const pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
);
293 void pa_sink_input_set_mute(pa_sink_input
*i
, pa_bool_t mute
, pa_bool_t save
);
294 pa_bool_t
pa_sink_input_get_mute(pa_sink_input
*i
);
295 pa_bool_t
pa_sink_input_update_proplist(pa_sink_input
*i
, pa_update_mode_t mode
, pa_proplist
*p
);
297 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
);
299 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
, pa_bool_t save
);
300 pa_bool_t
pa_sink_input_may_move(pa_sink_input
*i
); /* may this sink input move at all? */
301 pa_bool_t
pa_sink_input_may_move_to(pa_sink_input
*i
, pa_sink
*dest
); /* may this sink input move to this sink? */
303 /* The same as pa_sink_input_move_to() but in two seperate steps,
304 * first the detaching from the old sink, then the attaching to the
306 int pa_sink_input_start_move(pa_sink_input
*i
);
307 int pa_sink_input_finish_move(pa_sink_input
*i
, pa_sink
*dest
, pa_bool_t save
);
309 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
);
311 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
);
313 /* To be used exclusively by the sink driver IO thread */
315 int pa_sink_input_peek(pa_sink_input
*i
, size_t length
, pa_memchunk
*chunk
, pa_cvolume
*volume
);
316 void pa_sink_input_drop(pa_sink_input
*i
, size_t length
);
317 void pa_sink_input_process_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */);
318 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */);
319 void pa_sink_input_update_max_request(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */);
321 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
);
323 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
325 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
);
327 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
);
329 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
);