src/cpp/CAudioInput.cpp

   1 /*
   2  * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17
  18 #include <new>
  19
  20 #include "CAudioIODef.h"
  21 #include <sched.h>
  22 #include "cpp_audio_in_privilege.h"
  23
  24 #define RECORDER_PRIVILEGE "http://tizen.org/privilege/recorder"
  25 #define CLIENT_NAME "AUDIO_IO_PA_CLIENT"
  26
  27 using namespace std;
  28 using namespace tizen_media_audio;
  29
  30 /**
  31  * class CAudioInput inherited by CAudioIO
  32  */
  33 CAudioInput::CAudioInput(CAudioInfo& info) :
  34     CAudioIO(info),
  35     __mIsUsedSyncRead(true),
  36     __mIsInit(false) {
  37     mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_IN;
  38 }
  39
  40 void CAudioInput::onStream(CPulseAudioClient* pClient, size_t length) {
  41     assert(pClient);
  42
  43     /*
  44      * Does not call CAudioIO::onStream() for synchronization
  45      * if a user is using read()
  46      */
  47     if (__mIsUsedSyncRead) {
  48 #ifdef _AUDIO_IO_DEBUG_TIMING_
  49         AUDIO_IO_LOGD("Sync Read Mode! - pClient:[%p], length:[%zu]", pClient, length);
  50 #endif
  51         return;
  52     }
  53
  54     /*
  55      * Accrues callback function
  56      */
  57 #ifdef _AUDIO_IO_DEBUG_TIMING_
  58     AUDIO_IO_LOGD("pClient:[%p], length:[%zu]", pClient, length);
  59 #endif
  60     CAudioIO::onStream(pClient, length);
  61 }
  62
  63 void CAudioInput::__setInit(bool flag) noexcept {
  64     __mIsInit = flag;
  65 }
  66
  67 bool CAudioInput::__IsInit() noexcept {
  68     return (CAudioIO::isInit() && __mIsInit);
  69 }
  70
  71 bool CAudioInput::__IsReady() noexcept {
  72     return CAudioIO::IsReady();
  73 }
  74
  75 void CAudioInput::initialize() {
  76     if (__IsInit())
  77         return;
  78
  79     if (!cpp_audio_in_has_record_privilege())
  80         THROW_ERROR_MSG(CAudioError::EError::ERROR_PERMISSION_DENIED, "No privilege for record");
  81
  82     try {
  83         CAudioIO::initialize();
  84         __setInit(true);
  85     } catch (const CAudioError& e) {
  86 //LCOV_EXCL_START
  87         finalize();
  88         throw;
  89 //LCOV_EXCL_STOP
  90     }
  91
  92     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
  93 }
  94
  95 void CAudioInput::finalize() {
  96     if (!__IsInit()) {
  97 //LCOV_EXCL_START
  98         AUDIO_IO_LOGD("Did not initialize");
  99         return;
 100 //LCOV_EXCL_STOP
 101     }
 102
 103     CAudioIO::finalize();
 104
 105     __setInit(false);
 106 }
 107
 108 void CAudioInput::prepare() {
 109     if (!__IsInit())
 110         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput"); //LCOV_EXCL_LINE
 111
 112     if (__IsReady()) {
 113         AUDIO_IO_LOGD("Already prepared CAudioInput");
 114         CAudioIO::prepare();
 115         return;
 116     }
 117
 118     /* Check invalid AudioType */
 119     CAudioInfo::EAudioType audioType = mAudioInfo.getAudioType();
 120     if (audioType < CAudioInfo::EAudioType::AUDIO_IN_TYPE_MEDIA ||
 121         audioType >= CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA)
 122         THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
 123                                "The audioType is invalid [type:%d]", static_cast<int>(audioType));
 124
 125     try {
 126         /* Init StreamSpec */
 127         AUDIO_IO_LOGD("Set Stream Spec : CPulseStreamSpec::STREAM_LATENCY_INPUT_DEFAULT");
 128         CPulseStreamSpec::EStreamLatency streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_INPUT_DEFAULT;
 129         /* Override the default value by audio type */
 130         if (audioType == CAudioInfo::EAudioType::AUDIO_IN_TYPE_VOIP)
 131             streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_INPUT_VOIP;
 132
 133         CPulseStreamSpec spec(streamSpec, mAudioInfo);
 134
 135         internalLock();
 136         mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_RECORD, spec, this);
 137         mpPulseAudioClient->initialize();
 138 #ifndef DISABLE_MOBILE_BACK_COMP
 139         /* Uncork stream which is created with CORKED flag */
 140         mpPulseAudioClient->cork(false);
 141 #endif
 142         internalUnlock();
 143
 144         CAudioIO::prepare();
 145     } catch (const CAudioError& e) {
 146 //LCOV_EXCL_START
 147         SAFE_FINALIZE(mpPulseAudioClient);
 148         SAFE_DELETE(mpPulseAudioClient);
 149         internalUnlock();
 150         throw;
 151 //LCOV_EXCL_STOP
 152     } catch (const std::bad_alloc&) {
 153 //LCOV_EXCL_START
 154         internalUnlock();
 155         THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
 156 //LCOV_EXCL_STOP
 157     }
 158 }
 159
 160 void CAudioInput::unprepare() {
 161     if (!__IsInit())
 162         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
 163                         "Did not initialize CAudioInput");          //LCOV_EXCL_LINE
 164
 165     if (!__IsReady()) {
 166         AUDIO_IO_LOGD("Already unprepared");
 167         return;
 168     }
 169
 170     CAudioIO::unprepare();
 171
 172     try {
 173         internalLock();
 174         if (mpPulseAudioClient && mpPulseAudioClient->isInThread())
 175             THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't unprepare inside pulseaudio thread");
 176         SAFE_FINALIZE(mpPulseAudioClient);
 177         SAFE_DELETE(mpPulseAudioClient);
 178         internalUnlock();
 179     } catch (const CAudioError& e) {
 180 //LCOV_EXCL_START
 181         internalUnlock();
 182         throw;
 183 //LCOV_EXCL_STOP
 184     }
 185
 186     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
 187 }
 188
 189 void CAudioInput::pause() {
 190     if (!__IsInit() || !__IsReady())
 191         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,   //LCOV_EXCL_LINE
 192                         "Did not initialize or prepare CAudioInput"); //LCOV_EXCL_LINE
 193
 194     if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
 195         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
 196                         "Can't pause if not in Running state");
 197
 198     if (mpPulseAudioClient->isInThread())
 199         THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread"); //LCOV_EXCL_LINE
 200
 201     CAudioIO::pause();
 202     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
 203 }
 204
 205 void CAudioInput::resume() {
 206     if (!__IsInit() || !__IsReady())
 207         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,   //LCOV_EXCL_LINE
 208                         "Did not initialize or prepare CAudioInput"); //LCOV_EXCL_LINE
 209
 210     if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED)
 211         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
 212                         "Can't resume if not in Paused state");
 213
 214     if (mpPulseAudioClient->isInThread())
 215         THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread"); //LCOV_EXCL_LINE
 216
 217     CAudioIO::resume();
 218     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
 219 }
 220
 221 void CAudioInput::flush() {
 222     if (!__IsInit() || !__IsReady())
 223         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,   //LCOV_EXCL_LINE
 224                         "Did not initialize or prepare CAudioInput"); //LCOV_EXCL_LINE
 225
 226     CAudioIO::flush();
 227 }
 228
 229 int CAudioInput::getBufferSize() {
 230     if (!__IsInit())
 231         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput"); //LCOV_EXCL_LINE
 232
 233     /* FIXME : return calculated size here to satisfy backward compatibility */
 234     return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
 235 }
 236
 237 void CAudioInput::setStreamCallback(SStreamCallback callback) {
 238     if (!__IsInit())
 239         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioInput"); //LCOV_EXCL_LINE
 240
 241     __mIsUsedSyncRead = (callback.onStream == nullptr);
 242
 243     AUDIO_IO_LOGD("__mIsUsedSyncRead = %d", __mIsUsedSyncRead);
 244
 245     CAudioIO::setStreamCallback(callback);
 246 }
 247
 248 size_t CAudioInput::read(void* buffer, size_t length) {
 249     if (!__IsInit() || !__IsReady())
 250         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,   //LCOV_EXCL_LINE
 251                         "Did not initialize or prepare CAudioInput"); //LCOV_EXCL_LINE
 252
 253     if (!buffer)
 254         THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
 255                                "Parameters are NULL buffer:%p", buffer);
 256
 257     if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
 258         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
 259                         "Can't read if not in Running state");
 260
 261     /* Checks synchronous flag */
 262     if (!__mIsUsedSyncRead)
 263         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
 264                         "Invalid operation of read() if receive stream callback");
 265
 266     int ret = 0;
 267
 268     try {
 269         internalLock();
 270
 271         // If another thread did call unprepare, do not read
 272         if (!mpPulseAudioClient)
 273             THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
 274                             "Did not initialize CPulseAudioClient");    //LCOV_EXCL_LINE
 275
 276         // Block until read done
 277         ret = mpPulseAudioClient->read(buffer, length);
 278         internalUnlock();
 279
 280         sched_yield();
 281     } catch (const CAudioError& e) {
 282 //LCOV_EXCL_START
 283         internalUnlock();
 284         throw;
 285 //LCOV_EXCL_STOP
 286     }
 287
 288     return ret;
 289 }
 290
 291 int CAudioInput::peek(const void** buffer, size_t* length) {
 292     if (!__IsInit() || !__IsReady())
 293         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,   //LCOV_EXCL_LINE
 294                         "Did not initialize or prepare CAudioInput"); //LCOV_EXCL_LINE
 295
 296     if (buffer == nullptr || length == nullptr)
 297         THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,                 //LCOV_EXCL_LINE
 298                                "Parameters are NULL buffer:%p, length:%p", buffer, length); //LCOV_EXCL_LINE
 299
 300     /* Checks synchronous flag */
 301     if (__mIsUsedSyncRead)
 302         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
 303                         "Invalid operation of peek() if does not receive a stream callback");
 304
 305     return mpPulseAudioClient->peek(buffer, length);
 306 }
 307
 308 int CAudioInput::drop() {
 309     if (!__IsInit() || !__IsReady())
 310         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,   //LCOV_EXCL_LINE
 311                         "Did not initialize or prepare CAudioInput"); //LCOV_EXCL_LINE
 312
 313     /* Checks synchronous flag */
 314     if (__mIsUsedSyncRead)
 315         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION,
 316                         "Invalid operation of drop() if does not receive a stream callback");
 317
 318     return mpPulseAudioClient->drop();
 319 }