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.1 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 <pulse/format.h>
32 #include <pulsecore/hook-list.h>
33 #include <pulsecore/memblockq.h>
34 #include <pulsecore/resampler.h>
35 #include <pulsecore/module.h>
36 #include <pulsecore/client.h>
37 #include <pulsecore/sink.h>
38 #include <pulsecore/core.h>
40 typedef enum pa_sink_input_state
{
41 PA_SINK_INPUT_INIT
, /*< The stream is not active yet, because pa_sink_input_put() has not been called yet */
42 PA_SINK_INPUT_DRAINED
, /*< The stream stopped playing because there was no data to play */
43 PA_SINK_INPUT_RUNNING
, /*< The stream is alive and kicking */
44 PA_SINK_INPUT_CORKED
, /*< The stream was corked on user request */
45 PA_SINK_INPUT_UNLINKED
/*< The stream is dead */
46 /* FIXME: we need a state for MOVING here */
47 } pa_sink_input_state_t
;
49 static inline pa_bool_t
PA_SINK_INPUT_IS_LINKED(pa_sink_input_state_t x
) {
50 return x
== PA_SINK_INPUT_DRAINED
|| x
== PA_SINK_INPUT_RUNNING
|| x
== PA_SINK_INPUT_CORKED
;
53 typedef enum pa_sink_input_flags
{
54 PA_SINK_INPUT_VARIABLE_RATE
= 1,
55 PA_SINK_INPUT_DONT_MOVE
= 2,
56 PA_SINK_INPUT_START_CORKED
= 4,
57 PA_SINK_INPUT_NO_REMAP
= 8,
58 PA_SINK_INPUT_NO_REMIX
= 16,
59 PA_SINK_INPUT_FIX_FORMAT
= 32,
60 PA_SINK_INPUT_FIX_RATE
= 64,
61 PA_SINK_INPUT_FIX_CHANNELS
= 128,
62 PA_SINK_INPUT_DONT_INHIBIT_AUTO_SUSPEND
= 256,
63 PA_SINK_INPUT_NO_CREATE_ON_SUSPEND
= 512,
64 PA_SINK_INPUT_KILL_ON_SUSPEND
= 1024,
65 PA_SINK_INPUT_PASSTHROUGH
= 2048
66 } pa_sink_input_flags_t
;
68 struct pa_sink_input
{
74 /* Please note that this state should only be read with
75 * pa_sink_input_get_state(). That function will transparently
76 * merge the thread_info.drained value in. */
77 pa_sink_input_state_t state
;
78 pa_sink_input_flags_t flags
;
80 char *driver
; /* may be NULL */
81 pa_proplist
*proplist
;
83 pa_module
*module
; /* may be NULL */
84 pa_client
*client
; /* may be NULL */
86 pa_sink
*sink
; /* NULL while we are being moved */
87 pa_sink
*origin_sink
; /* only set by filter sinks */
89 /* A sink input may be connected to multiple source outputs
90 * directly, so that they don't get mixed data of the entire
92 pa_idxset
*direct_outputs
;
94 pa_sample_spec sample_spec
;
95 pa_channel_map channel_map
;
96 pa_format_info
*format
;
98 pa_sink_input
*sync_prev
, *sync_next
;
100 /* Also see http://pulseaudio.org/wiki/InternalVolumes */
101 pa_cvolume volume
; /* The volume clients are informed about */
102 pa_cvolume reference_ratio
; /* The ratio of the stream's volume to the sink's reference volume */
103 pa_cvolume real_ratio
; /* The ratio of the stream's volume to the sink's real volume */
104 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 */
105 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 */
107 pa_cvolume volume_factor_sink
; /* A second volume factor in format of the sink this stream is connected to */
109 pa_bool_t volume_writable
:1;
113 /* if TRUE then the sink we are connected to and/or the volume
114 * set is worth remembering, i.e. was explicitly chosen by the
115 * user and not automatically. module-stream-restore looks for
117 pa_bool_t save_sink
:1, save_volume
:1, save_muted
:1;
119 pa_resample_method_t requested_resample_method
, actual_resample_method
;
121 /* Returns the chunk of audio data and drops it from the
122 * queue. Returns -1 on failure. Called from IO thread context. If
123 * data needs to be generated from scratch then please in the
124 * specified length request_nbytes. This is an optimization
125 * only. If less data is available, it's fine to return a smaller
126 * block. If more data is already ready, it is better to return
128 int (*pop
) (pa_sink_input
*i
, size_t request_nbytes
, pa_memchunk
*chunk
); /* may NOT be NULL */
130 /* Rewind the queue by the specified number of bytes. Called just
131 * before peek() if it is called at all. Only called if the sink
132 * input driver ever plans to call
133 * pa_sink_input_request_rewind(). Called from IO context. */
134 void (*process_rewind
) (pa_sink_input
*i
, size_t nbytes
); /* may NOT be NULL */
136 /* Called whenever the maximum rewindable size of the sink
137 * changes. Called from IO context. */
138 void (*update_max_rewind
) (pa_sink_input
*i
, size_t nbytes
); /* may be NULL */
140 /* Called whenever the maximum request size of the sink
141 * changes. Called from IO context. */
142 void (*update_max_request
) (pa_sink_input
*i
, size_t nbytes
); /* may be NULL */
144 /* Called whenever the configured latency of the sink
145 * changes. Called from IO context. */
146 void (*update_sink_requested_latency
) (pa_sink_input
*i
); /* may be NULL */
148 /* Called whenver the latency range of the sink changes. Called
149 * from IO context. */
150 void (*update_sink_latency_range
) (pa_sink_input
*i
); /* may be NULL */
152 /* Called whenver the fixed latency of the sink changes, if there
153 * is one. Called from IO context. */
154 void (*update_sink_fixed_latency
) (pa_sink_input
*i
); /* may be NULL */
156 /* If non-NULL this function is called when the input is first
157 * connected to a sink or when the rtpoll/asyncmsgq fields
158 * change. You usually don't need to implement this function
159 * unless you rewrite a sink that is piggy-backed onto
160 * another. Called from IO thread context */
161 void (*attach
) (pa_sink_input
*i
); /* may be NULL */
163 /* If non-NULL this function is called when the output is
164 * disconnected from its sink. Called from IO thread context */
165 void (*detach
) (pa_sink_input
*i
); /* may be NULL */
167 /* If non-NULL called whenever the sink this input is attached
168 * to suspends or resumes. Called from main context */
169 void (*suspend
) (pa_sink_input
*i
, pa_bool_t b
); /* may be NULL */
171 /* If non-NULL called whenever the sink this input is attached
172 * to suspends or resumes. Called from IO context */
173 void (*suspend_within_thread
) (pa_sink_input
*i
, pa_bool_t b
); /* may be NULL */
175 /* If non-NULL called whenever the sink input is moved to a new
176 * sink. Called from main context after the sink input has been
177 * detached from the old sink and before it has been attached to
178 * the new sink. If dest is NULL the move was executed in two
179 * phases and the second one failed; the stream will be destroyed
180 * after this call. */
181 void (*moving
) (pa_sink_input
*i
, pa_sink
*dest
); /* may be NULL */
183 /* Supposed to unlink and destroy this stream. Called from main
185 void (*kill
) (pa_sink_input
*i
); /* may NOT be NULL */
187 /* Return the current latency (i.e. length of bufferd audio) of
188 this stream. Called from main context. This is added to what the
189 PA_SINK_INPUT_MESSAGE_GET_LATENCY message sent to the IO thread
191 pa_usec_t (*get_latency
) (pa_sink_input
*i
); /* may be NULL */
193 /* If non-NULL this function is called from thread context if the
194 * state changes. The old state is found in thread_info.state. */
195 void (*state_change
) (pa_sink_input
*i
, pa_sink_input_state_t state
); /* may be NULL */
197 /* If non-NULL this function is called before this sink input is
198 * move to a sink and if it returns FALSE the move will not
200 pa_bool_t (*may_move_to
) (pa_sink_input
*i
, pa_sink
*s
); /* may be NULL */
202 /* If non-NULL this function is used to dispatch asynchronous
203 * control events. Called from main context. */
204 void (*send_event
)(pa_sink_input
*i
, const char *event
, pa_proplist
* data
); /* may be NULL */
206 /* If non-NULL this function is called whenever the sink input
207 * volume changes. Called from main context */
208 void (*volume_changed
)(pa_sink_input
*i
); /* may be NULL */
210 /* If non-NULL this function is called whenever the sink input
211 * mute status changes. Called from main context */
212 void (*mute_changed
)(pa_sink_input
*i
); /* may be NULL */
215 pa_sink_input_state_t state
;
218 pa_cvolume soft_volume
;
221 pa_bool_t attached
:1; /* True only between ->attach() and ->detach() calls */
223 /* rewrite_nbytes: 0: rewrite nothing, (size_t) -1: rewrite everything, otherwise how many bytes to rewrite */
224 pa_bool_t rewrite_flush
:1, dont_rewind_render
:1;
225 size_t rewrite_nbytes
;
226 uint64_t underrun_for
, playing_for
;
228 pa_sample_spec sample_spec
;
230 pa_resampler
*resampler
; /* may be NULL */
232 /* We maintain a history of resampled audio data here. */
233 pa_memblockq
*render_memblockq
;
235 pa_sink_input
*sync_prev
, *sync_next
;
237 /* The requested latency for the sink */
238 pa_usec_t requested_sink_latency
;
240 pa_hashmap
*direct_outputs
;
246 PA_DECLARE_PUBLIC_CLASS(pa_sink_input
);
247 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
250 PA_SINK_INPUT_MESSAGE_SET_SOFT_VOLUME
,
251 PA_SINK_INPUT_MESSAGE_SET_SOFT_MUTE
,
252 PA_SINK_INPUT_MESSAGE_GET_LATENCY
,
253 PA_SINK_INPUT_MESSAGE_SET_RATE
,
254 PA_SINK_INPUT_MESSAGE_SET_STATE
,
255 PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
,
256 PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
,
257 PA_SINK_INPUT_MESSAGE_MAX
260 typedef struct pa_sink_input_send_event_hook_data
{
261 pa_sink_input
*sink_input
;
264 } pa_sink_input_send_event_hook_data
;
266 typedef struct pa_sink_input_new_data
{
267 pa_sink_input_flags_t flags
;
269 pa_proplist
*proplist
;
276 pa_sink
*origin_sink
;
278 pa_resample_method_t resample_method
;
280 pa_sink_input
*sync_base
;
282 pa_sample_spec sample_spec
;
283 pa_channel_map channel_map
;
284 pa_format_info
*format
;
285 pa_idxset
*req_formats
;
286 pa_idxset
*nego_formats
;
288 pa_cvolume volume
, volume_factor
, volume_factor_sink
;
291 pa_bool_t sample_spec_is_set
:1;
292 pa_bool_t channel_map_is_set
:1;
294 pa_bool_t volume_is_set
:1, volume_factor_is_set
:1, volume_factor_sink_is_set
:1;
295 pa_bool_t muted_is_set
:1;
297 pa_bool_t volume_is_absolute
:1;
299 pa_bool_t volume_writable
:1;
301 pa_bool_t save_sink
:1, save_volume
:1, save_muted
:1;
302 } pa_sink_input_new_data
;
304 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
);
305 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
);
306 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
);
307 pa_bool_t
pa_sink_input_new_data_is_passthrough(pa_sink_input_new_data
*data
);
308 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
);
309 void pa_sink_input_new_data_apply_volume_factor(pa_sink_input_new_data
*data
, const pa_cvolume
*volume_factor
);
310 void pa_sink_input_new_data_apply_volume_factor_sink(pa_sink_input_new_data
*data
, const pa_cvolume
*volume_factor
);
311 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, pa_bool_t mute
);
312 pa_bool_t
pa_sink_input_new_data_set_sink(pa_sink_input_new_data
*data
, pa_sink
*s
, pa_bool_t save
);
313 pa_bool_t
pa_sink_input_new_data_set_formats(pa_sink_input_new_data
*data
, pa_idxset
*formats
);
314 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
);
316 /* To be called by the implementing module only */
318 int pa_sink_input_new(
321 pa_sink_input_new_data
*data
);
323 void pa_sink_input_put(pa_sink_input
*i
);
324 void pa_sink_input_unlink(pa_sink_input
* i
);
326 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
);
328 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
);
330 /* Request that the specified number of bytes already written out to
331 the hw device is rewritten, if possible. Please note that this is
332 only a kind request. The sink driver may not be able to fulfill it
333 fully -- or at all. If the request for a rewrite was successful, the
334 sink driver will call ->rewind() and pass the number of bytes that
335 could be rewound in the HW device. This functionality is required for
336 implementing the "zero latency" write-through functionality. */
337 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
);
339 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
);
341 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
);
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
);
347 /* Callable by everyone from main thread*/
349 /* External code may request disconnection with this function */
350 void pa_sink_input_kill(pa_sink_input
*i
);
352 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
, pa_usec_t
*sink_latency
);
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
);
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
);
362 void pa_sink_input_update_proplist(pa_sink_input
*i
, pa_update_mode_t mode
, pa_proplist
*p
);
364 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
);
366 void pa_sink_input_send_event(pa_sink_input
*i
, const char *name
, pa_proplist
*data
);
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? */
372 /* The same as pa_sink_input_move_to() but in two seperate steps,
373 * first the detaching from the old sink, then the attaching to the
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
);
379 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
);
381 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
);
383 /* To be used exclusively by the sink driver IO thread */
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 */);
391 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
);
393 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
395 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
);
397 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
);
399 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
);
401 #define pa_sink_input_assert_io_context(s) \
402 pa_assert(pa_thread_mq_get() || !PA_SINK_INPUT_IS_LINKED((s)->state))