2 This file is part of PulseAudio.
4 Copyright 2004-2008 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as published
8 by the Free Software Foundation; either version 2.1 of the License,
9 or (at your option) any later version.
11 PulseAudio is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
35 #include <pulse/rtclock.h>
36 #include <pulse/timeval.h>
37 #include <pulse/xmalloc.h>
38 #include <pulse/i18n.h>
40 #include <pulsecore/macro.h>
41 #include <pulsecore/sink.h>
42 #include <pulsecore/module.h>
43 #include <pulsecore/core-rtclock.h>
44 #include <pulsecore/core-util.h>
45 #include <pulsecore/core-error.h>
46 #include <pulsecore/modargs.h>
47 #include <pulsecore/log.h>
48 #include <pulsecore/thread.h>
49 #include <pulsecore/thread-mq.h>
50 #include <pulsecore/rtpoll.h>
52 #include "module-null-sink-symdef.h"
54 PA_MODULE_AUTHOR("Lennart Poettering");
55 PA_MODULE_DESCRIPTION(_("Clocked NULL sink"));
56 PA_MODULE_VERSION(PACKAGE_VERSION
);
57 PA_MODULE_LOAD_ONCE(FALSE
);
59 "sink_name=<name of sink> "
60 "sink_properties=<properties for the sink> "
61 "format=<sample format> "
63 "channels=<number of channels> "
64 "channel_map=<channel map>");
66 #define DEFAULT_SINK_NAME "null"
67 #define BLOCK_USEC (PA_USEC_PER_SEC * 2)
75 pa_thread_mq thread_mq
;
82 static const char* const valid_modargs
[] = {
89 "description", /* supported for compatibility reasons, made redundant by sink_properties= */
93 static int sink_process_msg(
100 struct userdata
*u
= PA_SINK(o
)->userdata
;
103 case PA_SINK_MESSAGE_SET_STATE
:
105 if (PA_PTR_TO_UINT(data
) == PA_SINK_RUNNING
)
106 u
->timestamp
= pa_rtclock_now();
110 case PA_SINK_MESSAGE_GET_LATENCY
: {
113 now
= pa_rtclock_now();
114 *((pa_usec_t
*) data
) = u
->timestamp
> now
? u
->timestamp
- now
: 0ULL;
120 return pa_sink_process_msg(o
, code
, data
, offset
, chunk
);
123 static void sink_update_requested_latency_cb(pa_sink
*s
) {
127 pa_sink_assert_ref(s
);
128 pa_assert_se(u
= s
->userdata
);
130 u
->block_usec
= pa_sink_get_requested_latency_within_thread(s
);
132 if (u
->block_usec
== (pa_usec_t
) -1)
133 u
->block_usec
= s
->thread_info
.max_latency
;
135 nbytes
= pa_usec_to_bytes(u
->block_usec
, &s
->sample_spec
);
136 pa_sink_set_max_rewind_within_thread(s
, nbytes
);
137 pa_sink_set_max_request_within_thread(s
, nbytes
);
140 static void process_rewind(struct userdata
*u
, pa_usec_t now
) {
141 size_t rewind_nbytes
, in_buffer
;
146 /* Figure out how much we shall rewind and reset the counter */
147 rewind_nbytes
= u
->sink
->thread_info
.rewind_nbytes
;
148 u
->sink
->thread_info
.rewind_nbytes
= 0;
150 pa_assert(rewind_nbytes
> 0);
151 pa_log_debug("Requested to rewind %lu bytes.", (unsigned long) rewind_nbytes
);
153 if (u
->timestamp
<= now
)
156 delay
= u
->timestamp
- now
;
157 in_buffer
= pa_usec_to_bytes(delay
, &u
->sink
->sample_spec
);
162 if (rewind_nbytes
> in_buffer
)
163 rewind_nbytes
= in_buffer
;
165 pa_sink_process_rewind(u
->sink
, rewind_nbytes
);
166 u
->timestamp
-= pa_bytes_to_usec(rewind_nbytes
, &u
->sink
->sample_spec
);
168 pa_log_debug("Rewound %lu bytes.", (unsigned long) rewind_nbytes
);
173 pa_sink_process_rewind(u
->sink
, 0);
176 static void process_render(struct userdata
*u
, pa_usec_t now
) {
181 /* This is the configured latency. Sink inputs connected to us
182 might not have a single frame more than the maxrequest value
183 queed. Hence: at maximum read this many bytes from the sink
186 /* Fill the buffer up the the latency size */
187 while (u
->timestamp
< now
+ u
->block_usec
) {
190 pa_sink_render(u
->sink
, u
->sink
->thread_info
.max_request
, &chunk
);
191 pa_memblock_unref(chunk
.memblock
);
193 /* pa_log_debug("Ate %lu bytes.", (unsigned long) chunk.length); */
194 u
->timestamp
+= pa_bytes_to_usec(chunk
.length
, &u
->sink
->sample_spec
);
198 if (ate
>= u
->sink
->thread_info
.max_request
)
202 /* pa_log_debug("Ate in sum %lu bytes (of %lu)", (unsigned long) ate, (unsigned long) nbytes); */
205 static void thread_func(void *userdata
) {
206 struct userdata
*u
= userdata
;
210 pa_log_debug("Thread starting up");
212 pa_thread_mq_install(&u
->thread_mq
);
214 u
->timestamp
= pa_rtclock_now();
219 /* Render some data and drop it immediately */
220 if (PA_SINK_IS_OPENED(u
->sink
->thread_info
.state
)) {
223 now
= pa_rtclock_now();
225 if (u
->sink
->thread_info
.rewind_requested
) {
226 if (u
->sink
->thread_info
.rewind_nbytes
> 0)
227 process_rewind(u
, now
);
229 pa_sink_process_rewind(u
->sink
, 0);
232 if (u
->timestamp
<= now
)
233 process_render(u
, now
);
235 pa_rtpoll_set_timer_absolute(u
->rtpoll
, u
->timestamp
);
237 pa_rtpoll_set_timer_disabled(u
->rtpoll
);
239 /* Hmm, nothing to do. Let's sleep */
240 if ((ret
= pa_rtpoll_run(u
->rtpoll
, TRUE
)) < 0)
248 /* If this was no regular exit from the loop we have to continue
249 * processing messages until we received PA_MESSAGE_SHUTDOWN */
250 pa_asyncmsgq_post(u
->thread_mq
.outq
, PA_MSGOBJECT(u
->core
), PA_CORE_MESSAGE_UNLOAD_MODULE
, u
->module
, 0, NULL
, NULL
);
251 pa_asyncmsgq_wait_for(u
->thread_mq
.inq
, PA_MESSAGE_SHUTDOWN
);
254 pa_log_debug("Thread shutting down");
257 int pa__init(pa_module
*m
) {
258 struct userdata
*u
= NULL
;
261 pa_modargs
*ma
= NULL
;
262 pa_sink_new_data data
;
267 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
268 pa_log("Failed to parse module arguments.");
272 ss
= m
->core
->default_sample_spec
;
273 map
= m
->core
->default_channel_map
;
274 if (pa_modargs_get_sample_spec_and_channel_map(ma
, &ss
, &map
, PA_CHANNEL_MAP_DEFAULT
) < 0) {
275 pa_log("Invalid sample format specification or channel map");
279 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
282 u
->rtpoll
= pa_rtpoll_new();
283 pa_thread_mq_init(&u
->thread_mq
, m
->core
->mainloop
, u
->rtpoll
);
285 pa_sink_new_data_init(&data
);
286 data
.driver
= __FILE__
;
288 pa_sink_new_data_set_name(&data
, pa_modargs_get_value(ma
, "sink_name", DEFAULT_SINK_NAME
));
289 pa_sink_new_data_set_sample_spec(&data
, &ss
);
290 pa_sink_new_data_set_channel_map(&data
, &map
);
291 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_DESCRIPTION
, pa_modargs_get_value(ma
, "description", _("Null Output")));
292 pa_proplist_sets(data
.proplist
, PA_PROP_DEVICE_CLASS
, "abstract");
294 if (pa_modargs_get_proplist(ma
, "sink_properties", data
.proplist
, PA_UPDATE_REPLACE
) < 0) {
295 pa_log("Invalid properties");
296 pa_sink_new_data_done(&data
);
300 u
->sink
= pa_sink_new(m
->core
, &data
, PA_SINK_LATENCY
|PA_SINK_DYNAMIC_LATENCY
);
301 pa_sink_new_data_done(&data
);
304 pa_log("Failed to create sink object.");
308 u
->sink
->parent
.process_msg
= sink_process_msg
;
309 u
->sink
->update_requested_latency
= sink_update_requested_latency_cb
;
310 u
->sink
->userdata
= u
;
312 pa_sink_set_asyncmsgq(u
->sink
, u
->thread_mq
.inq
);
313 pa_sink_set_rtpoll(u
->sink
, u
->rtpoll
);
315 u
->block_usec
= BLOCK_USEC
;
316 nbytes
= pa_usec_to_bytes(u
->block_usec
, &u
->sink
->sample_spec
);
317 pa_sink_set_max_rewind(u
->sink
, nbytes
);
318 pa_sink_set_max_request(u
->sink
, nbytes
);
320 if (!(u
->thread
= pa_thread_new(thread_func
, u
))) {
321 pa_log("Failed to create thread.");
325 pa_sink_put(u
->sink
);
340 int pa__get_n_used(pa_module
*m
) {
344 pa_assert_se(u
= m
->userdata
);
346 return pa_sink_linked_by(u
->sink
);
349 void pa__done(pa_module
*m
) {
354 if (!(u
= m
->userdata
))
358 pa_sink_unlink(u
->sink
);
361 pa_asyncmsgq_send(u
->thread_mq
.inq
, NULL
, PA_MESSAGE_SHUTDOWN
, NULL
, 0, NULL
);
362 pa_thread_free(u
->thread
);
365 pa_thread_mq_done(&u
->thread_mq
);
368 pa_sink_unref(u
->sink
);
371 pa_rtpoll_free(u
->rtpoll
);