src/cpp/CAudioSessionHandler.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 <unistd.h>
  19 #include <mm_error.h>
  20 #include "CAudioIODef.h"
  21
  22
  23 using namespace std;
  24 using namespace tizen_media_audio;
  25
  26
  27 /**
  28  * class CAudioSessionHandler
  29  */
  30 int CAudioSessionHandler::__sCaptureRef = 0;
  31
  32 int CAudioSessionHandler::__pcmCaptureCountInc() {
  33     int actual;
  34     do {
  35         actual = __sCaptureRef;
  36     } while (!__sync_bool_compare_and_swap(&__sCaptureRef, actual, actual + 1));
  37     AUDIO_IO_LOGD("CaptureRefCount+1 > [%d]", __sCaptureRef);
  38     return __sCaptureRef;
  39 }
  40
  41 int CAudioSessionHandler::__pcmCaptureCountDec() {
  42     int actual;
  43     do {
  44         actual = __sCaptureRef;
  45     } while (!__sync_bool_compare_and_swap(&__sCaptureRef, actual, actual - 1));
  46     AUDIO_IO_LOGD("CaptureRefCount-1 > [%d]", __sCaptureRef);
  47     if (__sCaptureRef < 0) {
  48         AUDIO_IO_LOGE("A CaptureRef[%d] is not valid! Something is wrong!", __sCaptureRef);
  49         __sCaptureRef = 0;
  50     }
  51     return __sCaptureRef;
  52 }
  53
  54 int CAudioSessionHandler::__pcmCaptureCountGet() {
  55     AUDIO_IO_LOGD("CaptureRefCount > [%d]", __sCaptureRef);
  56     return __sCaptureRef;
  57 }
  58
  59 int CAudioSessionHandler::__sFocusRef = 0;
  60
  61 int CAudioSessionHandler::__focusIdCountInc() {
  62     int actual;
  63     do {
  64         actual = __sFocusRef;
  65     } while (!__sync_bool_compare_and_swap(&__sFocusRef, actual, actual + 1));
  66     AUDIO_IO_LOGD("FocusRefCount+1 > [%d]", __sFocusRef);
  67     return __sFocusRef;
  68 }
  69
  70 int CAudioSessionHandler::__focusIdCountDec() {
  71     int actual;
  72     do {
  73         actual = __sFocusRef;
  74     } while (!__sync_bool_compare_and_swap(&__sFocusRef, actual, actual - 1));
  75     AUDIO_IO_LOGD("FocusRefCount-1 > [%d]", __sFocusRef);
  76     return __sFocusRef;
  77 }
  78
  79 int CAudioSessionHandler::__focusIdCountGet() {
  80     /* AUDIO_IO_LOGD("FocusRefCount > [%d]", __sFocusRef); */
  81     return __sFocusRef;
  82 }
  83
  84 CAudioSessionHandler::CAudioSessionHandler(EAudioSessionType sessionType, CAudioInfo& audioInfo, IAudioSessionEventListener* listener) :
  85     __mId(-1),
  86     __mOptions(0),
  87     __mAudioSession(sessionType),
  88     __mMultimediaSession(MM_SESSION_TYPE_MEDIA),
  89     __mpEventListener(listener),
  90     __mIsInit(false),
  91     __mSubscribeId(0),
  92     __mUseFocus(false),
  93     __mFocusType(FOCUS_NONE),
  94     __mState(FOCUS_IS_RELEASED),
  95     __mReasonForChange(NULL),
  96     __mAdditionalInfo(NULL) {
  97     __mAudioInfo = audioInfo;
  98 }
  99
 100 CAudioSessionHandler::~CAudioSessionHandler() {
 101 }
 102
 103 CAudioError CAudioSessionHandler::__convertStreamType(EAudioSessionType type1, MMSessionType type2, int *index) {
 104     unsigned int i;
 105     int idx = -1;
 106
 107     assert(index != NULL);
 108
 109     if (type1 == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 110         for (i = 0 ; i < sizeof(__STREAM_TYPE_TABLE_IN) / sizeof(__STREAM_TYPE_TABLE_IN[0]) ; i++) {
 111             if (__STREAM_TYPE_TABLE_IN[i].type == type2) {
 112                 idx = i;
 113                 break;
 114             }
 115         }
 116     } else {
 117         for (i = 0 ; i < sizeof(__STREAM_TYPE_TABLE_OUT) / sizeof(__STREAM_TYPE_TABLE_OUT[0]) ; i++) {
 118             if (__STREAM_TYPE_TABLE_OUT[i].type == type2) {
 119                 idx = i;
 120                 break;
 121             }
 122         }
 123     }
 124
 125     if (idx < 0) {
 126         RET_ERROR_MSG(CAudioError::EError::ERROR_NOT_SUPPORTED, "Does not support session type.");
 127     }
 128     *index = idx;
 129     RET_ERROR(CAudioError::EError::ERROR_NONE);
 130 }
 131
 132 CAudioError CAudioSessionHandler::__getAsmInformation(MMSessionType *type, int *options) {
 133     assert(type != NULL);
 134     assert(options != NULL);
 135
 136     MMSessionType currentSession = MM_SESSION_TYPE_MEDIA;
 137     int           sessionOptions = 0;
 138
 139     /* Read session information */
 140     int ret = 0;
 141     if ((ret = _mm_session_util_read_information(-1, (int*)&currentSession, &sessionOptions)) < 0) {
 142         if (ret == (int) MM_ERROR_INVALID_HANDLE) {
 143             RET_ERROR_MSG(CAudioError::EError::ERROR_INVALID_HANDLE, "Failed _mm_session_util_read_information(). Invalid handle");
 144         } else {
 145             RET_ERROR_MSG(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed _mm_session_util_read_information(). Not exist");
 146         }
 147     }
 148
 149     *type    = currentSession;
 150     *options = sessionOptions;
 151
 152     RET_ERROR(CAudioError::EError::ERROR_NONE);
 153 }
 154
 155 bool CAudioSessionHandler::__isFocusRequired(MMSessionType type, int options) {
 156     if ((options & MM_SESSION_OPTION_PAUSE_OTHERS)
 157         || ((type != MM_SESSION_TYPE_MEDIA) && (type != MM_SESSION_TYPE_MEDIA_RECORD)))
 158         return true;
 159     else
 160         return false;
 161 }
 162
 163 int CAudioSessionHandler::getId() {
 164     return __mId;
 165 }
 166
 167 int CAudioSessionHandler::getOptions() {
 168     return __mOptions;
 169 }
 170
 171 CAudioSessionHandler::EAudioSessionType CAudioSessionHandler::getAudioSession() {
 172     return __mAudioSession;
 173 }
 174
 175 MMSessionType CAudioSessionHandler::getMultimediaSession() {
 176     return __mMultimediaSession;
 177 }
 178
 179 unsigned int CAudioSessionHandler::getSubscribeId() {
 180     return __mSubscribeId;
 181 }
 182
 183 CAudioInfo CAudioSessionHandler::getAudioInfo() {
 184     return __mAudioInfo;
 185 }
 186
 187 void CAudioSessionHandler::__sound_pcm_signal_cb(mm_sound_signal_name_t signal, int value, void *user_data) {
 188     assert(user_data);
 189
 190     AUDIO_IO_LOGD("[signal:%d], [value:%d], [user_data:0x%x]", signal, value, user_data);
 191
 192     CAudioSessionHandler* pHandler = static_cast<CAudioSessionHandler*>(user_data);
 193     if (pHandler->__mpEventListener != NULL)
 194         pHandler->__mpEventListener->onSignal(pHandler, signal, value);
 195 }
 196
 197 void CAudioSessionHandler::initialize() throw(CAudioError) {
 198     AUDIO_IO_LOGD("");
 199     if (__mIsInit == true) {
 200         return;
 201     }
 202
 203     MMSessionType currentSession = MM_SESSION_TYPE_MEDIA;
 204     int           sessionOptions = 0;  // Mix with others by default
 205
 206     CAudioError err = __getAsmInformation(&currentSession, &sessionOptions);
 207     if (err == CAudioError::EError::ERROR_NONE) {
 208         if (currentSession == MM_SESSION_TYPE_REPLACED_BY_STREAM) {
 209             __mUseFocus = false;
 210             AUDIO_IO_LOGD("Stream info. was created outside, skip audio focus concept internally!");
 211         } else {
 212             // Session was configured before, use focus callback
 213             __mUseFocus = true;
 214             AUDIO_IO_LOGD("Use audio focus concept internally!");
 215         }
 216     } else {
 217         if (err == CAudioError::EError::ERROR_INVALID_HANDLE) {
 218             // No session, No stream_info, No focus watch callback before
 219             // Use focus watch callback with signal subscribe
 220
 221             int errorCode = mm_sound_subscribe_signal(MM_SOUND_SIGNAL_RELEASE_INTERNAL_FOCUS, &__mSubscribeId, __sound_pcm_signal_cb, static_cast<void*>(this));
 222             if (errorCode != MM_ERROR_NONE || __mSubscribeId == 0) {
 223                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_subscribe_signal() err:0x%x, __mSubscribeId:%u",
 224                                        errorCode, __mSubscribeId);
 225             }
 226
 227             AUDIO_IO_LOGD("Subscribed mm_sound signal");
 228
 229             sessionOptions = 0;  // Mix with others by default
 230             __mUseFocus = true;
 231             AUDIO_IO_LOGD("Use audio focus(watch) concept internally!");
 232         } else {
 233             __mUseFocus = false;
 234             AUDIO_IO_LOGD("Skip audio focus concept!");
 235         }
 236
 237         if (__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 238             AUDIO_IO_LOGD("Set default \"Media_Record\" type");
 239             currentSession = MM_SESSION_TYPE_MEDIA_RECORD;
 240         } else {
 241             AUDIO_IO_LOGD("Set default \"Media\" type");
 242             currentSession = MM_SESSION_TYPE_MEDIA;
 243         }
 244     }
 245
 246     // Updates session information
 247     __mMultimediaSession = currentSession;
 248     __mOptions           = sessionOptions;
 249
 250     if (this->__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 251         __pcmCaptureCountInc();
 252     }
 253
 254     __mIsInit = true;
 255 }
 256
 257 void CAudioSessionHandler::finalize() {
 258     AUDIO_IO_LOGD("");
 259     if (__mIsInit == false) {
 260         return;
 261     }
 262
 263     if (__mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE) {
 264         __pcmCaptureCountDec();
 265     }
 266
 267     if (__mSubscribeId > 0) {
 268         mm_sound_unsubscribe_signal(__mSubscribeId);
 269         __mSubscribeId = 0;
 270     }
 271
 272     __mpEventListener = NULL;
 273
 274     __mIsInit = false;
 275 }
 276
 277 bool CAudioSessionHandler::isSkipSessionEvent() throw(CAudioError) {
 278     bool ret = false;
 279
 280     // To be regarded...
 281 #if 0
 282     /* Only Support below Event */
 283     if (mEvent != ASM_EVENT_CALL              && mEvent != ASM_EVENT_VOIP              &&
 284         mEvent != ASM_EVENT_VIDEOCALL         && mEvent != ASM_EVENT_VOICE_RECOGNITION &&
 285         mEvent != ASM_EVENT_MMCAMCORDER_AUDIO && mEvent != ASM_EVENT_MMCAMCORDER_VIDEO) {
 286         // Check AudioType
 287         switch (__mAudioInfo.getAudioType()) {
 288         case CAudioInfo::AUDIO_IN_TYPE_MEDIA:
 289         case CAudioInfo::AUDIO_IN_TYPE_VOICECONTROL:
 290             ret = false;
 291             break;
 292
 293         case CAudioInfo::AUDIO_IN_TYPE_MIRRORING:
 294         case CAudioInfo::AUDIO_IN_TYPE_LOOPBACK:
 295             ret = true;
 296             break;
 297
 298         default:
 299             return false;
 300         }
 301
 302         if (ret == true) {
 303             int captureCount = CAudioSessionHandler::__pcmCaptureCountGet();
 304             if (captureCount == 1) {/* If this is last one */
 305                 /* Recover session information to MEDIA */
 306                 int sessionResult = _mm_session_util_write_information(-1, MM_SESSION_TYPE_MEDIA, __mOptions);
 307                 if (sessionResult != 0) {
 308                     THROW_ERROR_MSG_FORMAT(CAudioError::ERROR_INTERNAL_OPERATION, "Failed _mm_session_util_write_information() ret:%d", sessionResult);
 309                 }
 310             }
 311         }
 312     }
 313 #endif
 314
 315     return ret;
 316 }
 317
 318 void CAudioSessionHandler::__sound_pcm_focus_cb(int id, mm_sound_focus_type_e focus_type, mm_sound_focus_state_e state, const char *reason_for_change, int option, const char *additional_info, void *user_data) {
 319     assert(user_data);
 320
 321     AUDIO_IO_LOGD("[id:%d], [focus_type:%d], [state:%d], [reason_for_change:%s], [additional_info:%s], [user_data:0x%x]", id, focus_type, state, reason_for_change, additional_info, user_data);
 322
 323 /* FIXME: disable it temporarily */
 324 #ifndef DISABLE_SESSION_BACK_COMP
 325
 326     CAudioSessionHandler* pHandler = static_cast<CAudioSessionHandler*>(user_data);
 327     pHandler->__mFocusType       = focus_type;
 328     pHandler->__mState           = state;
 329     pHandler->__mReasonForChange = (char *)reason_for_change;
 330     pHandler->__mAdditionalInfo  = (char *)additional_info;
 331
 332     if (pHandler->__mpEventListener != NULL)
 333         pHandler->__mpEventListener->onInterrupt(pHandler, id, focus_type, state, reason_for_change, additional_info);
 334 #endif
 335     return;
 336 }
 337
 338 void CAudioSessionHandler::__sound_pcm_focus_watch_cb(int id, mm_sound_focus_type_e focus_type, mm_sound_focus_state_e state, const char *reason_for_change, const char *additional_info, void *user_data) {
 339     AUDIO_IO_LOGD("[id:%d], [focus_type:%d], [state:%d], [reason_for_change:%s], [additional_info:%s], [user_data:0x%x]", id, focus_type, state, reason_for_change, additional_info, user_data);
 340
 341     CAudioSessionHandler::__sound_pcm_focus_cb(-1, focus_type, state, reason_for_change, 0, additional_info, user_data);
 342
 343     return;
 344 }
 345
 346 void CAudioSessionHandler::registerSound() throw(CAudioError) {
 347     if (__mIsInit == false) {
 348         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 349     }
 350
 351     if (__mUseFocus == true) {
 352         if (__mId >= 0) {
 353             THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Already registered [id:%d]", __mId);
 354         }
 355
 356         int errorCode = 0;
 357
 358         if (__isFocusRequired(__mMultimediaSession, __mOptions)) {
 359             int index = 0;
 360             CAudioError err = __convertStreamType(__mAudioSession, __mMultimediaSession, &index);
 361             if (err != CAudioError::EError::ERROR_NONE) {
 362                 throw err;
 363             }
 364
 365             errorCode = mm_sound_focus_get_id(&__mId);
 366             if (errorCode != MM_ERROR_NONE) {
 367                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_focus_get_id() err:0x%x", errorCode);
 368             }
 369
 370             // Register focus callback
 371             errorCode = mm_sound_register_focus_for_session(__mId,
 372                                                 getpid(),
 373                                                 __mAudioSession == EAudioSessionType::AUDIO_SESSION_TYPE_CAPTURE ? __STREAM_TYPE_TABLE_IN[index].name : __STREAM_TYPE_TABLE_OUT[index].name,
 374                                                 __sound_pcm_focus_cb,
 375                                                 static_cast<void*>(this));
 376             if (errorCode != MM_ERROR_NONE) {
 377                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_register_focus_for_session() err:0x%x", errorCode);
 378             }
 379
 380             __focusIdCountInc();
 381
 382             AUDIO_IO_LOGD("Focus callback registered successfully [id:%d]", __mId);
 383         } else if (!(__mOptions & MM_SESSION_OPTION_UNINTERRUPTIBLE)) {
 384             // Register focus watch callback
 385             errorCode = mm_sound_set_focus_watch_callback_for_session(getpid(), FOCUS_FOR_BOTH, __sound_pcm_focus_watch_cb, static_cast<void*>(this), &__mId);
 386             if (errorCode < 0) {
 387                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_set_focus_watch_callback_for_session() err:0x%x", errorCode);
 388             }
 389
 390             __focusIdCountInc();
 391
 392             AUDIO_IO_LOGD("Focus watch callback registered successfully [id:%d]", __mId);
 393         }
 394     }
 395 }
 396
 397 void CAudioSessionHandler::unregisterSound() throw(CAudioError) {
 398     if (__mIsInit == false) {
 399         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 400     }
 401
 402     if (__mUseFocus == true && __mId >= 0) {
 403         int errorCode = 0;
 404
 405         if (__isFocusRequired(__mMultimediaSession, __mOptions)) {
 406             // Unregister focus callback
 407             errorCode = mm_sound_unregister_focus(__mId);
 408             if (errorCode != MM_ERROR_NONE) {
 409                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_unregister_focus() err:0x%x", errorCode);
 410             }
 411
 412             __focusIdCountDec();
 413
 414             AUDIO_IO_LOGD("Focus callback unregistered successfully [id:%d]", __mId);
 415             __mId = -1;
 416         } else if (!(__mOptions & MM_SESSION_OPTION_UNINTERRUPTIBLE)) {
 417             // Unregister focus watch callback.
 418             errorCode = mm_sound_unset_focus_watch_callback(__mId);
 419             if (errorCode < 0) {
 420                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_unset_focus_watch_callback() err:0x%x", errorCode);
 421             }
 422
 423             __focusIdCountDec();
 424
 425             AUDIO_IO_LOGD("Focus watch callback unregistered successfully [id:%d]", __mId);
 426             __mId = -1;
 427         }
 428     }
 429 }
 430
 431 void CAudioSessionHandler::updatePlaying() throw(CAudioError) {
 432     if (__mIsInit == false) {
 433         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 434     }
 435
 436     if (__mUseFocus && __isFocusRequired(__mMultimediaSession, __mOptions)) {
 437         if (__mId >= 0) {
 438             int ret = mm_sound_acquire_focus(__mId, FOCUS_FOR_BOTH, "audio-io acquire focus");
 439             if (ret != MM_ERROR_NONE) {
 440                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_POLICY_BLOCKED, "Failed mm_sound_acquire_focus() err:0x%x", ret);
 441             }
 442             AUDIO_IO_LOGD("Focus acquired successfully [id:%d]", __mId);
 443         }
 444     }
 445 }
 446
 447 void CAudioSessionHandler::updateStop() throw(CAudioError) {
 448     if (__mIsInit == false) {
 449         THROW_ERROR_MSG(CAudioError::EError::ERROR_NOT_INITIALIZED, "Doesn't initialize CAudioSessionHandler");
 450     }
 451
 452     if (__mUseFocus && __isFocusRequired(__mMultimediaSession, __mOptions)) {
 453         if (__mId >= 0) {
 454             int ret = mm_sound_release_focus(__mId, FOCUS_FOR_BOTH, "audio-io release focus");
 455             if (ret != MM_ERROR_NONE) {
 456                 THROW_ERROR_MSG_FORMAT(CAudioError::EError::ERROR_FAILED_OPERATION, "Failed mm_sound_release_focus() err:0x%x", ret);
 457             }
 458             AUDIO_IO_LOGD("Focus released successfully [id:%d]", __mId);
 459         }
 460     }
 461 }
 462
 463 void CAudioSessionHandler::disableSessionHandler() throw(CAudioError) {
 464     CAudioSessionHandler::updateStop();
 465     CAudioSessionHandler::unregisterSound();
 466
 467     CAudioSessionHandler::__mUseFocus = false;
 468 }
 469
 470 /**
 471  * class IAudioSessionEventListener
 472  */
 473 IAudioSessionEventListener::EInterruptCode IAudioSessionEventListener::convertInterruptedCode(int code, const char *reason_for_change) {
 474     EInterruptCode e = EInterruptCode::INTERRUPT_COMPLETED;
 475
 476     switch (code) {
 477     case FOCUS_IS_ACQUIRED:
 478         e = EInterruptCode::INTERRUPT_COMPLETED;
 479         break;
 480
 481     case FOCUS_IS_RELEASED:
 482         if (!strcmp(reason_for_change, "media"))              e = EInterruptCode::INTERRUPT_BY_MEDIA;
 483         if (!strcmp(reason_for_change, "radio"))              e = EInterruptCode::INTERRUPT_BY_MEDIA;
 484         if (!strcmp(reason_for_change, "loopback"))           e = EInterruptCode::INTERRUPT_BY_MEDIA;
 485         if (!strcmp(reason_for_change, "system"))             e = EInterruptCode::INTERRUPT_BY_MEDIA;
 486         if (!strcmp(reason_for_change, "alarm"))              e = EInterruptCode::INTERRUPT_BY_ALARM;
 487         if (!strcmp(reason_for_change, "notification"))       e = EInterruptCode::INTERRUPT_BY_NOTIFICATION;
 488         if (!strcmp(reason_for_change, "emergency"))          e = EInterruptCode::INTERRUPT_BY_EMERGENCY;
 489         if (!strcmp(reason_for_change, "voice-information"))  e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 490         if (!strcmp(reason_for_change, "voice-recognition"))  e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 491         if (!strcmp(reason_for_change, "ringtone-voip"))      e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 492         if (!strcmp(reason_for_change, "ringtone-call"))      e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 493         if (!strcmp(reason_for_change, "voip"))               e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 494         if (!strcmp(reason_for_change, "call-voice"))         e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 495         if (!strcmp(reason_for_change, "call-video"))         e = EInterruptCode::INTERRUPT_BY_MEDIA;  //for what?
 496         break;
 497     }
 498
 499     return e;
 500 }