1 /*
2 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16
17 #include <config.h>
18 #include <pulse/rtclock.h>
19 #include <pulse/timeval.h>
20 #include <pulse/util.h>
21 #include <pulse/xmalloc.h>
22 #include <pulsecore/core.h>
23 #include <pulsecore/log.h>
24 #include <pulsecore/memchunk.h>
25 #include <pulsecore/modargs.h>
26 #include <pulsecore/module.h>
27 #include <pulsecore/rtpoll.h>
28 #include <pulsecore/thread-mq.h>
29 #include <pulsecore/thread.h>
30
31 #include <inttypes.h>
32 #include <stddef.h>
33 #include <stdint.h>
34 #include <stdbool.h>
35
36 #include "audio_types.h"
37 #include "audio_manager.h"
38
39 #include "audio_log.h"
40 #include "audio_source_type.h"
41 #include "capturer_source_adapter.h"
42
43 #define DEFAULT_SOURCE_NAME "hdi_input"
44 #define DEFAULT_DEVICE_CLASS "primary"
45 #define DEFAULT_AUDIO_DEVICE_NAME "Internal Mic"
46 #define DEFAULT_DEVICE_NETWORKID "LocalDevice"
47
48 #define DEFAULT_BUFFER_SIZE (1024 * 16)
49 #define MAX_VOLUME_VALUE 15.0
50 #define DEFAULT_LEFT_VOLUME MAX_VOLUME_VALUE
51 #define DEFAULT_RIGHT_VOLUME MAX_VOLUME_VALUE
52 #define MAX_LATENCY_USEC (PA_USEC_PER_SEC * 2)
53 #define MIN_LATENCY_USEC 500
54 #define AUDIO_POINT_NUM 1024
55 #define AUDIO_FRAME_NUM_IN_BUF 30
56
57 const char *DEVICE_CLASS_REMOTE = "remote";
58
59 struct Userdata {
60 pa_core *core;
61 pa_module *module;
62 pa_source *source;
63 pa_thread *thread;
64 pa_thread_mq thread_mq;
65 pa_rtpoll *rtpoll;
66 uint32_t buffer_size;
67 uint32_t open_mic_speaker;
68 pa_usec_t block_usec;
69 pa_usec_t timestamp;
70 SourceAttr attrs;
71 bool IsCapturerStarted;
72 struct CapturerSourceAdapter *sourceAdapter;
73 };
74
75 static int PaHdiCapturerInit(struct Userdata *u);
76 static void PaHdiCapturerExit(struct Userdata *u);
77
GetStateInfo(pa_source_state_t state)78 static char *GetStateInfo(pa_source_state_t state)
79 {
80 switch (state) {
81 case PA_SOURCE_INVALID_STATE:
82 return "INVALID";
83 case PA_SOURCE_RUNNING:
84 return "RUNNING";
85 case PA_SOURCE_IDLE:
86 return "IDLE";
87 case PA_SOURCE_SUSPENDED:
88 return "SUSPENDED";
89 case PA_SOURCE_INIT:
90 return "INIT";
91 case PA_SOURCE_UNLINKED:
92 return "UNLINKED";
93 default:
94 return "error state";
95 }
96 }
97
UserdataFree(struct Userdata * u)98 static void UserdataFree(struct Userdata *u)
99 {
100 pa_assert(u);
101 if (u->source) {
102 pa_source_unlink(u->source);
103 }
104
105 if (u->thread) {
106 pa_asyncmsgq_send(u->thread_mq.inq, NULL, PA_MESSAGE_SHUTDOWN, NULL, 0, NULL);
107 pa_thread_free(u->thread);
108 }
109
110 pa_thread_mq_done(&u->thread_mq);
111
112 if (u->source) {
113 pa_source_unref(u->source);
114 }
115
116 if (u->rtpoll) {
117 pa_rtpoll_free(u->rtpoll);
118 }
119
120 if (u->sourceAdapter) {
121 u->sourceAdapter->CapturerSourceStop(u->sourceAdapter->wapper);
122 u->sourceAdapter->CapturerSourceDeInit(u->sourceAdapter->wapper);
123 UnLoadSourceAdapter(u->sourceAdapter);
124 }
125
126 pa_xfree(u);
127 }
128
SourceProcessMsg(pa_msgobject * o,int code,void * data,int64_t offset,pa_memchunk * chunk)129 static int SourceProcessMsg(pa_msgobject *o, int code, void *data, int64_t offset, pa_memchunk *chunk)
130 {
131 struct Userdata *u = PA_SOURCE(o)->userdata;
132 pa_assert(u);
133
134 switch (code) {
135 case PA_SOURCE_MESSAGE_GET_LATENCY: {
136 pa_usec_t now;
137 now = pa_rtclock_now();
138 *((int64_t*)data) = (int64_t)now - (int64_t)u->timestamp;
139 return 0;
140 }
141 default: {
142 pa_log("SourceProcessMsg default case");
143 return pa_source_process_msg(o, code, data, offset, chunk);
144 }
145 }
146 }
147
148 /* Called from the IO thread. */
SourceSetStateInIoThreadCb(pa_source * s,pa_source_state_t newState,pa_suspend_cause_t newSuspendCause)149 static int SourceSetStateInIoThreadCb(pa_source *s, pa_source_state_t newState,
150 pa_suspend_cause_t newSuspendCause)
151 {
152 struct Userdata *u = NULL;
153 pa_assert(s);
154 pa_assert_se(u = s->userdata);
155 AUDIO_INFO_LOG("Source[%{public}s] state change:[%{public}s]-->[%{public}s]",
156 GetDeviceClass(u->sourceAdapter->deviceClass), GetStateInfo(s->thread_info.state), GetStateInfo(newState));
157
158 if ((s->thread_info.state == PA_SOURCE_SUSPENDED || s->thread_info.state == PA_SOURCE_INIT) &&
159 PA_SOURCE_IS_OPENED(newState)) {
160 u->timestamp = pa_rtclock_now();
161 if (newState == PA_SOURCE_RUNNING && !u->IsCapturerStarted) {
162 if (u->sourceAdapter->CapturerSourceStart(u->sourceAdapter->wapper)) {
163 AUDIO_ERR_LOG("HDI capturer start failed");
164 return -PA_ERR_IO;
165 }
166 u->IsCapturerStarted = true;
167 AUDIO_DEBUG_LOG("Successfully started HDI capturer");
168 }
169 } else if (s->thread_info.state == PA_SOURCE_IDLE) {
170 if (newState == PA_SOURCE_SUSPENDED) {
171 if (u->IsCapturerStarted) {
172 u->sourceAdapter->CapturerSourceStop(u->sourceAdapter->wapper);
173 u->IsCapturerStarted = false;
174 AUDIO_DEBUG_LOG("Stopped HDI capturer");
175 }
176 } else if (newState == PA_SOURCE_RUNNING && !u->IsCapturerStarted) {
177 AUDIO_DEBUG_LOG("Idle to Running starting HDI capturing device");
178 if (u->sourceAdapter->CapturerSourceStart(u->sourceAdapter->wapper)) {
179 AUDIO_ERR_LOG("Idle to Running HDI capturer start failed");
180 return -PA_ERR_IO;
181 }
182 u->IsCapturerStarted = true;
183 AUDIO_DEBUG_LOG("Idle to Running: Successfully reinitialized HDI renderer");
184 }
185 }
186
187 return 0;
188 }
189
GetCapturerFrameFromHdi(pa_memchunk * chunk,const struct Userdata * u)190 static int GetCapturerFrameFromHdi(pa_memchunk *chunk, const struct Userdata *u)
191 {
192 uint64_t requestBytes;
193 uint64_t replyBytes = 0;
194 void *p = NULL;
195
196 chunk->length = u->buffer_size;
197 AUDIO_DEBUG_LOG("HDI Source: chunk.length = u->buffer_size: %{public}zu", chunk->length);
198 chunk->memblock = pa_memblock_new(u->core->mempool, chunk->length);
199 pa_assert(chunk->memblock);
200 p = pa_memblock_acquire(chunk->memblock);
201 pa_assert(p);
202
203 requestBytes = pa_memblock_get_length(chunk->memblock);
204 u->sourceAdapter->CapturerSourceFrame(u->sourceAdapter->wapper, (char *)p, (uint64_t)requestBytes, &replyBytes);
205
206 pa_memblock_release(chunk->memblock);
207 AUDIO_DEBUG_LOG("HDI Source: request bytes: %{public}" PRIu64 ", replyBytes: %{public}" PRIu64,
208 requestBytes, replyBytes);
209 if (replyBytes > requestBytes) {
210 AUDIO_ERR_LOG("HDI Source: Error replyBytes > requestBytes. Requested data Length: "
211 "%{public}" PRIu64 ", Read: %{public}" PRIu64 " bytes", requestBytes, replyBytes);
212 pa_memblock_unref(chunk->memblock);
213 return 0;
214 }
215
216 if (replyBytes == 0) {
217 AUDIO_ERR_LOG("HDI Source: Failed to read, Requested data Length: %{public}" PRIu64 " bytes,"
218 " Read: %{public}" PRIu64 " bytes", requestBytes, replyBytes);
219 pa_memblock_unref(chunk->memblock);
220 return 0;
221 }
222
223 chunk->index = 0;
224 chunk->length = replyBytes;
225 pa_source_post(u->source, chunk);
226 pa_memblock_unref(chunk->memblock);
227
228 return 0;
229 }
230
PaRtpollSetTimerFunc(struct Userdata * u,bool timerElapsed)231 static bool PaRtpollSetTimerFunc(struct Userdata *u, bool timerElapsed)
232 {
233 if (!(PA_SOURCE_IS_OPENED(u->source->thread_info.state) && u->IsCapturerStarted)) {
234 pa_rtpoll_set_timer_disabled(u->rtpoll);
235 AUDIO_DEBUG_LOG("HDI Source: pa_rtpoll_set_timer_disabled done ");
236 return true;
237 }
238 pa_memchunk chunk;
239 pa_usec_t now;
240
241 now = pa_rtclock_now();
242 AUDIO_DEBUG_LOG("HDI Source: now: %{public}" PRIu64 " timerElapsed: %{public}d", now, timerElapsed);
243
244 if (timerElapsed) {
245 chunk.length = pa_usec_to_bytes(now - u->timestamp, &u->source->sample_spec);
246 if (chunk.length > 0) {
247 int ret = GetCapturerFrameFromHdi(&chunk, u);
248 if (ret != 0) {
249 return false;
250 }
251
252 u->timestamp += pa_bytes_to_usec(chunk.length, &u->source->sample_spec);
253 AUDIO_DEBUG_LOG("HDI Source: new u->timestamp : %{public}" PRIu64, u->timestamp);
254 }
255 }
256
257 pa_rtpoll_set_timer_absolute(u->rtpoll, u->timestamp + u->block_usec);
258 return true;
259 }
260
ThreadFuncCapturerTimer(void * userdata)261 static void ThreadFuncCapturerTimer(void *userdata)
262 {
263 struct Userdata *u = userdata;
264 bool timerElapsed = false;
265
266 pa_assert(u);
267
268 if (u->core->realtime_scheduling) {
269 pa_thread_make_realtime(u->core->realtime_priority);
270 }
271
272 pa_thread_mq_install(&u->thread_mq);
273 u->timestamp = pa_rtclock_now();
274 AUDIO_DEBUG_LOG("HDI Source: u->timestamp : %{public}" PRIu64, u->timestamp);
275
276 while (true) {
277 bool result = PaRtpollSetTimerFunc(u, timerElapsed);
278 if (!result) {
279 break;
280 }
281 /* Hmm, nothing to do. Let's sleep */
282 int ret = pa_rtpoll_run(u->rtpoll);
283 if (ret < 0) {
284 /* If this was no regular exit from the loop we have to continue
285 * processing messages until we received PA_MESSAGE_SHUTDOWN */
286 AUDIO_ERR_LOG("HDI Source: pa_rtpoll_run ret:%{public}d failed", ret);
287 pa_asyncmsgq_post(u->thread_mq.outq, PA_MSGOBJECT(u->core), PA_CORE_MESSAGE_UNLOAD_MODULE, u->module,
288 0, NULL, NULL);
289 pa_asyncmsgq_wait_for(u->thread_mq.inq, PA_MESSAGE_SHUTDOWN);
290 return;
291 }
292
293 timerElapsed = pa_rtpoll_timer_elapsed(u->rtpoll);
294
295 if (ret == 0) {
296 return;
297 }
298 }
299 }
300
PaHdiCapturerInit(struct Userdata * u)301 static int PaHdiCapturerInit(struct Userdata *u)
302 {
303 int ret;
304 ret = u->sourceAdapter->CapturerSourceInit(u->sourceAdapter->wapper, &u->attrs);
305 if (ret != 0) {
306 AUDIO_ERR_LOG("Audio capturer init failed!");
307 return ret;
308 }
309
310 // No start test for remote device.
311 if (strcmp(GetDeviceClass(u->sourceAdapter->deviceClass), DEVICE_CLASS_REMOTE)) {
312 ret = u->sourceAdapter->CapturerSourceStart(u->sourceAdapter->wapper);
313 if (ret != 0) {
314 AUDIO_ERR_LOG("Audio capturer start failed!");
315 goto fail;
316 }
317 }
318
319 u->IsCapturerStarted = true;
320 return ret;
321
322 fail:
323 PaHdiCapturerExit(u);
324 return ret;
325 }
326
PaHdiCapturerExit(struct Userdata * u)327 static void PaHdiCapturerExit(struct Userdata *u)
328 {
329 u->sourceAdapter->CapturerSourceStop(u->sourceAdapter->wapper);
330 u->sourceAdapter->CapturerSourceDeInit(u->sourceAdapter->wapper);
331 }
332
PaSetSourceProperties(pa_module * m,pa_modargs * ma,const pa_sample_spec * ss,const pa_channel_map * map,struct Userdata * u)333 static int PaSetSourceProperties(pa_module *m, pa_modargs *ma, const pa_sample_spec *ss, const pa_channel_map *map,
334 struct Userdata *u)
335 {
336 pa_source_new_data data;
337
338 if (pa_modargs_get_value_u32(ma, "buffer_size", &u->buffer_size) < 0) {
339 AUDIO_INFO_LOG("Failed to parse buffer_size argument.");
340 u->buffer_size = DEFAULT_BUFFER_SIZE;
341 }
342 pa_source_new_data_init(&data);
343 data.driver = __FILE__;
344 data.module = m;
345 pa_source_new_data_set_name(&data, pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME));
346 pa_proplist_sets(data.proplist, PA_PROP_DEVICE_STRING,
347 (u->attrs.adapterName ? u->attrs.adapterName : DEFAULT_AUDIO_DEVICE_NAME));
348 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_DESCRIPTION, "HDI source is %s",
349 (u->attrs.adapterName ? u->attrs.adapterName : DEFAULT_AUDIO_DEVICE_NAME));
350 pa_source_new_data_set_sample_spec(&data, ss);
351 pa_source_new_data_set_channel_map(&data, map);
352 pa_proplist_setf(data.proplist, PA_PROP_DEVICE_BUFFERING_BUFFER_SIZE, "%lu", (unsigned long)u->buffer_size);
353
354 if (pa_modargs_get_proplist(ma, "source_properties", data.proplist, PA_UPDATE_REPLACE) < 0) {
355 AUDIO_ERR_LOG("Invalid properties");
356 pa_source_new_data_done(&data);
357 return -1;
358 }
359
360 u->source = pa_source_new(m->core, &data, PA_SOURCE_HARDWARE | PA_SOURCE_LATENCY);
361 pa_source_new_data_done(&data);
362
363 if (!u->source) {
364 AUDIO_ERR_LOG("Failed to create source object");
365 return -1;
366 }
367
368 u->source->parent.process_msg = SourceProcessMsg;
369 u->source->set_state_in_io_thread = SourceSetStateInIoThreadCb;
370 u->source->userdata = u;
371
372 pa_source_set_asyncmsgq(u->source, u->thread_mq.inq);
373 pa_source_set_rtpoll(u->source, u->rtpoll);
374
375 u->block_usec = pa_bytes_to_usec(u->buffer_size, &u->source->sample_spec);
376 pa_source_set_latency_range(u->source, 0, u->block_usec);
377 u->source->thread_info.max_rewind = pa_usec_to_bytes(u->block_usec, &u->source->sample_spec);
378
379 return 0;
380 }
381
ConvertToHDIAudioFormat(pa_sample_format_t format)382 static enum AudioFormat ConvertToHDIAudioFormat(pa_sample_format_t format)
383 {
384 enum AudioFormat hdiAudioFormat;
385 switch (format) {
386 case PA_SAMPLE_U8:
387 hdiAudioFormat = AUDIO_FORMAT_TYPE_PCM_8_BIT;
388 break;
389 case PA_SAMPLE_S16LE:
390 case PA_SAMPLE_S16BE:
391 hdiAudioFormat = AUDIO_FORMAT_TYPE_PCM_16_BIT;
392 break;
393 case PA_SAMPLE_S24LE:
394 case PA_SAMPLE_S24BE:
395 hdiAudioFormat = AUDIO_FORMAT_TYPE_PCM_24_BIT;
396 break;
397 case PA_SAMPLE_S32LE:
398 case PA_SAMPLE_S32BE:
399 hdiAudioFormat = AUDIO_FORMAT_TYPE_PCM_32_BIT;
400 break;
401 default:
402 hdiAudioFormat = AUDIO_FORMAT_TYPE_PCM_16_BIT;
403 break;
404 }
405
406 return hdiAudioFormat;
407 }
408
GetEndianInfo(pa_sample_format_t format)409 static bool GetEndianInfo(pa_sample_format_t format)
410 {
411 bool isBigEndian = false;
412 switch (format) {
413 case PA_SAMPLE_S16BE:
414 case PA_SAMPLE_S24BE:
415 case PA_SAMPLE_S32BE:
416 case PA_SAMPLE_FLOAT32BE:
417 case PA_SAMPLE_S24_32BE:
418 isBigEndian = true;
419 break;
420 default:
421 isBigEndian = false;
422 break;
423 }
424
425 return isBigEndian;
426 }
427
PaHdiSourceNew(pa_module * m,pa_modargs * ma,const char * driver)428 pa_source *PaHdiSourceNew(pa_module *m, pa_modargs *ma, const char *driver)
429 {
430 struct Userdata *u = NULL;
431 pa_sample_spec ss;
432 char *threadName = NULL;
433 pa_channel_map map;
434 int ret;
435
436 pa_assert(m);
437 pa_assert(ma);
438
439 ss = m->core->default_sample_spec;
440 map = m->core->default_channel_map;
441
442 /* Override with modargs if provided */
443 if (pa_modargs_get_sample_spec_and_channel_map(ma, &ss, &map, PA_CHANNEL_MAP_DEFAULT) < 0) {
444 AUDIO_ERR_LOG("Failed to parse sample specification and channel map");
445 return NULL;
446 }
447
448 u = pa_xnew0(struct Userdata, 1);
449 pa_assert(u);
450
451 u->core = m->core;
452 u->module = m;
453 u->rtpoll = pa_rtpoll_new();
454
455 if (pa_thread_mq_init(&u->thread_mq, m->core->mainloop, u->rtpoll) < 0) {
456 AUDIO_ERR_LOG("pa_thread_mq_init() failed.");
457 goto fail;
458 }
459
460 if (pa_modargs_get_value_s32(ma, "source_type", &u->attrs.sourceType) < 0) {
461 AUDIO_ERR_LOG("Failed to parse source_type argument");
462 }
463
464 ret = LoadSourceAdapter(pa_modargs_get_value(ma, "device_class", DEFAULT_DEVICE_CLASS),
465 pa_modargs_get_value(ma, "network_id", DEFAULT_DEVICE_NETWORKID),
466 u->attrs.sourceType,
467 pa_modargs_get_value(ma, "source_name", DEFAULT_SOURCE_NAME),
468 &u->sourceAdapter);
469 if (ret) {
470 AUDIO_ERR_LOG("Load adapter failed");
471 goto fail;
472 }
473
474 u->buffer_size = DEFAULT_BUFFER_SIZE;
475 u->attrs.sampleRate = ss.rate;
476 u->attrs.filePath = pa_modargs_get_value(ma, "file_path", "");
477 if (pa_modargs_get_value_u32(ma, "open_mic_speaker", &u->open_mic_speaker) < 0) {
478 AUDIO_ERR_LOG("Failed to parse open_mic_speaker argument");
479 goto fail;
480 }
481 u->attrs.channel = ss.channels;
482 u->attrs.format = ConvertToHDIAudioFormat(ss.format);
483 u->attrs.isBigEndian = GetEndianInfo(ss.format);
484 u->attrs.adapterName = pa_modargs_get_value(ma, "adapter_name", DEFAULT_DEVICE_CLASS);
485 u->attrs.deviceNetworkId = pa_modargs_get_value(ma, "network_id", DEFAULT_DEVICE_NETWORKID);
486 if (pa_modargs_get_value_s32(ma, "device_type", &u->attrs.deviceType) < 0) {
487 AUDIO_ERR_LOG("Failed to parse deviceType argument");
488 }
489
490 AUDIO_DEBUG_LOG("AudioDeviceCreateCapture format: %{public}d, isBigEndian: %{public}d channel: %{public}d,"
491 "sampleRate: %{public}d", u->attrs.format, u->attrs.isBigEndian, u->attrs.channel, u->attrs.sampleRate);
492
493 ret = PaSetSourceProperties(m, ma, &ss, &map, u);
494 if (ret != 0) {
495 AUDIO_ERR_LOG("Failed to PaSetSourceProperties");
496 goto fail;
497 }
498
499 u->attrs.bufferSize = u->buffer_size;
500 u->attrs.open_mic_speaker = u->open_mic_speaker;
501
502 ret = PaHdiCapturerInit(u);
503 if (ret != 0) {
504 AUDIO_ERR_LOG("Failed to PaHdiCapturerInit");
505 goto fail;
506 }
507
508 threadName = "read-hdi";
509 if (!(u->thread = pa_thread_new(threadName, ThreadFuncCapturerTimer, u))) {
510 AUDIO_ERR_LOG("Failed to create hdi-source-record thread!");
511 goto fail;
512 }
513
514 pa_source_put(u->source);
515 return u->source;
516
517 fail:
518
519 if (u->IsCapturerStarted) {
520 PaHdiCapturerExit(u);
521 }
522 UserdataFree(u);
523
524 return NULL;
525 }
526
PaHdiSourceFree(pa_source * s)527 void PaHdiSourceFree(pa_source *s)
528 {
529 struct Userdata *u = NULL;
530 pa_source_assert_ref(s);
531 pa_assert_se(u = s->userdata);
532 UserdataFree(u);
533 }
534