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);
88 CAudioIO::onInterrupt(pHandler, id, focus_type, state, reason_for_change, additional_info);
91 void CAudioInput::onSignal(CAudioSessionHandler* pHandler, mm_sound_signal_name_t signal, int value) {
93 AUDIO_IO_LOGD("[pHandler:%p], [signal:%d], [value:%d]", pHandler, signal, value);
95 CAudioIO::onSignal(pHandler, signal, value);
98 void CAudioInput::__setInit(bool flag) {
102 bool CAudioInput::__IsInit() {
103 return (CAudioIO::isInit() == true && __mIsInit == true);
106 bool CAudioInput::__IsReady() {
107 return CAudioIO::IsReady();
110 static void __contextStateChangeCb(pa_context* c, void* user_data) {
111 pa_threaded_mainloop *paMainloop = static_cast<pa_threaded_mainloop*>(user_data);
115 switch (pa_context_get_state(c)) {
116 case PA_CONTEXT_READY:
117 AUDIO_IO_LOGD("The context is ready");
118 pa_threaded_mainloop_signal(paMainloop, 0);
121 case PA_CONTEXT_FAILED:
122 case PA_CONTEXT_TERMINATED:
123 AUDIO_IO_LOGD("The context is lost");
124 pa_threaded_mainloop_signal(paMainloop, 0);
127 case PA_CONTEXT_UNCONNECTED:
128 case PA_CONTEXT_CONNECTING:
129 case PA_CONTEXT_AUTHORIZING:
130 case PA_CONTEXT_SETTING_NAME:
135 static void __checkPrivilegeCb(pa_context *c, int success, void *user_data) {
136 AUDIO_IO_LOGD("pa_context[%p], success[%d], user_data[%p]", c, success, user_data);
140 PrivilegeData *prData = static_cast<PrivilegeData*>(user_data);
141 prData->isPrivilegeAllowed = success ? true : false;
143 pa_threaded_mainloop_signal(prData->paMainloop, 0);
146 static bool __IsPrivilegeAllowed() {
150 PrivilegeData prData;
152 prData.paMainloop = pa_threaded_mainloop_new();
153 if (prData.paMainloop == NULL)
154 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_threaded_mainloop_new()");
156 c = pa_context_new(pa_threaded_mainloop_get_api(prData.paMainloop), CLIENT_NAME);
158 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_new()");
160 pa_context_set_state_callback(c, __contextStateChangeCb, prData.paMainloop);
162 if (pa_context_connect(c, NULL, PA_CONTEXT_NOFLAGS, NULL) < 0)
163 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed pa_context_connect()");
165 pa_threaded_mainloop_lock(prData.paMainloop);
167 if (pa_threaded_mainloop_start(prData.paMainloop) < 0) {
168 pa_threaded_mainloop_unlock(prData.paMainloop);
169 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed pa_threaded_mainloop_start()");
173 pa_context_state_t state;
174 state = pa_context_get_state(c);
176 if (state == PA_CONTEXT_READY)
179 if (!PA_CONTEXT_IS_GOOD(state)) {
180 err = pa_context_errno(c);
181 pa_threaded_mainloop_unlock(prData.paMainloop);
182 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
183 "pa_context's state is not good : err[%d]", err);
186 /* Wait until the context is ready */
187 pa_threaded_mainloop_wait(prData.paMainloop);
190 o = pa_context_check_privilege(c, RECORDER_PRIVILEGE, __checkPrivilegeCb, &prData);
192 pa_threaded_mainloop_unlock(prData.paMainloop);
193 THROW_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed to pa_context_check_privilege()");
195 while (pa_operation_get_state(o) == PA_OPERATION_RUNNING)
196 pa_threaded_mainloop_wait(prData.paMainloop);
197 pa_operation_unref(o);
199 pa_threaded_mainloop_unlock(prData.paMainloop);
200 pa_threaded_mainloop_stop(prData.paMainloop);
201 pa_context_disconnect(c);
203 pa_threaded_mainloop_free(prData.paMainloop);
205 return prData.isPrivilegeAllowed;
208 void CAudioInput::initialize() {
209 if (__IsInit() == true)
213 CAudioIO::initialize();
214 } catch (CAudioError& e) {
219 if (__IsPrivilegeAllowed() == false)
220 THROW_ERROR_MSG(CAudioError::EError::ERROR_PERMISSION_DENIED, "No privilege for record");
223 internalSessionLock();
224 mpAudioSessionHandler = new CAudioSessionHandler(CAudioSessionHandler::EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE, mAudioInfo, this);
225 mpAudioSessionHandler->initialize();
226 internalSessionUnlock();
227 } catch (CAudioError& e) {
228 internalSessionUnlock();
231 } catch (const std::bad_alloc&) {
232 internalSessionUnlock();
234 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CAudioSessionHandler object");
238 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
241 void CAudioInput::finalize() {
242 if (__IsInit() == false) {
243 AUDIO_IO_LOGD("Did not initialize");
247 internalSessionLock();
248 SAFE_FINALIZE(mpAudioSessionHandler);
249 SAFE_DELETE(mpAudioSessionHandler);
250 internalSessionUnlock();
252 CAudioIO::finalize();
257 void CAudioInput::prepare() {
258 if (__IsInit() == false)
259 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
261 if (__IsReady() == true) {
262 AUDIO_IO_LOGD("Already prepared CAudioInput");
267 /* Check invalid AudioType */
268 CAudioInfo::EAudioType audioType = mAudioInfo.getAudioType();
269 if (audioType < CAudioInfo::EAudioType::AUDIO_IN_TYPE_MEDIA ||
270 audioType >= CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA)
271 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
272 "The audioType is invalid [type:%d]", static_cast<int>(audioType));
275 internalSessionLock();
276 if (mpAudioSessionHandler &&
277 mpAudioSessionHandler->getId() < 0) { // Did not registerSound()
278 if (isForceIgnore() == false &&
279 mpAudioSessionHandler->isSkipSession() == false) {
280 AUDIO_IO_LOGD("Register ASM Listener");
281 mpAudioSessionHandler->registerSound();
284 internalSessionUnlock();
285 } catch (CAudioError& e) {
286 internalSessionUnlock();
290 CAudioIO::setInternalStreamInfo();
293 internalSessionLock();
294 if (isSessionEnabled() && isForceIgnore() == false)
295 mpAudioSessionHandler->updatePlaying();
296 internalSessionUnlock();
297 } catch (CAudioError& e) {
298 internalSessionUnlock();
303 /* Init StreamSpec */
304 AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_INPUT_DEFAULT");
305 CPulseStreamSpec::EStreamLatency streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_INPUT_DEFAULT;
306 CPulseStreamSpec spec(streamSpec, mAudioInfo);
309 mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_RECORD, spec, this);
310 mpPulseAudioClient->initialize();
311 #ifndef DISABLE_MOBILE_BACK_COMP
312 /* Uncork stream which is created with CORKED flag */
313 mpPulseAudioClient->cork(false);
318 } catch (CAudioError& e) {
319 SAFE_FINALIZE(mpPulseAudioClient);
320 SAFE_DELETE(mpPulseAudioClient);
323 } catch (const std::bad_alloc&) {
325 THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
329 void CAudioInput::unprepare() {
330 if (__IsInit() == false)
331 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
332 "Did not initialize CAudioInput");
334 if (__IsReady() == false) {
335 AUDIO_IO_LOGD("Already unprepared");
339 CAudioIO::unprepare();
343 if (mpPulseAudioClient && mpPulseAudioClient->isInThread())
344 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't unprepare inside pulseaudio thread");
345 SAFE_FINALIZE(mpPulseAudioClient);
346 SAFE_DELETE(mpPulseAudioClient);
348 } catch (CAudioError& e) {
354 internalSessionLock();
355 if (isSessionEnabled() && isForceIgnore() == false)
356 mpAudioSessionHandler->updateStop();
357 internalSessionUnlock();
359 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
360 } catch (CAudioError& e) {
361 internalSessionUnlock();
366 void CAudioInput::pause() {
367 if (__IsInit() == false || __IsReady() == false)
368 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
369 "Did not initialize or prepare CAudioInput");
371 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
372 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
373 "Can't pause if not in Running state");
375 if (mpPulseAudioClient->isInThread() == true)
376 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread");
379 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
382 void CAudioInput::resume() {
383 if (__IsInit() == false || __IsReady() == false)
384 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
385 "Did not initialize or prepare CAudioInput");
387 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED)
388 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
389 "Can't resume if not in Paused state");
391 if (mpPulseAudioClient->isInThread() == true)
392 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread");
395 CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
398 void CAudioInput::drain() {
399 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "Did not support drain of CAudioInput");
402 void CAudioInput::flush() {
403 if (__IsInit() == false || __IsReady() == false)
404 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
405 "Did not initialize or prepare CAudioInput");
410 int CAudioInput::getBufferSize() {
411 if (__IsInit() == false)
412 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
414 /* FIXME : return calculated size here to satisfy backward compatibility */
415 return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
418 void CAudioInput::setStreamCallback(SStreamCallback callback) {
419 if (__IsInit() == false)
420 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput");
422 if (callback.onStream == NULL)
423 __mIsUsedSyncRead = true;
425 __mIsUsedSyncRead = false;
426 AUDIO_IO_LOGD("__mIsUsedSyncRead = %d", __mIsUsedSyncRead);
428 CAudioIO::setStreamCallback(callback);
431 size_t CAudioInput::read(void* buffer, size_t length) {
432 if (__IsInit() == false || __IsReady() == false)
433 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
434 "Did not initialize or prepare CAudioInput");
437 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
438 "Parameters are NULL buffer:%p", buffer);
440 if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
441 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
442 "Can't read if not in Running state");
444 /* Checks synchronous flag */
445 if (__mIsUsedSyncRead == false)
446 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
447 "Invalid operation of read() if receive stream callback");
454 THROW_ERROR_MSG(CAudioError::EError::ERROR_POLICY_BLOCKED, "audio-io is interrupted");
456 // If another thread did call unprepare, do not read
457 if (mpPulseAudioClient == NULL)
458 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
459 "Did not initialize CPulseAudioClient");
461 // Block until read done
462 ret = mpPulseAudioClient->read(buffer, length);
466 } catch (CAudioError& e) {
474 int CAudioInput::peek(const void** buffer, size_t* length) {
475 if (__IsInit() == false || __IsReady() == false)
476 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
477 "Did not initialize or prepare CAudioInput");
479 if (buffer == NULL || length == NULL)
480 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
481 "Parameters are NULL buffer:%p, length:%p", buffer, length);
483 /* Checks synchronous flag */
484 if (__mIsUsedSyncRead == true)
485 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
486 "Invalid operation of peek() if does not receive a stream callback");
488 return mpPulseAudioClient->peek(buffer, length);
491 int CAudioInput::drop() {
492 if (__IsInit() == false || __IsReady() == false)
493 THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
494 "Did not initialize or prepare CAudioInput");
496 /* Checks synchronous flag */
497 if (__mIsUsedSyncRead == true)
498 THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
499 "Invalid operation of drop() if does not receive a stream callback");
501 return mpPulseAudioClient->drop();