2 * 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.
20 #include "CAudioIODef.h"
25 using namespace tizen_media_audio;
27 static constexpr auto cond_wait_ms = 200ms;
28 static constexpr auto writable_timeout_s = 5s;
34 CAudioOutput::CAudioOutput(CAudioInfo& info) :
36 __mIsUsedSyncWrite(false),
38 __mTotalWrittenCount(0),
39 __mTotalWrittenBytes(0) {
40 mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_OUT;
43 void CAudioOutput::onStream(CPulseAudioClient* pClient, size_t length) {
47 * Does not call CAudioIO::onStream() for synchronization
48 * if a user is using write()
50 if (__mIsUsedSyncWrite) {
51 #ifdef _AUDIO_IO_DEBUG_TIMING_
52 AUDIO_IO_LOGD("Sync Write Mode! - signal! - pClient:[%p], length:[%zu]", pClient, length);
54 { /* NOTE: this block needs to unlock right after lock */
55 std::lock_guard<std::mutex> cond_guard(mCondMutex);
62 * Accrues callback function
64 #ifdef _AUDIO_IO_DEBUG_TIMING_
65 AUDIO_IO_LOGD("pClient:[%p], length:[%zu]", pClient, length);
67 CAudioIO::onStream(pClient, length);
70 void CAudioOutput::__setInit(bool flag) noexcept {
74 bool CAudioOutput::__IsInit() noexcept {
75 return (CAudioIO::isInit() && __mIsInit);
78 bool CAudioOutput::__IsReady() noexcept {
79 return CAudioIO::IsReady();
82 void CAudioOutput::initialize() {
87 CAudioIO::initialize();
89 } catch (const CAudioError& e) {
96 CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
97 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
100 void CAudioOutput::finalize() {
102 AUDIO_IO_LOGD("Did not initialize");
106 CAudioIO::finalize();
110 void CAudioOutput::prepare() {
111 std::lock_guard<std::mutex> mutex(mMutex);
114 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioOutput"); //LCOV_EXCL_LINE
118 AUDIO_IO_LOGD("Already prepared CAudioOutput");
124 /* Check invalid AudioType */
125 CAudioInfo::EAudioType audioType = mAudioInfo.getAudioType();
126 if (audioType < CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA ||
127 audioType >= CAudioInfo::EAudioType::AUDIO_TYPE_MAX)
128 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
129 "The audioType is invalid [type:%d]", static_cast<int>(audioType));
132 /* Init StreamSpec */
133 CPulseStreamSpec::EStreamLatency streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT;
134 #ifndef DISABLE_MOBILE_BACK_COMP
135 if (!mStreamCallback.onStream) {
136 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_OUTPUT_DEFAULT");
137 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT;
139 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_OUTPUT_DEFAULT_ASYNC");
140 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT_ASYNC;
143 /* Override the default value by audio type */
144 if (audioType == CAudioInfo::EAudioType::AUDIO_OUT_TYPE_VOIP)
145 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_VOIP;
146 else if (audioType == CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA_NETWORK_SOURCE)
147 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_HIGH;
149 CPulseStreamSpec spec(streamSpec, mAudioInfo);
151 mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_PLAYBACK,
153 mpPulseAudioClient->initialize();
154 AUDIO_IO_LOGD("pClient:[%p] initialized done", mpPulseAudioClient);
155 #ifndef DISABLE_MOBILE_BACK_COMP
156 /* Uncork stream which is created with CORKED flag */
157 /* FIXME : following uncork may move into initialize() for mainloop lock */
158 mpPulseAudioClient->cork(false);
159 AUDIO_IO_LOGD("pClient:[%p] corked done", mpPulseAudioClient);
163 } catch (const CAudioError& e) {
165 SAFE_FINALIZE(mpPulseAudioClient);
166 SAFE_DELETE(mpPulseAudioClient);
169 } catch (const std::bad_alloc&) {
170 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
174 void CAudioOutput::unprepare() {
175 std::unique_lock<std::mutex> mutex(mMutex);
178 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
179 "Did not initialize CAudioOutput"); //LCOV_EXCL_LINE
182 AUDIO_IO_LOGD("Already unprepared");
188 CAudioIO::unprepare();
190 if (mpPulseAudioClient && mpPulseAudioClient->isInThread())
191 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't unprepare inside pulseaudio thread");
193 SAFE_FINALIZE(mpPulseAudioClient);
194 SAFE_DELETE(mpPulseAudioClient);
196 __mTotalWrittenCount = 0;
197 __mTotalWrittenBytes = 0;
199 CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
203 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
206 void CAudioOutput::pause() {
207 std::unique_lock<std::mutex> mutex(mMutex);
209 if (!__IsInit() || !__IsReady())
210 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
211 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
213 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
214 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
215 "Can't pause if not in Running state");
217 if (mpPulseAudioClient->isInThread())
218 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread"); //LCOV_EXCL_LINE
223 CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
227 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
230 void CAudioOutput::resume() {
231 std::unique_lock<std::mutex> mutex(mMutex);
233 if (!__IsInit() || !__IsReady())
234 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
235 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
237 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED)
238 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
239 "Can't resume if not in Paused state");
241 if (mpPulseAudioClient->isInThread())
242 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread"); //LCOV_EXCL_LINE
247 CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
251 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
254 void CAudioOutput::drain() {
255 std::lock_guard<std::mutex> mutex(mMutex);
257 if (!__IsInit() || !__IsReady())
258 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
259 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
261 if (mStreamCallback.onStream)
262 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "async type don't support drain");
264 mpPulseAudioClient->drain();
267 void CAudioOutput::flush() {
268 std::lock_guard<std::mutex> mutex(mMutex);
270 if (!__IsInit() || !__IsReady())
271 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
272 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
277 int CAudioOutput::getBufferSize() {
279 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
280 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
282 /* FIXME : return calculated size here to satisfy backward compatibility */
283 return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
286 size_t CAudioOutput::write(const void* buffer, size_t length) {
287 std::unique_lock<std::mutex> mutex(mMutex, std::defer_lock);
289 if (mpPulseAudioClient && !mpPulseAudioClient->isInThread())
292 if (!__IsInit() || !__IsReady())
293 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
294 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
297 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
298 "Parameters are invalid - buffer:%p, length:%zu", buffer, length);
300 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
301 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
302 "Can't write if not in Running state");
304 /* When write() is called in PulseAudio callback, bypass a pcm data to CPulseAudioClient (For Asynchronous) */
305 if (mpPulseAudioClient && mpPulseAudioClient->isInThread()) {
306 int ret = mpPulseAudioClient->write(buffer, length);
308 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
309 "The written result is invalid ret:%d", ret);
310 #ifdef _AUDIO_IO_DEBUG_TIMING_
311 AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%zu)", buffer, length);
318 // If another thread did call unprepare, do not write
319 if (!mpPulseAudioClient)
320 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
321 "Did not initialize CPulseAudioClient"); //LCOV_EXCL_LINE
323 // Sets synchronous flag
324 __mIsUsedSyncWrite = true;
325 size_t lengthIter = length;
327 while (lengthIter > 0) {
329 unsigned int timeouts = 0;
331 while ((l = mpPulseAudioClient->getWritableSize()) == 0) {
332 #ifdef _AUDIO_IO_DEBUG_TIMING_
333 AUDIO_IO_LOGD("writableSize is [%zu].. wait", l);
335 std::unique_lock<std::mutex> cond_mutex(mCondMutex);
336 if (mCond.wait_for(cond_mutex, cond_wait_ms) == std::cv_status::timeout) {
338 AUDIO_IO_LOGW("[%2u] timeout expired for waiting %zu ms of write available...", ++timeouts,
339 static_cast<size_t>(std::chrono::duration_cast<std::chrono::milliseconds>(cond_wait_ms).count()));
340 if ((cond_wait_ms * timeouts) > writable_timeout_s)
341 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
342 "writable size is 0 for more than %zu seconds...",
343 static_cast<size_t>(std::chrono::duration_cast<std::chrono::seconds>(writable_timeout_s).count()));
349 AUDIO_IO_LOGD("writableSize(%zu) is now available after (%u) timeouts!!!", l, timeouts);
354 #ifdef _AUDIO_IO_DEBUG_TIMING_
355 AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%zu)", buffer, l);
359 int ret = mpPulseAudioClient->write(buffer, l);
361 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,//LCOV_EXCL_LINE
362 "The written result is invalid ret:%d", ret); //LCOV_EXCL_LINE
364 buffer = static_cast<const uint8_t*>(buffer) + l;
367 __mTotalWrittenCount++;
368 __mTotalWrittenBytes += l;
369 } // End of while (lengthIter > 0)
371 __mIsUsedSyncWrite = false;
375 } catch (const CAudioError& e) {
376 __mIsUsedSyncWrite = false;
383 void CAudioOutput::__dumpStat() noexcept {
384 AUDIO_IO_LOGD("total written %" PRIu64 " times, %" PRIu64 " bytes, %" PRIu64 " ms",
385 __mTotalWrittenCount, __mTotalWrittenBytes,
386 __mTotalWrittenBytes * 1000 / mAudioInfo.getSampleSize() / mAudioInfo.getSampleRate());