Use in-class initializer for class members
[platform/core/api/audio-io.git] / src / cpp / CAudioOutput.cpp
index 96b7531..2aa032e 100644 (file)
 
 #include "CAudioIODef.h"
 #include <sched.h>
+#include <chrono>
 
 using namespace std;
 using namespace tizen_media_audio;
 
+static constexpr auto cond_wait_ms = 200ms;
+static constexpr auto writable_timeout_s = 5s;
+
 /**
  * class CAudioOutput
  */
-CAudioOutput::CAudioOutput(CAudioInfo& info) :
-    CAudioIO(info),
-    __mIsUsedSyncWrite(false),
-    __mIsInit(false) {
-    mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_OUT;
-}
 
-CAudioOutput::CAudioOutput(
-        unsigned int            sampleRate,
-        CAudioInfo::EChannel    channel,
-        CAudioInfo::ESampleType sampleType,
-        CAudioInfo::EAudioType  audioType) :
-    __mIsUsedSyncWrite(false),
-    __mIsInit(false) {
+CAudioOutput::CAudioOutput(CAudioInfo& info) :
+    CAudioIO(info) {
     mDirection = CAudioInfo::EAudioDirection::AUDIO_DIRECTION_OUT;
-    mAudioInfo = CAudioInfo(sampleRate, channel, sampleType, audioType, -1);
-}
-
-CAudioOutput::~CAudioOutput() {
 }
 
 void CAudioOutput::onStream(CPulseAudioClient* pClient, size_t length) {
@@ -54,11 +43,14 @@ void CAudioOutput::onStream(CPulseAudioClient* pClient, size_t length) {
      * Does not call CAudioIO::onStream() for synchronization
      * if a user is using write()
      */
-    if (__mIsUsedSyncWrite == true) {
+    if (__mIsUsedSyncWrite) {
 #ifdef _AUDIO_IO_DEBUG_TIMING_
-        AUDIO_IO_LOGD("Sync Write Mode! - signal! - pClient:[%p], length:[%d]", pClient, length);
+        AUDIO_IO_LOGD("Sync Write Mode! - signal! - pClient:[%p], length:[%zu]", pClient, length);
 #endif
-        internalSignal();
+        { /* NOTE: this block needs to unlock right after lock */
+            std::lock_guard<std::mutex> cond_guard(mCondMutex);
+        }
+        mCond.notify_one();
         return;
     }
 
@@ -66,57 +58,63 @@ void CAudioOutput::onStream(CPulseAudioClient* pClient, size_t length) {
      * Accrues callback function
      */
 #ifdef _AUDIO_IO_DEBUG_TIMING_
-    AUDIO_IO_LOGD("pClient:[%p], length:[%d]", pClient, length);
+    AUDIO_IO_LOGD("pClient:[%p], length:[%zu]", pClient, length);
 #endif
     CAudioIO::onStream(pClient, length);
 }
 
-void CAudioOutput::__setInit(bool flag) {
+void CAudioOutput::__setInit(bool flag) noexcept {
     __mIsInit = flag;
 }
 
-bool CAudioOutput::__IsInit() {
-    return (CAudioIO::isInit() == true && __mIsInit == true);
+bool CAudioOutput::__IsInit() noexcept {
+    return (CAudioIO::isInit() && __mIsInit);
 }
 
-bool CAudioOutput::__IsReady() {
+bool CAudioOutput::__IsReady() noexcept {
     return CAudioIO::IsReady();
 }
 
 void CAudioOutput::initialize() {
-    if (__IsInit() == true)
+    if (__IsInit())
         return;
 
     try {
         CAudioIO::initialize();
         __setInit(true);
-    } catch (CAudioError& e) {
+    } catch (const CAudioError& e) {
+//LCOV_EXCL_START
         finalize();
         throw;
+//LCOV_EXCL_STOP
     }
 
+    CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
 }
 
 void CAudioOutput::finalize() {
-    if (__IsInit() == false) {
+    if (!__IsInit()) {
         AUDIO_IO_LOGD("Did not initialize");
         return;
     }
 
     CAudioIO::finalize();
-
     __setInit(false);
 }
 
 void CAudioOutput::prepare() {
-    if (__IsInit() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioOutput");
+    CAudioTimedLocker locker(__func__, mMutex);
 
-    if (__IsReady() == true) {
+    if (!__IsInit())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Did not initialize CAudioOutput"); //LCOV_EXCL_LINE
+
+    if (__IsReady()) {
+//LCOV_EXCL_START
         AUDIO_IO_LOGD("Already prepared CAudioOutput");
         CAudioIO::prepare();
         return;
+//LCOV_EXCL_STOP
     }
 
     /* Check invalid AudioType */
@@ -138,124 +136,160 @@ void CAudioOutput::prepare() {
             streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_DEFAULT_ASYNC;
         }
 #endif
+        /* Override the default value by audio type */
+        if (audioType == CAudioInfo::EAudioType::AUDIO_OUT_TYPE_VOIP)
+            streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_VOIP;
+        else if (audioType == CAudioInfo::EAudioType::AUDIO_OUT_TYPE_MEDIA_NETWORK_SOURCE)
+            streamSpec = CPulseStreamSpec::EStreamLatency::STREAM_LATENCY_OUTPUT_HIGH;
+
         CPulseStreamSpec spec(streamSpec, mAudioInfo);
 
-        internalLock();
-        mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_PLAYBACK, spec, this);
+        mpPulseAudioClient = new CPulseAudioClient(CPulseAudioClient::EStreamDirection::STREAM_DIRECTION_PLAYBACK,
+                                                   spec, this);
         mpPulseAudioClient->initialize();
+        AUDIO_IO_LOGD("pClient:[%p] initialized done", mpPulseAudioClient);
 #ifndef DISABLE_MOBILE_BACK_COMP
         /* Uncork stream which is created with CORKED flag */
+        /* FIXME : following uncork may move into initialize() for mainloop lock */
         mpPulseAudioClient->cork(false);
+        AUDIO_IO_LOGD("pClient:[%p] corked done", mpPulseAudioClient);
 #endif
-        internalUnlock();
 
         CAudioIO::prepare();
-    } catch (CAudioError& e) {
+    } catch (const CAudioError& e) {
+//LCOV_EXCL_START
         SAFE_FINALIZE(mpPulseAudioClient);
         SAFE_DELETE(mpPulseAudioClient);
-        internalUnlock();
         throw;
+//LCOV_EXCL_STOP
     } catch (const std::bad_alloc&) {
-//LCOV_EXCL_START
-        internalUnlock();
         THROW_ERROR_MSG(CAudioError::EError::ERROR_OUT_OF_MEMORY, "Failed to allocate CPulseAudioClient object");
-//LCOV_EXCL_STOP
     }
 }
 
 void CAudioOutput::unprepare() {
-    if (__IsInit() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize CAudioOutput");
+    CAudioTimedLocker locker(__func__, mMutex);
+
+    if (!__IsInit())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
+                        "Did not initialize CAudioOutput");         //LCOV_EXCL_LINE
 
-    if (__IsReady() == false) {
+    if (!__IsReady()) {
         AUDIO_IO_LOGD("Already unprepared");
         return;
     }
 
+    __dumpStat();
+
     CAudioIO::unprepare();
 
-    try {
-        internalLock();
-        if (mpPulseAudioClient && mpPulseAudioClient->isInThread())
-            THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't unprepare inside pulseaudio thread");
-        SAFE_FINALIZE(mpPulseAudioClient);
-        SAFE_DELETE(mpPulseAudioClient);
-        internalUnlock();
-    } catch (CAudioError& e) {
-        internalUnlock();
-        throw;
-    }
+    if (mpPulseAudioClient && mpPulseAudioClient->isInThread())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't unprepare inside pulseaudio thread");
+
+    SAFE_FINALIZE(mpPulseAudioClient);
+    SAFE_DELETE(mpPulseAudioClient);
+
+    __mTotalWrittenCount = 0;
+    __mTotalWrittenBytes = 0;
+
+    CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
+
+    locker.unlock();
 
     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_IDLE);
 }
 
 void CAudioOutput::pause() {
-    if (__IsInit() == false || __IsReady() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize or prepare CAudioOutput");
+    CAudioTimedLocker locker(__func__, mMutex);
+
+    if (!__IsInit() || !__IsReady())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,    //LCOV_EXCL_LINE
+                        "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
 
     if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING)
         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
                         "Can't pause if not in Running state");
 
-    if (mpPulseAudioClient->isInThread() == true)
-        THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread");
+    if (mpPulseAudioClient->isInThread())
+        THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't pause in thread"); //LCOV_EXCL_LINE
+
+    __dumpStat();
 
     CAudioIO::pause();
+    CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
+
+    locker.unlock();
+
     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED);
 }
 
 void CAudioOutput::resume() {
-    if (__IsInit() == false || __IsReady() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize or prepare CAudioOutput");
+    CAudioTimedLocker locker(__func__, mMutex);
+
+    if (!__IsInit() || !__IsReady())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,    //LCOV_EXCL_LINE
+                        "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
 
     if (CAudioIO::getState() != CAudioInfo::EAudioIOState::AUDIO_IO_STATE_PAUSED)
         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_STATE,
                         "Can't resume if not in Paused state");
 
-    if (mpPulseAudioClient->isInThread() == true)
-        THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread");
+    if (mpPulseAudioClient->isInThread())
+        THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_OPERATION, "Can't resume in thread"); //LCOV_EXCL_LINE
+
+    __dumpStat();
 
     CAudioIO::resume();
+    CAudioIO::setState(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
+
+    locker.unlock();
+
     CAudioIO::onStateChanged(CAudioInfo::EAudioIOState::AUDIO_IO_STATE_RUNNING);
 }
 
 void CAudioOutput::drain() {
-    if (__IsInit() == false || __IsReady() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize or prepare CAudioOutput");
+    CAudioTimedLocker locker(__func__, mMutex);
+
+    if (!__IsInit() || !__IsReady())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,    //LCOV_EXCL_LINE
+                        "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
 
     if (mStreamCallback.onStream)
         THROW_ERROR_MSG(CAudioError::EError::ERROR_INVALID_OPERATION, "async type don't support drain");
 
-    CAudioIO::drain();
+    mpPulseAudioClient->drain();
 }
 
 void CAudioOutput::flush() {
-    if (__IsInit() == false || __IsReady() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize or prepare CAudioOutput");
+    CAudioTimedLocker locker(__func__, mMutex);
+
+    if (!__IsInit() || !__IsReady())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,    //LCOV_EXCL_LINE
+                        "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
 
     CAudioIO::flush();
 }
 
 int CAudioOutput::getBufferSize() {
-    if (__IsInit() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize or prepare CAudioOutput");
+    if (!__IsInit())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,    //LCOV_EXCL_LINE
+                        "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
 
     /* FIXME : return calculated size here to satisfy backward compatibility */
     return (mAudioInfo.getSampleRate() * DEFAULT_PERIOD_SIZE) / 1000 * mAudioInfo.getSampleSize();
 }
 
 size_t CAudioOutput::write(const void* buffer, size_t length) {
-    if (__IsInit() == false || __IsReady() == false)
-        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                        "Did not initialize or prepare CAudioOutput");
+    CAudioTimedLocker locker(__func__);
+
+    if (mpPulseAudioClient && !mpPulseAudioClient->isInThread())
+        locker.lock(mMutex);
+
+    if (!__IsInit() || !__IsReady())
+        THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,    //LCOV_EXCL_LINE
+                        "Did not initialize or prepare CAudioOutput"); //LCOV_EXCL_LINE
 
-    if (buffer == NULL)
+    if (!buffer)
         THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INVALID_ARGUMENT,
                                "Parameters are invalid - buffer:%p, length:%zu", buffer, length);
 
@@ -264,66 +298,106 @@ size_t CAudioOutput::write(const void* buffer, size_t length) {
                         "Can't write if not in Running state");
 
     /* When write() is called in PulseAudio callback, bypass a pcm data to CPulseAudioClient (For Asynchronous) */
-    if (mpPulseAudioClient && mpPulseAudioClient->isInThread() == true) {
+    if (mpPulseAudioClient && mpPulseAudioClient->isInThread()) {
         int ret = mpPulseAudioClient->write(buffer, length);
         if (ret < 0)
             THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
                                    "The written result is invalid ret:%d", ret);
 #ifdef _AUDIO_IO_DEBUG_TIMING_
-        AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%d)", buffer, length);
+        AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%zu)", buffer, length);
 #endif
+        __mTotalWrittenCount++;
+        __mTotalWrittenBytes += length;
+
+        __dumpStat(length);
+
         return length;
     }
 
     try {
-        /* For synchronization */
-        internalLock();
 
         // If another thread did call unprepare, do not write
-        if (mpPulseAudioClient == NULL)
-            THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED,
-                            "Did not initialize CPulseAudioClient");
+        if (!mpPulseAudioClient)
+            THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, //LCOV_EXCL_LINE
+                            "Did not initialize CPulseAudioClient");    //LCOV_EXCL_LINE
 
         // Sets synchronous flag
         __mIsUsedSyncWrite = true;
-
         size_t lengthIter = length;
 
         while (lengthIter > 0) {
             size_t l;
+            unsigned int timeouts = 0;
 
             while ((l = mpPulseAudioClient->getWritableSize()) == 0) {
 #ifdef _AUDIO_IO_DEBUG_TIMING_
-                AUDIO_IO_LOGD("writableSize is [%d].. wait", l);
+                AUDIO_IO_LOGD("writableSize is [%zu].. wait", l);
 #endif
-                internalWait();
+                std::unique_lock<std::mutex> cond_mutex(mCondMutex);
+                if (mCond.wait_for(cond_mutex, cond_wait_ms) == std::cv_status::timeout) {
+//LCOV_EXCL_START
+                    AUDIO_IO_LOGW("[%2u] timeout expired for waiting %zu ms of write available...", ++timeouts,
+                                  static_cast<size_t>(std::chrono::duration_cast<std::chrono::milliseconds>(cond_wait_ms).count()));
+                    if ((cond_wait_ms * timeouts) > writable_timeout_s)
+                        THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
+                                               "writable size is 0 for more than %zu seconds...",
+                                               static_cast<size_t>(std::chrono::duration_cast<std::chrono::seconds>(writable_timeout_s).count()));
+//LCOV_EXCL_STOP
+                }
             }
 
+            if (timeouts > 0)
+                AUDIO_IO_LOGD("writableSize(%zu) is now available after (%u) timeouts!!!", l, timeouts);
+
             if (l > lengthIter)
                 l = lengthIter;
 
 #ifdef _AUDIO_IO_DEBUG_TIMING_
-            AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%d)", buffer, l);
+            AUDIO_IO_LOGD("CPulseAudioClient->write(buffer:%p, length:%zu)", buffer, l);
+            __dumpStat();
 #endif
 
             int ret = mpPulseAudioClient->write(buffer, l);
             if (ret < 0)
-                THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,
-                                       "The written result is invalid ret:%d", ret);
+                THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_INTERNAL_OPERATION,//LCOV_EXCL_LINE
+                                       "The written result is invalid ret:%d", ret); //LCOV_EXCL_LINE
 
             buffer = static_cast<const uint8_t*>(buffer) + l;
             lengthIter -= l;
-        }  // End of while (length > 0)
+
+            __mTotalWrittenCount++;
+            __mTotalWrittenBytes += l;
+        }  // End of while (lengthIter > 0)
 
         __mIsUsedSyncWrite = false;
-        internalUnlock();
+        locker.unlock();
 
         sched_yield();
-    } catch (CAudioError& e) {
+    } catch (const CAudioError& e) {
         __mIsUsedSyncWrite = false;
-        internalUnlock();
         throw;
     }
 
+    __dumpStat(length);
+
     return length;
 }
+
+void CAudioOutput::__dumpStat() noexcept {
+    AUDIO_IO_LOGD("pClient[%p] : total written %5" PRIu64 " times, %10" PRIu64 " bytes, %7" PRIu64 " ms",
+                  mpPulseAudioClient, __mTotalWrittenCount, __mTotalWrittenBytes,
+                  __mTotalWrittenBytes * 1000 / mAudioInfo.getSampleSize() / mAudioInfo.getSampleRate());
+}
+
+void CAudioOutput::__dumpStat(size_t length) noexcept {
+    static constexpr auto PRINT_INTERVAL_BYTES = 256 * 1024; // 256k
+    static constexpr auto MIN_PRINTS = 20;
+    static uint64_t writtenBytes = 0;
+
+    if (__mTotalWrittenCount <= MIN_PRINTS) {
+        __dumpStat();
+    } else if ((writtenBytes += length) > PRINT_INTERVAL_BYTES) {
+        __dumpStat();
+        writtenBytes = 0;
+    }
+}
\ No newline at end of file