2 git st* Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "CAudioIODef.h"
27 #include <dpm/restriction.h>
31 using namespace tizen_media_audio;
34 * class CMainloopLocker
36 CPulseAudioClient::CPulseThreadLocker::CPulseThreadLocker(pa_threaded_mainloop* mainloop) : ml(nullptr) {
37 if (!mainloop || pa_threaded_mainloop_in_thread(mainloop))
40 pa_threaded_mainloop_lock(mainloop);
44 CPulseAudioClient::CPulseThreadLocker::~CPulseThreadLocker() {
46 pa_threaded_mainloop_unlock(const_cast<pa_threaded_mainloop*>(ml));
51 * class CPulseAudioClient
53 const char* CPulseAudioClient::CLIENT_NAME = "AUDIO_IO_PA_CLIENT";
54 const char* ec_method = "default";
55 static constexpr auto drain_wait_interval = 10000;
56 static constexpr auto drain_wait_max_count = 30;
58 CPulseAudioClient::CPulseAudioClient(
59 EStreamDirection direction,
60 CPulseStreamSpec& spec,
61 IPulseStreamListener* listener) :
62 __mDirection(direction),
64 __mpListener(listener),
65 __mpMainloop(nullptr),
68 __mpPropList(nullptr),
70 __mIsOperationSuccess(false),
71 __mpSyncReadDataPtr(nullptr),
74 __mIsUsedSyncRead(false),
75 __mIsFirstStream(false),
80 CPulseAudioClient::~CPulseAudioClient() {
83 } catch (const CAudioError& e) {
84 AUDIO_IO_LOGE("%s", e.getErrorMsg()); //LCOV_EXCL_LINE
88 void CPulseAudioClient::__contextStateChangeCb(pa_context* c, void* user_data) {
89 auto pClient = static_cast<CPulseAudioClient*>(user_data);
93 switch (pa_context_get_state(c)) {
94 case PA_CONTEXT_READY:
95 AUDIO_IO_LOGD("pa_context[%p] is ready", c);
96 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
99 case PA_CONTEXT_FAILED:
100 case PA_CONTEXT_TERMINATED:
101 AUDIO_IO_LOGD("pa_context[%p] is lost", c);
102 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
105 case PA_CONTEXT_UNCONNECTED:
106 case PA_CONTEXT_CONNECTING:
107 case PA_CONTEXT_AUTHORIZING:
108 case PA_CONTEXT_SETTING_NAME:
114 static bool __is_microphone_restricted(void) {
117 device_policy_manager_h dpm_h = nullptr;
120 if ((dpm_h = dpm_manager_create())) {
121 /* state: 0(disallowed), 1(allowed) */
122 if ((ret = dpm_restriction_get_microphone_state(dpm_h, &state)))
123 AUDIO_IO_LOGE("Failed to dpm_restriction_get_microphone_state(), ret(0x%x)", ret);
124 dpm_manager_destroy(dpm_h);
125 AUDIO_IO_LOGD("microphone restriction state: %d(1:allowed, 0:disallowed)", state);
127 AUDIO_IO_LOGE("Failed to dpm_manager_create()");
130 return (state ? false : true);
134 void CPulseAudioClient::__streamStateChangeCb(pa_stream* s, void* user_data) {
138 auto pClient = static_cast<CPulseAudioClient*>(user_data);
139 pa_stream_state_t state = pa_stream_get_state(s);
142 case PA_STREAM_UNCONNECTED:
145 case PA_STREAM_CREATING:
148 case PA_STREAM_READY:
149 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] is READY[%d]", pClient, s, PA_STREAM_READY);
150 pClient->__mpListener->setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
151 pClient->__mpListener->onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
152 if (pClient->__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK)
153 pClient->__mIsFirstStream = true;
154 pClient->__mIsInit = true;
156 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] now signaling...", pClient, s);
157 pa_threaded_mainloop_signal(pClient->__mpMainloop, 1);
158 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] signal accepted", pClient, s);
162 case PA_STREAM_FAILED:
163 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] is FAILED[%d]", pClient, s, PA_STREAM_FAILED);
164 pClient->__mpListener->setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
165 pClient->__mpListener->onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE,
166 __is_microphone_restricted());
168 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] now signaling...", pClient, s);
169 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
173 case PA_STREAM_TERMINATED:
174 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] is TERMINATED[%d]", pClient, s, PA_STREAM_TERMINATED);
175 pClient->__mpListener->setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
176 pClient->__mpListener->onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
178 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] now signaling...", pClient, s);
179 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
183 AUDIO_IO_LOGW("Unexpected state[%d]", state);
187 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] state[%d] done", pClient, s, state);
190 void CPulseAudioClient::__streamCaptureCb(pa_stream* s, size_t length, void* user_data) {
194 auto pClient = static_cast<CPulseAudioClient*>(user_data);
195 assert(pClient->__mpListener);
196 assert(pClient->__mpMainloop);
198 if (pClient->__mIsUsedSyncRead)
199 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
201 pClient->__mpListener->onStream(pClient, length);
204 static void __dummy_write(pa_stream* s, size_t length) {
205 pa_stream_write(s, std::vector<char>(length).data(), length, NULL, 0LL, PA_SEEK_RELATIVE);
208 void CPulseAudioClient::__streamPlaybackCb(pa_stream* s, size_t length, void* user_data) {
212 auto pClient = static_cast<CPulseAudioClient*>(user_data);
213 assert(pClient->__mpListener);
215 #ifndef DISABLE_MOBILE_BACK_COMP
216 if (!pClient->__mIsInit) {
217 AUDIO_IO_LOGD("pa_stream[%p] is on the way to create : Write dummy, length[%zu]", s, length);
218 __dummy_write(s, length);
221 if (pClient->isCorked()) {
222 AUDIO_IO_LOGD("pa_stream[%p] is CORKED : Write dummy, length[%zu]", s, length);
223 __dummy_write(s, length);
228 pClient->__mpListener->onStream(pClient, length);
230 #ifndef DISABLE_MOBILE_BACK_COMP
231 /* If stream is not written in first callback during prepare,
232 then write dummy data to ensure the start */
233 if (pClient->__mSpec.getStreamLatency() == CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT_ASYNC &&
234 pClient->__mIsFirstStream) {
235 AUDIO_IO_LOGW("[async] pa_stream[%p] : not written in the first callback during prepare, write dummy of length[%zu]",
237 __dummy_write(s, length);
238 pClient->__mIsFirstStream = false;
243 void CPulseAudioClient::__streamLatencyUpdateCb(pa_stream* s, void* user_data) {
247 auto pClient = static_cast<CPulseAudioClient*>(user_data);
249 #ifdef _AUDIO_IO_DEBUG_TIMING_
250 /* FIXME : print some useful latency info */
251 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] latency updated", pClient, s);
254 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
257 void CPulseAudioClient::__streamStartedCb(pa_stream* s, void* user_data) {
261 auto pClient = static_cast<CPulseAudioClient*>(user_data);
263 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] started", pClient, s);
265 pClient->__mIsStarted = true;
268 void CPulseAudioClient::__streamUnderflowCb(pa_stream* s, void* user_data) {
272 auto pClient = static_cast<CPulseAudioClient*>(user_data);
274 AUDIO_IO_LOGD("pClient[%p] pa_stream[%p] UnderFlow...", pClient, s);
276 pClient->__mIsStarted = false;
280 void CPulseAudioClient::__streamEventCb(pa_stream* s, const char* name, pa_proplist* pl, void* user_data) {
284 auto pClient = static_cast<CPulseAudioClient*>(user_data);
286 AUDIO_IO_LOGW("pClient[%p] pa_stream[%p] : name[%s], proplist[%p]", pClient, s, name, pl);
288 if (strcmp(name, PA_STREAM_EVENT_POP_TIMEOUT) == 0) {
289 pa_operation* o = pa_stream_cork(pClient->__mpStream, 1, NULL, NULL);
291 AUDIO_IO_LOGE("pa_stream[%p] : cork failed", pClient->__mpStream);
294 pa_operation_unref(o);
299 void CPulseAudioClient::__successStreamCb(pa_stream* s, int success, void* user_data) {
303 auto pClient = static_cast<CPulseAudioClient*>(user_data);
305 AUDIO_IO_LOGD("pClient[%p], pa_stream[%p], success[%d], user_data[%p]", pClient, s, success, user_data);
307 pClient->__mIsOperationSuccess = static_cast<bool>(success);
309 /* FIXME : verify following action without any waiting */
310 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
314 void CPulseAudioClient::__successDrainCbInThread(pa_stream* s, int success, void* user_data) {
318 auto pClient = static_cast<CPulseAudioClient*>(user_data);
320 AUDIO_IO_LOGD("pClient[%p], pa_stream[%p], success[%d], user_data[%p]", pClient, s, success, user_data);
322 pClient->__mIsOperationSuccess = static_cast<bool>(success);
323 pClient->__mIsDraining = false;
327 void CPulseAudioClient::__successDrainCb(pa_stream* s, int success, void* user_data) {
331 auto pClient = static_cast<CPulseAudioClient*>(user_data);
333 AUDIO_IO_LOGD("pClient[%p], pa_stream[%p], success[%d], user_data[%p]", pClient, s, success, user_data);
335 pClient->__mIsOperationSuccess = static_cast<bool>(success);
336 pClient->__mIsDraining = false;
338 pa_threaded_mainloop_signal(pClient->__mpMainloop, 0);
341 void CPulseAudioClient::__successVolumeCb(pa_context* c, int success, void* user_data) {
342 AUDIO_IO_LOGD("pa_context[%p], success[%d], user_data[%p]", c, success, user_data);
345 void CPulseAudioClient::resetStreamCallbacks() {
349 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK)
350 pa_stream_set_write_callback(__mpStream, NULL, NULL);
352 pa_stream_set_read_callback(__mpStream, NULL, NULL);
354 pa_stream_set_latency_update_callback(__mpStream, NULL, NULL);
355 pa_stream_set_event_callback(__mpStream, NULL, NULL);
358 void CPulseAudioClient::resetInternalObjects() {
360 pa_threaded_mainloop_stop(__mpMainloop);
363 pa_stream_disconnect(__mpStream);
364 pa_stream_unref(__mpStream);
365 __mpStream = nullptr;
369 pa_context_disconnect(__mpContext);
370 pa_context_unref(__mpContext);
371 __mpContext = nullptr;
375 pa_threaded_mainloop_free(__mpMainloop);
376 __mpMainloop = nullptr;
380 pa_proplist_free(__mpPropList);
381 __mpPropList = nullptr;
385 void CPulseAudioClient::initialize() {
393 // Allocates PA proplist
394 __mpPropList = pa_proplist_new();
396 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_proplist_new()"); //LCOV_EXCL_LINE
398 // Adds values on proplist for delivery to PULSEAUDIO
399 pa_proplist_sets(__mpPropList, PA_PROP_MEDIA_ROLE, __mSpec.getAudioInfo().getConvertedStreamType());
401 int index = __mSpec.getAudioInfo().getAudioIndex();
403 pa_proplist_setf(__mpPropList, PA_PROP_MEDIA_PARENT_ID, "%u", (unsigned int) index);
405 int reference_id = __mSpec.getAudioInfo().getEchoCancelReferenceDeviceId();
406 if (reference_id > 0) {
407 pa_proplist_setf(__mpPropList, PA_PROP_MEDIA_ECHO_CANCEL_METHOD, "%s", ec_method);
408 pa_proplist_setf(__mpPropList, PA_PROP_MEDIA_ECHO_CANCEL_REFERENCE_DEVICE, "%d", reference_id);
411 // Adds latency on proplist for delivery to PULSEAUDIO
412 AUDIO_IO_LOGD("LATENCY : %s[%d]", __mSpec.getStreamLatencyToString(), static_cast<int>(__mSpec.getStreamLatency()));
413 pa_proplist_setf(__mpPropList, PA_PROP_MEDIA_TIZEN_AUDIO_LATENCY, "%s", __mSpec.getStreamLatencyToString());
415 // Allocates PA mainloop
416 __mpMainloop = pa_threaded_mainloop_new();
418 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_threaded_mainloop_new()"); //LCOV_EXCL_LINE
420 // Allocates PA context
421 __mpContext = pa_context_new(pa_threaded_mainloop_get_api(__mpMainloop), CLIENT_NAME);
423 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_new()"); //LCOV_EXCL_LINE
425 // Sets context state changed callback
426 pa_context_set_state_callback(__mpContext, __contextStateChangeCb, this);
428 // Connects this client with PA server
429 if (pa_context_connect(__mpContext, NULL, PA_CONTEXT_NOFLAGS, NULL) < 0)
430 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_connect()"); //LCOV_EXCL_LINE
432 // LOCK for synchronous connection
433 CPulseThreadLocker locker{__mpMainloop};
436 if (pa_threaded_mainloop_start(__mpMainloop) < 0) {
438 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_threaded_mainloop_start()");
442 // Connection process is asynchronously
443 // So, this function will be waited when occurred context state change event
444 // If I got a signal, do next processing
446 pa_context_state_t state;
447 state = pa_context_get_state(__mpContext);
449 if (state == PA_CONTEXT_READY)
452 if (!PA_CONTEXT_IS_GOOD(state)) {
454 err = pa_context_errno(__mpContext);
455 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
456 "pa_context's state is not good : err[%d]", err);
460 /* Wait until the context is ready */
461 pa_threaded_mainloop_wait(__mpMainloop);
464 AUDIO_IO_LOGD("pa_context[%p] now ready", __mpContext);
466 // Allocates PA stream
467 pa_sample_spec ss = __mSpec.getSampleSpec();
468 pa_channel_map map = __mSpec.getChannelMap();
470 __mpStream = pa_stream_new_with_proplist(__mpContext, __mSpec.getStreamName(), &ss, &map, __mpPropList);
473 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_stream_new_with_proplist()");
477 // Sets stream callbacks
478 pa_stream_set_state_callback(__mpStream, __streamStateChangeCb, this);
479 pa_stream_set_read_callback(__mpStream, __streamCaptureCb, this);
480 pa_stream_set_write_callback(__mpStream, __streamPlaybackCb, this);
481 pa_stream_set_latency_update_callback(__mpStream, __streamLatencyUpdateCb, this);
482 pa_stream_set_event_callback(__mpStream, __streamEventCb, this);
483 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK) {
484 pa_stream_set_started_callback(__mpStream, __streamStartedCb, this);
485 pa_stream_set_underflow_callback(__mpStream, __streamUnderflowCb, this);
488 // Connect stream with PA Server
490 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK) {
491 auto flags = static_cast<pa_stream_flags_t>(
492 PA_STREAM_INTERPOLATE_TIMING |
493 PA_STREAM_ADJUST_LATENCY |
494 #ifndef DISABLE_MOBILE_BACK_COMP
495 PA_STREAM_START_CORKED |
497 PA_STREAM_AUTO_TIMING_UPDATE);
499 ret = pa_stream_connect_playback(__mpStream, NULL, NULL, flags, NULL, NULL);
501 auto flags = static_cast<pa_stream_flags_t>(
502 PA_STREAM_INTERPOLATE_TIMING |
503 PA_STREAM_ADJUST_LATENCY |
504 #ifndef DISABLE_MOBILE_BACK_COMP
505 PA_STREAM_START_CORKED |
507 PA_STREAM_AUTO_TIMING_UPDATE);
509 ret = pa_stream_connect_record(__mpStream, NULL, NULL, flags);
513 err = pa_context_errno(__mpContext);
514 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION,
515 "Failed pa_stream_connect() : err[%d]", err);
519 AUDIO_IO_LOGD("pa_stream[%p] now wait for stream ready...", __mpStream);
522 pa_stream_state_t state = pa_stream_get_state(__mpStream);
523 AUDIO_IO_LOGD("pa_stream[%p] current state[%d]", __mpStream, state);
525 if (state == PA_STREAM_READY)
528 if (!PA_STREAM_IS_GOOD(state)) {
529 err = pa_context_errno(__mpContext);
530 if (err == PA_ERR_ACCESS)
531 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_DEVICE_POLICY_RESTRICTION,
532 "pa_stream's state is not good : err[%d]", err);
534 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION, //LCOV_EXCL_LINE
535 "pa_stream's state is not good : err[%d]", err); //LCOV_EXCL_LINE
538 /* Wait until the stream is ready */
539 AUDIO_IO_LOGD("pa_mainloop[%p] signal wait...", __mpMainloop);
540 pa_threaded_mainloop_wait(__mpMainloop);
541 AUDIO_IO_LOGD("pa_mainloop[%p] signal wait done", __mpMainloop);
543 pa_threaded_mainloop_accept(__mpMainloop);
545 // __mIsInit = true; // Moved to __streamStateChangeCb()
546 } catch (const CAudioError& e) {
548 resetStreamCallbacks();
549 resetInternalObjects();
554 AUDIO_IO_LOGD("Done : pa_context[%p], pa_mainloop[%p], pa_stream[%p]", __mpContext, __mpMainloop, __mpStream);
557 void CPulseAudioClient::finalize() {
558 AUDIO_IO_LOGD("pa_context[%p], pa_mainloop[%p], pa_stream[%p]", __mpContext, __mpMainloop, __mpStream);
563 bool is_in_thread = isInThread();
565 pa_threaded_mainloop_lock(__mpMainloop);
569 resetStreamCallbacks();
572 pa_threaded_mainloop_unlock(__mpMainloop);
574 /* Wait for drain complete if draining before finalize */
576 unsigned int drain_wait_count = 0;
577 while (__mIsDraining && drain_wait_count++ < drain_wait_max_count)
578 usleep(drain_wait_interval);
579 AUDIO_IO_LOGD("wait for drain complete!!!! [%d * %d usec]",
580 drain_wait_count, drain_wait_interval);
583 resetInternalObjects();
585 AUDIO_IO_LOGD("Done");
588 int CPulseAudioClient::read(void* buffer, size_t length) {
590 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); //LCOV_EXCL_LINE
595 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT, "invalid parameter : buffer[%p]", buffer); //LCOV_EXCL_LINE
597 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK)
598 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "playback client can't use this function"); //LCOV_EXCL_LINE
600 size_t lengthIter = length;
603 __mIsUsedSyncRead = true;
606 CPulseThreadLocker locker{__mpMainloop};
608 while (lengthIter > 0) {
611 while (!__mpSyncReadDataPtr) {
612 ret = pa_stream_peek(__mpStream, &__mpSyncReadDataPtr, &__mSyncReadLength);
614 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION, "Failed pa_stream_peek() : ret[%d]", ret); //LCOV_EXCL_LINE
616 if (__mSyncReadLength <= 0) {
617 #ifdef _AUDIO_IO_DEBUG_TIMING_
618 AUDIO_IO_LOGD("readLength(%zu byte) is not valid. wait...", __mSyncReadLength);
620 pa_threaded_mainloop_wait(__mpMainloop);
621 } else if (!__mpSyncReadDataPtr) {
623 // Data peeked, but it doesn't have any data
624 ret = pa_stream_drop(__mpStream);
626 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION, "Failed pa_stream_drop() : ret[%d]", ret);
629 __mSyncReadIndex = 0;
633 l = min(__mSyncReadLength, lengthIter);
635 // Copy partial pcm data on out parameter
636 #ifdef _AUDIO_IO_DEBUG_TIMING_
637 AUDIO_IO_LOGD("memcpy() that a peeked buffer[%p], index[%zu], length[%zu] on out buffer", (const uint8_t*)(__mpSyncReadDataPtr) + __mSyncReadIndex, __mSyncReadIndex, l);
639 memcpy(buffer, (const uint8_t*)__mpSyncReadDataPtr + __mSyncReadIndex, l);
641 // Move next position
642 buffer = (uint8_t*)buffer + l;
645 // Adjusts the rest length
646 __mSyncReadIndex += l;
647 __mSyncReadLength -= l;
649 if (__mSyncReadLength == 0) {
650 #ifdef _AUDIO_IO_DEBUG_TIMING_
651 AUDIO_IO_LOGD("__mSyncReadLength is zero, do drop()");
653 ret = pa_stream_drop(__mpStream);
655 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION, //LCOV_EXCL_LINE
656 "Failed pa_stream_drop() : ret[%d]", ret); //LCOV_EXCL_LINE
658 // Reset the internal pointer
659 __mpSyncReadDataPtr = nullptr;
660 __mSyncReadLength = 0;
661 __mSyncReadIndex = 0;
663 } // End of while (lengthIter > 0)
665 __mIsUsedSyncRead = false;
666 } catch (const CAudioError& e) {
668 __mIsUsedSyncRead = false;
676 int CPulseAudioClient::peek(const void** buffer, size_t* length) {
678 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
682 if (!buffer || !length)
683 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT, // LCOV_EXCL_LINE
684 "invalid parameter : buffer[%p], length[%p]", buffer, length); // LCOV_EXCL_LINE
686 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK)
687 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "playback can't use this function"); // LCOV_EXCL_LINE
689 CPulseThreadLocker locker{__mpMainloop};
691 int ret = pa_stream_peek(__mpStream, buffer, length);
694 #ifdef _AUDIO_IO_DEBUG_TIMING_
695 AUDIO_IO_LOGD("buffer[%p], length[%zu]", *buffer, *length);
699 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_stream_peek() : err[%d]", ret); //LCOV_EXCL_LINE
704 int CPulseAudioClient::drop() {
706 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
708 #ifdef _AUDIO_IO_DEBUG_TIMING_
714 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK)
715 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "playback can't use this function"); // LCOV_EXCL_LINE
717 CPulseThreadLocker locker{__mpMainloop};
719 int ret = pa_stream_drop(__mpStream);
721 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_stream_drop() : err[%d]", ret); //LCOV_EXCL_LINE
726 int CPulseAudioClient::write(const void* data, size_t length) {
728 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_ARGUMENT, "invalid parameter"); // LCOV_EXCL_LINE
730 if (__mDirection == EStreamDirection::STREAM_DIRECTION_RECORD)
731 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "playback can't use this function"); // LCOV_EXCL_LINE
735 #ifdef _AUDIO_IO_DEBUG_TIMING_
736 AUDIO_IO_LOGD("data[%p], length[%zu], First[%d]", data, length, __mIsFirstStream);
740 CPulseThreadLocker locker{__mpMainloop};
741 if (pa_stream_is_corked(__mpStream)) {
742 AUDIO_IO_LOGW("pa_stream[%p] is corked...do uncork here first!!!!", __mpStream);
743 pa_operation* o = pa_stream_cork(__mpStream, 0, NULL, NULL);
745 AUDIO_IO_LOGE("pa_stream[%p] : uncork failed", __mpStream);
747 pa_operation_unref(o);
750 ret = pa_stream_write(__mpStream, data, length, NULL, 0LL, PA_SEEK_RELATIVE);
753 if (pa_stream_is_corked(__mpStream)) {
754 AUDIO_IO_LOGW("pa_stream[%p] is corked...do uncork here first!!!!", __mpStream);
755 pa_operation* o = pa_stream_cork(__mpStream, 0, NULL, NULL);
757 AUDIO_IO_LOGE("pa_stream[%p] : uncork failed", __mpStream);
759 pa_operation_unref(o);
762 if (__mIsFirstStream) {
763 const pa_buffer_attr* attr = pa_stream_get_buffer_attr(__mpStream);
764 uint32_t prebuf = attr->prebuf;
765 // Compensate amount of prebuf in first stream callback when audio-io use prebuf(-1)
766 // Because a stream will never start when an application wrote less than prebuf at first
768 __dummy_write(__mpStream, prebuf - length);
770 __mIsFirstStream = false;
771 AUDIO_IO_LOGW("FIRST STREAM CALLBACK : length[%zu], prebuf[%d], dummy[%zu]",
772 length, prebuf, (length < prebuf) ? prebuf - length : 0);
774 ret = pa_stream_write(__mpStream, data, length, NULL, 0LL, PA_SEEK_RELATIVE);
779 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_stream_write() : err[%d]", ret); //LCOV_EXCL_LINE
784 void CPulseAudioClient::cork(bool cork) {
785 AUDIO_IO_LOGD("cork[%d]", cork);
788 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
791 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "This operation is not supported in callback"); // LCOV_EXCL_LINE
795 // Set __mIsFirstStream flag when uncork(resume) stream, because prebuf will be enable again
797 __mIsFirstStream = true;
799 CPulseThreadLocker locker{__mpMainloop};
801 /* FIXME: wait for completion like drain? */
802 pa_operation* o = pa_stream_cork(__mpStream, static_cast<int>(cork), __successStreamCb, this);
804 AUDIO_IO_LOGE("pa_stream[%p] : cork[%d] failed", __mpStream, cork);
807 pa_operation_unref(o);
808 AUDIO_IO_LOGD("cork[%d] done", cork);
811 bool CPulseAudioClient::isCorked() {
813 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
817 CPulseThreadLocker locker{__mpMainloop};
819 int isCorked = pa_stream_is_corked(__mpStream);
821 #ifdef _AUDIO_IO_DEBUG_TIMING_
822 AUDIO_IO_LOGD("isCorked[%d]", isCorked);
824 return static_cast<bool>(isCorked);
827 bool CPulseAudioClient::drain() {
829 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
834 AUDIO_IO_LOGW("Corked...");
839 AUDIO_IO_LOGW("already draining...");
844 AUDIO_IO_LOGW("stream not started yet...skip drain");
849 AUDIO_IO_LOGD("drain");
850 CPulseThreadLocker locker{__mpMainloop};
852 pa_operation* o = pa_stream_drain(__mpStream, __successDrainCb, this);
853 __mIsDraining = true;
854 while (pa_operation_get_state(o) == PA_OPERATION_RUNNING)
855 pa_threaded_mainloop_wait(__mpMainloop);
856 pa_operation_unref(o);
858 AUDIO_IO_LOGD("drain done");
860 AUDIO_IO_LOGD("drain in thread");
861 pa_operation* o = pa_stream_drain(__mpStream, __successDrainCbInThread, this);
863 AUDIO_IO_LOGE("pa_stream[%p] : drain failed", __mpStream);
866 pa_operation_unref(o);
867 __mIsDraining = true;
873 bool CPulseAudioClient::flush() {
875 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
879 CPulseThreadLocker locker{__mpMainloop};
881 /* FIXME: wait for completion like drain? */
882 pa_operation* o = pa_stream_flush(__mpStream, __successStreamCb, this);
884 AUDIO_IO_LOGE("pa_stream[%p] : flush failed", __mpStream);
887 pa_operation_unref(o);
892 size_t CPulseAudioClient::getWritableSize() {
894 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized"); // LCOV_EXCL_LINE
898 if (__mDirection != EStreamDirection::STREAM_DIRECTION_PLAYBACK)
899 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "This client is used for Playback"); // LCOV_EXCL_LINE
901 CPulseThreadLocker locker{__mpMainloop};
903 return pa_stream_writable_size(__mpStream);
906 void CPulseAudioClient::checkRunningState() {
907 if (!__mpContext || !PA_CONTEXT_IS_GOOD(pa_context_get_state(__mpContext)))
908 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_NOT_INITIALIZED, // LCOV_EXCL_LINE
909 "The context[%p] is not created or not good state", __mpContext); // LCOV_EXCL_LINE
911 if (!__mpStream || !PA_STREAM_IS_GOOD(pa_stream_get_state(__mpStream)))
912 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_NOT_INITIALIZED, // LCOV_EXCL_LINE
913 "The stream[%p] is not created or not good state", __mpStream); // LCOV_EXCL_LINE
915 if (pa_context_get_state(__mpContext) != PA_CONTEXT_READY || pa_stream_get_state(__mpStream) != PA_STREAM_READY)
916 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_NOT_INITIALIZED, // LCOV_EXCL_LINE
917 "The context[%p] or stream[%p] state is not ready", __mpContext, __mpStream); // LCOV_EXCL_LINE
919 #ifdef _AUDIO_IO_DEBUG_TIMING_
920 AUDIO_IO_LOGD("This client is running");
924 bool CPulseAudioClient::isInThread() const {
926 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "__mIsInit is null");
929 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "__mpMainloop is null");
931 int ret = pa_threaded_mainloop_in_thread(__mpMainloop);
933 #ifdef _AUDIO_IO_DEBUG_TIMING_
934 AUDIO_IO_LOGD("isInThread[%d]", ret);
936 return static_cast<bool>(ret);
940 size_t CPulseAudioClient::getReadableSize() {
942 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized");
946 if (__mDirection != EStreamDirection::STREAM_DIRECTION_RECORD)
947 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "This client is used for Capture");
949 CPulseThreadLocker locker{__mpMainloop};
951 return pa_stream_readable_size(__mpStream);
954 size_t CPulseAudioClient::getBufferSize() {
956 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized");
960 size_t buffer_size = 0;
961 CPulseThreadLocker locker{__mpMainloop};
963 const pa_buffer_attr* attr = pa_stream_get_buffer_attr(__mpStream);
965 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION,
966 "Failed pa_stream_get_buffer_attr() : err[%d]", pa_context_errno(__mpContext));
968 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK) {
969 buffer_size = attr->tlength;
970 AUDIO_IO_LOGD("PLAYBACK buffer size[%zu]", buffer_size);
972 buffer_size = attr->fragsize;
973 AUDIO_IO_LOGD("RECORD buffer size[%zu]", buffer_size);
979 pa_usec_t CPulseAudioClient::getLatency() {
981 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized");
985 pa_usec_t latency = 0;
989 if (pa_stream_get_latency(__mpStream, &latency, &negative) < 0) {
990 int _err = pa_context_errno(__mpContext);
991 if (_err != PA_ERR_NODATA)
992 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION,
993 "Failed pa_stream_get_latency() : err[%d]", _err);
995 return negative ? 0 : latency;
998 CPulseThreadLocker locker{__mpMainloop};
1000 while (pa_stream_get_latency(__mpStream, &latency, &negative) < 0) {
1001 int _err = pa_context_errno(__mpContext);
1002 if (_err != PA_ERR_NODATA)
1003 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION,
1004 "Failed pa_stream_get_latency() : err[%d]", _err);
1005 /* Wait until latency data is available again */
1006 pa_threaded_mainloop_wait(__mpMainloop);
1009 return negative ? 0 : latency;
1012 pa_usec_t CPulseAudioClient::getFinalLatency() {
1014 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized");
1016 checkRunningState();
1018 pa_usec_t latency = 0;
1020 CPulseThreadLocker locker{__mpMainloop};
1022 uint32_t ver = pa_context_get_server_protocol_version(__mpContext);
1024 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_NOT_SUPPORTED, "This version(ver.%d) is not supported", ver);
1026 const pa_buffer_attr* buffer_attr = pa_stream_get_buffer_attr(__mpStream);
1027 const pa_sample_spec* sample_spec = pa_stream_get_sample_spec(__mpStream);
1028 const pa_timing_info* timing_info = pa_stream_get_timing_info(__mpStream);
1030 if (!buffer_attr || !sample_spec || !timing_info)
1031 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_OUT_OF_MEMORY,
1032 "Failed to get buffer_attr[%p] or sample_spec[%p] or timing_info[%p] from a pa_stream",
1033 buffer_attr, sample_spec, timing_info);
1035 if (__mDirection == EStreamDirection::STREAM_DIRECTION_PLAYBACK) {
1036 latency = (pa_bytes_to_usec(buffer_attr->tlength, sample_spec) + timing_info->configured_sink_usec);
1037 AUDIO_IO_LOGD("FINAL PLAYBACK LATENCY[%" PRIu64 "]", latency);
1039 latency = (pa_bytes_to_usec(buffer_attr->fragsize, sample_spec) + timing_info->configured_source_usec);
1040 AUDIO_IO_LOGD("FINAL RECORD LATENCY[%" PRIu64 "]", latency);
1047 void CPulseAudioClient::applyRecordVolume(double volume) {
1050 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "CPulseAudioClient is not initialized");
1052 checkRunningState();
1054 if (__mDirection != EStreamDirection::STREAM_DIRECTION_RECORD)
1055 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "The Playback client can't use this function"); //LCOV_EXCL_LINE
1057 CPulseThreadLocker locker{__mpMainloop};
1059 pa_cvolume cv = { 0, };
1060 pa_volume_t v = PA_VOLUME_NORM * volume;
1062 pa_cvolume_set(&cv, __mSpec.getChannelMap().channels, v);
1064 pa_operation_unref(pa_context_set_source_output_volume(__mpContext,
1065 pa_stream_get_index(__mpStream), &cv, __successVolumeCb, NULL));