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 <pulse/pulseaudio.h>
21 #include "CAudioIODef.h"
24 #define RECORDER_PRIVILEGE "http://tizen.org/privilege/recorder"
25 #define CLIENT_NAME "AUDIO_IO_PA_CLIENT"
28 using namespace tizen_media_audio;
30 struct PrivilegeData {
31 bool isPrivilegeAllowed;
32 pa_threaded_mainloop *paMainloop;
36 * class CAudioInput inherited by CAudioIO
38 CAudioInput::CAudioInput(CAudioInfo& info) :
40 __mIsUsedSyncRead(true),
42 mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_IN;
45 CAudioInput::CAudioInput(
46 unsigned int sampleRate,
47 CAudioInfo::EChannel channel,
48 CAudioInfo::ESampleType type,
49 CAudioInfo::EAudioType audioType) :
50 __mIsUsedSyncRead(true),
52 mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_IN;
53 mAudioInfo = CAudioInfo(sampleRate, channel, type, audioType, -1);
56 CAudioInput::~CAudioInput() {
59 void CAudioInput::onStream(CPulseAudioClient* pClient, size_t length) {
63 * Does not call CAudioIO::onStream() for synchronization
64 * if a user is using read()
66 if (__mIsUsedSyncRead == true) {
67 #ifdef _AUDIO_IO_DEBUG_TIMING_
68 AUDIO_IO_LOGD("Sync Read Mode! - pClient:[%p], length:[%d]", pClient, length);
74 * Accrues callback function
76 #ifdef _AUDIO_IO_DEBUG_TIMING_
77 AUDIO_IO_LOGD("pClient:[%p], length:[%d]", pClient, length);
79 CAudioIO::onStream(pClient, length);
82 void CAudioInput::onInterrupt(CAudioSessionHandler* pHandler, int id, mm_sound_focus_type_e focus_type,
83 mm_sound_focus_state_e state, const char *reason_for_change, const char *additional_info) {
85 AUDIO_IO_LOGD("[pHandler:%p], [focus_type:%d], [state:%d], [reason_for_change:%s], [additional_info:%s]",
86 pHandler, focus_type, state, reason_for_change, additional_info);
87 CAudioIO::onInterrupt(pHandler, id, focus_type, state, reason_for_change, additional_info);
90 void CAudioInput::onSignal(CAudioSessionHandler* pHandler, mm_sound_signal_name_t signal, int value) {
92 AUDIO_IO_LOGD("[pHandler:%p], [signal:%d], [value:%d]", pHandler, signal, value);
93 CAudioIO::onSignal(pHandler, signal, value);
96 void CAudioInput::__setInit(bool flag) {
100 bool CAudioInput::__IsInit() {
101 return (CAudioIO::isInit() == true && __mIsInit == true);
104 bool CAudioInput::__IsReady() {
105 return CAudioIO::IsReady();
108 static void __contextStateChangeCb(pa_context* c, void* user_data) {
109 pa_threaded_mainloop *paMainloop = static_cast<pa_threaded_mainloop*>(user_data);
113 switch (pa_context_get_state(c)) {
114 case PA_CONTEXT_READY:
115 AUDIO_IO_LOGD("The context is ready");
116 pa_threaded_mainloop_signal(paMainloop, 0);
119 case PA_CONTEXT_FAILED:
120 case PA_CONTEXT_TERMINATED:
121 AUDIO_IO_LOGD("The context is lost");
122 pa_threaded_mainloop_signal(paMainloop, 0);
125 case PA_CONTEXT_UNCONNECTED:
126 case PA_CONTEXT_CONNECTING:
127 case PA_CONTEXT_AUTHORIZING:
128 case PA_CONTEXT_SETTING_NAME:
133 static void __checkPrivilegeCb(pa_context *c, int success, void *user_data) {
134 AUDIO_IO_LOGD("pa_context[%p], success[%d], user_data[%p]", c, success, user_data);
138 PrivilegeData *prData = static_cast<PrivilegeData*>(user_data);
139 prData->isPrivilegeAllowed = success ? true : false;
141 pa_threaded_mainloop_signal(prData->paMainloop, 0);
144 static bool __IsPrivilegeAllowed() {
148 PrivilegeData prData;
150 prData.paMainloop = pa_threaded_mainloop_new();
151 if (prData.paMainloop == NULL)
152 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_threaded_mainloop_new()");
153 c = pa_context_new(pa_threaded_mainloop_get_api(prData.paMainloop), CLIENT_NAME);
155 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_new()");
157 pa_context_set_state_callback(c, __contextStateChangeCb, prData.paMainloop);
159 if (pa_context_connect(c, NULL, PA_CONTEXT_NOFLAGS, NULL) < 0)
160 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_connect()");
162 pa_threaded_mainloop_lock(prData.paMainloop);
164 if (pa_threaded_mainloop_start(prData.paMainloop) < 0) {
165 pa_threaded_mainloop_unlock(prData.paMainloop);
166 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_threaded_mainloop_start()");
170 pa_context_state_t state;
171 state = pa_context_get_state(c);
173 if (state == PA_CONTEXT_READY)
176 if (!PA_CONTEXT_IS_GOOD(state)) {
177 err = pa_context_errno(c);
178 pa_threaded_mainloop_unlock(prData.paMainloop);
179 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
180 "pa_context's state is not good : err[%d]", err);
183 /* Wait until the context is ready */
184 pa_threaded_mainloop_wait(prData.paMainloop);
187 o = pa_context_check_privilege(c, RECORDER_PRIVILEGE, __checkPrivilegeCb, &prData);
189 pa_threaded_mainloop_unlock(prData.paMainloop);
190 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed to pa_context_check_privilege()");
192 while (pa_operation_get_state(o) == PA_OPERATION_RUNNING)
193 pa_threaded_mainloop_wait(prData.paMainloop);
194 pa_operation_unref(o);
196 pa_threaded_mainloop_unlock(prData.paMainloop);
197 pa_threaded_mainloop_stop(prData.paMainloop);
198 pa_context_disconnect(c);
200 pa_threaded_mainloop_free(prData.paMainloop);
202 return prData.isPrivilegeAllowed;
205 void CAudioInput::initialize() throw(CAudioError) {
206 if (__IsInit() == true) {
211 CAudioIO::initialize();
212 if (__IsPrivilegeAllowed() == false) {
213 THROW_ERROR_MSG(CAudioError::EError::ERROR_PERMISSION_DENIED, "No privilege for record");
216 // Create ASM Handler
217 mpAudioSessionHandler = new CAudioSessionHandler(CAudioSessionHandler::EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE, mAudioInfo, this);
219 // Initialize ASM Handler
220 mpAudioSessionHandler->initialize();
223 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
224 } catch (CAudioError err) {
227 } catch (std::bad_alloc&) {
229 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CAudioSessionHandler object");
233 void CAudioInput::finalize() {
234 if (__IsInit() == false) {
235 AUDIO_IO_LOGD("Did not initialize");
239 SAFE_FINALIZE(mpAudioSessionHandler);
240 SAFE_DELETE(mpAudioSessionHandler);
242 CAudioIO::finalize();
247 void CAudioInput::prepare() throw(CAudioError) {
248 if (__IsInit() == false) {
249 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
252 if (__IsReady() == true) {
253 AUDIO_IO_LOGD("Already prepared CAudioInput");
260 // Check to invalid AudioType
261 CAudioInfo::EAudioType audioType = mAudioInfo.getAudioType();
262 if (audioType < CAudioInfo::EAudioType::AUDIO_IN_TYPE_MEDIA || audioType > CAudioInfo::EAudioType::AUDIO_IN_TYPE_LOOPBACK) {
263 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
264 "The audioType is invalid [type:%d]", static_cast<int>(audioType));
267 if (mpAudioSessionHandler->getId() < 0) { // Did not registerSound()
268 // Check session to skip registration
269 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSession() == false) {
270 // Register ASM Listener
271 AUDIO_IO_LOGD("Register ASM Listener");
272 mpAudioSessionHandler->registerSound();
276 CAudioIO::setInternalStreamInfo();
279 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_INPUT_DEFAULT");
280 CPulseStreamSpec::EStreamLatency streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_INPUT_DEFAULT;
281 CPulseStreamSpec spec(streamSpec, mAudioInfo);
283 // Create PulseAudio Handler
284 mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_RECORD, spec, this);
286 // Initialize PulseAudio Handler
287 mpPulseAudioClient->initialize();
289 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSession() == false)
290 mpAudioSessionHandler->updatePlaying();
296 } catch (CAudioError e) {
299 } catch (std::bad_alloc&) {
301 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
305 void CAudioInput::unprepare() throw(CAudioError) {
306 if (__IsInit() == false) {
307 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
308 "Did not initialize CAudioInput");
311 if (__IsReady() == false) {
312 AUDIO_IO_LOGD("Already unprepared");
317 CAudioIO::unprepare();
321 SAFE_FINALIZE(mpPulseAudioClient);
322 SAFE_DELETE(mpPulseAudioClient);
326 if (mpAudioSessionHandler->getId() >= 0) {
327 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSession() == false)
328 mpAudioSessionHandler->updateStop();
330 if (mpAudioSessionHandler->isSkipSession() == false)
331 mpAudioSessionHandler->unregisterSound();
334 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
335 } catch (CAudioError e) {
341 void CAudioInput::pause() throw(CAudioError) {
342 if (__IsInit() == false || __IsReady() == false) {
343 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
344 "Did not initialize or prepare CAudioInput");
347 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING) {
348 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
349 "Can't pause if not in Running state");
352 if (mpPulseAudioClient->isInThread() == true) {
353 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread");
361 /* Updates ASM to STOP */
362 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSession() == false) {
363 mpAudioSessionHandler->updateStop();
368 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
369 } catch (CAudioError e) {
375 void CAudioInput::resume() throw(CAudioError) {
376 if (__IsInit() == false || __IsReady() == false) {
377 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
378 "Did not initialize or prepare CAudioInput");
381 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED) {
382 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
383 "Can't resume if not in Paused state");
386 if (mpPulseAudioClient->isInThread() == true) {
387 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread");
393 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSession() == false)
394 mpAudioSessionHandler->updatePlaying();
400 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
401 } catch (CAudioError e) {
407 void CAudioInput::drain() throw(CAudioError) {
408 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "Did not support drain of CAudioInput");
411 void CAudioInput::flush() throw(CAudioError) {
412 if (__IsInit() == false || __IsReady() == false) {
413 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
414 "Did not initialize or prepare CAudioInput");
419 } catch (CAudioError e) {
424 int CAudioInput::getBufferSize() throw(CAudioError) {
425 if (__IsInit() == false) {
426 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
429 /* FIXME : return calculated size here to satisfy backward compatibility */
430 return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
433 void CAudioInput::setStreamCallback(SStreamCallback callback) throw(CAudioError) {
434 if (__IsInit() == false) {
435 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
438 if (callback.onStream == NULL) {
439 AUDIO_IO_LOGD("__mIsUsedSyncRead = true");
440 __mIsUsedSyncRead = true;
442 AUDIO_IO_LOGD("__mIsUsedSyncRead = false");
443 __mIsUsedSyncRead = false;
446 CAudioIO::setStreamCallback(callback);
449 size_t CAudioInput::read(void* buffer, size_t length) throw(CAudioError) {
450 if (__IsInit() == false || __IsReady() == false) {
451 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
452 "Did not initialize or prepare CAudioInput");
454 if (buffer == NULL) {
455 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
456 "Parameters are NULL buffer:%p", buffer);
458 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING) {
459 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
460 "Can't read if not in Running state");
462 /* Checks synchronous flag */
463 if (__mIsUsedSyncRead == false) {
464 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
465 "Invalid operation of read() if receive stream callback");
473 // If another thread did call unprepare, do not read
474 if (mpPulseAudioClient == NULL)
475 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
476 "Did not initialize CPulseAudioClient");
478 // Block until read done
479 ret = mpPulseAudioClient->read(buffer, length);
483 } catch (CAudioError e) {
491 int CAudioInput::peek(const void** buffer, size_t* length) throw(CAudioError) {
492 if (__IsInit() == false || __IsReady() == false) {
493 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
494 "Did not initialize or prepare CAudioInput");
497 if (buffer == NULL || length == NULL) {
498 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
499 "Parameters are NULL buffer:%p, length:%p", buffer, length);
502 /* Checks synchronous flag */
503 if (__mIsUsedSyncRead == true) {
504 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
505 "Invalid operation of peek() if does not receive a stream callback");
511 ret = mpPulseAudioClient->peek(buffer, length);
512 } catch (CAudioError e) {
519 int CAudioInput::drop() throw(CAudioError) {
520 if (__IsInit() == false || __IsReady() == false) {
521 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
522 "Did not initialize or prepare CAudioInput");
525 /* Checks synchronous flag */
526 if (__mIsUsedSyncRead == true) {
527 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
528 "Invalid operation of drop() if does not receive a stream callback");
534 ret = mpPulseAudioClient->drop();
535 } catch (CAudioError e) {