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.
18 #include <pulse/pulseaudio.h>
19 #include "CAudioIODef.h"
21 #define RECORDER_PRIVILEGE "http://tizen.org/privilege/recorder"
22 #define CLIENT_NAME "AUDIO_IO_PA_CLIENT"
25 using namespace tizen_media_audio;
27 struct PrivilegeData {
28 bool isPrivilegeAllowed;
29 pa_threaded_mainloop *paMainloop;
33 * class CAudioInput inherited by CAudioIO
35 CAudioInput::CAudioInput(CAudioInfo& info) :
37 __mIsUsedSyncRead(true),
41 CAudioInput::CAudioInput(
42 unsigned int sampleRate,
43 CAudioInfo::EChannel channel,
44 CAudioInfo::ESampleType type,
45 CAudioInfo::EAudioType audioType) :
46 __mIsUsedSyncRead(true),
48 mAudioInfo = CAudioInfo(sampleRate, channel, type, audioType, -1);
51 CAudioInput::~CAudioInput() {
54 void CAudioInput::onStream(CPulseAudioClient* pClient, size_t length) {
58 * Does not call CAudioIO::onStream() for synchronization
59 * if a user is using read()
61 if (__mIsUsedSyncRead == true) {
62 #ifdef _AUDIO_IO_DEBUG_TIMING_
63 AUDIO_IO_LOGD("Sync Read Mode! - pClient:[%p], length:[%d]", pClient, length);
69 * Accrues callback function
71 #ifdef _AUDIO_IO_DEBUG_TIMING_
72 AUDIO_IO_LOGD("pClient:[%p], length:[%d]", pClient, length);
74 CAudioIO::onStream(pClient, length);
77 void CAudioInput::onInterrupt(CAudioSessionHandler* pHandler, int id, mm_sound_focus_type_e focus_type, mm_sound_focus_state_e state, const char *reason_for_change, const char *additional_info) {
79 AUDIO_IO_LOGD("[pHandler:0x%x], [focus_type:%d], [state:%d], [reason_for_change:%s], [additional_info:%s]", pHandler, focus_type, state, reason_for_change, additional_info);
80 CAudioIO::onInterrupt(pHandler, id, focus_type, state, reason_for_change, additional_info);
83 void CAudioInput::onSignal(CAudioSessionHandler* pHandler, mm_sound_signal_name_t signal, int value) {
85 AUDIO_IO_LOGD("[pHandler:0x%x], [signal:%d], [value:%d]", pHandler, signal, value);
86 CAudioIO::onSignal(pHandler, signal, value);
89 void CAudioInput::__setInit(bool flag) {
93 bool CAudioInput::__IsInit() {
94 return (CAudioIO::isInit() == true && __mIsInit == true);
97 bool CAudioInput::__IsReady() {
98 return CAudioIO::IsReady();
101 static void __contextStateChangeCb(pa_context* c, void* user_data) {
102 pa_threaded_mainloop *paMainloop = static_cast<pa_threaded_mainloop*>(user_data);
106 switch (pa_context_get_state(c)) {
107 case PA_CONTEXT_READY:
108 AUDIO_IO_LOGD("The context is ready");
109 pa_threaded_mainloop_signal(paMainloop, 0);
112 case PA_CONTEXT_FAILED:
113 case PA_CONTEXT_TERMINATED:
114 AUDIO_IO_LOGD("The context is lost");
115 pa_threaded_mainloop_signal(paMainloop, 0);
118 case PA_CONTEXT_UNCONNECTED:
119 case PA_CONTEXT_CONNECTING:
120 case PA_CONTEXT_AUTHORIZING:
121 case PA_CONTEXT_SETTING_NAME:
126 static void __checkPrivilegeCb(pa_context *c, int success, void *user_data) {
127 AUDIO_IO_LOGD("pa_context[%p], success[%d], user_data[%p]", c, success, user_data);
131 PrivilegeData *prData = static_cast<PrivilegeData*>(user_data);
132 prData->isPrivilegeAllowed = success ? true : false;
134 pa_threaded_mainloop_signal(prData->paMainloop, 0);
137 static bool __IsPrivilegeAllowed() {
141 PrivilegeData prData;
143 prData.paMainloop = pa_threaded_mainloop_new();
144 if (prData.paMainloop == NULL)
145 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_threaded_mainloop_new()");
146 c = pa_context_new(pa_threaded_mainloop_get_api(prData.paMainloop), CLIENT_NAME);
148 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_new()");
150 pa_context_set_state_callback(c, __contextStateChangeCb, prData.paMainloop);
152 if (pa_context_connect(c, NULL, PA_CONTEXT_NOFLAGS, NULL) < 0)
153 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_connect()");
155 pa_threaded_mainloop_lock(prData.paMainloop);
157 if (pa_threaded_mainloop_start(prData.paMainloop) < 0) {
158 pa_threaded_mainloop_unlock(prData.paMainloop);
159 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_threaded_mainloop_start()");
163 pa_context_state_t state;
164 state = pa_context_get_state(c);
166 if (state == PA_CONTEXT_READY)
169 if (!PA_CONTEXT_IS_GOOD(state)) {
170 err = pa_context_errno(c);
171 pa_threaded_mainloop_unlock(prData.paMainloop);
172 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION, "pa_context's state is not good : err[%d]", err);
175 /* Wait until the context is ready */
176 pa_threaded_mainloop_wait(prData.paMainloop);
179 o = pa_context_check_privilege(c, RECORDER_PRIVILEGE, __checkPrivilegeCb, &prData);
181 pa_threaded_mainloop_unlock(prData.paMainloop);
182 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed to pa_context_check_privilege()");
184 while (pa_operation_get_state(o) == PA_OPERATION_RUNNING)
185 pa_threaded_mainloop_wait(prData.paMainloop);
186 pa_operation_unref(o);
188 pa_threaded_mainloop_unlock(prData.paMainloop);
189 pa_threaded_mainloop_stop(prData.paMainloop);
190 pa_context_disconnect(c);
192 pa_threaded_mainloop_free(prData.paMainloop);
194 return prData.isPrivilegeAllowed;
197 void CAudioInput::initialize() throw(CAudioError) {
198 if (__IsInit() == true) {
203 CAudioIO::initialize();
204 if (__IsPrivilegeAllowed() == false) {
205 THROW_ERROR_MSG(CAudioError::EError::ERROR_PERMISSION_DENIED, "No privilege for record");
208 // Create ASM Handler
209 mpAudioSessionHandler = new CAudioSessionHandler(CAudioSessionHandler::EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE, mAudioInfo, this);
210 if (mpAudioSessionHandler == NULL) {
211 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CAudioSessionHandler object");
214 // Initialize ASM Handler
215 mpAudioSessionHandler->initialize();
218 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
219 } catch (CAudioError err) {
225 void CAudioInput::finalize() {
226 if (__IsInit() == false) {
227 AUDIO_IO_LOGD("Did not initialize");
231 SAFE_FINALIZE(mpAudioSessionHandler);
232 SAFE_DELETE(mpAudioSessionHandler);
234 CAudioIO::finalize();
239 void CAudioInput::prepare() throw(CAudioError) {
240 if (__IsInit() == false) {
241 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
244 if (__IsReady() == true) {
245 AUDIO_IO_LOGD("Already prepared CAudioInput");
252 // Check to invalid AudioType
253 CAudioInfo::EAudioType audioType = mAudioInfo.getAudioType();
254 if (audioType < CAudioInfo::EAudioType::AUDIO_IN_TYPE_MEDIA || audioType > CAudioInfo::EAudioType::AUDIO_IN_TYPE_LOOPBACK) {
255 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT, "The audioType is invalid [type:%d]", static_cast<int>(audioType));
258 if (mpAudioSessionHandler->getId() < 0) { // Did not registerSound()
259 // Check session to skip registration
260 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSessionEvent() == false) {
261 // Register ASM Listener
262 AUDIO_IO_LOGD("Register ASM Listener");
263 mpAudioSessionHandler->registerSound();
268 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_INPUT_DEFAULT");
269 CPulseStreamSpec::EStreamLatency streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_INPUT_DEFAULT;
270 CPulseStreamSpec spec(streamSpec, mAudioInfo);
272 // Create PulseAudio Handler
273 mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_RECORD, spec, this);
274 if (mpPulseAudioClient == NULL) {
275 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
278 // Initialize PulseAudio Handler
279 mpPulseAudioClient->initialize();
281 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSessionEvent() == false) {
282 /* Updates ASM to PLAYING */
283 mpAudioSessionHandler->updatePlaying();
290 } catch (CAudioError e) {
296 void CAudioInput::unprepare() throw(CAudioError) {
297 if (__IsInit() == false) {
298 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
301 if (__IsReady() == false) {
302 AUDIO_IO_LOGD("Already unprepared");
308 CAudioIO::unprepare();
312 SAFE_FINALIZE(mpPulseAudioClient);
313 SAFE_DELETE(mpPulseAudioClient);
315 if (mpAudioSessionHandler->getId() >= 0) {
316 /* Updates ASM to STOP */
317 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSessionEvent() == false) {
318 mpAudioSessionHandler->updateStop();
321 bool isSkip = mpAudioSessionHandler->isSkipSessionEvent();
322 if (isSkip == false) {
323 mpAudioSessionHandler->unregisterSound();
329 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
330 } catch (CAudioError e) {
336 void CAudioInput::pause() throw(CAudioError) {
337 if (__IsInit() == false || __IsReady() == false) {
338 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize or prepare CAudioInput");
341 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING) {
342 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
343 "Can't pause if not in Running state");
346 if (mpPulseAudioClient->isInThread() == true) {
347 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread");
355 /* Updates ASM to STOP */
356 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSessionEvent() == false) {
357 mpAudioSessionHandler->updateStop();
362 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
363 } catch (CAudioError e) {
369 void CAudioInput::resume() throw(CAudioError) {
370 if (__IsInit() == false || __IsReady() == false) {
371 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize or prepare CAudioInput");
374 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED) {
375 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
376 "Can't resume if not in Paused state");
379 if (mpPulseAudioClient->isInThread() == true) {
380 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread");
386 if (isForceIgnore() == false && mpAudioSessionHandler->isSkipSessionEvent() == false) {
387 /* Updates ASM to PLAYING */
388 mpAudioSessionHandler->updatePlaying();
395 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
396 } catch (CAudioError e) {
402 void CAudioInput::drain() throw(CAudioError) {
403 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "Did not support drain of CAudioInput");
406 void CAudioInput::flush() throw(CAudioError) {
407 if (__IsInit() == false || __IsReady() == false) {
408 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize or prepare CAudioInput");
413 } catch (CAudioError e) {
418 int CAudioInput::getBufferSize() throw(CAudioError) {
419 if (__IsInit() == false) {
420 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
423 /* FIXME : return calculated size here to satisfy backward compatibility */
424 return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
427 void CAudioInput::setStreamCallback(SStreamCallback callback) throw(CAudioError) {
428 if (__IsInit() == false) {
429 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
432 if (callback.onStream == NULL) {
433 AUDIO_IO_LOGD("__mIsUsedSyncRead = true");
434 __mIsUsedSyncRead = true;
436 AUDIO_IO_LOGD("__mIsUsedSyncRead = false");
437 __mIsUsedSyncRead = false;
440 CAudioIO::setStreamCallback(callback);
443 size_t CAudioInput::read(void* buffer, size_t length) throw(CAudioError) {
444 if (__IsInit() == false || __IsReady() == false) {
445 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize or prepare CAudioInput");
448 if (buffer == NULL) {
449 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT, "Parameters are NULL buffer:%p", buffer);
451 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING) {
452 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
453 "Can't read if not in Running state");
455 /* Checks synchronous flag */
456 if (__mIsUsedSyncRead == false) {
457 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Invalid operation of read() if receive stream callback");
465 // If another thread did call unprepare, do not read
466 if (mpPulseAudioClient == NULL)
467 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CPulseAudioClient");
469 // Block until read done
470 ret = mpPulseAudioClient->read(buffer, length);
473 } catch (CAudioError e) {
481 int CAudioInput::peek(const void** buffer, size_t* length) throw(CAudioError) {
482 if (__IsInit() == false || __IsReady() == false) {
483 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize or prepare CAudioInput");
486 if (buffer == NULL || length == NULL) {
487 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT, "Parameters are NULL buffer:%p, length:%p", buffer, length);
490 /* Checks synchronous flag */
491 if (__mIsUsedSyncRead == true) {
492 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Invalid operation of peek() if does not receive a stream callback");
498 ret = mpPulseAudioClient->peek(buffer, length);
499 } catch (CAudioError e) {
506 int CAudioInput::drop() throw(CAudioError) {
507 if (__IsInit() == false || __IsReady() == false) {
508 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize or prepare CAudioInput");
511 /* Checks synchronous flag */
512 if (__mIsUsedSyncRead == true) {
513 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Invalid operation of drop() if does not receive a stream callback");
519 ret = mpPulseAudioClient->drop();
520 } catch (CAudioError e) {