gdb: Fix building against api level 21
[termux-packages] / packages / libpulseaudio / module-sles-sink.c
CommitLineData
674a9bc3 1/***
2 This file is part of PulseAudio.
3
4 Copyright 2004-2008 Lennart Poettering
5
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.
10
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.
15
16 You should have received a copy of the GNU Lesser General Public License
17 along with PulseAudio; if not, see <http://www.gnu.org/licenses/>.
18***/
19
20#ifdef HAVE_CONFIG_H
21#include <config.h>
22#endif
23
24#include <stdlib.h>
25#include <stdio.h>
26#include <errno.h>
27#include <unistd.h>
28
29#include <pulse/rtclock.h>
30#include <pulse/timeval.h>
31#include <pulse/xmalloc.h>
32
33#include <pulsecore/i18n.h>
34#include <pulsecore/macro.h>
35#include <pulsecore/sink.h>
36#include <pulsecore/module.h>
37#include <pulsecore/core-util.h>
38#include <pulsecore/modargs.h>
39#include <pulsecore/log.h>
40#include <pulsecore/thread.h>
41#include <pulsecore/thread-mq.h>
42#include <pulsecore/rtpoll.h>
43
44#include <SLES/OpenSLES.h>
45
46#include "module-sles-sink-symdef.h"
47
48#ifdef USE_ANDROID_SIMPLE_BUFFER_QUEUE
1c285bb8 49 #include <SLES/OpenSLES_Android.h>
50 #define DATALOCATOR_BUFFERQUEUE SL_DATALOCATOR_ANDROIDSIMPLEBUFFERQUEUE
51 #define IID_BUFFERQUEUE SL_IID_ANDROIDSIMPLEBUFFERQUEUE
52 #define BufferQueueItf SLAndroidSimpleBufferQueueItf
53 #define BufferQueueState SLAndroidSimpleBufferQueueState
54 #define IID_BUFFERQUEUE_USED SL_IID_ANDROIDSIMPLEBUFFERQUEUE
55 #define INDEX index
674a9bc3 56#else
1c285bb8 57 #define DATALOCATOR_BUFFERQUEUE SL_DATALOCATOR_BUFFERQUEUE
58 #define IID_BUFFERQUEUE SL_IID_BUFFERQUEUE
59 #define BufferQueueItf SLBufferQueueItf
60 #define BufferQueueState SLBufferQueueState
61 #define IID_BUFFERQUEUE_USED IID_BUFFERQUEUE
62 #define INDEX playIndex
674a9bc3 63#endif
64
65#define checkResult(r) do { \
66 if ((r) != SL_RESULT_SUCCESS) { \
67 if ((r) == SL_RESULT_PARAMETER_INVALID) fprintf(stderr, "error SL_RESULT_PARAMETER_INVALID at %s:%d\n", __FILE__, __LINE__); \
68 else if ((r) == SL_RESULT_PRECONDITIONS_VIOLATED ) fprintf(stderr, "error SL_RESULT_PRECONDITIONS_VIOLATED at %s:%d\n", __FILE__, __LINE__); \
69 else fprintf(stderr, "error %d at %s:%d\n", (int) r, __FILE__, __LINE__); \
70 } \
71 } while (0)
72typedef struct {
73 short left;
74 short right;
75} frame_t;
76
77PA_MODULE_AUTHOR("Lennart Poettering, Nathan Martynov");
78PA_MODULE_DESCRIPTION("Android OpenSL ES sink");
79PA_MODULE_VERSION(PACKAGE_VERSION);
80PA_MODULE_LOAD_ONCE(false);
81PA_MODULE_USAGE(
82 "sink_name=<name for the sink> "
1c285bb8 83 "sink_properties=<properties for the sink> "
84 "rate=<sampling rate> ");
674a9bc3 85
86#define DEFAULT_SINK_NAME "OpenSL ES sink"
87#define BLOCK_USEC (PA_USEC_PER_SEC * 2)
88
89struct userdata {
90 pa_core *core;
91 pa_module *module;
92 pa_sink *sink;
93
94 pa_thread *thread;
95 pa_thread_mq thread_mq;
96 pa_rtpoll *rtpoll;
97
98 pa_usec_t block_usec;
99 pa_usec_t timestamp;
100
101 pa_memchunk memchunk;
102
103 SLObjectItf engineObject;
104 SLEngineItf engineEngine;
105
106 // output mix interfaces
107 SLObjectItf outputMixObject;
108
109 // buffer queue player interfaces
110 SLObjectItf bqPlayerObject;
111 SLPlayItf bqPlayerPlay;
112 BufferQueueItf bqPlayerBufferQueue;
113};
114
115static const char* const valid_modargs[] = {
116 "sink_name",
117 "sink_properties",
1c285bb8 118 "rate",
674a9bc3 119 NULL
120};
121
122static int sink_process_msg(
123 pa_msgobject *o,
124 int code,
125 void *data,
126 int64_t offset,
127 pa_memchunk *chunk) {
128
129 struct userdata *u = PA_SINK(o)->userdata;
130
131 switch (code) {
132 case PA_SINK_MESSAGE_SET_STATE:
133
134 if (pa_sink_get_state(u->sink) == PA_SINK_SUSPENDED || pa_sink_get_state(u->sink) == PA_SINK_INIT) {
135 if (PA_PTR_TO_UINT(data) == PA_SINK_RUNNING || PA_PTR_TO_UINT(data) == PA_SINK_IDLE)
136 u->timestamp = pa_rtclock_now();
137 }
138
139 break;
140
141 case PA_SINK_MESSAGE_GET_LATENCY: {
142 pa_usec_t now;
143
144 now = pa_rtclock_now();
145 *((pa_usec_t*) data) = u->timestamp > now ? u->timestamp - now : 0ULL;
146
147 return 0;
148 }
149 }
150
151 return pa_sink_process_msg(o, code, data, offset, chunk);
152}
153
154static void sink_update_requested_latency_cb(pa_sink *s) {
155 struct userdata *u;
156 size_t nbytes;
157
158 pa_sink_assert_ref(s);
159 pa_assert_se(u = s->userdata);
160
161 u->block_usec = pa_sink_get_requested_latency_within_thread(s);
162
163 if (u->block_usec == (pa_usec_t) -1)
164 u->block_usec = s->thread_info.max_latency;
165
166 nbytes = pa_usec_to_bytes(u->block_usec, &s->sample_spec);
167 pa_sink_set_max_rewind_within_thread(s, nbytes);
168 pa_sink_set_max_request_within_thread(s, nbytes);
169}
170
1c285bb8 171static int pa_init_sles_player(struct userdata *s, SLint32 sl_rate)
674a9bc3 172{
1c285bb8 173 if (s == NULL) return -1;
674a9bc3 174 SLresult result;
175
176 // create engine
177 result = slCreateEngine(&(s->engineObject), 0, NULL, 0, NULL, NULL); checkResult(result);
178 result = (*s->engineObject)->Realize(s->engineObject, SL_BOOLEAN_FALSE); checkResult(result);
179
180 result = (*s->engineObject)->GetInterface(s->engineObject, SL_IID_ENGINE, &(s->engineEngine)); checkResult(result);
181
182 // create output mix
183 result = (*s->engineEngine)->CreateOutputMix(s->engineEngine, &(s->outputMixObject), 0, NULL, NULL); checkResult(result);
184 result = (*s->outputMixObject)->Realize(s->outputMixObject, SL_BOOLEAN_FALSE); checkResult(result);
185
186 // create audio player
187
188 SLDataLocator_OutputMix locator_outputmix;
189 locator_outputmix.locatorType = SL_DATALOCATOR_OUTPUTMIX;
190 locator_outputmix.outputMix = s->outputMixObject;
191
192 SLDataLocator_BufferQueue locator_bufferqueue;
193 locator_bufferqueue.locatorType = DATALOCATOR_BUFFERQUEUE;
194 locator_bufferqueue.numBuffers = 50;
195
1c285bb8 196 if (sl_rate < 0) {
197 pa_log("Incompatible sample rate");
198 return -1;
199 }
200
674a9bc3 201 SLDataFormat_PCM pcm;
202 pcm.formatType = SL_DATAFORMAT_PCM;
203 pcm.numChannels = 2;
1c285bb8 204 pcm.samplesPerSec = sl_rate;
674a9bc3 205 pcm.bitsPerSample = SL_PCMSAMPLEFORMAT_FIXED_16;
206 pcm.containerSize = 16;
207 pcm.channelMask = SL_SPEAKER_FRONT_LEFT | SL_SPEAKER_FRONT_RIGHT;
208 pcm.endianness = SL_BYTEORDER_LITTLEENDIAN;
209
210 SLDataSource audiosrc;
211 audiosrc.pLocator = &locator_bufferqueue;
212 audiosrc.pFormat = &pcm;
213
214 SLDataSink audiosnk;
215 audiosnk.pLocator = &locator_outputmix;
216 audiosnk.pFormat = NULL;
217
218 SLInterfaceID ids[1] = {IID_BUFFERQUEUE};
219 SLboolean flags[1] = {SL_BOOLEAN_TRUE};
220 result = (*s->engineEngine)->CreateAudioPlayer(s->engineEngine, &s->bqPlayerObject, &audiosrc, &audiosnk, 1, ids, flags); checkResult(result);
221 result = (*s->bqPlayerObject)->Realize(s->bqPlayerObject, SL_BOOLEAN_FALSE); checkResult(result);
222
223 result = (*s->bqPlayerObject)->GetInterface(s->bqPlayerObject, SL_IID_PLAY, &s->bqPlayerPlay); checkResult(result);
224 result = (*s->bqPlayerObject)->GetInterface(s->bqPlayerObject, IID_BUFFERQUEUE_USED, &s->bqPlayerBufferQueue); checkResult(result);
225
226 result = (*s->bqPlayerPlay)->SetPlayState(s->bqPlayerPlay, SL_PLAYSTATE_PLAYING); checkResult(result);
1c285bb8 227 return 0;
674a9bc3 228}
229
1c285bb8 230static void pa_destroy_sles_player(struct userdata *s){
674a9bc3 231 if (s == NULL) return;
232 (*s->bqPlayerPlay)->SetPlayState(s->bqPlayerPlay, SL_PLAYSTATE_STOPPED);
233 (*s->bqPlayerObject)->Destroy(s->bqPlayerObject);
234 (*s->outputMixObject)->Destroy(s->outputMixObject);
235 (*s->engineObject)->Destroy(s->engineObject);
236}
237
238static void process_render(struct userdata *u, pa_usec_t now) {
239 size_t ate = 0;
240
241 pa_assert(u);
242
243 /* This is the configured latency. Sink inputs connected to us
244 might not have a single frame more than the maxrequest value
245 queued. Hence: at maximum read this many bytes from the sink
246 inputs. */
247
248 /* Fill the buffer up the latency size */
249 while (u->timestamp < now + u->block_usec) {
250 void *p;
251
252 pa_sink_render(u->sink, u->sink->thread_info.max_request, &u->memchunk);
253 p = pa_memblock_acquire(u->memchunk.memblock);
254 (*u->bqPlayerBufferQueue)->Enqueue(u->bqPlayerBufferQueue, (uint8_t*) p + u->memchunk.index, u->memchunk.length);
255 pa_memblock_release(u->memchunk.memblock);
256
674a9bc3 257 u->timestamp += pa_bytes_to_usec(u->memchunk.length, &u->sink->sample_spec);
674a9bc3 258 ate += u->memchunk.length;
1c285bb8 259 if (ate >= u->sink->thread_info.max_request) break;
674a9bc3 260 }
674a9bc3 261}
262
263static void thread_func(void *userdata) {
264 struct userdata *u = userdata;
265
266 pa_assert(u);
267
268 pa_log_debug("Thread starting up");
269
270 pa_thread_mq_install(&u->thread_mq);
271
272 u->timestamp = pa_rtclock_now();
273
274 for (;;) {
275 pa_usec_t now = 0;
276 int ret;
277
278 if (PA_SINK_IS_OPENED(u->sink->thread_info.state))
279 now = pa_rtclock_now();
280
281 if (PA_UNLIKELY(u->sink->thread_info.rewind_requested))
282 pa_sink_process_rewind(u->sink, 0);
283
284 /* Render some data and drop it immediately */
285 if (PA_SINK_IS_OPENED(u->sink->thread_info.state)) {
286 if (u->timestamp <= now)
287 process_render(u, now);
288
289 pa_rtpoll_set_timer_absolute(u->rtpoll, u->timestamp);
290 } else
291 pa_rtpoll_set_timer_disabled(u->rtpoll);
292
293 /* Hmm, nothing to do. Let's sleep */
294 if ((ret = pa_rtpoll_run(u->rtpoll)) < 0)
295 goto fail;
296
297 if (ret == 0)
298 goto finish;
299 }
300
301fail:
302 /* If this was no regular exit from the loop we have to continue
303 * processing messages until we received PA_MESSAGE_SHUTDOWN */
304 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module, 0, NULL, NULL);
305 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
306
307finish:
308 pa_log_debug("Thread shutting down");
309}
1c285bb8 310
311static SLint32 PA2SLrate(int32_t rate){
312 if (!(rate >= 8000 && rate <= 192000)) return -1;
313 switch(rate){
314 case 8000:
315 return SL_SAMPLINGRATE_8;
316 case 11025:
317 return SL_SAMPLINGRATE_11_025;
318 case 12000:
319 return SL_SAMPLINGRATE_12;
320 case 16000:
321 return SL_SAMPLINGRATE_16;
322 case 22050:
323 return SL_SAMPLINGRATE_22_05;
324 case 24000:
325 return SL_SAMPLINGRATE_24;
326 case 32000:
327 return SL_SAMPLINGRATE_32;
328 case 44100:
329 return SL_SAMPLINGRATE_44_1;
330 case 48000:
331 return SL_SAMPLINGRATE_48;
332 case 64000:
333 return SL_SAMPLINGRATE_64;
334 case 88200:
335 return SL_SAMPLINGRATE_88_2;
336 case 96000:
337 return SL_SAMPLINGRATE_96;
338 case 192000:
339 return SL_SAMPLINGRATE_192;
340 default:
341 return -1;
342 }
343}
674a9bc3 344
345int pa__init(pa_module*m) {
346 struct userdata *u = NULL;
347 pa_sample_spec ss;
348 pa_channel_map map;
349 pa_modargs *ma = NULL;
350 pa_sink_new_data data;
351 size_t nbytes;
352
353 pa_assert(m);
354
355 if (!(ma = pa_modargs_new(m->argument, valid_modargs))) {
356 pa_log("Failed to parse module arguments.");
357 goto fail;
358 }
359
360 // High rate causes glitches on some devices, this is needed to prevent it
1c285bb8 361 //ss.rate = 32000;
362 //ss.channels = 2;
363 //ss.format = PA_SAMPLE_S16LE;
364
365 //OK. That will allow users to define sampling rate under his responsibility
366 ss = m->core->default_sample_spec;
674a9bc3 367 map = m->core->default_channel_map;
1c285bb8 368 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
369 pa_log("Invalid sample format specification or channel map");
370 goto fail;
371 }
674a9bc3 372
1c285bb8 373 //Needed. Don't touch
374 ss.channels = 2;
375 ss.format = PA_SAMPLE_S16LE;
376 int forceFormat = atoi(getenv("PROPERTY_OUTPUT_SAMPLE_RATE"));
377 if (forceFormat >= 8000 && forceFormat <= 192000)
378 ss.rate = forceFormat;
379
674a9bc3 380 m->userdata = u = pa_xnew0(struct userdata, 1);
381 u->core = m->core;
382 u->module = m;
383 u->rtpoll = pa_rtpoll_new();
384 pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll);
385
1c285bb8 386 if (pa_init_sles_player(u, PA2SLrate(ss.rate)) < 0)
387 goto fail;
674a9bc3 388 int buff[2] = {0, 0};
389 (*u->bqPlayerBufferQueue)->Enqueue(u->bqPlayerBufferQueue, buff, 1);
390
391 pa_sink_new_data_init(&data);
392 data.driver = __FILE__;
393 data.module = m;
394 pa_sink_new_data_set_name(&data, pa_modargs_get_value(ma, "sink_name", DEFAULT_SINK_NAME));
395 pa_sink_new_data_set_sample_spec(&data, &ss);
396 pa_sink_new_data_set_channel_map(&data, &map);
1c285bb8 397 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_DESCRIPTION, _("OpenSL ES Output"));
674a9bc3 398 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_CLASS, "abstract");
399
400 if (pa_modargs_get_proplist(ma, "sink_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
401 pa_log("Invalid properties");
402 pa_sink_new_data_done(&data);
403 goto fail;
404 }
405
406 u->sink = pa_sink_new(m->core, &data, PA_SINK_LATENCY|PA_SINK_DYNAMIC_LATENCY);
407 pa_sink_new_data_done(&data);
408
409 if (!u->sink) {
410 pa_log("Failed to create sink object.");
411 goto fail;
412 }
413
414 u->sink->parent.process_msg = sink_process_msg;
415 u->sink->update_requested_latency = sink_update_requested_latency_cb;
416 u->sink->userdata = u;
417
418 pa_sink_set_asyncmsgq(u->sink, u->thread_mq.inq);
419 pa_sink_set_rtpoll(u->sink, u->rtpoll);
420
421 u->block_usec = BLOCK_USEC;
422 nbytes = pa_usec_to_bytes(u->block_usec, &u->sink->sample_spec);
423 pa_sink_set_max_rewind(u->sink, nbytes);
424 pa_sink_set_max_request(u->sink, nbytes);
425
1c285bb8 426 if (!(u->thread = pa_thread_new("sles-sink", thread_func, u))) {
674a9bc3 427 pa_log("Failed to create thread.");
428 goto fail;
429 }
430
431 pa_sink_set_latency_range(u->sink, 0, BLOCK_USEC);
432
433 pa_sink_put(u->sink);
434
435 pa_modargs_free(ma);
436
437 return 0;
438
439fail:
440 if (ma)
441 pa_modargs_free(ma);
442
443 pa__done(m);
444
445 return -1;
446}
447
448int pa__get_n_used(pa_module *m) {
449 struct userdata *u;
450
451 pa_assert(m);
452 pa_assert_se(u = m->userdata);
453
454 return pa_sink_linked_by(u->sink);
455}
456
457void pa__done(pa_module*m) {
458 struct userdata *u;
459
460 pa_assert(m);
461
462 if (!(u = m->userdata))
463 return;
464
465 if (u->sink)
466 pa_sink_unlink(u->sink);
467
468 if (u->thread) {
469 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
470 pa_thread_free(u->thread);
471 }
472
473 pa_thread_mq_done(&u->thread_mq);
474
475 if (u->sink)
476 pa_sink_unref(u->sink);
477
478 if (u->rtpoll)
479 pa_rtpoll_free(u->rtpoll);
480
481 pa_xfree(u);
482}