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 mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_OUT;
41 void CAudioOutput::onStream(CPulseAudioClient* pClient, size_t length) {
45 * Does not call CAudioIO::onStream() for synchronization
46 * if a user is using write()
48 if (__mIsUsedSyncWrite) {
49 #ifdef _AUDIO_IO_DEBUG_TIMING_
50 AUDIO_IO_LOGD("Sync Write Mode! - signal! - pClient:[%p], length:[%zu]", pClient, length);
53 std::lock_guard<std::mutex> cond_guard(mCondMutex);
60 * Accrues callback function
62 #ifdef _AUDIO_IO_DEBUG_TIMING_
63 AUDIO_IO_LOGD("pClient:[%p], length:[%zu]", pClient, length);
65 CAudioIO::onStream(pClient, length);
68 void CAudioOutput::__setInit(bool flag) noexcept {
72 bool CAudioOutput::__IsInit() noexcept {
73 return (CAudioIO::isInit() && __mIsInit);
76 bool CAudioOutput::__IsReady() noexcept {
77 return CAudioIO::IsReady();
80 void CAudioOutput::initialize() {
85 CAudioIO::initialize();
87 } catch (const CAudioError& e) {
94 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
97 void CAudioOutput::finalize() {
99 AUDIO_IO_LOGD("Did not initialize");
103 CAudioIO::finalize();
107 void CAudioOutput::prepare() {
109 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioOutput"); //LCOV_EXCL_LINE
113 AUDIO_IO_LOGD("Already prepared CAudioOutput");
119 /* Check invalid AudioType */
120 CAudioInfo::EAudioType audioType = mAudioInfo.getAudioType();
121 if (audioType < CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA ||
122 audioType >= CAudioInfo::EAudioType::AUDIO_TYPE_MAX)
123 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
124 "The audioType is invalid [type:%d]", static_cast<int>(audioType));
127 /* Init StreamSpec */
128 CPulseStreamSpec::EStreamLatency streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT;
129 #ifndef DISABLE_MOBILE_BACK_COMP
130 if (!mStreamCallback.onStream) {
131 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_OUTPUT_DEFAULT");
132 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT;
134 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_OUTPUT_DEFAULT_ASYNC");
135 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT_ASYNC;
138 /* Override the default value by audio type */
139 if (audioType == CAudioInfo::EAudioType::AUDIO_OUT_TYPE_VOIP)
140 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_VOIP;
141 else if (audioType == CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA_NETWORK_SOURCE)
142 streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_HIGH;
144 CPulseStreamSpec spec(streamSpec, mAudioInfo);
146 std::unique_lock<std::mutex> mutex(mMutex);
147 mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_PLAYBACK,
149 mpPulseAudioClient->initialize();
150 #ifndef DISABLE_MOBILE_BACK_COMP
151 /* Uncork stream which is created with CORKED flag */
152 mpPulseAudioClient->cork(false);
157 } catch (const CAudioError& e) {
159 SAFE_FINALIZE(mpPulseAudioClient);
160 SAFE_DELETE(mpPulseAudioClient);
163 } catch (const std::bad_alloc&) {
164 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
168 void CAudioOutput::unprepare() {
170 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
171 "Did not initialize CAudioOutput"); //LCOV_EXCL_LINE
174 AUDIO_IO_LOGD("Already unprepared");
178 CAudioIO::unprepare();
180 std::unique_lock<std::mutex> mutex(mMutex);
181 if (mpPulseAudioClient && mpPulseAudioClient->isInThread())
182 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't unprepare inside pulseaudio thread");
183 SAFE_FINALIZE(mpPulseAudioClient);
184 SAFE_DELETE(mpPulseAudioClient);
187 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
190 void CAudioOutput::pause() {
191 if (!__IsInit() || !__IsReady())
192 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
193 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
195 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
196 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
197 "Can't pause if not in Running state");
199 if (mpPulseAudioClient->isInThread() )
200 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread"); //LCOV_EXCL_LINE
203 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
206 void CAudioOutput::resume() {
207 if (!__IsInit() || !__IsReady())
208 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
209 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
211 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED)
212 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
213 "Can't resume if not in Paused state");
215 if (mpPulseAudioClient->isInThread())
216 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread"); //LCOV_EXCL_LINE
219 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
222 void CAudioOutput::drain() {
223 if (!__IsInit() || !__IsReady())
224 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
225 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
227 if (mStreamCallback.onStream)
228 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "async type don't support drain");
230 std::unique_lock<std::mutex> defer_mutex(mMutex, std::defer_lock);
231 if (!mpPulseAudioClient->isInThread())
234 mpPulseAudioClient->drain();
237 void CAudioOutput::flush() {
238 if (!__IsInit() || !__IsReady())
239 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
240 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
245 int CAudioOutput::getBufferSize() {
247 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
248 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
250 /* FIXME : return calculated size here to satisfy backward compatibility */
251 return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
254 size_t CAudioOutput::write(const void* buffer, size_t length) {
255 if (!__IsInit() || !__IsReady())
256 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
257 "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
260 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
261 "Parameters are invalid - buffer:%p, length:%zu", buffer, length);
263 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
264 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
265 "Can't write if not in Running state");
267 /* When write() is called in PulseAudio callback, bypass a pcm data to CPulseAudioClient (For Asynchronous) */
268 if (mpPulseAudioClient && mpPulseAudioClient->isInThread()) {
269 int ret = mpPulseAudioClient->write(buffer, length);
271 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
272 "The written result is invalid ret:%d", ret);
273 #ifdef _AUDIO_IO_DEBUG_TIMING_
274 AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%zu)", buffer, length);
280 /* For synchronization */
281 std::unique_lock<std::mutex> mutex(mMutex);
283 // If another thread did call unprepare, do not write
284 if (!mpPulseAudioClient)
285 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
286 "Did not initialize CPulseAudioClient"); //LCOV_EXCL_LINE
288 // Sets synchronous flag
289 __mIsUsedSyncWrite = true;
290 size_t lengthIter = length;
292 while (lengthIter > 0) {
294 unsigned int timeouts = 0;
296 while ((l = mpPulseAudioClient->getWritableSize()) == 0) {
297 #ifdef _AUDIO_IO_DEBUG_TIMING_
298 AUDIO_IO_LOGD("writableSize is [%zu].. wait", l);
300 std::unique_lock<std::mutex> cond_mutex(mCondMutex);
301 if (mCond.wait_for(cond_mutex, cond_wait_ms) == std::cv_status::timeout) {
303 AUDIO_IO_LOGW("[%2u] timeout expired for waiting %lld ms of write available...", ++timeouts,
304 std::chrono::duration_cast<std::chrono::milliseconds>(cond_wait_ms).count());
305 if ((cond_wait_ms * timeouts) > writable_timeout_s)
306 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
307 "writable size is 0 for more than %lld seconds...",
308 std::chrono::duration_cast<std::chrono::seconds>(writable_timeout_s).count());
316 #ifdef _AUDIO_IO_DEBUG_TIMING_
317 AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%zu)", buffer, l);
320 int ret = mpPulseAudioClient->write(buffer, l);
322 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,//LCOV_EXCL_LINE
323 "The written result is invalid ret:%d", ret); //LCOV_EXCL_LINE
325 buffer = static_cast<const uint8_t*>(buffer) + l;
327 } // End of while (length > 0)
329 __mIsUsedSyncWrite = false;
333 } catch (const CAudioError& e) {
334 __mIsUsedSyncWrite = false;