1 #ifndef foopulsesinkinputhfoo
2 #define foopulsesinkinputhfoo
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
30 typedef struct pa_sink_input pa_sink_input
;
32 #include <pulse/sample.h>
33 #include <pulsecore/hook-list.h>
34 #include <pulsecore/memblockq.h>
35 #include <pulsecore/resampler.h>
36 #include <pulsecore/module.h>
37 #include <pulsecore/client.h>
38 #include <pulsecore/sink.h>
39 #include <pulsecore/core.h>
41 typedef enum pa_sink_input_state
{
42 PA_SINK_INPUT_INIT
, /*< The stream is not active yet, because pa_sink_put() has not been called yet */
43 PA_SINK_INPUT_DRAINED
, /*< The stream stopped playing because there was no data to play */
44 PA_SINK_INPUT_RUNNING
, /*< The stream is alive and kicking */
45 PA_SINK_INPUT_CORKED
, /*< The stream was corked on user request */
46 PA_SINK_INPUT_UNLINKED
/*< The stream is dead */
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_flags_t
;
64 struct pa_sink_input
{
70 /* Please note that this state should only be read with
71 * pa_sink_input_get_state(). That function will transparently
72 * merge the thread_info.drained value in. */
73 pa_sink_input_state_t state
;
74 pa_sink_input_flags_t flags
;
76 pa_proplist
*proplist
;
77 char *driver
; /* may be NULL */
78 pa_module
*module
; /* may be NULL */
79 pa_client
*client
; /* may be NULL */
83 pa_sample_spec sample_spec
;
84 pa_channel_map channel_map
;
86 pa_sink_input
*sync_prev
, *sync_next
;
91 pa_resample_method_t resample_method
;
93 /* Returns the chunk of audio data and drops it from the
94 * queue. Returns -1 on failure. Called from IO thread context. If
95 * data needs to be generated from scratch then please in the
96 * specified length request_nbytes. This is an optimization
97 * only. If less data is available, it's fine to return a smaller
98 * block. If more data is already ready, it is better to return
100 int (*pop
) (pa_sink_input
*i
, size_t request_nbytes
, pa_memchunk
*chunk
); /* may NOT be NULL */
102 /* Rewind the queue by the specified number of bytes. Called just
103 * before peek() if it is called at all. Only called if the sink
104 * input driver ever plans to call
105 * pa_sink_input_request_rewind(). Called from IO context. */
106 void (*process_rewind
) (pa_sink_input
*i
, size_t nbytes
); /* may NOT be NULL */
108 /* Called whenever the maximum rewindable size of the sink
109 * changes. Called from IO context. */
110 void (*update_max_rewind
) (pa_sink_input
*i
, size_t nbytes
); /* may be NULL */
112 /* If non-NULL this function is called when the input is first
113 * connected to a sink or when the rtpoll/asyncmsgq fields
114 * change. You usually don't need to implement this function
115 * unless you rewrite a sink that is piggy-backed onto
116 * another. Called from IO thread context */
117 void (*attach
) (pa_sink_input
*i
); /* may be NULL */
119 /* If non-NULL this function is called when the output is
120 * disconnected from its sink. Called from IO thread context */
121 void (*detach
) (pa_sink_input
*i
); /* may be NULL */
123 /* If non-NULL called whenever the the sink this input is attached
124 * to suspends or resumes. Called from main context */
125 void (*suspend
) (pa_sink_input
*i
, pa_bool_t b
); /* may be NULL */
127 /* If non-NULL called whenever the the sink this input is attached
128 * to changes. Called from main context */
129 void (*moved
) (pa_sink_input
*i
); /* may be NULL */
131 /* Supposed to unlink and destroy this stream. Called from main
133 void (*kill
) (pa_sink_input
*i
); /* may be NULL */
135 /* Return the current latency (i.e. length of bufferd audio) of
136 this stream. Called from main context. If NULL a
137 PA_SINK_INPUT_MESSAGE_GET_LATENCY message is sent to the IO thread
139 pa_usec_t (*get_latency
) (pa_sink_input
*i
); /* may be NULL */
141 /* If non_NULL this function is called from thread context if the
142 * state changes. The old state is found in thread_info.state. */
143 void (*state_change
) (pa_sink_input
*i
, pa_sink_input_state_t state
); /* may be NULL */
146 pa_sink_input_state_t state
;
149 pa_bool_t attached
; /* True only between ->attach() and ->detach() calls */
151 pa_sample_spec sample_spec
;
153 pa_resampler
*resampler
; /* may be NULL */
155 /* We maintain a history of resampled audio data here. */
156 pa_memblockq
*render_memblockq
;
158 size_t rewrite_nbytes
;
159 pa_bool_t rewrite_flush
;
160 uint64_t underrun_for
, playing_for
;
162 pa_sink_input
*sync_prev
, *sync_next
;
167 /* The requested latency for the sink */
168 pa_usec_t requested_sink_latency
;
174 PA_DECLARE_CLASS(pa_sink_input
);
175 #define PA_SINK_INPUT(o) pa_sink_input_cast(o)
178 PA_SINK_INPUT_MESSAGE_SET_VOLUME
,
179 PA_SINK_INPUT_MESSAGE_SET_MUTE
,
180 PA_SINK_INPUT_MESSAGE_GET_LATENCY
,
181 PA_SINK_INPUT_MESSAGE_SET_RATE
,
182 PA_SINK_INPUT_MESSAGE_SET_STATE
,
183 PA_SINK_INPUT_MESSAGE_SET_REQUESTED_LATENCY
,
184 PA_SINK_INPUT_MESSAGE_GET_REQUESTED_LATENCY
,
185 PA_SINK_INPUT_MESSAGE_MAX
188 typedef struct pa_sink_input_new_data
{
189 pa_proplist
*proplist
;
197 pa_sample_spec sample_spec
;
198 pa_bool_t sample_spec_is_set
;
199 pa_channel_map channel_map
;
200 pa_bool_t channel_map_is_set
;
203 pa_bool_t volume_is_set
;
205 pa_bool_t muted_is_set
;
207 pa_resample_method_t resample_method
;
209 pa_sink_input
*sync_base
;
210 } pa_sink_input_new_data
;
212 pa_sink_input_new_data
* pa_sink_input_new_data_init(pa_sink_input_new_data
*data
);
213 void pa_sink_input_new_data_set_sample_spec(pa_sink_input_new_data
*data
, const pa_sample_spec
*spec
);
214 void pa_sink_input_new_data_set_channel_map(pa_sink_input_new_data
*data
, const pa_channel_map
*map
);
215 void pa_sink_input_new_data_set_volume(pa_sink_input_new_data
*data
, const pa_cvolume
*volume
);
216 void pa_sink_input_new_data_set_muted(pa_sink_input_new_data
*data
, pa_bool_t mute
);
217 void pa_sink_input_new_data_done(pa_sink_input_new_data
*data
);
219 typedef struct pa_sink_input_move_hook_data
{
220 pa_sink_input
*sink_input
;
221 pa_sink
*destination
;
222 } pa_sink_input_move_hook_data
;
224 /* To be called by the implementing module only */
226 pa_sink_input
* pa_sink_input_new(
228 pa_sink_input_new_data
*data
,
229 pa_sink_input_flags_t flags
);
231 void pa_sink_input_put(pa_sink_input
*i
);
232 void pa_sink_input_unlink(pa_sink_input
* i
);
234 void pa_sink_input_set_name(pa_sink_input
*i
, const char *name
);
236 pa_usec_t
pa_sink_input_set_requested_latency(pa_sink_input
*i
, pa_usec_t usec
);
238 /* Request that the specified number of bytes already written out to
239 the hw device is rewritten, if possible. Please note that this is
240 only a kind request. The sink driver may not be able to fulfill it
241 fully -- or at all. If the request for a rewrite was successful, the
242 sink driver will call ->rewind() and pass the number of bytes that
243 could be rewound in the HW device. This functionality is required for
244 implementing the "zero latency" write-through functionality. */
245 void pa_sink_input_request_rewind(pa_sink_input
*i
, size_t nbytes
, pa_bool_t rewrite
, pa_bool_t flush
);
247 void pa_sink_input_cork(pa_sink_input
*i
, pa_bool_t b
);
249 int pa_sink_input_set_rate(pa_sink_input
*i
, uint32_t rate
);
251 /* Callable by everyone from main thread*/
253 /* External code may request disconnection with this function */
254 void pa_sink_input_kill(pa_sink_input
*i
);
256 pa_usec_t
pa_sink_input_get_latency(pa_sink_input
*i
);
258 void pa_sink_input_set_volume(pa_sink_input
*i
, const pa_cvolume
*volume
);
259 const pa_cvolume
*pa_sink_input_get_volume(pa_sink_input
*i
);
260 void pa_sink_input_set_mute(pa_sink_input
*i
, pa_bool_t mute
);
261 int pa_sink_input_get_mute(pa_sink_input
*i
);
263 pa_resample_method_t
pa_sink_input_get_resample_method(pa_sink_input
*i
);
265 int pa_sink_input_move_to(pa_sink_input
*i
, pa_sink
*dest
);
267 pa_sink_input_state_t
pa_sink_input_get_state(pa_sink_input
*i
);
269 pa_usec_t
pa_sink_input_get_requested_latency(pa_sink_input
*i
);
271 /* To be used exclusively by the sink driver IO thread */
273 int pa_sink_input_peek(pa_sink_input
*i
, size_t length
, pa_memchunk
*chunk
, pa_cvolume
*volume
);
274 void pa_sink_input_drop(pa_sink_input
*i
, size_t length
);
275 void pa_sink_input_process_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */);
276 void pa_sink_input_update_max_rewind(pa_sink_input
*i
, size_t nbytes
/* in the sink's sample spec */);
278 void pa_sink_input_set_state_within_thread(pa_sink_input
*i
, pa_sink_input_state_t state
);
280 int pa_sink_input_process_msg(pa_msgobject
*o
, int code
, void *userdata
, int64_t offset
, pa_memchunk
*chunk
);
282 pa_usec_t
pa_sink_input_set_requested_latency_within_thread(pa_sink_input
*i
, pa_usec_t usec
);
284 pa_bool_t
pa_sink_input_safe_to_remove(pa_sink_input
*i
);
286 pa_memchunk
* pa_sink_input_get_silence(pa_sink_input
*i
, pa_memchunk
*ret
);